/ - Diff - AMiRo-OS - Research for Cognitive Interaction

Revision 697dba3c

         #error "AMIROOS_CFG_SHELL_MAXARGS not defined in aosconf.h"
       #endif /* !defined(AMIROOS_CFG_SHELL_MAXARGS) */
       #if !defined(AMIROOS_CFG_SHELL_HISTLENGTH)
         #error "AMIROOS_CFG_SHELL_HISTLENGTH not defined in aosconf.h"
       #endif /* !defined(AMIROOS_CFG_SHELL_HISTLENGTH) */
     #else /* (AMIROOS_CFG_SHELL_ENABLE == true) */
       #if (AMIROOS_CFG_TESTS_ENABLE == true)

     /**
      * @brief   Shell event flag that is emitted when a command is executed.
      */
     #define AOS_SHELL_EVTFLAG_EXEC                    ((eventflags_t)(1 << 1))
     #define AOS_SHELL_EVTFLAG_EXECUTE                 ((eventflags_t)(1 << 1))
     /**
      * @brief   Shell event flag that is emitted when a command execution finished.
-...
     } aos_shellexecstatus_t;
     /**
      * @brief   Enumerator to encode shell actions.
      */
     typedef enum aos_shellaction {
       AOS_SHELL_ACTION_NONE,
       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,
       AOS_SHELL_ACTION_CURSORWORDLEFT,
       AOS_SHELL_ACTION_CURSORWORDRIGHT,
       AOS_SHELL_ACTION_EXECUTE,
       AOS_SHELL_ACTION_ESCSTART,
       AOS_SHELL_ACTION_PRINTUNKNOWNSEQUENCE,
     } aos_shellaction_t;
     /**
      * @brief   Shell structure.
      */
     typedef struct aos_shell {
-...
       event_source_t eventSource;
       /**
        * @brief   Struct for OS related events
        * @brief   Listener for OS related events.
        */
       struct {
         /**
          * @brief   Pointer to the OS' event source.
          */
         event_source_t* eventSource;
         /**
          * @brief   Listener for OS related events.
          */
         event_listener_t eventListener;
       } os;
       event_listener_t osEventListener;
       /**
          * @brief   Pointer to the first I/O channel.
-...
       struct {
         /**
          * @brief   Input buffer.
          * @details This buffer is interpreted as two dimensional array.
          *          It contains @p nentries elements of @p linewidth size each.
          */
         char* line;
         /**
          * @brief   Size of the input buffer.
          */
         size_t length;
         /**
          * @brief   Size of the argument buffer.
          */
         size_t nargs;
       } input;
       /**
        * @brief   Structure containing data for internal input parsing.
        */
       struct {
         /**
          * @brief   The last action executed by the shell.
          */
         aos_shellaction_t lastaction;
         char* buffer;
         /**
          * @brief   Buffer to store an escape sequence.
          * @brief   Number of entries in the buffer.
          * @note    Must be >0.
          */
         char escseq[AOS_SHELL_ESCSEQUENCE_LENGTH];
         size_t nentries;
         /**
          * @brief   Current curso position.
          * @brief   Width of each input line.
          * @brief   Must be >0.
          */
         size_t cursorpos;
         size_t linewidth;
         /**
          * @brief   Current line width.
          */
         size_t lineend;
         /**
          * @brief   Flag whether there was input since the prompt was printed the last time.
          * @brief   Size of the argument buffer.
          * @note    Must be >0.
          */
         bool noinput;
       } inputdata;
         size_t nargs;
       } input;
       /**
        * @brief   Configuration flags.
-...
     #if defined(__cplusplus)
     extern "C" {
     #endif /* defined(__cplusplus) */
       void aosShellInit(aos_shell_t* shell, event_source_t* oseventsource, const char* prompt, char* line, size_t linesize, size_t numargs);
       void aosShellInit(aos_shell_t* shell, const char* prompt, char inbuf[], size_t entries, size_t linewidth, size_t numargs);
       void aosShellStreamInit(AosShellStream* stream);
       void aosShellChannelInit(AosShellChannel* channel, BaseAsynchronousChannel* asyncchannel);
       aos_status_t aosShellAddCommand(aos_shell_t* shell, aos_shellcommand_t* cmd);

     /******************************************************************************/
     /**
      * @brief   The character the input buffer is initialized with.
      */
     #define INBUF_INIT_CHAR                         '\x07'
     /**
      * @brief   Event mask to be set on OS related events.
      */
     #define AOS_SHELL_EVENTMASK_OS                  EVENT_MASK(0)
     #define EVENTMASK_OS                            EVENT_MASK(0)
     /**
      * @brief   Event mask to be set on a input event.
      */
     #define AOS_SHELL_EVENTMASK_INPUT               EVENT_MASK(1)
     #define EVENTMASK_INPUT                         EVENT_MASK(1)
     /**
      * @brief   String that defines the INSERT key as specified by VT100.
      */
     #define KEYSTRING_INSERT                        "\x1B\x5B\x32\x7E"
     /**
      * @brief   String that defines the DEL key as specified by VT100.
      */
     #define KEYSTRING_DELETE                        "\x1B\x5B\x33\x7E"
     /**
      * @brief   String that defines the HOME key as specified by VT100.
      */
     #define KEYSTRING_HOME                          "\x1B\x5B\x48"
     /**
      * @brief   String that defines the END key as specified by VT100.
      */
     #define KEYSTRING_END                           "\x1B\x5B\x46"
     /**
      * @brief   String that defines the PGUP key as specified by VT100.
      */
     #define KEYSTRING_PAGEUP                        "\x1B\x5B\x35\x7E"
     /**
      * @brief   String that defines the PGUP key as specified by VT100.
      */
     #define KEYSTRING_PAGEDOWN                      "\x1B\x5B\x36\x7E"
     /**
      * @brief   String that defines the 'arrow down' key as specified by VT100.
      */
     #define KEYSTRING_ARROWUP                       "\x1B\x5B\x41"
     /**
      * @brief   String that defines the 'arrow up' key as specified by VT100.
      */
     #define KEYSTRING_ARROWDOWN                     "\x1B\x5B\x42"
     /**
      * @brief   String that defines the 'arrow left' key as specified by VT100.
      */
     #define KEYSTRING_ARROWLEFT                     "\x1B\x5B\x44"
     /**
      * @brief   String that defines the 'arrow right' key as specified by VT100.
      */
     #define KEYSTRING_ARROWRIGHT                    "\x1B\x5B\x43"
     /**
      * @brief   String that defines the CRTL + 'arrow up' key combination as specified by VT100.
      */
     #define KEYSTRING_CTRL_ARROWUP                  "\x1B\x5B\x31\x3B\x35\x41"
     /**
      * @brief   String that defines the CRTL + 'arrow down' key combination as specified by VT100.
      */
     #define KEYSTRING_CTRL_ARROWDOWN                "\x1B\x5B\x31\x3B\x35\x42"
     /**
      * @brief   String that defines the CRTL + 'arrow left' key combination as specified by VT100.
      */
     #define KEYSTRING_CTRL_ARROWLEFT                "\x1B\x5B\x31\x3B\x35\x44"
     /**
      * @brief   String that defines the CRTL + 'arrow right' key combination as specified by VT100.
      */
     #define KEYSTRING_CTRL_ARROWRIGHT               "\x1B\x5B\x31\x3B\x35\x43"
     /******************************************************************************/
     /* EXPORTED VARIABLES                                                         */
