jim tests: use installed
[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 <helper/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 #endif
33
34 #include <jim.h>
35 #include <jim-nvp.h>
36
37 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
38 * used for __attribute__((format( ... ))), with GCC v4.4 or later
39 */
40 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
41 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
42 #else
43 #define PRINTF_ATTRIBUTE_FORMAT printf
44 #endif
45
46 enum command_mode
47 {
48 COMMAND_EXEC,
49 COMMAND_CONFIG,
50 COMMAND_ANY,
51 };
52
53 struct command_context;
54
55 /// The type signature for command context's output handler.
56 typedef int (*command_output_handler_t)(struct command_context *context,
57 const char* line);
58
59 struct command_context
60 {
61 Jim_Interp *interp;
62 enum command_mode mode;
63 struct command *commands;
64 int current_target;
65 command_output_handler_t output_handler;
66 void *output_handler_priv;
67 };
68
69 struct command;
70
71 /**
72 * When run_command is called, a new instance will be created on the
73 * stack, filled with the proper values, and passed by reference to the
74 * required COMMAND_HANDLER routine.
75 */
76 struct command_invocation {
77 struct command_context *ctx;
78 struct command *current;
79 const char *name;
80 unsigned argc;
81 const char **argv;
82 };
83
84 /**
85 * Command handlers may be defined with more parameters than the base
86 * set provided by command.c. This macro uses C99 magic to allow
87 * defining all such derivative types using this macro.
88 */
89 #define __COMMAND_HANDLER(name, extra...) \
90 int name(struct command_invocation *cmd, ##extra)
91
92 /**
93 * Use this to macro to call a command helper (or a nested handler).
94 * It provides command handler authors protection against reordering or
95 * removal of unused parameters.
96 *
97 * @b Note: This macro uses lexical capture to provide some arguments.
98 * As a result, this macro should be used @b only within functions
99 * defined by the COMMAND_HANDLER or COMMAND_HELPER macros. Those
100 * macros provide the expected lexical context captured by this macro.
101 * Furthermore, it should be used only from the top-level of handler or
102 * helper function, or care must be taken to avoid redefining the same
103 * variables in intervening scope(s) by accident.
104 */
105 #define CALL_COMMAND_HANDLER(name, extra...) \
106 name(cmd, ##extra)
107
108 /**
109 * Always use this macro to define new command handler functions.
110 * It ensures the parameters are ordered, typed, and named properly, so
111 * they be can be used by other macros (e.g. COMMAND_PARSE_NUMBER).
112 * All command handler functions must be defined as static in scope.
113 */
114 #define COMMAND_HANDLER(name) static __COMMAND_HANDLER(name)
115
116 /**
117 * Similar to COMMAND_HANDLER, except some parameters are expected.
118 * A helper is globally-scoped because it may be shared between several
119 * source files (e.g. the s3c24xx device command helper).
120 */
121 #define COMMAND_HELPER(name, extra...) __COMMAND_HANDLER(name, extra)
122
123 /**
124 * Use this macro to access the context of the command being handled,
125 * rather than accessing the variable directly. It may be moved.
126 */
127 #define CMD_CTX cmd->ctx
128 /**
129 * Use this macro to access the number of arguments for the command being
130 * handled, rather than accessing the variable directly. It may be moved.
131 */
132 #define CMD_ARGC cmd->argc
133 /**
134 * Use this macro to access the arguments for the command being handled,
135 * rather than accessing the variable directly. It may be moved.
136 */
137 #define CMD_ARGV cmd->argv
138 /**
139 * Use this macro to access the name of the command being handled,
140 * rather than accessing the variable directly. It may be moved.
141 */
142 #define CMD_NAME cmd->name
143 /**
144 * Use this macro to access the current command being handled,
145 * rather than accessing the variable directly. It may be moved.
146 */
147 #define CMD_CURRENT cmd->current
148 /**
149 * Use this macro to access the invoked command handler's data pointer,
150 * rather than accessing the variable directly. It may be moved.
151 */
152 #define CMD_DATA CMD_CURRENT->jim_handler_data
153
154
155 /**
156 * The type signature for command handling functions. They are
157 * usually registered as part of command_registration, providing
158 * a high-level means for executing a command.
159 *
160 * If the command fails, it *MUST* return a value != ERROR_OK
161 * (many commands break this rule, patches welcome!)
162 *
163 * This is *especially* important for commands such as writing
164 * to flash or verifying memory. The reason is that those commands
165 * can be used by programs to determine if the operation succeded
166 * or not. If the operation failed, then a program can try
167 * an alternative approach.
168 *
169 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
170 * printing out the syntax of the command.
171 */
172 typedef __COMMAND_HANDLER((*command_handler_t));
173
174 struct command
175 {
176 char *name;
177 const char *help;
178 const char *usage;
179 struct command *parent;
180 struct command *children;
181 command_handler_t handler;
182 Jim_CmdProc jim_handler;
183 void *jim_handler_data;
184 enum command_mode mode;
185 struct command *next;
186 };
187
188 /**
189 * @param c The command to be named.
190 * @param delim The character to place between command names.
191 * @returns A malloc'd string containing the full command name,
192 * which may include one or more ancestor components. Multiple names
193 * are separated by single spaces. The caller must free() the string
194 * when done with it.
195 */
196 char *command_name(struct command *c, char delim);
197
198 /*
199 * Commands should be registered by filling in one or more of these
200 * structures and passing them to register_command().
201 *
202 * A conventioal format should be used for help strings, to provide both
203 * usage and basic information:
204 * @code
205 * "@<options@> ... - some explanation text"
206 * @endcode
207 *
208 * @param name The name of the command to register, which must not have
209 * been registered previously in the intended context.
210 * @param handler The callback function that will be called. If NULL,
211 * then the command serves as a placeholder for its children or a script.
212 * @param mode The command mode(s) in which this command may be run.
213 * @param help The help text that will be displayed to the user.
214 */
215 struct command_registration {
216 const char *name;
217 command_handler_t handler;
218 Jim_CmdProc jim_handler;
219 void *jim_handler_data;
220 enum command_mode mode;
221 const char *help;
222 /// a string listing the options and arguments, required or optional
223 const char *usage;
224
225 /**
226 * If non-NULL, the commands in @c chain will be registered in
227 * the same context and scope of this registration record.
228 * This allows modules to inherit lists commands from other
229 * modules.
230 */
231 const struct command_registration *chain;
232 };
233
234 /// Use this as the last entry in an array of command_registration records.
235 #define COMMAND_REGISTRATION_DONE { .name = NULL, .chain = NULL }
236
237 /**
238 * Register a command @c handler that can be called from scripts during
239 * the execution @c mode specified.
240 *
241 * If @c parent is non-NULL, the new command will be registered as a
242 * sub-command under it; otherwise, it will be available as a top-level
243 * command.
244 *
245 * @param cmd_ctx The command_context in which to register the command.
246 * @param parent Register this command as a child of this, or NULL to
247 * register a top-level command.
248 * @param rec A command_registration record that contains the desired
249 * command parameters.
250 * @returns The new command, if successful; otherwise, NULL.
251 */
252 struct command* register_command(struct command_context *cmd_ctx,
253 struct command *parent, const struct command_registration *rec);
254
255 /**
256 * Register one or more commands in the specified context, as children
257 * of @c parent (or top-level commends, if NULL). In a registration's
258 * record contains a non-NULL @c chain member and name is NULL, the
259 * commands on the chain will be registered in the same context.
260 * Otherwise, the chained commands are added as children of the command.
261 *
262 * @param cmd_ctx The command_context in which to register the command.
263 * @param parent Register this command as a child of this, or NULL to
264 * register a top-level command.
265 * @param cmds Pointer to an array of command_registration records that
266 * contains the desired command parameters. The last record must have
267 * NULL for all fields.
268 * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
269 */
270 int register_commands(struct command_context *cmd_ctx, struct command *parent,
271 const struct command_registration *cmds);
272
273
274 /**
275 * Unregisters command @c name from the given context, @c cmd_ctx.
276 * @param cmd_ctx The context of the registered command.
277 * @param parent The parent of the given command, or NULL.
278 * @param name The name of the command to unregister.
279 * @returns ERROR_OK on success, or an error code.
280 */
281 int unregister_command(struct command_context *cmd_ctx,
282 struct command *parent, const char *name);
283 /**
284 * Unregisters all commands from the specfied context.
285 * @param cmd_ctx The context that will be cleared of registered commands.
286 * @param parent If given, only clear commands from under this one command.
287 * @returns ERROR_OK on success, or an error code.
288 */
289 int unregister_all_commands(struct command_context *cmd_ctx,
290 struct command *parent);
291
292 struct command *command_find_in_context(struct command_context *cmd_ctx,
293 const char *name);
294 struct command *command_find_in_parent(struct command *parent,
295 const char *name);
296
297 /**
298 * Update the private command data field for a command and all descendents.
299 * This is used when creating a new heirarchy of commands that depends
300 * on obtaining a dynamically created context. The value will be available
301 * in command handlers by using the CMD_DATA macro.
302 * @param c The command (group) whose data pointer(s) will be updated.
303 * @param p The new data pointer to use for the command or its descendents.
304 */
305 void command_set_handler_data(struct command *c, void *p);
306
307 void command_set_output_handler(struct command_context* context,
308 command_output_handler_t output_handler, void *priv);
309
310
311 int command_context_mode(struct command_context *context, enum command_mode mode);
312
313 /* Return the current command context associated with the Jim interpreter or
314 * alternatively the global default command interpreter
315 */
316 struct command_context *current_command_context(Jim_Interp *interp);
317 /**
318 * Creates a new command context using the startup TCL provided and
319 * the existing Jim interpreter, if any. If interp == NULL, then command_init
320 * creates a command interpreter.
321 */
322 struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp);
323 /**
324 * Creates a copy of an existing command context. This does not create
325 * a deep copy of the command list, so modifications in one context will
326 * affect all shared contexts. The caller must track reference counting
327 * and ensure the commands are freed before destroying the last instance.
328 * @param cmd_ctx The command_context that will be copied.
329 * @returns A new command_context with the same state as the original.
330 */
331 struct command_context* copy_command_context(struct command_context* cmd_ctx);
332 /**
333 * Frees the resources associated with a command context. The commands
334 * are not removed, so unregister_all_commands() must be called first.
335 * @param context The command_context that will be destroyed.
336 */
337 void command_done(struct command_context *context);
338
339 void command_print(struct command_context *context, const char *format, ...)
340 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
341 void command_print_sameline(struct command_context *context, const char *format, ...)
342 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
343 int command_run_line(struct command_context *context, char *line);
344 int command_run_linef(struct command_context *context, const char *format, ...)
345 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
346 void command_output_text(struct command_context *context, const char *data);
347
348 void process_jim_events(struct command_context *cmd_ctx);
349
350 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
351 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
352 #define ERROR_COMMAND_NOTFOUND (-602)
353 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
354 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
355 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
356
357 int parse_ulong(const char *str, unsigned long *ul);
358 int parse_ullong(const char *str, unsigned long long *ul);
359
360 int parse_long(const char *str, long *ul);
361 int parse_llong(const char *str, long long *ul);
362
363 #define DECLARE_PARSE_WRAPPER(name, type) \
364 int parse##name(const char *str, type *ul)
365
366 DECLARE_PARSE_WRAPPER(_uint, unsigned);
367 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
368 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
369 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
370
371 DECLARE_PARSE_WRAPPER(_int, int);
372 DECLARE_PARSE_WRAPPER(_s32, int32_t);
373 DECLARE_PARSE_WRAPPER(_s16, int16_t);
374 DECLARE_PARSE_WRAPPER(_s8, int8_t);
375
376 /**
377 * @brief parses the string @a in into @a out as a @a type, or prints
378 * a command error and passes the error code to the caller. If an error
379 * does occur, the calling function will return the error code produced
380 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
381 *
382 * This function may cause the calling function to return immediately,
383 * so it should be used carefully to avoid leaking resources. In most
384 * situations, parsing should be completed in full before proceding
385 * to allocate resources, and this strategy will most prevents leaks.
386 */
387 #define COMMAND_PARSE_NUMBER(type, in, out) \
388 do { \
389 int retval_macro_tmp = parse_##type(in, &(out)); \
390 if (ERROR_OK != retval_macro_tmp) { \
391 command_print(CMD_CTX, stringify(out) \
392 " option value ('%s') is not valid", in); \
393 return retval_macro_tmp; \
394 } \
395 } while (0)
396
397 /**
398 * Parse the string @c as a binary parameter, storing the boolean value
399 * in @c out. The strings @c on and @c off are used to match different
400 * strings for true and false options (e.g. "on" and "off" or
401 * "enable" and "disable").
402 */
403 #define COMMAND_PARSE_BOOL(in, out, on, off) \
404 do { \
405 bool value; \
406 int retval_macro_tmp = command_parse_bool_arg(in, &value); \
407 if (ERROR_OK != retval_macro_tmp) { \
408 command_print(CMD_CTX, stringify(out) \
409 " option value ('%s') is not valid", in); \
410 command_print(CMD_CTX, " choices are '%s' or '%s'", \
411 on, off); \
412 return retval_macro_tmp; \
413 } \
414 out = value; \
415 } while (0)
416
417 int command_parse_bool_arg(const char *in, bool *out);
418 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);
419
420 /// parses an on/off command argument
421 #define COMMAND_PARSE_ON_OFF(in, out) \
422 COMMAND_PARSE_BOOL(in, out, "on", "off")
423 /// parses an enable/disable command argument
424 #define COMMAND_PARSE_ENABLE(in, out) \
425 COMMAND_PARSE_BOOL(in, out, "enable", "disable")
426
427 void script_debug(Jim_Interp *interp, const char *cmd,
428 unsigned argc, Jim_Obj *const *argv);
429
430 #endif /* COMMAND_H */