1 /* Manages interpreters for GDB, the GNU debugger.
3 Copyright (C) 2000-2019 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 struct gdb_exception
interp_exec (struct interp
*interp
,
44 explicit interp (const char *name
);
45 virtual ~interp () = 0;
47 virtual void init (bool top_level
)
50 virtual void resume () = 0;
51 virtual void suspend () = 0;
53 virtual gdb_exception
exec (const char *command
) = 0;
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 virtual ui_out
*interp_ui_out () = 0;
61 /* Provides a hook for interpreters to do any additional
62 setup/cleanup that they might need when logging is enabled or
64 virtual void set_logging (ui_file_up logfile
, bool logging_redirect
) = 0;
66 /* Called before starting an event loop, to give the interpreter a
67 chance to e.g., print a prompt. */
68 virtual void pre_command_loop ()
71 /* Returns true if this interpreter supports using the readline
72 library; false if it uses GDB's own simplified readline
74 virtual bool supports_command_editing ()
77 const char *name () const
82 /* This is the name in "-i=" and "set interpreter". */
86 /* Interpreters are stored in a linked list, this is the next
91 /* Has the init method been run? */
95 extern void interp_add (struct ui
*ui
, struct interp
*interp
);
97 /* Look up the interpreter for NAME, creating one if none exists yet.
98 If NAME is not a interpreter type previously registered with
99 interp_factory_register, return NULL; otherwise return a pointer to
101 extern struct interp
*interp_lookup (struct ui
*ui
, const char *name
);
103 /* Set the current UI's top level interpreter to the interpreter named
104 NAME. Throws an error if NAME is not a known interpreter or the
105 interpreter fails to initialize. */
106 extern void set_top_level_interpreter (const char *name
);
108 /* Temporarily set the current interpreter, and reset it on
110 class scoped_restore_interp
114 scoped_restore_interp (const char *name
)
115 : m_interp (set_interp (name
))
119 ~scoped_restore_interp ()
121 set_interp (m_interp
->name ());
124 scoped_restore_interp (const scoped_restore_interp
&) = delete;
125 scoped_restore_interp
&operator= (const scoped_restore_interp
&) = delete;
129 struct interp
*set_interp (const char *name
);
131 struct interp
*m_interp
;
134 extern int current_interp_named_p (const char *name
);
136 /* Call this function to give the current interpreter an opportunity
137 to do any special handling of streams when logging is enabled or
138 disabled. LOGFILE is the stream for the log file when logging is
139 starting and is NULL when logging is ending. LOGGING_REDIRECT is
140 the value of the "set logging redirect" setting. If true, the
141 interpreter should configure the output streams to send output only
142 to the logfile. If false, the interpreter should configure the
143 output streams to send output to both the current output stream
144 (i.e., the terminal) and the log file. */
145 extern void current_interp_set_logging (ui_file_up logfile
,
146 bool logging_redirect
);
148 /* Returns the top-level interpreter. */
149 extern struct interp
*top_level_interpreter (void);
151 /* Return the current UI's current interpreter. */
152 extern struct interp
*current_interpreter (void);
154 extern struct interp
*command_interp (void);
156 extern void clear_interpreter_hooks (void);
158 /* Returns true if INTERP supports using the readline library; false
159 if it uses GDB's own simplified form of readline. */
160 extern int interp_supports_command_editing (struct interp
*interp
);
162 /* Called before starting an event loop, to give the interpreter a
163 chance to e.g., print a prompt. */
164 extern void interp_pre_command_loop (struct interp
*interp
);
166 /* List the possible interpreters which could complete the given
168 extern void interpreter_completer (struct cmd_list_element
*ignore
,
169 completion_tracker
&tracker
,
173 /* well-known interpreters */
174 #define INTERP_CONSOLE "console"
175 #define INTERP_MI1 "mi1"
176 #define INTERP_MI2 "mi2"
177 #define INTERP_MI3 "mi3"
178 #define INTERP_MI "mi"
179 #define INTERP_TUI "tui"
180 #define INTERP_INSIGHT "insight"
This page took 0.032195 seconds and 4 git commands to generate.