libeconf 0.7.6
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#include <sys/types.h>
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
93
94typedef enum econf_err econf_err;
95
106#define econf_setValue(kf, group, key, value) (( \
107 _Generic((value), \
108 int: econf_setIntValue, \
109 long: econf_setInt64Value, \
110 unsigned int: econf_setUIntValue, \
111 unsigned long: econf_setUInt64Value, \
112 float: econf_setFloatValue, \
113 double: econf_setDoubleValue, \
114 char*: econf_setStringValue, void*: econf_setStringValue)) \
115(kf, group, key, value))
116
123#define econf_free(value) (( \
124 _Generic((value), \
125 econf_file*: econf_freeFile , \
126 char**: econf_freeArray)) \
127(value))
128
129typedef struct econf_file econf_file;
130
155extern econf_err econf_readFile(econf_file **result, const char *file_name,
156 const char *delim, const char *comment);
157
158
198extern econf_err econf_readFileWithCallback(econf_file **result, const char *file_name,
199 const char *delim, const char *comment,
200 bool (*callback)(const char *filename, const void *data),
201 const void *callback_data);
202
232 econf_file *usr_file, econf_file *etc_file);
233
234
333 const char *project,
334 const char *usr_subdir,
335 const char *config_name,
336 const char *config_suffix,
337 const char *delim,
338 const char *comment);
339
452 const char *project,
453 const char *usr_subdir,
454 const char *config_name,
455 const char *config_suffix,
456 const char *delim,
457 const char *comment,
458 bool (*callback)(const char *filename, const void *data),
459 const void *callback_data);
460
461
496extern econf_err __attribute__ ((deprecated("Use the econf_readConfig/econf_readConfigWithCallback instead")))
498 const char *usr_conf_dir,
499 const char *etc_conf_dir,
500 const char *config_name,
501 const char *config_suffix,
502 const char *delim,
503 const char *comment);
504
551extern econf_err __attribute__ ((deprecated("Use the econf_readConfig/econf_readConfigWithCallback instead")))
553 const char *usr_conf_dir,
554 const char *etc_conf_dir,
555 const char *config_name,
556 const char *config_suffix,
557 const char *delim,
558 const char *comment,
559 bool (*callback)(const char *filename, const void *data),
560 const void *callback_data);
561
581 size_t *size,
582 const char *usr_conf_dir,
583 const char *etc_conf_dir,
584 const char *config_name,
585 const char *config_suffix,
586 const char *delim,
587 const char *comment);
588
613 size_t *size,
614 const char *usr_conf_dir,
615 const char *etc_conf_dir,
616 const char *config_name,
617 const char *config_suffix,
618 const char *delim,
619 const char *comment,
620 bool (*callback)(const char *filename, const void *data),
621 const void *callback_data);
622
631extern econf_err econf_newKeyFile(econf_file **result, char delimiter, char comment);
632
688extern econf_err econf_newKeyFile_with_options(econf_file **result, const char *options);
689
698
706extern char econf_comment_tag(econf_file *key_file);
707
715extern char econf_delimiter_tag(econf_file *key_file);
716
724extern void econf_set_comment_tag(econf_file *key_file, const char comment);
725
733extern void econf_set_delimiter_tag(econf_file *key_file, const char delimiter);
734
743extern econf_err econf_writeFile(econf_file *key_file, const char *save_to_dir,
744 const char *file_name);
745
746/* --------------- */
747/* --- GETTERS --- */
748/* --------------- */
749
757extern char *econf_getPath(econf_file *kf);
758
767extern econf_err econf_getGroups(econf_file *kf, size_t *length, char ***groups);
768
779extern econf_err econf_getKeys(econf_file *kf, const char *group, size_t *length, char ***keys);
780
790extern econf_err econf_getIntValue(econf_file *kf, const char *group, const char *key, int32_t *result);
791
801extern econf_err econf_getInt64Value(econf_file *kf, const char *group, const char *key, int64_t *result);
802
812extern econf_err econf_getUIntValue(econf_file *kf, const char *group, const char *key, uint32_t *result);
813
823extern econf_err econf_getUInt64Value(econf_file *kf, const char *group, const char *key, uint64_t *result);
824
834extern econf_err econf_getFloatValue(econf_file *kf, const char *group, const char *key, float *result);
835
845extern econf_err econf_getDoubleValue(econf_file *kf, const char *group, const char *key, double *result);
846
856extern econf_err econf_getStringValue(econf_file *kf, const char *group, const char *key, char **result);
857
867extern econf_err econf_getBoolValue(econf_file *kf, const char *group, const char *key, bool *result);
868
880extern econf_err econf_getIntValueDef(econf_file *kf, const char *group, const char *key, int32_t *result, int32_t def);
881
893extern econf_err econf_getInt64ValueDef(econf_file *kf, const char *group, const char *key, int64_t *result, int64_t def);
894
906extern econf_err econf_getUIntValueDef(econf_file *kf, const char *group, const char *key, uint32_t *result, uint32_t def);
907
919extern econf_err econf_getUInt64ValueDef(econf_file *kf, const char *group, const char *key, uint64_t *result, uint64_t def);
920
932extern econf_err econf_getFloatValueDef(econf_file *kf, const char *group, const char *key, float *result, float def);
933
945extern econf_err econf_getDoubleValueDef(econf_file *kf, const char *group, const char *key, double *result, double def);
946
958extern econf_err econf_getStringValueDef(econf_file *kf, const char *group, const char *key, char **result, char *def);
959
971extern econf_err econf_getBoolValueDef(econf_file *kf, const char *group, const char *key, bool *result, bool def);
972
973/* --------------- */
974/* --- SETTERS --- */
975/* --------------- */
976
986extern econf_err econf_setIntValue(econf_file *kf, const char *group, const char *key, int32_t value);
987
997extern econf_err econf_setInt64Value(econf_file *kf, const char *group, const char *key, int64_t value);
998
1008extern econf_err econf_setUIntValue(econf_file *kf, const char *group, const char *key, uint32_t value);
1009
1019extern econf_err econf_setUInt64Value(econf_file *kf, const char *group, const char *key, uint64_t value);
1020
1030extern econf_err econf_setFloatValue(econf_file *kf, const char *group, const char *key, float value);
1031
1041extern econf_err econf_setDoubleValue(econf_file *kf, const char *group, const char *key, double value);
1042
1052extern econf_err econf_setStringValue(econf_file *kf, const char *group, const char *key, const char *value);
1053
1063extern econf_err econf_setBoolValue(econf_file *kf, const char *group, const char *key, const char *value);
1064
1065/* --------------- */
1066/* --- HELPERS --- */
1067/* --------------- */
1068
1075extern const char *econf_errString (const econf_err error);
1076
1083extern void econf_errLocation (char **filename, uint64_t *line_nr);
1084
1091extern char **econf_freeArray(char **array);
1092
1093/* helper so that __attribute__((cleanup(econf_freeArrayp)) may be used */
1094static __inline__ void econf_freeArrayp(char ***array) {
1095 if (*array)
1096 *array = econf_freeArray(*array);
1097}
1098
1110
1111/* helper so that __attribute__((cleanup(econf_freeFilep)) may be used */
1112static __inline__ void econf_freeFilep(econf_file **key_file) {
1113 if (*key_file)
1114 *key_file = econf_freeFile(*key_file);
1115}
1116
1125extern void __attribute__ ((deprecated("use callback in econf_readFileWithCallback or econf_readConfigWithCallback instead")))
1127
1137extern void __attribute__ ((deprecated("use callback in econf_readFileWithCallback or econf_readConfigWithCallback instead")))
1139
1149extern void __attribute__ ((deprecated("use callback in econf_readFileWithCallback or econf_readConfigWithCallback instead")))
1150econf_requirePermissions(mode_t file_perms, mode_t dir_perms);
1151
1160extern void __attribute__ ((deprecated("use callback in econf_readFileWithCallback or econf_readConfigWithCallback instead")))
1162
1171extern void __attribute__ ((deprecated("use callback in econf_readFileWithCallback or econf_readConfigWithCallback instead")))
1173
1191extern econf_err __attribute__ ((deprecated("Is not thread-safe. Use econf_newKeyFile_with_options instead")))
1192econf_set_conf_dirs(const char **dir_postfix_list);
1193
1194#ifdef __cplusplus
1195}
1196#endif
econf_err econf_set_conf_dirs(const char **dir_postfix_list)
Set a list of directory structures (with order) which describes the directories in which the files ha...
econf_err econf_newIniFile(econf_file **result)
Create a new econf_file object in IniFile format.
struct econf_file econf_file
Definition libeconf.h:129
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_readConfig(econf_file **key_file, const char *project, const char *usr_subdir, const char *config_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 from...
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:41
@ ECONF_FILE_LIST_IS_NULL
Parsed file list is NULL.
Definition libeconf.h:69
@ ECONF_VALUE_CONVERSION_ERROR
Value cannot be converted.
Definition libeconf.h:91
@ ECONF_NOMEM
Out of memory.
Definition libeconf.h:47
@ ECONF_NOGROUP
Group not found.
Definition libeconf.h:51
@ ECONF_WRONG_BOOLEAN_VALUE
Wrong boolean value (1/0 true/false yes/no)
Definition libeconf.h:71
@ ECONF_TEXT_AFTER_SECTION
Text after section.
Definition libeconf.h:67
@ ECONF_PARSING_CALLBACK_FAILED
User defined parsing callback has failed.
Definition libeconf.h:85
@ ECONF_PARSE_ERROR
General syntax error in input file.
Definition libeconf.h:59
@ ECONF_WRONG_FILE_PERMISSION
File has wrong file permissions.
Definition libeconf.h:79
@ ECONF_ARGUMENT_IS_NULL_VALUE
Given argument is NULL.
Definition libeconf.h:87
@ ECONF_OPTION_NOT_FOUND
Given option not found.
Definition libeconf.h:89
@ ECONF_EMPTY_SECTION_NAME
Empty section name.
Definition libeconf.h:65
@ ECONF_WRITEERROR
Error creating or writing to a file.
Definition libeconf.h:57
@ ECONF_KEY_HAS_NULL_VALUE
Given key has NULL value.
Definition libeconf.h:73
@ ECONF_MISSING_BRACKET
Missing closing section bracket.
Definition libeconf.h:61
@ ECONF_ERROR_FILE_IS_SYM_LINK
File is a sym link which is not permitted.
Definition libeconf.h:83
@ ECONF_WRONG_GROUP
File has wrong group.
Definition libeconf.h:77
@ ECONF_WRONG_DIR_PERMISSION
File has wrong dir permission.
Definition libeconf.h:81
@ ECONF_NOKEY
Key not found.
Definition libeconf.h:53
@ ECONF_MISSING_DELIMITER
Missing delimiter.
Definition libeconf.h:63
@ ECONF_NOFILE
Config file not found.
Definition libeconf.h:49
@ ECONF_WRONG_OWNER
File has wrong owner.
Definition libeconf.h:75
@ ECONF_ERROR
Generic Error.
Definition libeconf.h:45
@ ECONF_EMPTYKEY
Key is NULL or has empty value.
Definition libeconf.h:55
@ ECONF_SUCCESS
General purpose success code.
Definition libeconf.h:43
void econf_requirePermissions(mode_t file_perms, mode_t dir_perms)
All parsed file have to have these file and directory permissions.
econf_file * econf_freeFile(econf_file *key_file)
Free memory allocated and returned by econf_readFile(), econf_readFileWithCallback,...
econf_err econf_readDirsHistoryWithCallback(econf_file ***key_files, size_t *size, const char *usr_conf_dir, const char *etc_conf_dir, const char *config_name, const char *config_suffix, const char *delim, const char *comment, bool(*callback)(const char *filename, const void *data), const void *callback_data)
Evaluating key/values for every given configuration files in two different directories (normally in /...
econf_err econf_setBoolValue(econf_file *kf, const char *group, const char *key, const char *value)
Set bool value for given group/key.
static __inline__ void econf_freeArrayp(char ***array)
Definition libeconf.h:1094
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_readDirs(econf_file **key_file, const char *usr_conf_dir, const char *etc_conf_dir, const char *config_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_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_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 an econf_file struct to specified location.
econf_err econf_readDirsHistory(econf_file ***key_files, size_t *size, const char *usr_conf_dir, const char *etc_conf_dir, const char *config_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_newKeyFile_with_options(econf_file **result, const char *options)
Create a new econf_file object with special options.
econf_err econf_readFileWithCallback(econf_file **result, const char *file_name, const char *delim, const char *comment, bool(*callback)(const char *filename, const void *data), const void *callback_data)
Process the file of the given file_name and save its contents into key_file object.
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_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_readDirsWithCallback(econf_file **key_file, const char *usr_conf_dir, const char *etc_conf_dir, const char *config_name, const char *config_suffix, const char *delim, const char *comment, bool(*callback)(const char *filename, const void *data), const void *callback_data)
Evaluating key/values for every given configuration files in two different directories (normally in /...
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.
static __inline__ void econf_freeFilep(econf_file **key_file)
Definition libeconf.h:1112
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.
char ** econf_freeArray(char **array)
Free an array of type char** created by econf_getGroups() or econf_getKeys().
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_readConfigWithCallback(econf_file **key_file, const char *project, const char *usr_subdir, const char *config_name, const char *config_suffix, const char *delim, const char *comment, bool(*callback)(const char *filename, const void *data), const void *callback_data)
Evaluating key/values of a given configuration by reading and merging all needed/available files from...
econf_err econf_getDoubleValue(econf_file *kf, const char *group, const char *key, double *result)
Evaluating double value for given group/key.
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.
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.