1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
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. *
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. *
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 ***************************************************************************/
28 /* Integrate the JIM TCL interpretor into the command processing. */
32 /* Jim is provied by eCos */
33 #include <cyg/jimtcl/jim.h>
38 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
39 * used for __attribute__((format( ... ))), with GCC v4.4 or later
41 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
42 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
44 #define PRINTF_ATTRIBUTE_FORMAT printf
54 typedef struct command_context_s
56 enum command_mode mode;
57 struct command_s *commands;
61 * If the command fails, it *MUST* return a value != ERROR_OK
62 * (many commands break this rule, patches welcome!)
64 * This is *especially* important for commands such as writing
65 * to flash or verifying memory. The reason is that those commands
66 * can be used by programs to determine if the operation succeded
67 * or not. If the operation failed, then a program can try
68 * an alternative approach.
70 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
71 * printing out the syntax of the command.
73 int (*output_handler)(struct command_context_s *context, const char* line);
74 void *output_handler_priv;
77 typedef struct command_s
80 struct command_s *parent;
81 struct command_s *children;
82 int (*handler)(struct command_context_s *context, char* name, char** args, int argc);
83 enum command_mode mode;
84 struct command_s *next;
87 command_t* register_command(command_context_t *context,
88 command_t *parent, char *name,
89 int (*handler)(struct command_context_s *context,
90 char* name, char** args, int argc),
91 enum command_mode mode, char *help);
93 int unregister_command(command_context_t *context, char *name);
94 int unregister_all_commands(command_context_t *context);
96 void command_set_output_handler(command_context_t* context,
97 int (*output_handler)(struct command_context_s *context,
98 const char* line), void *priv);
100 command_context_t* copy_command_context(command_context_t* context);
102 int command_context_mode(command_context_t *context, enum command_mode mode);
104 command_context_t* command_init(void);
105 int command_done(command_context_t *context);
107 void command_print(command_context_t *context, const char *format, ...)
108 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
109 void command_print_sameline(command_context_t *context, const char *format, ...)
110 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
111 int command_run_line(command_context_t *context, char *line);
112 int command_run_linef(command_context_t *context, const char *format, ...)
113 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
114 void command_output_text(command_context_t *context, const char *data);
116 void process_jim_events(void);
118 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
119 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
120 #define ERROR_COMMAND_NOTFOUND (-602)
121 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
122 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
123 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
125 extern int fast_and_dangerous;
127 extern Jim_Interp *interp;
129 void register_jim(command_context_t *context, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help);
131 long jim_global_long(const char *variable);
133 int parse_ulong(const char *str, unsigned long *ul);
134 int parse_ullong(const char *str, unsigned long long *ul);
136 int parse_long(const char *str, long *ul);
137 int parse_llong(const char *str, long long *ul);
139 #define DECLARE_PARSE_WRAPPER(name, type) \
140 int parse##name(const char *str, type *ul)
142 DECLARE_PARSE_WRAPPER(_uint, unsigned);
143 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
144 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
145 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
147 DECLARE_PARSE_WRAPPER(_int, int);
148 DECLARE_PARSE_WRAPPER(_s32, int32_t);
149 DECLARE_PARSE_WRAPPER(_s16, int16_t);
150 DECLARE_PARSE_WRAPPER(_s8, int8_t);
153 * @brief parses the string @a in into @a out as a @a type, or prints
154 * a command error and passes the error code to the caller. If an error
155 * does occur, the calling function will return the error code produced
156 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
158 * This function may cause the calling function to return immediately,
159 * so it should be used carefully to avoid leaking resources. In most
160 * situations, parsing should be completed in full before proceding
161 * to allocate resources, and this strategy will most prevents leaks.
163 #define COMMAND_PARSE_NUMBER(type, in, out) \
165 int retval = parse_##type(in, &(out)); \
166 if (ERROR_OK != retval) { \
167 command_print(cmd_ctx, stringify(out) \
168 " option value ('%s') is not valid", in); \
173 void script_debug(Jim_Interp *interp, const char *cmd, int argc, Jim_Obj *const *argv);
175 #endif /* COMMAND_H */