source: set.h @ 7bee5af

Last change on this file since 7bee5af was 7bee5af, checked in by Jelmer Vernooij <jelmer@…>, at 2006-12-24T21:47:18Z

Add tests for set_url(). Fixed a bug where the default port wasn't
set when socks5 was used.

  • 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#ifndef __SET_H__
27#define __SET_H__
28
29/* This used to be specific to irc_t structures, but it's more generic now
30   (so it can also be used for account_t structs). It's pretty simple, but
31   so far pretty useful.
32   
33   In short, it just keeps a linked list of settings/variables and it also
34   remembers a default value for every setting. And to prevent the user
35   from setting invalid values, you can write an evaluator function for
36   every setting, which can check a new value and block it by returning
37   NULL, or replace it by returning a new value. See struct set.eval. */
38
39typedef char *(*set_eval) ( struct set *set, char *value );
40
41typedef struct set
42{
43        void *data;     /* Here you can save a pointer to the
44                           object this settings belongs to. */
45       
46        char *key;
47        char *value;
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
51                           you read a setting, don't forget about this! */
52       
53        int flags;      /* See account.h, for example. set.c doesn't use
54                           this (yet?). */
55       
56        /* Eval: Returns NULL if the value is incorrect or exactly the
57           passed value variable. When returning a corrected value,
58           set_setstr() should be able to free() the returned string! */
59        set_eval eval;
60        struct set *next;
61} set_t;
62
63/* Should be pretty clear. */
64set_t *set_add( set_t **head, char *key, char *def, set_eval eval, void *data );
65
66/* Returns the raw set_t. Might be useful sometimes. */
67set_t *set_find( set_t **head, char *key );
68
69/* Returns a pointer to the string value of this setting. Don't modify the
70   returned string, and don't free() it! */
71G_MODULE_EXPORT char *set_getstr( set_t **head, char *key );
72
73/* Get an integer. Right now this also converts true/false/on/off/etc to
74   numbers, but this is for historical reasons, please use set_getbool()
75   for booleans instead. */
76G_MODULE_EXPORT int set_getint( set_t **head, char *key );
77G_MODULE_EXPORT int set_getbool( set_t **head, char *key );
78
79/* set_setstr() strdup()s the given value, so after using this function
80   you can free() it, if you want. */
81int set_setstr( set_t **head, char *key, char *value );
82int set_setint( set_t **head, char *key, int value );
83void set_del( set_t **head, char *key );
84
85/* Two very useful generic evaluators. */
86char *set_eval_int( set_t *set, char *value );
87char *set_eval_bool( set_t *set, char *value );
88
89/* Some not very generic evaluators that really shouldn't be here... */
90char *set_eval_to_char( set_t *set, char *value );
91char *set_eval_ops( set_t *set, char *value );
92char *set_eval_charset( set_t *set, char *value );
93
94#endif /* __SET_H__ */
Note: See TracBrowser for help on using the repository browser.