| confuse.h(3) | Library Functions Manual | confuse.h(3) |
confuse.h - A configuration file parser library.
#include <stdio.h>
#include <stdarg.h>
struct cfg_t
Data structure holding information about a 'section'. union cfg_value_t
Data structure holding the value of a fundamental option value. union
cfg_simple_t
Data structure holding the pointer to a user provided variable defined with
CFG_SIMPLE_*. struct cfg_defvalue_t
Data structure holding the default value given by the initialization macros.
struct cfg_opt_t
Data structure holding information about an option.
#define CFGF_NONE (0)
Flags. #define CFGF_MULTI (1 << 0)
option may be specified multiple times (only applies to sections) #define
CFGF_LIST (1 << 1)
option is a list #define CFGF_NOCASE (1 << 2)
configuration file is case insensitive #define CFGF_TITLE (1 <<
3)
option has a title (only applies to sections) #define CFGF_NODEFAULT (1
<< 4)
option has no default value #define CFGF_NO_TITLE_DUPES (1 << 5)
multiple section titles must be unique (duplicates raises an error, only
applies to sections) #define CFGF_IGNORE_UNKNOWN (1 << 8)
ignore unknown options in configuration files #define CFGF_DEPRECATED
(1 << 9)
option is deprecated and should be ignored. #define CFGF_DROP (1
<< 10)
option should be dropped after parsing #define CFGF_COMMENTS (1
<< 11)
Enable option annotation/comments support. #define CFGF_MODIFIED (1
<< 12)
option has been changed from its default value #define CFGF_KEYSTRVAL
(1 << 13)
section has free-form key=value string options created when parsing file
#define CFG_SUCCESS 0
Return codes from cfg_parse(), cfg_parse_boolean(), and
cfg_set*() functions. #define CFG_STR(name, def, flags)
__CFG_STR(name, def, flags, 0, 0)
Initialize a string option. #define CFG_STR_LIST(name, def, flags)
__CFG_STR_LIST(name, def, flags, 0, 0)
Initialize a string list option. #define CFG_STR_CB(name, def, flags,
cb) __CFG_STR(name, def, flags, 0, cb)
Initialize a string option with a value parsing callback. #define
CFG_STR_LIST_CB(name, def, flags, cb) __CFG_STR_LIST(name, def,
flags, 0, cb)
Initialize a string list option with a value parsing callback. #define
CFG_SIMPLE_STR(name, svalue) __CFG_STR(name, 0, CFGF_NONE,
svalue, 0)
Initialize a 'simple' string option. #define CFG_INT(name, def, flags)
__CFG_INT(name, def, flags, 0, 0)
Initialize an integer option. #define CFG_INT_LIST(name, def, flags)
__CFG_INT_LIST(name, def, flags, 0, 0)
Initialize an integer list option. #define CFG_INT_CB(name, def, flags,
cb) __CFG_INT(name, def, flags, 0, cb)
Initialize an integer option with a value parsing callback. #define
CFG_INT_LIST_CB(name, def, flags, cb) __CFG_INT_LIST(name, def,
flags, 0, cb)
Initialize an integer list option with a value parsing callback. #define
CFG_SIMPLE_INT(name, svalue) __CFG_INT(name, 0, CFGF_NONE,
svalue, 0)
Initialize a 'simple' integer option (see documentation for CFG_SIMPLE_STR for
more information). #define CFG_FLOAT(name, def, flags)
__CFG_FLOAT(name, def, flags, 0, 0)
Initialize a floating point option. #define CFG_FLOAT_LIST(name, def,
flags) __CFG_FLOAT_LIST(name, def, flags, 0, 0)
Initialize a floating point list option. #define CFG_FLOAT_CB(name,
def, flags, cb) __CFG_FLOAT(name, def, flags, 0, cb)
Initialize a floating point option with a value parsing callback. #define
CFG_FLOAT_LIST_CB(name, def, flags, cb) __CFG_FLOAT_LIST(name, def,
flags, 0, cb)
Initialize a floating point list option with a value parsing callback. #define
CFG_SIMPLE_FLOAT(name, svalue) __CFG_FLOAT(name, 0, CFGF_NONE,
svalue, 0)
Initialize a 'simple' floating point option (see documentation for
CFG_SIMPLE_STR for more information). #define CFG_BOOL(name, def,
flags) __CFG_BOOL(name, def, flags, 0, 0)
Initialize a boolean option. #define CFG_BOOL_LIST(name, def, flags)
__CFG_BOOL_LIST(name, def, flags, 0, 0)
Initialize a boolean list option. #define CFG_BOOL_CB(name, def, flags,
cb) __CFG_BOOL(name, def, flags, 0, cb)
Initialize a boolean option with a value parsing callback. #define
CFG_BOOL_LIST_CB(name, def, flags, cb) __CFG_BOOL_LIST(name, def,
flags, 0, cb)
Initialize a boolean list option with a value parsing callback. #define
CFG_SIMPLE_BOOL(name, svalue) __CFG_BOOL(name, cfg_false,
CFGF_NONE, svalue, 0)
Initialize a 'simple' boolean option (see documentation for CFG_SIMPLE_STR for
more information). #define CFG_SEC(name, opts, flags)
{name,0,CFGT_SEC,0,0,flags,opts,{0,0,cfg_false,0,0},0,{0},0,0,0,0,0}
Initialize a section. #define CFG_FUNC(name, func)
{name,0,CFGT_FUNC,0,0,CFGF_NONE,0,{0,0,cfg_false,0,0},func,{0},0,0,0,0,0}
Initialize a function. #define CFG_PTR_CB(name, def, flags, parsecb,
freecb) __CFG_PTR(name, def, flags, 0, parsecb, freecb)
Initialize a user-defined option. #define CFG_PTR_LIST_CB(name, def,
flags, parsecb, freecb) __CFG_PTR(name, def, flags | CFGF_LIST, 0,
parsecb, freecb)
Initialize a list of user-defined options. #define CFG_END()
{0,0,CFGT_NONE,0,0,CFGF_NONE,0,{0,0,cfg_false,0,0},0,{0},0,0,0,0,0}
Terminate list of options.
typedef int(* cfg_func_t) (cfg_t *cfg,
cfg_opt_t *opt, int argc, const char **argv)
Function prototype used by CFGT_FUNC options. typedef void(*
cfg_print_func_t) (cfg_opt_t *opt, unsigned int index, FILE
*fp)
Function prototype used by the cfg_print_ functions. typedef int(*
cfg_callback_t) (cfg_t *cfg, cfg_opt_t *opt, const char
*value, void *result)
Value parsing callback prototype. typedef int(*
cfg_validate_callback_t) (cfg_t *cfg, cfg_opt_t *opt)
Validating callback prototype. typedef int(* cfg_validate_callback2_t)
(cfg_t *cfg, cfg_opt_t *opt, void *value)
Validating callback2 prototype. typedef void(* cfg_free_func_t) (void
*value)
User-defined memory release function for CFG_PTR values. typedef void(*
cfg_errfunc_t) (cfg_t *cfg, const char *fmt, va_list ap)
Error reporting function. typedef int(* cfg_print_filter_func_t)
(cfg_t *cfg, cfg_opt_t *opt)
Print filter function.
enum cfg_type_t { }
Fundamental option types. enum cfg_bool_t
Boolean values.
DLLIMPORT cfg_t *__export cfg_init (cfg_opt_t
*opts, cfg_flag_t flags)
Create and initialize a cfg_t structure. DLLIMPORT int __export
cfg_add_searchpath (cfg_t *cfg, const char *dir)
Add a searchpath directory to the configuration context, the const char*
argument will be duplicated and then freed as part of the usual context
takedown. DLLIMPORT char *__export cfg_searchpath (cfg_searchpath_t
*path, const char *file)
Search the linked-list of cfg_searchpath_t for the specified file. DLLIMPORT
int __export cfg_parse (cfg_t *cfg, const char *filename)
Parse a configuration file. DLLIMPORT int __export cfg_parse_fp
(cfg_t *cfg, FILE *fp)
Same as cfg_parse() above, but takes an already opened file as
argument. DLLIMPORT int __export cfg_parse_buf (cfg_t *cfg,
const char *buf)
Same as cfg_parse() above, but takes a character buffer as argument.
DLLIMPORT int __export cfg_free_value (cfg_opt_t *opt)
Free the memory allocated for the values of a given option. DLLIMPORT int
__export cfg_free (cfg_t *cfg)
Free a cfg_t context. DLLIMPORT cfg_errfunc_t __export
cfg_set_error_function (cfg_t *cfg, cfg_errfunc_t
errfunc)
Install a user-defined error reporting function. DLLIMPORT void __export
cfg_error (cfg_t *cfg, const char *fmt,...)
Show a parser error. DLLIMPORT char *__export cfg_opt_getcomment
(cfg_opt_t *opt)
Returns the option comment. DLLIMPORT char *__export cfg_getcomment
(cfg_t *cfg, const char *name)
Returns the option comment. DLLIMPORT signed long __export
cfg_opt_getnint (cfg_opt_t *opt, unsigned int index)
Returns the value of an integer option, given a cfg_opt_t pointer.
DLLIMPORT long int __export cfg_getnint (cfg_t *cfg, const
char *name, unsigned int index)
Indexed version of cfg_getint(), used for lists. DLLIMPORT long int
__export cfg_getint (cfg_t *cfg, const char *name)
Returns the value of an integer option. DLLIMPORT double __export
cfg_opt_getnfloat (cfg_opt_t *opt, unsigned int index)
Returns the value of a floating point option, given a cfg_opt_t
pointer. DLLIMPORT double __export cfg_getnfloat (cfg_t *cfg,
const char *name, unsigned int index)
Indexed version of cfg_getfloat(), used for lists. DLLIMPORT double
__export cfg_getfloat (cfg_t *cfg, const char *name)
Returns the value of a floating point option. DLLIMPORT char *__export
cfg_opt_getnstr (cfg_opt_t *opt, unsigned int index)
Returns the value of a string option, given a cfg_opt_t pointer.
DLLIMPORT char *__export cfg_getnstr (cfg_t *cfg, const char
*name, unsigned int index)
Indexed version of cfg_getstr(), used for lists. DLLIMPORT char
*__export cfg_getstr (cfg_t *cfg, const char *name)
Returns the value of a string option. DLLIMPORT cfg_bool_t __export
cfg_opt_getnbool (cfg_opt_t *opt, unsigned int index)
Returns the value of a boolean option, given a cfg_opt_t pointer.
DLLIMPORT cfg_bool_t __export cfg_getnbool (cfg_t *cfg,
const char *name, unsigned int index)
Indexed version of cfg_getbool(), used for lists. DLLIMPORT
cfg_bool_t __export cfg_getbool (cfg_t *cfg, const char
*name)
Returns the value of a boolean option. DLLIMPORT void *__export
cfg_getptr (cfg_t *cfg, const char *name)
Returns the value of a user-defined option (void pointer). DLLIMPORT
cfg_t *__export cfg_opt_getnsec (cfg_opt_t *opt,
unsigned int index)
Returns the value of a section option, given a cfg_opt_t pointer.
DLLIMPORT cfg_t *__export cfg_getnsec (cfg_t *cfg,
const char *name, unsigned int index)
Indexed version of cfg_getsec(), used for sections with the CFGF_MULTI
flag set. DLLIMPORT cfg_t *__export cfg_opt_gettsec
(cfg_opt_t *opt, const char *title)
Returns the value of a section option, given a cfg_opt_t pointer and
the title. DLLIMPORT cfg_t *__export cfg_gettsec (cfg_t
*cfg, const char *name, const char *title)
Return a section given the title, used for section with the CFGF_TITLE flag
set. DLLIMPORT cfg_t *__export cfg_getsec (cfg_t *cfg,
const char *name)
Returns the value of a section option. DLLIMPORT unsigned int __export
cfg_opt_size (cfg_opt_t *opt)
Return the number of values this option has. DLLIMPORT unsigned int __export
cfg_size (cfg_t *cfg, const char *name)
Return the number of values this option has. DLLIMPORT const char *__export
cfg_title (cfg_t *cfg)
Return the title of a section. DLLIMPORT const char *__export cfg_name
(cfg_t *cfg)
Return the name of a section. DLLIMPORT const char *__export
cfg_opt_name (cfg_opt_t *opt)
Return the name of an option. DLLIMPORT const char * cfg_opt_getstr
(cfg_opt_t *opt)
Return the string value of a key=value pair. DLLIMPORT int __export
cfg_include (cfg_t *cfg, cfg_opt_t *opt, int argc,
const char **argv)
Predefined include-function. DLLIMPORT char *__export cfg_tilde_expand
(const char *filename)
Does tilde expansion (~ -> $HOME) on the filename. DLLIMPORT int __export
cfg_parse_boolean (const char *s)
Parse a boolean option string. DLLIMPORT cfg_opt_t * cfg_getnopt
(cfg_t *cfg, unsigned int index)
Return the nth option in a file or section. DLLIMPORT cfg_opt_t
*__export cfg_getopt (cfg_t *cfg, const char *name)
Return an option given it's name. DLLIMPORT cfg_value_t *
cfg_setopt (cfg_t *cfg, cfg_opt_t *opt, const char
*value)
Set an option (create an instance of an option). DLLIMPORT int __export
cfg_opt_setcomment (cfg_opt_t *opt, char *comment)
Annotate an option. DLLIMPORT int __export cfg_setcomment (cfg_t
*cfg, const char *name, char *comment)
Annotate an option given its name. DLLIMPORT int __export
cfg_opt_setnint (cfg_opt_t *opt, long int value, unsigned int
index)
Set a value of an integer option. DLLIMPORT int __export cfg_setint
(cfg_t *cfg, const char *name, long int value)
Set the value of an integer option given its name. DLLIMPORT int __export
cfg_setnint (cfg_t *cfg, const char *name, long int value,
unsigned int index)
Set a value of an integer option given its name and index. DLLIMPORT int
__export cfg_opt_setnfloat (cfg_opt_t *opt, double value,
unsigned int index)
Set a value of a floating point option. DLLIMPORT int __export
cfg_setfloat (cfg_t *cfg, const char *name, double value)
Set the value of a floating point option given its name. DLLIMPORT int
__export cfg_setnfloat (cfg_t *cfg, const char *name, double
value, unsigned int index)
Set a value of a floating point option given its name and index. DLLIMPORT int
__export cfg_opt_setnbool (cfg_opt_t *opt, cfg_bool_t
value, unsigned int index)
Set a value of a boolean option. DLLIMPORT int __export cfg_setbool
(cfg_t *cfg, const char *name, cfg_bool_t value)
Set the value of a boolean option given its name. DLLIMPORT int __export
cfg_setnbool (cfg_t *cfg, const char *name, cfg_bool_t
value, unsigned int index)
Set a value of a boolean option given its name and index. DLLIMPORT int
__export cfg_opt_setnstr (cfg_opt_t *opt, const char *value,
unsigned int index)
Set a value of a string option. DLLIMPORT int __export cfg_setstr
(cfg_t *cfg, const char *name, const char *value)
Set the value of a string option given its name. DLLIMPORT int __export
cfg_setnstr (cfg_t *cfg, const char *name, const char *value,
unsigned int index)
Set a value of a boolean option given its name and index. DLLIMPORT int
__export cfg_setlist (cfg_t *cfg, const char *name, unsigned
int nvalues,...)
Set values for a list option. DLLIMPORT unsigned int __export cfg_num
(cfg_t *cfg)
Return number of options in a file or section. DLLIMPORT int __export
cfg_addlist (cfg_t *cfg, const char *name, unsigned int
nvalues,...)
Add values for a list option. DLLIMPORT int cfg_opt_setmulti
(cfg_t *cfg, cfg_opt_t *opt, unsigned int nvalues, char
**values)
Set an option (create an instance of an option). DLLIMPORT int
cfg_setmulti (cfg_t *cfg, const char *name, unsigned int
nvalues, char **values)
Set an option (create an instance of an option). DLLIMPORT cfg_t *
cfg_addtsec (cfg_t *cfg, const char *name, const char *title)
Create a new titled config section. DLLIMPORT int __export
cfg_opt_rmnsec (cfg_opt_t *opt, unsigned int index)
Removes and frees a config section, given a cfg_opt_t pointer.
DLLIMPORT int __export cfg_rmnsec (cfg_t *cfg, const char
*name, unsigned int index)
Indexed version of cfg_rmsec(), used for CFGF_MULTI sections. DLLIMPORT
int __export cfg_rmsec (cfg_t *cfg, const char *name)
Removes and frees a config section. DLLIMPORT int __export
cfg_opt_rmtsec (cfg_opt_t *opt, const char *title)
Removes and frees a config section, given a cfg_opt_t pointer and the
title. DLLIMPORT int __export cfg_rmtsec (cfg_t *cfg, const
char *name, const char *title)
Removes and frees a section given the title, used for section with the
CFGF_TITLE flag set. DLLIMPORT int __export cfg_opt_nprint_var
(cfg_opt_t *opt, unsigned int index, FILE *fp)
Default value print function. DLLIMPORT int __export
cfg_opt_print_indent (cfg_opt_t *opt, FILE *fp, int indent)
Print an option and its value to a file. DLLIMPORT int __export
cfg_opt_print (cfg_opt_t *opt, FILE *fp)
Print an option and its value to a file. DLLIMPORT int __export
cfg_print_indent (cfg_t *cfg, FILE *fp, int indent)
Print the options and values to a file. DLLIMPORT int __export
cfg_print (cfg_t *cfg, FILE *fp)
Print the options and values to a file. DLLIMPORT cfg_print_func_t
__export cfg_opt_set_print_func (cfg_opt_t *opt,
cfg_print_func_t pf)
Set a print callback function for an option. DLLIMPORT cfg_print_func_t
__export cfg_set_print_func (cfg_t *cfg, const char *name,
cfg_print_func_t pf)
Set a print callback function for an option given its name. DLLIMPORT
cfg_print_filter_func_t __export cfg_set_print_filter_func
(cfg_t *cfg, cfg_print_filter_func_t pff)
Install a user-defined print filter function. DLLIMPORT
cfg_validate_callback_t __export cfg_set_validate_func
(cfg_t *cfg, const char *name, cfg_validate_callback_t vf)
Register a validating callback function for an option. DLLIMPORT
cfg_validate_callback2_t __export cfg_set_validate_func2
(cfg_t *cfg, const char *name, cfg_validate_callback2_t vf)
Register a validating callback function for an option.
A configuration file parser library.
Terminate list of options. This must be the last initializer in the option list.
Examples
ftpconf.c, reread.c, and simple.c.
Initialize a function.
Parameters
See also
Examples
ftpconf.c.
Initialize a user-defined option. CFG_PTR options can only be used together with a value parsing callback.
Parameters
See also
Initialize a section.
Parameters
Examples
ftpconf.c, and reread.c.
Initialize a 'simple' integer option (see documentation for CFG_SIMPLE_STR for more information). Note that confuse uses long integers, so make sure that any pointer you provide for svalue points to a long int rather than a normal int. Otherwise, you will have strange problems on 64-bit architectures.
Examples
simple.c.
Initialize a 'simple' string option. 'Simple' options (in lack of a better expression) does not support lists of values or multiple sections. LibConfuse will store the value of a simple option in the user-defined location specified by the value parameter in the initializer. Simple options are not stored in the cfg_t context, only a pointer. Sections can not be initialized as a 'simple' option.
As of version 2.2, libConfuse can now return the values of simple options with the cfg_get functions. This allows using the new cfg_print function with simple options.
libConfuse doesn't support handling default values for 'simple' options. They are assumed to be set by the calling application before cfg_parse is called.
Parameters
char *user = 'joe';
...
cfg_opt_t opts[] = {
CFG_SIMPLE_STR('user', &user),
...
since libConfuse will try to free the static string 'joe' (which is an error)
when a 'user' option is found. Rather, use the following code snippet:
char *user = strdup('joe');
...
cfg_opt_t opts[] = {
CFG_SIMPLE_STR('user', &user),
...
Alternatively, the default value can be set after the opts struct is defined,
as in:
char *user = 0;
...
cfg_opt_t opts[] = {
CFG_SIMPLE_STR('user', &user),
...
user = strdup('joe');
cfg = cfg_init(opts, 0);
cfg_parse(cfg, filename);
Examples
simple.c.
Return codes from cfg_parse(), cfg_parse_boolean(), and cfg_set*() functions.
Examples
ftpconf.c, and reread.c.
option is deprecated and should be ignored.
Flags.
Examples
ftpconf.c, and reread.c.
Value parsing callback prototype. This is a callback function (different from the one registered with the CFG_FUNC initializer) used to parse a value. This can be used to override the internal parsing of a value.
Suppose you want an integer option that only can have certain values, for example 1, 2 and 3, and these should be written in the configuration file as 'yes', 'no' and 'maybe'. The callback function would be called with the found value ('yes', 'no' or 'maybe') as a string, and the result should be stored in the result parameter.
Parameters
Returns
Error reporting function.
User-defined memory release function for CFG_PTR values. This callback is used to free memory allocated in a value parsing callback function. Especially useful for CFG_PTR options, since libConfuse will not itself release such values. If the values are simply allocated with a malloc(3), one can use the standard free(3) function here.
Function prototype used by CFGT_FUNC options. This is a callback function, registered with the CFG_FUNC initializer. Each time libConfuse finds a function, the registered callback function is called (parameters are passed as strings, any conversion to other types should be made in the callback function). libConfuse does not support any storage of the data found; these are passed as parameters to the callback, and it's the responsibility of the callback function to do whatever it should do with the data.
Parameters
Returns
See also
Print filter function.
Parameters
Returns
See also
Function prototype used by the cfg_print_ functions. This callback function is used to print option values. For options with a value parsing callback, this is often required, especially if a string is mapped to an integer by the callback. This print callback must then map the integer back to the appropriate string.
Except for functions, the print callback function should only print the value of the option, not the name and the equal sign (that is handled by the cfg_opt_print function). For function options however, the name and the parenthesis must be printed by this function. The value to print can be accessed with the cfg_opt_get functions.
Parameters
See also
Validating callback2 prototype. This callback function is called before an option is set using the cfg_set*() APIs. The function is called only for strings, integers, and floats. Compared to the regular callback function this takes a value pointer argument which must be casted before use, but can also be used to correct a value before it is set, e.g. when a too large value is set this can be used to set the MAX.
Returns
See also
Validating callback prototype. This callback function is called after an option has been parsed and set. The function is called for both fundamental values (strings, integers etc) as well as lists and sections. This can for example be used to validate that all required options in a section has been set to sane values.
Returns
See also
Boolean values.
Fundamental option types.
Enumerator
Add a searchpath directory to the configuration context, the const char* argument will be duplicated and then freed as part of the usual context takedown. All directories added to the context in this manner will be searched for the file specified in cfg_parse(), and for those included. All directories added with this function will be 'tilde expanded'. Note that the current directory is not added to the searchpath by default.
Parameters
Returns
References CFG_SUCCESS, and cfg_t::path.
Add values for a list option. The new values are appended to any current values in the list.
Parameters
Returns
References CFG_SUCCESS, CFGF_LIST, and cfg_opt_t::flags.
Create a new titled config section.
Parameters
Returns
References cfg_t::errfunc, cfg_t::line, cfg_t::path, and cfg_value_t::section.
Show a parser error. Any user-defined error reporting function is called.
See also
References cfg_t::errfunc, cfg_t::filename, and cfg_t::line.
Free a cfg_t context. All memory allocated by the cfg_t context structure are freed, and can't be used in any further cfg_* calls.
Returns
References CFG_SUCCESS, cfg_t::comment, cfg_t::filename, cfg_t::name, cfg_opt_t::name, cfg_t::opts, cfg_t::path, and cfg_t::title.
Free the memory allocated for the values of a given option. Only the values are freed, not the option itself (it is freed by cfg_free()).
See also
Returns
References CFG_SUCCESS, CFGT_PTR, CFGT_SEC, CFGT_STR, cfg_opt_t::comment, cfg_opt_t::flags, cfg_opt_t::nvalues, cfg_t::path, cfg_value_t::ptr, cfg_value_t::section, cfg_value_t::string, cfg_opt_t::type, and cfg_opt_t::values.
Returns the value of a boolean option.
Parameters
Returns
Returns the option comment. This function can be used to extract option annotations from a config file. Only comments preceding the option are read by cfg_parse().
Parameters
See also
Returns
Returns the value of a floating point option.
Parameters
Returns
Returns the value of an integer option. This is the same as calling cfg_getnint with index 0.
Parameters
Returns
Indexed version of cfg_getbool(), used for lists.
Parameters
See also
Indexed version of cfg_getfloat(), used for lists.
Parameters
See also
Indexed version of cfg_getint(), used for lists.
Parameters
See also
Return the nth option in a file or section.
Parameters
See also
References cfg_opt_t::name, and cfg_t::opts.
Indexed version of cfg_getsec(), used for sections with the CFGF_MULTI flag set.
Parameters
See also
Indexed version of cfg_getstr(), used for lists.
Parameters
See also
Return an option given it's name.
Parameters
Returns
Returns the value of a user-defined option (void pointer).
Parameters
Returns
Returns the value of a section option. The returned value is another cfg_t structure that can be used in following calls to cfg_getint, cfg_getstr or other get-functions.
Parameters
Returns
Returns the value of a string option.
Parameters
Returns
Return a section given the title, used for section with the CFGF_TITLE flag set.
Parameters
See also
Predefined include-function. This function can be used in the options passed to cfg_init() to specify a function for including other configuration files in the parsing. For example: CFG_FUNC('include', &cfg_include)
Create and initialize a cfg_t structure. This should be the first function called when setting up the parsing of a configuration file. The options passed in the first parameter is initialized using the CFG_* initializers. The last option in the option array must be CFG_END(), unless you like segmentation faults.
The options must no longer be defined in the same scope as where the cfg_xxx functions are used (since version 2.3).
CFGF_IGNORE_UNKNOWN can be specified to use the '__unknown' option whenever an unknown option is parsed. Be sure to define an '__unknown' option in each scope that unknown parameters are allowed.
Call setlocale() before calling this function to localize handling of types, LC_CTYPE, and messages, LC_MESSAGES, since version 2.9:
setlocale(LC_MESSAGES, '');
setlocale(LC_CTYPE, '');
Parameters
Returns
References cfg_t::errfunc, cfg_t::filename, cfg_t::flags, cfg_t::line, cfg_t::name, and cfg_t::opts.
Return the name of a section.
Parameters
Returns
References cfg_t::name.
Return number of options in a file or section.
Parameters
When a file has been parsed this function returns the number of options/settings the file, or a sub-section, has.
Returns
References cfg_t::opts.
Returns the option comment.
Parameters
See also
References cfg_opt_t::comment.
Returns the value of a boolean option, given a cfg_opt_t pointer.
Parameters
See also
References cfg_value_t::boolean, CFGT_BOOL, cfg_opt_t::simple_value, cfg_opt_t::type, and cfg_opt_t::values.
Returns the value of a floating point option, given a cfg_opt_t pointer.
Parameters
See also
References CFGT_FLOAT, cfg_value_t::fpnumber, cfg_opt_t::simple_value, cfg_opt_t::type, and cfg_opt_t::values.
Returns the value of an integer option, given a cfg_opt_t pointer.
Parameters
See also
References CFGT_INT, cfg_value_t::number, cfg_opt_t::simple_value, cfg_opt_t::type, and cfg_opt_t::values.
Returns the value of a section option, given a cfg_opt_t pointer.
Parameters
See also
References CFGT_SEC, cfg_value_t::section, cfg_opt_t::type, and cfg_opt_t::values.
Returns the value of a string option, given a cfg_opt_t pointer.
Parameters
See also
References CFGT_STR, cfg_opt_t::simple_value, cfg_value_t::string, cfg_opt_t::type, and cfg_opt_t::values.
Return the string value of a key=value pair.
Parameters
See also
Returns
Returns the value of a section option, given a cfg_opt_t pointer and the title.
Parameters
See also
References CFGF_TITLE, and cfg_opt_t::flags.
Return the name of an option.
Parameters
Returns
References cfg_opt_t::name.
Default value print function. Print only the value of a given option. Does not handle sections or functions. Use cfg_opt_print to print the whole assignment ('option = value'), or cfg_print to print the whole config file.
Parameters
See also
Returns
References CFG_SUCCESS, CFGT_BOOL, CFGT_COMMENT, CFGT_FLOAT, CFGT_FUNC, CFGT_INT, CFGT_PTR, CFGT_SEC, CFGT_STR, and cfg_opt_t::type.
Print an option and its value to a file. If a print callback function is specified for the option, it is used instead of cfg_opt_nprint_var.
Parameters
See also
Returns
Print an option and its value to a file. Same as cfg_opt_print, but with the indentation level specified.
See also
Returns
Removes and frees a config section, given a cfg_opt_t pointer.
Parameters
See also
Returns
References CFG_SUCCESS, CFGT_SEC, cfg_opt_t::nvalues, cfg_value_t::section, cfg_opt_t::type, and cfg_opt_t::values.
Removes and frees a config section, given a cfg_opt_t pointer and the title.
Parameters
See also
Returns
References CFGF_NOCASE, CFGF_TITLE, cfg_opt_t::flags, and cfg_t::title.
Set a print callback function for an option.
Parameters
See also
References cfg_opt_t::pf.
Annotate an option.
Parameters
See also
Returns
References CFG_SUCCESS, CFGF_COMMENTS, CFGF_MODIFIED, cfg_opt_t::comment, and cfg_opt_t::flags.
Set an option (create an instance of an option).
Parameters
Returns
References CFG_SUCCESS, CFGF_MODIFIED, cfg_opt_t::flags, cfg_opt_t::nvalues, and cfg_opt_t::values.
Set a value of a boolean option.
Parameters
Returns
References cfg_value_t::boolean, CFG_SUCCESS, CFGF_MODIFIED, CFGT_BOOL, cfg_opt_t::flags, and cfg_opt_t::type.
Set a value of a floating point option.
Parameters
Returns
References CFG_SUCCESS, CFGF_MODIFIED, CFGT_FLOAT, cfg_opt_t::flags, cfg_value_t::fpnumber, and cfg_opt_t::type.
Set a value of an integer option.
Parameters
Returns
References CFG_SUCCESS, CFGF_MODIFIED, CFGT_INT, cfg_opt_t::flags, cfg_value_t::number, and cfg_opt_t::type.
Set a value of a string option.
Parameters
Returns
References CFG_SUCCESS, CFGF_MODIFIED, CFGT_STR, cfg_opt_t::flags, cfg_value_t::string, and cfg_opt_t::type.
Return the number of values this option has. If no default value is given for the option and no value was found in the config file, 0 will be returned (ie, the option value is not set at all).
Parameters
References cfg_opt_t::nvalues.
Parse a configuration file. Tilde expansion is performed on the filename before it is opened. After a configuration file has been initialized (with cfg_init()) and parsed (with cfg_parse()), the values can be read with the cfg_getXXX functions.
Parameters
Returns
References cfg_t::filename, and cfg_t::path.
Parse a boolean option string. Accepted 'true' values are 'true', 'on' and 'yes', and accepted 'false' values are 'false', 'off' and 'no'.
Returns
Same as cfg_parse() above, but takes a character buffer as argument.
Parameters
See also
Returns
References CFG_SUCCESS, and cfg_t::filename.
Same as cfg_parse() above, but takes an already opened file as argument. Reading begins at the current position. After parsing, the position is not reset. The caller is responsible for closing the file.
Parameters
See also
Returns
References CFG_SUCCESS, cfg_t::filename, and cfg_t::line.
Print the options and values to a file. Note that options in any included file are expanded and printed directly to the file. Option values given with environment variables in the parsed input are also printed expanded. This means that if you parse a configuration file you can't expect that the output from this function is identical to the initial file.
Parameters
See also
Returns
Print the options and values to a file. Same as cfg_print, but with the indentation level specified.
See also
Returns
Indexed version of cfg_rmsec(), used for CFGF_MULTI sections.
Parameters
See also
Returns
Removes and frees a config section. This is the same as calling cfg_rmnsec with index 0.
Parameters
Returns
Removes and frees a section given the title, used for section with the CFGF_TITLE flag set.
Parameters
See also
Returns
Search the linked-list of cfg_searchpath_t for the specified file. If not NULL, the return value is freshly allocated and and should be freed by the caller.
Parameters
Returns
Install a user-defined error reporting function.
Returns
References cfg_t::errfunc.
Install a user-defined print filter function. This callback is called for each option when printing cfg, or something above cfg if cfg is a section in some parent cfg. When cfg (or something above cfg) is printed, this filter is also inherited to child sections unless the child section has its own print filter.
Parameters
Returns
See also
References cfg_t::pff.
Set a print callback function for an option given its name.
Parameters
See also
Register a validating callback function for an option.
Parameters
See also
References cfg_t::flags, cfg_t::opts, and cfg_opt_t::validcb.
Register a validating callback function for an option. This callback is called for all cfg_set*() functions, although not cfg_opt_set*(), and can be used to check and modify a value/string *before* it is actually set. The regular callbacks are run after the fact and are only called when parsing a buffer or file.
Parameters
See also
References cfg_t::flags, cfg_t::opts, and cfg_opt_t::validcb2.
Set the value of a boolean option given its name.
Parameters
Returns
Annotate an option given its name. All options can be annotated as long as the CFGF_COMMENTS flag is given to cfg_init().
When calling cfg_print(), annotations are saved as a C style one-liner comment before each option.
When calling cfg_parse(), only one-liner comments preceding an option are read and used to annotate the option.
Parameters
Returns
Set the value of a floating point option given its name.
Parameters
Returns
Set the value of an integer option given its name.
Parameters
Returns
Set values for a list option. All existing values are replaced with the new ones.
Parameters
Returns
References CFG_SUCCESS, CFGF_LIST, and cfg_opt_t::flags.
Set an option (create an instance of an option).
Parameters
Returns
Set a value of a boolean option given its name and index.
Parameters
Returns
Set a value of a floating point option given its name and index.
Parameters
Returns
References cfg_opt_t::validcb2.
Set a value of an integer option given its name and index.
Parameters
Returns
References cfg_opt_t::validcb2.
Set a value of a boolean option given its name and index.
Parameters
Returns
References cfg_opt_t::validcb2.
Set an option (create an instance of an option).
Parameters
Returns
References cfg_value_t::boolean, CFGF_KEYSTRVAL, CFGF_LIST, CFGF_MODIFIED, CFGF_MULTI, CFGF_NO_TITLE_DUPES, CFGF_NOCASE, CFGF_TITLE, CFGT_BOOL, CFGT_FLOAT, CFGT_INT, CFGT_PTR, CFGT_SEC, CFGT_STR, cfg_t::errfunc, cfg_t::filename, cfg_t::flags, cfg_opt_t::flags, cfg_value_t::fpnumber, cfg_t::line, cfg_t::name, cfg_opt_t::name, cfg_value_t::number, cfg_opt_t::nvalues, cfg_t::opts, cfg_opt_t::parsecb, cfg_t::path, cfg_value_t::ptr, cfg_value_t::section, cfg_opt_t::simple_value, cfg_value_t::string, cfg_opt_t::subopts, cfg_t::title, cfg_opt_t::type, and cfg_opt_t::values.
Set the value of a string option given its name.
Parameters
Returns
Return the number of values this option has. If no default value is given for the option and no value was found in the config file, 0 will be returned (ie, the option value is not set at all).
Note that there is no way to *not* specify a default value for integers, floats and booleans. Ie, they always have default values (since 0 or NULL is a valid integer/float/boolean value). Only strings and lists may have no default value.
Parameters
Does tilde expansion (~ -> $HOME) on the filename.
Returns
Return the title of a section.
Parameters
Returns
References cfg_t::title.
Generated automatically by Doxygen for confuse from the source code.
| Version 3.3 | confuse |