source: set.h @ 50b8978

Last change on this file since 50b8978 was f6f5eee, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-07-27T22:04:19Z

Source documentation update, including a short HACKING file.

  • Property mode set to 100644
File size: 4.2 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#ifndef __SET_H__
27#define __SET_H__
28
29struct 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
41typedef char *(*set_eval) ( struct set *set, char *value );
42
43extern char *SET_INVALID;
44
45#define SET_NULL_OK        0x0100
46
47typedef struct set
48{
49        void *data;     /* Here you can save a pointer to the
50                           object this settings belongs to. */
51       
52        char *key;
53        char *old_key;  /* Previously known as; for smooth upgrades. */
54        char *value;
55        char *def;      /* Default value. If the set_setstr() function
56                           notices a new value is exactly the same as
57                           the default, value gets set to NULL. So when
58                           you read a setting, don't forget about this!
59                           In fact, you should only read values using
60                           set_getstr/int(). */
61       
62        int flags;      /* See account.h, for example. set.c doesn't use
63                           this (yet?). */
64       
65        /* Eval: Returns SET_INVALID if the value is incorrect, exactly
66           the passed value variable, or a corrected value. In case of
67           the latter, set_setstr() will free() the returned string! */
68        set_eval eval;
69        void *eval_data;
70        struct set *next;
71} set_t;
72
73/* Should be pretty clear. */
74set_t *set_add( set_t **head, const char *key, const char *def, set_eval eval, void *data );
75
76/* Returns the raw set_t. Might be useful sometimes. */
77set_t *set_find( set_t **head, const char *key );
78
79/* Returns a pointer to the string value of this setting. Don't modify the
80   returned string, and don't free() it! */
81G_MODULE_EXPORT char *set_getstr( set_t **head, const char *key );
82
83/* Get an integer. In previous versions set_getint() was also used to read
84   boolean values, but this SHOULD be done with set_getbool() now! */
85G_MODULE_EXPORT int set_getint( set_t **head, const char *key );
86G_MODULE_EXPORT int set_getbool( set_t **head, const char *key );
87
88/* set_setstr() strdup()s the given value, so after using this function
89   you can free() it, if you want. */
90int set_setstr( set_t **head, const char *key, char *value );
91int set_setint( set_t **head, const char *key, int value );
92void set_del( set_t **head, const char *key );
93int set_reset( set_t **head, const char *key );
94
95/* Two very useful generic evaluators. */
96char *set_eval_int( set_t *set, char *value );
97char *set_eval_bool( set_t *set, char *value );
98
99/* Another more complicated one. */
100char *set_eval_list( set_t *set, char *value );
101
102/* Some not very generic evaluators that really shouldn't be here... */
103char *set_eval_to_char( set_t *set, char *value );
104char *set_eval_ops( set_t *set, char *value );
105
106#endif /* __SET_H__ */
Note: See TracBrowser for help on using the repository browser.