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