clopts.h

Go to the documentation of this file.

#ifndef CSNIP_CLOPTS_H
#define CSNIP_CLOPTS_H
 
#include <stdio.h>
#include <stdbool.h>
 
#include <csnip/err.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct csnip_clopts_optinfo_s;
struct csnip_clopts_s;
 
typedef struct csnip_clopts_optinfo_s csnip_clopts_optinfo;
 
typedef struct csnip_clopts_s csnip_clopts;
 
typedef int (*csnip_clopts_parser)(const csnip_clopts* opts,
                    const csnip_clopts_optinfo* optinfo,
                    const char* argval);
 
struct csnip_clopts_optinfo_s {
    char short_name;        
    const char* long_name;      
    const char* description;    
    bool takes_val;         
    csnip_clopts_parser parser; 
    void* usr;          
};
 
struct csnip_clopts_s {
    const char *description;
 
    /* The array of clopts_optinfo members */
    int n_optinfo;          
    int n_optinfo_cap;      
    csnip_clopts_optinfo* optinfo;  
};
 
/* Operations on csnip_clopts */
 
int csnip_clopts_add_defaults(csnip_clopts* opts);
 
int csnip_clopts_add(csnip_clopts* opts,
            int n_optinfo,
            const csnip_clopts_optinfo* optinfo);
 
int csnip_clopts_process(csnip_clopts* opts,
            int argc,
            char** argv,
            int* ret_pos_args,
            bool do_clear);
 
void csnip_clopts_clear(csnip_clopts* opts);
 
int csnip_clopts_parser_uchar(const csnip_clopts* opts,
            const csnip_clopts_optinfo* optinfo,
            const char* argval);
int csnip_clopts_parser_uint(const csnip_clopts* opts,
            const csnip_clopts_optinfo* optinfo,
            const char* argval);
int csnip_clopts_parser_ulong(const csnip_clopts* opts,
            const csnip_clopts_optinfo* optinfo,
            const char* argval);
int csnip_clopts_parser_ullong(const csnip_clopts* opts,
            const csnip_clopts_optinfo* optinfo,
            const char* argval);
int csnip_clopts_parser_float(const csnip_clopts* opts,
            const csnip_clopts_optinfo* optinfo,
            const char* argval);
int csnip_clopts_parser_double(const csnip_clopts* opts,
            const csnip_clopts_optinfo* optinfo,
            const char* argval);
int csnip_clopts_parser_ldouble(const csnip_clopts* opts,
            const csnip_clopts_optinfo* optinfo,
            const char* argval);
int csnip_clopts_parser_pchar(const csnip_clopts* opts,
            const csnip_clopts_optinfo* optinfo,
            const char* argval);
 
int csnip_clopts_flagparser_bool(const csnip_clopts* opts,
            const csnip_clopts_optinfo* optinfo,
            const char* argval);
 
#ifdef __cplusplus
}
#endif
 
#define csnip_clopts_Addvar(opts, \
            short_name, \
            long_name, \
            description, \
            ptr_target, \
            err) \
    csnip_clopts__Addvar((opts), (short_name), (long_name), \
                    (description), (ptr_target), (err), \
            csnip__parser, csnip__O, csnip__errval)
 
#define csnip_clopts__Addvar(opts_, \
            short_name_, \
            long_name_, \
            description_, \
            ptr_target_, \
            err, \
            /* Internal variable names: */ \
            parser_, \
            O, \
            errval) \
    do { \
        csnip_clopts_parser parser_ = csnip_clopts__Getparser(ptr_target_); \
        csnip_clopts_optinfo O = { \
            .short_name = short_name_, \
            .long_name = long_name_, \
            .description = description_, \
            .takes_val = true, \
            .parser = parser_, \
            .usr = (void*)ptr_target_, \
        }; \
        int errval = csnip_clopts_add(opts_, 1, &O); \
        if (errval) \
            csnip_err_Raise(errval, err); \
    } while(0)
#define csnip_clopts_Addflag(opts, \
            short_name, \
            long_name, \
            description, \
            ptr_target, \
            err) \
    csnip_clopts__Addflag((opts), (short_name), (long_name), \
                    (description), (ptr_target), (err), \
            csnip__O, csnip__errval)
 
