cli.h

Go to the documentation of this file.

#ifndef BJ_CLI_H
#define BJ_CLI_H
 
#include <banjo/api.h>
#include <banjo/error.h>
 
struct bj_cli;
struct bj_cli_argument;

typedef bj_bool (*bj_cli_action_fn)(
    const struct bj_cli*          parser,
    const struct bj_cli_argument* arg,
    const char*                   value,
    void*                         dest,
    struct bj_error**             error
);

struct bj_cli_argument {
    const char*            name;       
    char                   shortname;  
    const char*            help;       
    const char*            metavar;    
    void*                  dest;       
    bj_cli_action_fn       action;     
    int                    required;   
};

struct bj_cli {
    const char*             prog;          
    const char*             description;   
    const char*             epilog;        
    size_t                  arguments_len; 
    struct bj_cli_argument* arguments;     
};

BANJO_EXPORT bj_bool bj_cli_parse(
    struct bj_cli*    parser,
    int               argc,
    char*             argv[],
    struct bj_error** error
);

BANJO_EXPORT bj_bool bj_cli_validate(
    const struct bj_cli* parser,
    struct bj_error**    error
);

BANJO_EXPORT void bj_cli_print_help(
    const struct bj_cli* parser
);

BANJO_EXPORT size_t bj_cli_get_help_string(
    const struct bj_cli* parser,
    char*                buffer,
    size_t               buffer_size
);

BANJO_EXPORT bj_bool bj_cli_store_cstring(
    const struct bj_cli*          parser,
    const struct bj_cli_argument* arg,
    const char*                   value,
    void*                         dest,
    struct bj_error**             error
);

BANJO_EXPORT bj_bool bj_cli_store_double(
    const struct bj_cli*          parser,
    const struct bj_cli_argument* arg,
    const char*                   value,
    void*                         dest,
    struct bj_error**             error
);

BANJO_EXPORT bj_bool bj_cli_store_int(
    const struct bj_cli*          parser,
    const struct bj_cli_argument* arg,
    const char*                   value,
    void*                         dest,
    struct bj_error**             error
);

BANJO_EXPORT bj_bool bj_cli_store_uint(
    const struct bj_cli*          parser,
    const struct bj_cli_argument* arg,
    const char*                   value,
    void*                         dest,
    struct bj_error**             error
);

BANJO_EXPORT bj_bool bj_cli_store_bool(
    const struct bj_cli*          parser,
    const struct bj_cli_argument* arg,
    const char*                   value,
    void*                         dest,
    struct bj_error**             error
);

BANJO_EXPORT bj_bool bj_cli_print_help_action(
    const struct bj_cli*          parser,
    const struct bj_cli_argument* arg,
    const char*                   value,
    void*                         dest,
    struct bj_error**             error
);
 
#endif // BJ_CLI_H