argpar.h

Go to the documentation of this file.

 
#ifndef __ARGPAR_H__
#define __ARGPAR_H__
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <limits.h>
#include <math.h>
#include <stdio.h>
 
#ifndef ARGPAR_API_VERSION
 
#define ARGPAR_API_VERSION 2001000
 
#define ARGPAR_API_VERSION_STR "2.1.0"
#endif
 
#ifndef MAX_PARFILES
#define MAX_PARFILES 64
#endif
 
#ifndef PARFILE_STR
#define PARFILE_STR "parfile"
#endif
 
extern const char *argpar_program_name;
 
extern FILE *argpar_ostream;
 
typedef struct argpar_option {
    const char *name;
    int key;
    const char *arg;
    int flags;
    const char *doc;
    int group;
} argpar_option;
 
#define ARGPAR_CAST_ARGS 0x1
 
#define ARGPAR_SKIP_PARFILES 0x2
 
#define ARGPAR_NO_KEYARGS 0x4
 
#define ARGPAR_NO_HELP 0x8
 
#define ARGPAR_NO_EXIT 0x10
 
#define ARGPAR_ACCEPT_ANY 0x20
 
#define ARGPAR_STORE_PARAMS 0x40
 
 
#define OPTION_ARG_OPTIONAL 0x1
 
#define OPTION_HIDDEN 0x2
 
#define OPTION_DOC 0x4
 
#define OPTION_DBL 0x10
 
#define OPTION_INT 0x20
 
#define OPTION_PARENT 0x40
 
#define OPTION_CHILD 0x80
 
#define OPTION_DOC_NO_BREAK 0x100
 
#define OPTION_ALIAS 0x200
 
#define OPTION_ENUM (OPTION_DOC | 0x400)
 
#define OPTION_ATTR (OPTION_DOC | OPTION_HIDDEN | 0x800)
 
const char *argpar_program_name;
 
FILE *argpar_ostream;
 
typedef struct argpar_state {
    struct argpar *argpar;
 
    unsigned argc;
    char **argv;
 
    unsigned next;
 
    unsigned int flags;
 
    unsigned arg_num;
 
    unsigned quoted;
 
    void *input;
 
    void **child_inputs;
 
    void *hook;
 
    const char *parfile;
 
    char *name;
 
    const char *arg_name;
 
    const char *arg_alias;
 
    const char *arg_value;
 
    long argv_as_int;
    int argv_as_int_err;
 
    double argv_as_dbl;
    int argv_as_dbl_err;
} argpar_state;
 
extern const char *argpar_program_version;
 
extern void (*argpar_program_version_hook) (FILE *stream, argpar_state *state);
 
#define ARGPAR_KEY_ARG      0
 
#define ARGPAR_KEY_ARGS     -8
 
#define ARGPAR_KEY_END -1
 
#define ARGPAR_KEY_INIT -3
 
#define ARGPAR_KEY_FINI -4
 
#define ARGPAR_KEY_SUCCESS -5
 
#define ARGPAR_KEY_ERROR -6
 
#define ARGPAR_KEY_NO_ARGS -7
 
#define ARGPAR_KEY_UNKNOWN -8
 
#define ARGPAR_KEY_HELP_ARGS_DOC -1
 
#define ARGPAR_KEY_HELP_PRE_DOC -2
 
#define ARGPAR_KEY_HELP_POST_DOC -3
 
#define ARGPAR_KEY_HELP_HEADER -4
 
#define ARGPAR_KEY_HELP_OPTION_DOC -5
 
#define ARGPAR_KEY_HELP_EXTRA -7 /* After all other documentation; text is NULL for this key. */
 
#define ARGPAR_ERR_ABORT -1
 
#define ARGPAR_ERR_USAGE -2
 
#define ARGPAR_ERR_UNKNOWN -5
 
#define ARGPAR_ERR_PARFILE -3
 
#define ARGPAR_LIMIT_REACHED -4
 
typedef int (*argpar_parser)(int key, char *argv, argpar_state *state);
 
typedef char *(*help_filter)(int key, const char *text, void *input);
 
typedef struct argpar_child {
    struct argpar *argpar;
 
    unsigned flags;
 
    const char *header;
 
    int group;
} argpar_child;
 
typedef struct argpar {
    const argpar_option *options;
    argpar_parser parser;
    const char *args_doc;
    const char *doc;
    const argpar_child *children;
    help_filter help_filter;
    unsigned parfile_buffer_count;
    char **parfile_buffer;
} argpar;
 
int argpar_clean(argpar *p);
 
int argpar_parse_file(argpar *p, const char *path, unsigned flags, void *input);
 
int argpar_parse_args(argpar *p, unsigned argc, char *argv[], unsigned flags, unsigned *end_index, void *input);
 
int argpar_usage(argpar_state *state);
 
int argpar_usage_default(argpar *argpar);
 
int argpar_help(argpar *argpar, FILE *stream, unsigned flags, char *name);
 
int argpar_usage_json(argpar_state *state);
 
int argpar_usage_default_json(argpar *argpar);
 
int argpar_help_json(argpar *argpar, FILE *stream, unsigned flags, char *name);
 
const char *argpar_version();
 
char **argpar_split_str(char *str, const char *delim);
 
char **argpar_split_trim(char *str, const char *delim);
 
#ifndef NULL_INT
#define NULL_INT INT_MIN
#endif
 
#ifndef EMPTY_INT
#define EMPTY_INT INT_MAX
#endif
 
int *argpar_split_int(char *str, const char *delim);
 
double *argpar_split_dbl(char *str, const char *delim);
 
#ifdef __cplusplus
}
#endif
 
#endif // __ARGPAR_H__