cli.h

Go to the documentation of this file.

 
#ifndef __TBOX_CLI_H__
#define __TBOX_CLI_H__
 
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C"
{
#endif

#define TBOX_CLI_MODULE_ABI_VERSION 2U

typedef int (*tbox_cli_handler_t)(size_t argument_count, const char* arguments[]);

typedef int (*tbox_cli_pre_init_t)(void);

typedef int (*tbox_cli_deinit_t)(void);

typedef struct
{
    const char* name;        
    const char* value_help;  
    const char* description; 
    char        short_name;  
} tbox_cli_argument_t;

typedef struct
{
    const char*                name;           
    tbox_cli_handler_t         handler;        
    const tbox_cli_argument_t* arguments;      
    size_t                     argument_count; 
    const char*                description;    
} tbox_cli_command_t;

typedef struct
{
    const char*               name;          
    const char*               description;   
    tbox_cli_pre_init_t       pre_init;      
    tbox_cli_deinit_t         deinit;        
    const tbox_cli_command_t* commands;      
    size_t                    command_count; 
} tbox_cli_module_t;

typedef struct
{
    uint32_t                 abi_version;  
    const tbox_cli_module_t* modules;      
    size_t                   module_count; 
} tbox_cli_module_set_t;

const tbox_cli_module_set_t* tbox_cli_get_modules(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __TBOX_CLI_H__ */