/core/inc/aos_shell.h - Annotate - AMiRo-OS - Research for Cognitive Interaction

amiro-os / core / inc / aos_shell.h @ f606e2bf

History | View | Annotate | Download (12.132 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.h
  * @brief   Shell macros and structures.
+ *
  * @addtogroup aos_shell
  * @{
  */
-ff06bbf
+#ifndef AMIROOS_SHELL_H
 #define AMIROOS_SHELL_H
-            e545e620
+            Thomas Schöpping
-ba8a
+#include <amiroos.h>
-            cda14729
+#if (AMIROOS_CFG_SHELL_ENABLE == true) || defined(__DOXYGEN__)
-ba8a
+            Thomas Schöpping
-            f3ac1c96
+/******************************************************************************/
 /* CONSTANTS                                                                  */
 /******************************************************************************/
-            e545e620
+            Thomas Schöpping
 /**
-            cc33217b
+ * @brief   Size of the escape sequence buffer.
  */
 #if !defined(AOS_SHELL_ESCSEQUENCE_LENGTH) || defined(__DOXYGEN__)
 #define AOS_SHELL_ESCSEQUENCE_LENGTH              8
 #endif
 /**
-            e545e620
+ * @brief   Shell event flag that is emitted when the thread starts.
  */
-            ba516b61
+#define AOS_SHELL_EVTFLAG_START                   ((eventflags_t)(1 << 0))
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   Shell event flag that is emitted when a command is executed.
  */
-            ba516b61
+#define AOS_SHELL_EVTFLAG_EXEC                    ((eventflags_t)(1 << 1))
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   Shell event flag that is emitted when a command execution finished.
  */
-            ba516b61
+#define AOS_SHELL_EVTFLAG_DONE                    ((eventflags_t)(1 << 2))
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   Shell event flag that is emitted when the shread stops.
  */
-            ba516b61
+#define AOS_SHELL_EVTFLAG_EXIT                    ((eventflags_t)(1 << 3))
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   Shell event flag that is emitted when an I/O error occurred.
  */
-            ba516b61
+#define AOS_SHELL_EVTFLAG_IOERROR                 ((eventflags_t)(1 << 4))
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   Shell input configuration for replacing content by user input.
  */
-            ba516b61
+#define AOS_SHELL_CONFIG_INPUT_OVERWRITE          (1 << 0)
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   Shell prompt configuration print a minimalistic prompt.
  */
-            ba516b61
+#define AOS_SHELL_CONFIG_PROMPT_MINIMAL           (1 << 1)
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   Shell prompt configuration to additionally print the system uptime with the prompt.
  */
-            ba516b61
+#define AOS_SHELL_CONFIG_PROMPT_UPTIME            (1 << 2)
-            e545e620
+            Thomas Schöpping
 /**
-aeae
+ * @brief   Shell prompt configuration to additionally print the date and time with the prompt.
  */
 #define AOS_SHELL_CONFIG_PROMPT_DATETIME          (2 << 2)
 /**
-            e545e620
+ * @brief   Shell prompt configuration to additionally print the system uptime with the prompt.
  */
-aeae
+#define AOS_SHELL_CONFIG_MATCH_CASE               (1 << 4)
-            ba516b61
+            Thomas Schöpping
 /**
  * @brief   Shell I/O channel flag whether the channel is attached to a list.
  */
 #define AOS_SHELLCHANNEL_ATTACHED                 (1 << 0)
 /**
  * @brief   Shell I/O channel flag whether the channel is enabled as input.
  */
 #define AOS_SHELLCHANNEL_INPUT_ENABLED            (1 << 1)
 /**
  * @brief   Shell I/O channel flag whether the channel is enabled as output.
  */
 #define AOS_SHELLCHANNEL_OUTPUT_ENABLED           (1 << 2)
-            f3ac1c96
+/******************************************************************************/
 /* SETTINGS                                                                   */
 /******************************************************************************/
 /******************************************************************************/
 /* CHECKS                                                                     */
 /******************************************************************************/
 /******************************************************************************/
 /* DATA STRUCTURES AND TYPES                                                  */
 /******************************************************************************/
-            ba516b61
+            Thomas Schöpping
 /**
  * @brief   AosShellChannel specific methods.
  */
 #define _aos_shell_channel_methods                                          \
   _base_asynchronous_channel_methods
 /**
  * @brief   AosShellChannel specific data.
  */
 #define _aos_shell_channel_data                                             \
-            dd8738ea
+  /* pointer to a BaseAsynchronousChannel object */                         \
   BaseAsynchronousChannel* asyncchannel;                                    \
-            ba516b61
+  /* event listener for the associated BaseAsynchronousChannel */           \
   event_listener_t listener;                                                \
   /* pointer to the next chennal in a AosShellStream */                     \
-            f3ac1c96
+  struct aos_shellchannel* next;                                            \
-            ba516b61
+  /* flags related to the channel */                                        \
   uint8_t flags;
 /**
  * @extends BaseAsynchronousChannelVMT
+ *
  * @brief   AosShellChannel virtual methods table.
  */
 struct AosShellChannelVMT {
   _aos_shell_channel_methods
 };
 /**
  * @extends BaseAsynchronousChannel
+ *
  * @brief   Shell channel class.
  * @details This class implements an asynchronous I/O channel.
  */
-            f3ac1c96
+typedef struct aos_shellchannel {
-            ba516b61
+  /** @brief Virtual Methods Table. */
   const struct AosShellChannelVMT* vmt;
   _aos_shell_channel_data
-            f3ac1c96
+} AosShellChannel;
-            ba516b61
+            Thomas Schöpping
 /**
  * @brief   AosShellStream methods.
  */
 #define _aos_shellstream_methods                                            \
   _base_sequential_stream_methods
 /**
  * @brief   AosShellStream data.
  */
 #define _aos_shellstream_data                                               \
   /* Pointer to the first channel in a list. */                             \
   AosShellChannel* channel;
 /**
  * @extends BaseSequentialStream
+ *
  * @brief   AosShellStream virtual methods table.
  */
 struct AosShellStreamVMT {
   _aos_shellstream_methods
 };
 /**
  * @extends BaseSequentialStream
+ *
  * @brief   Shell Stream class.
  * @details This class implements an base sequential stream.
  * @todo    So far only output but no input is supported.
  */
-            f3ac1c96
+typedef struct aos_shellstream {
-            ba516b61
+  const struct AosShellStreamVMT* vmt;
   _aos_shellstream_data
-            f3ac1c96
+} AosShellStream;
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   Shell command calback type.
-c72a54c
+            Thomas Schöpping
  * @param[in] stream  Stream to print to.
  * @param[in] argc    Number of arguments.
  * @param[in] argv    List of arguments.
-            e545e620
+ */
 typedef int (*aos_shellcmdcb_t)(BaseSequentialStream* stream, int argc, char* argv[]);
 /**
  * @brief   Shell command structure.
  */
 typedef struct aos_shellcommand {
   /**
    * @brief   Command name.
    */
   const char* name;
   /**
    * @brief   Callback function.
    */
   aos_shellcmdcb_t callback;
   /**
    * @brief   Pointer to next command in a singly linked list.
    */
   struct aos_shellcommand* next;
-            ba516b61
+            Thomas Schöpping
-            e545e620
+} aos_shellcommand_t;
 /**
  * @brief   Execution status of a shell command.
  */
 typedef struct aos_shellexecstatus {
-            ba516b61
+  /**
    * @brief   Pointer to the command that was executed.
    */
   aos_shellcommand_t* command;
   /**
    * @brief   Return value of the executed command.
    */
   int retval;
-            e545e620
+} aos_shellexecstatus_t;
 /**
-            ba516b61
+ * @brief   Enumerator to encode shell actions.
  */
 typedef enum aos_shellaction {
-            dd8738ea
+  AOS_SHELL_ACTION_NONE,
-            ba516b61
+  AOS_SHELL_ACTION_READCHAR,
   AOS_SHELL_ACTION_AUTOFILL,
   AOS_SHELL_ACTION_SUGGEST,
   AOS_SHELL_ACTION_INSERTTOGGLE,
   AOS_SHELL_ACTION_DELETEFORWARD,
   AOS_SHELL_ACTION_DELETEBACKWARD,
   AOS_SHELL_ACTION_RECALLLAST,
   AOS_SHELL_ACTION_CLEAR,
   AOS_SHELL_ACTION_CURSOR2START,
   AOS_SHELL_ACTION_CURSOR2END,
   AOS_SHELL_ACTION_CURSORLEFT,
   AOS_SHELL_ACTION_CURSORRIGHT,
-            cc33217b
+  AOS_SHELL_ACTION_CURSORWORDLEFT,
   AOS_SHELL_ACTION_CURSORWORDRIGHT,
-            ba516b61
+  AOS_SHELL_ACTION_EXECUTE,
   AOS_SHELL_ACTION_ESCSTART,
-            cc33217b
+  AOS_SHELL_ACTION_PRINTUNKNOWNSEQUENCE,
-            ba516b61
+} aos_shellaction_t;
 /**
-            e545e620
+ * @brief   Shell structure.
  */
 typedef struct aos_shell {
   /**
    * @brief   Pointer to the thread object.
    */
   thread_t* thread;
   /**
    * @brief   Event source.
    */
   event_source_t eventSource;
   /**
-            ba516b61
+   * @brief   Struct for OS related events
-            e545e620
+   */
-            ba516b61
+  struct {
     /**
      * @brief   Pointer to the OS' event source.
      */
     event_source_t* eventSource;
     /**
      * @brief   Listener for OS related events.
      */
     event_listener_t eventListener;
   } os;
   /**
      * @brief   Pointer to the first I/O channel.
      */
   AosShellStream stream;
-            e545e620
+            Thomas Schöpping
   /**
    * @brief   String to printed as prompt.
    */
   const char* prompt;
   /**
    * @brief   Pointer to the first element of the singly linked list of commands.
    * @details Commands are ordered alphabetically in the list.
    */
   aos_shellcommand_t* commands;
   /**
    * @brief   Execution status of the most recent command.
    */
   aos_shellexecstatus_t execstatus;
   /**
-            cc33217b
+   * @brief   Structure containing all input data.
-            e545e620
+   */
-            cc33217b
+  struct {
     /**
      * @brief   Input buffer.
      */
     char* line;
-            e545e620
+            Thomas Schöpping
-            cc33217b
+    /**
      * @brief   Size of the input buffer.
      */
     size_t width;
   } input;
-            e545e620
+            Thomas Schöpping
   /**
-            ba516b61
+   * @brief   Structure containing data for internal input parsing.
    */
   struct {
     /**
      * @brief   The last action executed by the shell.
      */
     aos_shellaction_t lastaction;
     /**
      * @brief   Buffer to store an escape sequence.
      */
-            cc33217b
+    char escseq[AOS_SHELL_ESCSEQUENCE_LENGTH];
-            ba516b61
+            Thomas Schöpping
     /**
      * @brief   Current curso position.
      */
     size_t cursorpos;
     /**
      * @brief   Current line width.
      */
     size_t lineend;
     /**
      * @brief   Flag whether there was input since the prompt was printed the last time.
      */
     bool noinput;
   } inputdata;
   /**
-            e545e620
+   * @brief   Argument buffer.
    */
   char** arglist;
   /**
    * @brief   Size of the argument buffer.
    */
   size_t arglistsize;
   /**
    * @brief   Configuration flags.
    */
   uint8_t config;
 } aos_shell_t;
-            f3ac1c96
+/******************************************************************************/
 /* MACROS                                                                     */
 /******************************************************************************/
-c72a54c
+/**
  * @brief   Initializes a shell command object.
+ *
  * @param[in] var       Name of the object variable to be initialized.
  * @param[in] name      Shell command name.
  * @param[in] callback  Pointer to the callback function.
  */
 #define AOS_SHELL_COMMAND(var, name, callback) aos_shellcommand_t var = {     \
   /* name     */ name,                                                        \
   /* callback */ callback,                                                    \
   /* next     */ NULL,                                                        \
+}
-            f3ac1c96
+/******************************************************************************/
 /* EXTERN DECLARATIONS                                                        */
 /******************************************************************************/
-de0cc90
+#if defined(__cplusplus)
-            e545e620
+extern "C" {
-de0cc90
+#endif /* defined(__cplusplus) */
-            ba516b61
+  void aosShellInit(aos_shell_t* shell, event_source_t* oseventsource, const char* prompt, char* line, size_t linesize, char** arglist, size_t arglistsize);
   void aosShellStreamInit(AosShellStream* stream);
-            dd8738ea
+  void aosShellChannelInit(AosShellChannel* channel, BaseAsynchronousChannel* asyncchannel);
-            e545e620
+  aos_status_t aosShellAddCommand(aos_shell_t* shell, aos_shellcommand_t* cmd);
   aos_status_t aosShellRemoveCommand(aos_shell_t* shell, char* cmd, aos_shellcommand_t** removed);
-            aed3754b
+  unsigned int aosShellCountCommands(aos_shell_t* shell);
-            ba516b61
+  void aosShellStreamAddChannel(AosShellStream* stream, AosShellChannel* channel);
   aos_status_t aosShellStreamRemoveChannel(AosShellStream* stream, AosShellChannel* channel);
   void aosShellChannelInputEnable(AosShellChannel* channel);
   void aosShellChannelInputDisable( AosShellChannel* channel);
   void aosShellChannelOutputEnable(AosShellChannel* channel);
   void aosShellChannelOutputDisable(AosShellChannel* channel);
-            e545e620
+  THD_FUNCTION(aosShellThread, shell);
-de0cc90
+#if defined(__cplusplus)
-            e545e620
+            Thomas Schöpping
-de0cc90
+#endif /* defined(__cplusplus) */
-            e545e620
+            Thomas Schöpping
-            f3ac1c96
+/******************************************************************************/
 /* INLINE FUNCTIONS                                                           */
 /******************************************************************************/
-            cda14729
+#endif /* (AMIROOS_CFG_SHELL_ENABLE == true) */
-            ba516b61
+            Thomas Schöpping
-ff06bbf
+#endif /* AMIROOS_SHELL_H */
-ca3
+            Marc Rothmann
 /** @} */