1 /* Manages interpreters for GDB, the GNU debugger.
3 Copyright (C) 2000, 2002, 2003, 2007, 2008, 2009, 2010, 2011
4 Free Software Foundation, Inc.
6 Written by Jim Ingham <jingham@apple.com> of Apple Computer, Inc.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
26 #include "exceptions.h"
31 extern int interp_resume (struct interp
*interp
);
32 extern int interp_suspend (struct interp
*interp
);
33 extern int interp_prompt_p (struct interp
*interp
);
34 extern int interp_exec_p (struct interp
*interp
);
35 extern struct gdb_exception
interp_exec (struct interp
*interp
,
37 extern int interp_quiet_p (struct interp
*interp
);
39 typedef void *(interp_init_ftype
) (struct interp
*self
, int top_level
);
40 typedef int (interp_resume_ftype
) (void *data
);
41 typedef int (interp_suspend_ftype
) (void *data
);
42 typedef int (interp_prompt_p_ftype
) (void *data
);
43 typedef struct gdb_exception (interp_exec_ftype
) (void *data
,
45 typedef void (interp_command_loop_ftype
) (void *data
);
46 typedef struct ui_out
*(interp_ui_out_ftype
) (struct interp
*self
);
50 interp_init_ftype
*init_proc
;
51 interp_resume_ftype
*resume_proc
;
52 interp_suspend_ftype
*suspend_proc
;
53 interp_exec_ftype
*exec_proc
;
54 interp_prompt_p_ftype
*prompt_proc_p
;
56 /* Returns the ui_out currently used to collect results for this
57 interpreter. It can be a formatter for stdout, as is the case
58 for the console & mi outputs, or it might be a result
60 interp_ui_out_ftype
*ui_out_proc
;
62 interp_command_loop_ftype
*command_loop_proc
;
65 extern struct interp
*interp_new (const char *name
, const struct interp_procs
*procs
);
66 extern void interp_add (struct interp
*interp
);
67 extern int interp_set (struct interp
*interp
, int top_level
);
68 extern struct interp
*interp_lookup (const char *name
);
69 extern struct ui_out
*interp_ui_out (struct interp
*interp
);
70 extern void *interp_data (struct interp
*interp
);
71 extern const char *interp_name (struct interp
*interp
);
73 extern int current_interp_named_p (const char *name
);
74 extern int current_interp_display_prompt_p (void);
75 extern void current_interp_command_loop (void);
76 /* Returns opaque data associated with the top-level interpreter. */
77 extern void *top_level_interpreter_data (void);
78 extern struct interp
*top_level_interpreter (void);
80 /* True if the current interpreter is in async mode, false if in sync
81 mode. If in sync mode, running a synchronous execution command
82 (with execute_command, e.g, "next") will not return until the
83 command is finished. If in async mode, then running a synchronous
84 command returns right after resuming the target. Waiting for the
85 command's completion is later done on the top event loop (using
87 extern int interpreter_async
;
89 extern void clear_interpreter_hooks (void);
91 /* well-known interpreters */
92 #define INTERP_CONSOLE "console"
93 #define INTERP_MI1 "mi1"
94 #define INTERP_MI2 "mi2"
95 #define INTERP_MI3 "mi3"
96 #define INTERP_MI "mi"
97 #define INTERP_TUI "tui"
98 #define INTERP_INSIGHT "insight"