git.sur5r.net Git - freertos/blob - Demo/Common/Utils/CommandInterpreter.c

   1 /*\r
   2     FreeRTOS V7.0.1 - Copyright (C) 2011 Real Time Engineers Ltd.\r
   3         \r
   4 \r
   5     ***************************************************************************\r
   6      *                                                                       *\r
   7      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
   8      *    Complete, revised, and edited pdf reference manuals are also       *\r
   9      *    available.                                                         *\r
  10      *                                                                       *\r
  11      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  12      *    ensuring you get running as quickly as possible and with an        *\r
  13      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  14      *    the FreeRTOS project to continue with its mission of providing     *\r
  15      *    professional grade, cross platform, de facto standard solutions    *\r
  16      *    for microcontrollers - completely free of charge!                  *\r
  17      *                                                                       *\r
  18      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  19      *                                                                       *\r
  20      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  21      *                                                                       *\r
  22     ***************************************************************************\r
  23 \r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  31     distribute a combined work that includes FreeRTOS without being obliged to\r
  32     provide the source code for proprietary components outside of the FreeRTOS\r
  33     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  34     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  35     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public\r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43 \r
  44     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 #include "FreeRTOS.h"\r
  55 #include "task.h"\r
  56 #include "CommandInterpreter.h"\r
  57 \r
  58 /*\r
  59  * The callback function that is executed when "help" is entered.  This is the\r
  60  * only default command that is always present.\r
  61  */\r
  62 static const signed char *prvHelpCommand( void );\r
  63 \r
  64 /* The definition of the "help" command.  This command is always at the front\r
  65 of the list of registered commands. */\r
  66 const xCommandLineInput xHelpCommand = \r
  67 {\r
  68         "help",\r
  69         "help: Lists all the registered commands\r\n",\r
  70         prvHelpCommand,\r
  71         NULL\r
  72 };\r
  73 \r
  74 /*-----------------------------------------------------------*/\r
  75 \r
  76 void vCmdIntRegisterCommand( const xCommandLineInput *pxCommandToRegister )\r
  77 {\r
  78 /* Used to point to the last command in the list of registered command, just to\r
  79 make registering commands faster. */\r
  80 static xCommandLineInput *pxLastCommandInList = &xHelpCommand;\r
  81 \r
  82         configASSERT( pxLastCommandInList );\r
  83         pxLastCommandInList->pxNext = pxCommandToRegister;\r
  84         pxLastCommandInLIst = pxCommandToRegister;\r
  85 }\r
  86 /*-----------------------------------------------------------*/\r
  87 \r
  88 const signed char *pcCmdIntProcessCommand( const signed char *pcCommandInput )\r
  89 {\r
  90 static const xCommandLineInput *pxCommand = NULL;\r
  91 signed const char *pcReturn = NULL;\r
  92         \r
  93         if( pxCommand == NULL )\r
  94         {\r
  95                 /* Search for the command string in the list of registered commands. */\r
  96                 for( pxCommand = &xHelpCommand; pxCommand != NULL; pxCommand = pxCommand->pxNext )\r
  97                 {\r
  98                         if( strcmp( ( const char * ) pcCommandInput, ( const char * ) pxCommand->pcCommand ) == 0 )\r
  99                         {\r
 100                                 /* The command has been found, the loop can exit so the command\r
 101                                 can be executed. */\r
 102                                 break;\r
 103                         }\r
 104                 }\r
 105         }\r
 106 \r
 107         if( pxCommand != NULL )\r
 108         {\r
 109                 pcReturn = pxCommand->pxCommandInterpreter();\r
 110 \r
 111                 /* If no strings were returned, then all the strings that are going to\r
 112                 be returned by the current command have already been returned, and\r
 113                 pxCommand can be reset to NULL ready to search for the next entered\r
 114                 command. */\r
 115                 if( pcReturn == NULL )\r
 116                 {\r
 117                         pxCommand = NULL;\r
 118                 }\r
 119         }\r
 120         else\r
 121         {\r
 122                 pcReturn = "Command not recognised\r\n\r\n";\r
 123                 pxCommand = &xHelpCommand;\r
 124         }\r
 125 \r
 126         return pcReturn;\r
 127 }\r
 128 /*-----------------------------------------------------------*/\r
 129 \r
 130 static const signed char *prvHelpCommand( void )\r
 131 {\r
 132 static const xCommandLineInput * pxCommand = &xHelpCommand;\r
 133 signed const char *pcReturn;\r
 134 \r
 135         /* pxCommand will be NULL if all the commands in the list have already been\r
 136         returned. */\r
 137         if( pxCommand != NULL )\r
 138         {\r
 139                 /* Return the next command help string, before moving the pointer on to\r
 140                 the next command in the list. */\r
 141                 pcReturn = pxCommand->pcHelpString;\r
 142                 pxCommand = pxCommand->pxNext;\r
 143         }\r
 144         else\r
 145         {\r
 146                 /* Reset the pointer back to the start of the list. */\r
 147                 pxCommand = &xHelpCommand;\r
 148 \r
 149                 /* Return NULL to show that there are no more strings to return. */\r
 150                 pcReturn = NULL;\r
 151         }\r
 152         \r
 153         return pcReturn;\r
 154 }\r
 155 \r