libconfini: confini.c File Reference (original) (raw)

libconfini functions More...

#include <stdlib.h>
#include "[confini.h](confini%5F8h%5Fsource.html)"

libconfini functions

Copyright

GNU General Public License, version 3 or any later version

Version

1.16.4

Date

2016-2022

See also

https://madmurphy.github.io/libconfini

◆ CONFINI_IO_FLAVOR

#define CONFINI_IO_FLAVOR CONFINI_STANDARD

The I/O API to use (possibly overridden via -DCONFINI_IO_FLAVOR=[FLAVOR])

Possible values are CONFINI_STANDARD and CONFINI_POSIX

◆ collapse_empty_quotes()

Similar to ECMAScript str.replace(/''|""/g, "")

Parameters

Returns

The new length of the string

◆ collapse_everything()

Out of quotes similar to ECMAScript ini_string.replace(/''|""/g, "").replace(/^[\n\r]\s*|\s+/g, " ")

Parameters

Returns

The new length of the string

◆ collapse_spaces()

Out of quotes similar to ECMAScript ini_string.replace(/\s+/g, " ")

Parameters

Returns

The new length of the string

◆ dqultrim_s()

Soft left trim within an unparsed disabled entry (left trim of /(?:(?:^|\\?[\n\r])[ \t\v\f]*(?:#(?:[ \t\v\f]|''|"")*)?)+/) – does not change the buffer.

Parameters

Returns

The offset of the first non-trivial character

◆ further_cuts()

Examine a (single-/multi-line) segment and check whether it contains more than just one node.

Parameters

Returns

Number of entries found

◆ get_metachar_pos()

Get the position of the first occurrence out of quotes of a given character.

Parameters

Returns

The offset of the first occurrence of chr or the length of str if chr has not been not found

◆ get_type_as_active()

Try to determine the type of a member assuming it is active

Parameters

Returns

The active node type (see confini.h)

◆ getn_metachar_pos()

Get the position of the first occurrence out of quotes of a given character, stopping after a given number of charcters.

Parameters

Returns

The offset of the first occurrence of chr, or len if chr has not been not found

◆ ini_array_break()

Replace the first delimiter found (together with the spaces that surround it) with \0

Parameters

Returns

A pointer to the remaining INI array or NULL if the remaining array is empty

Usually ini_string comes from an IniDispatch (but any other string may be used as well).

Similarly to strtok_r() this function can be used only once for a given string.

Note

If ini_string comes from INI_GLOBAL_IMPLICIT_VALUE this function is no-op and will return NULL.

If delimiter matches a metacharacter within the format given ('\\', '\'' or '\"'), its role as metacharacter will have higher priority than its role as delimiter (i.e., the array will have no delimiters and will contain only one member).

#include <stdio.h>

static int my_ini_listener (

void * const v_null

) {

if (

"my_array",

)

) {

#define DELIMITER ','

char * part_a, * part_b = dispatch->value;

while ((part_a = part_b)) {

printf("%s\n", part_a);

}

#undef DELIMITER

}

return 0;

}

int main () {

if (

"../ini_files/typed_ini.conf",

NULL,

my_ini_listener,

NULL

)

) {

fprintf(stderr, "Sorry, something went wrong :-(\n");

return 1;

}

return 0;

}

int load_ini_path(const char *const path, const IniFormat format, const IniStatsHandler f_init, const IniDispHandler f_foreach, void *const user_data)

Parse an INI file and dispatch its content to a custom callback using a path as argument.

Definition: confini.c:3274

bool ini_string_match_si(const char *const simple_string, const char *const ini_string, const IniFormat format)

Compare a simple string and an INI string and and check whether they match.

Definition: confini.c:3470

char * ini_array_break(char *const ini_string, const char delimiter, const IniFormat format)

Replace the first delimiter found (together with the spaces that surround it) with \0

Definition: confini.c:5067

static const IniFormat INI_DEFAULT_FORMAT

A model format for standard INI files.

Definition: confini.h:524

size_t ini_string_parse(char *const ini_string, const IniFormat format)

Unescape \', \", and \\ and remove all unescaped quotes (when single/double quotes are considered met...

Definition: confini.c:4256

Dispatch of a single INI node.

Definition: confini.h:131

char * data

Definition: confini.h:134

char * value

Definition: confini.h:135

const IniFormat format

Definition: confini.h:132

◆ ini_array_collapse()

Compress the distribution of the data in a stringified INI array by removing all the white spaces that surround its delimiters, empty quotes, collapsable spaces, etc.

Parameters

Returns

The new length of the stringified array

Out of quotes similar to ECMAScript ini_string.replace(new RegExp("^\\s+|\\s*(?:(" + delimiter + ")\\s*|($))", "g"), "$1$2"). If INI_ANY_SPACE (0) is used as delimiter, one or more different spaces (/[\t \v\f\n\r]+/) will be always collapsed to one space, independently of what the format says.

Usually ini_string comes from an IniDispatch (but any other string may be used as well).

This function can be useful before invoking memcpy() using ini_string as source, when saving memory is a priority.

The format argument is used for the following fields:

• format.no_single_quotes
• format.no_double_quotes
• format.do_not_collapse_values
• format.preserve_empty_quotes

Examples:

1. Using comma as delimiter:
   • Before: first , second , third , etc.
   • After: first,second,third,etc.
2. Using INI_ANY_SPACE as delimiter:
   • Before: first second third etc.
   • After: first second third etc.

Note

If ini_string comes from INI_GLOBAL_IMPLICIT_VALUE this function is no-op and will only return the value of INI_GLOBAL_IMPLICIT_V_LEN minus the offset of ini_string within INI_GLOBAL_IMPLICIT_VALUE.

If delimiter matches a metacharacter within the format given ('\\', '\'' or '\"'), its role as metacharacter will have higher priority than its role as delimiter (i.e., the array will have no delimiters and will contain only one member).

#include <stdio.h>

#include <stdlib.h>

#include <string.h>

static int populate_strarray (

char * const part,

const size_t part_len,

const size_t idx,

void * const v_array

) {

((char **) v_array)[idx] = part;

return 0;

}

static int my_ini_listener (

void * const v_null

) {

if (

"my_array",

)

) {

#define DELIMITER ','

char ** my_array;

size_t my_array_length;

DELIMITER,

);

DELIMITER,

);

