Kannel: Open Source WAP and SMS gateway  $Revision: 5037 $
cfg.h
Go to the documentation of this file.
1 /* ====================================================================
2  * The Kannel Software License, Version 1.0
3  *
4  * Copyright (c) 2001-2016 Kannel Group
5  * Copyright (c) 1998-2001 WapIT Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Kannel Group (http://www.kannel.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Kannel" and "Kannel Group" must not be used to
28  * endorse or promote products derived from this software without
29  * prior written permission. For written permission, please
30  * contact org@kannel.org.
31  *
32  * 5. Products derived from this software may not be called "Kannel",
33  * nor may "Kannel" appear in their name, without prior written
34  * permission of the Kannel Group.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE KANNEL GROUP OR ITS CONTRIBUTORS
40  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
41  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
42  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
43  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
44  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
45  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
46  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Kannel Group. For more information on
51  * the Kannel Group, please see <http://www.kannel.org/>.
52  *
53  * Portions of this software are based upon software originally written at
54  * WapIT Ltd., Helsinki, Finland for the Kannel project.
55  */
56 
57 /*
58  * cfg.h - configuration file handling
59  *
60  * All returned octet strings are copies which the caller should destroy.
61  *
62  * Lars Wirzenius
63  */
64 
65 
66 #ifndef CFG_H
67 #define CFG_H
68 
69 typedef struct Cfg Cfg;
70 typedef struct CfgLoc CfgLoc;
71 typedef struct CfgGroup CfgGroup;
72 
74 void cfg_destroy(Cfg *cfg);
75 int cfg_read(Cfg *cfg);
76 void cfg_add_hooks(void *allowed, void *single);
77 
83 
84 Octstr *cfg_get_real(CfgGroup *grp, Octstr *varname, const char *file,
85  long line, const char *func);
86 #define cfg_get(grp, varname) \
87  cfg_get_real(grp, varname, __FILE__, __LINE__, __func__)
88 int cfg_get_integer(long *n, CfgGroup *grp, Octstr *varname);
89 
90 /* Return -1 and set n to 0 if no varname found
91  * otherwise return 0 and set n to 0 if value is no, false, off or 0,
92  * and 1 if it is true, yes, on or 1. Set n to 1 for other values, too
93  */
94 int cfg_get_bool(int *n, CfgGroup *grp, Octstr *varname);
95 List *cfg_get_list(CfgGroup *grp, Octstr *varname);
96 void cfg_set(CfgGroup *grp, Octstr *varname, Octstr *value);
97 
98 void grp_dump(CfgGroup *grp);
99 void cfg_dump(Cfg *cfg);
100 
101 void cfg_init(void);
102 void cfg_shutdown(void);
103 
104 /*
105  * Dump all known config groups and values to stdout.
106  */
107 void cfg_dump_all(void);
108 
109 #endif
void cfg_dump_all(void)
Definition: cfg.c:866
int cfg_get_integer(long *n, CfgGroup *grp, Octstr *varname)
Definition: cfg.c:739
void grp_dump(CfgGroup *grp)
Definition: cfg.c:808
List * cfg_get_multi_group(Cfg *cfg, Octstr *name)
Definition: cfg.c:642
CfgGroup * cfg_get_single_group(Cfg *cfg, Octstr *name)
Definition: cfg.c:636
Definition: cfg.c:107
FILE * file
Definition: log.c:133
void cfg_init(void)
Definition: cfg.c:884
Octstr * cfg_get_configfile(CfgGroup *grp)
Definition: cfg.c:713
Definition: cfg.c:164
Octstr * cfg_get_group_checksum(CfgGroup *grp,...)
Definition: cfg.c:663
char * name
Definition: smsc_cimd2.c:212
char filename[FILENAME_MAX+1]
Definition: log.c:135
void cfg_shutdown(void)
Definition: cfg.c:895
void cfg_add_hooks(void *allowed, void *single)
Definition: cfg.c:253
long line
Definition: cfg.c:77
Octstr * cfg_get_real(CfgGroup *grp, Octstr *varname, const char *file, long line, const char *func)
Definition: cfg.c:719
static Cfg * cfg
Definition: smsbox.c:115
Definition: octstr.c:118
void cfg_dump(Cfg *cfg)
Definition: cfg.c:832
Definition: cfg.c:73
void cfg_destroy(Cfg *cfg)
Definition: cfg.c:331
void cfg_set(CfgGroup *grp, Octstr *varname, Octstr *value)
Definition: cfg.c:802
List * cfg_get_list(CfgGroup *grp, Octstr *varname)
Definition: cfg.c:787
Octstr * cfg_get_group_name(CfgGroup *grp)
Definition: cfg.c:658
Definition: list.c:102
Cfg * cfg_create(Octstr *filename)
Definition: cfg.c:318
int cfg_get_bool(int *n, CfgGroup *grp, Octstr *varname)
Definition: cfg.c:756
int cfg_read(Cfg *cfg)
Definition: cfg.c:452
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.