---

tucs.h

Go to the documentation of this file.

#ifndef __TUCS_H_INCLUDED__
#define __TUCS_H_INCLUDED__

#define TUCS "0.1.15"

typedef struct setting * tucs_setting;

#define TUCS_BADSETTING NULL

typedef enum {
  TypeGeneric =  1,   /* if not known */
  TypeString  =  2,
  TypeInt     =  3,
  TypeDouble  =  4,
  TypeBool    =  5,
  /* container settings */
  TypeGroup   = 10,
  TypeList    = 11
} tucs_type;

typedef unsigned char tucs_bool;

typedef enum {
  OK,
  EOutOfMem, EWrongType, ENotGroup, EIsGroup, EInvalidSetting,
  ENoParentGroup
} tucs_errors;

tucs_errors tucs_error;

typedef enum {
  SyncImmediate = 1,
  SyncOnCommand = 2
} tucs_syncMode;

typedef enum {
  MetaNever         = 1,
  MetaIfMissing     = 2,
  MetaIfRootMissing = 3
} tucs_metaconfigMode;

int tucs_init(const char * base_path);


tucs_setting
tucs_declareStringSetting(const char * name, const char * defval, 
  const char * sdesc, int flags);
tucs_setting
tucs_declareIntSetting(const char * name, int defval, 
  const char * sdesc, int flags);
tucs_setting
tucs_declareDoubleSetting(const char * name, double defval, 
  const char * sdesc, int flags);
tucs_setting
tucs_declareBoolSetting(const char * name, tucs_bool defval, 
  const char * sdesc, int flags);

tucs_setting tucs_getSetting(const char * name);

tucs_setting tucs_getGroupHandle(const char * base_path);

const char * tucs_getStringValue(tucs_setting setting);
int    tucs_getIntValue(tucs_setting setting);
const char * tucs_getStringValueByName(const char * name, const char * defval);
int    tucs_getIntValueByName(const char * name, int defval);

int tucs_setStringValue(tucs_setting setting, const char *    newval);
int tucs_setIntValue   (tucs_setting setting, int       newval);
int tucs_setDoubleValue(tucs_setting setting, double    newval);
int tucs_setBoolValue  (tucs_setting setting, tucs_bool newval);
int tucs_setStringValueByName(const char * name, const char *    newval);
int tucs_setIntValueByName   (const char * name, int       newval);
int tucs_setDoubleValueByName(const char * name, double    newval);
int tucs_setBoolValueByName  (const char * name, tucs_bool newval);

int tucs_setSettingDefault(tucs_setting setting);

const char * tucs_getName(const tucs_setting setting);
const char * tucs_getPath(const tucs_setting setting);
const char * tucs_getPrefix(const tucs_setting setting);
const char * tucs_getDescription(const tucs_setting setting);
tucs_type tucs_getType(const tucs_setting setting);


tucs_setting tucs_setBase(const char * base_path);

int tucs_setSearchOrder(const char * searchlist);


int tucs_setSyncMode(tucs_syncMode syncMode);

int tucs_setMetaconfigMode(tucs_metaconfigMode mode);

tucs_setting tucs_getGroupFirst(tucs_setting group);

tucs_setting tucs_getGroupNext(tucs_setting group);

tucs_setting tucs_getMetaGroup(const tucs_setting set);

tucs_setting tucs_getMetaGroupByName(const char * pathname);

tucs_setting tucs_recreateMetaGroup(const tucs_setting set);

int tucs_commit(void);

void tucs_commitSetting(tucs_setting setting);

void tucs_close(void);


char * tucs_getCurrentUser(void);

void tucs_debugWrite(void);



#endif

---