my_array = (char **) malloc(my_array_length * sizeof(char *) +

dispatch->v_len + 1);

memcpy(

my_array + my_array_length,

);

(char *) (my_array + my_array_length),

DELIMITER,

populate_strarray,

my_array

);

#undef DELIMITER

printf("Array `my_array` has been created.\n\n");

for (size_t idx = 0; idx < my_array_length; idx++) {

printf("my_array[%zu] -> %s\n", idx, my_array[idx]);

}

}

return 0;

}

int main () {

if (

"../ini_files/typed_ini.conf",

NULL,

my_ini_listener,

NULL

)

) {

fprintf(stderr, "Sorry, something went wrong :-(\n");

return 1;

}

return 0;

}

int ini_array_split(char *const ini_string, const char delimiter, const IniFormat format, const IniStrHandler f_foreach, void *const user_data)

Split a stringified INI array into NUL-separated members and call a custom function for each member.

Definition: confini.c:5226

size_t ini_array_get_length(const char *const ini_string, const char delimiter, const IniFormat format)

Get the length of a stringified INI array in number of members.

Definition: confini.c:4472

size_t ini_array_collapse(char *const ini_string, const char delimiter, const IniFormat format)

Compress the distribution of the data in a stringified INI array by removing all the white spaces tha...

Definition: confini.c:4838

size_t v_len

Definition: confini.h:138

24-bit bitfield representing the format of an INI file (INI dialect)

Definition: confini.h:115

Note

The actual space occupied by the array might get reduced further after each member is parsed by ini_string_parse().

◆ ini_array_foreach()

Call a custom function for each member of a stringified INI array, without modifying the content of the buffer – useful for read-only (const) stringified arrays.

Parameters

Returns

Zero for success, otherwise an error code (see enum ConfiniInterruptNo)

Usually ini_string comes from an IniDispatch (but any other string may be used as well).

The user given function f_foreach (see IniSubstrHandler data type) will be invoked with six arguments: ini_string, memb_offset (the offset of the member in bytes), memb_length (the length of the member in bytes), memb_num (the offset of the member in number of members), format (the format of the INI file), user_data (the custom argument user_data previously passed). If f_foreach returns a non-zero value the function ini_array_foreach() will be interrupted.

Note

If delimiter matches a metacharacter within the format given ('\\', '\'' or '\"'), its role as metacharacter will have higher priority than its role as delimiter (i.e., the array will have no delimiters and will contain only one member).

Possible return values are: CONFINI_SUCCESS, CONFINI_FEINTR.

#include <stdio.h>

static int my_array_fragm_handler (

const char * const ini_array,

const size_t fragm_offset,

const size_t fragm_length,

const size_t fragm_num,

void * const user_data

) {

printf("\"%.*s\"\n", (unsigned int) fragm_length, ini_array + fragm_offset);

return 0;

}

int main () {

"first , second , third",

',',

my_array_fragm_handler,

NULL

);

return 0;

}

int ini_array_foreach(const char *const ini_string, const char delimiter, const IniFormat format, const IniSubstrHandler f_foreach, void *const user_data)

Call a custom function for each member of a stringified INI array, without modifying the content of t...

Definition: confini.c:4593

◆ ini_array_get_length()

Get the length of a stringified INI array in number of members.

Parameters

Returns

The length of the INI array in number of members

Usually ini_string comes from an IniDispatch (but any other string may be used as well).

Note

If delimiter matches a metacharacter within the format given ('\\', '\'' or '\"'), its role as metacharacter will have higher priority than its role as delimiter (i.e., the array will have no delimiters and will contain only one member).

◆ ini_array_match()

Compare two INI arrays and check whether they match.

Parameters

Returns

A boolean: true if the two arrays match, false otherwise

This function grants that the result of the comparison between two INI arrays will always match the the literal comparison between the individual members of both arrays after these have been parsed, one by one, by ini_string_parse() (with format.do_not_collapse_values set to false).

This function can be used, with '.' as delimiter, to compare section paths.

INI strings are the strings typically dispatched by load_ini_file(), load_ini_path() or strip_ini_cache(), which may contain quotes and the three escape sequences \\, \' and \".

In order to be suitable for both names and values, this function always considers sequences of one or more spaces out of quotes in both strings as collapsed, even when format.do_not_collapse_values is set to true.

The format argument is used for the following fields:

