source: set.h @ aa88e50

Last change on this file since aa88e50 was ce199b7, checked in by Wilmer van der Gaast <wilmer@…>, at 2011-12-21T11:21:04Z

Make it easier to add OAuth-authenticated accounts without having to type
a bogus password.

  • Property mode set to 100644
File size: 4.4 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
[f6f5eee]39   NULL, or replace it by returning a new value. See struct set.eval. */
[d5ccd83]40
[0383943]41typedef char *(*set_eval) ( struct set *set, char *value );
42
[7125cb3]43extern char *SET_INVALID;
44
[180ab31]45typedef enum
46{
[5df65bd]47        SET_NOSAVE = 0x0001,
[180ab31]48        SET_NULL_OK = 0x0100,
49        SET_HIDDEN = 0x0200,
[09d4922]50        SET_PASSWORD = 0x0400,
[06b5893]51        SET_HIDDEN_DEFAULT = 0x0800,
[180ab31]52} set_flags_t;
[7125cb3]53
[b7d3cc34]54typedef struct set
55{
[d5ccd83]56        void *data;     /* Here you can save a pointer to the
57                           object this settings belongs to. */
[5c9512f]58       
[b7d3cc34]59        char *key;
[88eaf4b]60        char *old_key;  /* Previously known as; for smooth upgrades. */
[b7d3cc34]61        char *value;
[d5ccd83]62        char *def;      /* Default value. If the set_setstr() function
63                           notices a new value is exactly the same as
64                           the default, value gets set to NULL. So when
[723e611]65                           you read a setting, don't forget about this!
66                           In fact, you should only read values using
67                           set_getstr/int(). */
[b7d3cc34]68       
[180ab31]69        set_flags_t flags; /* Mostly defined per user. */
[5100caa]70       
[f6f5eee]71        /* Eval: Returns SET_INVALID if the value is incorrect, exactly
72           the passed value variable, or a corrected value. In case of
73           the latter, set_setstr() will free() the returned string! */
[0383943]74        set_eval eval;
[56244c0]75        void *eval_data;
[b7d3cc34]76        struct set *next;
77} set_t;
78
[ce199b7]79#define set_value( set ) ((set)->value) ? ((set)->value) : ((set)->def)
80
[d5ccd83]81/* Should be pretty clear. */
[0f7ee7e5]82set_t *set_add( set_t **head, const char *key, const char *def, set_eval eval, void *data );
[d5ccd83]83
84/* Returns the raw set_t. Might be useful sometimes. */
[b74b287]85set_t *set_find( set_t **head, const char *key );
[d5ccd83]86
87/* Returns a pointer to the string value of this setting. Don't modify the
88   returned string, and don't free() it! */
[b74b287]89G_MODULE_EXPORT char *set_getstr( set_t **head, const char *key );
[d5ccd83]90
[723e611]91/* Get an integer. In previous versions set_getint() was also used to read
92   boolean values, but this SHOULD be done with set_getbool() now! */
[b74b287]93G_MODULE_EXPORT int set_getint( set_t **head, const char *key );
94G_MODULE_EXPORT int set_getbool( set_t **head, const char *key );
[d5ccd83]95
96/* set_setstr() strdup()s the given value, so after using this function
97   you can free() it, if you want. */
[b74b287]98int set_setstr( set_t **head, const char *key, char *value );
99int set_setint( set_t **head, const char *key, int value );
100void set_del( set_t **head, const char *key );
101int set_reset( set_t **head, const char *key );
[b7d3cc34]102
[06b5893]103/* returns true if a setting shall be shown to the user */
104int set_isvisible( set_t *set );
105
[d5ccd83]106/* Two very useful generic evaluators. */
[5c9512f]107char *set_eval_int( set_t *set, char *value );
108char *set_eval_bool( set_t *set, char *value );
[1719464]109
[56244c0]110/* Another more complicated one. */
111char *set_eval_list( set_t *set, char *value );
112
[d5ccd83]113/* Some not very generic evaluators that really shouldn't be here... */
[5c9512f]114char *set_eval_to_char( set_t *set, char *value );
[ce199b7]115char *set_eval_oauth( set_t *set, char *value );
[7bee5af]116
117#endif /* __SET_H__ */
Note: See TracBrowser for help on using the repository browser.