Annotation of libaitcfg/inc/aitcfg.h, revision 1.22
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.22 ! misho 6: * $Id: aitcfg.h,v 1.21.2.1 2025/10/09 16:40:02 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.21 misho 15: Copyright 2004 - 2025
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: /*
1.21 misho 107: * cfgInitConfigExt() - Init existed config root
108: *
109: * @cfg = Config root
110: * return: -1 error or 0 inited config root
111: */
112: int cfgInitConfigExt(cfg_root_t * __restrict cfg);
113: /*
1.7 misho 114: * cfgLoadConfig() - Load config from file
115: *
116: * @cfgName = Config filename
117: * @cfg = Config root
118: * return: -1 error or 0 ok
119: */
120: int cfgLoadConfig(const char *cfgName, cfg_root_t * __restrict cfg);
121: /*
1.8 misho 122: * cfgUnloadConfig() - Unload config from memory and destroy resources
1.7 misho 123: *
124: * @cfg = Config root
125: * return: none
126: */
127: void cfgUnloadConfig(cfg_root_t * __restrict cfg);
1.3 misho 128: /*
1.8 misho 129: * cfgClearConfig() - Clear config and free resources
130: *
131: * @cfg = Config root
132: * return: none
133: */
134: void cfgClearConfig(cfg_root_t * __restrict cfg);
135: /*
1.7 misho 136: * cfgCreateConfig() - Create config file from memory
137: *
138: * @csConfigName = New config filename
139: * @cfg = Config root
140: * @whitespace = Additional whitespace characters to file
141: * return: -1 error or 0 ok
142: */
143: int cfgCreateConfig(const char *csConfigName, cfg_root_t * __restrict cfg,
144: int whitespace);
145:
146: /*
1.9 misho 147: * cfgReadLines() - Read custom lines and add new item at config root
148: *
149: * @f = File resource
150: * @delim = Custom delimiter, if =NULL default is '='
151: * @end = Custom user end of file, if =NULL default is EOF
152: * @cfg = Config root
153: * return: -1 error or 0 ok
154: */
155: int cfgReadLines(FILE *f, const char *delim, const char *end,
156: cfg_root_t * __restrict cfg);
157: /*
1.10 misho 158: * cfgWriteLines() - Write custom lines and export data to variable
159: *
160: * @f = File resource
161: * @delim = Custom delimiter, if =NULL default is '='
162: * @eol = End of line string, if =NULL default is "\n"
163: * @section = Export only section, if =NULL default is all
164: * @cfg = Config root
1.11 misho 165: * return: =NULL error or !=NULL exported data, must be free after use with ait_freeVar()
1.10 misho 166: */
167: ait_val_t *cfgWriteLines(FILE *f, const char *delim, const char *eol,
168: const char *section, cfg_root_t * __restrict cfg);
169: /*
1.7 misho 170: * cfgReadConfig() - Read file and add new item at config root
171: *
172: * @f = File resource
173: * @cfg = Config root
174: * return: -1 error or 0 ok
175: */
176: int cfgReadConfig(FILE *f, cfg_root_t * __restrict cfg);
177: /*
178: * cfgWriteConfig() - Write config from memory
179: *
180: * @f = File handle
181: * @cfg = Config root
182: * @whitespace = Additional whitespace characters to file
183: * return: -1 error or 0 ok
184: */
185: int cfgWriteConfig(FILE *f, cfg_root_t * __restrict cfg, int whitespace);
186: /*
1.18 misho 187: * cfgWriteConfigRaw() - Write config from memory by list
188: *
189: * @f = File handle
190: * @cfg = Config root
191: * @whitespace = Additional whitespace characters to file
192: * return: -1 error or 0 ok
193: */
194: int cfgWriteConfigRaw(FILE *f, cfg_root_t * __restrict cfg, int whitespace);
195: /*
1.7 misho 196: * cfgConcatConfig() - Concat two configs into one
197: *
198: * @cfg = Config root
199: * @add_cfg = Concated config will be destroy after merge
200: * return: -1 error or 0 ok
201: */
202: int cfgConcatConfig(cfg_root_t * __restrict cfg, cfg_root_t * __restrict add_cfg);
203: /*
204: * cfgMergeConfig() - Marge two list in one cfg and destroy add_cfg
205: *
206: * @cfg = Config root of main list
207: * @add_cfg = Merged config will be destroy after merge
208: * return: -1 error or 0 ok
209: */
210: int cfgMergeConfig(cfg_root_t * __restrict cfg, cfg_root_t * __restrict add_cfg);
211:
1.17 misho 212: /*
213: * cfg_dumpCfg() - dump config data
214: *
215: * @cfg = Config root
216: * return: none
217: */
218: void cfg_dumpCfg(cfg_root_t * __restrict cfg);
1.7 misho 219: /*
1.22 ! misho 220: * cfg_delSection() - Delete entire section
! 221: *
! 222: * @cfg = Config root
! 223: * @csSec = Config section //[{csSec}]
! 224: * return: -1 error, 0 nothing deleted or >0 deleted attributes
! 225: */
! 226: int cfg_delSection(cfg_root_t * __restrict cfg, const char *csSec);
! 227: /*
1.15 misho 228: * cfg_getSection() - Get entire section attributes into array
229: *
230: * @cfg = Config root
231: * @csSec = Config section //[{csSec}]
232: * return: NULL not found or !=NULL allocated array, must free with array_Destroy() after use!
233: */
234: array_t *cfg_getSection(cfg_root_t * __restrict cfg, const char *csSec);
235: /*
1.7 misho 236: * cfg_findAttribute() - Find attribute position in config file
237: *
238: * @cfg = Config root
1.1 misho 239: * @csSec = Config section //[{csSec}]
1.18 misho 240: * @csAttr = Config attribute //{csAttr} = ...
1.7 misho 241: * return: 0 not found item, -1 error or >0 position in list
242: */
1.11 misho 243: int cfg_findAttribute(cfg_root_t * __restrict cfg,
1.7 misho 244: const char *csSec, const char *csAttr);
245: /*
246: * cfg_getAttribute() - Get item from config and return value from it
247: *
248: * @cfg = Config root
249: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
1.18 misho 250: * @csAttr = Config attribute //{csAttr} = ...
1.7 misho 251: * return: NULL item not found or null parameters, !=NULL value const string
252: */
1.11 misho 253: const char *cfg_getAttribute(cfg_root_t * __restrict cfg,
1.7 misho 254: const char *csSec, const char *csAttr);
255: /*
1.16 misho 256: * cfg_getAttributeLong() - Get item as long from config and return value from it
257: *
258: * @cfg = Config root
259: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
1.18 misho 260: * @csAttr = Config attribute //{csAttr} = ...
1.16 misho 261: * return: value
262: */
263: long cfg_getAttributeLong(cfg_root_t * __restrict cfg,
264: const char *csSec, const char *csAttr);
265: /*
266: * cfg_getAttributeLLong() - Get item as long long from config and return value from it
267: *
268: * @cfg = Config root
269: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
1.18 misho 270: * @csAttr = Config attribute //{csAttr} = ...
1.16 misho 271: * return: value
272: */
273: long long
274: cfg_getAttributeLLong(cfg_root_t * __restrict cfg,
275: const char *csSec, const char *csAttr);
276: /*
277: * cfg_getAttributeDouble() - Get item as double from config and return value from it
278: *
279: * @cfg = Config root
280: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
1.18 misho 281: * @csAttr = Config attribute //{csAttr} = ...
1.16 misho 282: * return: value
283: */
284: double cfg_getAttributeDouble(cfg_root_t * __restrict cfg,
285: const char *csSec, const char *csAttr);
286: /*
287: * cfg_getAttributeLDouble() - Get item as long double from config and return value from it
288: *
289: * @cfg = Config root
290: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
1.18 misho 291: * @csAttr = Config attribute //{csAttr} = ...
1.16 misho 292: * return: value
293: */
294: long double cfg_getAttributeLDouble(cfg_root_t * __restrict cfg,
295: const char *csSec, const char *csAttr);
296: /*
1.7 misho 297: * cfg_setAttribute() - Set item in config or adding new item if not exists
298: *
299: * @cfg = Config root
1.1 misho 300: * @csSec = Config section //[{csSec}], if NULL set in *default* section
1.7 misho 301: * @csAttr = Config attribute //{csAttr} = ...
1.1 misho 302: * @csVal = Config value //... = {csVal} to setup
1.7 misho 303: * return: 0 nothing changed, -1 error, 1 found and updated item or 2 added new item
304: */
305: int cfg_setAttribute(cfg_root_t * __restrict cfg, const char *csSec,
306: const char *csAttr, const char *csVal);
307: /*
308: * cfg_unsetAttribute() - Unset item from config and free resources
309: *
310: * @cfg = Config root
1.1 misho 311: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
1.18 misho 312: * @csAttr = Config attribute //{csAttr} = ...
1.7 misho 313: * return: 0 item not found, -1 error or 1 removed item
314: */
315: int cfg_unsetAttribute(cfg_root_t * __restrict cfg, const char *csSec,
316: const char *csAttr);
1.1 misho 317:
318: /*
1.7 misho 319: * cfg_loadAttribute() - Get guarded attribute, if not found item return *default value*
320: *
321: * @cfg = Config root
1.1 misho 322: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
1.18 misho 323: * @csAttr = Config attribute //{csAttr} = ...
1.7 misho 324: * @val = Return buffer for item Value //... = {val}
325: * @csDefValue = *Default Value* for return in //{val}, if not found item in config
326: * return: 0 item not found, -1 error or >0 number of copied bytes in //{val}
327: */
328: int cfg_loadAttribute(cfg_root_t * __restrict cfg, const char *csSec,
329: const char *csAttr, ait_val_t * __restrict val, const char *csDefValue);
1.1 misho 330:
1.20 misho 331: #ifdef __cplusplus
332: }
333: #endif
1.1 misho 334:
335: #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