/core/src/aos_shell.c - AMiRo-OS - Research for Cognitive Interaction

amiro-os / core / src / aos_shell.c @ 7de0cc90

History | View | Annotate | Download (49.698 KB)

       /*
       AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.
       Copyright (C) 2016..2019  Thomas Schöpping et al.
       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.
       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.
       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.
       */
       /**
        * @file    aos_shell.c
        * @brief   Shell code.
        * @details Shell code as well as shell related channels and streams.
+       *
        * @addtogroup aos_shell
        * @{
        */
       #include <amiroos.h>
       #include <string.h>
       #if (AMIROOS_CFG_SHELL_ENABLE == true) || (AMIROOS_CFG_TESTS_ENABLE == true)
       /******************************************************************************/
       /* LOCAL DEFINITIONS                                                          */
       /******************************************************************************/
       /**
        * @brief   Event mask to be set on OS related events.
        */
       #define AOS_SHELL_EVENTMASK_OS                  EVENT_MASK(0)
       /**
        * @brief   Event mask to be set on a input event.
        */
       #define AOS_SHELL_EVENTMASK_INPUT               EVENT_MASK(1)
       /******************************************************************************/
       /* EXPORTED VARIABLES                                                         */
       /******************************************************************************/
       /******************************************************************************/
       /* LOCAL TYPES                                                                */
       /******************************************************************************/
       /*
        * forward declarations
        */
       static size_t _channelwrite(void *instance, const uint8_t *bp, size_t n);
       static size_t _channelread(void *instance, uint8_t *bp, size_t n);
       static msg_t _channelput(void *instance, uint8_t b);
       static msg_t _channelget(void *instance);
       static msg_t _channelputt(void *instance, uint8_t b, sysinterval_t time);
       static msg_t _channelgett(void *instance, sysinterval_t time);
       static size_t _channelwritet(void *instance, const uint8_t *bp, size_t n, sysinterval_t time);
       static size_t _channelreadt(void *instance, uint8_t *bp, size_t n, sysinterval_t time);
       static msg_t _channelctl(void *instance, unsigned int operation, void *arg);
       static size_t _streamwrite(void *instance, const uint8_t *bp, size_t n);
       static size_t _stremread(void *instance, uint8_t *bp, size_t n);
       static msg_t _streamput(void *instance, uint8_t b);
       static msg_t _streamget(void *instance);
       static const struct AosShellChannelVMT _channelvmt = {
         (size_t) 0,
         _channelwrite,
         _channelread,
         _channelput,
         _channelget,
         _channelputt,
         _channelgett,
         _channelwritet,
         _channelreadt,
         _channelctl,
       };
       static const struct AosShellStreamVMT _streamvmt = {
         (size_t) 0,
         _streamwrite,
         _stremread,
         _streamput,
         _streamget,
       };
       /**
        * @brief   Enumerator of special keyboard keys.
        */
       typedef enum special_key {
         KEY_UNKNOWN,      /**< any/unknow key */
         KEY_AMBIGUOUS,    /**< key is ambiguous */
         KEY_TAB,          /**< tabulator key */
         KEY_ESCAPE,       /**< escape key */
         KEY_BACKSPACE,    /**< backspace key */
         KEY_INSERT,       /**< insert key */
         KEY_DELETE,       /**< delete key */
         KEY_HOME,         /**< home key */
         KEY_END,          /**< end key */
         KEY_PAGE_UP,      /**< page up key */
         KEY_PAGE_DOWN,    /**< page down key */
         KEY_ARROW_UP,     /**< arrow up key */
         KEY_ARROW_DOWN,   /**< arrow down key */
         KEY_ARROW_LEFT,   /**< arrow left key */
         KEY_ARROW_RIGHT,  /**< arrow right key */
       } special_key_t;
       /**
        * @brief   Enumerator for case (in)sensitive character matching.
        */
       typedef enum charmatch {
         CHAR_MATCH_NOT    = 0,  /**< Characters do not match at all. */
         CHAR_MATCH_NCASE  = 1,  /**< Characters would match case insensitive. */
         CHAR_MATCH_CASE   = 2,  /**< Characters do match with case. */
       } charmatch_t;
       /******************************************************************************/
       /* LOCAL VARIABLES                                                            */
       /******************************************************************************/
       /******************************************************************************/
       /* LOCAL FUNCTIONS                                                            */
       /******************************************************************************/
       /**
        * @brief   Implementation of the BaseAsynchronous write() method (inherited from BaseSequentialStream).
        */
       static size_t _channelwrite(void *instance, const uint8_t *bp, size_t n)
