libconfini
Yet another INI parser
|
Go to the documentation of this file.
16 #ifndef _LIBCONFINI_HEADER_
17 #define _LIBCONFINI_HEADER_
36 #define _LIBCONFINI_INIFORMAT_DESCR_(NAME, OFFSET, SIZE, DEFVAL) \
37 unsigned char NAME:SIZE;
38 #define _LIBCONFINI_DEFAULT_FMT_DESCR_(NAME, OFFSET, SIZE, DEFVAL) DEFVAL,
39 #define _LIBCONFINI_UNIXLIKE_FMT_DESCR_(NAME, OFFSET, SIZE, DEFVAL) 0,
40 #define _LIBCONFINI_INIFORMAT_TYPE_ \
41 struct IniFormat { INIFORMAT_TABLE_AS(_LIBCONFINI_INIFORMAT_DESCR_) }
42 #define _LIBCONFINI_DEFAULT_FORMAT_ \
43 { INIFORMAT_TABLE_AS(_LIBCONFINI_DEFAULT_FMT_DESCR_) }
44 #define _LIBCONFINI_UNIXLIKE_FORMAT_ \
45 { INIFORMAT_TABLE_AS(_LIBCONFINI_UNIXLIKE_FMT_DESCR_) }
60 #define INIFORMAT_TABLE_AS(_____)
64 _____( delimiter_symbol, 0, 7, INI_EQUALS ) \
65 _____( case_sensitive, 7, 1, 0 )
67 _____( semicolon_marker, 8, 2, INI_DISABLED_OR_COMMENT ) \
68 _____( hash_marker, 10, 2, INI_DISABLED_OR_COMMENT ) \
69 _____( section_paths, 12, 2, INI_ABSOLUTE_AND_RELATIVE ) \
70 _____( multiline_nodes, 14, 2, INI_MULTILINE_EVERYWHERE )
72 _____( no_single_quotes, 16, 1, 0 ) \
73 _____( no_double_quotes, 17, 1, 0 ) \
74 _____( no_spaces_in_names, 18, 1, 0 ) \
75 _____( implicit_is_not_empty, 19, 1, 0 ) \
76 _____( do_not_collapse_values, 20, 1, 0 ) \
77 _____( preserve_empty_quotes, 21, 1, 0 ) \
78 _____( disabled_after_space, 22, 1, 0 ) \
79 _____( disabled_can_be_implicit, 23, 1, 0 )
86 #define INIFORMAT_HAS_NO_ESC(FORMAT) \
87 (FORMAT.multiline_nodes == INI_NO_MULTILINE && \
88 FORMAT.no_double_quotes && FORMAT.no_single_quotes)
99 typedef _LIBCONFINI_INIFORMAT_TYPE_
IniFormat;
158 size_t string_length,
169 const char * ini_string,
183 register char *
const ini_source,
184 const size_t ini_length,
188 void *
const user_data
193 FILE *
const ini_file,
197 void *
const user_data
202 const char *
const path,
206 void *
const user_data
211 const char *
const simple_string_a,
212 const char *
const simple_string_b,
218 const char *
const simple_string,
219 const char *
const ini_string,
225 const char *
const ini_string_a,
226 const char *
const ini_string_b,
232 const char *
const ini_string_a,
233 const char *
const ini_string_b,
234 const char delimiter,
240 char *
const ini_string,
246 char *
const ini_string,
252 const char *
const ini_string,
253 const char delimiter,
259 const char *
const ini_string,
260 const char delimiter,
263 void *
const user_data
268 const char **
const ini_strptr,
269 const char delimiter,
275 char *
const ini_string,
276 const char delimiter,
282 char *
const ini_string,
283 const char delimiter,
289 char **
const ini_strptr,
290 const char delimiter,
296 char *
const ini_string,
297 const char delimiter,
300 void *
const user_data
310 char *
const implicit_value,
311 const size_t implicit_v_len
326 const char *
const ini_string,
327 const int return_value
336 const char * ini_string
341 const char * ini_string
346 const char * ini_string
351 const char * ini_string
359 #define ini_get_float \
360 _Pragma("GCC warning \"function `ini_get_float()` is deprecated for parsing a `double` data type; use `ini_get_double()` instead\"") \
371 #define CONFINI_ERROR 252
487 static const IniFormat INI_DEFAULT_FORMAT = {
INI_EQUALS , 0 ,
INI_DISABLED_OR_COMMENT ,
INI_DISABLED_OR_COMMENT ,
INI_ABSOLUTE_AND_RELATIVE ,
INI_MULTILINE_EVERYWHERE , 0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 , };
495 static const IniFormat INI_UNIXLIKE_FORMAT = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, };
524 #undef _LIBCONFINI_UNIXLIKE_FORMAT_
525 #undef _LIBCONFINI_DEFAULT_FORMAT_
526 #undef _LIBCONFINI_INIFORMAT_TYPE_
527 #undef _LIBCONFINI_UNIXLIKE_FMT_DESCR_
528 #undef _LIBCONFINI_DEFAULT_FMT_DESCR_
529 #undef _LIBCONFINI_INIFORMAT_DESCR_
@ INI_NO_SECTIONS
Definition: confini.h:455
int ini_array_split(char *const ini_string, const char delimiter, const IniFormat format, const IniStrHandler f_foreach, void *const user_data)
Splits a stringified INI array into NUL-separated members and calls a custom function for each member...
Definition: confini.c:4608
@ INI_DOT
Definition: confini.h:421
@ INI_MULTILINE_EVERYWHERE
Definition: confini.h:465
bool ini_string_match_ss(const char *const simple_string_a, const char *const simple_string_b, const IniFormat format)
Compares two simple strings and checks if they match.
Definition: confini.c:2932
@ INI_UNKNOWN
Definition: confini.h:394
@ INI_BUT_DISABLED_AND_COMMENTS
Definition: confini.h:471
long int(*const ini_get_lint)(const char *ini_string)
Pointer to atol()
Definition: confini.c:4886
@ CONFINI_EOOR
Definition: confini.h:382
@ INI_DISABLED_SECTION
Definition: confini.h:406
const IniFormat format
Definition: confini.h:111
uint32_t IniFormatNum
The unique ID of an INI format (24-bit maximum)
Definition: confini.h:126
size_t v_len
Definition: confini.h:117
char * data
Definition: confini.h:113
@ INI_COMMA
Definition: confini.h:422
ConfiniInterruptNo
Error codes.
Definition: confini.h:372
size_t ini_unquote(char *const ini_string, const IniFormat format)
Unescapes \', \", and \\ and removes all unescaped quotes (if single/double quotes are considered met...
Definition: confini.c:3623
bool ini_string_match_ii(const char *const ini_string_a, const char *const ini_string_b, const IniFormat format)
Compares two INI strings and checks if they match.
Definition: confini.c:3198
int(* IniSubstrHandler)(const char *ini_string, size_t fragm_offset, size_t fragm_length, size_t fragm_num, IniFormat format, void *user_data)
Callback function for handling a selected fragment of an INI string.
Definition: confini.h:163
@ INI_ABSOLUTE_AND_RELATIVE
Definition: confini.h:446
@ INI_ANY_SPACE
Definition: confini.h:416
char * ini_array_break(char *const ini_string, const char delimiter, const IniFormat format)
Replaces the first delimiter found (together with the spaces that surround it) with \0
Definition: confini.c:4465
IniFormatNum ini_fton(const IniFormat format)
Calculates the IniFormatNum of an IniFormat.
Definition: confini.c:4767
@ CONFINI_ENOENT
Definition: confini.h:379
Global statistics about an INI file.
Definition: confini.h:100
@ CONFINI_FEINTR
Definition: confini.h:377
size_t ini_array_shift(const char **const ini_strptr, const char delimiter, const IniFormat format)
Shifts the location pointed by ini_strptr to the next member of the INI array (without modifying the ...
Definition: confini.c:4178
@ CONFINI_EIO
Definition: confini.h:381
@ CONFINI_EBADF
Definition: confini.h:384
IniDelimiters
Most used array and key-value delimiters (but a delimiter may also be any other ASCII character not p...
Definition: confini.h:415
@ CONFINI_ENOMEM
Definition: confini.h:380
long long int(*const ini_get_llint)(const char *ini_string)
Pointer to atoll()
Definition: confini.c:4888
struct IniDispatch IniDispatch
Dispatch of a single INI node.
@ INI_ABSOLUTE_ONLY
Definition: confini.h:449
@ INI_BUT_COMMENTS
Definition: confini.h:468
void ini_global_set_lowercase_mode(const bool lowercase)
Sets the value of the global variable INI_GLOBAL_LOWERCASE_MODE.
Definition: confini.c:4726
int load_ini_file(FILE *const ini_file, const IniFormat format, const IniStatsHandler f_init, const IniDispHandler f_foreach, void *const user_data)
Parses an INI file and dispatches its content using a FILE structure as argument.
Definition: confini.c:2771
size_t ini_array_collapse(char *const ini_string, const char delimiter, const IniFormat format)
Compresses the distribution of the data in a stringified INI array by removing all the white spaces t...
Definition: confini.c:4268
int ini_get_bool(const char *const ini_string, const int return_value)
Checks whether a string matches one of the booleans listed in the private constant INI_BOOLEANS (case...
Definition: confini.c:4833
Dispatch of a single INI node.
Definition: confini.h:110
const size_t members
Definition: confini.h:103
@ INI_IGNORE
Definition: confini.h:435
@ INI_SECTION
Definition: confini.h:401
size_t dispatch_id
Definition: confini.h:119
size_t INI_GLOBAL_IMPLICIT_V_LEN
Length of the value assigned to implicit keys – this may be any unsigned number, independently of the...
Definition: confini.c:4907
int strip_ini_cache(register char *const ini_source, const size_t ini_length, const IniFormat format, const IniStatsHandler f_init, const IniDispHandler f_foreach, void *const user_data)
Parses and tokenizes a buffer containing an INI file, then dispatches its content to a custom callbac...
Definition: confini.c:2271
size_t ini_string_parse(char *const ini_string, const IniFormat format)
Unescapes \', \", and \\ and removes all unescaped quotes (if single/double quotes are considered met...
Definition: confini.c:3751
double(*const ini_get_double)(const char *ini_string)
Pointer to atof()
Definition: confini.c:4890
int(*const ini_get_int)(const char *ini_string)
Pointer to atoi()
Definition: confini.c:4884
@ INI_ONE_LEVEL_ONLY
Definition: confini.h:452
const IniFormat format
Definition: confini.h:101
char * value
Definition: confini.h:114
@ CONFINI_EFBIG
Definition: confini.h:386
@ CONFINI_SUCCESS
Definition: confini.h:373
@ INI_INLINE_COMMENT
Definition: confini.h:404
@ INI_DISABLED_OR_COMMENT
Definition: confini.h:432
size_t ini_array_get_length(const char *const ini_string, const char delimiter, const IniFormat format)
Gets the length of a stringified INI array in number of members.
Definition: confini.c:3937
bool ini_array_match(const char *const ini_string_a, const char *const ini_string_b, const char delimiter, const IniFormat format)
Compares two INI arrays and checks if they match.
Definition: confini.c:3392
bool ini_string_match_si(const char *const simple_string, const char *const ini_string, const IniFormat format)
Compares a simple string and an INI string and and checks if they match.
Definition: confini.c:3030
struct IniStatistics IniStatistics
Global statistics about an INI file.
const char * append_to
Definition: confini.h:115
@ INI_IS_NOT_A_MARKER
Definition: confini.h:437
@ INI_NO_MULTILINE
Definition: confini.h:474
int(* IniDispHandler)(IniDispatch *dispatch, void *user_data)
Callback function for handling an IniDispatch structure.
Definition: confini.h:141
IniSectionPaths
Possible values of IniFormat::section_paths.
Definition: confini.h:445
@ INI_ONLY_COMMENT
Definition: confini.h:434
static const IniFormat INI_UNIXLIKE_FORMAT
A model format for Unix-like .conf files (where space characters are delimiters between keys and valu...
Definition: confini.h:490
IniNodeType
INI node types.
Definition: confini.h:393
bool INI_GLOBAL_LOWERCASE_MODE
If set to true, key and section names in case-insensitive INI formats will be dispatched lowercase,...
Definition: confini.c:4903
@ INI_KEY
Definition: confini.h:400
@ INI_COMMENT
Definition: confini.h:403
int(* IniStrHandler)(char *ini_string, size_t string_length, size_t string_num, IniFormat format, void *user_data)
Callback function for handling an INI string belonging to a sequence of INI strings.
Definition: confini.h:151
IniMultiline
Possible values of IniFormat::multiline_nodes.
Definition: confini.h:464
IniFormat ini_ntof(const IniFormatNum format_id)
Constructs a new IniFormat according to an IniFormatNum.
Definition: confini.c:4788
const size_t bytes
Definition: confini.h:102
@ CONFINI_IINTR
Definition: confini.h:375
uint8_t type
Definition: confini.h:112
@ INI_COLON
Definition: confini.h:420
@ INI_DISABLED_KEY
Definition: confini.h:405
char * INI_GLOBAL_IMPLICIT_VALUE
Value to be assigned to implicit keys (default value: NULL)
Definition: confini.c:4905
@ INI_EQUALS
Definition: confini.h:419
size_t at_len
Definition: confini.h:118
size_t d_len
Definition: confini.h:116
int load_ini_path(const char *const path, const IniFormat format, const IniStatsHandler f_init, const IniDispHandler f_foreach, void *const user_data)
Parses an INI file and dispatches its content using a path as argument.
Definition: confini.c:2855
void ini_global_set_implicit_value(char *const implicit_value, const size_t implicit_v_len)
Sets the value to be to be assigned to implicit keys.
Definition: confini.c:4751
static const IniFormat INI_DEFAULT_FORMAT
A model format for standard INI files.
Definition: confini.h:482
int ini_array_foreach(const char *const ini_string, const char delimiter, const IniFormat format, const IniSubstrHandler f_foreach, void *const user_data)
Calls a custom function for each member of a stringified INI array, without modifying the content of ...
Definition: confini.c:4053
char * ini_array_release(char **const ini_strptr, const char delimiter, const IniFormat format)
Replaces the first delimiter found (together with the spaces that surround it) with \0,...
Definition: confini.c:4541
int(* IniStatsHandler)(IniStatistics *statistics, void *user_data)
Callback function for handling an IniStatistics structure.
Definition: confini.h:132
@ INI_VALUE
Definition: confini.h:396
IniCommentMarker
Possible values of IniFormat::semicolon_marker and IniFormat::hash_marker (i.e., meaning of /\s+;/ an...
Definition: confini.h:431