1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
32 typedef struct command_context_s
34 enum command_mode mode;
35 struct command_s *commands;
39 * If the command fails, it *MUST* return a value != ERROR_OK
40 * (many commands break this rule, patches welcome!)
42 * This is *especially* important for commands such as writing
43 * to flash or verifying memory. The reason is that those commands
44 * can be used by programs to determine if the operation succeded
45 * or not. If the operation failed, then a program can try
46 * an alternative approach.
48 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
49 * printing out the syntax of the command.
51 int (*output_handler)(struct command_context_s *context, char* line);
52 void *output_handler_priv;
55 typedef struct command_s
58 struct command_s *parent;
59 struct command_s *children;
60 int (*handler)(struct command_context_s *context, char* name, char** args, int argc);
61 enum command_mode mode;
64 struct command_s *next;
67 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);
68 extern int unregister_command(command_context_t *context, char *name);
69 extern void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, char* line), void *priv);
70 extern command_context_t* copy_command_context(command_context_t* context);
71 extern command_context_t* command_init();
72 extern int command_done(command_context_t *context);
73 extern void command_print(command_context_t *context, char *format, ...);
74 extern void command_print_sameline(command_context_t *context, char *format, ...);
75 extern int command_run_line(command_context_t *context, char *line);
76 extern int command_run_file(command_context_t *context, FILE *file, enum command_mode mode);
79 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
80 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
83 extern int fast_and_dangerous;
85 #endif /* COMMAND_H */