cli.h

/**
 * @file cli.h
 * Implements a generic console that can read command strings. Command
 * strings are not handled in this file.
 * Interface-specific (UART, SPI, etc...) handling should be done in
 * another file, this file abstracts it.
 *
 * This code assumes that the connected terminal emulates a VT-100.
 */

#ifndef CLI_H
#define CLI_H

/** CLI configuration parameters */
#define CLI_MAX_LINE 80 // max command length
#define CLI_HISTORY 3   // max number of past commands to store
#define PRINT_BUFLEN 256 // size of printf buffer to use.

#define CLI_BUFCNT CLI_HISTORY + 2 // Used internally for CLI buffer length

typedef struct {
    /*! buffer to store the commandline data */
    char line_buf[CLI_MAX_LINE];
    /*! length of line */
    int len;
} CLI_Line;

typedef struct {
    /*! read bytes into the buffer. Returns the number of bytes read. */
    int (*cli_read)(char *, int);
    /*! write data for output on the CLI. Returns number of bytes written. */
    int (*cli_write)(char *, int);
    /*! current pointer location */
    char *cursor;
    /*! line buffers */
    CLI_Line lines[CLI_BUFCNT];
    /*! Index of current line buffer */
    int line_idx;
} CLIContext;

/**
 * CLI Printf function. Same syntax as printf.
 * @param context CLI context to print to
 * @param format printf style format string
 */
void cli_printf(CLIContext *context, const char *format, ...);

/**
 * Initializes memory for a CLI context.
 * @param context: CLI context to init.
 */
void cli_context_init(CLIContext *context);

/**
 * Runs the embedded CLI for this program. The provided context exposes read
 * and write functions for a communication interface.
 * @param context: CLI context for I/O.
 */
void start_cli(CLIContext *context);

#endif