refactor command registration
[openocd.git] / src / helper / command.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
12 * *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
17 * *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
23 #ifndef COMMAND_H
24 #define COMMAND_H
25
26 #include "types.h"
27
28 /* Integrate the JIM TCL interpretor into the command processing. */
29 #if BUILD_ECOSBOARD
30 #include <stdio.h>
31 #include <stdarg.h>
32 /* Jim is provied by eCos */
33 #include <cyg/jimtcl/jim.h>
34 #else
35 #include "jim.h"
36 #endif
37
38 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
39 * used for __attribute__((format( ... ))), with GCC v4.4 or later
40 */
41 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
42 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
43 #else
44 #define PRINTF_ATTRIBUTE_FORMAT printf
45 #endif
46
47 enum command_mode
48 {
49 COMMAND_EXEC,
50 COMMAND_CONFIG,
51 COMMAND_ANY,
52 };
53
54 struct command_context;
55
56 /// The type signature for command context's output handler.
57 typedef int (*command_output_handler_t)(struct command_context *context,
58 const char* line);
59
60 struct command_context
61 {
62 enum command_mode mode;
63 struct command *commands;
64 int current_target;
65 /* Execute a command.
66 *
67 * If the command fails, it *MUST* return a value != ERROR_OK
68 * (many commands break this rule, patches welcome!)
69 *
70 * This is *especially* important for commands such as writing
71 * to flash or verifying memory. The reason is that those commands
72 * can be used by programs to determine if the operation succeded
73 * or not. If the operation failed, then a program can try
74 * an alternative approach.
75 *
76 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
77 * printing out the syntax of the command.
78 */
79 command_output_handler_t output_handler;
80 void *output_handler_priv;
81 };
82
83 /**
84 * When run_command is called, a new instance will be created on the
85 * stack, filled with the proper values, and passed by reference to the
86 * required COMMAND_HANDLER routine.
87 */
88 struct command_invocation {
89 struct command_context *ctx;
90 const char *name;
91 unsigned argc;
92 const char **argv;
93 };
94
95 /**
96 * Command handlers may be defined with more parameters than the base
97 * set provided by command.c. This macro uses C99 magic to allow
98 * defining all such derivative types using this macro.
99 */
100 #define __COMMAND_HANDLER(name, extra...) \
101 int name(struct command_invocation *cmd, ##extra)
102
103 /**
104 * Use this to macro to call a command helper (or a nested handler).
105 * It provides command handler authors protection against reordering or
106 * removal of unused parameters.
107 *
108 * @b Note: This macro uses lexical capture to provide some arguments.
109 * As a result, this macro should be used @b only within functions
110 * defined by the COMMAND_HANDLER or COMMAND_HELPER macros. Those
111 * macros provide the expected lexical context captured by this macro.
112 * Furthermore, it should be used only from the top-level of handler or
113 * helper function, or care must be taken to avoid redefining the same
114 * variables in intervening scope(s) by accident.
115 */
116 #define CALL_COMMAND_HANDLER(name, extra...) \
117 name(cmd, ##extra)
118
119 /**
120 * Always use this macro to define new command handler functions.
121 * It ensures the parameters are ordered, typed, and named properly, so
122 * they be can be used by other macros (e.g. COMMAND_PARSE_NUMBER).
123 * All command handler functions must be defined as static in scope.
124 */
125 #define COMMAND_HANDLER(name) static __COMMAND_HANDLER(name)
126
127 /**
128 * Similar to COMMAND_HANDLER, except some parameters are expected.
129 * A helper is globally-scoped because it may be shared between several
130 * source files (e.g. the s3c24xx device command helper).
131 */
132 #define COMMAND_HELPER(name, extra...) __COMMAND_HANDLER(name, extra)
133
134 /**
135 * Use this macro to access the context of the command being handled,
136 * rather than accessing the variable directly. It may be moved.
137 */
138 #define CMD_CTX cmd->ctx
139 /**
140 * Use this macro to access the number of arguments for the command being
141 * handled, rather than accessing the variable directly. It may be moved.
142 */
143 #define CMD_ARGC cmd->argc
144 /**
145 * Use this macro to access the arguments for the command being handled,
146 * rather than accessing the variable directly. It may be moved.
147 */
148 #define CMD_ARGV cmd->argv
149 /**
150 * Use this macro to access the name of the command being handled,
151 * rather than accessing the variable directly. It may be moved.
152 */
153 #define CMD_NAME cmd->name
154
155
156 /// The type signature for commands' handler functions.
157 typedef __COMMAND_HANDLER((*command_handler_t));
158
159 struct command
160 {
161 char *name;
162 struct command *parent;
163 struct command *children;
164 command_handler_t handler;
165 enum command_mode mode;
166 struct command *next;
167 };
168
169 /**
170 * @param c The command to be named.
171 * @param delim The character to place between command names.
172 * @returns A malloc'd string containing the full command name,
173 * which may include one or more ancestor components. Multiple names
174 * are separated by single spaces. The caller must free() the string
175 * when done with it.
176 */
177 char *command_name(struct command *c, char delim);
178
179 /**
180 * Register a command @c handler that can be called from scripts during
181 * the execution @c mode specified.
182 *
183 * If @c parent is non-NULL, the new command will be registered as a
184 * sub-command under it; otherwise, it will be available as a top-level
185 * command.
186 *
187 * A conventioal format should be used for help strings, to provide both
188 * usage and basic information:
189 * @code
190 * "@<options@> ... - some explanation text"
191 * @endcode
192 *
193 * @param cmd_ctx The command_context in which to register the command.
194 * @param parent Register this command as a child of this, or NULL to
195 * register a top-level command.
196 * @param name The name of the command to register, which must not have
197 * been registered previously.
198 * @param handler The callback function that will be called. If NULL,
199 * then the command serves as a placeholder for its children or a script.
200 * @param mode The command mode(s) in which this command may be run.
201 * @param help The help text that will be displayed to the user.
202 * @returns The new command, if successful; otherwise, NULL.
203 */
204 struct command* register_command(struct command_context *cmd_ctx,
205 struct command *parent, const char *name,
206 command_handler_t handler, enum command_mode mode,
207 const char *help);
208
209 /**
210 * Unregisters command @c name from the given context, @c cmd_ctx.
211 * @param cmd_ctx The context of the registered command.
212 * @param parent The parent of the given command, or NULL.
213 * @param name The name of the command to unregister.
214 * @returns ERROR_OK on success, or an error code.
215 */
216 int unregister_command(struct command_context *cmd_ctx,
217 struct command *parent, const char *name);
218 /**
219 * Unregisters all commands from the specfied context.
220 * @param cmd_ctx The context that will be cleared of registered commands.
221 * @param parent If given, only clear commands from under this one command.
222 * @returns ERROR_OK on success, or an error code.
223 */
224 int unregister_all_commands(struct command_context *cmd_ctx,
225 struct command *parent);
226
227 void command_set_output_handler(struct command_context* context,
228 command_output_handler_t output_handler, void *priv);
229
230 struct command_context* copy_command_context(struct command_context* context);
231
232 int command_context_mode(struct command_context *context, enum command_mode mode);
233
234 /**
235 * Creates a new command context using the startup TCL provided.
236 */
237 struct command_context* command_init(const char *startup_tcl);
238 int command_done(struct command_context *context);
239
240 void command_print(struct command_context *context, const char *format, ...)
241 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
242 void command_print_sameline(struct command_context *context, const char *format, ...)
243 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
244 int command_run_line(struct command_context *context, char *line);
245 int command_run_linef(struct command_context *context, const char *format, ...)
246 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
247 void command_output_text(struct command_context *context, const char *data);
248
249 void process_jim_events(void);
250
251 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
252 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
253 #define ERROR_COMMAND_NOTFOUND (-602)
254 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
255 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
256 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
257
258 extern Jim_Interp *interp;
259
260 void register_jim(struct command_context *context, const char *name,
261 Jim_CmdProc cmd, const char *help);
262
263 int parse_ulong(const char *str, unsigned long *ul);
264 int parse_ullong(const char *str, unsigned long long *ul);
265
266 int parse_long(const char *str, long *ul);
267 int parse_llong(const char *str, long long *ul);
268
269 #define DECLARE_PARSE_WRAPPER(name, type) \
270 int parse##name(const char *str, type *ul)
271
272 DECLARE_PARSE_WRAPPER(_uint, unsigned);
273 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
274 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
275 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
276
277 DECLARE_PARSE_WRAPPER(_int, int);
278 DECLARE_PARSE_WRAPPER(_s32, int32_t);
279 DECLARE_PARSE_WRAPPER(_s16, int16_t);
280 DECLARE_PARSE_WRAPPER(_s8, int8_t);
281
282 /**
283 * @brief parses the string @a in into @a out as a @a type, or prints
284 * a command error and passes the error code to the caller. If an error
285 * does occur, the calling function will return the error code produced
286 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
287 *
288 * This function may cause the calling function to return immediately,
289 * so it should be used carefully to avoid leaking resources. In most
290 * situations, parsing should be completed in full before proceding
291 * to allocate resources, and this strategy will most prevents leaks.
292 */
293 #define COMMAND_PARSE_NUMBER(type, in, out) \
294 do { \
295 int retval = parse_##type(in, &(out)); \
296 if (ERROR_OK != retval) { \
297 command_print(CMD_CTX, stringify(out) \
298 " option value ('%s') is not valid", in); \
299 return retval; \
300 } \
301 } while (0)
302
303 /**
304 * Parse the string @c as a binary parameter, storing the boolean value
305 * in @c out. The strings @c on and @c off are used to match different
306 * strings for true and false options (e.g. "on" and "off" or
307 * "enable" and "disable").
308 */
309 #define COMMAND_PARSE_BOOL(in, out, on, off) \
310 do { \
311 bool value; \
312 int retval = command_parse_bool_arg(in, &value); \
313 if (ERROR_OK != retval) { \
314 command_print(CMD_CTX, stringify(out) \
315 " option value ('%s') is not valid", in); \
316 command_print(CMD_CTX, " choices are '%s' or '%s'", \
317 on, off); \
318 return retval; \
319 } \
320 out = value; \
321 } while (0)
322
323 int command_parse_bool_arg(const char *in, bool *out);
324 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);
325
326 /// parses an on/off command argument
327 #define COMMAND_PARSE_ON_OFF(in, out) \
328 COMMAND_PARSE_BOOL(in, out, "on", "off")
329 /// parses an enable/disable command argument
330 #define COMMAND_PARSE_ENABLE(in, out) \
331 COMMAND_PARSE_BOOL(in, out, "enable", "disable")
332
333 void script_debug(Jim_Interp *interp, const char *cmd,
334 unsigned argc, Jim_Obj *const *argv);
335
336 #endif /* COMMAND_H */