ini_configobj.h

/*
    INI LIBRARY

    Header file for the ini collection object.

    Copyright (C) Dmitri Pal <dpal@redhat.com> 2010

    INI Library is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    INI Library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with INI Library.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef INI_CONFIGOBJ_H
#define INI_CONFIGOBJ_H

#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <limits.h>
#include <stdio.h>
#include "simplebuffer.h"


#define INI_STOP_ON_ANY     0

#define INI_STOP_ON_NONE    1

#define INI_STOP_ON_ERROR   2

#define ERR_LONGDATA        1

#define ERR_NOCLOSESEC      2

#define ERR_NOSECTION       3

#define ERR_SECTIONLONG     4

#define ERR_NOEQUAL         5

#define ERR_NOKEY           6

#define ERR_LONGKEY         7

#define ERR_READ            8

#define ERR_SPACE           9

#define ERR_DUPKEY          10

#define ERR_DUPKEYSEC       11

#define ERR_DUPSECTION      12

#define ERR_MAXPARSE        ERR_DUPSECTION

#define INI_META_NONE     0

#define INI_META_STATS    1

#define INI_ACCESS_CHECK_MODE   0x00000001

#define INI_ACCESS_CHECK_UID   0x00000002

#define INI_ACCESS_CHECK_GID   0x00000004

#define INI_MV1S_OVERWRITE 0x0000

#define INI_MV1S_ERROR     0x0001

#define INI_MV1S_PRESERVE  0x0002

#define INI_MV1S_ALLOW     0x0003

#define INI_MV1S_DETECT    0x0004

#define INI_MV2S_OVERWRITE 0x0000

#define INI_MV2S_ERROR     0x0010

#define INI_MV2S_PRESERVE  0x0020

#define INI_MV2S_ALLOW     0x0030

#define INI_MV2S_DETECT    0x0040

#define INI_MS_MERGE     0x0000

#define INI_MS_ERROR     0x0100

#define INI_MS_OVERWRITE 0x0200

#define INI_MS_PRESERVE  0x0300

#define INI_MS_ALLOW     0x0400

#define INI_MS_DETECT    0x0500

struct ini_cfgobj;
struct ini_cfgfile;

struct ini_parse_error;


/********************************************************************/
/* THIS IS A BEGINNING OF THE THE NEW CONFIG OBJECT INTERFACE - TBD */
/* It will be moved to the ini_config.h when it is ready            */
/********************************************************************/


/* Create a configuration object */
int ini_config_create(struct ini_cfgobj **ini_config);

/* Destroy a configuration object */
void ini_config_destroy(struct ini_cfgobj *ini_config);

/* Create a file object for parsing a config file */
int ini_config_file_open(const char *filename,
                         int error_level,
                         uint32_t collision_flags,
                         uint32_t metadata_flags,
                         struct ini_cfgfile **file_ctx);

/* Create a file object from existing one */
int ini_config_file_reopen(struct ini_cfgfile *file_ctx_in,
                           struct ini_cfgfile **file_ctx_out);

/* Close file context */
void ini_config_file_close(struct ini_cfgfile *file_ctx);

/* Close file context and destroy the object */
void ini_config_file_destroy(struct ini_cfgfile *file_ctx);

/* How many errors do we have in the list ? */
unsigned ini_config_error_count(struct ini_cfgfile *file_ctx);

/* Get the list of error strings */
int ini_config_get_errors(struct ini_cfgfile *file_ctx,
                          char ***errors);

/* Get the fully resolved file name */
const char *ini_config_get_filename(struct ini_cfgfile *file_ctx);

/* Free error strings */
void ini_config_free_errors(char **errors);

/* Parse the file and create a config object */
int ini_config_parse(struct ini_cfgfile *file_ctx,
                     struct ini_cfgobj *ini_config);

/* Copy configuration */
int ini_config_copy(struct ini_cfgobj *ini_config,
                    struct ini_cfgobj **ini_new);

/* Function to print errors from the list */
void ini_config_print_errors(FILE *file, char **error_list);

/* Merge two configurations together creating a new one */
int ini_config_merge(struct ini_cfgobj *first,
                     struct ini_cfgobj *second,
                     uint32_t collision_flags,
                     struct ini_cfgobj **result);

/* Set the folding boundary for multiline values.
 * Use before serializing and saving to a file if the
 * default boundary of 80 characters does not work for you.
 */
int ini_config_set_wrap(struct ini_cfgobj *ini_config,
                        uint32_t boundary);

/* Serialize configuration object into provided buffer */
int ini_config_serialize(struct ini_cfgobj *ini_config,
                         struct simplebuffer *sbobj);

/* Check access */
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);

/* Determins if two file context different by comparing
 * - time stamp
 * - device ID
 * - i-node
 */
int ini_config_changed(struct ini_cfgfile *file_ctx1,
                       struct ini_cfgfile *file_ctx2,
                       int *changed);


/****************************************************/
/* VALUE MANAGEMENT                                 */
/****************************************************/

char **get_section_list(struct ini_cfgobj *ini_config,
                        int *size,
                        int *error);

void free_section_list(char **section_list);

char **get_attribute_list(struct ini_cfgobj *ini_config,
                          const char *section,
                          int *size,
                          int *error);

void free_attribute_list(char **attr_list);


int get_int_config_value(struct ini_cfgobj *ini_config,
                         const char *section,
                         const char *name,
                         int strict,
                         int def,
                         int *value);

/* Similar functions are below */
int get_long_config_value(struct ini_cfgobj *ini_config,
                          const char *section,
                          const char *name,
                          int strict,
                          long def,
                          long *value);

int get_unsigned_config_value(struct ini_cfgobj *ini_config,
                              const char *section,
                              const char *name,
                              int strict,
                              unsigned def,
                              unsigned *value);

int get_ulong_config_value(struct ini_cfgobj *ini_config,
                           const char *section,
                           const char *name,
                           int strict,
                           unsigned long def,
                           unsigned long *value);







#ifdef THE_PART_I_HAVE_PROCESSED






int32_t get_int32_config_value(struct collection_item *item,
                               int strict,
                               int32_t def,
                               int *error);

uint32_t get_uint32_config_value(struct collection_item *item,
                                 int strict,
                                 uint32_t def,
                                 int *error);

int64_t get_int64_config_value(struct collection_item *item,
                               int strict,
                               int64_t def,
                               int *error);

uint64_t get_uint64_config_value(struct collection_item *item,
                                 int strict,
                                 uint64_t def,
                                 int *error);

double get_double_config_value(struct collection_item *item,
                               int strict,
                               double def,
                               int *error);

unsigned char get_bool_config_value(struct collection_item *item,
                                    unsigned char def,
                                    int *error);

char *get_string_config_value(struct collection_item *item,
                              int *error);
const char *get_const_string_config_value(struct collection_item *item,
                                          int *error);

char *get_bin_config_value(struct collection_item *item,
                           int *length,
                           int *error);

void free_bin_config_value(char *bin);

char **get_string_config_array(struct collection_item *item,
                               const char *sep,
                               int *size,
                               int *error);

char **get_raw_string_config_array(struct collection_item *item,
                                   const char *sep,
                                   int *size,
                                   int *error);

long *get_long_config_array(struct collection_item *item,
                            int *size,
                            int *error);

double *get_double_config_array(struct collection_item *item,
                                int *size,
                                int *error);

void free_string_config_array(char **str_config);

void free_long_config_array(long *array);
void free_double_config_array(double *array);

#endif

#endif