[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.6.4.2 and 1.22.2.1

version 1.6.4.2, 2012/04/02 15:12:15 version 1.22.2.1, 2026/08/04 18:51:43
Line 12  terms: Line 12  terms:
 All of the documentation and software included in the ELWIX and AITNET  All of the documentation and software included in the ELWIX and AITNET
 Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>  Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
   
Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012Copyright 2004 - 2026
         by Michael Pounov <misho@elwix.org>.  All rights reserved.          by Michael Pounov <misho@elwix.org>.  All rights reserved.
   
 Redistribution and use in source and binary forms, with or without  Redistribution and use in source and binary forms, with or without
Line 47  SUCH DAMAGE. Line 47  SUCH DAMAGE.
 #define __AITCFG_H  #define __AITCFG_H
   
   
#include <aitio.h>#include <pthread.h>
#include <atree.h>#include <elwix.h>
   
   
 struct tagCfg {  struct tagCfg {
         ait_val_t               cfg_sec;          ait_val_t               cfg_sec;
         ait_val_t               cfg_attr;          ait_val_t               cfg_attr;
         ait_val_t               cfg_val;          ait_val_t               cfg_val;
           int                     cfg_quoted;
   
        SLIST_ENTRY(tagCfg)  cfg_next;        TAILQ_ENTRY(tagCfg)  cfg_next;
         RB_ENTRY(tagCfg)        cfg_node;          RB_ENTRY(tagCfg)        cfg_node;
 };  };
 typedef struct tagRC {  typedef struct tagRC {
 #ifdef HAVE_LIBPTHREAD  
         pthread_mutex_t         rc_mtx;          pthread_mutex_t         rc_mtx;
#endif
        struct tagCfg           *slh_first;        struct tagCfg           *tqh_first;
         struct tagCfg           **tqh_last;
         struct tagCfg           *rbh_root;          struct tagCfg           *rbh_root;
 } cfg_root_t;  } cfg_root_t;
 #ifdef HAVE_LIBPTHREAD  
 #define CFG_RC_LOCK(x)          pthread_mutex_lock(&(x)->rc_mtx)  #define CFG_RC_LOCK(x)          pthread_mutex_lock(&(x)->rc_mtx)
 #define CFG_RC_UNLOCK(x)        pthread_mutex_unlock(&(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  
   
   #define CFG_SECTION(x)          (assert((x)), AIT_GET_LIKE(&((struct tagCfg*) (x))->cfg_sec, const char*))
   #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*))
   
   #ifdef __cplusplus
   extern "C" {
   #endif
   
 // cfg_GetErrno() Get error code of last operation  // cfg_GetErrno() Get error code of last operation
inline int cfg_GetErrno();int cfg_GetErrno();
 // cfg_GetError() Get error text of last operation  // cfg_GetError() Get error text of last operation
inline const char *cfg_GetError();const char *cfg_GetError();
   
   
 /*  /*
  * Macros for config library.   * Macros for config library.
*/ */
 #define CFG_ISEMPTY(x)          RB_EMPTY((x))  #define CFG_ISEMPTY(x)          RB_EMPTY((x))
   
   
 /*  /*
    * cfgInitConfig() - Init config root
    *
    * return: NULL error or !=NULL allocated config root
    */
   cfg_root_t *cfgInitConfig();
   /*
    * cfgEndConfig() - Free resources & config root
    *
    * @pcfg = Config root
    * return: none
    */
   void cfgEndConfig(cfg_root_t **pcfg);
   /*
    * cfgInitConfigExt() - Init existed config root
    *
    * @cfg = Config root
    * return: -1 error or 0 inited config root
    */
   int cfgInitConfigExt(cfg_root_t * __restrict cfg);
   /*
    * cfgLoadConfigExt() - Load config from file with recursion level of includes
    *
    * @cfgName = Config filename
    * @cfg = Config root
    * @lvl = Level of include recursion
    * return: -1 error or 0 ok
    */
   int cfgLoadConfigExt(const char *cfgName, cfg_root_t * __restrict cfg, int lvl);
   /*
  * cfgLoadConfig() - Load config from file   * cfgLoadConfig() - Load config from file
  *   *
  * @cfgName = Config filename   * @cfgName = Config filename
Line 96  inline const char *cfg_GetError(); Line 128  inline const char *cfg_GetError();
  */   */
 int cfgLoadConfig(const char *cfgName, cfg_root_t * __restrict cfg);  int cfgLoadConfig(const char *cfgName, cfg_root_t * __restrict cfg);
 /*  /*
 * cfgUnloadConfig() - Unload config from memory and free resources * cfgUnloadConfig() - Unload config from memory and destroy resources
  *   *
  * @cfg = Config root   * @cfg = Config root
  * return: none   * return: none
  */   */
 void cfgUnloadConfig(cfg_root_t * __restrict cfg);  void cfgUnloadConfig(cfg_root_t * __restrict cfg);
   /*
    * cfgClearConfig() - Clear config and free resources
    *
    * @cfg = Config root
    * return: none
    */
   void cfgClearConfig(cfg_root_t * __restrict cfg);
   /*
    * cfgCreateConfig() - Create config file from memory
    *
    * @csConfigName = New config filename
    * @cfg = Config root
    * @whitespace = Additional whitespace characters to file
    * return: -1 error or 0 ok
    */
   int cfgCreateConfig(const char *csConfigName, cfg_root_t * __restrict cfg, 
                   int whitespace);
   
 /*  /*
 * cfgReadConfig() - Read file and add new item at config root * cfgReadLines() - Read custom lines and add new item at config root
  *   *
  * @f = File resource   * @f = File resource
    * @delim = Custom delimiter, if =NULL default is '='
    * @end = Custom user end of file, if =NULL default is EOF
  * @cfg = Config root   * @cfg = Config root
  * return: -1 error or 0 ok   * return: -1 error or 0 ok
  */   */
int cfgReadConfig(FILE *f, cfg_root_t * __restrict cfg);int cfgReadLines(FILE *f, const char *delim, const char *end, 
                cfg_root_t * __restrict cfg);
#if 0 
 /*  /*
 * cfg_CreateConfig() Create config file from memory without whitespaces! * cfgWriteLines() - Write custom lines and export data to variable
 * @csConfigName = New config filename *
 * @cfg = Head list element * @f = File resource
 * return: 0 ok; -1 error:: can`t save new config * @delim = Custom delimiter, if =NULL default is '='
*/ * @eol = End of line string, if =NULL default is "\n"
int cfg_CreateConfig(const char *csConfigName, sl_config * __restrict 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);
 /*  /*
 * CreateConfig() Create config file from memory * cfg_ReadConfig() - Read file and add new item at config root
 * @csConfigName = New config filename *
 * @cfg = Head list element * @f = File resource
 * return: 0 ok; -1 error:: can`t save new config * @cfg = Config root
*/ * @lvl = Level of include recursion
int CreateConfig(const char *csConfigName, sl_config * __restrict cfg); * return: -1 error or 0 ok
 */
int cfg_ReadConfig(FILE *f, cfg_root_t * __restrict cfg, int lvl);
 #define cfgReadConfig(f, c)     cfg_ReadConfig((f), (c), 1)
 /*  /*
 * WriteConfig() Write to file from items in config list * cfgWriteConfig() - Write config from memory
 * @f = file resource *
 * @cfg = Head list element * @f = File handle
 * 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 cfgWriteConfig(FILE *f, cfg_root_t * __restrict cfg, int whitespace);
 /*  /*
 * cfg_WriteConfig() Write to file from items in config list without whitespaces! * cfgWriteConfigRaw() - Write config from memory by list
 * @f = file resource *
 * @cfg = Head list element * @f = File handle
 * return: 0 ok; -1 error:: can`t write to file * @cfg = Config root
*/ * @whitespace = Additional whitespace characters to file
int cfg_WriteConfig(FILE *f, sl_config * __restrict cfg); * return: -1 error or 0 ok
 */
 int cfgWriteConfigRaw(FILE *f, cfg_root_t * __restrict cfg, int whitespace);
 /*  /*
 * ConcatConfig() Concat two list in one * cfgConcatConfig() - Concat two configs into one
 * @cfg = Head list element of main list *
 * @add_cfg = Head list element of added list * @cfg = Config root
 * return: 0 ok; -1 error:: can`t concat lists * @add_cfg = Concated config will be destroy after merge
*/ * return: -1 error or 0 ok
int ConcatConfig(sl_config * __restrict cfg, sl_config * __restrict add_cfg); */
int cfgConcatConfig(cfg_root_t * __restrict cfg, cfg_root_t * __restrict add_cfg);
 /*  /*
 * MergeConfig() Marge two list in one cfg and destroy add_cfg * cfgMergeConfig() - 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!) * @cfg = Config root of main list
 * return: 0 ok; -1 error:: can`t merge lists * @add_cfg = Merged config will be destroy after merge
*/ * return: -1 error or 0 ok
int MergeConfig(sl_config * __restrict cfg, sl_config * __restrict add_cfg); */
#endifint cfgMergeConfig(cfg_root_t * __restrict cfg, cfg_root_t * __restrict add_cfg);
   
 /*  /*
    * cfg_dumpCfg() - dump config data
    *
    * @cfg = Config root
    * return: none
    */
   void cfg_dumpCfg(cfg_root_t * __restrict cfg);
   /*
    * cfg_delSection() - Delete entire section
    *
    * @cfg = Config root
    * @csSec = Config section //[{csSec}]
    * return: -1 error, 0 nothing deleted or >0 deleted attributes
    */
   int cfg_delSection(cfg_root_t * __restrict cfg, const char *csSec);
   /*
    * cfg_getSection() - Get entire section attributes into array
    *
    * @cfg = Config root
    * @csSec = Config section //[{csSec}]
    * return: NULL not found or !=NULL allocated array, must free with array_Destroy() after use!
    */
   array_t *cfg_getSection(cfg_root_t * __restrict cfg, const char *csSec);
   /*
  * cfg_findAttribute() - Find attribute position in config file   * cfg_findAttribute() - Find attribute position in config file
  *   *
  * @cfg = Config root   * @cfg = Config root
Line 170  int MergeConfig(sl_config * __restrict cfg, sl_config  Line 251  int MergeConfig(sl_config * __restrict cfg, sl_config 
  * @csAttr = Config attribute //{csAttr} = ...   * @csAttr = Config attribute //{csAttr} = ...
  * return: 0 not found item, -1 error or >0 position in list   * return: 0 not found item, -1 error or >0 position in list
  */   */
inline int cfg_findAttribute(cfg_root_t * __restrict cfg, int cfg_findAttribute(cfg_root_t * __restrict cfg, 
                 const char *csSec, const char *csAttr);                  const char *csSec, const char *csAttr);
 /*  /*
  * cfg_getAttribute() - Get item from config and return value from it   * cfg_getAttribute() - Get item from config and return value from it
  *   *
  * @cfg = Config root   * @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} = ...
  * return: NULL item not found or null parameters, !=NULL value const string   * return: NULL item not found or null parameters, !=NULL value const string
  */   */
inline const char *cfg_getAttribute(cfg_root_t * __restrict cfg, const char *cfg_getAttribute(cfg_root_t * __restrict cfg, 
                 const char *csSec, const char *csAttr);                  const char *csSec, const char *csAttr);
 /*  /*
    * cfg_getAttributeLong() - Get item as long from config and return value from it
    *
    * @cfg = Config root
    * @csSec = Config section //[{csSec}], if NULL unset in *default* section
    * @csAttr = Config attribute //{csAttr} = ...
    * return: value
    */
   long cfg_getAttributeLong(cfg_root_t * __restrict cfg, 
                   const char *csSec, const char *csAttr);
   /*
    * cfg_getAttributeLLong() - Get item as long long from config and return value from it
    *
    * @cfg = Config root
    * @csSec = Config section //[{csSec}], if NULL unset in *default* section
    * @csAttr = Config attribute //{csAttr} = ...
    * return: value
    */
   long long
   cfg_getAttributeLLong(cfg_root_t * __restrict cfg, 
                   const char *csSec, const char *csAttr);
   /*
    * cfg_getAttributeDouble() - Get item as double from config and return value from it
    *
    * @cfg = Config root
    * @csSec = Config section //[{csSec}], if NULL unset in *default* section
    * @csAttr = Config attribute //{csAttr} = ...
    * return: value
    */
   double cfg_getAttributeDouble(cfg_root_t * __restrict cfg, 
                   const char *csSec, const char *csAttr);
   /*
    * cfg_getAttributeLDouble() - Get item as long double from config and return value from it
    *
    * @cfg = Config root
    * @csSec = Config section //[{csSec}], if NULL unset in *default* section
    * @csAttr = Config attribute //{csAttr} = ...
    * return: value
    */
   long double cfg_getAttributeLDouble(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_setAttribute() - Set item in config or adding new item if not exists
  *   *
  * @cfg = Config root   * @cfg = Config root
Line 193  inline const char *cfg_getAttribute(cfg_root_t * __res Line 315  inline const char *cfg_getAttribute(cfg_root_t * __res
  */   */
 int cfg_setAttribute(cfg_root_t * __restrict cfg, const char *csSec,   int cfg_setAttribute(cfg_root_t * __restrict cfg, const char *csSec, 
                 const char *csAttr, const char *csVal);                  const char *csAttr, const char *csVal);
   
 #if 0  
 /*  /*
 * 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} = ...
 * 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_LoadAttribute() Extended get attribute, if not found item return *default value* * cfg_loadAttribute() - Get guarded attribute, if not found item return *default value*
 * @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} = ...
 * @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 
   
   #ifdef __cplusplus
   }
   #endif
   
 #endif  #endif
Removed from v.1.6.4.2  
changed lines
  Added in v.1.22.2.1

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