1: /*************************************************************************
2: * (C) 2008 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
3: * by Michael Pounov <misho@openbsd-bg.org>
4: *
5: * $Author: misho $
6: * $Id: aitcfg.h,v 1.6.4.5 2012/04/03 09:21:06 misho Exp $
7: *
8: **************************************************************************
9: The ELWIX and AITNET software is distributed under the following
10: terms:
11:
12: All of the documentation and software included in the ELWIX and AITNET
13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
14:
15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
16: by Michael Pounov <misho@elwix.org>. All rights reserved.
17:
18: Redistribution and use in source and binary forms, with or without
19: modification, are permitted provided that the following conditions
20: are met:
21: 1. Redistributions of source code must retain the above copyright
22: notice, this list of conditions and the following disclaimer.
23: 2. Redistributions in binary form must reproduce the above copyright
24: notice, this list of conditions and the following disclaimer in the
25: documentation and/or other materials provided with the distribution.
26: 3. All advertising materials mentioning features or use of this software
27: must display the following acknowledgement:
28: This product includes software developed by Michael Pounov <misho@elwix.org>
29: ELWIX - Embedded LightWeight unIX and its contributors.
30: 4. Neither the name of AITNET nor the names of its contributors
31: may be used to endorse or promote products derived from this software
32: without specific prior written permission.
33:
34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37: ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44: SUCH DAMAGE.
45: */
46: #ifndef __AITCFG_H
47: #define __AITCFG_H
48:
49:
50: #include <aitio.h>
51: #include <atree.h>
52:
53:
54: struct tagCfg {
55: ait_val_t cfg_sec;
56: ait_val_t cfg_attr;
57: ait_val_t cfg_val;
58:
59: SLIST_ENTRY(tagCfg) cfg_next;
60: RB_ENTRY(tagCfg) cfg_node;
61: };
62: typedef struct tagRC {
63: #ifdef HAVE_LIBPTHREAD
64: pthread_mutex_t rc_mtx;
65: #endif
66: struct tagCfg *slh_first;
67: struct tagCfg *rbh_root;
68: } cfg_root_t;
69: #ifdef HAVE_LIBPTHREAD
70: #define CFG_RC_LOCK(x) pthread_mutex_lock(&(x)->rc_mtx)
71: #define CFG_RC_UNLOCK(x) pthread_mutex_unlock(&(x)->rc_mtx)
72: #else
73: #define CFG_RC_LOCK(x)
74: #define CFG_RC_UNLOCK(x)
75: #endif
76:
77:
78: // cfg_GetErrno() Get error code of last operation
79: inline int cfg_GetErrno();
80: // cfg_GetError() Get error text of last operation
81: inline const char *cfg_GetError();
82:
83:
84: /*
85: * Macros for config library.
86: */
87: #define CFG_ISEMPTY(x) RB_EMPTY((x))
88:
89:
90: /*
91: * cfgInitConfig() - Init config root
92: *
93: * @cfg = Config root
94: * return: -1 error or 0 ok
95: */
96: int cfgInitConfig(cfg_root_t * __restrict cfg);
97: /*
98: * cfgLoadConfig() - Load config from file
99: *
100: * @cfgName = Config filename
101: * @cfg = Config root
102: * return: -1 error or 0 ok
103: */
104: int cfgLoadConfig(const char *cfgName, cfg_root_t * __restrict cfg);
105: /*
106: * cfgUnloadConfig() - Unload config from memory and free resources
107: *
108: * @cfg = Config root
109: * return: none
110: */
111: void cfgUnloadConfig(cfg_root_t * __restrict cfg);
112:
113: /*
114: * cfgReadConfig() - Read file and add new item at config root
115: *
116: * @f = File resource
117: * @cfg = Config root
118: * return: -1 error or 0 ok
119: */
120: int cfgReadConfig(FILE *f, cfg_root_t * __restrict cfg);
121: /*
122: * cfgWriteConfig() - Write config from memory
123: *
124: * @f = File handle
125: * @cfg = Config root
126: * @whitespace = Additional whitespace characters to file
127: * return: -1 error or 0 ok
128: */
129: int cfgWriteConfig(FILE *f, cfg_root_t * __restrict cfg, int whitespace);
130:
131: #if 0
132: /*
133: * cfg_CreateConfig() Create config file from memory without whitespaces!
134: * @csConfigName = New config filename
135: * @cfg = Head list element
136: * return: 0 ok; -1 error:: can`t save new config
137: */
138: int cfg_CreateConfig(const char *csConfigName, sl_config * __restrict cfg);
139: /*
140: * CreateConfig() Create config file from memory
141: * @csConfigName = New config filename
142: * @cfg = Head list element
143: * return: 0 ok; -1 error:: can`t save new config
144: */
145: int CreateConfig(const char *csConfigName, sl_config * __restrict cfg);
146:
147:
148: /*
149: * ConcatConfig() Concat two list in one
150: * @cfg = Head list element of main list
151: * @add_cfg = Head list element of added list
152: * return: 0 ok; -1 error:: can`t concat lists
153: */
154: int ConcatConfig(sl_config * __restrict cfg, sl_config * __restrict add_cfg);
155:
156: /*
157: * MergeConfig() Marge two list in one cfg and destroy add_cfg
158: * @cfg = Head list element of main list
159: * @add_cfg = Head list element of merged list (destroy after all!)
160: * return: 0 ok; -1 error:: can`t merge lists
161: */
162: int MergeConfig(sl_config * __restrict cfg, sl_config * __restrict add_cfg);
163: #endif
164:
165: /*
166: * cfg_findAttribute() - Find attribute position in config file
167: *
168: * @cfg = Config root
169: * @csSec = Config section //[{csSec}]
170: * @csAttr = Config attribute //{csAttr} = ...
171: * return: 0 not found item, -1 error or >0 position in list
172: */
173: inline int cfg_findAttribute(cfg_root_t * __restrict cfg,
174: const char *csSec, const char *csAttr);
175: /*
176: * cfg_getAttribute() - Get item from config and return value from it
177: *
178: * @cfg = Config root
179: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
180: * @csAttr = Config attribute //{csAttr} = ..., if NULL unset as *any* attribute
181: * return: NULL item not found or null parameters, !=NULL value const string
182: */
183: inline const char *cfg_getAttribute(cfg_root_t * __restrict cfg,
184: const char *csSec, const char *csAttr);
185: /*
186: * cfg_setAttribute() - Set item in config or adding new item if not exists
187: *
188: * @cfg = Config root
189: * @csSec = Config section //[{csSec}], if NULL set in *default* section
190: * @csAttr = Config attribute //{csAttr} = ...
191: * @csVal = Config value //... = {csVal} to setup
192: * return: 0 nothing changed, -1 error, 1 found and updated item or 2 added new item
193: */
194: int cfg_setAttribute(cfg_root_t * __restrict cfg, const char *csSec,
195: const char *csAttr, const char *csVal);
196: /*
197: * cfg_unsetAttribute() - Unset item from config and free resources
198: *
199: * @cfg = Config root
200: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
201: * @csAttr = Config attribute //{csAttr} = ...
202: * return: 0 item not found, -1 error or 1 removed item
203: */
204: int cfg_unsetAttribute(cfg_root_t * __restrict cfg, const char *csSec,
205: const char *csAttr);
206:
207: /*
208: * cfg_loadAttribute() - Get guarded attribute, if not found item return *default value*
209: *
210: * @cfg = Config root
211: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
212: * @csAttr = Config attribute //{csAttr} = ...
213: * @val = Return buffer for item Value //... = {val}
214: * @csDefValue = *Default Value* for return in //{val}, if not found item in config
215: * return: 0 item not found, -1 error or >0 number of copied bytes in //{val}
216: */
217: int cfg_loadAttribute(cfg_root_t * __restrict cfg, const char *csSec,
218: const char *csAttr, ait_val_t * __restrict val, const char *csDefValue);
219:
220:
221: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to aitcfg.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libaitcfg / inc