source: set.h @ f6c963b

Last change on this file since f6c963b was 723e611, checked in by Wilmer van der Gaast <wilmer@…>, at 2007-02-26T04:46:35Z

Removed boolean code from set_getint() and added bits of help to set.h.

  • Property mode set to 100644
File size: 4.0 KB
[b7d3cc34]1  /********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
[5c9512f]4  * Copyright 2002-2006 Wilmer van der Gaast and others                *
[b7d3cc34]5  \********************************************************************/
7/* Some stuff to register, handle and save user preferences             */
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.
15  This program is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  GNU General Public License for more details.
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
[d5ccd83]26/* This used to be specific to irc_t structures, but it's more generic now
27   (so it can also be used for account_t structs). It's pretty simple, but
28   so far pretty useful.
30   In short, it just keeps a linked list of settings/variables and it also
31   remembers a default value for every setting. And to prevent the user
32   from setting invalid values, you can write an evaluator function for
33   every setting, which can check a new value and block it by returning
[723e611]34   NULL, or replace it by returning a new value. See struct set.eval.
35   One thing that is really missing here is additional data for the
36   evaluator. This could be useful to add minimum and maximum values for
37   integers, for example. */
[0383943]39typedef char *(*set_eval) ( struct set *set, char *value );
[b7d3cc34]41typedef struct set
[d5ccd83]43        void *data;     /* Here you can save a pointer to the
44                           object this settings belongs to. */
[b7d3cc34]46        char *key;
47        char *value;
[d5ccd83]48        char *def;      /* Default value. If the set_setstr() function
49                           notices a new value is exactly the same as
50                           the default, value gets set to NULL. So when
[723e611]51                           you read a setting, don't forget about this!
52                           In fact, you should only read values using
53                           set_getstr/int(). */
[d5ccd83]55        int flags;      /* See account.h, for example. set.c doesn't use
56                           this (yet?). */
[5c9512f]58        /* Eval: Returns NULL if the value is incorrect or exactly the
59           passed value variable. When returning a corrected value,
60           set_setstr() should be able to free() the returned string! */
[0383943]61        set_eval eval;
[b7d3cc34]62        struct set *next;
63} set_t;
[d5ccd83]65/* Should be pretty clear. */
[0383943]66set_t *set_add( set_t **head, char *key, char *def, set_eval eval, void *data );
68/* Returns the raw set_t. Might be useful sometimes. */
[5100caa]69set_t *set_find( set_t **head, char *key );
71/* Returns a pointer to the string value of this setting. Don't modify the
72   returned string, and don't free() it! */
[5c9512f]73G_MODULE_EXPORT char *set_getstr( set_t **head, char *key );
[723e611]75/* Get an integer. In previous versions set_getint() was also used to read
76   boolean values, but this SHOULD be done with set_getbool() now! */
[5c9512f]77G_MODULE_EXPORT int set_getint( set_t **head, char *key );
[fef6116]78G_MODULE_EXPORT int set_getbool( set_t **head, char *key );
80/* set_setstr() strdup()s the given value, so after using this function
81   you can free() it, if you want. */
[5c9512f]82int set_setstr( set_t **head, char *key, char *value );
83int set_setint( set_t **head, char *key, int value );
84void set_del( set_t **head, char *key );
[d5ccd83]86/* Two very useful generic evaluators. */
[5c9512f]87char *set_eval_int( set_t *set, char *value );
88char *set_eval_bool( set_t *set, char *value );
[d5ccd83]90/* Some not very generic evaluators that really shouldn't be here... */
[5c9512f]91char *set_eval_to_char( set_t *set, char *value );
92char *set_eval_ops( set_t *set, char *value );
93char *set_eval_charset( set_t *set, char *value );
Note: See TracBrowser for help on using the repository browser.