command.h 16 KB
Newer Older
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
5
 *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
6
7
 *   oyvind.harboe@zylin.com                                               *
 *                                                                         *
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef COMMAND_H
#define COMMAND_H

26
27
#include "types.h"

28
29
/* Integrate the JIM TCL interpretor into the command processing. */
#if BUILD_ECOSBOARD
30
#include <stdio.h>
31
32
33
34
35
36
#include <stdarg.h>
/* Jim is provied by eCos */
#include <cyg/jimtcl/jim.h>
#else
#include "jim.h"
#endif
37

38
39
40
41
/* To achieve C99 printf compatibility in MinGW, gnu_printf should be
 * used for __attribute__((format( ... ))), with GCC v4.4 or later
 */
#if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
42
43
44
45
46
#define PRINTF_ATTRIBUTE_FORMAT gnu_printf
#else
#define PRINTF_ATTRIBUTE_FORMAT printf
#endif

47
48
49
50
51
52
53
enum command_mode
{
	COMMAND_EXEC,
	COMMAND_CONFIG,
	COMMAND_ANY,
};

54
struct command_context;
Zachary T Welch's avatar
Zachary T Welch committed
55
56

/// The type signature for command context's output handler.
57
typedef int (*command_output_handler_t)(struct command_context *context,
Zachary T Welch's avatar
Zachary T Welch committed
58
59
				const char* line);

60
struct command_context
61
{
62
	Jim_Interp *interp;
63
	enum command_mode mode;
Zachary T Welch's avatar
Zachary T Welch committed
64
	struct command *commands;
65
	int current_target;
Zachary T Welch's avatar
Zachary T Welch committed
66
	command_output_handler_t output_handler;
67
	void *output_handler_priv;
68
};
69

70
71
struct command;

72
73
74
75
76
77
78
/**
 * When run_command is called, a new instance will be created on the
 * stack, filled with the proper values, and passed by reference to the
 * required COMMAND_HANDLER routine.
 */
struct command_invocation {
	struct command_context *ctx;
79
	struct command *current;
80
	const char *name;
81
82
83
	unsigned argc;
	const char **argv;
};
84
85
86
87
88
89
90

/**
 * Command handlers may be defined with more parameters than the base
 * set provided by command.c.  This macro uses C99 magic to allow
 * defining all such derivative types using this macro.
 */
