source: set.h @ e97827b

Last change on this file since e97827b was 0383943, checked in by Wilmer van der Gaast <wilmer@…>, at 2006-08-24T22:06:52Z

Added message on successful creation of accounts and fixed "set password"
command.

  • Property mode set to 100644
File size: 3.8 KB
Line 
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/* 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.
29   
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
34   NULL, or replace it by returning a new value. See struct set.eval. */
35
36typedef char *(*set_eval) ( struct set *set, char *value );
37
38typedef struct set
39{
40        void *data;     /* Here you can save a pointer to the
41                           object this settings belongs to. */
42       
43        char *key;
44        char *value;
45        char *def;      /* Default value. If the set_setstr() function
46                           notices a new value is exactly the same as
47                           the default, value gets set to NULL. So when
48                           you read a setting, don't forget about this! */
49       
50        int flags;      /* See account.h, for example. set.c doesn't use
51                           this (yet?). */
52       
53        /* Eval: Returns NULL if the value is incorrect or exactly the
54           passed value variable. When returning a corrected value,
55           set_setstr() should be able to free() the returned string! */
56        set_eval eval;
57        struct set *next;
58} set_t;
59
60/* Should be pretty clear. */
61set_t *set_add( set_t **head, char *key, char *def, set_eval eval, void *data );
62
63/* Returns the raw set_t. Might be useful sometimes. */
64set_t *set_find( set_t **head, char *key );
65
66/* Returns a pointer to the string value of this setting. Don't modify the
67   returned string, and don't free() it! */
68G_MODULE_EXPORT char *set_getstr( set_t **head, char *key );
69
70/* Get an integer. Right now this also converts true/false/on/off/etc to
71   numbers, but this is for historical reasons, please use set_getbool()
72   for booleans instead. */
73G_MODULE_EXPORT int set_getint( set_t **head, char *key );
74G_MODULE_EXPORT int set_getbool( set_t **head, char *key );
75
76/* set_setstr() strdup()s the given value, so after using this function
77   you can free() it, if you want. */
78int set_setstr( set_t **head, char *key, char *value );
79int set_setint( set_t **head, char *key, int value );
80void set_del( set_t **head, char *key );
81
82/* Two very useful generic evaluators. */
83char *set_eval_int( set_t *set, char *value );
84char *set_eval_bool( set_t *set, char *value );
85
86/* Some not very generic evaluators that really shouldn't be here... */
87char *set_eval_to_char( set_t *set, char *value );
88char *set_eval_ops( set_t *set, char *value );
89char *set_eval_charset( set_t *set, char *value );
Note: See TracBrowser for help on using the repository browser.