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