clap.h

Go to the documentation of this file.

 
#ifndef CLAP_H
#define CLAP_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdio.h>
#include <clap/clap_version.h>
#include <clap/clap_error.h>
#include <clap/clap_types.h>
#include <clap/clap_action.h>
#include <clap/clap_allocator.h>
#include <clap/clap_export.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ============================================================================
 * nargs Specifiers
 * ============================================================================ */
 
#define CLAP_NARGS_ZERO_OR_ONE   (-3)  
#define CLAP_NARGS_ZERO_OR_MORE  (-4)  
#define CLAP_NARGS_ONE_OR_MORE   (-5)  
#define CLAP_NARGS_OPTIONAL      CLAP_NARGS_ZERO_OR_ONE
#define CLAP_NARGS_REMAINDER     (-1)  
/* ============================================================================
 * Parser API
 * ============================================================================ */
 
CLAP_EXPORT clap_parser_t* clap_parser_new(
    const char *prog_name,
    const char *description,
    const char *epilog
);
 
CLAP_EXPORT void clap_parser_free(clap_parser_t *parser);
 
CLAP_EXPORT void clap_parser_set_help_width(clap_parser_t *parser, int width);
CLAP_EXPORT void clap_parser_set_allow_abbrev(clap_parser_t *parser, bool allow);
CLAP_EXPORT void clap_parser_set_version(clap_parser_t *parser, const char *version);
 
/* ============================================================================
 * Argument API
 * ============================================================================ */
 
CLAP_EXPORT clap_argument_t* clap_add_argument(
    clap_parser_t *parser,
    const char *name_or_flags
);
 
CLAP_EXPORT clap_argument_t* clap_argument_help(clap_argument_t *arg, const char *help_text);
CLAP_EXPORT clap_argument_t* clap_argument_type(clap_argument_t *arg, const char *type_name);
CLAP_EXPORT clap_argument_t* clap_argument_default(clap_argument_t *arg, const char *default_value);
CLAP_EXPORT clap_argument_t* clap_argument_required(clap_argument_t *arg, bool required);
CLAP_EXPORT clap_argument_t* clap_argument_choices(clap_argument_t *arg, const char **choices, size_t count);
CLAP_EXPORT clap_argument_t* clap_argument_nargs(clap_argument_t *arg, int nargs);
CLAP_EXPORT clap_argument_t* clap_argument_action(clap_argument_t *arg, clap_action_t action);
CLAP_EXPORT clap_argument_t* clap_argument_metavar(clap_argument_t *arg, const char *metavar);
CLAP_EXPORT clap_argument_t* clap_argument_dest(clap_argument_t *arg, const char *dest);
CLAP_EXPORT clap_argument_t* clap_argument_const(clap_argument_t *arg, const char *const_value);
CLAP_EXPORT clap_argument_t* clap_argument_handler(clap_argument_t *arg, clap_action_handler_t handler);
CLAP_EXPORT clap_argument_t* clap_argument_data(clap_argument_t *arg, void *data);
 
/* ============================================================================
 * Mutually Exclusive Groups
 * ============================================================================ */
 
CLAP_EXPORT int clap_add_mutually_exclusive_group(clap_parser_t *parser, bool required);
CLAP_EXPORT bool clap_mutex_group_add_argument(clap_parser_t *parser, int mutex_group_id, clap_argument_t *arg);
 
/* ============================================================================
 * Argument Groups
 * ============================================================================ */
 
CLAP_EXPORT int clap_add_argument_group(clap_parser_t *parser, const char *title, const char *description);
CLAP_EXPORT bool clap_argument_group_add_argument(clap_parser_t *parser, int display_group_id, clap_argument_t *arg);
 
/* ============================================================================
 * Subparsers
 * ============================================================================ */
 
CLAP_EXPORT clap_parser_t* clap_add_subparsers(
    clap_parser_t *parser,
    const char *dest,
    const char *help_text
);
 
CLAP_EXPORT clap_parser_t* clap_subparser_add(
    clap_parser_t *subparsers,
    const char *name,
    const char *help_text
);
 
CLAP_EXPORT void clap_subparsers_metavar(clap_parser_t *parser, const char *metavar);
CLAP_EXPORT bool clap_print_subcommand_help(clap_parser_t *parser, const char *command_name, FILE *stream);
 
CLAP_EXPORT void clap_print_help_on_error(clap_parser_t *parser, const clap_error_t *error, FILE *stream);
 
/* ============================================================================
 * Parsing
 * ============================================================================ */
 
CLAP_EXPORT clap_parse_result_t clap_parse_args(
    clap_parser_t *parser,
    int argc,
    char *argv[],
    clap_namespace_t **out_namespace,
    clap_error_t *error
);
 
/* ============================================================================
 * Namespace API
 * ============================================================================ */
 
CLAP_EXPORT void clap_namespace_free(clap_namespace_t *ns);
 
CLAP_EXPORT bool clap_namespace_get_string(clap_namespace_t *ns, const char *name, const char **value);
CLAP_EXPORT bool clap_namespace_get_int(clap_namespace_t *ns, const char *name, int *value);
CLAP_EXPORT bool clap_namespace_get_float(clap_namespace_t *ns, const char *name, double *value);
CLAP_EXPORT bool clap_namespace_get_bool(clap_namespace_t *ns, const char *name, bool *value);
CLAP_EXPORT bool clap_namespace_get_string_array(clap_namespace_t *ns, const char *name,
                                      const char ***values, size_t *count);
 
CLAP_EXPORT bool clap_namespace_set_string(clap_namespace_t *ns, const char *name, const char *value);
CLAP_EXPORT bool clap_namespace_set_int(clap_namespace_t *ns, const char *name, int value);
CLAP_EXPORT bool clap_namespace_set_float(clap_namespace_t *ns, const char *name, double value);
CLAP_EXPORT bool clap_namespace_set_bool(clap_namespace_t *ns, const char *name, bool value);
CLAP_EXPORT bool clap_namespace_append_string(clap_namespace_t *ns, const char *name, const char *value);
 
CLAP_EXPORT bool clap_namespace_has(clap_namespace_t *ns, const char *name);
 
/* ============================================================================
 * Help and Version
 * ============================================================================ */
 
CLAP_EXPORT void clap_print_help(clap_parser_t *parser, FILE *stream);
CLAP_EXPORT void clap_print_version(clap_parser_t *parser, FILE *stream);
 
/* ============================================================================
 * Extension APIs
 * ============================================================================ */
 
CLAP_EXPORT bool clap_register_type(
    clap_parser_t *parser,
    const char *type_name,
    clap_type_handler_t handler,
    size_t output_size
);
 
/* ============================================================================
 * Dependency API
 * ============================================================================ */
 
CLAP_EXPORT bool clap_argument_requires(
    clap_argument_t *arg,
    clap_argument_t *required_arg,
    const char *error_msg
);
 
CLAP_EXPORT bool clap_argument_conflicts(
    clap_argument_t *arg,
    clap_argument_t *conflicting_arg,
    const char *error_msg
);
 
#ifdef __cplusplus
}
#endif
 
#endif /* CLAP_H */