1 /* Manages interpreters for GDB, the GNU debugger.
3 Copyright (C) 2000-2014 Free Software Foundation, Inc.
5 Written by Jim Ingham <jingham@apple.com> of Apple Computer, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
25 #include "exceptions.h"
30 extern int interp_resume (struct interp
*interp
);
31 extern int interp_suspend (struct interp
*interp
);
32 extern struct gdb_exception
interp_exec (struct interp
*interp
,
34 extern int interp_quiet_p (struct interp
*interp
);
36 typedef void *(interp_init_ftype
) (struct interp
*self
, int top_level
);
37 typedef int (interp_resume_ftype
) (void *data
);
38 typedef int (interp_suspend_ftype
) (void *data
);
39 typedef struct gdb_exception (interp_exec_ftype
) (void *data
,
41 typedef void (interp_command_loop_ftype
) (void *data
);
42 typedef struct ui_out
*(interp_ui_out_ftype
) (struct interp
*self
);
44 typedef int (interp_set_logging_ftype
) (struct interp
*self
, int start_log
,
46 struct ui_file
*logfile
);
50 interp_init_ftype
*init_proc
;
51 interp_resume_ftype
*resume_proc
;
52 interp_suspend_ftype
*suspend_proc
;
53 interp_exec_ftype
*exec_proc
;
55 /* Returns the ui_out currently used to collect results for this
56 interpreter. It can be a formatter for stdout, as is the case
57 for the console & mi outputs, or it might be a result
59 interp_ui_out_ftype
*ui_out_proc
;
61 /* Provides a hook for interpreters to do any additional
62 setup/cleanup that they might need when logging is enabled or
64 interp_set_logging_ftype
*set_logging_proc
;
66 interp_command_loop_ftype
*command_loop_proc
;
69 extern struct interp
*interp_new (const char *name
, const struct interp_procs
*procs
);
70 extern void interp_add (struct interp
*interp
);
71 extern int interp_set (struct interp
*interp
, int top_level
);
72 extern struct interp
*interp_lookup (const char *name
);
73 extern struct ui_out
*interp_ui_out (struct interp
*interp
);
74 extern void *interp_data (struct interp
*interp
);
75 extern const char *interp_name (struct interp
*interp
);
76 extern struct interp
*interp_set_temp (const char *name
);
78 extern int current_interp_named_p (const char *name
);
80 extern void current_interp_command_loop (void);
82 /* Call this function to give the current interpreter an opportunity
83 to do any special handling of streams when logging is enabled or
84 disabled. START_LOG is 1 when logging is starting, 0 when it ends,
85 and OUT is the stream for the log file; it will be NULL when
86 logging is ending. LOGFILE is non-NULL if the output streams
87 are to be tees, with the log file as one of the outputs. */
89 extern int current_interp_set_logging (int start_log
, struct ui_file
*out
,
90 struct ui_file
*logfile
);
92 /* Returns opaque data associated with the top-level interpreter. */
93 extern void *top_level_interpreter_data (void);
94 extern struct interp
*top_level_interpreter (void);
96 extern struct interp
*command_interp (void);
98 /* True if the current interpreter is in async mode, false if in sync
99 mode. If in sync mode, running a synchronous execution command
100 (with execute_command, e.g, "next") will not return until the
101 command is finished. If in async mode, then running a synchronous
102 command returns right after resuming the target. Waiting for the
103 command's completion is later done on the top event loop (using
105 extern int interpreter_async
;
107 extern void clear_interpreter_hooks (void);
109 /* well-known interpreters */
110 #define INTERP_CONSOLE "console"
111 #define INTERP_MI1 "mi1"
112 #define INTERP_MI2 "mi2"
113 #define INTERP_MI3 "mi3"
114 #define INTERP_MI "mi"
115 #define INTERP_TUI "tui"
116 #define INTERP_INSIGHT "insight"