rte_argparse.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2024 HiSilicon Limited
 */

#ifndef RTE_ARGPARSE_H
#define RTE_ARGPARSE_H

#include <stdbool.h>
#include <stdint.h>

#include <rte_bitops.h>
#include <rte_compat.h>

#ifdef __cplusplus
extern "C" {
#endif

enum rte_argparse_value_required {
    RTE_ARGPARSE_VALUE_NONE,
    RTE_ARGPARSE_VALUE_REQUIRED,
    RTE_ARGPARSE_VALUE_OPTIONAL,
};

enum rte_argparse_value_type {
    RTE_ARGPARSE_VALUE_TYPE_NONE = 0,
    RTE_ARGPARSE_VALUE_TYPE_INT,
    RTE_ARGPARSE_VALUE_TYPE_U8,
    RTE_ARGPARSE_VALUE_TYPE_U16,
    RTE_ARGPARSE_VALUE_TYPE_U32,
    RTE_ARGPARSE_VALUE_TYPE_U64,
    RTE_ARGPARSE_VALUE_TYPE_STR,
    RTE_ARGPARSE_VALUE_TYPE_BOOL,
    RTE_ARGPARSE_VALUE_TYPE_CORELIST,
};

enum rte_argparse_arg_flags {
    RTE_ARGPARSE_FLAG_SUPPORT_MULTI = RTE_BIT32(0),
};

struct rte_argparse_arg {
    const char *name_long;
    const char *name_short;

    const char *help;

    void *val_saver;
    void *val_set;

    enum rte_argparse_value_required value_required;
    enum rte_argparse_value_type value_type;

    uint32_t flags;
};

typedef int (*rte_arg_parser_t)(uint32_t index, const char *value, void *opaque);

struct rte_argparse {
    const char *prog_name;
    const char *usage;
    const char *descriptor;
    const char *epilog;
    bool exit_on_error;
    bool ignore_non_flag_args;
    /* reserved for future flags/other use */
    bool reserved_flags[6];
    rte_arg_parser_t callback;
    void *opaque;
    void (*print_help)(const struct rte_argparse *obj);
    void *reserved[15];
    struct rte_argparse_arg args[];
};

#define ARGPARSE_ARG_END() { NULL }

__rte_experimental
int rte_argparse_parse(const struct rte_argparse *obj, int argc, char **argv);

__rte_experimental
void rte_argparse_print_help(FILE *stream, const struct rte_argparse *obj);

__rte_experimental
int rte_argparse_parse_type(const char *str, enum rte_argparse_value_type val_type, void *val);

#ifdef __cplusplus
}
#endif

#endif /* RTE_ARGPARSE_H */