• format.case_sensitive
• format.no_double_quotes
• format.no_single_quotes
• format.multiline_nodes ([INIFORMAT_HAS_NO_ESC()](confini%5F8h.html#ae74cb0104512ee3dfe2865abe689e3f5 "Check whether a format does not support escape sequences."))

◆ ini_array_release()

Replace the first delimiter found (together with the spaces that surround it) with \0, then shifts the location pointed by ini_strptr to the next member of the INI array, or to NULL if the INI array has no more members.

Parameters

Returns

The array member that has been released

Usually ini_strptr comes from an IniDispatch (but any other string may be used as well).

Similarly to strtok_r() this function can be used only once for a given string.

Note

If ini_string comes from INI_GLOBAL_IMPLICIT_VALUE this function is no-op and will set ini_strptr to NULL.

If delimiter matches a metacharacter within the format given ('\\', '\'' or '\"'), its role as metacharacter will have higher priority than its role as delimiter (i.e., the array will have no delimiters and will contain only one member).

#include <stdio.h>

static int my_ini_listener (

void * const v_null

) {

if (

"my_array",

)

) {

#define DELIMITER ','

char * token, * remaining = dispatch->value;

while ((

)) {

printf("%s\n", token);

}

#undef DELIMITER

}

return 0;

}

int main () {

if (

"../ini_files/typed_ini.conf",

NULL,

my_ini_listener,

NULL

)

) {

fprintf(stderr, "Sorry, something went wrong :-(\n");

return 1;

}

return 0;

}

char * ini_array_release(char **const ini_strptr, const char delimiter, const IniFormat format)

Replace the first delimiter found (together with the spaces that surround it) with \0,...

Definition: confini.c:5146

◆ ini_array_shift()

Shift the location pointed by ini_strptr to the next member of the INI array (without modifying the content of the buffer), or to NULL if the INI array has no more members – useful for read-only (const) stringified arrays.

Parameters

Returns

The length of the array member that has been left behind

Usually ini_strptr comes from an IniDispatch (but any other string may be used as well).

Note

If delimiter matches a metacharacter within the format given ('\\', '\'' or '\"'), its role as metacharacter will have higher priority than its role as delimiter (i.e., the array will have no delimiters and will contain only one member).

#include <stdio.h>

static int my_ini_listener (

void * const v_null

) {

if (

"my_array",

)

) {

#define DELIMITER ','

size_t length;

char * left_behind, * shifted = dispatch->value;

while ((left_behind = shifted)) {

(const char **) &shifted,

DELIMITER,

);

printf("%.*s\n", (unsigned int) length, left_behind);

}

#undef DELIMITER

}

return 0;

}

int main () {

if (

"../ini_files/typed_ini.conf",

NULL,

my_ini_listener,

NULL

)

) {

fprintf(stderr, "Sorry, something went wrong :-(\n");

return 1;

}

return 0;

}

size_t ini_array_shift(const char **const ini_strptr, const char delimiter, const IniFormat format)

Shift the location pointed by ini_strptr to the next member of the INI array (without modifying the c...

Definition: confini.c:4740

◆ ini_array_split()

Split a stringified INI array into NUL-separated members and call a custom function for each member.

Parameters

Returns

Zero for success, otherwise an error code (see enum ConfiniInterruptNo)

Usually ini_string comes from an IniDispatch (but any other string may be used as well).

The user given function f_foreach (see IniStrHandler data type) will be invoked with five arguments: member (the member of the array), memb_length (the length of the member in bytes), memb_num (the offset of the member in number of members), format (the format of the INI file), user_data (the custom argument user_data previously passed). If f_foreach returns a non-zero value the function ini_array_split() will be interrupted.

Similarly to strtok_r() this function can be used only once for a given string.

Note

If ini_string comes from INI_GLOBAL_IMPLICIT_VALUE or is NULL this function is no-op and will return an error code.

If delimiter matches a metacharacter within the format given ('\\', '\'' or '\"'), its role as metacharacter will have higher priority than its role as delimiter (i.e., the array will have no delimiters and will contain only one member).

Possible return values are: CONFINI_SUCCESS, CONFINI_EROADDR, CONFINI_FEINTR.

#include <stdio.h>

static int my_array_memb_handler (

char * const arr_member,

const size_t memb_length,

const size_t memb_num,

void * const foreach_other

) {

printf("\"%s\"\n", arr_member);

return 0;

}

int main () {

char my_ini_array[] = "first . second . third";

my_ini_array,

'.',

my_array_memb_handler,

NULL

);

return 0;

}

◆ ini_fton()

Calculate the IniFormatNum of an IniFormat.

Parameters

Returns

The unique unsigned integer that identifies the format given

◆ ini_get_bool()

Check whether a simple string matches one of the booleans listed in the private constant INI_BOOLEANS (case-insensitive)

Parameters

Returns

The matching boolean (0 or 1) or when_fail if simple_string does not contain a valid INI boolean

#include <stdio.h>

#include <stdlib.h>

#include <string.h>

#include "../utilities/make_strarray.h"

#define MY_ARRAY_DELIMITER ','

struct ini_store {

char * my_section_my_string;

int my_section_my_number;

bool my_section_my_boolean;

bool my_section_my_implicit_bool;

char * const * my_section_my_array;

size_t my_section_my_arr_len;

};

static int my_init (IniStatistics * statistics, void * v_store) {

*((struct ini_store *) v_store) = (struct ini_store) {

.my_section_my_string = NULL,

.my_section_my_number = -1,

.my_section_my_boolean = false,

.my_section_my_implicit_bool = false,

.my_section_my_array = NULL,

.my_section_my_arr_len = 0

};

return 0;

}

