/* MIT License * * Copyright (c) 2023 CLECIO JUNG * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ /*------------------------------------------------------------------------------ * HEADER *------------------------------------------------------------------------------ */ #ifndef __INI_FILE #define __INI_FILE /* Summary: * INI files are not standardized, meaning that different implementations may have * differences. This implementation uses the # and ; characters to define * single-line comments. As a result, these characters cannot be used when defining * section names, keys, and values. Special characters such as =, #, and ; are not * allowed in key names. However, spaces and the = character can be used when * defining values, as long as the characters # and ; are not used. Section names * can have spaces, but cannot include the characters ], #, and ;. Nested sections * are not currently implemented, and duplicate names are allowed (for now). Quoted * strings and escaped characters are not supported in this implementation. * If a key-value pair appears in the INI file before the first section is declared, * it will be treated as belonging to the "global" section. This allows properties * to be defined outside of any specific section and still be easily accessible in * the program. */ /* This is a implementation of a custom string allocator to store the strings found * inside the INI. If you don't want to use this approach, just comment the * definition of the macro USE_CUSTOM_STRING_ALLOCATOR bellow. In this case, all the * string allocations will be performed by expensive malloc calls. * * This custom string allocator consists of a linked-list of large buffers. It is * designed to be memory-efficient and avoid memory fragmentation. Whenever a new * string is found in the INI file, it is copied to an available buffer in the * linked list, allocating new buffers as needed. This approach reduces the number * of malloc and free calls, which can be expensive in terms of performance. */ #define USE_CUSTOM_STRING_ALLOCATOR #ifdef USE_CUSTOM_STRING_ALLOCATOR struct String_Buffer { char buffer[4096]; struct String_Buffer *next; /* This index points to the next valid location to store the string. * If the buffer is full, the index will equal -1. In this case we shall * use one of the next buffers. */ int index; }; #endif struct Key_Value_Pair { char *key; char *value; }; struct Ini_Section { char *name; /* The properties of the section are stored in a dynamic array */ size_t properties_size; size_t properties_capacity; struct Key_Value_Pair *properties; }; struct Ini_File { #ifdef USE_CUSTOM_STRING_ALLOCATOR struct String_Buffer *strings; #endif /* The sections of the ini file are stored in a dynamic array */ size_t sections_size; size_t sections_capacity; struct Ini_Section *sections; }; enum Ini_File_Errors { ini_no_error = 0, ini_allocation, ini_invalid_parameters, ini_couldnt_open_file, ini_expected_clocing_bracket, ini_expected_equals, ini_section_not_provided, ini_key_not_provided, ini_value_not_provided, ini_no_such_section, ini_no_such_property, ini_not_integer, ini_not_unsigned, ini_not_float, NUMBER_OF_INI_FILE_ERRORS }; /* Callback used to handle errors and warnings in the parsing of INI files (function ini_file_parse). * In case of an error, this callback is called, and if it returns an integer different from zero, * we end the parsing and return NULL. */ typedef int (*Ini_File_Error_Callback)(const char *const filename, const size_t line_number, const size_t column, const char *const line, const enum Ini_File_Errors error); size_t get_file_size(FILE *const file); /* Remember to free the memory allocated for the returned string */ char *get_content_from_file(const char *const filename); struct Ini_File *ini_file_new(void); void ini_file_free(struct Ini_File *const ini_file); void ini_section_print_to(const struct Ini_Section *const ini_section, FILE *const sink); void ini_file_print_to(const struct Ini_File *const ini_file, FILE *const sink); char *ini_file_error_to_string(const enum Ini_File_Errors error); /* Remember to free the memory allocated for the returned ini file structure */ struct Ini_File *ini_file_parse(const char *const filename, Ini_File_Error_Callback callback); /* These functions returns ini_no_error = 0 if everything worked correctly */ enum Ini_File_Errors ini_file_add_section_sized(struct Ini_File *const ini_file, const char *const name, const size_t name_len); enum Ini_File_Errors ini_file_add_section(struct Ini_File *const ini_file, const char *const name); enum Ini_File_Errors ini_file_add_property_sized(struct Ini_File *const ini_file, const char *const key, const size_t key_len, const char *const value, const size_t value_len); enum Ini_File_Errors ini_file_add_property(struct Ini_File *const ini_file, const char *const key, const char *const value); enum Ini_File_Errors ini_file_save(const struct Ini_File *const ini_file, const char *const filename); /* These functions use sequential search algorithm to find the requested section and properties. * They return ini_no_error = 0 if everything worked correctly. * The found value will be stores at the memory address provided by the caller. * If no value is found, the function will not modify the value stored at the address provided. */ enum Ini_File_Errors ini_file_find_section(struct Ini_File *const ini_file, const char *const section, struct Ini_Section **ini_section); enum Ini_File_Errors ini_file_find_property(struct Ini_File *const ini_file, const char *const section, const char *const key, char **value); enum Ini_File_Errors ini_file_find_integer(struct Ini_File *const ini_file, const char *const section, const char *const key, long *integer); enum Ini_File_Errors ini_file_find_unsigned(struct Ini_File *const ini_file, const char *const section, const char *const key, unsigned long *uint); enum Ini_File_Errors ini_file_find_float(struct Ini_File *const ini_file, const char *const section, const char *const key, double *real); #endif /* __INI_FILE */ /*------------------------------------------------------------------------------ * END *------------------------------------------------------------------------------ */ /* MIT License * * Copyright (c) 2023 CLECIO JUNG * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */