- prepare OpenOCD for branching, created ./trunk/
[openocd.git] / src / helper / command.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
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. *
9 * *
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. *
14 * *
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 ***************************************************************************/
20 #ifndef COMMAND_H
21 #define COMMAND_H
22
23 #include <stdio.h>
24
25 enum command_mode
26 {
27 COMMAND_EXEC,
28 COMMAND_CONFIG,
29 COMMAND_ANY,
30 };
31
32 typedef struct command_context_s
33 {
34 enum command_mode mode;
35 struct command_s *commands;
36 int current_target;
37 int echo;
38 int (*output_handler)(struct command_context_s *context, char* line);
39 void *output_handler_priv;
40 } command_context_t;
41
42 typedef struct command_s
43 {
44 char *name;
45 struct command_s *parent;
46 struct command_s *children;
47 int (*handler)(struct command_context_s *context, char* name, char** args, int argc);
48 enum command_mode mode;
49 char *help;
50 int unique_len;
51 struct command_s *next;
52 } command_t;
53
54 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);
55 extern int unregister_command(command_context_t *context, char *name);
56 extern void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, char* line), void *priv);
57 extern command_context_t* copy_command_context(command_context_t* context);
58 extern command_context_t* command_init();
59 extern int command_done(command_context_t *context);
60 extern void command_print(command_context_t *context, char *format, ...);
61 extern int command_run_line(command_context_t *context, char *line);
62 extern int command_run_file(command_context_t *context, FILE *file, enum command_mode mode);
63
64
65 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
66
67 #endif /* COMMAND_H */