static int my_handler (IniDispatch * const dsp, void * const v_store) {

#define store ((struct ini_store *) v_store)

#define THEYMATCH(SSTR, ISTR) \

ini_string_match_si(SSTR, ISTR, dsp->format)

if (THEYMATCH("my_string", dsp->data)) {

free(store->my_section_my_string);

store->my_section_my_string = strndup(dsp->value, dsp->v_len);

if (!store->my_section_my_string) {

return 1;

}

} else if (THEYMATCH("my_number", dsp->data)) {

} else if (THEYMATCH("my_boolean", dsp->data)) {

0,

);

} else if (THEYMATCH("my_implicit_boolean", dsp->data)) {

1,

);

} else if (THEYMATCH("my_array", dsp->data)) {

MY_ARRAY_DELIMITER,

);

free((void *) store->my_section_my_array);

store->my_section_my_array = make_strarray(

&store->my_section_my_arr_len,

MY_ARRAY_DELIMITER,

);

if (!store->my_section_my_array) {

return 1;

}

}

}

return 0;

#undef THEYMATCH

#undef store

}

static void print_stored_data (const struct ini_store * const store) {

printf(

"my_string -> %s\n"

"my_number -> %d\n"

"my_boolean -> %s\n"

"my_implicit_boolean -> %s\n"

"my_array[%zu] -> [%s",

store->my_section_my_string,

store->my_section_my_number,

store->my_section_my_boolean ? "True (`1`)" : "False (`0`)",

store->my_section_my_implicit_bool ? "True (`1`)" : "False (`0`)",

store->my_section_my_arr_len,

store->my_section_my_arr_len ? store->my_section_my_array[0] : ""

);

for (size_t idx = 1; idx < store->my_section_my_arr_len; idx++) {

printf("|%s", store->my_section_my_array[idx]);

}

printf("]\n");

}

int main () {

struct ini_store my_store;

"../ini_files/typed_ini.conf",

my_format,

my_init,

my_handler,

&my_store

)) {

fprintf(stderr, "Sorry, something went wrong :-(\n");

return 1;

}

print_stored_data(&my_store);

free(my_store.my_section_my_string);

free((void *) my_store.my_section_my_array);

return 0;

}

void ini_global_set_implicit_value(char *const implicit_value, const size_t implicit_v_len)

Set the value to be to be assigned to implicit keys.

Definition: confini.c:5395

@ INI_KEY

Definition: confini.h:442

int ini_get_bool_i(const char *const ini_string, const int when_fail, const IniFormat format)

Check whether an INI string matches one of the booleans listed in the private constant INI_BOOLEANS (...

Definition: confini.c:5550

@ INI_IGNORE

Definition: confini.h:476

int(*const ini_get_int)(const char *ini_string)

Pointer to atoi()

Definition: confini.c:5733

uint_least8_t type

Definition: confini.h:133

const char * append_to

Definition: confini.h:136

unsigned char hash_marker

Definition: confini.h:115

unsigned char semicolon_marker

Definition: confini.h:115

unsigned char disabled_can_be_implicit

Definition: confini.h:115

unsigned char implicit_is_not_empty

Definition: confini.h:115

Global statistics about an INI file.

Definition: confini.h:121

◆ ini_get_bool_i()

Check whether an INI string matches one of the booleans listed in the private constant INI_BOOLEANS (case-insensitive)

Parameters

Returns

The matching boolean (0 or 1) or when_fail if ini_string does not contain a valid INI boolean

Usually ini_string comes from an IniDispatch (but any other string may be used as well).

The format argument is used for the following fields:

• format.no_double_quotes
• format.no_single_quotes

#include <stdio.h>

#include <stdlib.h>

#include <string.h>

#include "../utilities/make_strarray.h"

#define MY_ARRAY_DELIMITER ','

struct ini_store {

char * my_section_my_string;

int my_section_my_number;

bool my_section_my_boolean;

bool my_section_my_implicit_bool;

char * const * my_section_my_array;

size_t my_section_my_arr_len;

};

static int my_init (IniStatistics * statistics, void * v_store) {

*((struct ini_store *) v_store) = (struct ini_store) {

.my_section_my_string = NULL,

.my_section_my_number = -1,

.my_section_my_boolean = false,

.my_section_my_implicit_bool = false,

.my_section_my_array = NULL,

.my_section_my_arr_len = 0

};

return 0;

}

static int my_handler (IniDispatch * const dsp, void * const v_store) {

#define store ((struct ini_store *) v_store)

#define THEYMATCH(SSTR, ISTR) \

ini_string_match_si(SSTR, ISTR, dsp->format)

if (THEYMATCH("my_string", dsp->data)) {

free(store->my_section_my_string);

store->my_section_my_string = strndup(dsp->value, dsp->v_len);

if (!store->my_section_my_string) {

return 1;

}

} else if (THEYMATCH("my_number", dsp->data)) {

} else if (THEYMATCH("my_boolean", dsp->data)) {

0,

);

} else if (THEYMATCH("my_implicit_boolean", dsp->data)) {

1,

);

} else if (THEYMATCH("my_array", dsp->data)) {

MY_ARRAY_DELIMITER,

);

free((void *) store->my_section_my_array);

store->my_section_my_array = make_strarray(

&store->my_section_my_arr_len,

MY_ARRAY_DELIMITER,

);

if (!store->my_section_my_array) {

return 1;

}

}

}

return 0;

#undef THEYMATCH

#undef store

}

