[BACK]Return to aitcfg.h CVS log [TXT] [DIR] Up to [ELWIX - Embedded LightWeight unIX -] / libaitcfg / inc

Diff for /libaitcfg/inc/aitcfg.h between versions 1.3.2.2 and 1.15

version 1.3.2.2, 2009/11/11 13:52:29 version 1.15, 2014/03/19 18:38:43
Line 5 Line 5
 * $Author$  * $Author$
 * $Id$  * $Id$
 *  *
*************************************************************************/**************************************************************************
 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 - 2014
         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  #ifndef __AITCFG_H
 #define __AITCFG_H  #define __AITCFG_H
   
   
struct tagPair {#include <pthread.h>
        unsigned int    uLine;#include <elwix.h>
        unsigned char   *psSection; 
        unsigned char   *psAttribute; 
        unsigned char   *psValue; 
        struct tagPair *sle_next; 
}; 
   
struct tagHead {
        struct tagPair *slh_first;struct tagCfg {
         ait_val_t               cfg_sec;
         ait_val_t               cfg_attr;
         ait_val_t               cfg_val;
 
         TAILQ_ENTRY(tagCfg)     cfg_next;
         RB_ENTRY(tagCfg)        cfg_node;
 };  };
typedef struct tagHead sl_config;typedef struct tagRC {
         pthread_mutex_t         rc_mtx;
   
           struct tagCfg           *tqh_first;
           struct tagCfg           **tqh_last;
           struct tagCfg           *rbh_root;
   } cfg_root_t;
   #define CFG_RC_LOCK(x)          pthread_mutex_lock(&(x)->rc_mtx)
   #define CFG_RC_UNLOCK(x)        pthread_mutex_unlock(&(x)->rc_mtx)
   
/*#define CFG_SECTION(x)             (assert((x)), AIT_GET_LIKE(&((struct tagCfg*) (x))->cfg_sec, const char*))
 * Macros for config library. Typecast string to specific config string format.#define CFG_ATTRIBUTE(x)        (assert((x)), AIT_GET_LIKE(&((struct tagCfg*) (x))->cfg_attr, const char*))
*/#define CFG_VALUE(x)            (assert((x)), AIT_GET_LIKE(&((struct tagCfg*) (x))->cfg_val, const char*))
#define CFG(x)             (unsigned char *)(x) 
   
 #define CFG_ISSET(x)    ((long) cfg_FirstItem((x)))  
   
   // cfg_GetErrno() Get error code of last operation
   int cfg_GetErrno();
   // cfg_GetError() Get error text of last operation
   const char *cfg_GetError();
   
   
 /*  /*
 * InitConfig() Head initializing function for config * Macros for config library.
 * @cfg = New head element for init */
 * return: 0 ok; -1 error:: new head element is null#define CFG_ISEMPTY(x)          RB_EMPTY((x))
*/
inline int InitConfig(sl_config * __restrict cfg);
 /*  /*
 * cfg_CreateConfig() Create config file from memory without whitespaces! * cfgInitConfig() - Init config root
 * @csConfigName = New config filename *
 * @cfg = Head list element * return: NULL error or !=NULL allocated config root
 * return: 0 ok; -1 error:: can`t save new config */
*/cfg_root_t *cfgInitConfig();
int cfg_CreateConfig(const char *csConfigName, sl_config * __restrict cfg); 
 /*  /*
 * CreateConfig() Create config file from memory * cfgEndConfig() - Free resources & config root
 * @csConfigName = New config filename *
 * @cfg = Head list element * @pcfg = Config root
 * return: 0 ok; -1 error:: can`t save new config * return: none
*/ */
int CreateConfig(const char *csConfigName, sl_config * __restrict cfg);void cfgEndConfig(cfg_root_t **pcfg);
 /*  /*
 * LoadConfig() Load config from file * cfgLoadConfig() - Load config from file
 * @csConfigName = Filename of config *
 * @cfg = Head list element * @cfgName = Config filename
 * return: 0 ok; -1 error:: can`t load config * @cfg = Config root
*/ * return: -1 error or 0 ok
int LoadConfig(const char *csConfigName, sl_config * __restrict cfg); */
 int cfgLoadConfig(const char *cfgName, cfg_root_t * __restrict cfg);
 /*  /*
 * UnloadConfig() Unload config from memory and free resources * cfgUnloadConfig() - Unload config from memory and destroy resources
 * @cfg = Head list element *
*/ * @cfg = Config root
void UnloadConfig(sl_config * __restrict cfg); * return: none
 */