#define __COMMAND_HANDLER(name, extra...) \
91
		int name(struct command_invocation *cmd, ##extra)
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

/**
 * Use this to macro to call a command helper (or a nested handler).
 * It provides command handler authors protection against reordering or
 * removal of unused parameters.
 *
 * @b Note: This macro uses lexical capture to provide some arguments.
 * As a result, this macro should be used @b only within functions
 * defined by the COMMAND_HANDLER or COMMAND_HELPER macros.  Those
 * macros provide the expected lexical context captured by this macro.
 * Furthermore, it should be used only from the top-level of handler or
 * helper function, or care must be taken to avoid redefining the same
 * variables in intervening scope(s) by accident.
 */
#define CALL_COMMAND_HANDLER(name, extra...) \
107
		name(cmd, ##extra)
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

/**
 * Always use this macro to define new command handler functions.
 * It ensures the parameters are ordered, typed, and named properly, so
 * they be can be used by other macros (e.g. COMMAND_PARSE_NUMBER).
 * All command handler functions must be defined as static in scope.
 */
#define COMMAND_HANDLER(name) static __COMMAND_HANDLER(name)

/**
 * Similar to COMMAND_HANDLER, except some parameters are expected.
 * A helper is globally-scoped because it may be shared between several
 * source files (e.g. the s3c24xx device command helper).
 */
#define COMMAND_HELPER(name, extra...) __COMMAND_HANDLER(name, extra)

124
125
126
127
/**
 * Use this macro to access the context of the command being handled,
 * rather than accessing the variable directly.  It may be moved.
 */
128
#define CMD_CTX cmd->ctx
129
130
131
132
/**
 * Use this macro to access the number of arguments for the command being
 * handled, rather than accessing the variable directly.  It may be moved.
 */
133
#define CMD_ARGC cmd->argc
134
135
136
137
/**
 * Use this macro to access the arguments for the command being handled,
 * rather than accessing the variable directly.  It may be moved.
 */
138
#define CMD_ARGV cmd->argv
139
140
141
142
/**
 * Use this macro to access the name of the command being handled,
 * rather than accessing the variable directly.  It may be moved.
 */
143
#define CMD_NAME cmd->name
144
145
146
147
148
149
150
151
152
153
/**
 * Use this macro to access the current command being handled,
 * rather than accessing the variable directly.  It may be moved.
 */
#define CMD_CURRENT cmd->current
/**
 * Use this macro to access the invoked command handler's data pointer,
 * rather than accessing the variable directly.  It may be moved.
 */
#define CMD_DATA CMD_CURRENT->jim_handler_data
154

155

156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
/**
 * The type signature for command handling functions.  They are
 * usually registered as part of command_registration, providing
 * a high-level means for executing a command.
 *
 * If the command fails, it *MUST* return a value != ERROR_OK
 * (many commands break this rule, patches welcome!)
 *
 * This is *especially* important for commands such as writing
 * to flash or verifying memory. The reason is that those commands
 * can be used by programs to determine if the operation succeded
 * or not. If the operation failed, then a program can try
 * an alternative approach.
 *
 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
 * printing out the syntax of the command.
 */
Zachary T Welch's avatar
Zachary T Welch committed
173
174
typedef __COMMAND_HANDLER((*command_handler_t));

Zachary T Welch's avatar
Zachary T Welch committed
175
struct command
176
177
{
	char *name;
Zachary T Welch's avatar
Zachary T Welch committed
178
	const char *help;
179
	const char *usage;
Zachary T Welch's avatar
Zachary T Welch committed
180
181
	struct command *parent;
	struct command *children;
Zachary T Welch's avatar
Zachary T Welch committed
182
	command_handler_t handler;
183
184
	Jim_CmdProc jim_handler;
	void *jim_handler_data;
185
	enum command_mode mode;
Zachary T Welch's avatar
Zachary T Welch committed
186
187
	struct command *next;
};
188

Zachary T Welch's avatar
Zachary T Welch committed
189
190
191
192
193
194
195
196
/**
 * @param c The command to be named.
 * @param delim The character to place between command names.
 * @returns A malloc'd string containing the full command name,
 * which may include one or more ancestor components.  Multiple names
 * are separated by single spaces.  The caller must free() the string
 * when done with it.
 */
Zachary T Welch's avatar
Zachary T Welch committed
197
char *command_name(struct command *c, char delim);
Zachary T Welch's avatar
Zachary T Welch committed
198

199
200
201
/*
 * Commands should be registered by filling in one or more of these
 * structures and passing them to register_command().
202
203
204
205
206
207
208
209
 *
 * A conventioal format should be used for help strings, to provide both
 * usage and basic information:
 * @code
 * "@<options@> ... - some explanation text"
 * @endcode
 *
 * @param name The name of the command to register, which must not have
210
 * been registered previously in the intended context.
211
212
213
214
 * @param handler The callback function that will be called.  If NULL,
 * then the command serves as a placeholder for its children or a script.
 * @param mode The command mode(s) in which this command may be run.
 * @param help The help text that will be displayed to the user.
215
216
217
218
 */
struct command_registration {
	const char *name;
	command_handler_t handler;
219
220
	Jim_CmdProc jim_handler;
	void *jim_handler_data;
221
222
	enum command_mode mode;
	const char *help;
223
224
	/// a string listing the options and arguments, required or optional
	const char *usage;
225
226
227
228
229
230
231
232

	/**
	 * If non-NULL, the commands in @c chain will be registered in
	 * the same context and scope of this registration record.
	 * This allows modules to inherit lists commands from other
	 * modules.
	 */
	const struct command_registration *chain;
233
234
};

235
/// Use this as the last entry in an array of command_registration records.
236
#define COMMAND_REGISTRATION_DONE { .name = NULL, .chain = NULL }
237

238
239
240
241
242
243
244
245
246
247
248
249
250
/**
 * Register a command @c handler that can be called from scripts during
 * the execution @c mode specified.
 *
 * If @c parent is non-NULL, the new command will be registered as a
 * sub-command under it; otherwise, it will be available as a top-level
 * command.
 *
 * @param cmd_ctx The command_context in which to register the command.
 * @param parent Register this command as a child of this, or NULL to
 * register a top-level command.
 * @param rec A command_registration record that contains the desired
 * command parameters.
251
252
253
 * @returns The new command, if successful; otherwise, NULL.
 */
struct command* register_command(struct command_context *cmd_ctx,
254
		struct command *parent, const struct command_registration *rec);
255

Zachary T Welch's avatar
Zachary T Welch committed
256
#define COMMAND_REGISTER(_cmd_ctx, _parent, _name, _handler, _mode, _help) \
257
258
259
260
261
262
263
264
265
	({ \
		struct command_registration cr = { \
				.name = _name, \
				.handler = _handler, \
				.mode = _mode, \
				.help = _help, \
			}; \
		register_command(_cmd_ctx, _parent, &cr); \
	})
Zachary T Welch's avatar
Zachary T Welch committed
266

267
268
/**
 * Register one or more commands in the specified context, as children
269
270
271
272
 * of @c parent (or top-level commends, if NULL).  In a registration's
 * record contains a non-NULL @c chain member and name is NULL, the
 * commands on the chain will be registered in the same context.
 * Otherwise, the chained commands are added as children of the command.
273
274
275
276
277
278
279
280
281
282
283
284
285
 *
 * @param cmd_ctx The command_context in which to register the command.
 * @param parent Register this command as a child of this, or NULL to
 * register a top-level command.
 * @param cmds Pointer to an array of command_registration records that
 * contains the desired command parameters.  The last record must have
 * NULL for all fields.
 * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
 */
int register_commands(struct command_context *cmd_ctx, struct command *parent,
		const struct command_registration *cmds);


286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
/**
 * Unregisters command @c name from the given context, @c cmd_ctx.
 * @param cmd_ctx The context of the registered command.
 * @param parent The parent of the given command, or NULL.
 * @param name The name of the command to unregister.
 * @returns ERROR_OK on success, or an error code.
 */
int unregister_command(struct command_context *cmd_ctx,
		struct command *parent, const char *name);
/**
 * Unregisters all commands from the specfied context.
 * @param cmd_ctx The context that will be cleared of registered commands.
 * @param parent If given, only clear commands from under this one command.
 * @returns ERROR_OK on success, or an error code.
 */
int unregister_all_commands(struct command_context *cmd_ctx,
		struct command *parent);
303

304
305
306
307
308
struct command *command_find_in_context(struct command_context *cmd_ctx,
		const char *name);
struct command *command_find_in_parent(struct command *parent,
		const char *name);

309
310
311
312
313
314
315
316
317
318
/**
 * Update the private command data field for a command and all descendents.
 * This is used when creating a new heirarchy of commands that depends
 * on obtaining a dynamically created context.  The value will be available
 * in command handlers by using the CMD_DATA macro.
 * @param c The command (group) whose data pointer(s) will be updated.
 * @param p The new data pointer to use for the command or its descendents.
 */
void command_set_handler_data(struct command *c, void *p);

319
void command_set_output_handler(struct command_context* context,
Zachary T Welch's avatar
Zachary T Welch committed
320
		command_output_handler_t output_handler, void *priv);
321
322


323
int command_context_mode(struct command_context *context, enum command_mode mode);
324

325
326
327
328
/**
 * Creates a new command context using the startup TCL provided.
 */
struct command_context* command_init(const char *startup_tcl);
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
/**
 * Creates a copy of an existing command context.  This does not create
 * a deep copy of the command list, so modifications in one context will
 * affect all shared contexts.  The caller must track reference counting
 * and ensure the commands are freed before destroying the last instance.
 * @param cmd_ctx The command_context that will be copied.
 * @returns A new command_context with the same state as the original.
 */
struct command_context* copy_command_context(struct command_context* cmd_ctx);
/**
 * Frees the resources associated with a command context.  The commands
 * are not removed, so unregister_all_commands() must be called first.
 * @param cmd_ctx The command_context that will be destroyed.
 */
void command_done(struct command_context *context);
344

345
void command_print(struct command_context *context, const char *format, ...)
346
		__attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
347
void command_print_sameline(struct command_context *context, const char *format, ...)
348
		__attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
349
350
int command_run_line(struct command_context *context, char *line);
int command_run_linef(struct command_context *context, const char *format, ...)
351
		__attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
352
void command_output_text(struct command_context *context, const char *data);
353

354
void process_jim_events(void);
355

356
#define		ERROR_COMMAND_CLOSE_CONNECTION		(-600)
ntfreak's avatar
ntfreak committed
357
#define		ERROR_COMMAND_SYNTAX_ERROR			(-601)
358
#define		ERROR_COMMAND_NOTFOUND				(-602)
359
360
361
#define		ERROR_COMMAND_ARGUMENT_INVALID		(-603)
#define		ERROR_COMMAND_ARGUMENT_OVERFLOW		(-604)
#define		ERROR_COMMAND_ARGUMENT_UNDERFLOW	(-605)
362

363
364
365
int parse_ulong(const char *str, unsigned long *ul);
int parse_ullong(const char *str, unsigned long long *ul);

366
367
368
int parse_long(const char *str, long *ul);
int parse_llong(const char *str, long long *ul);

369
#define DECLARE_PARSE_WRAPPER(name, type) \
370
	int parse##name(const char *str, type *ul)
371

372
373
374
375
DECLARE_PARSE_WRAPPER(_uint, unsigned);
DECLARE_PARSE_WRAPPER(_u32, uint32_t);
DECLARE_PARSE_WRAPPER(_u16, uint16_t);
DECLARE_PARSE_WRAPPER(_u8, uint8_t);
376

377
378
379
380
DECLARE_PARSE_WRAPPER(_int, int);
DECLARE_PARSE_WRAPPER(_s32, int32_t);
DECLARE_PARSE_WRAPPER(_s16, int16_t);
DECLARE_PARSE_WRAPPER(_s8, int8_t);
381

382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
/**
 * @brief parses the string @a in into @a out as a @a type, or prints
 * a command error and passes the error code to the caller.  If an error
 * does occur, the calling function will return the error code produced
 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
 *
 * This function may cause the calling function to return immediately,
 * so it should be used carefully to avoid leaking resources.  In most
 * situations, parsing should be completed in full before proceding
 * to allocate resources, and this strategy will most prevents leaks.
 */
#define COMMAND_PARSE_NUMBER(type, in, out) \
	do { \
		int retval = parse_##type(in, &(out)); \
		if (ERROR_OK != retval) { \
397
			command_print(CMD_CTX, stringify(out) \
398
399
400
401
402
				" option value ('%s') is not valid", in); \
			return retval; \
		} \
	} while (0)

403
404
405
406
407
408
409
410
/**
 * Parse the string @c as a binary parameter, storing the boolean value
 * in @c out.  The strings @c on and @c off are used to match different
 * strings for true and false options (e.g. "on" and "off" or
 * "enable" and "disable").
 */
#define COMMAND_PARSE_BOOL(in, out, on, off) \
	do { \
411
		bool value; \
412
		int retval = command_parse_bool_arg(in, &value); \
413
		if (ERROR_OK != retval) { \
414
415
416
417
			command_print(CMD_CTX, stringify(out) \
				" option value ('%s') is not valid", in); \
			command_print(CMD_CTX, "  choices are '%s' or '%s'", \
				on, off); \
418
			return retval; \
419
		} \
420
		out = value; \
421
422
	} while (0)

423
int command_parse_bool_arg(const char *in, bool *out);
424
425
COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);

426
427
428
429
430
431
432
/// parses an on/off command argument
#define COMMAND_PARSE_ON_OFF(in, out) \
		COMMAND_PARSE_BOOL(in, out, "on", "off")
/// parses an enable/disable command argument
#define COMMAND_PARSE_ENABLE(in, out) \
		COMMAND_PARSE_BOOL(in, out, "enable", "disable")

433
434
void script_debug(Jim_Interp *interp, const char *cmd,
		unsigned argc, Jim_Obj *const *argv);
zwelch's avatar
zwelch committed
435

436
#endif /* COMMAND_H */