source: set.h @ 180ab31

Last change on this file since 180ab31 was 180ab31, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-08-21T19:34:17Z

Added some neat whatsnew code that keeps track of the newest version of
BitlBee used by a user, and if it looks like s/he hasn't used this one
before, show a list of new features that may be interesting.

Since I don't think users will read any changelogs ever,
this is probably not a bad idea. If you hate it, the following command
should get rid of it forever: set last_version 9999999

  • Property mode set to 100644
File size: 4.2 KB
[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  \********************************************************************/
7/* Some stuff to register, handle and save user preferences             */
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.
15  This program is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  GNU General Public License for more details.
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
[7bee5af]26#ifndef __SET_H__
27#define __SET_H__
[7738014]29struct set;
[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.
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. */
[0383943]41typedef char *(*set_eval) ( struct set *set, char *value );
[7125cb3]43extern char *SET_INVALID;
[180ab31]45typedef enum
47        SET_NULL_OK = 0x0100,
48        SET_HIDDEN = 0x0200,
49} set_flags_t;
[b7d3cc34]51typedef struct set
[d5ccd83]53        void *data;     /* Here you can save a pointer to the
54                           object this settings belongs to. */
[b7d3cc34]56        char *key;
[88eaf4b]57        char *old_key;  /* Previously known as; for smooth upgrades. */
[b7d3cc34]58        char *value;
[d5ccd83]59        char *def;      /* Default value. If the set_setstr() function
60                           notices a new value is exactly the same as
61                           the default, value gets set to NULL. So when
[723e611]62                           you read a setting, don't forget about this!
63                           In fact, you should only read values using
64                           set_getstr/int(). */
[180ab31]66        set_flags_t flags; /* Mostly defined per user. */
[f6f5eee]68        /* Eval: Returns SET_INVALID if the value is incorrect, exactly
69           the passed value variable, or a corrected value. In case of
70           the latter, set_setstr() will free() the returned string! */
[0383943]71        set_eval eval;
[56244c0]72        void *eval_data;
[b7d3cc34]73        struct set *next;
74} set_t;
[d5ccd83]76/* Should be pretty clear. */
[0f7ee7e5]77set_t *set_add( set_t **head, const char *key, const char *def, set_eval eval, void *data );
79/* Returns the raw set_t. Might be useful sometimes. */
[b74b287]80set_t *set_find( set_t **head, const char *key );
82/* Returns a pointer to the string value of this setting. Don't modify the
83   returned string, and don't free() it! */
[b74b287]84G_MODULE_EXPORT char *set_getstr( set_t **head, const char *key );
[723e611]86/* Get an integer. In previous versions set_getint() was also used to read
87   boolean values, but this SHOULD be done with set_getbool() now! */
[b74b287]88G_MODULE_EXPORT int set_getint( set_t **head, const char *key );
89G_MODULE_EXPORT int set_getbool( set_t **head, const char *key );
91/* set_setstr() strdup()s the given value, so after using this function
92   you can free() it, if you want. */
[b74b287]93int set_setstr( set_t **head, const char *key, char *value );
94int set_setint( set_t **head, const char *key, int value );
95void set_del( set_t **head, const char *key );
96int set_reset( set_t **head, const char *key );
[d5ccd83]98/* Two very useful generic evaluators. */
[5c9512f]99char *set_eval_int( set_t *set, char *value );
100char *set_eval_bool( set_t *set, char *value );
[56244c0]102/* Another more complicated one. */
103char *set_eval_list( set_t *set, char *value );
[d5ccd83]105/* Some not very generic evaluators that really shouldn't be here... */
[5c9512f]106char *set_eval_to_char( set_t *set, char *value );
107char *set_eval_ops( set_t *set, char *value );
109#endif /* __SET_H__ */
Note: See TracBrowser for help on using the repository browser.