-...
       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_ESCAPE,           /**< escape 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 */
       KEY_PAGEUP,           /**< page up key */
       KEY_PAGEDOWN,         /**< page down key */
       KEY_ARROWUP,          /**< arrow up key */
       KEY_ARROWDOWN,        /**< arrow down key */
       KEY_ARROWLEFT,        /**< arrow left key */
       KEY_ARROWRIGHT,       /**< arrow right key */
       KEY_CTRL_ARROWUP,     /**< CTRL + arrow up key */
       KEY_CTRL_ARROWDOWN,   /**< CTRL + arrow down key */
       KEY_CTRL_ARROWLEFT,   /**< CTRL + arrow left key */
       KEY_CTRL_ARROWRIGHT,  /**< CTRL + arrow right key */
       KEY_CTRL_C,           /**< CTRL + C key */
     } special_key_t;
     /**
-...
       CHAR_MATCH_CASE   = 2,  /**< Characters do match with case. */
     } charmatch_t;
     /**
      * @brief   Enumerator to encode shell actions.
      */
     typedef enum aos_shellaction {
       ACTION_NONE,                  /**< No action at all. */
       ACTION_READCHAR,              /**< Read a printable character. */
       ACTION_AUTOCOMPLETE,          /**< Automatically comlete input by using available command. */
       ACTION_SUGGEST,               /**< Suggest matching available commands. */
       ACTION_EXECUTE,               /**< Execute input. */
       ACTION_DELETEBACKWARD,        /**< Delete a single character backwards. */
       ACTION_DELETEFORWARD,         /**< Delete a single character forwards. */
       ACTION_CLEAR,                 /**< Clear the input. */
       ACTION_RECALLPREVIOUS,        /**< Recall the previous (older) entry in the history. */
       ACTION_RECALLNEXT,            /**< Recall the next (more recent) entry in the history. */
       ACTION_RECALLOLDEST,          /**< Recall the oldest entry in the history. */
       ACTION_RECALLCURRENT,         /**< Recall the current input. */
       ACTION_CURSORLEFT,            /**< Move cursor one character to the left. */
       ACTION_CURSORRIGHT,           /**< Move cursor one character to the right. */
       ACTION_CURSORWORDLEFT,        /**< Move cursor one word to the left. */
       ACTION_CURSORWORDRIGHT,       /**< Move cursor one word to the right. */
       ACTION_CURSOR2END,            /**< Move cursor to the very right. */
       ACTION_CURSOR2START,          /**< Move cursor to the very left. */
       ACTION_RESET,                 /**< Reset the current input. */
       ACTION_INSERTTOGGLE,          /**< Toggle insertion mode. */
       ACTION_ESCSTART,              /**< Start an escape sequence (special keys). */
       ACTION_PRINTUNKNOWNSEQUENCE,  /**< Print an unknown escape sequence. */
     } action_t;
     /**
      * @brief   Struct that holds most important runtime data for the shell.
      * @details The structure is to be used by the shell thread main function as some kind of structured stack, which can be easily passed to other functions.
      */
     typedef struct runtimedata {
       /**
        * @brief   Data related to the current input.
        */
       struct {
         /**
          * @brief   Length of the input.
          */
         size_t length;
         /**
          * @brief   Current position of the cursor in the input line.
          */
         size_t cursorpos;
         /**
          * @brief   Buffer to store escape sequences, which describe special characters.
          */
         char escseq[AOS_SHELL_ESCSEQUENCE_LENGTH];
       } input;
       /**
        * @brief   Data related to the entry or history buffer.
        */
       struct {
         /**
          * @brief   Current entry to be filled and executed.
          */
         size_t current;
         /**
          * @brief   Selected entry in the 'history' as preview.
          * @details A value of 0 indicates, that the line is cleared as a preview.
          *          A value of 1 indicates, that the current entry is selected.
          *          A value of t>1 indicates, that the entry t-1 in the past is selected.
          *          The value must never be greater than the number of entries available, of course.
          */
         size_t selected;
         /**
          * @brief   Selected entry in the 'history' that has been edited by the user.
          *          A value of 0 indicates, that there was no modification by the user yet (i.e. charcters, deletions or autofill).
          *          A value of 1 indicates, that the current entry was edited.
          *          A value of t>1 indicated, that a history entry was recalled and then edited.
          */
         size_t edited;
       } buffer;
       /**
        * @brief   The last action executed by the shell.
        */
       action_t lastaction;
     } runtimedata_t;
     /******************************************************************************/
     /* LOCAL VARIABLES                                                            */
     /******************************************************************************/
