1 /* Manages interpreters for GDB, the GNU debugger.
3 Copyright (C) 2000-2016 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/>. */
29 typedef struct interp
*(*interp_factory_func
) (const char *name
);
31 /* Each interpreter kind (CLI, MI, etc.) registers itself with a call
32 to this function, passing along its name, and a pointer to a
33 function that creates a new instance of an interpreter with that
35 extern void interp_factory_register (const char *name
,
36 interp_factory_func func
);
38 extern int interp_resume (struct interp
*interp
);
39 extern int interp_suspend (struct interp
*interp
);
40 extern struct gdb_exception
interp_exec (struct interp
*interp
,
42 extern int interp_quiet_p (struct interp
*interp
);
44 typedef void *(interp_init_ftype
) (struct interp
*self
, int top_level
);
45 typedef int (interp_resume_ftype
) (void *data
);
46 typedef int (interp_suspend_ftype
) (void *data
);
47 typedef struct gdb_exception (interp_exec_ftype
) (void *data
,
49 typedef void (interp_command_loop_ftype
) (void *data
);
50 typedef struct ui_out
*(interp_ui_out_ftype
) (struct interp
*self
);
52 typedef int (interp_set_logging_ftype
) (struct interp
*self
, int start_log
,
54 struct ui_file
*logfile
);
58 interp_init_ftype
*init_proc
;
59 interp_resume_ftype
*resume_proc
;
60 interp_suspend_ftype
*suspend_proc
;
61 interp_exec_ftype
*exec_proc
;
63 /* Returns the ui_out currently used to collect results for this
64 interpreter. It can be a formatter for stdout, as is the case
65 for the console & mi outputs, or it might be a result
67 interp_ui_out_ftype
*ui_out_proc
;
69 /* Provides a hook for interpreters to do any additional
70 setup/cleanup that they might need when logging is enabled or
72 interp_set_logging_ftype
*set_logging_proc
;
74 interp_command_loop_ftype
*command_loop_proc
;
77 extern struct interp
*interp_new (const char *name
,
78 const struct interp_procs
*procs
,
80 extern void interp_add (struct ui
*ui
, struct interp
*interp
);
81 extern int interp_set (struct interp
*interp
, int top_level
);
83 /* Look up the interpreter for NAME, creating one if none exists yet.
84 If NAME is not a interpreter type previously registered with
85 interp_factory_register, return NULL; otherwise return a pointer to
87 extern struct interp
*interp_lookup (struct ui
*ui
, const char *name
);
89 extern struct ui_out
*interp_ui_out (struct interp
*interp
);
90 extern void *interp_data (struct interp
*interp
);
91 extern const char *interp_name (struct interp
*interp
);
92 extern struct interp
*interp_set_temp (const char *name
);
94 extern int current_interp_named_p (const char *name
);
96 extern void current_interp_command_loop (void);
98 /* Call this function to give the current interpreter an opportunity
99 to do any special handling of streams when logging is enabled or
100 disabled. START_LOG is 1 when logging is starting, 0 when it ends,
101 and OUT is the stream for the log file; it will be NULL when
102 logging is ending. LOGFILE is non-NULL if the output streams
103 are to be tees, with the log file as one of the outputs. */
105 extern int current_interp_set_logging (int start_log
, struct ui_file
*out
,
106 struct ui_file
*logfile
);
108 /* Returns opaque data associated with the top-level interpreter. */
109 extern void *top_level_interpreter_data (void);
110 extern struct interp
*top_level_interpreter (void);
112 extern struct interp
*command_interp (void);
114 extern void clear_interpreter_hooks (void);
116 /* well-known interpreters */
117 #define INTERP_CONSOLE "console"
118 #define INTERP_MI1 "mi1"
119 #define INTERP_MI2 "mi2"
120 #define INTERP_MI3 "mi3"
121 #define INTERP_MI "mi"
122 #define INTERP_TUI "tui"
123 #define INTERP_INSIGHT "insight"