---

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@pobox.sk>
 * Copyright (c) 2001-2002 Platon SDG, http://www.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://www.platon.sk/projects/libcfg+/
 */

/* $Id: cfg+.h,v 1.36 2002/05/20 16:06:09 jombik9 Exp $ */

#ifndef _PLATON_CFG_H
#define _PLATON_CFG_H

#include <stdio.h>
#include "props.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_SKIP_FIRST = 0,

        CFG_PROCESS_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_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;

        enum cfg_error error_code;

        char **quote_prefix;
        char **quote_postfix;


        int argc;
        char **argv;

        int cur_idx;
        int cur_idx_tmp;
        int *used_opt_idx;

        int cur_opt_type;
        char *cur_opt;
        char *cur_arg;

        char **line_stop_str;

        char **short_option_prefix;
        char **long_option_prefix;
        char **line_option_arg_separator;

        char **line_multi_vals_separator;


        long begin_pos;
        long end_pos;
        char *filename;

        FILE *fhandle;

        char **file_stop_prefix;

        char **comment_prefix;

        char **multi_line_postfix;

        char **file_option_arg_separator;

        char **file_multi_vals_separator;

};

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(
                        int argc,
                        char **argv,
                        struct cfg_option *options);

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

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

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

        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);


        void cfg_clear_multi_vals_separator(const CFG_CONTEXT con);
        int cfg_add_multi_vals_separator(const CFG_CONTEXT con, char *str);
        int cfg_remove_multi_vals_separator(const CFG_CONTEXT con, char *str);

        void cfg_clear_option_arg_separator(const CFG_CONTEXT con);
        int cfg_add_option_arg_separator(const CFG_CONTEXT con, char *str);
        int cfg_remove_option_arg_separator(const CFG_CONTEXT con, char *str);

        void cfg_clear_quote_strings(const CFG_CONTEXT con);
        int cfg_add_quote_strings(const CFG_CONTEXT con,
                        char *prefix, char *postfix);
        int cfg_remove_quote_strings(const CFG_CONTEXT con,
                        char *prefix, char *postfix);

#define cfg_clear_cmdline_stop_string(con) \
        __cfg_clear_strdyn_array(&((con)->line_stop_str))
#define cfg_add_cmdline_stop_string(con, str) \
                __cfg_add_strdyn_array(&((con)->line_stop_str), str)
#define cfg_remove_cmdline_stop_string(con, str) \
                __cfg_remove_strdyn_array(&((con)->line_stop_str), str)

#define cfg_clear_cfgfile_stop_prefix(con) \
                __cfg_clear_strdyn_array(&((con)->file_stop_prefix))
#define cfg_add_cfgfile_stop_prefix(con, str) \
                __cfg_add_strdyn_array(&((con)->file_stop_prefix), str)
#define cfg_remove_cfgfile_stop_prefix(con, str) \
                __cfg_remove_strdyn_array(&((con)->file_stop_prefix), str)

#define cfg_clear_cfgfile_comment_prefix(con) \
                __cfg_clear_strdyn_array(&((con)->comment_prefix))
#define cfg_add_cfgfile_comment_prefix(con, str) \
                __cfg_add_strdyn_array(&((con)->comment_prefix), str)
#define cfg_remove_cfgfile_comment_prefix(con, str) \
                __cfg_remove_strdyn_array(&((con)->comment_prefix), str)

#define cfg_clear_cmdline_short_option_prefix(con) \
                __cfg_clear_strdyn_array(&((con)->short_option_prefix))
#define cfg_add_cmdline_short_option_prefix(con, str) \
                __cfg_add_strdyn_array(&((con)->short_option_prefix), str)
#define cfg_remove_cmdline_short_option_prefix(con, str) \
                __cfg_remove_strdyn_array(&((con)->short_option_prefix), str)

#define cfg_clear_cmdline_long_option_prefix(con) \
                __cfg_clear_strdyn_array(&((con)->long_option_prefix))
#define cfg_add_cmdline_long_option_prefix(con, str) \
                __cfg_add_strdyn_array(&((con)->long_option_prefix), str)
#define cfg_remove_cmdline_long_option_prefix(con, str) \
                __cfg_remove_strdyn_array(&((con)->long_option_prefix), str)

#define cfg_clear_cfgfile_multi_line_postfix(con) \
                __cfg_clear_strdyn_array(&((con)->multi_line_postfix))
#define cfg_add_cfgfile_multi_line_postfix(con, str) \
                __cfg_add_strdyn_array(&((con)->multi_line_postfix), str)
#define cfg_remove_cfgfile_multi_line_postfix(con, str) \
                __cfg_remove_strdyn_array(&((con)->multi_line_postfix), str)

#define cfg_clear_cmdline_multi_vals_separator(con) \
                __cfg_clear_strdyn_array(&((con)->line_multi_vals_separator))
#define cfg_add_cmdline_multi_vals_separator(con, str) \
                __cfg_add_strdyn_array(&((con)->line_multi_vals_separator), str)
#define cfg_remove_cmdline_multi_vals_separator(con, str) \
                __cfg_remove_strdyn_array(&((con)->line_multi_vals_separator), str)

#define cfg_clear_cfgfile_multi_vals_separator(con) \
                __cfg_clear_strdyn_array(&((con)->file_multi_vals_separator))
#define cfg_add_cfgfile_multi_vals_separator(con, str) \
                __cfg_add_strdyn_array(&((con)->file_multi_vals_separator), str)
#define cfg_remove_cfgfile_multi_vals_separator(con, str) \
                __cfg_remove_strdyn_array(&((con)->file_multi_vals_separator), str)

#define cfg_clear_cmdline_option_arg_separator(con) \
                __cfg_clear_strdyn_array(&((con)->line_option_arg_separator))
#define cfg_add_cmdline_option_arg_separator(con, str) \
                __cfg_add_strdyn_array(&((con)->line_option_arg_separator), str)
#define cfg_remove_cmdline_option_arg_separator(con, str) \
                __cfg_remove_strdyn_array(&((con)->line_option_arg_separator), str)

#define cfg_clear_cfgfile_option_arg_separator(con) \
                __cfg_clear_strdyn_array(&((con)->file_option_arg_separator))
#define cfg_add_cfgfile_option_arg_separator(con, str) \
                __cfg_add_strdyn_array(&((con)->file_option_arg_separator), str)
#define cfg_remove_cfgfile_option_arg_separator(con, str) \
                __cfg_remove_strdyn_array(&((con)->file_option_arg_separator), 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 */

---