You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

423 lines
16 KiB

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