cfg+.h

Go to the documentation of this file.

/*
 * libcfg+ - precise command line & config file parsing library
 *
 * cfg+.h - main implementation header file
 * ____________________________________________________________
 *
 * Developed by Ondrej Jombik <nepto@platon.sk>
 *          and Lubomir Host <rajo@platon.sk>
 * Copyright (c) 2001-2015 Platon Group, http://platon.sk/
 * All rights reserved.
 *
 * See README file for more information about this software.
 * See COPYING file for license information.
 *
 * Download the latest version from
 * http://opensource.platon.sk/projects/libcfg+/
 */

/* $Platon: libcfg+/src/cfg+.h,v 1.61 2015/09/12 04:04:49 nepto Exp $ */

#ifndef _PLATON_CFG_H
#define _PLATON_CFG_H

#include <stdio.h>

#define CFG_END_OPTION { NULL, '\0', NULL, CFG_END, NULL, 0 }
#define CFG_END_OF_LIST CFG_END_OPTION 
enum cfg_error { /* {{{ */

        CFG_ERR_OK = 0,
        CFG_ERROR_OK = 0,
        CFG_OK = 0,
        CFG_ERR_NOARG = -1,
        CFG_ERROR_NOARG = -1,

        CFG_ERR_NOTALLOWEDARG = -2,
        CFG_ERROR_NOTALLOWEDARG = -2,

        CFG_ERR_BADOPT = -3,
        CFG_ERROR_BADOPT = -3,

        CFG_ERR_BADQUOTE = -4,
        CFG_ERROR_BADQUOTE = -4,

        CFG_ERR_BADNUMBER = -5,
        CFG_ERROR_BADNUMBER = -5,

        CFG_ERR_OVERFLOW = -6,
        CFG_ERROR_OVERFLOW = -6,

        CFG_ERR_MULTI = -7,
        CFG_ERROR_MULTI = -7,

        CFG_ERR_NOMEM = -8,
        CFG_ERROR_NOMEM = -8,

        CFG_ERR_STOP_STR = -9,
        CFG_ERR_STOP_STR_FOUND = -9,
        CFG_ERROR_STOP_STR = -9,
        CFG_ERROR_STOP_STR_FOUND = -9,

        CFG_ERR_NOEQUAL = -10,
        CFG_ERROR_NOEQUAL = -10,

        CFG_ERR_UNKNOWN = -11,
        CFG_ERROR_UNKNOWN = -11,

        CFG_ERR_FILE_NOT_FOUND = -12,
        CFG_ERROR_FILE_NOT_FOUND = -12,

        CFG_ERR_SEEK_ERROR = -13,
        CFG_ERROR_SEEK_ERROR = -13,

        CFG_ERR_INTERNAL = -20,
        CFG_ERROR_INTERNAL = -20

}; /* }}} */ /*@}*/

enum cfg_flag { /* {{{ */

        CFG_IGNORE_MULTI = 1,

        CFG_IGNORE_UNKNOWN = 2,

        CFG_PROCESS_FIRST = 0,

        CFG_SKIP_FIRST = 4,

        CFG_POSIXLY_LEFTOVERS = 0,

        CFG_ADVANCED_LEFTOVERS = 8,

        CFG_NORMAL_LEFTOVERS = 0,

        CFG_STRICT_LEFTOVERS = 16,

        CFG_FILE_BYTE_POS_USAGE = 0,

        CFG_FILE_LINE_POS_USAGE = 32

                /* Ignore all quotations in options arguments. */
                /*
                   CFG_USE_QUOTE = 0,
                   CFG_IGNORE_QUOTE = 16
                   */
                /* Advanced quotations are things like  option = va"'l'"ue
                   which resolves to                                    va'l'ue.

                   We really want this strange stuff? Any volunter?

                   CFG_ADVANCED_QUOTE = 32 + 16
                   */

}; /* }}} */ /*@}*/

enum cfg_option_type { /* {{{ */

        CFG_BOOL = 1,
        CFG_BOOLEAN = 1,

        CFG_INT = 2,
        CFG_INTEGER = 2,

        CFG_UINT = 3,
        CFG_UNSIGNED = 3,
        CFG_UNSIGNED_INT = 3,

        CFG_LONG = 4,

        CFG_ULONG = 5,
        CFG_UNSIGNED_LONG = 5,

        CFG_FLOAT = 6,

        CFG_DOUBLE = 7,

        CFG_STR = 8,
        CFG_STRING = 8,