static void print_stored_data (const struct ini_store * const store) {

printf(

"my_string -> %s\n"

"my_number -> %d\n"

"my_boolean -> %s\n"

"my_implicit_boolean -> %s\n"

"my_array[%zu] -> [%s",

store->my_section_my_string,

store->my_section_my_number,

store->my_section_my_boolean ? "True (`1`)" : "False (`0`)",

store->my_section_my_implicit_bool ? "True (`1`)" : "False (`0`)",

store->my_section_my_arr_len,

store->my_section_my_arr_len ? store->my_section_my_array[0] : ""

);

for (size_t idx = 1; idx < store->my_section_my_arr_len; idx++) {

printf("|%s", store->my_section_my_array[idx]);

}

printf("]\n");

}

int main () {

struct ini_store my_store;

"../ini_files/typed_ini.conf",

my_format,

my_init,

my_handler,

&my_store

)) {

fprintf(stderr, "Sorry, something went wrong :-(\n");

return 1;

}

print_stored_data(&my_store);

free(my_store.my_section_my_string);

free((void *) my_store.my_section_my_array);

return 0;

}

◆ ini_global_set_implicit_value()

Set the value to be to be assigned to implicit keys.

Parameters

Returns

Nothing

Warning

This function changes the value of one or more global variables. In order to be thread-safe this function should be used only once at beginning of execution, or otherwise a mutex logic must be introduced.

#include <stdio.h>

static int ini_listener (

void * const v_null

) {

printf(

"\nDATA: %s\nVALUE: %s\nNODE TYPE: %u\n"

"(This is an implicit key element)\n",

);

} else {

printf(

"\nDATA: %s\nVALUE: %s\nNODE TYPE: %u\n",

);

}

return 0;

}

int main () {

if (

"../ini_files/unix-like.conf",

my_format,

NULL,

ini_listener,

NULL

)

) {

fprintf(stderr, "Sorry, something went wrong :-(\n");

return 1;

}

}

char * INI_GLOBAL_IMPLICIT_VALUE

Value to be assigned to implicit keys (default value: NULL)

Definition: confini.c:5764

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:532

◆ ini_global_set_lowercase_mode()

Set the value of the global variable INI_GLOBAL_LOWERCASE_MODE.

Deprecated:

Deprecated since version 1.15.0 (it will be removed in version 2.0.0)

Parameters

Returns

Nothing

If lowercase is true, key and section names in case-insensitive INI formats will be dispatched lowercase, verbatim otherwise (default value: true).

Warning

This function changes the value of one or more global variables. In order to be thread-safe this function should be used only once at beginning of execution, or otherwise a mutex logic must be introduced.

◆ ini_ntof()

Construct a new IniFormat according to an IniFormatNum.

Parameters

Returns

The new IniFormat constructed

Note

If format_num > 16777215 it will be truncated to 24 bits.

◆ ini_string_match_ii()

Compare two INI strings and check whether they match.

Parameters

Returns

A boolean: true if the two strings match, false otherwise

This function grants that the result of the comparison between two INI strings

printf(

"%s\n",

"They match"

:

"They don't match"

);

bool ini_string_match_ii(const char *const ini_string_a, const char *const ini_string_b, const IniFormat format)

Compare two INI strings and check whether they match.

Definition: confini.c:3653

will always match the result of the literal comparison between the same two INI strings after these have been parsed by ini_string_parse() when format.do_not_collapse_values is set to false.

printf("%s\n",

"They match"

:

"They don't match"

);

bool ini_string_match_ss(const char *const simple_string_a, const char *const simple_string_b, const IniFormat format)

Compare two simple strings and check whether they match.

Definition: confini.c:3369

INI strings are the strings typically dispatched by load_ini_file(), load_ini_path() or strip_ini_cache(), which may contain quotes and the three escape sequences \\, \' and \".

In order to be suitable for both names and values, this function always considers sequences of one or more spaces out of quotes in both strings as collapsed, even when format.do_not_collapse_values is set to true.

The format argument is used for the following fields:

