hal_cli.h

Go to the documentation of this file.

#ifndef HAL_CLI_H
#define HAL_CLI_H

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


#ifndef CLI_COMMAND_BUF_SIZE

#define CLI_COMMAND_BUF_SIZE    127

#endif

typedef struct CLIConsoleDesc* CLIConsole;

typedef enum {
    CLI_NO_ACTION,
    CLI_DEFAULT_ACTION,
    CLI_USER_ACTION,
    CLI_BUSY,
} CLIConsoleAction;

struct CLIConsoleDesc {
    IODevice iodevice;
    struct {
        uint8_t busy : 1;
        uint8_t multichar : 1;
        uint8_t doublechar : 1;
    } state;
    void (*command_processor) (CLIConsole clic);
    char buf[CLI_COMMAND_BUF_SIZE];
    size_t cnt;
    size_t offset;
    int cols;
    int rows;
};

#define CLI_DECLARE(name, iodevice, command_processor, attribute) \
    static struct CLIConsoleDesc name##_desc = {iodevice, {0,0,0}, command_processor, {0x00}, 0, 0 }; \
    attribute CLIConsole name = &name##_desc


CLIConsole CLI_Create(IODevice iodevice);

void CLI_Destroy(CLIConsole cli);

void CLI_DisplayMainScreen(CLIConsole cli);

CLIConsoleAction CLI_ProcessConsole(CLIConsole cli);

void CLI_SetCommandProcessor(CLIConsole cli, void (*cmd_proc) (CLIConsole cli));

void CLI_ForceCommandMode(CLIConsole cli);

void CLI_CursorSave(CLIConsole cli);

void CLI_CursorRestore(CLIConsole cli);

void CLI_CursorRest(CLIConsole cli);

bool CLI_GetCommand(CLIConsole cli, char* dst, size_t dst_size);

bool CLI_IsNextArg(CLIConsole cli);

bool CLI_GetNextArg(CLIConsole cli, char* arg);

bool CLI_GetNextArgAndConvertToLowerCase(CLIConsole cli, char* arg, size_t argMaxSize);

bool CLI_GetNextArgINT32(CLIConsole cli, int32_t *arg);

bool CLI_GetNextArgUINT32(CLIConsole cli, uint32_t *arg);

bool CLI_GetNextArgINT64(CLIConsole cli, int64_t *arg);

bool CLI_GetNextArgUINT64(CLIConsole cli, uint64_t *arg);

void CLI_GetBack(CLIConsole cli, int argc);


#define CLI_HaltConsoleInput(cli)           do { cli->state.busy = 1; } while (0)

#define CLI_EnableConsoleInput(cli)         do { cli->state.busy = 0; } while (0)

#define CLI_GetIODevice(cli)                (cli->iodevice)

#define CLI_SetIODevice(cli,device)         (cli->iodevice=device)

#endif /* HAL_CLI_H */