        CFG_END = 0,

        CFG_DATA_TYPE_MASK = 31,

        CFG_SINGLE = 0,
        CFG_MULTI = 32,
        CFG_MULTI_ARRAY = 32,
        CFG_MULTI_SEPARATED = 32 + 64,

        CFG_LAST_ARGS = 128,
        CFG_LAST_ARGUMENTS = 128,
        CFG_LEFTOVER_ARGS = 128,
        CFG_LEFTOVER_ARGUMENTS = 128

}; /* }}} */ /*@}*/

enum cfg_property_type { /* {{{ */


        CFG_LINE_STOP_STRING = 0,

        CFG_LINE_SHORT_OPTION_PREFIX = 1,

        CFG_LINE_LONG_OPTION_PREFIX = 2,

        CFG_LINE_OPTION_ARG_SEPARATOR = 3,

        CFG_LINE_NORMAL_MULTI_VALS_SEPARATOR = 4,

        CFG_LINE_LEFTOVER_MULTI_VALS_SEPARATOR = 5,

        CFG_LINE_QUOTE_PREFIX  = 6,
        CFG_LINE_QUOTE_POSTFIX = 7,

        CFG_FILE_STOP_PREFIX = 8,

        CFG_FILE_COMMENT_PREFIX = 9,

        CFG_FILE_MULTI_LINE_POSTFIX = 10,

        CFG_FILE_OPTION_ARG_SEPARATOR = 11,

        CFG_FILE_NORMAL_MULTI_VALS_SEPARATOR = 12,

        CFG_FILE_LEFTOVER_MULTI_VALS_SEPARATOR = 13,

        CFG_FILE_QUOTE_PREFIX  = 14,
        CFG_FILE_QUOTE_POSTFIX = 15,

        CFG_N_PROPS = 16,

        CFG_QUOTE         = 50,
        CFG_LINE_QUOTE    = 51,
        CFG_FILE_QUOTE    = 52,
        CFG_QUOTE_PREFIX  = 53,
        CFG_QUOTE_POSTFIX = 54,

        CFG_MULTI_VALS_SEPARATOR          = 55,
        CFG_FILE_MULTI_VALS_SEPARATOR     = 56,
        CFG_LINE_MULTI_VALS_SEPARATOR     = 57,
        CFG_NORMAL_MULTI_VALS_SEPARATOR   = 58,
        CFG_LEFTOVER_MULTI_VALS_SEPARATOR = 59,

        CFG_OPTION_ARG_SEPARATOR = 60
}; /* }}} */

#define CFG_EOT                 CFG_N_PROPS
#define CFG_END_TYPE    CFG_N_PROPS

enum cfg_context_type { /* {{{ */

        CFG_NO_CONTEXT = 0,

        CFG_CMDLINE = 1,
        CFG_LINE = 1,

        CFG_CFGFILE = 2,
        CFG_FILE = 2
}; /* }}} */

enum cfg_line_option_type { /* {{{ */

        CFG_NONE_OPTION = 0,

        CFG_SHORT_OPTION = 1,

        CFG_LONG_OPTION = 2,

        CFG_SHORT_OPTIONS = 4,

        CFG_LONG_SEPINIT = 8,

        CFG_LONG_NOSEPINIT = 0
}; /* }}} */ /*@}*/

struct cfg_option { /* {{{ */
        const char *cmdline_long_name;
        const char  cmdline_short_name;
        const char *cfgfile_name;

        const enum cfg_option_type type;

        void *value;

        int val;
}; /* }}} */

struct cfg_context { /* {{{ */


        enum cfg_context_type type;

        int flags;

        const struct cfg_option *options;

        long begin_pos;

        long size;

        int *used_opt_idx;

        enum cfg_error error_code;

        char **prop[CFG_N_PROPS];

        long cur_idx;
        long cur_idx_tmp;
        int  cur_opt_type;

        char *cur_opt;

        char *cur_arg;


        int parsing_started:1;

        char **argv;


        char *filename;

        FILE *fhandle;

}; /* }}} */

typedef struct cfg_context * CFG_CONTEXT;

/*
 * Functions
 */

