libaitcfg/inc/aitcfg.h - view

File: [ELWIX - Embedded LightWeight unIX -] / libaitcfg / inc / aitcfg.h
Revision 1.6.4.1: download - view: text, annotated - select for diffs - revision graph
Mon Apr 2 14:39:02 2012 UTC (12 years, 1 month ago) by misho
Branches: cfg5_0
Diff to: branchpoint 1.6: preferred, colored

start big step out ... redesign and rework all lib

/************************************************************************* * (C) 2008 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com> * by Michael Pounov <misho@openbsd-bg.org> * * $Author: misho $ * $Id: aitcfg.h,v 1.6.4.1 2012/04/02 14:39:02 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following terms: All of the documentation and software included in the ELWIX and AITNET Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org> Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 by Michael Pounov <misho@elwix.org>. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. All advertising materials mentioning features or use of this software must display the following acknowledgement: This product includes software developed by Michael Pounov <misho@elwix.org> ELWIX - Embedded LightWeight unIX and its contributors. 4. Neither the name of AITNET nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef __AITCFG_H #define __AITCFG_H #include <aitio.h> #include <atree.h> struct tagCfg { ait_val_t cfg_sec; ait_val_t cfg_attr; ait_val_t cfg_val; SLIST_ENTRY(tagCfg) cfg_next; RB_ENTRY(tagCfg) cfg_node; }; typedef struct tagRC { #ifdef HAVE_LIBPTHREAD pthread_mutex_t rc_mtx; #endif struct tagCfg *slh_first; struct tagCfg *rbh_root; } cfg_root_t; #ifdef HAVE_LIBPTHREAD #define CFG_RC_LOCK(x) pthread_mutex_lock(&(x)->rc_mtx) #define CFG_RC_UNLOCK(x) pthread_mutex_unlock(&(x)->rc_mtx) #else #define CFG_RC_LOCK(x) #define CFG_RC_UNLOCK(x) #endif // cfg_GetErrno() Get error code of last operation inline int cfg_GetErrno(); // cfg_GetError() Get error text of last operation inline const char *cfg_GetError(); /* * Macros for config library. */ #define CFG_ISEMPTY(x) RB_EMPTY((x)) /* * cfgLoadConfig() - Load config from file * * @cfgName = Config filename * @cfg = Config root * return: -1 error or 0 ok */ int cfgLoadConfig(const char *cfgName, cfg_root_t * __restrict cfg); /* * cfgUnloadConfig() - Unload config from memory and free resources * * @cfg = Config root * return: none */ void cfgUnloadConfig(cfg_root_t * __restrict cfg); /* * cfgReadConfig() - Read file and add new item at config root * * @f = File resource * @cfg = Config root * return: -1 error or 0 ok */ int cfgReadConfig(FILE *f, cfg_root_t * __restrict cfg); #if 0 /* * cfg_CreateConfig() Create config file from memory without whitespaces! * @csConfigName = New config filename * @cfg = Head list element * return: 0 ok; -1 error:: can`t save new config */ int cfg_CreateConfig(const char *csConfigName, sl_config * __restrict cfg); /* * CreateConfig() Create config file from memory * @csConfigName = New config filename * @cfg = Head list element * return: 0 ok; -1 error:: can`t save new config */ int CreateConfig(const char *csConfigName, sl_config * __restrict cfg); /* * WriteConfig() Write to file from items in config list * @f = file resource * @cfg = Head list element * return: 0 ok; -1 error:: can`t write to file */ int WriteConfig(FILE *f, sl_config * __restrict cfg); /* * cfg_WriteConfig() Write to file from items in config list without whitespaces! * @f = file resource * @cfg = Head list element * return: 0 ok; -1 error:: can`t write to file */ int cfg_WriteConfig(FILE *f, sl_config * __restrict cfg); /* * ConcatConfig() Concat two list in one * @cfg = Head list element of main list * @add_cfg = Head list element of added list * return: 0 ok; -1 error:: can`t concat lists */ int ConcatConfig(sl_config * __restrict cfg, sl_config * __restrict add_cfg); /* * MergeConfig() Marge two list in one cfg and destroy add_cfg * @cfg = Head list element of main list * @add_cfg = Head list element of merged list (destroy after all!) * return: 0 ok; -1 error:: can`t merge lists */ int MergeConfig(sl_config * __restrict cfg, sl_config * __restrict add_cfg); #endif /* * cfg_findAttribute() - Find attribute position in config file * * @cfg = Config root * @csSec = Config section //[{csSec}] * @csAttr = Config attribute //{csAttr} = ... * return: 0 not found item; -1 error: null parameters; >0 position in list */ inline int cfg_findAttribute(cfg_root_t * __restrict cfg, const char *csSec, const char *csAttr); /* * cfg_getAttribute() - Get item from config and return value from it * * @cfg = Config root * @csSec = Config section //[{csSec}], if NULL unset in *default* section * @csAttr = Config attribute //{csAttr} = ..., if NULL unset as *any* attribute * return: NULL item not found or null parameters; !=NULL value const string */ inline const char *cfg_getAttribute(cfg_root_t * __restrict cfg, const char *csSec, const char *csAttr); #if 0 /* * cfg_SetAttribute() Set item in config list or add new item if not exists * @cfg = Head list element * @csSec = Config section //[{csSec}], if NULL set in *default* section * @csAttr = Config attribute //{csAttr} = ..., if NULL set as *any* attribute * @csVal = Config value //... = {csVal} to setup * return: 0 nothing changed, -1 error: not enough memory; 1 find and update item; 2 added new item */ int cfg_SetAttribute(sl_config * __restrict cfg, const u_char *csSec, const u_char *csAttr, const u_char *csVal); /* * cfg_UnsetAttribute() Unset item from config list and free resources * @cfg = Head list element * @csSec = Config section //[{csSec}], if NULL unset in *default* section * @csAttr = Config attribute //{csAttr} = ..., if NULL unset as *any* attribute * return: 0 item not found, -1 error: null parameters; >0 position in list */ int cfg_UnsetAttribute(sl_config * __restrict cfg, const u_char *csSec, const u_char *csAttr); /* * cfg_GetAttribute() Get item from config list and return his value * @cfg = Head list element * @csSec = Config section //[{csSec}], if NULL unset in *default* section * @csAttr = Config attribute //{csAttr} = ..., if NULL unset as *any* attribute * return: NULL item not found or null parameters; !=NULL value const string */ inline const u_char *cfg_GetAttribute(sl_config * __restrict cfg, const u_char *csSec, const u_char *csAttr); /* * cfg_LoadAttribute() Extended get attribute, if not found item return *default value* * @cfg = Head list element * @csSec = Config section //[{csSec}], if NULL unset in *default* section * @csAttr = Config attribute //{csAttr} = ..., if NULL unset as *any* attribute * @psVal = Return buffer for item Value //... = {psVal} * @ValLen = Length of buffer //{psVal} for return * @csDefValue = *Default Value* for return in //{psVal}, if not found item in config list * return: 0 item not found, -1 error: null parameters; >0 number of copied bytes in //{psVal} */ int cfg_LoadAttribute(sl_config * __restrict cfg, const u_char *csSec, const u_char *csAttr, u_char * __restrict psVal, int ValLen, const char *csDefValue); #endif #endif