GDB (xrefs)

/tmp/gdb-8.1/gdb/interps.h
Go to the documentation of this file.
1 /* Manages interpreters for GDB, the GNU debugger.
2
3 Copyright (C) 2000-2018 Free Software Foundation, Inc.
4
5 Written by Jim Ingham <jingham@apple.com> of Apple Computer, Inc.
6
7 This file is part of GDB.
8
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.
13
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.
18
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/>. */
21
22 #ifndef INTERPS_H
23 #define INTERPS_H
24
25 struct ui_out;
26 struct interp;
27 struct ui;
28
29 typedef struct interp *(*interp_factory_func) (const char *name);
30
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
34 name. */
35 extern void interp_factory_register (const char *name,
36 interp_factory_func func);
37
38 extern struct gdb_exception interp_exec (struct interp *interp,
39 const char *command);
40
41 class interp
42 {
43 public:
44 explicit interp (const char *name);
45 virtual ~interp () = 0;
46
47 virtual void init (bool top_level)
48 {}
49
50 virtual void resume () = 0;
51 virtual void suspend () = 0;
52
53 virtual gdb_exception exec (const char *command) = 0;
54
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
58 formatter. */
59 virtual ui_out *interp_ui_out () = 0;
60
61 /* Provides a hook for interpreters to do any additional
62 setup/cleanup that they might need when logging is enabled or
63 disabled. */
64 virtual void set_logging (ui_file_up logfile, bool logging_redirect) = 0;
65
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 ()
69 {}
70
71 /* Returns true if this interpreter supports using the readline
72 library; false if it uses GDB's own simplified readline
73 emulation. */
74 virtual bool supports_command_editing ()
75 { return false; }
76
77 /* This is the name in "-i=" and "set interpreter". */
78 const char *name;
79
80 /* Interpreters are stored in a linked list, this is the next
81 one... */
82 struct interp *next;
83
84 /* Has the init method been run? */
85 bool inited;
86 };
87
88 extern void interp_add (struct ui *ui, struct interp *interp);
89
90 /* Look up the interpreter for NAME, creating one if none exists yet.
91 If NAME is not a interpreter type previously registered with
92 interp_factory_register, return NULL; otherwise return a pointer to
93 the interpreter. */
94 extern struct interp *interp_lookup (struct ui *ui, const char *name);
95
96 /* Set the current UI's top level interpreter to the interpreter named
97 NAME. Throws an error if NAME is not a known interpreter or the
98 interpreter fails to initialize. */
99 extern void set_top_level_interpreter (const char *name);
100
101 extern struct ui_out *interp_ui_out (struct interp *interp);
102 extern const char *interp_name (struct interp *interp);
103
104 /* Temporarily set the current interpreter, and reset it on
105 destruction. */
106 class scoped_restore_interp
107 {
108 public:
109
110 scoped_restore_interp (const char *name)
111 : m_interp (set_interp (name))
112 {
113 }
114
115 ~scoped_restore_interp ()
116 {
117 set_interp (interp_name (m_interp));
118 }
119
120 scoped_restore_interp (const scoped_restore_interp &) = delete;
121 scoped_restore_interp &operator= (const scoped_restore_interp &) = delete;
122
123 private:
124
125 struct interp *set_interp (const char *name);
126
127 struct interp *m_interp;
128 };
129
130 extern int current_interp_named_p (const char *name);
131
132 /* Call this function to give the current interpreter an opportunity
133 to do any special handling of streams when logging is enabled or
134 disabled. LOGFILE is the stream for the log file when logging is
135 starting and is NULL when logging is ending. LOGGING_REDIRECT is
136 the value of the "set logging redirect" setting. If true, the
137 interpreter should configure the output streams to send output only
138 to the logfile. If false, the interpreter should configure the
139 output streams to send output to both the current output stream
140 (i.e., the terminal) and the log file. */
141 extern void current_interp_set_logging (ui_file_up logfile,
142 bool logging_redirect);
143
144 /* Returns the top-level interpreter. */
145 extern struct interp *top_level_interpreter (void);
146
147 /* Return the current UI's current interpreter. */
148 extern struct interp *current_interpreter (void);
149
150 extern struct interp *command_interp (void);
151
152 extern void clear_interpreter_hooks (void);
153
154 /* Returns true if INTERP supports using the readline library; false
155 if it uses GDB's own simplified form of readline. */
156 extern int interp_supports_command_editing (struct interp *interp);
157
158 /* Called before starting an event loop, to give the interpreter a
159 chance to e.g., print a prompt. */
160 extern void interp_pre_command_loop (struct interp *interp);
161
162 /* List the possible interpreters which could complete the given
163 text. */
164 extern void interpreter_completer (struct cmd_list_element *ignore,
165 completion_tracker &tracker,
166 const char *text,
167 const char *word);
168
169 /* well-known interpreters */
170 #define INTERP_CONSOLE "console"
171 #define INTERP_MI1 "mi1"
172 #define INTERP_MI2 "mi2"
173 #define INTERP_MI3 "mi3"
174 #define INTERP_MI "mi"
175 #define INTERP_TUI "tui"
176 #define INTERP_INSIGHT "insight"
177
178 #endif
current_interp_set_logging
void current_interp_set_logging(ui_file_up logfile, bool logging_redirect)
Definition: interps.c:267
interp_factory_register
void interp_factory_register(const char *name, interp_factory_func func)
Definition: interps.c:111
interp::init
virtual void init(bool top_level)
Definition: interps.h:47
ui_file_up
std::unique_ptr< ui_file > ui_file_up
Definition: ui-file.h:76
cmd_list_element
Definition: cli-decode.h:46
func
void(* func)(char *)
Definition: remote-fileio.c:1104
scoped_restore_interp::m_interp
struct interp * m_interp
Definition: interps.h:127
interp
Definition: interps.h:41
interp::resume
virtual void resume()=0
interp::interp
interp(const char *name)
Definition: interps.c:80
current_interpreter
struct interp * current_interpreter(void)
Definition: interps.c:459
current_interp_named_p
int current_interp_named_p(const char *name)
Definition: interps.c:299
scoped_restore_interp::operator=
scoped_restore_interp & operator=(const scoped_restore_interp &)=delete
interp::~interp
virtual ~interp()=0
Definition: interps.c:86
interp_exec
struct gdb_exception interp_exec(struct interp *interp, const char *command)
Definition: interps.c:353
name
const char *const name
Definition: aarch64-tdep.c:76
logging_redirect
static int logging_redirect
Definition: cli-logging.c:64
scoped_restore_interp::set_interp
struct interp * set_interp(const char *name)
Definition: interps.c:278
top_level_interpreter
struct interp * top_level_interpreter(void)
Definition: interps.c:449
interp::next
struct interp * next
Definition: interps.h:82
interp::interp_ui_out
virtual ui_out * interp_ui_out()=0
interp::set_logging
virtual void set_logging(ui_file_up logfile, bool logging_redirect)=0
clear_interpreter_hooks
void clear_interpreter_hooks(void)
Definition: interps.c:374
interp_pre_command_loop
void interp_pre_command_loop(struct interp *interp)
Definition: interps.c:334
command_interp
struct interp * command_interp(void)
Definition: interps.c:321
ui
Definition: top.h:56
interp::name
const char * name
Definition: interps.h:78
scoped_restore_interp
Definition: interps.h:106
interp::pre_command_loop
virtual void pre_command_loop()
Definition: interps.h:68
interp_lookup
struct interp * interp_lookup(struct ui *ui, const char *name)
Definition: interps.c:219
interp::exec
virtual gdb_exception exec(const char *command)=0
interpreter_completer
void interpreter_completer(struct cmd_list_element *ignore, completion_tracker &tracker, const char *text, const char *word)
Definition: interps.c:432
ui_out
Definition: ui-out.h:77
interp_supports_command_editing
int interp_supports_command_editing(struct interp *interp)
Definition: interps.c:344
interp::suspend
virtual void suspend()=0
interp_name
const char * interp_name(struct interp *interp)
Definition: interps.c:292
interp::supports_command_editing
virtual bool supports_command_editing()
Definition: interps.h:74
gdb_exception
Definition: common-exceptions.h:111
ignore
static int ignore(struct target_ops *ops, struct gdbarch *gdbarch, struct bp_target_info *bp_tgt)
Definition: corelow.c:879
scoped_restore_interp::~scoped_restore_interp
~scoped_restore_interp()
Definition: interps.h:115
completion_tracker
Definition: completer.h:310
interp_add
void interp_add(struct ui *ui, struct interp *interp)
Definition: interps.c:128
interp::inited
bool inited
Definition: interps.h:85
interp_factory_func
struct interp *(* interp_factory_func)(const char *name)
Definition: interps.h:29
interp_ui_out
struct ui_out * interp_ui_out(struct interp *interp)
Definition: interps.c:257
scoped_restore_interp::scoped_restore_interp
scoped_restore_interp(const char *name)
Definition: interps.h:110
set_top_level_interpreter
void set_top_level_interpreter(const char *name)
Definition: interps.c:243