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