libeconf 0.4.7
libeconf.h
Go to the documentation of this file.
1/*
2 Copyright (C) 2019 SUSE LLC
3 Author: Pascal Arlt <parlt@suse.com>
4
5 Permission is hereby granted, free of charge, to any person obtaining a copy
6 of this software and associated documentation files (the "Software"), to deal
7 in the Software without restriction, including without limitation the rights
8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 copies of the Software, and to permit persons to whom the Software is
10 furnished to do so, subject to the following conditions:
11
12 The above copyright notice and this permission notice shall be included in all
13 copies or substantial portions of the Software.
14
15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 SOFTWARE.
22*/
23
24#pragma once
25
30#include <stdbool.h>
31#include <stdint.h>
32#include <stdlib.h>
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
83};
84
85typedef enum econf_err econf_err;
86
97#define econf_setValue(kf, group, key, value) (( \
98 _Generic((value), \
99 int: econf_setIntValue, \
100 long: econf_setInt64Value, \
101 unsigned int: econf_setUIntValue, \
102 unsigned long: econf_setUInt64Value, \
103 float: econf_setFloatValue, \
104 double: econf_setDoubleValue, \
105 char*: econf_setStringValue, void*: econf_setStringValue)) \
106(kf, group, key, value))
107
114#define econf_free(value) (( \
115 _Generic((value), \
116 econf_file*: econf_freeFile , \
117 char**: econf_freeArray)) \
118(value))
119
120typedef struct econf_file econf_file;
121
150extern econf_err econf_readFile(econf_file **result, const char *file_name,
151 const char *delim, const char *comment);
152
182 econf_file *usr_file, econf_file *etc_file);
183
217 const char *usr_conf_dir,
218 const char *etc_conf_dir,
219 const char *project_name,
220 const char *config_suffix,
221 const char *delim,
222 const char *comment);
223
243 size_t *size,
244 const char *usr_conf_dir,
245 const char *etc_conf_dir,
246 const char *project_name,
247 const char *config_suffix,
248 const char *delim,
249 const char *comment);
250
251/* The API/ABI of the following three functions (econf_newKeyFile,
252 econf_newIniFile and econf_writeFile) are not stable and will change */
253
267extern econf_err econf_newKeyFile(econf_file **result, char delimiter, char comment);
268
277
285extern char econf_comment_tag(econf_file *key_file);
286
294extern char econf_delimiter_tag(econf_file *key_file);
295
303extern void econf_set_comment_tag(econf_file *key_file, const char comment);
304
312extern void econf_set_delimiter_tag(econf_file *key_file, const char delimiter);
313
322extern econf_err econf_writeFile(econf_file *key_file, const char *save_to_dir,
323 const char *file_name);
324
325/* --------------- */
326/* --- GETTERS --- */
327/* --------------- */
328
336extern char *econf_getPath(econf_file *kf);
337
346extern econf_err econf_getGroups(econf_file *kf, size_t *length, char ***groups);
347
358extern econf_err econf_getKeys(econf_file *kf, const char *group, size_t *length, char ***keys);
359
369extern econf_err econf_getIntValue(econf_file *kf, const char *group, const char *key, int32_t *result);
370
380extern econf_err econf_getInt64Value(econf_file *kf, const char *group, const char *key, int64_t *result);
381
391extern econf_err econf_getUIntValue(econf_file *kf, const char *group, const char *key, uint32_t *result);
392
402extern econf_err econf_getUInt64Value(econf_file *kf, const char *group, const char *key, uint64_t *result);
403
413extern econf_err econf_getFloatValue(econf_file *kf, const char *group, const char *key, float *result);
414
424extern econf_err econf_getDoubleValue(econf_file *kf, const char *group, const char *key, double *result);
425
435extern econf_err econf_getStringValue(econf_file *kf, const char *group, const char *key, char **result);
436
446extern econf_err econf_getBoolValue(econf_file *kf, const char *group, const char *key, bool *result);
447
459extern econf_err econf_getIntValueDef(econf_file *kf, const char *group, const char *key, int32_t *result, int32_t def);
460
472extern econf_err econf_getInt64ValueDef(econf_file *kf, const char *group, const char *key, int64_t *result, int64_t def);
473
485extern econf_err econf_getUIntValueDef(econf_file *kf, const char *group, const char *key, uint32_t *result, uint32_t def);
486
498extern econf_err econf_getUInt64ValueDef(econf_file *kf, const char *group, const char *key, uint64_t *result, uint64_t def);
499
511extern econf_err econf_getFloatValueDef(econf_file *kf, const char *group, const char *key, float *result, float def);
512
524extern econf_err econf_getDoubleValueDef(econf_file *kf, const char *group, const char *key, double *result, double def);
525
537extern econf_err econf_getStringValueDef(econf_file *kf, const char *group, const char *key, char **result, char *def);
538
550extern econf_err econf_getBoolValueDef(econf_file *kf, const char *group, const char *key, bool *result, bool def);
551
552/* --------------- */
553/* --- SETTERS --- */
554/* --------------- */
555
565extern econf_err econf_setIntValue(econf_file *kf, const char *group, const char *key, int32_t value);
566
576extern econf_err econf_setInt64Value(econf_file *kf, const char *group, const char *key, int64_t value);
577
587extern econf_err econf_setUIntValue(econf_file *kf, const char *group, const char *key, uint32_t value);
588
598extern econf_err econf_setUInt64Value(econf_file *kf, const char *group, const char *key, uint64_t value);
599
609extern econf_err econf_setFloatValue(econf_file *kf, const char *group, const char *key, float value);
610
620extern econf_err econf_setDoubleValue(econf_file *kf, const char *group, const char *key, double value);
621
631extern econf_err econf_setStringValue(econf_file *kf, const char *group, const char *key, const char *value);
632
642extern econf_err econf_setBoolValue(econf_file *kf, const char *group, const char *key, const char *value);
643
644/* --------------- */
645/* --- HELPERS --- */
646/* --------------- */
647
654extern const char *econf_errString (const econf_err error);
655
662extern void econf_errLocation (char **filename, uint64_t *line_nr);
663
670extern void econf_freeArray(char **array);
671
678extern void econf_freeFile(econf_file *key_file);
679
686extern void econf_requireOwner(uid_t owner);
687
694extern void econf_requireGroup(gid_t group);
695
703extern void econf_requirePermissions(mode_t file_perms, mode_t dir_perms);
704
711extern void econf_followSymlinks(bool allow);
712
719
720#ifdef __cplusplus
721}
722#endif
econf_err econf_newIniFile(econf_file **result)
Create a new econf_file object in IniFile format.
struct econf_file econf_file
Definition: libeconf.h:120
econf_err econf_setUInt64Value(econf_file *kf, const char *group, const char *key, uint64_t value)
Set uint64 value for given group/key.
econf_err econf_getBoolValueDef(econf_file *kf, const char *group, const char *key, bool *result, bool def)
Evaluating bool value for given group/key.
const char * econf_errString(const econf_err error)
Convert an econf_err type to a string.
econf_err econf_setDoubleValue(econf_file *kf, const char *group, const char *key, double value)
Set double value for given group/key.
void econf_followSymlinks(bool allow)
Allowing the parser to follow sym links (default: true).
void econf_set_comment_tag(econf_file *key_file, const char comment)
Set the comment character tag of the given econf_file object.
econf_err econf_mergeFiles(econf_file **merged_file, econf_file *usr_file, econf_file *etc_file)
Merge the contents of two key_files objects.
char econf_delimiter_tag(econf_file *key_file)
Returns the delimiter character of the given econf_file object.
econf_err econf_setInt64Value(econf_file *kf, const char *group, const char *key, int64_t value)
Set int64 value for given group/key.
econf_err econf_getStringValueDef(econf_file *kf, const char *group, const char *key, char **result, char *def)
Evaluating string value for given group/key.
econf_err
libeconf error codes
Definition: libeconf.h:40
@ ECONF_FILE_LIST_IS_NULL
Parsed file list is NULL.
Definition: libeconf.h:68
@ ECONF_NOMEM
Out of memory.
Definition: libeconf.h:46
@ ECONF_NOGROUP
Group not found.
Definition: libeconf.h:50
@ ECONF_WRONG_BOOLEAN_VALUE
Wrong boolean value (1/0 true/false yes/no)
Definition: libeconf.h:70
@ ECONF_TEXT_AFTER_SECTION
Text after section.
Definition: libeconf.h:66
@ ECONF_PARSE_ERROR
General syntax error in input file.
Definition: libeconf.h:58
@ ECONF_WRONG_FILE_PERMISSION
File has wrong file permission.
Definition: libeconf.h:78
@ ECONF_EMPTY_SECTION_NAME
Empty section name.
Definition: libeconf.h:64
@ ECONF_WRITEERROR
Error creating or writing to a file.
Definition: libeconf.h:56
@ ECONF_KEY_HAS_NULL_VALUE
Given key has NULL value.
Definition: libeconf.h:72
@ ECONF_MISSING_BRACKET
Missing closing section bracket.
Definition: libeconf.h:60
@ ECONF_ERROR_FILE_IS_SYM_LINK
File is a sym link which is not permitted.
Definition: libeconf.h:82
@ ECONF_WRONG_GROUP
File has wrong group.
Definition: libeconf.h:76
@ ECONF_WRONG_DIR_PERMISSION
File has wrong dir permission.
Definition: libeconf.h:80
@ ECONF_NOKEY
Key not found.
Definition: libeconf.h:52
@ ECONF_MISSING_DELIMITER
Missing delimiter.
Definition: libeconf.h:62
@ ECONF_NOFILE
Config file not found.
Definition: libeconf.h:48
@ ECONF_WRONG_OWNER
File has wrong owner.
Definition: libeconf.h:74
@ ECONF_ERROR
Generic Error.
Definition: libeconf.h:44
@ ECONF_EMPTYKEY
Key is NULL or has empty value.
Definition: libeconf.h:54
@ ECONF_SUCCESS
General purpose success code.
Definition: libeconf.h:42
void econf_requirePermissions(mode_t file_perms, mode_t dir_perms)
All parsed file have to have these file and directory permissions.
econf_err econf_setBoolValue(econf_file *kf, const char *group, const char *key, const char *value)
Set bool value for given group/key.
econf_err econf_getUInt64Value(econf_file *kf, const char *group, const char *key, uint64_t *result)
Evaluating uint64 value for given group/key.
econf_err econf_setUIntValue(econf_file *kf, const char *group, const char *key, uint32_t value)
Set uint32 value for given group/key.
void econf_requireGroup(gid_t group)
All parsed files require this group permission.
econf_err econf_readDirsHistory(econf_file ***key_files, size_t *size, const char *usr_conf_dir, const char *etc_conf_dir, const char *project_name, const char *config_suffix, const char *delim, const char *comment)
Evaluating key/values for every given configuration files in two different directories (normally in /...
econf_err econf_getFloatValue(econf_file *kf, const char *group, const char *key, float *result)
Evaluating float value for given group/key.
char econf_comment_tag(econf_file *key_file)
Returns the comment character tag of the given econf_file object.
econf_err econf_writeFile(econf_file *key_file, const char *save_to_dir, const char *file_name)
Write content of a econf_file struct to specified location.
econf_err econf_getBoolValue(econf_file *kf, const char *group, const char *key, bool *result)
Evaluating bool value for given group/key.
econf_err econf_readDirs(econf_file **key_file, const char *usr_conf_dir, const char *etc_conf_dir, const char *project_name, const char *config_suffix, const char *delim, const char *comment)
Evaluating key/values of a given configuration by reading and merging all needed/available files in t...
econf_err econf_setStringValue(econf_file *kf, const char *group, const char *key, const char *value)
Set string value for given group/key.
econf_err econf_getInt64Value(econf_file *kf, const char *group, const char *key, int64_t *result)
Evaluating int64 value for given group/key.
econf_err econf_getUInt64ValueDef(econf_file *kf, const char *group, const char *key, uint64_t *result, uint64_t def)
Evaluating uint64 value for given group/key.
econf_err econf_setFloatValue(econf_file *kf, const char *group, const char *key, float value)
Set float value for given group/key.
econf_err econf_newKeyFile(econf_file **result, char delimiter, char comment)
Create a new econf_file object.
econf_err econf_getDoubleValueDef(econf_file *kf, const char *group, const char *key, double *result, double def)
Evaluating double value for given group/key.
econf_err econf_setIntValue(econf_file *kf, const char *group, const char *key, int32_t value)
Set int32 value for given group/key.
econf_err econf_readFile(econf_file **result, const char *file_name, const char *delim, const char *comment)
Process the file of the given file_name and save its contents into key_file object.
void econf_set_delimiter_tag(econf_file *key_file, const char delimiter)
Set the delimiter character of the given econf_file object.
econf_err econf_getGroups(econf_file *kf, size_t *length, char ***groups)
Evaluating all group entries.
econf_err econf_getUIntValueDef(econf_file *kf, const char *group, const char *key, uint32_t *result, uint32_t def)
Evaluating uint32 value for given group/key.
econf_err econf_getFloatValueDef(econf_file *kf, const char *group, const char *key, float *result, float def)
Evaluating float value for given group/key.
void econf_requireOwner(uid_t owner)
All parsed files require this user permission.
econf_err econf_getStringValue(econf_file *kf, const char *group, const char *key, char **result)
Evaluating string value for given group/key.
void econf_reset_security_settings(void)
Reset all UID, GID, permissions,... restrictions for parsed files/dirs.
econf_err econf_getIntValue(econf_file *kf, const char *group, const char *key, int32_t *result)
Evaluating int32 value for given group/key.
econf_err econf_getDoubleValue(econf_file *kf, const char *group, const char *key, double *result)
Evaluating double value for given group/key.
void econf_freeArray(char **array)
Free an array of type char** created by econf_getGroups() or econf_getKeys().
void econf_errLocation(char **filename, uint64_t *line_nr)
Info about where the error has happened.
econf_err econf_getInt64ValueDef(econf_file *kf, const char *group, const char *key, int64_t *result, int64_t def)
Evaluating int64 value for given group/key.
char * econf_getPath(econf_file *kf)
Evaluating path name.
void econf_freeFile(econf_file *key_file)
Free memory allocated by e.g.
econf_err econf_getIntValueDef(econf_file *kf, const char *group, const char *key, int32_t *result, int32_t def)
Evaluating int32 value for given group/key.
econf_err econf_getUIntValue(econf_file *kf, const char *group, const char *key, uint32_t *result)
Evaluating uint32 value for given group/key.
econf_err econf_getKeys(econf_file *kf, const char *group, size_t *length, char ***keys)
Evaluating all keys.