Annotation of libaitcfg/inc/aitcfg.h, revision 1.12.2.1
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.12.2.1! misho 6: * $Id: aitcfg.h,v 1.12 2014/01/29 23:48: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.12 misho 15: Copyright 2004 - 2014
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.12.2.1! 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.12.2.1! 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:
72:
73: // cfg_GetErrno() Get error code of last operation
1.11 misho 74: int cfg_GetErrno();
1.1 misho 75: // cfg_GetError() Get error text of last operation
1.11 misho 76: const char *cfg_GetError();
1.1 misho 77:
78:
79: /*
1.7 misho 80: * Macros for config library.
81: */
82: #define CFG_ISEMPTY(x) RB_EMPTY((x))
1.1 misho 83:
1.3 misho 84:
85: /*
1.7 misho 86: * cfgInitConfig() - Init config root
87: *
88: * @cfg = Config root
89: * return: -1 error or 0 ok
90: */
91: int cfgInitConfig(cfg_root_t * __restrict cfg);
92: /*
93: * cfgLoadConfig() - Load config from file
94: *
95: * @cfgName = Config filename
96: * @cfg = Config root
97: * return: -1 error or 0 ok
98: */
99: int cfgLoadConfig(const char *cfgName, cfg_root_t * __restrict cfg);
100: /*
1.8 misho 101: * cfgUnloadConfig() - Unload config from memory and destroy resources
1.7 misho 102: *
103: * @cfg = Config root
104: * return: none
105: */
106: void cfgUnloadConfig(cfg_root_t * __restrict cfg);
1.3 misho 107: /*
1.8 misho 108: * cfgClearConfig() - Clear config and free resources
109: *
110: * @cfg = Config root
111: * return: none
112: */
113: void cfgClearConfig(cfg_root_t * __restrict cfg);
114: /*
1.7 misho 115: * cfgCreateConfig() - Create config file from memory
116: *
117: * @csConfigName = New config filename
118: * @cfg = Config root
119: * @whitespace = Additional whitespace characters to file
120: * return: -1 error or 0 ok
121: */
122: int cfgCreateConfig(const char *csConfigName, cfg_root_t * __restrict cfg,
123: int whitespace);
124:
125: /*
1.9 misho 126: * cfgReadLines() - Read custom lines and add new item at config root
127: *
128: * @f = File resource
129: * @delim = Custom delimiter, if =NULL default is '='
130: * @end = Custom user end of file, if =NULL default is EOF
131: * @cfg = Config root
132: * return: -1 error or 0 ok
133: */
134: int cfgReadLines(FILE *f, const char *delim, const char *end,
135: cfg_root_t * __restrict cfg);
136: /*
1.10 misho 137: * cfgWriteLines() - Write custom lines and export data to variable
138: *
139: * @f = File resource
140: * @delim = Custom delimiter, if =NULL default is '='
141: * @eol = End of line string, if =NULL default is "\n"
142: * @section = Export only section, if =NULL default is all
143: * @cfg = Config root
1.11 misho 144: * return: =NULL error or !=NULL exported data, must be free after use with ait_freeVar()
1.10 misho 145: */
146: ait_val_t *cfgWriteLines(FILE *f, const char *delim, const char *eol,
147: const char *section, cfg_root_t * __restrict cfg);
148: /*
1.7 misho 149: * cfgReadConfig() - Read file and add new item at config root
150: *
151: * @f = File resource
152: * @cfg = Config root
153: * return: -1 error or 0 ok
154: */
155: int cfgReadConfig(FILE *f, cfg_root_t * __restrict cfg);
156: /*
157: * cfgWriteConfig() - Write config from memory
158: *
159: * @f = File handle
160: * @cfg = Config root
161: * @whitespace = Additional whitespace characters to file
162: * return: -1 error or 0 ok
163: */
164: int cfgWriteConfig(FILE *f, cfg_root_t * __restrict cfg, int whitespace);
165: /*
166: * cfgConcatConfig() - Concat two configs into one
167: *
168: * @cfg = Config root
169: * @add_cfg = Concated config will be destroy after merge
170: * return: -1 error or 0 ok
171: */
172: int cfgConcatConfig(cfg_root_t * __restrict cfg, cfg_root_t * __restrict add_cfg);
173: /*
174: * cfgMergeConfig() - Marge two list in one cfg and destroy add_cfg
175: *
176: * @cfg = Config root of main list
177: * @add_cfg = Merged config will be destroy after merge
178: * return: -1 error or 0 ok
179: */
180: int cfgMergeConfig(cfg_root_t * __restrict cfg, cfg_root_t * __restrict add_cfg);
181:
182: /*
183: * cfg_findAttribute() - Find attribute position in config file
184: *
185: * @cfg = Config root
1.1 misho 186: * @csSec = Config section //[{csSec}]
187: * @csAttr = Config attribute //{csAttr} = ...
1.7 misho 188: * return: 0 not found item, -1 error or >0 position in list
189: */
1.11 misho 190: int cfg_findAttribute(cfg_root_t * __restrict cfg,
1.7 misho 191: const char *csSec, const char *csAttr);
192: /*
193: * cfg_getAttribute() - Get item from config and return value from it
194: *
195: * @cfg = Config root
196: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
197: * @csAttr = Config attribute //{csAttr} = ..., if NULL unset as *any* attribute
198: * return: NULL item not found or null parameters, !=NULL value const string
199: */
1.11 misho 200: const char *cfg_getAttribute(cfg_root_t * __restrict cfg,
1.7 misho 201: const char *csSec, const char *csAttr);
202: /*
203: * cfg_setAttribute() - Set item in config or adding new item if not exists
204: *
205: * @cfg = Config root
1.1 misho 206: * @csSec = Config section //[{csSec}], if NULL set in *default* section
1.7 misho 207: * @csAttr = Config attribute //{csAttr} = ...
1.1 misho 208: * @csVal = Config value //... = {csVal} to setup
1.7 misho 209: * return: 0 nothing changed, -1 error, 1 found and updated item or 2 added new item
210: */
211: int cfg_setAttribute(cfg_root_t * __restrict cfg, const char *csSec,
212: const char *csAttr, const char *csVal);
213: /*
214: * cfg_unsetAttribute() - Unset item from config and free resources
215: *
216: * @cfg = Config root
1.1 misho 217: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
1.7 misho 218: * @csAttr = Config attribute //{csAttr} = ...
219: * return: 0 item not found, -1 error or 1 removed item
220: */
221: int cfg_unsetAttribute(cfg_root_t * __restrict cfg, const char *csSec,
222: const char *csAttr);
1.1 misho 223:
224: /*
1.7 misho 225: * cfg_loadAttribute() - Get guarded attribute, if not found item return *default value*
226: *
227: * @cfg = Config root
1.1 misho 228: * @csSec = Config section //[{csSec}], if NULL unset in *default* section
1.7 misho 229: * @csAttr = Config attribute //{csAttr} = ...
230: * @val = Return buffer for item Value //... = {val}
231: * @csDefValue = *Default Value* for return in //{val}, if not found item in config
232: * return: 0 item not found, -1 error or >0 number of copied bytes in //{val}
233: */
234: int cfg_loadAttribute(cfg_root_t * __restrict cfg, const char *csSec,
235: const char *csAttr, ait_val_t * __restrict val, const char *csDefValue);
1.1 misho 236:
237:
238: #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