cli_help.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2019-2022 Intel Corporation.
 */
 
#ifndef _CLI_HELP_H_
#define _CLI_HELP_H_
 
#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>        // for strcmp
#include <stdarg.h>
#include <unistd.h>
#include <inttypes.h>
#include <sys/queue.h>        // for TAILQ_ENTRY
 
#include "cli_map.h"           // for cli_map
#include "cne_common.h"        // for CNDP_API
 
// IWYU pragma: no_forward_declare cli_map
struct cli_map;
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define CLI_HELP_PAUSE    "<<PauseOutput>>"
#define CLI_HELP_NAME_LEN 32
 
struct help_node {
    TAILQ_ENTRY(help_node) next; 
    char group[CLI_HELP_NAME_LEN];
    struct cli_map *map;
    const char **help_data;
};
 
CNDP_API struct help_node *cli_help_find_group(const char *group);
 
CNDP_API int cli_help_show_all(const char *msg);
 
CNDP_API int cli_help_show_group(const char *group);
 
CNDP_API int cli_help_add(const char *group, struct cli_map *map, const char **hd);
 
static inline int
is_help(int argc, char **argv)
{
    if (argc == 0)
        return 0;
 
    return !strcmp("-?", argv[argc - 1]) || !strcmp("?", argv[argc - 1]);
}
 
CNDP_API void cli_help_foreach(void (*func)(void *arg, const char **h), void *arg);
 
CNDP_API int cli_cmd_error(const char *msg, const char *group, int argc, char **argv);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _CLI_HELP_H_ */