# HG changeset patch # User Christian Hammond # Date 1054496066 0 # Node ID 408fef8451440dc3eddb58665b044a2dabb3e086 # Parent 0bdfa28c678e22d37aa4d0ea83deb5a4184f30ca [gaim-migrate @ 6051] Forgot to add these files. Oops. committer: Tailor Script diff -r 0bdfa28c678e -r 408fef845144 src/accountopt.c --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/accountopt.c Sun Jun 01 19:34:26 2003 +0000 @@ -0,0 +1,239 @@ +/** + * @file accountopt.c Account Options API + * @ingroup core + * + * gaim + * + * Copyright (C) 2003 Christian Hammond + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ +#include "accountopt.h" + +GaimAccountOption * +gaim_account_option_new(GaimPrefType type, const char *text, + const char *pref_name) +{ + GaimAccountOption *option; + + g_return_val_if_fail(type == GAIM_PREF_BOOLEAN || + type == GAIM_PREF_INT || + type == GAIM_PREF_STRING, + NULL); + g_return_val_if_fail(text != NULL, NULL); + g_return_val_if_fail(pref_name != NULL, NULL); + + option = g_new0(GaimAccountOption, 1); + + option->type = type; + option->text = g_strdup(text); + option->pref_name = g_strdup(pref_name); + + return option; +} + +GaimAccountOption * +gaim_account_option_bool_new(const char *text, const char *pref_name, + gboolean default_value) +{ + GaimAccountOption *option; + + option = gaim_account_option_new(GAIM_PREF_BOOLEAN, text, pref_name); + + if (option == NULL) + return NULL; + + option->default_value.boolean = default_value; + + return option; +} + +GaimAccountOption * +gaim_account_option_int_new(const char *text, const char *pref_name, + int default_value) +{ + GaimAccountOption *option; + + option = gaim_account_option_new(GAIM_PREF_INT, text, pref_name); + + if (option == NULL) + return NULL; + + option->default_value.integer = default_value; + + return option; +} + +GaimAccountOption * +gaim_account_option_string_new(const char *text, const char *pref_name, + const char *default_value) +{ + GaimAccountOption *option; + + option = gaim_account_option_new(GAIM_PREF_STRING, text, pref_name); + + if (option == NULL) + return NULL; + + if (default_value != NULL) + option->default_value.string = g_strdup(default_value); + + return option; +} + +void +gaim_account_option_destroy(GaimAccountOption *option) +{ + g_return_if_fail(option != NULL); + + if (option->text != NULL) + g_free(option->text); + + if (option->pref_name != NULL) + g_free(option->pref_name); + + if (option->type == GAIM_PREF_STRING && + option->default_value.string != NULL) { + + g_free(option->default_value.string); + } + + g_free(option); +} + +void +gaim_account_option_set_default_bool(GaimAccountOption *option, + gboolean value) +{ + g_return_if_fail(option != NULL); + g_return_if_fail(option->type == GAIM_PREF_BOOLEAN); + + option->default_value.boolean = value; +} + +void +gaim_account_option_set_default_int(GaimAccountOption *option, int value) +{ + g_return_if_fail(option != NULL); + g_return_if_fail(option->type == GAIM_PREF_INT); + + option->default_value.integer = value; +} + +void +gaim_account_option_set_default_string(GaimAccountOption *option, + const char *value) +{ + g_return_if_fail(option != NULL); + g_return_if_fail(option->type == GAIM_PREF_STRING); + + if (option->default_value.string != NULL) + g_free(option->default_value.string); + + option->default_value.string = (value == NULL ? NULL : g_strdup(value)); +} + +GaimPrefType +gaim_account_option_get_type(const GaimAccountOption *option) +{ + g_return_val_if_fail(option != NULL, GAIM_PREF_NONE); + + return option->type; +} + +const char * +gaim_account_option_get_text(const GaimAccountOption *option) +{ + g_return_val_if_fail(option != NULL, NULL); + + return option->text; +} + +gboolean +gaim_account_option_get_default_bool(const GaimAccountOption *option) +{ + g_return_val_if_fail(option != NULL, FALSE); + g_return_val_if_fail(option->type != GAIM_PREF_BOOLEAN, FALSE); + + return option->default_value.boolean; +} + +int +gaim_account_option_get_default_int(const GaimAccountOption *option) +{ + g_return_val_if_fail(option != NULL, -1); + g_return_val_if_fail(option->type != GAIM_PREF_INT, -1); + + return option->default_value.integer; +} + +const char * +gaim_account_option_get_default_string(const GaimAccountOption *option) +{ + g_return_val_if_fail(option != NULL, NULL); + g_return_val_if_fail(option->type != GAIM_PREF_STRING, NULL); + + return option->default_value.string; +} + + +GaimAccountUserSplit * +gaim_account_user_split_new(const char *text, const char *default_value, + char sep) +{ + GaimAccountUserSplit *split; + + g_return_val_if_fail(text != NULL, NULL); + g_return_val_if_fail(sep != 0, NULL); + + split = g_new0(GaimAccountUserSplit, 1); + + split->text = g_strdup(text); + split->field_sep = sep; + split->default_value = (default_value == NULL + ? NULL : g_strdup(default_value)); + + return split; +} + +void +gaim_account_user_split_destroy(GaimAccountUserSplit *split) +{ + g_return_if_fail(split != NULL); + + if (split->text != NULL) + g_free(split->text); + + if (split->default_value != NULL) + g_free(split->default_value); + + g_free(split); +} + +const char * +gaim_account_split_get_default_value(const GaimAccountUserSplit *split) +{ + g_return_val_if_fail(split != NULL, NULL); + + return split->default_value; +} + +char +gaim_account_split_get_separator(const GaimAccountUserSplit *split) +{ + g_return_val_if_fail(split != NULL, 0); + + return split->field_sep; +} diff -r 0bdfa28c678e -r 408fef845144 src/accountopt.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/accountopt.h Sun Jun 01 19:34:26 2003 +0000 @@ -0,0 +1,250 @@ +/** + * @file accountopt.h Account Options API + * @ingroup core + * + * gaim + * + * Copyright (C) 2003 Christian Hammond + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ +#ifndef _GAIM_ACCOUNT_OPT_H_ +#define _GAIM_ACCOUNT_OPT_H_ + +#include "prefs.h" + +/** + * An option for an account. + * + * This is set by protocol plugins, and appears in the account settings + * dialogs. + */ +typedef struct +{ + GaimPrefType type; /**< The type of value. */ + + char *text; /**< The text that will appear to the user. */ + char *pref_name; /**< The name of the associated preference. */ + + union + { + gboolean boolean; /**< The default boolean value. */ + int integer; /**< The default integer value. */ + char *string; /**< The default string value. */ + + } default_value; + +} GaimAccountOption; + +/** + * A username split. + * + * This is used by some protocols to separate the fields of the username + * into more human-readable components. + */ +typedef struct +{ + char *text; /**< The text that will appear to the user. */ + char *default_value; /**< The default value. */ + char field_sep; /**< The field separator. */ + +} GaimAccountUserSplit; + +/**************************************************************************/ +/** @name Account Option API */ +/**************************************************************************/ +/*@{*/ + +/** + * Creates a new account option. + * + * @param type The type of option. + * @param text The text of the option. + * @param pref_name The account preference name for the option. + * + * @return The account option. + */ +GaimAccountOption *gaim_account_option_new(GaimPrefType type, const char *text, + const char *pref_name); + +/** + * Creates a new boolean account option. + * + * @param text The text of the option. + * @param pref_name The account preference name for the option. + * @param default_value The default value. + * + * @return The account option. + */ +GaimAccountOption *gaim_account_option_bool_new(const char *text, + const char *pref_name, + gboolean default_value); + +/** + * Creates a new integer account option. + * + * @param text The text of the option. + * @param pref_name The account preference name for the option. + * @param default_value The default value. + * + * @return The account option. + */ +GaimAccountOption *gaim_account_option_int_new(const char *text, + const char *pref_name, + int default_value); + +/** + * Creates a new string account option. + * + * @param text The text of the option. + * @param pref_name The account preference name for the option. + * @param default_value The default value. + * + * @return The account option. + */ +GaimAccountOption *gaim_account_option_string_new(const char *text, + const char *pref_name, + const char *default_value); + +/** + * Destroys an account option. + * + * @param option The option to destroy. + */ +void gaim_account_option_destroy(GaimAccountOption *option); + +/** + * Sets the default boolean value for an account option. + * + * @param option The account option. + * @param value The default boolean value. + */ +void gaim_account_option_set_default_bool(GaimAccountOption *option, + gboolean value); + +/** + * Sets the default integer value for an account option. + * + * @param option The account option. + * @param value The default integer value. + */ +void gaim_account_option_set_default_int(GaimAccountOption *option, + int value); + +/** + * Sets the default string value for an account option. + * + * @param option The account option. + * @param value The default string value. + */ +void gaim_account_option_set_default_string(GaimAccountOption *option, + const char *value); + +/** + * Returns the specified account option's type. + * + * @param option The account option. + * + * @return The account option's type. + */ +GaimPrefType gaim_account_option_get_type(const GaimAccountOption *option); + +/** + * Returns the text for an account option. + * + * @param option The accont option. + * + * @return The account option's text. + */ +const char *gaim_account_option_get_text(const GaimAccountOption *option); + +/** + * Returns the default boolean value for an account option. + * + * @param option The account option. + * + * @return The default boolean value. + */ +gboolean gaim_account_option_get_default_bool(const GaimAccountOption *option); + +/** + * Returns the default integer value for an account option. + * + * @param option The account option. + * + * @return The default integer value. + */ +int gaim_account_option_get_default_int(const GaimAccountOption *option); + +/** + * Returns the default string value for an account option. + * + * @param option The account option. + * + * @return The default string value. + */ +const char *gaim_account_option_get_default_string( + const GaimAccountOption *option); + +/*@}*/ + + +/**************************************************************************/ +/** @name Account User Split API */ +/**************************************************************************/ +/*@{*/ + +/** + * Creates a new account username split. + * + * @param text The text of the option. + * @param default_value The default value. + * @param sep The field separator. + * + * @return The new user split. + */ +GaimAccountUserSplit *gaim_account_user_split_new(const char *text, + const char *default_value, + char sep); + +/** + * Destroys an account username split. + * + * @param split The split to destroy. + */ +void gaim_account_user_split_destroy(GaimAccountUserSplit *split); + +/** + * Returns the default string value for an account split. + * + * @param split The account username split. + * + * @return The default string. + */ +const char *gaim_account_split_get_default_value( + const GaimAccountUserSplit *split); + +/** + * Returns the field separator for an account split. + * + * @param split The account username split. + * + * @return The field separator. + */ +char gaim_account_split_get_separator(const GaimAccountUserSplit *split); + +/*@}*/ + +#endif /* _GAIM_ACCOUNT_OPT_H_ */