void cfgUnloadConfig(cfg_root_t * __restrict cfg);
// 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(); 
 
 
 /*  /*
 * ReadConfig() Read from file and add new item to config list * cfgClearConfig() - Clear config and free resources
 * @f = file resource *
 * @cfg = Head list element * @cfg = Config root
 * return: 0 ok; -1 error:: can`t allocate memory * return: none
*/ */
int ReadConfig(FILE *f, sl_config * __restrict cfg);void cfgClearConfig(cfg_root_t * __restrict cfg);
 /*  /*
 * WriteConfig() Write to file from items in config list * cfgCreateConfig() - Create config file from memory
 * @f = file resource *
 * @cfg = Head list element * @csConfigName = New config filename
 * return: 0 ok; -1 error:: can`t write to file * @cfg = Config root
*/ * @whitespace = Additional whitespace characters to file
int WriteConfig(FILE *f, sl_config * __restrict cfg); * return: -1 error or 0 ok
  */
 int cfgCreateConfig(const char *csConfigName, cfg_root_t * __restrict cfg, 
                 int whitespace);
   
 /*  /*
 * cfg_WriteConfig() Write to file from items in config list without whitespaces! * cfgReadLines() - Read custom lines and add new item at config root
 * @f = file resource *
 * @cfg = Head list element * @f = File resource
 * return: 0 ok; -1 error:: can`t write to file * @delim = Custom delimiter, if =NULL default is '='
*/ * @end = Custom user end of file, if =NULL default is EOF
int cfg_WriteConfig(FILE *f, sl_config * __restrict cfg); * @cfg = Config root
 * return: -1 error or 0 ok
  */
 int cfgReadLines(FILE *f, const char *delim, const char *end, 
                 cfg_root_t * __restrict cfg);
 /*  /*
 * ConcatConfig() Concat two list in one * cfgWriteLines() - Write custom lines and export data to variable
 * @cfg = Head list element of main list *
 * @add_cfg = Head list element of added list * @f = File resource
 * return: 0 ok; -1 error:: can`t concat lists * @delim = Custom delimiter, if =NULL default is '='
*/ * @eol = End of line string, if =NULL default is "\n"
int ConcatConfig(sl_config * __restrict cfg, sl_config * __restrict add_cfg); * @section = Export only section, if =NULL default is all
 * @cfg = Config root
  * return: =NULL error or !=NULL exported data, must be free after use with ait_freeVar()
  */
 ait_val_t *cfgWriteLines(FILE *f, const char *delim, const char *eol, 
                 const char *section, cfg_root_t * __restrict cfg);
 /*  /*
 * MergeConfig() Marge two list in one cfg and destroy add_cfg * cfgReadConfig() - Read file and add new item at config root
 * @cfg = Head list element of main list *
 * @add_cfg = Head list element of merged list (destroy after all!) * @f = File resource
 * return: 0 ok; -1 error:: can`t merge lists * @cfg = Config root
*/ * return: -1 error or 0 ok
int MergeConfig(sl_config * __restrict cfg, sl_config * __restrict add_cfg); */
 int cfgReadConfig(FILE *f, cfg_root_t * __restrict cfg);
 /*
  * cfgWriteConfig() - Write config from memory
  *
  * @f = File handle
  * @cfg = Config root
  * @whitespace = Additional whitespace characters to file
  * return: -1 error or 0 ok
  */
 int cfgWriteConfig(FILE *f, cfg_root_t * __restrict cfg, int whitespace);
 /*
  * cfgConcatConfig() - Concat two configs into one
  *
  * @cfg = Config root
  * @add_cfg = Concated config will be destroy after merge
  * return: -1 error or 0 ok
  */
 int cfgConcatConfig(cfg_root_t * __restrict cfg, cfg_root_t * __restrict add_cfg);
 /*
  * cfgMergeConfig() - Marge two list in one cfg and destroy add_cfg
  *
  * @cfg = Config root of main list
  * @add_cfg = Merged config will be destroy after merge
  * return: -1 error or 0 ok
  */
 int cfgMergeConfig(cfg_root_t * __restrict cfg, cfg_root_t * __restrict add_cfg);
   
   
 /*  /*
 * cfg_FindAttribute() Find attribute position in config list * cfg_getSection() - Get entire section attributes into array
 * @cfg = Head list element *
  * @cfg = Config root
  * @csSec = Config section //[{csSec}]   * @csSec = Config section //[{csSec}]
 * @csAttr = Config attribute //{csAttr} = ... * return: NULL not found or !=NULL allocated array, must free with array_Destroy() after use!
 * return: 0 not found item; -1 error: null parameters; >0 position in list */
