mhu/shellmatta
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

implemented most text based functions:

Browse Source 
- byte wise processing and call of the command function
- history buffer
- auto complete
- edit functions (backspace, del, arrow keys, pos1, end)
This commit is contained in:
prozessorkern
2019-06-21 04:47:35 +02:00
parent 799903dcc1
commit bf7f366cb6
2 changed files with 774 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
api/shellmatta.h
View File

@@ -37,6 +37,7 @@
#define _SHELLMATTA_H_
#include <stdint.h>
#include <stdbool.h>
/**
* @brief definition of shellmatta return codes
@@ -46,25 +47,40 @@ typedef enum
SHELLMATTA_OK = 0u, /**< everything is OK */
SHELLMATTA_ERROR , /**< error occured */
SHELLMATTA_CONTINUE , /**< the function is not over */
SHELLMATTA_USE_FAULT /**< parameter error - wrong usage */
SHELLMATTA_USE_FAULT , /**< parameter error - wrong usage */
SHELLMATTA_DUPLICATE /**< duplicate command */
} shellmatta_retCode_t;
/**
* @brief definition of shellmatta insert mode
*/
typedef enum
{
SHELLMATTA_MODE_INSERT = 0u, /**< insert mode */
SHELLMATTA_MODE_OVERWRITE , /**< overwrite mode */
} shellmatta_mode_t;
/**
* @brief shellmatta command function definition
*/
typedef shellmatta_retCode_t (*shellmatta_cmdFct_t)(int argc, char *argv[]);
/**
* @brief shellmatta write function definition
*/
typedef shellmatta_retCode_t (*shellmatta_write_t)(const char* data, uint32_t length);
/**
* @brief structure of one shellmatta command
*/
typedef struct shellmatta_cmd
{
char *cmd; /**< command name */
char *cmdAlias; /**< command alias */
char *helpText; /**< help text to print in "help" command */
char *usageText; /**< usage text to print on parameter error */
shellmatta_cmdFct_t cmdFct; /**< pointer to the cmd callack function */
struct shellmatta_cmd *next; /**< pointer to next command or NULL */
char *cmd; /**< command name */
char *cmdAlias; /**< command alias */
char *helpText; /**< help text to print in "help" command */
char *usageText; /**< usage text to print on parameter error */
shellmatta_cmdFct_t cmdFct; /**< pointer to the cmd callack function */
struct shellmatta_cmd *next; /**< pointer to next command or NULL */
} shellmatta_cmd_t;
/**
@@ -72,17 +88,35 @@ typedef struct shellmatta_cmd
*/
typedef struct
{
uint8_t *buffer; /**< input buffer */
uint32_t bufferSize; /**< size of the input buffer */
uint32_t bufferWritePointer; /**< offset of the current write operation */
uint32_t bufferReadPointer; /**< offset of the current read operation */
uint8_t *historyBuffer; /**< buffer to store the last commands */
uint32_t historyBufferSize; /**< size of the history buffer */
shellmatta_cmd_t *cmdList; /**< pointer to the first command */
uint8_t *buffer; /**< input buffer */
uint32_t bufferSize; /**< size of the input buffer */
uint32_t inputCount; /**< offset of the current write operation */
uint32_t cursor; /**< offset where the cursor is at */
uint8_t *historyBuffer; /**< buffer to store the last commands */
uint32_t historyBufferSize; /**< size of the history buffer */
uint32_t historyStart; /**< index of the oldest stored command */
uint32_t historyEnd; /**< index of the newest stored command */
uint32_t historyRead; /**< index of the current search */
bool historyReadUp; /**< flag to show the last history dir */
uint32_t tabCounter; /**< counts the tabulator key presses */
uint32_t escapeCounter; /**< counts the characters of an escape seq */
uint8_t escapeChars[4]; /**< buffer to save the escape characters */
bool echoEnabled; /**< if true the input is printed */
bool dirty; /**< dirty flag to show changes */
const char *prompt; /**< prompt is printed after every command */
shellmatta_mode_t mode; /**< mode of the shell */
shellmatta_write_t write; /**< pointer to write function */
shellmatta_cmd_t *cmdList; /**< pointer to the first command */
} shellmatta_instance_t;
void shellmatta_doInit(shellmatta_instance_t *inst, uint8_t *buffer, uint32_t bufferSize, uint8_t *historyBuffer, uint32_t historyBufferSize);
void shellmatta_addCmd(shellmatta_instance_t *inst, shellmatta_cmd_t *cmd);
shellmatta_retCode_t shellmatta_doInit( shellmatta_instance_t *inst,
uint8_t *buffer,
uint32_t bufferSize,
uint8_t *historyBuffer,
uint32_t historyBufferSize,
const char *prompt,
shellmatta_write_t writeFct);
shellmatta_retCode_t shellmatta_addCmd(shellmatta_instance_t *inst, shellmatta_cmd_t *cmd);
void shellmatta_doTask(shellmatta_instance_t *inst, uint32_t time);
void shellmatta_processData(shellmatta_instance_t *inst, char *data, uint32_t size);
void shellmatta_printf(shellmatta_instance_t *inst, const char *fmt, ...);