#define csnip_clopts__Addflag(opts_, \
            short_name_, \
            long_name_, \
            description_, \
            ptr_target_, \
            err, \
            O, \
            errval) \
    do { \
        csnip_clopts_optinfo O = { \
            .short_name = short_name_, \
            .long_name = long_name_, \
            .description = description_, \
            .takes_val = false, \
            .parser = csnip_clopts_flagparser_bool, \
            .usr = (void*)ptr_target_ \
        }; \
        int errval = csnip_clopts_add(opts_, 1, &O); \
        if (errval) \
            csnip_err_Raise(errval, err); \
    } while (0)
#ifndef __cplusplus
 
/* C11 version using _Generic */
#define csnip_clopts__Getparser(ptr_target_) \
          _Generic(*ptr_target_, \
            char: csnip_clopts_parser_uchar, \
            unsigned char: csnip_clopts_parser_uchar, \
            int: csnip_clopts_parser_uint, \
            unsigned int: csnip_clopts_parser_uint, \
            long: csnip_clopts_parser_ulong, \
            unsigned long: csnip_clopts_parser_ulong, \
            long long: csnip_clopts_parser_ullong, \
            unsigned long long: csnip_clopts_parser_ullong, \
            float: csnip_clopts_parser_float, \
            double: csnip_clopts_parser_double, \
            long double: csnip_clopts_parser_ldouble, \
            char*: csnip_clopts_parser_pchar, \
            char const*: csnip_clopts_parser_pchar)
#else
 
/* C++ version using templates */
template<typename T> csnip_clopts_parser csnip_clopts__getparser(T* type);
#define csnip_clopts__tspec(type, suffix) \
    template<> csnip_clopts_parser csnip_clopts__getparser<type>(type*) \
    { \
        return csnip_clopts_parser_ ## suffix; \
    }
csnip_clopts__tspec(char, uchar)
csnip_clopts__tspec(unsigned char, uchar)
csnip_clopts__tspec(int, uint)
csnip_clopts__tspec(unsigned int, uint)
csnip_clopts__tspec(long, ulong)
csnip_clopts__tspec(unsigned long, ulong)
csnip_clopts__tspec(long long, ullong)
csnip_clopts__tspec(unsigned long long, ullong)
csnip_clopts__tspec(float, float)
csnip_clopts__tspec(double, double)
csnip_clopts__tspec(long double, ldouble)
csnip_clopts__tspec(char*, pchar)
csnip_clopts__tspec(char const*, pchar)
#undef csnip_clopts__tspec
#define csnip_clopts__Getparser(ptr_target_) csnip_clopts__getparser(ptr_target_)
#endif
 
#endif /* CSNIP_CLOPTS_H */
 
#if defined(CSNIP_SHORT_NAMES) && !defined(CSNIP_CLOPTS_HAVE_SHORT_NAMES)
#define clopts          csnip_clopts
#define clopts_optinfo      csnip_clopts_optinfo
#define clopts_parser       csnip_clopts_parser
#define clopts_init     csnip_clopts_init
#define clopts_clear        csnip_clopts_clear
#define clopts_add_defaults csnip_clopts_add_defaults
#define clopts_add      csnip_clopts_add
#define clopts_process      csnip_clopts_process
#define clopts_clear        csnip_clopts_clear
#define clopts_parser_uchar csnip_clopts_parser_uchar
#define clopts_parser_uint  csnip_clopts_parser_uint
#define clopts_parser_ulong csnip_clopts_parser_ulong
#define clopts_parser_ullong    csnip_clopts_parser_ullong
#define clopts_parser_float csnip_clopts_parser_float
#define clopts_parser_double    csnip_clopts_parser_double
#define clopts_parser_ldouble   csnip_clopts_parser_ldouble
#define clopts_parser_pchar csnip_clopts_parser_pchar
#define clopts_Addvar       csnip_clopts_Addvar
#define clopts_Addflag      csnip_clopts_Addflag
#define CSNIP_CLOPTS_HAVE_SHORT_NAMES
#endif /* CSNIP_SHORT_NAMES && !CSNIP_CLOPTS_HAVE_SHORT_NAMES */