- #define CFG_INPUT_SHIFT is used instead of a hardwired value
[sip-router] / cfg / cfg.h
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2007 iptelorg GmbH
5  *
6  * This file is part of ser, a free SIP server.
7  *
8  * ser is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version
12  *
13  * For a license to use the ser software under conditions
14  * other than those described here, or to purchase support for this
15  * software, please contact iptel.org by e-mail at the following addresses:
16  *    info@iptel.org
17  *
18  * ser is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26  *
27  * History
28  * -------
29  *  2007-12-03  Initial version (Miklos)
30  */
31
32 #ifndef _CFG_H
33 #define _CFG_H
34
35 #include "../str.h"
36
37 #define CFG_VAR_INT             1U
38 #define CFG_VAR_STRING          2U
39 #define CFG_VAR_STR             3U
40 #define CFG_VAR_POINTER         4U
41
42 #define CFG_INPUT_SHIFT         3
43
44 #define CFG_INPUT_INT           (CFG_VAR_INT << CFG_INPUT_SHIFT)
45 #define CFG_INPUT_STRING        (CFG_VAR_STRING << CFG_INPUT_SHIFT)
46 #define CFG_INPUT_STR           (CFG_VAR_STR << CFG_INPUT_SHIFT)
47
48 #define CFG_VAR_MASK(x)         ((x)&(CFG_INPUT_INT-1))
49 #define CFG_INPUT_MASK(x)       ((x)&(~(CFG_INPUT_INT-1)))
50
51 typedef int (*cfg_on_change)(void *, str *, void **);
52 typedef void (*cfg_on_set_child)(str *);
53
54 /* strutrure to be used by the module interface */
55 typedef struct _cfg_def {
56         char    *name;
57         unsigned int    type;
58         int     min;
59         int     max;
60         cfg_on_change   on_change_cb;
61         cfg_on_set_child        on_set_child_cb;
62         char    *descr;
63 } cfg_def_t;
64
65 /* declares a new cfg group
66  * handler is set to the memory area where the variables are stored
67  * return value is -1 on error
68  */
69 int cfg_declare(char *group_name, cfg_def_t *def, void *values, int def_size,
70                         void **handler);
71
72 #define cfg_size(gname) \
73         sizeof(struct cfg_group_##gname)
74
75 #define cfg_get(gname, handle, var) \
76         ((struct cfg_group_##gname *)handle)->var
77
78 /* declares a single variable with integer type */
79 int cfg_declare_int(char *group_name, char *var_name, int val, char *descr);
80
81 /* declares a single variable with str type */
82 int cfg_declare_str(char *group_name, char *var_name, char *val, char *descr);
83
84 #endif /* _CFG_H */