-...
       return MSG_OK;
+    }
     /**
      * @brief   Implementation of the BaseSequentialStream write() method.
      */
     static size_t _streamwrite(void *instance, const uint8_t *bp, size_t n)
+    {
       aosDbgCheck(instance != NULL);
-...
       return maxbytes;
+    }
     /**
      * @brief   Implementation of the BaseSequentialStream read() method.
      */
     static size_t _stremread(void *instance, uint8_t *bp, size_t n)
+    {
       (void)instance;
-...
       return 0;
+    }
     /**
      * @brief   Implementation of the BaseSequentialStream put() method.
      */
     static msg_t _streamput(void *instance, uint8_t b)
+    {
       aosDbgCheck(instance != NULL);
-...
       return ret;
+    }
     /**
      * @brief   Implementation of the BaseSequentialStream get() method.
      */
     static msg_t _streamget(void *instance)
+    {
       (void)instance;
-...
+    }
     /**
      * @brief   Retreive a pointer to the string buffer of a specified entry in the input buffer.
+     *
      * @param[in] shell   Pointer to a shell object.
      * @param[in] entry   Entry to be retrieved.
+     *
      * @return  Pointer to the entry in the input buffer.
      */
     static inline char* _getAbsoluteEntry(const aos_shell_t* shell, size_t entry)