#ifdef __cplusplus
extern "C" {
#endif

 /* {{{ */

        CFG_CONTEXT cfg_get_context(struct cfg_option *options);

        CFG_CONTEXT cfg_get_cmdline_context(
                        long begin_pos,
                        long size,
                        char **argv,
                        struct cfg_option *options);

#define cfg_get_cmdline_context_pos(begin_pos, end_pos, argv, options) \
        cfg_get_cmdline_context( \
                        begin_pos, \
                        end_pos - begin_pos + 1, \
                        argv, \
                        options)

                CFG_CONTEXT cfg_get_cmdline_context_argc(
                                int argc,
                                char **argv,
                                struct cfg_option *options);

        CFG_CONTEXT cfg_get_cfgfile_context(
                        long begin_pos,
                        long size,
                        char *filename,
                        struct cfg_option *options);

#define cfg_get_cfgfile_context_pos(begin_pos, end_pos, argv, options) \
        cfg_get_cfgfile_context( \
                        begin_pos, \
                        end_pos - begin_pos + 1, \
                        argv, \
                        options)

                void cfg_set_cmdline_context(
                                const CFG_CONTEXT con,
                                long begin_pos,
                                long size,
                                char **argv);

#define cfg_set_cmdline_context_pos(con, begin_pos, end_pos, argv) \
        cfg_get_cmdline_context( \
                        con \
                        begin_pos, \
                        end_pos - begin_pos + 1, \
                        argv)

                void cfg_set_cmdline_context_argc(
                                const CFG_CONTEXT con,
                                int argc,
                                char **argv);

        void cfg_set_cfgfile_context(
                        const CFG_CONTEXT con,
                        long begin_pos,
                        long size,
                        char *filename);

#define cfg_set_cfgfile_context_pos(con, begin_pos, end_pos, argv) \
        cfg_get_cfgfile_context( \
                        con \
                        begin_pos, \
                        end_pos - begin_pos + 1, \
                        argv)

                void cfg_reset_context(const CFG_CONTEXT con);

        void cfg_free_context(const CFG_CONTEXT con);

        /* }}} */ /*@}*/

 /* {{{ */

        void cfg_set_context_flag(const CFG_CONTEXT con, int flag);

        void cfg_clear_context_flag(const CFG_CONTEXT con, int flag);

        int cfg_get_context_flag(const CFG_CONTEXT con, int flag);

#define cfg_is_context_flag(con, flag) cfg_get_context_flag(con, flag)

        void cfg_set_context_flags(const CFG_CONTEXT con, int flags);

        int cfg_get_context_flags(const CFG_CONTEXT con);

        /* }}} */ /*@}*/

 /* {{{ */

        int cfg_clear_property(
                        const CFG_CONTEXT con, enum cfg_property_type type);

        int cfg_clear_properties(
                        const CFG_CONTEXT con, enum cfg_property_type type, ...);


        int cfg_add_property(
                        const CFG_CONTEXT con, enum cfg_property_type type, char *str);

        int cfg_add_properties(
                        const CFG_CONTEXT con, enum cfg_property_type type, char *str, ...);

        int cfg_add_properties_str(
                        const CFG_CONTEXT con, char *str, enum cfg_property_type type, ...);

        int cfg_add_properties_type(
                        const CFG_CONTEXT con, enum cfg_property_type type, char *str, ...);

        int cfg_remove_property(
                        const CFG_CONTEXT con, enum cfg_property_type type, char *str);

        int cfg_remove_properties(
                        const CFG_CONTEXT con, enum cfg_property_type type, char *str, ...);

        int cfg_remove_properties_str(
                        const CFG_CONTEXT con, char *str, enum cfg_property_type type, ...);

        int cfg_remove_properties_type(
                        const CFG_CONTEXT con, enum cfg_property_type type, char *str, ...);

        /* }}} */ /*@}*/

 /* {{{ */

        int cfg_parse(const CFG_CONTEXT con);

        int cfg_get_next_opt(const CFG_CONTEXT con);

        char *cfg_get_cur_opt(const CFG_CONTEXT con);

        char *cfg_get_cur_arg(const CFG_CONTEXT con);

        int cfg_get_cur_idx(const CFG_CONTEXT con);

        /* }}} */ /*@}*/

 /* {{{ */

        void cfg_print_error(const CFG_CONTEXT con);

        void cfg_fprint_error(const CFG_CONTEXT con, FILE *fh);

        char *cfg_get_error_str(const CFG_CONTEXT con);

        char *cfg_get_static_error_str(const int errorcode);

        /* }}} */ /*@}*/

#ifdef __cplusplus
}
#endif

#endif /* _PLATON_CFG_H */

/* Modeline for ViM {{{
 * vim:set ts=4:
 * vim600:fdm=marker fdl=0 fdc=0:
 * }}} */