*/array_t *cfg_getSection(cfg_root_t * __restrict cfg, const char *csSec);
inline int cfg_FindAttribute(sl_config * __restrict cfg, const u_char *csSec, const u_char *csAttr); 
 /*  /*
 * cfg_SetAttribute() Set item in config list or add new item if not exists * cfg_findAttribute() - Find attribute position in config file
 * @cfg = Head list element *
  * @cfg = Config root
  * @csSec = Config section //[{csSec}]
  * @csAttr = Config attribute //{csAttr} = ..., if NULL as *any* attribute
  * return: 0 not found item, -1 error or >0 position in list
  */
 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 as *any* attribute
  * return: NULL item not found or null parameters, !=NULL value const string
  */
 const char *cfg_getAttribute(cfg_root_t * __restrict cfg, 
                 const char *csSec, const char *csAttr);
 /*
  * cfg_setAttribute() - Set item in config or adding new item if not exists
  *
  * @cfg = Config root
  * @csSec = Config section //[{csSec}], if NULL set in *default* section   * @csSec = Config section //[{csSec}], if NULL set in *default* section
 * @csAttr = Config attribute //{csAttr} = ..., if NULL set as *any* attribute * @csAttr = Config attribute //{csAttr} = ...
  * @csVal = Config value //... = {csVal} to setup   * @csVal = Config value //... = {csVal} to setup
 * return: 0 nothing changed, -1 error: not enough memory; 1 find and update item; 2 added new item * return: 0 nothing changed, -1 error, 1 found and updated item or 2 added new item
*/ */
int cfg_SetAttribute(sl_config * __restrict cfg, const u_char *csSec, const u_char *csAttr, const u_char *csVal);int cfg_setAttribute(cfg_root_t * __restrict cfg, const char *csSec, 
                 const char *csAttr, const char *csVal);
 /*  /*
 * cfg_UnsetAttribute() Unset item from config list and free resources * cfg_unsetAttribute() - Unset item from config and free resources
 * @cfg = Head list element *
  * @cfg = Config root
  * @csSec = Config section //[{csSec}], if NULL unset in *default* section   * @csSec = Config section //[{csSec}], if NULL unset in *default* section
 * @csAttr = Config attribute //{csAttr} = ..., if NULL unset as *any* attribute * @csAttr = Config attribute //{csAttr} = ..., if NULL as *any* attribute
 * return: 0 item not found, -1 error: null parameters; >0 position in list * return: 0 item not found, -1 error or 1 removed item
*/ */
int cfg_UnsetAttribute(sl_config * __restrict cfg, const u_char *csSec, const u_char *csAttr);int cfg_unsetAttribute(cfg_root_t * __restrict cfg, const char *csSec, 
/*                const 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_FirstItem() Get first item from config list and return his value * cfg_loadAttribute() - Get guarded attribute, if not found item return *default value*
 * @cfg = Head list element *
 * return: NULL if no items in list; !=NULL first pair item * @cfg = Config root
*/ 
inline struct tagPair *cfg_FirstItem(sl_config * __restrict cfg); 
 
/* 
 * 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   * @csSec = Config section //[{csSec}], if NULL unset in *default* section
 * @csAttr = Config attribute //{csAttr} = ..., if NULL unset as *any* attribute * @csAttr = Config attribute //{csAttr} = ..., if NULL as *any* attribute
 * @psVal = Return buffer for item Value //... = {psVal} * @val = Return buffer for item Value //... = {val}
 * @ValLen = Length of buffer //{psVal} for return * @csDefValue = *Default Value* for return in //{val}, if not found item in config
 * @csDefValue = *Default Value* for return in //{psVal}, if not found item in config list * return: 0 item not found, -1 error or >0 number of copied bytes in //{val}
 * return: 0 item not found, -1 error: null parameters; >0 number of copied bytes in //{psVal} */
*/int cfg_loadAttribute(cfg_root_t * __restrict cfg, const char *csSec, 
int cfg_LoadAttribute(sl_config * __restrict cfg, const u_char *csSec, const u_char *csAttr,                 const char *csAttr, ait_val_t * __restrict val, const char *csDefValue);
                u_char * __restrict psVal, int ValLen, const char *csDefValue); 
   
   
 #endif  #endif
Removed from v.1.3.2.2  
changed lines
  Added in v.1.15

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>