source: set.h @ 7738014

Last change on this file since 7738014 was 7738014, checked in by Jelmer Vernooij <jelmer@…>, at 2007-01-21T22:08:56Z

Add tests for set

  • Property mode set to 100644
File size: 3.9 KB
RevLine 
[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  \********************************************************************/
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
[7bee5af]26#ifndef __SET_H__
27#define __SET_H__
28
[7738014]29struct set;
30
[d5ccd83]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
[0383943]41typedef char *(*set_eval) ( struct set *set, char *value );
42
[b7d3cc34]43typedef struct set
44{
[d5ccd83]45        void *data;     /* Here you can save a pointer to the
46                           object this settings belongs to. */
[5c9512f]47       
[b7d3cc34]48        char *key;
49        char *value;
[d5ccd83]50        char *def;      /* Default value. If the set_setstr() function
51                           notices a new value is exactly the same as
52                           the default, value gets set to NULL. So when
53                           you read a setting, don't forget about this! */
[b7d3cc34]54       
[d5ccd83]55        int flags;      /* See account.h, for example. set.c doesn't use
56                           this (yet?). */
[5100caa]57       
[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;
64
[d5ccd83]65/* Should be pretty clear. */
[0383943]66set_t *set_add( set_t **head, char *key, char *def, set_eval eval, void *data );
[d5ccd83]67
68/* Returns the raw set_t. Might be useful sometimes. */
[5100caa]69set_t *set_find( set_t **head, char *key );
[d5ccd83]70
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 );
[d5ccd83]74
75/* Get an integer. Right now this also converts true/false/on/off/etc to
76   numbers, but this is for historical reasons, please use set_getbool()
77   for booleans instead. */
[5c9512f]78G_MODULE_EXPORT int set_getint( set_t **head, char *key );
[fef6116]79G_MODULE_EXPORT int set_getbool( set_t **head, char *key );
[d5ccd83]80
81/* set_setstr() strdup()s the given value, so after using this function
82   you can free() it, if you want. */
[5c9512f]83int set_setstr( set_t **head, char *key, char *value );
84int set_setint( set_t **head, char *key, int value );
85void set_del( set_t **head, char *key );
[b7d3cc34]86
[d5ccd83]87/* Two very useful generic evaluators. */
[5c9512f]88char *set_eval_int( set_t *set, char *value );
89char *set_eval_bool( set_t *set, char *value );
[1719464]90
[d5ccd83]91/* Some not very generic evaluators that really shouldn't be here... */
[5c9512f]92char *set_eval_to_char( set_t *set, char *value );
93char *set_eval_ops( set_t *set, char *value );
94char *set_eval_charset( set_t *set, char *value );
[7bee5af]95
96#endif /* __SET_H__ */
Note: See TracBrowser for help on using the repository browser.