shellmatta/api/shellmatta.h

/*
 * MIT License
 *
 * Copyright (c) 2019 Stefan Strobel <stefan.strobel@shimatta.net>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH
 * THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

/**
 * @file shellmatta.h
 * @brief API definition of the Shellmatta terminal implementation
 * @author Stefan Strobel <stefan.strobel@shimatta.net>
 */

/**
 * @addtogroup shellmatta
 * @{
 */

#ifndef _SHELLMATTA_H_
#define _SHELLMATTA_H_

#include <stdint.h>

/**
 * @brief definition of shellmatta return codes
 */
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_retCode_t;

/**
 * @brief shellmatta command function definition
 */
typedef shellmatta_retCode_t (*shellmatta_cmdFct_t)(int argc, char *argv[]);

/**
 * @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        */
} shellmatta_cmd_t;

/**
 * @brief structure of one shellmatta instance
 */
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           */
} 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);
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, ...);
void shellmatta_getArg(uint32_t cnt, uint8_t *arg);

#endif

/** @} */