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