improve 'help' command
[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 const char *help;
163 struct command *parent;
164 struct command *children;
165 command_handler_t handler;
166 enum command_mode mode;
167 struct command *next;
168 };
169
170 /**
171 * @param c The command to be named.
172 * @param delim The character to place between command names.
173 * @returns A malloc'd string containing the full command name,
174 * which may include one or more ancestor components. Multiple names
175 * are separated by single spaces. The caller must free() the string
176 * when done with it.
177 */
178 char *command_name(struct command *c, char delim);
179
180 /**
181 * Register a command @c handler that can be called from scripts during
182 * the execution @c mode specified.
183 *
184 * If @c parent is non-NULL, the new command will be registered as a
185 * sub-command under it; otherwise, it will be available as a top-level
186 * command.
187 *
188 * A conventioal format should be used for help strings, to provide both
189 * usage and basic information:
190 * @code
191 * "@<options@> ... - some explanation text"
192 * @endcode
193 *
194 * @param cmd_ctx The command_context in which to register the command.
195 * @param parent Register this command as a child of this, or NULL to
196 * register a top-level command.
197 * @param name The name of the command to register, which must not have
198 * been registered previously.
199 * @param handler The callback function that will be called. If NULL,
200 * then the command serves as a placeholder for its children or a script.
201 * @param mode The command mode(s) in which this command may be run.
202 * @param help The help text that will be displayed to the user.
203 * @returns The new command, if successful; otherwise, NULL.
204 */
205 struct command* register_command(struct command_context *cmd_ctx,
206 struct command *parent, const char *name,
207 command_handler_t handler, enum command_mode mode,
208 const char *help);
209
210 /**
211 * Unregisters command @c name from the given context, @c cmd_ctx.
212 * @param cmd_ctx The context of the registered command.
213 * @param parent The parent of the given command, or NULL.
214 * @param name The name of the command to unregister.
215 * @returns ERROR_OK on success, or an error code.
216 */
217 int unregister_command(struct command_context *cmd_ctx,
218 struct command *parent, const char *name);
219 /**
220 * Unregisters all commands from the specfied context.
221 * @param cmd_ctx The context that will be cleared of registered commands.
222 * @param parent If given, only clear commands from under this one command.
223 * @returns ERROR_OK on success, or an error code.
224 */
225 int unregister_all_commands(struct command_context *cmd_ctx,
226 struct command *parent);
227
228 void command_set_output_handler(struct command_context* context,
229 command_output_handler_t output_handler, void *priv);
230
231 struct command_context* copy_command_context(struct command_context* context);
232
233 int command_context_mode(struct command_context *context, enum command_mode mode);
234
235 /**
236 * Creates a new command context using the startup TCL provided.
237 */
238 struct command_context* command_init(const char *startup_tcl);
239 int command_done(struct command_context *context);
240
241 void command_print(struct command_context *context, const char *format, ...)
242 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
243 void command_print_sameline(struct command_context *context, const char *format, ...)
244 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
245 int command_run_line(struct command_context *context, char *line);
246 int command_run_linef(struct command_context *context, const char *format, ...)
247 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
248 void command_output_text(struct command_context *context, const char *data);
249
250 void process_jim_events(void);
251
252 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
253 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
254 #define ERROR_COMMAND_NOTFOUND (-602)
255 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
256 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
257 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
258
259 extern Jim_Interp *interp;
260
261 void register_jim(struct command_context *context, const char *name,
262 Jim_CmdProc cmd, const char *help);
263
264 int parse_ulong(const char *str, unsigned long *ul);
265 int parse_ullong(const char *str, unsigned long long *ul);
266
267 int parse_long(const char *str, long *ul);
268 int parse_llong(const char *str, long long *ul);
269
270 #define DECLARE_PARSE_WRAPPER(name, type) \
271 int parse##name(const char *str, type *ul)
272
273 DECLARE_PARSE_WRAPPER(_uint, unsigned);
274 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
275 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
276 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
277
278 DECLARE_PARSE_WRAPPER(_int, int);
279 DECLARE_PARSE_WRAPPER(_s32, int32_t);
280 DECLARE_PARSE_WRAPPER(_s16, int16_t);
281 DECLARE_PARSE_WRAPPER(_s8, int8_t);
282
283 /**
284 * @brief parses the string @a in into @a out as a @a type, or prints
285 * a command error and passes the error code to the caller. If an error
286 * does occur, the calling function will return the error code produced
287 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
288 *
289 * This function may cause the calling function to return immediately,
290 * so it should be used carefully to avoid leaking resources. In most
291 * situations, parsing should be completed in full before proceding
292 * to allocate resources, and this strategy will most prevents leaks.
293 */
294 #define COMMAND_PARSE_NUMBER(type, in, out) \
295 do { \
296 int retval = parse_##type(in, &(out)); \
297 if (ERROR_OK != retval) { \
298 command_print(CMD_CTX, stringify(out) \
299 " option value ('%s') is not valid", in); \
300 return retval; \
301 } \
302 } while (0)
303
304 /**
305 * Parse the string @c as a binary parameter, storing the boolean value
306 * in @c out. The strings @c on and @c off are used to match different
307 * strings for true and false options (e.g. "on" and "off" or
308 * "enable" and "disable").
309 */
310 #define COMMAND_PARSE_BOOL(in, out, on, off) \
311 do { \
312 bool value; \
313 int retval = command_parse_bool_arg(in, &value); \
314 if (ERROR_OK != retval) { \
315 command_print(CMD_CTX, stringify(out) \
316 " option value ('%s') is not valid", in); \
317 command_print(CMD_CTX, " choices are '%s' or '%s'", \
318 on, off); \
319 return retval; \
320 } \
321 out = value; \
322 } while (0)
323
324 int command_parse_bool_arg(const char *in, bool *out);
325 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);
326
327 /// parses an on/off command argument
328 #define COMMAND_PARSE_ON_OFF(in, out) \
329 COMMAND_PARSE_BOOL(in, out, "on", "off")
330 /// parses an enable/disable command argument
331 #define COMMAND_PARSE_ENABLE(in, out) \
332 COMMAND_PARSE_BOOL(in, out, "enable", "disable")
333
334 void script_debug(Jim_Interp *interp, const char *cmd,
335 unsigned argc, Jim_Obj *const *argv);
336
337 #endif /* COMMAND_H */