+      {
         if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_OUTPUT_ENABLED) {
           return streamWrite(((AosShellChannel*)instance)->asyncchannel, bp, n);
         } else {
           return 0;
+        }
+      }
       /**
        * @brief   Implementation of the BaseAsynchronous read() method (inherited from BaseSequentialStream).
        */
       static size_t _channelread(void *instance, uint8_t *bp, size_t n)
+      {
         if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_INPUT_ENABLED) {
           return streamRead(((AosShellChannel*)instance)->asyncchannel, bp, n);
         } else {
           return 0;
+        }
+      }
       /**
        * @brief   Implementation of the BaseAsynchronous put() method (inherited from BaseSequentialStream).
        */
       static msg_t _channelput(void *instance, uint8_t b)
+      {
         if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_OUTPUT_ENABLED) {
           return streamPut(((AosShellChannel*)instance)->asyncchannel, b);
         } else {
           return MSG_RESET;
+        }
+      }
       /**
        * @brief   Implementation of the BaseAsynchronous get() method (inherited from BaseSequentialStream).
        */
       static msg_t _channelget(void *instance)
+      {
         if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_INPUT_ENABLED) {
           return streamGet(((AosShellChannel*)instance)->asyncchannel);
         } else {
           return MSG_RESET;
+        }
+      }
       /**
        * @brief   Implementation of the BaseAsynchronous putt() method.
        */
       static msg_t _channelputt(void *instance, uint8_t b, sysinterval_t time)
+      {
         if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_OUTPUT_ENABLED) {
           return chnPutTimeout(((AosShellChannel*)instance)->asyncchannel, b, time);
         } else {
           return MSG_RESET;
+        }
+      }
       /**
        * @brief   Implementation of the BaseAsynchronous gett() method.
        */
       static msg_t _channelgett(void *instance, sysinterval_t time)
+      {
         if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_INPUT_ENABLED) {
           return chnGetTimeout(((AosShellChannel*)instance)->asyncchannel, time);
         } else {
           return MSG_RESET;
+        }
+      }
       /**
        * @brief   Implementation of the BaseAsynchronous writet() method.
        */
       static size_t _channelwritet(void *instance, const uint8_t *bp, size_t n, sysinterval_t time)
+      {
         if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_OUTPUT_ENABLED) {
           return chnWriteTimeout(((AosShellChannel*)instance)->asyncchannel, bp, n, time);
         } else {
           return 0;
+        }
+      }
       /**
        * @brief   Implementation of the BaseAsynchronous readt() method.
        */
       static size_t _channelreadt(void *instance, uint8_t *bp, size_t n, sysinterval_t time)
+      {
         if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_INPUT_ENABLED) {
           return chnReadTimeout(((AosShellChannel*)instance)->asyncchannel, bp, n, time);
         } else {
           return 0;
+        }
+      }
       /**
        * @brief   Implementation of the BaseAsynchronousChannel ctl() method.
        */
       static msg_t _channelctl(void *instance, unsigned int operation, void *arg)
+      {
         (void) instance;
         switch (operation) {
         case CHN_CTL_NOP:
           osalDbgCheck(arg == NULL);
           break;
         case CHN_CTL_INVALID:
           osalDbgAssert(false, "invalid CTL operation");
           break;
         default:
           break;
+        }
         return MSG_OK;
+      }
       static size_t _streamwrite(void *instance, const uint8_t *bp, size_t n)
+      {
         aosDbgCheck(instance != NULL);
         // local variables
         AosShellChannel* channel = ((AosShellStream*)instance)->channel;
         size_t bytes;
         size_t maxbytes = 0;
         // iterate through the list of channels
         while (channel != NULL) {
           bytes = streamWrite(channel, bp, n);
           maxbytes = (bytes > maxbytes) ? bytes : maxbytes;
           channel = channel->next;
+        }
         return maxbytes;
+      }
       static size_t _stremread(void *instance, uint8_t *bp, size_t n)