• format.case_sensitive
• format.no_double_quotes
• format.no_single_quotes
• format.multiline_nodes ([INIFORMAT_HAS_NO_ESC()](confini%5F8h.html#ae74cb0104512ee3dfe2865abe689e3f5 "Check whether a format does not support escape sequences."))

◆ ini_string_match_si()

Compare a simple string and an INI string and and check whether they match.

Parameters

Returns

A boolean: true if the two strings match, false otherwise

This function grants that the result of the comparison between a simple string and an INI string

printf(

"%s\n",

"They match"

:

"They don't match"

);

will always match the result of the literal comparison between the simple string and the INI string after the latter has been parsed by ini_string_parse() when format.do_not_collapse_values is set to false.

printf(

"%s\n",

"They match"

:

"They don't match"

);

INI strings are the strings typically dispatched by load_ini_file(), load_ini_path() or strip_ini_cache(), which may contain quotes and the three escape sequences \\, \' and \". Simple strings are user-given strings or the result of ini_string_parse().

In order to be suitable for both names and values, this function always considers sequences of one or more spaces out of quotes in the INI string as collapsed, even when format.do_not_collapse_values is set to true.

The format argument is used for the following fields:

• format.case_sensitive
• format.no_double_quotes
• format.no_single_quotes
• format.multiline_nodes ([INIFORMAT_HAS_NO_ESC()](confini%5F8h.html#ae74cb0104512ee3dfe2865abe689e3f5 "Check whether a format does not support escape sequences."))

#include <stdio.h>

static int passfinder (

void * const v_membid

) {

if (

) {

return 1;

}

return 0;

}

int main () {

size_t membid;

"../ini_files/self_explaining.conf",

NULL,

passfinder,

&membid

);

fprintf(stderr, "Sorry, something went wrong :-(\n");

return 1;

}

printf(

"We found it! It's the INI node number %zu!\n",

membid

)

:

printf("We didn't find it :-(\n");

return 0;

}

#define CONFINI_ERROR

Error mask (flags not present in user-generated interruptions)

Definition: confini.h:398

@ CONFINI_FEINTR

Definition: confini.h:409

size_t dispatch_id

Definition: confini.h:140

◆ ini_string_match_ss()

Compare two simple strings and check whether they match.

Parameters

Returns

A boolean: true if the two strings match, false otherwise

Simple strings are user-given strings or the result of ini_string_parse(). The format argument is used for the following fields:

• format.case_sensitive

◆ ini_string_parse()

Unescape \', \", and \\ and remove all unescaped quotes (when single/double quotes are considered metacharacters in respect to the format given); if the format allows it, sequences of one or more spaces out of quotes will be collapsed.

Parameters

Returns

The new length of the string

This function is meant to be used to parse values. In order to parse key and section names please use ini_unquote().

If you only need to compare ini_string with another string, consider to use ini_string_match_si() and ini_string_match_ii() instead of parsing the former and perform a simple comparison afterwards. These two functions are in fact able to check directly for equality between unparsed INI strings without actually modifying them.

Usually ini_string comes from an IniDispatch (but any other string may be used as well). If format.do_not_collapse_values is set to non-zero, spaces surrounding empty quotes will be collapsed together with the latter.

Note

If ini_string comes from INI_GLOBAL_IMPLICIT_VALUE this function is no-op and will only return the value of INI_GLOBAL_IMPLICIT_V_LEN minus the offset of ini_string within INI_GLOBAL_IMPLICIT_VALUE.

The format argument is used for the following fields:

• format.no_single_quotes
• format.no_double_quotes
• format.multiline_nodes ([INIFORMAT_HAS_NO_ESC()](confini%5F8h.html#ae74cb0104512ee3dfe2865abe689e3f5 "Check whether a format does not support escape sequences."))
• format.do_not_collapse_values

#include <stdio.h>

static int ini_listener (

void * const v_null

) {

if (

) {

}

printf(

"DATA: %s\nVALUE: %s\nNODE TYPE: %u\n\n",

);

return 0;

}

int main () {

if (

"../ini_files/self_explaining.conf",

NULL,

ini_listener,

NULL

)

) {

fprintf(stderr, "Sorry, something went wrong :-(\n");

return 1;

}

return 0;

}

@ INI_DISABLED_KEY

Definition: confini.h:446

size_t ini_unquote(char *const ini_string, const IniFormat format)

Unescape \', \", and \\ and remove all unescaped quotes (when single/double quotes are considered met...

Definition: confini.c:4110

◆ ini_unquote()

Unescape \', \", and \\ and remove all unescaped quotes (when single/double quotes are considered metacharacters in respect to the format given)

Parameters

Returns

The new length of the string

This function is very similar to ini_string_parse(), except that does not bother collapsing the sequences of more than one space that might result from removing empty quotes. Its purpose is to be used to parse key and section names, since these are always dispatched as already collapsed. In order to parse values, or array parts listed in values, please use ini_string_parse().

If you only need to compare ini_string with another string, consider to use ini_string_match_si() and ini_string_match_ii() instead of parsing the former and perform a simple comparison afterwards. These two functions are in fact able to check directly for equality between unparsed INI strings without actually modifiyng them.

Usually ini_string comes from an IniDispatch (but any other string may be used as well). If the string does not contain quotes, or if quotes are considered to be normal characters, no changes will be made.

Note

If ini_string comes from INI_GLOBAL_IMPLICIT_VALUE this function is no-op and will only return the value of INI_GLOBAL_IMPLICIT_V_LEN minus the offset of ini_string within INI_GLOBAL_IMPLICIT_VALUE.

The format argument is used for the following fields:

• format.no_single_quotes
• format.no_double_quotes
• format.multiline_nodes ([INIFORMAT_HAS_NO_ESC()](confini%5F8h.html#ae74cb0104512ee3dfe2865abe689e3f5 "Check whether a format does not support escape sequences."))

#include <stdio.h>

static int ini_listener (

void * const v_null

) {

if (

) {

}

printf(

"DATA: %s\nVALUE: %s\nNODE TYPE: %u\n\n",

);

return 0;

}

int main () {

if (

"../ini_files/self_explaining.conf",

NULL,

ini_listener,

NULL

)

) {

fprintf(stderr, "Sorry, something went wrong :-(\n");

return 1;

}

return 0;

}

◆ is_some_space()

Check whether a character is a space.

Parameters

Returns

A boolean: true if the character matches, false otherwise

◆ load_ini_file()

Parse an INI file and dispatch its content to a custom callback using a FILE structure as argument.

Parameters

Returns

Zero for success, otherwise an error code (see enum ConfiniInterruptNo)

Note

This function is absent if the --without-io-api option was passed to the configure script when the library was compiled

The ini_file parameter must be a FILE handle with read privileges. On some platforms, such as Microsoft Windows, it might be necessary to add the binary specifier to the mode string ("b") in order to prevent discrepancies between the physical size of the file and its computed size. Adding the binary specifier guarantees portability across all platforms:

FILE * my_file = fopen("example.conf", "rb");

For the two parameters f_init and f_foreach see function strip_ini_cache().

The parsing algorithms used by libconfini are able to parse any type of file encoded in 8-bit code units, as long as the characters that match the regular expression /[\s\[\]\.\\;#"']/ refer to the same code points they refer to in ASCII (as they do, for example, in UTF-8 and ISO-8859-1), independently of platform-specific conventions.

Note

In order to be null-byte-injection safe, NUL characters, if present in the file, will be removed from the dispatched strings.

Possible return values are: CONFINI_SUCCESS, CONFINI_IINTR, CONFINI_FEINTR, CONFINI_ENOMEM, CONFINI_EIO, CONFINI_EOOR, CONFINI_EBADF, CONFINI_EFBIG.

#include <stdio.h>

static int my_callback (

void * const v_null

) {

printf(

"DATA: %s\nVALUE: %s\nNODE TYPE: %u\n\n",

);

return 0;

}

int main () {

FILE * const ini_file = fopen("../ini_files/delivery.conf", "rb");

if (ini_file == NULL) {

fprintf(stderr, "File doesn't exist :-(\n");

return 1;

}

if (

ini_file,

NULL,

my_callback,

NULL

)

) {

fprintf(stderr, "Sorry, something went wrong :-(\n");

return 1;

}

fclose(ini_file);

return 0;

}

int load_ini_file(FILE *const ini_file, const IniFormat format, const IniStatsHandler f_init, const IniDispHandler f_foreach, void *const user_data)

Parse an INI file and dispatch its content to a custom callback using a FILE structure as argument.

Definition: confini.c:3180

◆ load_ini_path()

Parse an INI file and dispatch its content to a custom callback using a path as argument.

Parameters

Returns

Zero for success, otherwise an error code (see enum ConfiniInterruptNo)

Note

This function is absent if the --without-io-api option was passed to the configure script when the library was compiled

For the two parameters f_init and f_foreach see function strip_ini_cache().

The parsing algorithms used by libconfini are able to parse any type of file encoded in 8-bit code units, as long as the characters that match the regular expression /[\s\[\]\.\\;#"']/ refer to the same code points they refer to in ASCII (as they do, for example, in UTF-8 and ISO-8859-1), independently of platform-specific conventions.

Note

In order to be null-byte-injection safe, NUL characters, if present in the file, will be removed from the dispatched strings.

Possible return values are: CONFINI_SUCCESS, CONFINI_IINTR, CONFINI_FEINTR, CONFINI_ENOENT, CONFINI_ENOMEM, CONFINI_EIO, CONFINI_EOOR, CONFINI_EBADF, CONFINI_EFBIG.

#include <stdio.h>

static int my_callback (

void * const v_null

) {

printf(

"DATA: %s\nVALUE: %s\nNODE TYPE: %u\n\n",

);

return 0;

}

int main () {

if (

"../ini_files/delivery.conf",

NULL,

my_callback,

NULL

)

) {

fprintf(stderr, "Sorry, something went wrong :-(\n");

return 1;

}

return 0;

}

◆ ltrim_h()

Hard left trim – does change the buffer.

Parameters

Returns

The offset of the first non-space character

◆ ltrim_hh()

Shifting left trim – does change the buffer.

Parameters

Returns

The new length of the string

◆ ltrim_s()

Soft left trim – does not change the buffer.

Parameters

Returns

The offset of the first non-space character

◆ qultrim_h()

Unparsed hard left trim (left trim of /^(?:\s+|\\[\n\r]|''|"")+/) – does change the buffer.

Parameters

Returns

The offset of the first non-trivial character

◆ rtrim_h()

Hard right trim – does change the buffer.

Parameters

Returns

The new length of the string

◆ rtrim_s()

Soft right trim – does not change the buffer.

Parameters

Returns

The length of the string until the last non-space character

◆ sanitize_section_path()

Sanitize a section path.

Parameters

Returns

The new length of the string

Out of quotes, similar to ECMAScript secpath.replace(/\.*\s*$|(?:\s*(\.))+\s*|^\s+/g, "$1").replace(/\s+/g, " ")

A section path can start with a dot (append), but cannot end with a dot. Spaces surrounding dots will be removed. Fragments surrounded by single or double quotes (if these are enabled) are prevented from changes.

◆ string_tolower()

Convert an ASCII string to lower case.

Parameters

Returns

Nothing

◆ strip_ini_cache()

Parse and tokenize a buffer containing an INI file, then dispatch its content to a custom callback.

Parameters

Returns

Zero for success, otherwise an error code (see enum ConfiniInterruptNo)

The ini_source parameter must be a valid pointer to a buffer of size ini_length + 1 and cannot be NULL. The ini_source string does not need to be NUL-terminated, but it does need one extra byte where to append a NUL terminator – in fact, as soon as this function is invoked, ini_source[ini_length] will be immediately set to \0.

In most cases, as when using strlen() for computing ini_length, this is not a concern, since ini_source[ini_length] will always be \0 by the very definition of strlen(), and will only get overwritten with the same value. However, if you are passing a substring of a string, for example the fragment foo=bar of the string foo=barracuda, you must expect the string to be immediately truncated into foo=bar\0acuda.

In other words, ini_source must point to a memory location where at least ini_length + 1 bytes are freely usable.

The user given function f_init (see IniStatsHandler data type) will be invoked with two arguments: statistics (a pointer to an IniStatistics structure containing some properties about the file read) and user_data (the custom argument user_data previously passed). If f_init returns a non-zero value the caller function will be interrupted.

The user given function f_foreach (see IniDispHandler data type) will be invoked with two arguments: dispatch (a pointer to an IniDispatch structure containing the parsed member of the INI file) and user_data (the custom argument user_data previously passed). If f_foreach returns a non-zero value the caller function will be interrupted.

After invoking [strip_ini_cache()](confini%5F8c.html#a25d648d387f6e8bc36e7965accfca63b "Parse and tokenize a buffer containing an INI file, then dispatch its content to a custom callback."), the buffer pointed by the ini_source parameter must be considered as a corrupted buffer and should be freed or overwritten. For more information about this function, please refer to the Library Functions Manual.

The parsing algorithms used by libconfini are able to parse any type of file encoded in 8-bit code units, as long as the characters that match the regular expression /[\s\[\]\.\\;#"']/ refer to the same code points they refer to in ASCII (as they do, for example, in UTF-8 and ISO-8859-1), independently of platform-specific conventions.

Note

In order to be null-byte-injection-safe, before dispatching the parsed content this function strips all NUL characters possibly present in the buffer (with the exception of the last one).

Possible return values are: CONFINI_SUCCESS, CONFINI_IINTR, CONFINI_FEINTR, CONFINI_EOOR.

#include <stdio.h>

#include <stdlib.h>

#include <string.h>

static int my_callback (

void * const v_null

) {

printf(

"DATA: %s\nVALUE: %s\nNODE TYPE: %u\n\n",

);

return 0;

}

int main () {

const char original_ini_buffer[] =

"[SectionOne]\n"

"\n"

"key = \"value\"\n"

"integer = 1234\n"

"real = 3.14\n"

"string1 = \"Case 1\"\n"

"string2 = 'Case 2'\n"

;

size_t ini_length = strlen(original_ini_buffer);

char * const ini_cache = strndup(original_ini_buffer, ini_length);

if (

ini_cache,

ini_length,

NULL,

my_callback,

NULL

)

) {

fprintf(stderr, "Sorry, something went wrong :-(\n");

return 1;

}

printf(

"The previous dispatches come from the following buffer:\n\n"

"-------------[original INI buffer]-------------\n"

"%s"

"-----------------------------------------------\n\n",

original_ini_buffer

);

printf(

"After being processed by `strip_ini_cache()`, the buffer looks "

"like this:\n"

);

printf("\n---------------[disposed buffer]---------------\n");

for (size_t idx = 0; idx <= ini_length; idx++) {

putchar(ini_cache[idx] == 0 ? '.' : ini_cache[idx]);

}

printf("\n-----------------------------------------------\n\n");

printf(

"The dots in the example above represent NUL characters. Remember "

"that\n`strip_ini_cache()` does not free the buffer passed, you "

"will have to do that\nby yourself.\n"

);

free(ini_cache);

return 0;

}

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)

Parse and tokenize a buffer containing an INI file, then dispatch its content to a custom callback.

Definition: confini.c:2605

◆ uncomment()

Remove all comment initializers (# and/or ;) from the beginning of each line of a comment.

Parameters

Returns

The new length of the string

• Multi-line comments: srcstr.replace(/^[#;]+|(\n\r?|\r\n?)[\t \v\f]*[#;]+/g, "$1")
• Single-line comments: srcstr.replace(/^[#;]+/, "")

The argument srcstr may begin with a comment initializer (# or ; depending on the format), or with the character that immediately follows it.

◆ unescape_cr_lf()

Replace /\\(\n\r?|\r\n?)[\t \v\f]*[#;]/ or /\\(\n\r?|\r\n?)/ with "$1"

Parameters

Returns

The new length of the string

◆ urtrim_s()

Unparsed soft right trim (right trim of /(?:\s|\\[\n\r])+$/) – does not change the buffer.

Parameters

Returns

The length of the string until the last non-space character

◆ INI_BOOLEANS

Initial value:

= {

{ "no", "yes" },

{ "false", "true" },

{ "off", "on" }

}

A list of possible string representations of boolean pairs.

There may be infinite pairs here. Each pair must be organized according to the following order:

1. Signifier of false
2. Signifier of true

Note

Everything must be lowercase in this list.

◆ ini_get_double

◆ ini_get_float

Legacy support for parsing a double data type – please do not use this function: use [ini_get_double()](confini%5F8c.html#ac7aafdf3e7becda36ebe4e20f0f7438d "Pointer to atof()") instead.

Deprecated:

Deprecated since version 1.12.0 (it will be removed in version 2.0.0) – please use ini_get_double() instead

Parameters

◆ ini_get_int

◆ ini_get_lint

◆ ini_get_llint

◆ INI_GLOBAL_IMPLICIT_V_LEN

size_t INI_GLOBAL_IMPLICIT_V_LEN = 0

Length of the value assigned to implicit keys (default value: 0)

◆ INI_GLOBAL_IMPLICIT_VALUE

char* INI_GLOBAL_IMPLICIT_VALUE = (char *) 0

Value to be assigned to implicit keys (default value: NULL)

◆ INI_GLOBAL_LOWERCASE_MODE

bool INI_GLOBAL_LOWERCASE_MODE = 0

If set to true, key and section names in case-insensitive INI formats will be dispatched lowercase, verbatim otherwise (default value: false)

Deprecated:

Deprecated since version 1.15.0 (it will be removed in version 2.0.0)