mware/parser.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2003, 2006 Develer S.r.l. (http://www.develer.com/)
  30  * All Rights Reserved.
  31  * -->
  32  *
  33  * \version $Id$
  34  *
  35  * \author Bernardo Innocenti <bernie@develer.com>
  36  * \author Stefano Fedrigo <aleph@develer.com>
  37  * \author Giovanni Bajo <rasky@develer.com>
  38  *
  39  * \brief serial protocol parser and commands.
  40  */
  41
  42
  43 #ifndef PARSER_H
  44 #define PARSER_H
  45
  46 #include <drv/ser.h>
  47
  48 /** Max number of arguments and results for each command */
  49 #define PARSER_MAX_ARGS       8
  50
  51 /**
  52  * Error generated by the commands through the return code.
  53  */
  54 typedef enum
  55 {
  56         RC_ERROR  = -1, ///< Reply with error.
  57         RC_OK     = 0,  ///< No reply (ignore reply arguments).
  58         RC_REPLY  = 1,  ///< Reply command arguments.
  59         RC_SKIP   = 2   ///< Skip following commands
  60 } ResultCode;
  61
  62 /** union that contains parameters passed to and from commands */
  63 typedef union { long l; const char *s; } parms;
  64 /** pointer to commands */
  65 typedef ResultCode (*CmdFuncPtr)(parms args_results[]);
  66
  67 /**
  68  * Define a command that can be tokenized by the parser.
  69  *
  70  * The format strings are sequences of characters, one for each
  71  * parameter/result. Valid characters are:
  72  *
  73  *  d - a long integer, in decimal format
  74  *  s - a var string (in RAM)
  75  *
  76  * \note To create and fill an instance for this function, it is strongly
  77  * advised to use \c DECLARE_CMD_HUNK (cmd_hunk.h).
  78  */
  79 struct CmdTemplate
  80 {
  81         const char *name;          ///< Name of command
  82         const char *arg_fmt;       ///< Format string for the input
  83         const char *result_fmt;    ///< Format string for the output
  84         CmdFuncPtr func;           ///< Pointer to the handler function
  85         uint16_t   flags;          ///< Currently unused.
  86 };
  87
  88 /**
  89  * Initialize the parser module
  90  *
  91  * \note This function must be called before any other function in this module
  92  */
  93 void parser_init(void);
  94
  95
  96 /**
  97  * Register a new command into the parser
  98  *
  99  * \param cmd Command template describing the command
 100  *
 101  */
 102 void parser_register_cmd(const struct CmdTemplate* cmd);
 103
 104
 105 /**
 106  * Hook for readline to provide completion support for the commands
 107  * registered in the parser.
 108  *
 109  * \note This is meant to be used with mware/readline.c. See the
 110  * documentation there for a description of this hook.
 111  */
 112 const char* parser_rl_match(void* dummy, const char* word, int word_len);
 113
 114
 115 /**
 116  * \brief Command input handler.
 117  *
 118  * Process the input, calling the requested command
 119  * (if found) and calling printResult() to give out
 120  * the result (on device specified with parameter fd).
 121  *
 122  * \param line Text line to be processed (ASCIIZ)
 123  *
 124  * \return true if everything is OK, false in case of errors
 125  */
 126 bool parser_process_line(const char* line);
 127
 128
 129 /**
 130  * Execute a command with its arguments, and fetch its results.
 131  *
 132  * \param templ Template of the command to be executed
 133  * \param args Arguments for the command, and will contain the results
 134  *
 135  * \return False if the command returned an error, true otherwise
 136  */
 137 INLINE bool parser_execute_cmd(const struct CmdTemplate* templ, parms args[PARSER_MAX_ARGS])
 138 {
 139         return (templ->func(args) == 0);
 140 }
 141
 142
 143 /**
 144  * Find the template for the command contained in the text line.
 145  * The template can be used to tokenize the command and interpret
 146  * it.
 147  *
 148  * This function can be used to find out which command is contained
 149  * in a given text line without parsing all the parameters and
 150  * executing it.
 151  *
 152  * \param line Text line to be processed (ASCIIZ)
 153  *
 154  * \return The command template associated with the command contained
 155  * in the line, or NULL if the command is invalid.
 156  */
 157 const struct CmdTemplate* parser_get_cmd_template(const char* line);
 158
 159
 160 /**
 161  * Extract the arguments for the command contained in the text line.
 162  *
 163  * \param line Text line to be processed (ASCIIZ)
 164  * \param templ Command template for this line
 165  * \param args Will contain the extracted parameters
 166  *
 167  * \return True if everything OK, false in case of parsing error.
 168  */
 169 bool parser_get_cmd_arguments(const char* line, const struct CmdTemplate* templ, parms args[PARSER_MAX_ARGS]);
 170
 171
 172 /**
 173  * Extract the ID from the command text line.
 174  *
 175  * \param line Text line to be processed (ASCIIZ)
 176  * \param ID Will contain the ID extracted.
 177  *
 178  * \return True if everything ok, false if there is no ID
 179  *
 180  */
 181 bool parser_get_cmd_id(const char* line, unsigned long* ID);
 182
 183
 184 #endif /* PARSER_H */
 185