4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2003, 2006 Develer S.r.l. (http://www.develer.com/)
30 * All Rights Reserved.
33 * \defgroup parser Simple RPC machinery
37 * \brief Channel protocol parser and commands.
39 * This module provides a simple text based RPC implementation.
40 * Often there is the need to give a command to the device and receive results
41 * back. Each command may have a variable number of input and output
42 * parameters, with variable type, and a return code which indicates if the
43 * command was successfully executed or not; this module provides the machinery
44 * to facilitate the above RPC scenario.
45 * You will need to write the RPC input and reply code as well as
46 * the definition of the commands.
48 * Commands are defined using a CmdTemplate struct containing:
49 * - command name: the string that will be matched by the parser;
50 * - command arguments: a string representing type and number of input
52 * - command output: a string representing type and number of output arguments;
53 * - function callback: function implementing the command.
55 * Once you have declared the commands, you need to register them in the
56 * parser with the function parser_register_cmd().
57 * You are strongly encouraged to use MAKE_CMD() (or alternatively
58 * MAKE_TEMPLATE()) and REGISTER_CMD() to declare and register commands.
60 * A command line can be parsed with the following steps:
61 * - find the corresponding command template with parser_get_cmd_template()
62 * - extract command arguments with parser_get_cmd_arguments()
63 * - execute the command with parser_execute_cmd()
65 * You can also provide interactive command line completion using
70 * // Declare a buzzer command
71 * MAKE_CMD(beep, "d", "",
73 * buz_beep(args[1].l);
77 * // initialize the parser
81 * // parse an input line
83 * // read line from somewhere
85 * // now parse the line
86 * const struct CmdTemplate *templ;
87 * templ = parser_get_cmd_template(buf);
89 * // Take arguments (optionally check errors)
90 * parms args[PARSER_MAX_ARGS];
91 * parser_get_cmd_arguments(buf, templ, args);
93 * if(!parser_execute_cmd(templ, args))
97 * // Now args contain the outputs of the function, you can send it
98 * // back to the caller
103 * \author Bernie Innocenti <bernie@codewiz.org>
104 * \author Stefano Fedrigo <aleph@develer.com>
105 * \author Giovanni Bajo <rasky@develer.com>
107 * $WIZ$ module_name = "parser"
108 * $WIZ$ module_configuration = "bertos/cfg/cfg_parser.h"
109 * $WIZ$ module_depends = "kfile", "hashtable"
113 #ifndef MWARE_PARSER_H
114 #define MWARE_PARSER_H
116 #include "cfg/cfg_parser.h"
118 #include <cpu/types.h>
121 * Error generated by the commands through the return code.
125 RC_ERROR = -1, ///< Reply with error.
126 RC_OK = 0, ///< No reply (ignore reply arguments).
127 RC_REPLY = 1, ///< Reply command arguments.
128 RC_SKIP = 2 ///< Skip following commands
131 /** union that contains parameters passed to and from commands */
132 typedef union { long l; const char *s; } parms;
133 /** pointer to commands */
134 typedef ResultCode (*CmdFuncPtr)(parms args_results[]);
137 * Define a command that can be tokenized by the parser.
139 * The format strings are sequences of characters, one for each
140 * parameter/result. Valid characters are:
142 * d - a long integer, in decimal format
143 * s - a var string (in RAM)
145 * \note To create and fill an instance for this function, it is strongly
146 * advised to use \c DECLARE_CMD_HUNK (cmd_hunk.h).
150 const char *name; ///< Name of command
151 const char *arg_fmt; ///< Format string for the input
152 const char *result_fmt; ///< Format string for the output
153 CmdFuncPtr func; ///< Pointer to the handler function
154 uint16_t flags; ///< Currently unused.
157 #define REGISTER_FUNCTION parser_register_cmd
160 * Utility function to register a command.
162 * \param NAME Command name to register
164 #define REGISTER_CMD(NAME) REGISTER_FUNCTION(&cmd_ ## NAME ## _template)
167 * Utility macro to create a command template.
169 * It requires that a callback function with name \a cmd_NAME
170 * is already defined.
171 * \param NAME Command name
172 * \param ARGS Input arguments
173 * \param RES Output arguments
174 * \param FLAGS Command flags
176 #define MAKE_TEMPLATE(NAME, ARGS, RES, FLAGS) \
177 const struct CmdTemplate cmd_ ## NAME ## _template = \
179 #NAME, ARGS, RES, cmd_ ## NAME, FLAGS \
183 * Utility macro to create command templates and callback functions.
185 * Example for a version command:
187 * MAKE_CMD(ver, "", "ddd",
189 * args[1].l = VERS_MAJOR;
190 * args[2].l = VERS_MINOR;
191 * args[3].l = VERS_REV;
196 * Remember that input and output parameters start from index 1, since
197 * args[0] is the command itself.
198 * The last line is the return value of the function.
200 * \param NAME Command name matched by the parser
201 * \param ARGS Input arguments to the command
202 * \param RES Output arguments of the command
203 * \param BODY Command body, expressed with C 'statement expression'
204 * \param FLAGS Command flags
206 #define MAKE_CMD(NAME, ARGS, RES, BODY, FLAGS) \
207 static ResultCode cmd_ ## NAME (parms *args) \
209 return (ResultCode)BODY; \
211 MAKE_TEMPLATE(NAME, ARGS, RES, FLAGS)
214 * Initialize the parser module
216 * \note This function must be called before any other function in this module
218 void parser_init(void);
220 void parser_register_cmd(const struct CmdTemplate* cmd);
224 * Hook for readline to provide completion support for the commands
225 * registered in the parser.
227 * \note This is meant to be used with mware/readline.c. See the
228 * documentation there for a description of this hook.
230 const char* parser_rl_match(void* dummy, const char* word, int word_len);
232 bool parser_process_line(const char* line);
235 * Execute a command with its arguments, and fetch its results.
237 * The \a args paramenter is value-result: it provides input arguments to
238 * the callback function and it stores output values on return.
240 * \param templ Template of the command to be executed
241 * \param args Arguments for the command, and will contain the results
243 * \return False if the command returned an error, true otherwise
245 INLINE bool parser_execute_cmd(const struct CmdTemplate* templ, parms args[CONFIG_PARSER_MAX_ARGS])
247 return (templ->func(args) == 0);
250 const struct CmdTemplate* parser_get_cmd_template(const char* line);
252 bool parser_get_cmd_arguments(const char* line, const struct CmdTemplate* templ, parms args[CONFIG_PARSER_MAX_ARGS]);
254 #if CONFIG_ENABLE_COMPAT_BEHAVIOUR
256 * Extract the ID from the command text line.
258 * \param line Text line to be processed (ASCIIZ)
259 * \param ID Will contain the ID extracted.
261 * \return True if everything ok, false if there is no ID
264 bool parser_get_cmd_id(const char* line, unsigned long* ID);
268 /** \} */ // defgroup parser
269 #endif /* MWARE_PARSER_H */