diff options
Diffstat (limited to 'include/ini.h')
| -rw-r--r-- | include/ini.h | 185 |
1 files changed, 156 insertions, 29 deletions
diff --git a/include/ini.h b/include/ini.h index 06004e3..f16142c 100644 --- a/include/ini.h +++ b/include/ini.h @@ -1,54 +1,181 @@ +/// @file ini.h + #ifndef OHMYCAL_INI_H #define OHMYCAL_INI_H #include <stddef.h> #include <stdbool.h> -#define INIVAL_TYPE_INT 1 -#define INIVAL_TYPE_UINT 2 -#define INIVAL_TYPE_LONG 3 -#define INIVAL_TYPE_ULONG 4 -#define INIVAL_TYPE_LLONG 5 -#define INIVAL_TYPE_ULLONG 6 -#define INIVAL_TYPE_DOUBLE 7 -#define INIVAL_TYPE_FLOAT 8 -#define INIVAL_TYPE_STR 9 -#define INIVAL_TYPE_STR_ARRAY 10 -#define INIVAL_TYPE_BOOL 11 +#define INIVAL_TYPE_INT 1 ///< Integer +#define INIVAL_TYPE_UINT 2 ///< Unsigned integer +#define INIVAL_TYPE_LONG 3 ///< Long integer +#define INIVAL_TYPE_ULONG 4 ///< Unsigned long integer +#define INIVAL_TYPE_LLONG 5 ///< Long long integer +#define INIVAL_TYPE_ULLONG 6 ///< Unsigned long long integer +#define INIVAL_TYPE_DOUBLE 7 ///< Double precision float +#define INIVAL_TYPE_FLOAT 8 ///< Single precision float +#define INIVAL_TYPE_STR 9 ///< String +#define INIVAL_TYPE_STR_ARRAY 10 ///< String Array +#define INIVAL_TYPE_BOOL 11 ///< Boolean #define INIVAL_TO_LIST 1 << 1 +/*! \union INIVal + * \brief Consolidation possible value types + */ union INIVal { - int as_int; - unsigned as_uint; - long as_long; - unsigned long as_ulong; - long long as_llong; - unsigned long long as_ullong; - double as_double; - float as_float; - char *as_char_p; - char **as_char_array_p; - bool as_bool; + int as_int; ///< Integer + unsigned as_uint; ///< Unsigned integer + long as_long; ///< Long integer + unsigned long as_ulong; ///< Unsigned long integer + long long as_llong; ///< Long long integer + unsigned long long as_ullong; ///< Unsigned long long integer + double as_double; ///< Double precision float + float as_float; ///< Single precision float + char *as_char_p; ///< String + char **as_char_array_p; ///< String Array + bool as_bool; ///< Boolean }; +/*! \struct INIData + * \brief A structure to describe an INI data record + */ struct INIData { - char *key; - char *value; + char *key; ///< INI variable name + char *value; ///< INI variable value }; + +/*! \struct INISection + * \brief A structure to describe an INI section + */ struct INISection { - size_t data_count; - char *key; - struct INIData **data; + size_t data_count; ///< Total INIData records + char *key; ///< INI section name + struct INIData **data; ///< Array of INIData records }; + +/*! \struct INIFILE + * \brief A structure to describe an INI configuration file + */ struct INIFILE { - size_t section_count; - struct INISection **section; + size_t section_count; ///< Total INISection records + struct INISection **section; ///< Array of INISection records }; +/** + * Open and parse and INI configuration file + * + * ~~~.c + * #include "ini.h" + * int main(int argc, char *argv[]) { + * const char *filename = "example.ini" + * struct INIFILE *ini; + * ini = ini_open(filename); + * if (!ini) { + * perror(filename); + * exit(1); + * } + * } + * ~~~ + * + * @param filename path to INI file + * @return pointer to INIFILE + */ struct INIFILE *ini_open(const char *filename); + +/** + * Retrieve all data records in an INI section + * + * `example.ini` + * ~~~.ini + * [example] + * key_1 = a string + * key_2 = 100 + * ~~~ + * + * `example.c` + * ~~~.c + * #include "ini.h" + * int main(int argc, char *argv[]) { + * const char *filename = "example.ini" + * struct INIData *data; + * struct INIFILE *ini; + * ini = ini_open(filename); + * if (!ini) { + * perror(filename); + * exit(1); + * } + * // Read all records in "example" section + * for (size_t i = 0; ((data = ini_getall(&ini, "example") != NULL); i++) { + * printf("key=%s, value=%s\n", data->key, data->value); + * } + * } + * ~~~ + * + * @param ini pointer to INIFILE + * @param section_name to read + * @return pointer to INIData + */ struct INIData *ini_getall(struct INIFILE *ini, char *section_name); + +/** + * Retrieve a single record from a section key + * + * `example.ini` + * ~~~.ini + * [example] + * key_1 = a string + * key_2 = 100 + * ~~~ + * + * `example.c` + * ~~~.c + * #include "ini.h" + * int main(int argc, char *argv[]) { + * const char *filename = "example.ini" + * union INIVal *data; + * struct INIFILE *ini; + * ini = ini_open(filename); + * if (!ini) { + * perror(filename); + * exit(1); + * } + * data = ini_getval(&ini, "example", "key_1", INIVAL_TYPE_STR); + * puts(data.as_char_p); + * data = ini_getval(&ini, "example", "key_2", INIVAL_TYPE_INT); + * printf("%d\n", data.as_int); + * } + * ~~~ + * + * @param ini pointer to INIFILE + * @param section_name to read + * @param key to return + * @param type INIVAL_TYPE_INT + * @param type INIVAL_TYPE_UINT + * @param type INIVAL_TYPE_LONG + * @param type INIVAL_TYPE_ULONG + * @param type INIVAL_TYPE_LLONG + * @param type INIVAL_TYPE_ULLONG + * @param type INIVAL_TYPE_DOUBLE + * @param type INIVAL_TYPE_FLOAT + * @param type INIVAL_TYPE_STR + * @param type INIVAL_TYPE_STR_ARRAY + * @param type INIVAL_TYPE_BOOL + * @param result pointer to INIVal + * @return 0 on success + * @return Non-zero on error + */ int ini_getval(struct INIFILE *ini, char *section_name, char *key, int type, union INIVal *result); + +/** + * Print INIFILE sections and data + * @param ini pointer to INIFILE + */ void ini_show(struct INIFILE *ini); + +/** + * Free memory allocated by ini_open() + * @param ini + */ void ini_free(struct INIFILE **ini); #endif //OHMYCAL_INI_H |