[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.4 and 1.15

version 1.6.4.4, 2012/04/02 16:00:00 version 1.15, 2014/03/19 18:38: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 - 2014
         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 {
Line 56  struct tagCfg { Line 56  struct tagCfg {
         ait_val_t               cfg_attr;          ait_val_t               cfg_attr;
         ait_val_t               cfg_val;          ait_val_t               cfg_val;
   
        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*))
   
   
 // 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);
   /*
  * cfgLoadConfig() - Load config from file   * cfgLoadConfig() - Load config from file
  *   *
  * @cfgName = Config filename   * @cfgName = Config filename
Line 96  inline const char *cfg_GetError(); Line 108  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);
   
 /*  /*
    * cfgReadLines() - Read custom lines and add new item at config root
    *
    * @f = File resource
    * @delim = Custom delimiter, if =NULL default is '='
    * @end = Custom user end of file, if =NULL default is EOF
    * @cfg = Config root
    * return: -1 error or 0 ok
    */
   int cfgReadLines(FILE *f, const char *delim, const char *end, 
                   cfg_root_t * __restrict cfg);
   /*
    * cfgWriteLines() - Write custom lines and export data to variable
    *
    * @f = File resource
    * @delim = Custom delimiter, if =NULL default is '='
    * @eol = End of line string, if =NULL default is "\n"
    * @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);
   /*
  * cfgReadConfig() - Read file and add new item at config root   * cfgReadConfig() - Read file and add new item at config root
  *   *
  * @f = File resource   * @f = File resource
Line 111  void cfgUnloadConfig(cfg_root_t * __restrict cfg); Line 163  void cfgUnloadConfig(cfg_root_t * __restrict cfg);
  * return: -1 error or 0 ok   * return: -1 error or 0 ok
  */   */
 int cfgReadConfig(FILE *f, cfg_root_t * __restrict cfg);  int cfgReadConfig(FILE *f, cfg_root_t * __restrict cfg);
   
 #if 0  
 /*  /*
 * cfg_CreateConfig() Create config file from memory without whitespaces! * cfgWriteConfig() - Write config from memory
 * @csConfigName = New config filename *
 * @cfg = Head list element * @f = File handle
 * return: 0 ok; -1 error:: can`t save new config * @cfg = Config root
*/ * @whitespace = Additional whitespace characters to file
int cfg_CreateConfig(const char *csConfigName, sl_config * __restrict cfg); * return: -1 error or 0 ok
  */
 int cfgWriteConfig(FILE *f, cfg_root_t * __restrict cfg, int whitespace);
 /*  /*
 * CreateConfig() Create config file from memory * cfgConcatConfig() - Concat two configs into one
 * @csConfigName = New config filename *
 * @cfg = Head list element * @cfg = Config root
 * return: 0 ok; -1 error:: can`t save new config * @add_cfg = Concated config will be destroy after merge
*/ * return: -1 error or 0 ok
int CreateConfig(const char *csConfigName, sl_config * __restrict cfg); */
int cfgConcatConfig(cfg_root_t * __restrict cfg, cfg_root_t * __restrict add_cfg);
 
 /*  /*
 * WriteConfig() Write to file from items in config list * cfgMergeConfig() - Marge two list in one cfg and destroy add_cfg
 * @f = file resource *
 * @cfg = Head list element * @cfg = Config root of main list
 * return: 0 ok; -1 error:: can`t write to file * @add_cfg = Merged config will be destroy after merge
*/ * return: -1 error or 0 ok
int WriteConfig(FILE *f, sl_config * __restrict cfg); */
 int cfgMergeConfig(cfg_root_t * __restrict cfg, cfg_root_t * __restrict add_cfg);
   
 /*  /*
 * cfg_WriteConfig() Write to file from items in config list without whitespaces! * cfg_getSection() - Get entire section attributes into array
 * @f = file resource *
 * @cfg = Head list element * @cfg = Config root
 * return: 0 ok; -1 error:: can`t write to file * @csSec = Config section //[{csSec}]
*/ * return: NULL not found or !=NULL allocated array, must free with array_Destroy() after use!
int cfg_WriteConfig(FILE *f, sl_config * __restrict cfg); */
array_t *cfg_getSection(cfg_root_t * __restrict cfg, const char *csSec);
 /*  /*
  * 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_findAttribute() - Find attribute position in config file
  *   *
  * @cfg = Config root   * @cfg = Config root
  * @csSec = Config section //[{csSec}]   * @csSec = Config section //[{csSec}]
 * @csAttr = Config attribute //{csAttr} = ... * @csAttr = Config attribute //{csAttr} = ..., if NULL as *any* attribute
  * 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} = ..., if NULL as *any* attribute
  * 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_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
Line 198  int cfg_setAttribute(cfg_root_t * __restrict cfg, cons Line 233  int cfg_setAttribute(cfg_root_t * __restrict cfg, cons
  *   *
  * @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} = ... * @csAttr = Config attribute //{csAttr} = ..., if NULL as *any* attribute
  * return: 0 item not found, -1 error or 1 removed item   * return: 0 item not found, -1 error or 1 removed item
  */   */
 int cfg_unsetAttribute(cfg_root_t * __restrict cfg, const char *csSec,   int cfg_unsetAttribute(cfg_root_t * __restrict cfg, const char *csSec, 
Line 209  int cfg_unsetAttribute(cfg_root_t * __restrict cfg, co Line 244  int cfg_unsetAttribute(cfg_root_t * __restrict cfg, co
  *   *
  * @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} = ... * @csAttr = Config attribute //{csAttr} = ..., if NULL as *any* attribute
  * @val = Return buffer for item Value //... = {val}   * @val = Return buffer for item Value //... = {val}
  * @csDefValue = *Default Value* for return in //{val}, if not found item in config   * @csDefValue = *Default Value* for return in //{val}, if not found item in config
  * return: 0 item not found, -1 error or >0 number of copied bytes in //{val}   * return: 0 item not found, -1 error or >0 number of copied bytes in //{val}
Removed from v.1.6.4.4  
changed lines
  Added in v.1.15

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