shell.h

Go to the documentation of this file.

 
// ALLOW FORMATTING
#ifndef _SHELL_H
#define _SHELL_H
 
#include "FreeRTOS.h"
#include "stdbool.h"
#include "stdint.h"
#include "task.h"
 
#include "uart.h"
 
// clang-format off
 
// Macro for shell program definition boilerplate. The expansion of this will define
// a static global-scope ShellProgramHandle_t pointer to a compound literal struct.
#define DEFINE_PROGRAM_HANDLE(progName, execFunction)                              \
  static ShellProgramHandle_t __attribute__((section(".shell_" progName), unused)) \
  *progHandle = &(ShellProgramHandle_t){                                           \
      .name = progName,                                                            \
      .exec = execFunction                                                         \
  };
 
// Max allowable characters for name
#define SHELL_PROGRAM_NAME_LENGTH 20
 
// Terminal clear screen control sequence
#define CMD_CLEAR "\033[3J\033[H\033[2J"
 
// clang-format on


typedef struct Shell {
  UART_t usb;                                 
  void (*help)(struct Shell *);               
  void (*run)(struct Shell *, uint8_t *);     
  void (*runTask)(struct Shell *, uint8_t *); 
  bool (*clear)(struct Shell *);              
  TaskHandle_t taskHandle;                    
} Shell;

typedef struct ShellProgramHandle_t {
  char name[SHELL_PROGRAM_NAME_LENGTH];    
  void (*exec)(struct Shell *, uint8_t *); 
} ShellProgramHandle_t;

typedef struct ShellTaskParams {
  Shell *shell; 
  uint8_t *str; 
} ShellTaskParams;
 
int Shell_init(Shell *);
void Shell_help(Shell *);
void Shell_runTask(Shell *, uint8_t *);
void Shell_run(Shell *, uint8_t *);
bool Shell_clear(Shell *);

 
#endif