https://github.com/blhmr/cezconfig
Simple C library for handling configuration files
https://github.com/blhmr/cezconfig
Last synced: 4 months ago
JSON representation
Simple C library for handling configuration files
- Host: GitHub
- URL: https://github.com/blhmr/cezconfig
- Owner: blhmr
- License: mit
- Created: 2024-01-25T12:20:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-26T19:58:33.000Z (over 1 year ago)
- Last Synced: 2025-01-06T13:49:23.552Z (6 months ago)
- Language: C
- Size: 41 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CezConfig Library [⚙️]
CezConfig is a lightweight C library designed for parsing configuration files. It provides basic functions for opening, closing, reading, and manipulating configuration files using a key-value pair format.
## Use case
This library is for personal use, therefore it lacks some features other configuration files have, so keep your expectations low.
Example of usage: consider the following folder scheme
```
school/
├── class-1/
│ ├── student-1/
│ │ ├── history.txt
│ │ ├── grades/
│ │ └── information.cez <- Informations about the student
│ ├── student-2/
│ │ ├── history.txt
│ │ ├── grades/
│ │ └── information.cez
```
## Example
Go to the examples directory to see how the functions work.
This is a `.cez` file:
```ini
# This is a comment
key1=value1
key2=value2
# Let's use the example in the 'Use case' section
first_name=John
last_name=Doe
birth_year=2006
major=math
```
Example in C language:
```c
#include // Assume you installed the library
int main(void) {
cezfile_t file;
if (cez_open(&file, "example.cez") != 0) {
perror("Error opening file");
return -1;
}
cez_insert(&file, "first_name", "John");
cez_insert(&file, "last_name", "Doe");
cez_close(&file);
}
```
## Installation (Unix)
```bash
git clone https://github.com/blhmr/CezConfig.git
cd CezConfig
# TO INSTALL
make install
# You can compile the example code in examples directory
# TO DELETE FROM YOUR SYSTEM
make uninstall
```
Compilation:
```bash
gcc your_file.c -o your_file -lcezconfig
```
## Constants
- `CEZ_MAX_LEN_KEY`: Maximum length for a configuration key.
- `CEZ_MAX_LEN_VALUE`: Maximum length for a configuration value.
- `CEZ_MAX_LEN_LINE`: Maximum length for a configuration line (key + value + 1).
## Enums
- `linetype_t`: Enumerates different types of lines in a configuration file.
- `CEZ_COMMENT`: Line is a comment.
- `CEZ_KEY_VALUE_PAIR`: Line is a key-value pair.
- `CEZ_UNKNOWN`: Unknown line type (error).
- `CEZ_BLANK`: Blank line.
## Structs
- `cezpair_t`: Represents a key-value pair in the configuration file.
- `cezfile_t`: Represents a configuration file, including the file pointer, filename, and the number of properties.
## Functions
### File Operations
- `cez_open(cezfile_t* cezfile, const char* filename)`: Open a CEZ configuration file.
- `cez_close(cezfile_t* cezfile)`: Close a CEZ configuration file.
### Line Operations
- `cez_get_line(cezfile_t* cezfile, const char* key)`: Get the line number of a configuration file based on the key.
- `cez_key_exist(cezfile_t* cezfile, const char* key)`: Check if a key exists in the configuration file.
### Data Operations
- `cez_insert(cezfile_t* cezfile, const char* key, const char* value)`: Insert a configuration key with a value into the CEZ file.
- `cez_get_value(cezfile_t* cezfile, const char* key)`: Get the value of a configuration key.
- `cez_update(cezfile_t* cezfile, const char* key, const char* new_value)`: Update a configuration key with a new value.
- `cez_delete(cezfile_t* cezfile, const char* key)`: Delete a configuration key from the CEZ file.
### Undone and In Progress
- Functions using `cezpair_t` are currently undone.
- No functions are in progress at the moment.
## License
This library is provided under the [MIT License](LICENSE). Feel free to use and modify it in your projects.