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

amiro-os / core / src / aos_shell.c @ 47e89ebf

History | View | Annotate | Download (54.703 KB)

-            e545e620
+/*
 AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.
-f0ce9e
+Copyright (C) 2016..2019  Thomas Schöpping et al.
-            e545e620
+            Thomas Schöpping
 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/>.
 */
-ca3
+/**
  * @file    aos_shell.c
  * @brief   Shell code.
  * @details Shell code as well as shell related channels and streams.
+ *
  * @addtogroup aos_shell
  * @{
  */
-ba8a
+#include <amiroos.h>
 #include <string.h>
-            e545e620
+            Thomas Schöpping
-e89ebf
+#if (AMIROOS_CFG_SHELL_ENABLE == true) || defined(__DOXYGEN__)
-ba8a
+            Thomas Schöpping
-            f3ac1c96
+/******************************************************************************/
 /* LOCAL DEFINITIONS                                                          */
 /******************************************************************************/
-            ba516b61
+            Thomas Schöpping
 /**
  * @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)
-            f3ac1c96
+/******************************************************************************/
 /* 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 {
-            cc33217b
+  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 */
   KEY_CTRL_ARROW_UP,    /**< CTRL + arrow up key */
   KEY_CTRL_ARROW_DOWN,  /**< CTRL + arrow down key */
   KEY_CTRL_ARROW_LEFT,  /**< CTRL + arrow left key */
   KEY_CTRL_ARROW_RIGHT, /**< CTRL + arrow right key */
-            f3ac1c96
+} 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                                                            */
 /******************************************************************************/
-            ba516b61
+/**
  * @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) {
-            dd8738ea
+    return streamWrite(((AosShellChannel*)instance)->asyncchannel, bp, n);
-            ba516b61
+  } 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)
+{
-            dd8738ea
+  if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_INPUT_ENABLED) {
     return streamRead(((AosShellChannel*)instance)->asyncchannel, bp, n);
   } else {
     return 0;
+  }
-            ba516b61
+            Thomas Schöpping
 /**
  * @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) {
-            dd8738ea
+    return streamPut(((AosShellChannel*)instance)->asyncchannel, b);
-            ba516b61
+  } else {
     return MSG_RESET;
+  }
+}
 /**
  * @brief   Implementation of the BaseAsynchronous get() method (inherited from BaseSequentialStream).
  */
 static msg_t _channelget(void *instance)
+{
-            dd8738ea
+  if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_INPUT_ENABLED) {
     return streamGet(((AosShellChannel*)instance)->asyncchannel);
   } else {
     return MSG_RESET;
+  }
-            ba516b61
+            Thomas Schöpping
 /**
  * @brief   Implementation of the BaseAsynchronous putt() method.
  */
-c99037f
+static msg_t _channelputt(void *instance, uint8_t b, sysinterval_t time)
-            ba516b61
+            Thomas Schöpping
   if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_OUTPUT_ENABLED) {
-            dd8738ea
+    return chnPutTimeout(((AosShellChannel*)instance)->asyncchannel, b, time);
-            ba516b61
+  } else {
     return MSG_RESET;
+  }
+}
 /**
  * @brief   Implementation of the BaseAsynchronous gett() method.
  */
-c99037f
+static msg_t _channelgett(void *instance, sysinterval_t time)
-            ba516b61
+            Thomas Schöpping
-            dd8738ea
+  if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_INPUT_ENABLED) {
     return chnGetTimeout(((AosShellChannel*)instance)->asyncchannel, time);
   } else {
     return MSG_RESET;
+  }
-            ba516b61
+            Thomas Schöpping
 /**
  * @brief   Implementation of the BaseAsynchronous writet() method.
  */
-c99037f
+static size_t _channelwritet(void *instance, const uint8_t *bp, size_t n, sysinterval_t time)
-            ba516b61
+            Thomas Schöpping
   if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_OUTPUT_ENABLED) {
-            dd8738ea
+    return chnWriteTimeout(((AosShellChannel*)instance)->asyncchannel, bp, n, time);
-            ba516b61
+  } else {
     return 0;
+  }
+}
 /**
  * @brief   Implementation of the BaseAsynchronous readt() method.
  */
-c99037f
+static size_t _channelreadt(void *instance, uint8_t *bp, size_t n, sysinterval_t time)
-            ba516b61
+            Thomas Schöpping
-            dd8738ea
+  if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_INPUT_ENABLED) {
     return chnReadTimeout(((AosShellChannel*)instance)->asyncchannel, bp, n, time);
   } else {
     return 0;
+  }
             ba516b61