command_handler_t: make cmd an indirect parameter
[openocd.git] / 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 #ifndef COMMAND_H
24 #define COMMAND_H
25
26 #include "types.h"
27
28 /* Integrate the JIM TCL interpretor into the command processing. */
29 #if BUILD_ECOSBOARD
30 #include <stdio.h>
31 #include <stdarg.h>
32 /* Jim is provied by eCos */
33 #include <cyg/jimtcl/jim.h>
34 #else
35 #include "jim.h"
36 #endif
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 {
49 COMMAND_EXEC,
50 COMMAND_CONFIG,
51 COMMAND_ANY,
52 };
53
54 struct command_context_s;
55
56 /// The type signature for command context's output handler.
57 typedef int (*command_output_handler_t)(struct command_context_s *context,
58 const char* line);
59
60 typedef struct command_context_s
61 {
62 enum command_mode mode;
63 struct command_s *commands;
64 int current_target;
65 /* Execute a command.
66 *
67 * If the command fails, it *MUST* return a value != ERROR_OK
68 * (many commands break this rule, patches welcome!)
69 *
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.
75 *
76 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
77 * printing out the syntax of the command.
78 */
79 command_output_handler_t output_handler;
80 void *output_handler_priv;
81 } command_context_t;
82
83
84 /**
85 * Command handlers may be defined with more parameters than the base
86 * set provided by command.c. This macro uses C99 magic to allow
87 * defining all such derivative types using this macro.
88 */
89 #define __COMMAND_HANDLER(name, extra...) \
90 int name(struct command_context_s *cmd_ctx, \
91 const char *args[], unsigned argc, ##extra)
92
93 /**
94 * Use this to macro to call a command helper (or a nested handler).
95 * It provides command handler authors protection against reordering or
96 * removal of unused parameters.
97 *
98 * @b Note: This macro uses lexical capture to provide some arguments.
99 * As a result, this macro should be used @b only within functions
100 * defined by the COMMAND_HANDLER or COMMAND_HELPER macros. Those
101 * macros provide the expected lexical context captured by this macro.
102 * Furthermore, it should be used only from the top-level of handler or
103 * helper function, or care must be taken to avoid redefining the same
104 * variables in intervening scope(s) by accident.
105 */
106 #define CALL_COMMAND_HANDLER(name, extra...) \
107 name(cmd_ctx, args, argc, ##extra)
108
109 /**
110 * Always use this macro to define new command handler functions.
111 * It ensures the parameters are ordered, typed, and named properly, so
112 * they be can be used by other macros (e.g. COMMAND_PARSE_NUMBER).
113 * All command handler functions must be defined as static in scope.
114 */
115 #define COMMAND_HANDLER(name) static __COMMAND_HANDLER(name)
116
117 /**
118 * Similar to COMMAND_HANDLER, except some parameters are expected.
119 * A helper is globally-scoped because it may be shared between several
120 * source files (e.g. the s3c24xx device command helper).
121 */
122 #define COMMAND_HELPER(name, extra...) __COMMAND_HANDLER(name, extra)
123
124 /**
125 * Use this macro to access the name of the command being handled,
126 * rather than accessing the variable directly. It may be moved.
127 */
128 #define CMD_NAME args[-1]
129
130
131 /// The type signature for commands' handler functions.
132 typedef __COMMAND_HANDLER((*command_handler_t));
133
134 typedef struct command_s
135 {
136 char *name;
137 struct command_s *parent;
138 struct command_s *children;
139 command_handler_t handler;
140 enum command_mode mode;
141 struct command_s *next;
142 } command_t;
143
144 /**
145 * @param c The command to be named.
146 * @param delim The character to place between command names.
147 * @returns A malloc'd string containing the full command name,
148 * which may include one or more ancestor components. Multiple names
149 * are separated by single spaces. The caller must free() the string
150 * when done with it.
151 */
152 char *command_name(struct command_s *c, char delim);
153
154 command_t* register_command(command_context_t *context,
155 command_t *parent, char *name, command_handler_t handler,
156 enum command_mode mode, char *help);
157
158 int unregister_command(command_context_t *context, char *name);
159 int unregister_all_commands(command_context_t *context);
160
161 void command_set_output_handler(command_context_t* context,
162 command_output_handler_t output_handler, void *priv);
163
164 command_context_t* copy_command_context(command_context_t* context);
165
166 int command_context_mode(command_context_t *context, enum command_mode mode);
167
168 command_context_t* command_init(void);
169 int command_done(command_context_t *context);
170
171 void command_print(command_context_t *context, const char *format, ...)
172 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
173 void command_print_sameline(command_context_t *context, const char *format, ...)
174 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
175 int command_run_line(command_context_t *context, char *line);
176 int command_run_linef(command_context_t *context, const char *format, ...)
177 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
178 void command_output_text(command_context_t *context, const char *data);
179
180 void process_jim_events(void);
181
182 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
183 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
184 #define ERROR_COMMAND_NOTFOUND (-602)
185 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
186 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
187 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
188
189 extern int fast_and_dangerous;
190
191 extern Jim_Interp *interp;
192
193 void register_jim(command_context_t *context, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help);
194
195 long jim_global_long(const char *variable);
196
197 int parse_ulong(const char *str, unsigned long *ul);
198 int parse_ullong(const char *str, unsigned long long *ul);
199
200 int parse_long(const char *str, long *ul);
201 int parse_llong(const char *str, long long *ul);
202
203 #define DECLARE_PARSE_WRAPPER(name, type) \
204 int parse##name(const char *str, type *ul)
205
206 DECLARE_PARSE_WRAPPER(_uint, unsigned);
207 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
208 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
209 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
210
211 DECLARE_PARSE_WRAPPER(_int, int);
212 DECLARE_PARSE_WRAPPER(_s32, int32_t);
213 DECLARE_PARSE_WRAPPER(_s16, int16_t);
214 DECLARE_PARSE_WRAPPER(_s8, int8_t);
215
216 /**
217 * @brief parses the string @a in into @a out as a @a type, or prints
218 * a command error and passes the error code to the caller. If an error
219 * does occur, the calling function will return the error code produced
220 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
221 *
222 * This function may cause the calling function to return immediately,
223 * so it should be used carefully to avoid leaking resources. In most
224 * situations, parsing should be completed in full before proceding
225 * to allocate resources, and this strategy will most prevents leaks.
226 */
227 #define COMMAND_PARSE_NUMBER(type, in, out) \
228 do { \
229 int retval = parse_##type(in, &(out)); \
230 if (ERROR_OK != retval) { \
231 command_print(cmd_ctx, stringify(out) \
232 " option value ('%s') is not valid", in); \
233 return retval; \
234 } \
235 } while (0)
236
237 void script_debug(Jim_Interp *interp, const char *cmd,
238 unsigned argc, Jim_Obj *const *argv);
239
240 #endif /* COMMAND_H */