Fix "set integer-command unlimited junk"
[deliverable/binutils-gdb.git] / gdb / interps.h
1 /* Manages interpreters for GDB, the GNU debugger.
2
3 Copyright (C) 2000-2019 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,
65 bool debug_redirect) = 0;
66
67 /* Called before starting an event loop, to give the interpreter a
68 chance to e.g., print a prompt. */
69 virtual void pre_command_loop ()
70 {}
71
72 /* Returns true if this interpreter supports using the readline
73 library; false if it uses GDB's own simplified readline
74 emulation. */
75 virtual bool supports_command_editing ()
76 { return false; }
77
78 const char *name () const
79 {
80 return m_name;
81 }
82
83 /* This is the name in "-i=" and "set interpreter". */
84 private:
85 char *m_name;
86
87 /* Interpreters are stored in a linked list, this is the next
88 one... */
89 public:
90 struct interp *next;
91
92 /* Has the init method been run? */
93 bool inited;
94 };
95
96 extern void interp_add (struct ui *ui, struct interp *interp);
97
98 /* Look up the interpreter for NAME, creating one if none exists yet.
99 If NAME is not a interpreter type previously registered with
100 interp_factory_register, return NULL; otherwise return a pointer to
101 the interpreter. */
102 extern struct interp *interp_lookup (struct ui *ui, const char *name);
103
104 /* Set the current UI's top level interpreter to the interpreter named
105 NAME. Throws an error if NAME is not a known interpreter or the
106 interpreter fails to initialize. */
107 extern void set_top_level_interpreter (const char *name);
108
109 /* Temporarily set the current interpreter, and reset it on
110 destruction. */
111 class scoped_restore_interp
112 {
113 public:
114
115 scoped_restore_interp (const char *name)
116 : m_interp (set_interp (name))
117 {
118 }
119
120 ~scoped_restore_interp ()
121 {
122 set_interp (m_interp->name ());
123 }
124
125 scoped_restore_interp (const scoped_restore_interp &) = delete;
126 scoped_restore_interp &operator= (const scoped_restore_interp &) = delete;
127
128 private:
129
130 struct interp *set_interp (const char *name);
131
132 struct interp *m_interp;
133 };
134
135 extern int current_interp_named_p (const char *name);
136
137 /* Call this function to give the current interpreter an opportunity
138 to do any special handling of streams when logging is enabled or
139 disabled. LOGFILE is the stream for the log file when logging is
140 starting and is NULL when logging is ending. LOGGING_REDIRECT is
141 the value of the "set logging redirect" setting. If true, the
142 interpreter should configure the output streams to send output only
143 to the logfile. If false, the interpreter should configure the
144 output streams to send output to both the current output stream
145 (i.e., the terminal) and the log file. DEBUG_REDIRECT is same as
146 LOGGING_REDIRECT, but for the value of "set logging debugredirect"
147 instead. */
148 extern void current_interp_set_logging (ui_file_up logfile,
149 bool logging_redirect,
150 bool debug_redirect);
151
152 /* Returns the top-level interpreter. */
153 extern struct interp *top_level_interpreter (void);
154
155 /* Return the current UI's current interpreter. */
156 extern struct interp *current_interpreter (void);
157
158 extern struct interp *command_interp (void);
159
160 extern void clear_interpreter_hooks (void);
161
162 /* Returns true if INTERP supports using the readline library; false
163 if it uses GDB's own simplified form of readline. */
164 extern int interp_supports_command_editing (struct interp *interp);
165
166 /* Called before starting an event loop, to give the interpreter a
167 chance to e.g., print a prompt. */
168 extern void interp_pre_command_loop (struct interp *interp);
169
170 /* List the possible interpreters which could complete the given
171 text. */
172 extern void interpreter_completer (struct cmd_list_element *ignore,
173 completion_tracker &tracker,
174 const char *text,
175 const char *word);
176
177 /* well-known interpreters */
178 #define INTERP_CONSOLE "console"
179 #define INTERP_MI1 "mi1"
180 #define INTERP_MI2 "mi2"
181 #define INTERP_MI3 "mi3"
182 #define INTERP_MI "mi"
183 #define INTERP_TUI "tui"
184 #define INTERP_INSIGHT "insight"
185
186 #endif
This page took 0.037212 seconds and 4 git commands to generate.