libini_config  0.5.0
 All Data Structures Functions Variables Enumerations Enumerator Modules Pages
ini_configobj.h
1 /*
2  INI LIBRARY
3 
4  Header file for the ini configuration interface.
5  THIS IS THE PREFERRED INTERFACE TO USE.
6 
7  Copyright (C) Dmitri Pal <dpal@redhat.com> 2010 - 2012
8 
9  INI Library is free software: you can redistribute it and/or modify
10  it under the terms of the GNU Lesser General Public License as published by
11  the Free Software Foundation, either version 3 of the License, or
12  (at your option) any later version.
13 
14  INI Library is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  GNU Lesser General Public License for more details.
18 
19  You should have received a copy of the GNU Lesser General Public License
20  along with INI Library. If not, see <http://www.gnu.org/licenses/>.
21 */
22 
23 
24 #ifndef INI_CONFIGOBJ_H
25 #define INI_CONFIGOBJ_H
26 
27 #include <sys/types.h>
28 #include <sys/stat.h>
29 #include <unistd.h>
30 #include <limits.h>
31 #include <stdio.h>
32 #include "simplebuffer.h"
33 #include "ini_valueobj.h"
34 
148 };
149 
164 enum ERR_LEVEL {
168 };
169 
182 enum ERR_PARSE {
203 };
204 
218 #define INI_META_NONE 0
219 
220 #define INI_META_STATS 1
221 
239 #define INI_ACCESS_CHECK_MODE 0x00000001
240 
247 #define INI_ACCESS_CHECK_UID 0x00000002
248 
255 #define INI_ACCESS_CHECK_GID 0x00000004
256 
279 #define INI_MV1S_OVERWRITE 0x0000
280 
281 #define INI_MV1S_ERROR 0x0001
282 
283 #define INI_MV1S_PRESERVE 0x0002
284 
285 #define INI_MV1S_ALLOW 0x0003
286 
287 #define INI_MV1S_DETECT 0x0004
288 
306 #define INI_MV2S_OVERWRITE 0x0000
307 
308 #define INI_MV2S_ERROR 0x0010
309 
310 #define INI_MV2S_PRESERVE 0x0020
311 
312 #define INI_MV2S_ALLOW 0x0030
313 
314 #define INI_MV2S_DETECT 0x0040
315 
332 #define INI_MS_MERGE 0x0000
333 
334 #define INI_MS_ERROR 0x0100
335 
336 #define INI_MS_OVERWRITE 0x0200
337 
338 #define INI_MS_PRESERVE 0x0300
339 
340 #define INI_MS_DETECT 0x0400
341 
359 #define INI_PARSE_NOWRAP 0x0001
360 
361 #define INI_PARSE_NOSPACE 0x0002
362 
363 #define INI_PARSE_NOTAB 0x0004
364 
365 #define INI_PARSE_NO_C_COMMENTS 0x0008
366 
390 enum INI_GET {
394 };
395 
410 struct access_check {
411  uint32_t flags;
417  uid_t uid;
418  gid_t gid;
419  mode_t mode;
420  mode_t mask;
425 };
426 
428 enum augmode {
432 };
433 
444 #define INI_DEFAULT_SECTION "default"
445 
452 struct ini_cfgobj;
453 struct ini_cfgfile;
454 
458 struct ini_parse_error;
459 
460 
492 int ini_config_create(struct ini_cfgobj **ini_config);
493 
502 void ini_config_destroy(struct ini_cfgobj *ini_config);
503 
513 void ini_config_clean_state(struct ini_cfgobj *ini_config);
514 
540 int ini_config_file_open(const char *filename,
541  uint32_t metadata_flags,
542  struct ini_cfgfile **file_ctx);
543 
565 int ini_config_file_from_mem(void *data_buf,
566  uint32_t data_len,
567  struct ini_cfgfile **file_ctx);
568 
578 void ini_config_file_close(struct ini_cfgfile *file_ctx);
579 
580 
595 int ini_config_file_reopen(struct ini_cfgfile *file_ctx_in,
596  struct ini_cfgfile **file_ctx_out);
597 
598 
607 void ini_config_file_destroy(struct ini_cfgfile *file_ctx);
608 
658 int ini_config_file_backup(struct ini_cfgfile *file_ctx,
659  const char *backup_dir,
660  const char *backup_tpl,
661  struct access_check *backup_access,
662  unsigned max_num);
663 
683 int ini_config_change_access(struct ini_cfgfile *file_ctx,
684  struct access_check *new_access);
685 
694 int ini_config_save(struct ini_cfgfile *file_ctx,
695  struct access_check *new_access,
696  struct ini_cfgobj *ini_config);
697 
698 
699 /* Save configuration in a file using existing context but with a new name */
731 int ini_config_save_as(struct ini_cfgfile *file_ctx,
732  const char *filename,
733  struct access_check *new_access,
734  struct ini_cfgobj *ini_config);
735 
736 
737 
749 enum index_utf_t ini_config_get_bom(struct ini_cfgfile *file_ctx);
750 
766 int ini_config_set_bom(struct ini_cfgfile *file_ctx, enum index_utf_t bom);
767 
768 
780 unsigned ini_config_error_count(struct ini_cfgobj *ini_config);
781 
798 int ini_config_get_errors(struct ini_cfgobj *ini_config,
799  char ***errors);
800 
810 void ini_config_free_errors(char **errors);
811 
823 void ini_config_print_errors(FILE *file, char **error_list);
824 
835 const char *ini_config_get_filename(struct ini_cfgfile *file_ctx);
836 
848 const struct stat *ini_config_get_stat(struct ini_cfgfile *file_ctx);
849 
850 
851 
860 void ini_config_file_print(struct ini_cfgfile *file_ctx);
861 
886 int ini_config_access_check(struct ini_cfgfile *file_ctx,
887  uint32_t flags,
888  uid_t uid,
889  gid_t gid,
890  mode_t mode,
891  mode_t mask);
892 
924 int ini_config_changed(struct ini_cfgfile *file_ctx1,
925  struct ini_cfgfile *file_ctx2,
926  int *changed);
927 
950 int ini_config_parse(struct ini_cfgfile *file_ctx,
951  int error_level,
952  uint32_t collision_flags,
953  uint32_t parse_flags,
954  struct ini_cfgobj *ini_config);
955 
969 int ini_config_copy(struct ini_cfgobj *ini_config,
970  struct ini_cfgobj **ini_new);
971 
997 int ini_config_merge(struct ini_cfgobj *first,
998  struct ini_cfgobj *second,
999  uint32_t collision_flags,
1000  struct ini_cfgobj **result);
1001 
1002 
1064 int ini_config_augment(struct ini_cfgobj *base_cfg,
1065  const char *path,
1066  const char *patterns[],
1067  const char *sections[],
1068  struct access_check *check_perm,
1069  int error_level,
1070  uint32_t collision_flags,
1071  uint32_t parse_flags,
1072  uint32_t merge_flags,
1073  struct ini_cfgobj **result_cfg,
1074  struct ref_array **error_list,
1075  struct ref_array **success_list);
1076 
1090 int ini_config_set_wrap(struct ini_cfgobj *ini_config,
1091  uint32_t boundary);
1092 
1107 int ini_config_serialize(struct ini_cfgobj *ini_config,
1108  struct simplebuffer *sbobj);
1109 
1110 
1111 /* Functions that add, modify or delete sections and values in
1112  * the configuration object can be found in section \ref ini_mod.
1113  */
1114 
1151 char **ini_get_section_list(struct ini_cfgobj *ini_config,
1152  int *size,
1153  int *error);
1154 
1164 void ini_free_section_list(char **section_list);
1165 
1186 char **ini_get_attribute_list(struct ini_cfgobj *ini_config,
1187  const char *section,
1188  int *size,
1189  int *error);
1190 
1200 void ini_free_attribute_list(char **attr_list);
1201 
1243 int ini_get_config_valueobj(const char *section,
1244  const char *name,
1245  struct ini_cfgobj *ini_config,
1246  int mode,
1247  struct value_obj **vo);
1248 
1249 
1250 
1291 int ini_get_int_config_value(struct value_obj *vo,
1292  int strict,
1293  int def,
1294  int *error);
1295 
1337 unsigned ini_get_unsigned_config_value(struct value_obj *vo,
1338  int strict,
1339  unsigned def,
1340  int *error);
1341 
1383 long ini_get_long_config_value(struct value_obj *vo,
1384  int strict,
1385  long def,
1386  int *error);
1387 
1429 unsigned long ini_get_ulong_config_value(struct value_obj *vo,
1430  int strict,
1431  unsigned long def,
1432  int *error);
1433 
1434 
1475 int32_t ini_get_int32_config_value(struct value_obj *vo,
1476  int strict,
1477  int32_t def,
1478  int *error);
1479 
1520 uint32_t ini_get_uint32_config_value(struct value_obj *vo,
1521  int strict,
1522  uint32_t def,
1523  int *error);
1524 
1565 int64_t ini_get_int64_config_value(struct value_obj *vo,
1566  int strict,
1567  int64_t def,
1568  int *error);
1569 
1610 uint64_t ini_get_uint64_config_value(struct value_obj *vo,
1611  int strict,
1612  uint64_t def,
1613  int *error);
1614 
1653 double ini_get_double_config_value(struct value_obj *vo,
1654  int strict,
1655  double def,
1656  int *error);
1657 
1691 unsigned char ini_get_bool_config_value(struct value_obj *vo,
1692  unsigned char def,
1693  int *error);
1694 
1719 char *ini_get_string_config_value(struct value_obj *vo,
1720  int *error);
1743 const char *ini_get_const_string_config_value(struct value_obj *vo,
1744  int *error);
1745 
1795 char *ini_get_bin_config_value(struct value_obj *vo,
1796  int *length,
1797  int *error);
1798 
1807 void ini_free_bin_config_value(char *bin);
1808 
1863 char **ini_get_string_config_array(struct value_obj *vo,
1864  const char *sep,
1865  int *size,
1866  int *error);
1867 
1922 char **ini_get_raw_string_config_array(struct value_obj *vo,
1923  const char *sep,
1924  int *size,
1925  int *error);
1926 
1969 long *ini_get_long_config_array(struct value_obj *vo,
1970  int *size,
1971  int *error);
1972 
2014 double *ini_get_double_config_array(struct value_obj *vo,
2015  int *size,
2016  int *error);
2017 
2027 void ini_free_string_config_array(char **str_config);
2028 
2037 void ini_free_long_config_array(long *array);
2046 void ini_free_double_config_array(double *array);
2047 
2052 #endif
Definition: ini_configobj.h:183
Definition: ini_configobj.h:199
int ini_get_config_valueobj(const char *section, const char *name, struct ini_cfgobj *ini_config, int mode, struct value_obj **vo)
Retrieve a value object form the configuration.
void ini_free_long_config_array(long *array)
Free array of long values.
void ini_config_file_print(struct ini_cfgfile *file_ctx)
Print file context.
Definition: ini_configobj.h:192
void ini_free_attribute_list(char **attr_list)
Free list of attributes.
mode_t mode
Definition: ini_configobj.h:419
ERR_LEVEL
Definition: ini_configobj.h:164
void ini_config_free_errors(char **errors)
Free array of parsing errors.
char ** ini_get_string_config_array(struct value_obj *vo, const char *sep, int *size, int *error)
Convert value to an array of strings.
Definition: ini_configobj.h:194
Definition: ini_configobj.h:167
Definition: ini_configobj.h:147
INI_GET
Definition: ini_configobj.h:390
int ini_config_save_as(struct ini_cfgfile *file_ctx, const char *filename, struct access_check *new_access, struct ini_cfgobj *ini_config)
Save configuration with a new name.
Definition: ini_configobj.h:190
const char * ini_config_get_filename(struct ini_cfgfile *file_ctx)
Get the fully resolved file name.
Definition: ini_configobj.h:430
Definition: ini_configobj.h:392
void ini_free_section_list(char **section_list)
Free list of sections.
uint32_t ini_get_uint32_config_value(struct value_obj *vo, int strict, uint32_t def, int *error)
Convert value to uint32_t number.
int ini_config_file_backup(struct ini_cfgfile *file_ctx, const char *backup_dir, const char *backup_tpl, struct access_check *backup_access, unsigned max_num)
Save configuration in a backup configuration file.
unsigned ini_config_error_count(struct ini_cfgobj *ini_config)
Check parsing errors count.
void ini_config_destroy(struct ini_cfgobj *ini_config)
Destroy a configuration object.
Definition: ini_configobj.h:198
int ini_config_changed(struct ini_cfgfile *file_ctx1, struct ini_cfgfile *file_ctx2, int *changed)
Check if file has changed.
Definition: ini_configobj.h:393
Definition: ini_configobj.h:184
long * ini_get_long_config_array(struct value_obj *vo, int *size, int *error)
Convert value to an array of long values.
int ini_config_file_reopen(struct ini_cfgfile *file_ctx_in, struct ini_cfgfile **file_ctx_out)
Reopen the configuration file.
long ini_get_long_config_value(struct value_obj *vo, int strict, long def, int *error)
Convert value to long number.
Definition: ini_configobj.h:187
unsigned ini_get_unsigned_config_value(struct value_obj *vo, int strict, unsigned def, int *error)
Convert value object to a unsigned number.
char ** ini_get_raw_string_config_array(struct value_obj *vo, const char *sep, int *size, int *error)
Convert value to an array of strings.
void ini_free_bin_config_value(char *bin)
Free binary buffer.
Definition: ini_configobj.h:410
int ini_config_get_errors(struct ini_cfgobj *ini_config, char ***errors)
Get array of parsing errors.
uid_t uid
Definition: ini_configobj.h:417
void ini_config_clean_state(struct ini_cfgobj *ini_config)
Flush cached search data.
Definition: ini_configobj.h:391
char * ini_get_string_config_value(struct value_obj *vo, int *error)
Get the copy of string stored in the configuration value.
Definition: ini_configobj.h:165
uint64_t ini_get_uint64_config_value(struct value_obj *vo, int strict, uint64_t def, int *error)
Convert value to integer number.
int ini_config_merge(struct ini_cfgobj *first, struct ini_cfgobj *second, uint32_t collision_flags, struct ini_cfgobj **result)
Merge two configuration objects.
gid_t gid
Definition: ini_configobj.h:418
Definition: ini_configobj.h:191
int ini_config_set_wrap(struct ini_cfgobj *ini_config, uint32_t boundary)
Set the folding boundary.
Definition: ini_configobj.h:431
Definition: ini_configobj.h:144
Definition: ini_configobj.h:195
double * ini_get_double_config_array(struct value_obj *vo, int *size, int *error)
Convert value to an array of floating point values.
Definition: ini_configobj.h:189
Definition: ini_configobj.h:142
Definition: ini_configobj.h:188
enum index_utf_t ini_config_get_bom(struct ini_cfgfile *file_ctx)
Return the encoding indicator.
index_utf_t
Definition: ini_configobj.h:141
int ini_get_int_config_value(struct value_obj *vo, int strict, int def, int *error)
Convert value to integer number.
Definition: ini_configobj.h:201
void ini_config_file_close(struct ini_cfgfile *file_ctx)
Close configuration file after parsing.
Definition: ini_configobj.h:146
Definition: ini_configobj.h:143
void ini_config_print_errors(FILE *file, char **error_list)
Print errors to a file.
int ini_config_change_access(struct ini_cfgfile *file_ctx, struct access_check *new_access)
Change permissions and ownership of the file.
int ini_config_set_bom(struct ini_cfgfile *file_ctx, enum index_utf_t bom)
Set the encoding indicator.
unsigned char ini_get_bool_config_value(struct value_obj *vo, unsigned char def, int *error)
Convert value into a logical value.
char ** ini_get_section_list(struct ini_cfgobj *ini_config, int *size, int *error)
Get list of sections.
const char * ini_get_const_string_config_value(struct value_obj *vo, int *error)
Get the string stored in the configuration value.
ERR_PARSE
Definition: ini_configobj.h:182
Definition: ini_configobj.h:145
void ini_free_double_config_array(double *array)
Free array of floating pointer values.
int ini_config_copy(struct ini_cfgobj *ini_config, struct ini_cfgobj **ini_new)
Create a copy of the configuration object.
Definition: ini_configobj.h:197
int ini_config_access_check(struct ini_cfgfile *file_ctx, uint32_t flags, uid_t uid, gid_t gid, mode_t mode, mode_t mask)
Check file properties.
void ini_config_file_destroy(struct ini_cfgfile *file_ctx)
Close configuration file and free all data.
Definition: ini_configobj.h:202
char ** ini_get_attribute_list(struct ini_cfgobj *ini_config, const char *section, int *size, int *error)
Get list of attributes.
Definition: ini_configobj.h:186
int32_t ini_get_int32_config_value(struct value_obj *vo, int strict, int32_t def, int *error)
Convert value to int32_t number.
int ini_config_save(struct ini_cfgfile *file_ctx, struct access_check *new_access, struct ini_cfgobj *ini_config)
Save configuration in a file.
Definition: ini_configobj.h:429
int ini_config_augment(struct ini_cfgobj *base_cfg, const char *path, const char *patterns[], const char *sections[], struct access_check *check_perm, int error_level, uint32_t collision_flags, uint32_t parse_flags, uint32_t merge_flags, struct ini_cfgobj **result_cfg, struct ref_array **error_list, struct ref_array **success_list)
Augment configuration.
char * ini_get_bin_config_value(struct value_obj *vo, int *length, int *error)
Convert value into a binary sequence.
int ini_config_create(struct ini_cfgobj **ini_config)
Create a configuration object.
int ini_config_file_open(const char *filename, uint32_t metadata_flags, struct ini_cfgfile **file_ctx)
Create a configuration file object.
int ini_config_serialize(struct ini_cfgobj *ini_config, struct simplebuffer *sbobj)
Serialize configuration object.
int64_t ini_get_int64_config_value(struct value_obj *vo, int strict, int64_t def, int *error)
Convert value to integer number.
Definition: ini_configobj.h:166
mode_t mask
Definition: ini_configobj.h:420
double ini_get_double_config_value(struct value_obj *vo, int strict, double def, int *error)
Convert value to floating point number.
int ini_config_parse(struct ini_cfgfile *file_ctx, int error_level, uint32_t collision_flags, uint32_t parse_flags, struct ini_cfgobj *ini_config)
Parse the file and populate a configuration object.
uint32_t flags
Definition: ini_configobj.h:411
int ini_config_file_from_mem(void *data_buf, uint32_t data_len, struct ini_cfgfile **file_ctx)
Create a configuration file object using memory buffer.
unsigned long ini_get_ulong_config_value(struct value_obj *vo, int strict, unsigned long def, int *error)
Convert value to unsigned long number.
const struct stat * ini_config_get_stat(struct ini_cfgfile *file_ctx)
Get pointer to collected stat data.
void ini_free_string_config_array(char **str_config)
Free array of string values.
augmode
Definition: ini_configobj.h:428