+    {
       aosDbgCheck(shell != NULL);
       aosDbgCheck(entry < shell->input.nentries);
       return &(shell->input.buffer[entry * shell->input.linewidth * sizeof(char)]);
+    }
     /**
      * @brief   Calculate absolute entry from history offset.
+     *
      * @param[in] shell   Pointer to a shell object.
      * @param[in] rdata   Pointer to a runtime data object.
      * @param[in] offset  Relative offset of the entry to be retreived.
+     *
      * @return  Absolute index of the historic entry.
      */
     static inline size_t _historyOffset2EntryIndex(const aos_shell_t* shell, const runtimedata_t* rdata, size_t offset)
+    {
       aosDbgCheck(shell != NULL);
       aosDbgCheck(rdata != NULL);
       aosDbgCheck(offset < shell->input.nentries);
       return ((shell->input.nentries + rdata->buffer.current - offset) % shell->input.nentries);
+    }
     /**
      * @brief   Retreive a pointer to the string buffer of a historic entry in the input buffer.
+     *
      * @param[in] shell   Pointer to a shell object.
      * @param[in] rdata   Pointer to a runtime data object.
      * @param[in] offset  Relative offset of the entry to be retreived.
+     *
      * @return  Pointer to the entry in the input buffer.
      */
     static inline char* _getRelativeEntry(const aos_shell_t* shell, const runtimedata_t* rdata, size_t offset)
+    {
       aosDbgCheck(shell != NULL);
       aosDbgCheck(rdata != NULL);
       aosDbgCheck(offset < shell->input.nentries);
       return _getAbsoluteEntry(shell, _historyOffset2EntryIndex(shell, rdata, offset));
+    }
     /**
      * @brief   Retreive a pointer to the current entry string in the input buffer.
+     *
      * @param[in] shell   Pointer to a shell object.
      * @param[in] rdata   Pointer to a runtime data object.
+     *
      * @return  Pointer to the string of the current entry in the input buffer.
      */
     static inline char* _getCurrentEntry(const aos_shell_t* shell, const runtimedata_t* rdata)
+    {
       aosDbgCheck(shell != NULL);
       aosDbgCheck(rdata != NULL);
       return _getAbsoluteEntry(shell, rdata->buffer.current);
+    }