+      {
         (void)instance;
         (void)bp;
         (void)n;
         return 0;
+      }
       static msg_t _streamput(void *instance, uint8_t b)
+      {
         aosDbgCheck(instance != NULL);
         // local variables
         AosShellChannel* channel = ((AosShellStream*)instance)->channel;
         msg_t ret = MSG_OK;
         // iterate through the list of channels
         while (channel != NULL) {
           msg_t ret_ = streamPut(channel, b);
           ret = (ret_ < ret) ? ret_ : ret;
           channel = channel->next;
+        }
         return ret;
+      }
       static msg_t _streamget(void *instance)
+      {
         (void)instance;
         return 0;
+      }
       /**
        * @brief   Print the shell prompt
        * @details Depending on the configuration flags, the system uptime is printed before the prompt string.
+       *
        * @param[in] shell   Pointer to the shell object.
        */
       static void _printPrompt(aos_shell_t* shell)
+      {
         aosDbgCheck(shell != NULL);
         // print some time informattion before prompt if configured
         if (shell->config & (AOS_SHELL_CONFIG_PROMPT_UPTIME | AOS_SHELL_CONFIG_PROMPT_DATETIME)) {
           // printf the system uptime
           if ((shell->config & (AOS_SHELL_CONFIG_PROMPT_UPTIME | AOS_SHELL_CONFIG_PROMPT_DATETIME)) == AOS_SHELL_CONFIG_PROMPT_UPTIME) {
             // get current system uptime
             aos_timestamp_t uptime;
             aosSysGetUptime(&uptime);
             chprintf((BaseSequentialStream*)&shell->stream, "[%01u:%02u:%02u:%02u:%03u:%03u] ",
                      (uint32_t)(uptime / MICROSECONDS_PER_DAY),
                      (uint8_t)(uptime % MICROSECONDS_PER_DAY / MICROSECONDS_PER_HOUR),
                      (uint8_t)(uptime % MICROSECONDS_PER_HOUR / MICROSECONDS_PER_MINUTE),
                      (uint8_t)(uptime % MICROSECONDS_PER_MINUTE / MICROSECONDS_PER_SECOND),
                      (uint16_t)(uptime % MICROSECONDS_PER_SECOND / MICROSECONDS_PER_MILLISECOND),
                      (uint16_t)(uptime % MICROSECONDS_PER_MILLISECOND / MICROSECONDS_PER_MICROSECOND));
+          }
       #if (HAL_USE_RTC == TRUE)
           else if ((shell->config & (AOS_SHELL_CONFIG_PROMPT_UPTIME | AOS_SHELL_CONFIG_PROMPT_DATETIME)) == AOS_SHELL_CONFIG_PROMPT_DATETIME) {
             // get current RTC time
             struct tm dt;
             aosSysGetDateTime(&dt);
             chprintf((BaseSequentialStream*)&shell->stream, "[%02u-%02u-%04u|%02u:%02u:%02u] ",
                      dt.tm_mday,
                      dt.tm_mon + 1,
                      dt.tm_year + 1900,
                      dt.tm_hour,
                      dt.tm_min,
                      dt.tm_sec);
+          }
       #endif /* (HAL_USE_RTC == TRUE) */
           else {
             aosDbgAssert(false);
+          }
+        }
         // print the actual prompt string
         if (shell->prompt && !(shell->config & AOS_SHELL_CONFIG_PROMPT_MINIMAL)) {
           chprintf((BaseSequentialStream*)&shell->stream, "%s$ ", shell->prompt);
         } else {
           chprintf((BaseSequentialStream*)&shell->stream, "%>$ ");
+        }
         return;
+      }
       /**
        * @brief   Interprete a escape sequence
        * @details This function interpretes escape sequences (starting with ASCII
        *          "Escape" character 0x1B) according to the VT100 / VT52 ANSI escape
        *          sequence definitions.
        * @note    Only the most important escape sequences are implemented yet.
+       *
        * @param[in] seq   Character sequence to interprete.
        *                  Must be terminated by NUL byte.
+       *
        * @return          A @p special_key value.
        */
       static special_