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 ***************************************************************************/
35 typedef struct command_context_s
37 enum command_mode mode;
38 struct command_s *commands;
42 * If the command fails, it *MUST* return a value != ERROR_OK
43 * (many commands break this rule, patches welcome!)
45 * This is *especially* important for commands such as writing
46 * to flash or verifying memory. The reason is that those commands
47 * can be used by programs to determine if the operation succeded
48 * or not. If the operation failed, then a program can try
49 * an alternative approach.
51 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
52 * printing out the syntax of the command.
54 int (*output_handler)(struct command_context_s *context, const char* line);
55 void *output_handler_priv;
58 typedef struct command_s
61 struct command_s *parent;
62 struct command_s *children;
63 int (*handler)(struct command_context_s *context, char* name, char** args, int argc);
64 enum command_mode mode;
65 struct command_s *next;
68 extern command_t* register_command(command_context_t *context, command_t *parent, char *name, int (*handler)(struct command_context_s *context, char* name, char** args, int argc), enum command_mode mode, char *help);
69 extern int unregister_command(command_context_t *context, char *name);
70 extern int unregister_all_commands(command_context_t *context);
71 extern void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv);
72 extern command_context_t* copy_command_context(command_context_t* context);
73 extern int command_context_mode(command_context_t *context, enum command_mode mode);
74 extern command_context_t* command_init(void);
75 extern int command_done(command_context_t *context);
76 extern void command_print(command_context_t *context, char *format, ...);
77 extern void command_print_sameline(command_context_t *context, char *format, ...);
78 extern int command_run_line(command_context_t *context, char *line);
79 extern int command_run_linef(command_context_t *context, char *format, ...);
80 extern void command_output_text(command_context_t *context, const char *data);
82 extern void process_jim_events(void);
84 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
85 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
86 #define ERROR_COMMAND_NOTFOUND (-602)
88 extern int fast_and_dangerous;
90 /* Integrate the JIM TCL interpretor into the command processing. */
93 /* Jim is provied by eCos */
94 #include <cyg/jimtcl/jim.h>
100 extern Jim_Interp *interp;
102 void register_jim(command_context_t *context, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help);
104 long jim_global_long(const char *variable);
106 #endif /* COMMAND_H */