1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
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. *
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. *
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 ***************************************************************************/
28 /* Integrate the JIM TCL interpretor into the command processing. */
32 /* Jim is provied by eCos */
33 #include <cyg/jimtcl/jim.h>
38 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
39 * used for __attribute__((format( ... ))), with GCC v4.4 or later
41 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
42 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
44 #define PRINTF_ATTRIBUTE_FORMAT printf
54 struct command_context;
56 /// The type signature for command context's output handler.
57 typedef int (*command_output_handler_t)(struct command_context *context,
60 struct command_context
62 enum command_mode mode;
63 struct command *commands;
67 * If the command fails, it *MUST* return a value != ERROR_OK
68 * (many commands break this rule, patches welcome!)
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.
76 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
77 * printing out the syntax of the command.
79 command_output_handler_t output_handler;
80 void *output_handler_priv;
86 * When run_command is called, a new instance will be created on the
87 * stack, filled with the proper values, and passed by reference to the
88 * required COMMAND_HANDLER routine.
90 struct command_invocation {
91 struct command_context *ctx;
92 struct command *current;
99 * Command handlers may be defined with more parameters than the base
100 * set provided by command.c. This macro uses C99 magic to allow
101 * defining all such derivative types using this macro.
103 #define __COMMAND_HANDLER(name, extra...) \
104 int name(struct command_invocation *cmd, ##extra)
107 * Use this to macro to call a command helper (or a nested handler).
108 * It provides command handler authors protection against reordering or
109 * removal of unused parameters.
111 * @b Note: This macro uses lexical capture to provide some arguments.
112 * As a result, this macro should be used @b only within functions
113 * defined by the COMMAND_HANDLER or COMMAND_HELPER macros. Those
114 * macros provide the expected lexical context captured by this macro.
115 * Furthermore, it should be used only from the top-level of handler or
116 * helper function, or care must be taken to avoid redefining the same
117 * variables in intervening scope(s) by accident.
119 #define CALL_COMMAND_HANDLER(name, extra...) \
123 * Always use this macro to define new command handler functions.
124 * It ensures the parameters are ordered, typed, and named properly, so
125 * they be can be used by other macros (e.g. COMMAND_PARSE_NUMBER).
126 * All command handler functions must be defined as static in scope.
128 #define COMMAND_HANDLER(name) static __COMMAND_HANDLER(name)
131 * Similar to COMMAND_HANDLER, except some parameters are expected.
132 * A helper is globally-scoped because it may be shared between several
133 * source files (e.g. the s3c24xx device command helper).
135 #define COMMAND_HELPER(name, extra...) __COMMAND_HANDLER(name, extra)
138 * Use this macro to access the context of the command being handled,
139 * rather than accessing the variable directly. It may be moved.
141 #define CMD_CTX cmd->ctx
143 * Use this macro to access the number of arguments for the command being
144 * handled, rather than accessing the variable directly. It may be moved.
146 #define CMD_ARGC cmd->argc
148 * Use this macro to access the arguments for the command being handled,
149 * rather than accessing the variable directly. It may be moved.
151 #define CMD_ARGV cmd->argv
153 * Use this macro to access the name of the command being handled,
154 * rather than accessing the variable directly. It may be moved.
156 #define CMD_NAME cmd->name
158 * Use this macro to access the current command being handled,
159 * rather than accessing the variable directly. It may be moved.
161 #define CMD_CURRENT cmd->current
163 * Use this macro to access the invoked command handler's data pointer,
164 * rather than accessing the variable directly. It may be moved.
166 #define CMD_DATA CMD_CURRENT->jim_handler_data
169 /// The type signature for commands' handler functions.
170 typedef __COMMAND_HANDLER((*command_handler_t));
177 struct command *parent;
178 struct command *children;
179 command_handler_t handler;
180 Jim_CmdProc jim_handler;
181 void *jim_handler_data;
182 enum command_mode mode;
183 struct command *next;
187 * @param c The command to be named.
188 * @param delim The character to place between command names.
189 * @returns A malloc'd string containing the full command name,
190 * which may include one or more ancestor components. Multiple names
191 * are separated by single spaces. The caller must free() the string
194 char *command_name(struct command *c, char delim);
197 * Commands should be registered by filling in one or more of these
198 * structures and passing them to register_command().
200 * A conventioal format should be used for help strings, to provide both
201 * usage and basic information:
203 * "@<options@> ... - some explanation text"
206 * @param name The name of the command to register, which must not have
207 * been registered previously in the intended context.
208 * @param handler The callback function that will be called. If NULL,
209 * then the command serves as a placeholder for its children or a script.
210 * @param mode The command mode(s) in which this command may be run.
211 * @param help The help text that will be displayed to the user.
213 struct command_registration {
215 command_handler_t handler;
216 Jim_CmdProc jim_handler;
217 void *jim_handler_data;
218 enum command_mode mode;
220 /// a string listing the options and arguments, required or optional
224 * If non-NULL, the commands in @c chain will be registered in
225 * the same context and scope of this registration record.
226 * This allows modules to inherit lists commands from other
229 const struct command_registration *chain;
232 /// Use this as the last entry in an array of command_registration records.
233 #define COMMAND_REGISTRATION_DONE { .name = NULL, .chain = NULL }
236 * Register a command @c handler that can be called from scripts during
237 * the execution @c mode specified.
239 * If @c parent is non-NULL, the new command will be registered as a
240 * sub-command under it; otherwise, it will be available as a top-level
243 * @param cmd_ctx The command_context in which to register the command.
244 * @param parent Register this command as a child of this, or NULL to
245 * register a top-level command.
246 * @param rec A command_registration record that contains the desired
247 * command parameters.
248 * @returns The new command, if successful; otherwise, NULL.
250 struct command* register_command(struct command_context *cmd_ctx,
251 struct command *parent, const struct command_registration *rec);
253 #define COMMAND_REGISTER(_cmd_ctx, _parent, _name, _handler, _mode, _help) \
255 struct command_registration cr = { \
257 .handler = _handler, \
261 register_command(_cmd_ctx, _parent, &cr); \
265 * Register one or more commands in the specified context, as children
266 * of @c parent (or top-level commends, if NULL). In a registration's
267 * record contains a non-NULL @c chain member and name is NULL, the
268 * commands on the chain will be registered in the same context.
269 * Otherwise, the chained commands are added as children of the command.
271 * @param cmd_ctx The command_context in which to register the command.
272 * @param parent Register this command as a child of this, or NULL to
273 * register a top-level command.
274 * @param cmds Pointer to an array of command_registration records that
275 * contains the desired command parameters. The last record must have
276 * NULL for all fields.
277 * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
279 int register_commands(struct command_context *cmd_ctx, struct command *parent,
280 const struct command_registration *cmds);
284 * Unregisters command @c name from the given context, @c cmd_ctx.
285 * @param cmd_ctx The context of the registered command.
286 * @param parent The parent of the given command, or NULL.
287 * @param name The name of the command to unregister.
288 * @returns ERROR_OK on success, or an error code.
290 int unregister_command(struct command_context *cmd_ctx,
291 struct command *parent, const char *name);
293 * Unregisters all commands from the specfied context.
294 * @param cmd_ctx The context that will be cleared of registered commands.
295 * @param parent If given, only clear commands from under this one command.
296 * @returns ERROR_OK on success, or an error code.
298 int unregister_all_commands(struct command_context *cmd_ctx,
299 struct command *parent);
301 struct command *command_find_in_context(struct command_context *cmd_ctx,
303 struct command *command_find_in_parent(struct command *parent,
307 * Update the private command data field for a command and all descendents.
308 * This is used when creating a new heirarchy of commands that depends
309 * on obtaining a dynamically created context. The value will be available
310 * in command handlers by using the CMD_DATA macro.
311 * @param c The command (group) whose data pointer(s) will be updated.
312 * @param p The new data pointer to use for the command or its descendents.
314 void command_set_handler_data(struct command *c, void *p);
316 void command_set_output_handler(struct command_context* context,
317 command_output_handler_t output_handler, void *priv);
320 int command_context_mode(struct command_context *context, enum command_mode mode);
323 * Creates a new command context using the startup TCL provided.
325 struct command_context* command_init(const char *startup_tcl);
327 * Creates a copy of an existing command context. This does not create
328 * a deep copy of the command list, so modifications in one context will
329 * affect all shared contexts. The caller must track reference counting
330 * and ensure the commands are freed before destroying the last instance.
331 * @param cmd_ctx The command_context that will be copied.
332 * @returns A new command_context with the same state as the original.
334 struct command_context* copy_command_context(struct command_context* cmd_ctx);
336 * Frees the resources associated with a command context. The commands
337 * are not removed, so unregister_all_commands() must be called first.
338 * @param cmd_ctx The command_context that will be destroyed.
340 void command_done(struct command_context *context);
342 void command_print(struct command_context *context, const char *format, ...)
343 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
344 void command_print_sameline(struct command_context *context, const char *format, ...)
345 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
346 int command_run_line(struct command_context *context, char *line);
347 int command_run_linef(struct command_context *context, const char *format, ...)
348 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
349 void command_output_text(struct command_context *context, const char *data);
351 void process_jim_events(void);
353 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
354 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
355 #define ERROR_COMMAND_NOTFOUND (-602)
356 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
357 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
358 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
360 extern Jim_Interp *interp;
362 int parse_ulong(const char *str, unsigned long *ul);
363 int parse_ullong(const char *str, unsigned long long *ul);
365 int parse_long(const char *str, long *ul);
366 int parse_llong(const char *str, long long *ul);
368 #define DECLARE_PARSE_WRAPPER(name, type) \
369 int parse##name(const char *str, type *ul)
371 DECLARE_PARSE_WRAPPER(_uint, unsigned);
372 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
373 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
374 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
376 DECLARE_PARSE_WRAPPER(_int, int);
377 DECLARE_PARSE_WRAPPER(_s32, int32_t);
378 DECLARE_PARSE_WRAPPER(_s16, int16_t);
379 DECLARE_PARSE_WRAPPER(_s8, int8_t);
382 * @brief parses the string @a in into @a out as a @a type, or prints
383 * a command error and passes the error code to the caller. If an error
384 * does occur, the calling function will return the error code produced
385 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
387 * This function may cause the calling function to return immediately,
388 * so it should be used carefully to avoid leaking resources. In most
389 * situations, parsing should be completed in full before proceding
390 * to allocate resources, and this strategy will most prevents leaks.
392 #define COMMAND_PARSE_NUMBER(type, in, out) \
394 int retval = parse_##type(in, &(out)); \
395 if (ERROR_OK != retval) { \
396 command_print(CMD_CTX, stringify(out) \
397 " option value ('%s') is not valid", in); \
403 * Parse the string @c as a binary parameter, storing the boolean value
404 * in @c out. The strings @c on and @c off are used to match different
405 * strings for true and false options (e.g. "on" and "off" or
406 * "enable" and "disable").
408 #define COMMAND_PARSE_BOOL(in, out, on, off) \
411 int retval = command_parse_bool_arg(in, &value); \
412 if (ERROR_OK != retval) { \
413 command_print(CMD_CTX, stringify(out) \
414 " option value ('%s') is not valid", in); \
415 command_print(CMD_CTX, " choices are '%s' or '%s'", \
422 int command_parse_bool_arg(const char *in, bool *out);
423 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);
425 /// parses an on/off command argument
426 #define COMMAND_PARSE_ON_OFF(in, out) \
427 COMMAND_PARSE_BOOL(in, out, "on", "off")
428 /// parses an enable/disable command argument
429 #define COMMAND_PARSE_ENABLE(in, out) \
430 COMMAND_PARSE_BOOL(in, out, "enable", "disable")
432 void script_debug(Jim_Interp *interp, const char *cmd,
433 unsigned argc, Jim_Obj *const *argv);
435 #endif /* COMMAND_H */