Annotation of libaitcfg/inc/aitcfg.h, revision 1.20
1.2 misho 1: /*************************************************************************
2: * (C) 2008 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
3: * by Michael Pounov <misho@openbsd-bg.org>
4: *
5: * $Author: misho $
1.20 ! misho 6: * $Id: aitcfg.h,v 1.19.4.1 2024/12/09 13:16:20 misho Exp $
1.2 misho 7: *
1.6 misho 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:
1.20 ! misho 15: Copyright 2004 - 2024
1.6 misho 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: */
1.1 misho 46: #ifndef __AITCFG_H
47: #define __AITCFG_H
48:
49:
1.7 misho 50: #include <pthread.h>
1.11 misho 51: #include <elwix.h>
1.1 misho 52:
53:
1.7 misho 54: struct tagCfg {
55: ait_val_t cfg_sec;
56: ait_val_t cfg_attr;
57: ait_val_t cfg_val;
1.19 misho 58: int cfg_quoted;
1.1 misho 59:
1.13 misho 60: TAILQ_ENTRY(tagCfg) cfg_next;
1.7 misho 61: RB_ENTRY(tagCfg) cfg_node;
62: };
63: typedef struct tagRC {
64: pthread_mutex_t rc_mtx;
1.4 misho 65:
1.13 misho 66: struct tagCfg *tqh_first;
67: struct tagCfg **tqh_last;
1.7 misho 68: struct tagCfg *rbh_root;
69: } cfg_root_t;
70: #define CFG_RC_LOCK(x) pthread_mutex_lock(&(x)->rc_mtx)
71: #define CFG_RC_UNLOCK(x) pthread_mutex_unlock(&(x)->rc_mtx)
1.1 misho 72:
1.15 misho 73: #define CFG_SECTION(x) (assert((x)), AIT_GET_LIKE(&((struct tagCfg*) (x))->cfg_sec, const char*))
74: #define CFG_ATTRIBUTE(x) (assert((x)), AIT_GET_LIKE(&((struct tagCfg*) (x))->cfg_attr, const char*))
75: #define CFG_VALUE(x) (assert((x)), AIT_GET_LIKE(&((struct tagCfg*) (x))->cfg_val, const char*))
76:
1.20 ! misho 77: #ifdef __cplusplus
! 78: extern "C" {
! 79: #endif
1.1 misho 80:
81: // cfg_GetErrno() Get error code of last operation
1.11 misho 82: int cfg_GetErrno();
1.1 misho 83: // cfg_GetError() Get error text of last operation
1.11 misho 84: const char *cfg_GetError();
1.1 misho 85:
86:
87: /*
1.7 misho 88: * Macros for config library.
89: */
90: #define CFG_ISEMPTY(x) RB_EMPTY((x))
1.1 misho 91:
1.3 misho 92:
93: /*
1.7 misho 94: * cfgInitConfig() - Init config root
95: *
1.14 misho 96: * return: NULL error or !=NULL allocated config root
97: */
98: cfg_root_t *cfgInitConfig();
99: /*
100: * cfgEndConfig() - Free resources & config root
101: *
102: * @pcfg = Config root
103: * return: none
1.7 misho 104: */
1.14 misho 105: void cfgEndConfig(cfg_root_t **pcfg);
1.7 misho 106: /*
107: * cfgLoadConfig() - Load config from file
108: *
109: * @cfgName = Config filename
110: * @cfg = Config root
111: * return: -1 error or 0 ok
112: */
113: int cfgLoadConfig(const char *cfgName, cfg_root_t * __restrict cfg);
114: /*
1.8 misho 115: * cfgUnloadConfig() - Unload config from memory and destroy resources
1.7 misho 116: *
117: * @cfg = Config root
118: * return: none
119: */
120: void cfgUnloadConfig(cfg_root_t * __restrict cfg);
1.3 misho 121: /*
1.8 misho 122: * cfgClearConfig() - Clear config and free resources
123: *
124: * @cfg = Config root
125: * return: none
126: */
127: void cfgClearConfig(cfg_root_t * __restrict cfg);
128: /*
1.7 misho 129: * cfgCreateConfig() - Create config file from memory
130: *
131: * @csConfigName = New config filename
132: * @cfg = Config root
133: * @whitespace = Additional whitespace characters to file
134: * return: -1 error or 0 ok
135: */
136: int cfgCreateConfig(const char *csConfigName, cfg_root_t * __restrict cfg,
137: int whitespace);
138:
139: /*
1.9 misho 140: * cfgReadLines() - Read custom lines and add new item at config root
141: *
142: * @f = File resource
143: * @delim = Custom delimiter, if =NULL default is '='
144: * @end = Custom user end of file, if =NULL default is EOF
145: * @cfg = Config root
146: * return: -1 error or 0 ok
147: */
148: int cfgReadLines(FILE *f, const char *delim, const char *end,
149: cfg_root_t * __restrict cfg);
150: /*
1.10 misho 151: * cfgWriteLines() - Write custom lines and export data to variable
152: *
153: * @f = File resource
154: * @delim = Custom delimiter, if =NULL default is '='
155: * @eol = End of line string, if =NULL default is "\n"
156: * @section = Export only section, if =NULL default is all
157: * @cfg = Config root
1.11 misho 158: * return: =NULL error or !=NULL exported data, must be free after use with ait_freeVar()
1.10 misho 159: */
160: ait_val_t *cfgWriteLines(FILE *f, const char *delim, const char *eol,
161: const char *section, cfg_root_t * __restrict cfg);
162: /*
1.7 misho 163: * cfgReadConfig() - Read file and add new item at config root
164: *
165: * @f = File resource
166: * @cfg = Config root
167: * return: -1 error or 0 ok
168: */
169: int cfgReadConfig(FILE *f, cfg_root_t * __restrict cfg);
170: /*
171: * cfgWriteConfig() - Write config from memory
172: *
173: * @f = File handle
174: * @cfg = Config root
175: * @whitespace = Additional whitespace characters to file
176: * return: -1 error or 0 ok
177: */
178: int cfgWriteConfig(FILE *f, cfg_root_t * __restrict cfg, int whitespace);
179: /*
1.18 misho 180: * cfgWriteConfigRaw() - Write config from memory by list
181: *
182: * @f = File handle
183: * @cfg = Config root
184: * @whitespace = Additional whitespace characters to file
185: * return: -1 error or 0 ok
186: */
187: int cfgWriteConfigRaw(FILE *f, cfg_root_t * __restrict cfg, int whitespace);
188: /*
1.7 misho 189: * cfgConcatConfig() - Concat two configs into one
190: *
191: * @cfg = Config root
192: * @add_cfg = Concated config will be destroy after merge
193: * return: -1 error or 0 ok
194: */
195: int cfgConcatConfig(cfg_root_t * __restrict cfg, cfg_root_t * __restrict add_cfg);
196: /*
197: * cfgMergeConfig() - Marge two list in one cfg and destroy add_cfg
198: *
199: * @cfg = Config root of main list
200: * @add_cfg = Merged config will be destroy after merge
201: * return: -1 error or 0 ok
202: */
203: int cfgMergeConfig(cfg_root_t * __restrict cfg, cfg_root_t * __restrict add_cfg);
204:
1.17 misho 205: /*
206: * cfg_dumpCfg() - dump config data
207: *
208: * @cfg = Config root
209: * return: none
210: */
211: void cfg_dumpCfg(cfg_root_t * __restrict cfg);
1.7 misho 212: /*
1.15 misho 213: * cfg_getSection() - Get entire section attributes into array
214: *
215: * @cfg = Config root
216: * @csSec = Config section //[{csSec}]
217: * return: NULL not found or !=NULL allocated array, must free with array_Destroy() after use!
218: */
219: array_t *cfg_getSection(cfg_root_t * __restrict cfg, const char *csSec);
220: /*
1.7 misho 221: * cfg_findAttribute() - Find attribute position in config file
222: *
223: * @cfg = Config root
1.1 misho 224: * @csSec = Config section //[{csSec}]
1.18 misho 225: * @csAttr = Config attribute //{csAttr} = ...
1.7 misho 226: * return: 0 not found item, -1 error or >0 position in list
227: */
1.11 misho 228: int cfg_findAttribute(cfg_root_t * __restrict cfg,
1.7 misho 229: const char *csSec, const char *csAttr);
230: /*
231: * cfg_getAttribute() - Get item from config and return value from it
232: *
233: * @cfg = Config root
234: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
1.18 misho 235: * @csAttr = Config attribute //{csAttr} = ...
1.7 misho 236: * return: NULL item not found or null parameters, !=NULL value const string
237: */
1.11 misho 238: const char *cfg_getAttribute(cfg_root_t * __restrict cfg,
1.7 misho 239: const char *csSec, const char *csAttr);
240: /*
1.16 misho 241: * cfg_getAttributeLong() - Get item as long from config and return value from it
242: *
243: * @cfg = Config root
244: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
1.18 misho 245: * @csAttr = Config attribute //{csAttr} = ...
1.16 misho 246: * return: value
247: */
248: long cfg_getAttributeLong(cfg_root_t * __restrict cfg,
249: const char *csSec, const char *csAttr);
250: /*
251: * cfg_getAttributeLLong() - Get item as long long from config and return value from it
252: *
253: * @cfg = Config root
254: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
1.18 misho 255: * @csAttr = Config attribute //{csAttr} = ...
1.16 misho 256: * return: value
257: */
258: long long
259: cfg_getAttributeLLong(cfg_root_t * __restrict cfg,
260: const char *csSec, const char *csAttr);
261: /*
262: * cfg_getAttributeDouble() - Get item as double from config and return value from it
263: *
264: * @cfg = Config root
265: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
1.18 misho 266: * @csAttr = Config attribute //{csAttr} = ...
1.16 misho 267: * return: value
268: */
269: double cfg_getAttributeDouble(cfg_root_t * __restrict cfg,
270: const char *csSec, const char *csAttr);
271: /*
272: * cfg_getAttributeLDouble() - Get item as long double from config and return value from it
273: *
274: * @cfg = Config root
275: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
1.18 misho 276: * @csAttr = Config attribute //{csAttr} = ...
1.16 misho 277: * return: value
278: */
279: long double cfg_getAttributeLDouble(cfg_root_t * __restrict cfg,
280: const char *csSec, const char *csAttr);
281: /*
1.7 misho 282: * cfg_setAttribute() - Set item in config or adding new item if not exists
283: *
284: * @cfg = Config root
1.1 misho 285: * @csSec = Config section //[{csSec}], if NULL set in *default* section
1.7 misho 286: * @csAttr = Config attribute //{csAttr} = ...
1.1 misho 287: * @csVal = Config value //... = {csVal} to setup
1.7 misho 288: * return: 0 nothing changed, -1 error, 1 found and updated item or 2 added new item
289: */
290: int cfg_setAttribute(cfg_root_t * __restrict cfg, const char *csSec,
291: const char *csAttr, const char *csVal);
292: /*
293: * cfg_unsetAttribute() - Unset item from config and free resources
294: *
295: * @cfg = Config root
1.1 misho 296: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
1.18 misho 297: * @csAttr = Config attribute //{csAttr} = ...
1.7 misho 298: * return: 0 item not found, -1 error or 1 removed item
299: */
300: int cfg_unsetAttribute(cfg_root_t * __restrict cfg, const char *csSec,
301: const char *csAttr);
1.1 misho 302:
303: /*
1.7 misho 304: * cfg_loadAttribute() - Get guarded attribute, if not found item return *default value*
305: *
306: * @cfg = Config root
1.1 misho 307: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
1.18 misho 308: * @csAttr = Config attribute //{csAttr} = ...
1.7 misho 309: * @val = Return buffer for item Value //... = {val}
310: * @csDefValue = *Default Value* for return in //{val}, if not found item in config
311: * return: 0 item not found, -1 error or >0 number of copied bytes in //{val}
312: */
313: int cfg_loadAttribute(cfg_root_t * __restrict cfg, const char *csSec,
314: const char *csAttr, ait_val_t * __restrict val, const char *csDefValue);
1.1 misho 315:
1.20 ! misho 316: #ifdef __cplusplus
! 317: }
! 318: #endif
1.1 misho 319:
320: #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