clo.h

Go to the documentation of this file.

#ifndef CLO_H
#define CLO_H
 
#include <stdio.h>
#include <inttypes.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
#define CLO_CHUNK_SIZE 32
 
#define CLO_ARRAY_DELIMITER " \t,:[]()\""
 
enum clo_dataType_t {
    CLO_TYPE_BOOL,
    CLO_TYPE_INT,
    CLO_TYPE_INT64,
    CLO_TYPE_FLOAT,
    CLO_TYPE_DOUBLE,
    CLO_TYPE_STRING,
    CLO_TYPE_IFILE,
    CLO_TYPE_OFILE,
    CLO_TYPE_HELP,
    CLO_TYPE_POSITION
};
 
// forward reference for option structure
struct clo_option_t;
 
typedef void (*clo_optionCallback_t)(struct clo_option_t *option);
 
typedef struct clo_option_t {
    char *key; 
    enum clo_dataType_t dataType; 
    char *defaultVal; 
    char *desc; 
    char *valStr; 
    char *source; 
    clo_optionCallback_t cb; 
    void *cb_data; 
    int cb_flag; 
    char **strArray; 
    void *valArray; 
    int count; 
    char **aliases; 
    int numAliases; 
    int aliasStorageSize; 
    int position; 
} clo_option_t;
 
typedef struct clo_optionList_t {
    int storageSize; 
    int numOptions; 
    clo_option_t **options; 
    int positionStorageSize; 
    int positionNumOptions; 
    clo_option_t **positionOptions; 
} clo_optionList_t;
 
typedef struct clo_programMetadata_t {
    char* tag; 
    char* value; 
} clo_programMetadata_t;
 
typedef struct clo_programMetadataList_t {
    int storageSize; 
    int numEntries; 
    clo_programMetadata_t **entries; 
} clo_programMetadataList_t;
 
// global library settings
void clo_setIgnoreKeyCase(int val);
int clo_getIgnoreKeyCase();
 
void clo_setEnableDumpOptions(int val);
int clo_getEnableDumpOptions();
 
void clo_setEnableExtraOptions(int val);
int clo_getEnableExtraOptions();
 
void clo_setVersion(const char *str);
void clo_setVersion2(const char* programName, const char* versionStr);
char* clo_getVersion();
 
void clo_setHelpStr(const char *str);
char* clo_getHelpStr();
 
void clo_setSelectOptionKeys(char *keys[]);
char **clo_getSelectOptionKeys();
 
clo_optionList_t* clo_createList();
 
clo_option_t* clo_createOption(const char *key, enum clo_dataType_t dataType,
        const char *defaultVal, const char *desc);
void clo_addOptionAlias(clo_option_t *option, const char* alias);
void clo_addAlias(clo_optionList_t *list, const char *key, const char* alias);
void clo_insertOption(clo_optionList_t *list, clo_option_t *option);
clo_option_t* clo_addOption(clo_optionList_t *list, const char *key,
        enum clo_dataType_t dataType, const char *defaultVal,
        const char* desc);
clo_option_t* clo_copyOption(clo_option_t *option);
clo_optionList_t* clo_copyList(clo_optionList_t *list);
void clo_deleteOption(clo_option_t *option);
void clo_deleteList(clo_optionList_t *list);
clo_option_t* clo_getOption(clo_optionList_t *list, int i);
clo_option_t* clo_findOption(clo_optionList_t *list, const char *key);
int clo_getNumOptions(clo_optionList_t *list);
char* clo_getOptionRawString(clo_option_t *option);
 
char* clo_getOptionString(clo_option_t *option);
int clo_getOptionBool(clo_option_t *option);
int clo_getOptionInt(clo_option_t *option);
int64_t clo_getOptionInt64(clo_option_t *option);
float clo_getOptionFloat(clo_option_t *option);
double clo_getOptionDouble(clo_option_t *option);
 
char** clo_getOptionStrings(clo_option_t *option, int *count);
int* clo_getOptionBools(clo_option_t *option, int *count);
int* clo_getOptionInts(clo_option_t *option, int *count);
float* clo_getOptionFloats(clo_option_t *option, int *count);
double* clo_getOptionDoubles(clo_option_t *option, int *count);
 
char* clo_getRawString(clo_optionList_t *list, const char *key);
char* clo_getString(clo_optionList_t *list, const char *key);
int clo_getBool(clo_optionList_t *list, const char *key);
int clo_getInt(clo_optionList_t *list, const char *key);
float clo_getFloat(clo_optionList_t *list, const char *key);
double clo_getDouble(clo_optionList_t *list, const char *key);
 
char** clo_getStrings(clo_optionList_t *list, const char *key, int *count);
int* clo_getBools(clo_optionList_t *list, const char *key, int *count);
int* clo_getInts(clo_optionList_t *list, const char *key, int *count);
float* clo_getFloats(clo_optionList_t *list, const char *key, int *count);
double* clo_getDoubles(clo_optionList_t *list, const char *key, int *count);
 
int clo_setOptionString(clo_option_t *option, const char *val, const char *source);
int clo_setString(clo_optionList_t *list, const char* key, const char *val, const char *source);
 
// position option functions
void clo_setEnablePositionOptions(int val);
int clo_getEnablePositionOptions();
int clo_getPositionNumOptions(clo_optionList_t *list);
clo_option_t* clo_getPositionOption(clo_optionList_t *list, int i);
char* clo_getPositionString(clo_optionList_t *list, int pos);
 
void clo_setEnableParOption(int val);
int clo_getEnableParOption();
 
void clo_printOptionVal(clo_option_t *option);
void clo_printVals(clo_optionList_t *list);
void clo_printOption(clo_option_t *option);
void clo_printOptions(clo_optionList_t *list);
void clo_dumpOption(clo_option_t *option);
void clo_dumpOptions(clo_optionList_t *list);
void clo_printVersion();
void clo_printHelpString();
void clo_printUsage(clo_optionList_t *list);
 
void clo_readString(clo_optionList_t *list, const char *str, const char *source);
void clo_readArgs(clo_optionList_t *list, int argc, char *argv[]);
void clo_readArgsPar(clo_optionList_t *list, int argc, char *argv[], int enableFileDescending);
void clo_readOptions(clo_optionList_t *list, clo_optionList_t *readList);
void clo_readFile(clo_optionList_t *list, const char *fileName);
 
int clo_isOptionSet(clo_option_t *option);
int clo_isSet(clo_optionList_t *list, const char *key);
 
int clo_writeParameterFile(clo_optionList_t *list, const char *filename);
 
void clo_addXmlProgramMetadata(const char* tag, const char* value);
void clo_clearXmlProgramMetadata();
 
void clo_writeXmlStartTag(FILE *fout, int level, const char *tag);
void clo_writeXmlEndTag(FILE *fout, int level, const char *tag);
void clo_writeXmlTag(FILE *fout, int level, const char *tag, const char *value);
int clo_writeXmlFile(clo_optionList_t *list, const char *filename);
 
void clo_trimDashes(char* str);
char* clo_trimDashesDup(const char* str);
 
//void clo_resetFileRecursion();
 
 
#ifdef __cplusplus
}
#endif
 
#endif