| 1 | /********************************************************************\ |
|---|
| 2 | * BitlBee -- An IRC to other IM-networks gateway * |
|---|
| 3 | * * |
|---|
| 4 | * Copyright 2002-2006 Wilmer van der Gaast and others * |
|---|
| 5 | \********************************************************************/ |
|---|
| 6 | |
|---|
| 7 | /* Some stuff to register, handle and save user preferences */ |
|---|
| 8 | |
|---|
| 9 | /* |
|---|
| 10 | This program is free software; you can redistribute it and/or modify |
|---|
| 11 | it under the terms of the GNU General Public License as published by |
|---|
| 12 | the Free Software Foundation; either version 2 of the License, or |
|---|
| 13 | (at your option) any later version. |
|---|
| 14 | |
|---|
| 15 | This program is distributed in the hope that it will be useful, |
|---|
| 16 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|---|
| 18 | GNU General Public License for more details. |
|---|
| 19 | |
|---|
| 20 | You should have received a copy of the GNU General Public License with |
|---|
| 21 | the Debian GNU/Linux distribution in /usr/share/common-licenses/GPL; |
|---|
| 22 | if not, write to the Free Software Foundation, Inc., 59 Temple Place, |
|---|
| 23 | Suite 330, Boston, MA 02111-1307 USA |
|---|
| 24 | */ |
|---|
| 25 | |
|---|
| 26 | #ifndef __SET_H__ |
|---|
| 27 | #define __SET_H__ |
|---|
| 28 | |
|---|
| 29 | struct set; |
|---|
| 30 | |
|---|
| 31 | /* This used to be specific to irc_t structures, but it's more generic now |
|---|
| 32 | (so it can also be used for account_t structs). It's pretty simple, but |
|---|
| 33 | so far pretty useful. |
|---|
| 34 | |
|---|
| 35 | In short, it just keeps a linked list of settings/variables and it also |
|---|
| 36 | remembers a default value for every setting. And to prevent the user |
|---|
| 37 | from setting invalid values, you can write an evaluator function for |
|---|
| 38 | every setting, which can check a new value and block it by returning |
|---|
| 39 | NULL, or replace it by returning a new value. See struct set.eval. */ |
|---|
| 40 | |
|---|
| 41 | typedef char *(*set_eval) ( struct set *set, char *value ); |
|---|
| 42 | |
|---|
| 43 | extern char *SET_INVALID; |
|---|
| 44 | |
|---|
| 45 | typedef enum |
|---|
| 46 | { |
|---|
| 47 | SET_NOSAVE = 0x0001, |
|---|
| 48 | SET_NULL_OK = 0x0100, |
|---|
| 49 | SET_HIDDEN = 0x0200, |
|---|
| 50 | SET_PASSWORD = 0x0400, |
|---|
| 51 | } set_flags_t; |
|---|
| 52 | |
|---|
| 53 | typedef struct set |
|---|
| 54 | { |
|---|
| 55 | void *data; /* Here you can save a pointer to the |
|---|
| 56 | object this settings belongs to. */ |
|---|
| 57 | |
|---|
| 58 | char *key; |
|---|
| 59 | char *old_key; /* Previously known as; for smooth upgrades. */ |
|---|
| 60 | char *value; |
|---|
| 61 | char *def; /* Default value. If the set_setstr() function |
|---|
| 62 | notices a new value is exactly the same as |
|---|
| 63 | the default, value gets set to NULL. So when |
|---|
| 64 | you read a setting, don't forget about this! |
|---|
| 65 | In fact, you should only read values using |
|---|
| 66 | set_getstr/int(). */ |
|---|
| 67 | |
|---|
| 68 | set_flags_t flags; /* Mostly defined per user. */ |
|---|
| 69 | |
|---|
| 70 | /* Eval: Returns SET_INVALID if the value is incorrect, exactly |
|---|
| 71 | the passed value variable, or a corrected value. In case of |
|---|
| 72 | the latter, set_setstr() will free() the returned string! */ |
|---|
| 73 | set_eval eval; |
|---|
| 74 | void *eval_data; |
|---|
| 75 | struct set *next; |
|---|
| 76 | } set_t; |
|---|
| 77 | |
|---|
| 78 | /* Should be pretty clear. */ |
|---|
| 79 | set_t *set_add( set_t **head, const char *key, const char *def, set_eval eval, void *data ); |
|---|
| 80 | |
|---|
| 81 | /* Returns the raw set_t. Might be useful sometimes. */ |
|---|
| 82 | set_t *set_find( set_t **head, const char *key ); |
|---|
| 83 | |
|---|
| 84 | /* Returns a pointer to the string value of this setting. Don't modify the |
|---|
| 85 | returned string, and don't free() it! */ |
|---|
| 86 | G_MODULE_EXPORT char *set_getstr( set_t **head, const char *key ); |
|---|
| 87 | |
|---|
| 88 | /* Get an integer. In previous versions set_getint() was also used to read |
|---|
| 89 | boolean values, but this SHOULD be done with set_getbool() now! */ |
|---|
| 90 | G_MODULE_EXPORT int set_getint( set_t **head, const char *key ); |
|---|
| 91 | G_MODULE_EXPORT int set_getbool( set_t **head, const char *key ); |
|---|
| 92 | |
|---|
| 93 | /* set_setstr() strdup()s the given value, so after using this function |
|---|
| 94 | you can free() it, if you want. */ |
|---|
| 95 | int set_setstr( set_t **head, const char *key, char *value ); |
|---|
| 96 | int set_setint( set_t **head, const char *key, int value ); |
|---|
| 97 | void set_del( set_t **head, const char *key ); |
|---|
| 98 | int set_reset( set_t **head, const char *key ); |
|---|
| 99 | |
|---|
| 100 | /* Two very useful generic evaluators. */ |
|---|
| 101 | char *set_eval_int( set_t *set, char *value ); |
|---|
| 102 | char *set_eval_bool( set_t *set, char *value ); |
|---|
| 103 | |
|---|
| 104 | /* Another more complicated one. */ |
|---|
| 105 | char *set_eval_list( set_t *set, char *value ); |
|---|
| 106 | |
|---|
| 107 | /* Some not very generic evaluators that really shouldn't be here... */ |
|---|
| 108 | char *set_eval_to_char( set_t *set, char *value ); |
|---|
| 109 | char *set_eval_ops( set_t *set, char *value ); |
|---|
| 110 | |
|---|
| 111 | #endif /* __SET_H__ */ |
|---|
