Commit | Line | Data |
---|---|---|
4a8f6654 AC |
1 | /* Manages interpreters for GDB, the GNU debugger. |
2 | ||
e2882c85 | 3 | Copyright (C) 2000-2018 Free Software Foundation, Inc. |
4a8f6654 AC |
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 | |
a9762ec7 | 11 | the Free Software Foundation; either version 3 of the License, or |
4a8f6654 AC |
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 | |
1777feb0 | 20 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
4a8f6654 AC |
21 | |
22 | #ifndef INTERPS_H | |
23 | #define INTERPS_H | |
24 | ||
25 | struct ui_out; | |
26 | struct interp; | |
8322445e PA |
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); | |
4a8f6654 | 37 | |
71fff37b AC |
38 | extern struct gdb_exception interp_exec (struct interp *interp, |
39 | const char *command); | |
4a8f6654 | 40 | |
d6f9b0fb PA |
41 | class interp |
42 | { | |
43 | public: | |
44 | explicit interp (const char *name); | |
45 | virtual ~interp () = 0; | |
4a8f6654 | 46 | |
d6f9b0fb PA |
47 | virtual void init (bool top_level) |
48 | {} | |
37ce89eb | 49 | |
d6f9b0fb PA |
50 | virtual void resume () = 0; |
51 | virtual void suspend () = 0; | |
3c216924 | 52 | |
d6f9b0fb | 53 | virtual gdb_exception exec (const char *command) = 0; |
4801a9a3 PA |
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. */ | |
d6f9b0fb | 59 | virtual ui_out *interp_ui_out () = 0; |
4801a9a3 | 60 | |
37ce89eb SS |
61 | /* Provides a hook for interpreters to do any additional |
62 | setup/cleanup that they might need when logging is enabled or | |
63 | disabled. */ | |
d6f9b0fb | 64 | virtual void set_logging (ui_file_up logfile, bool logging_redirect) = 0; |
37ce89eb | 65 | |
b2d86570 PA |
66 | /* Called before starting an event loop, to give the interpreter a |
67 | chance to e.g., print a prompt. */ | |
d6f9b0fb PA |
68 | virtual void pre_command_loop () |
69 | {} | |
3c216924 PA |
70 | |
71 | /* Returns true if this interpreter supports using the readline | |
72 | library; false if it uses GDB's own simplified readline | |
73 | emulation. */ | |
d6f9b0fb PA |
74 | virtual bool supports_command_editing () |
75 | { return false; } | |
76 | ||
d525a99b TT |
77 | const char *name () const |
78 | { | |
79 | return m_name; | |
80 | } | |
81 | ||
d6f9b0fb | 82 | /* This is the name in "-i=" and "set interpreter". */ |
d525a99b | 83 | const char *m_name; |
d6f9b0fb PA |
84 | |
85 | /* Interpreters are stored in a linked list, this is the next | |
86 | one... */ | |
87 | struct interp *next; | |
88 | ||
89 | /* Has the init method been run? */ | |
90 | bool inited; | |
4a8f6654 AC |
91 | }; |
92 | ||
8322445e | 93 | extern void interp_add (struct ui *ui, struct interp *interp); |
8322445e PA |
94 | |
95 | /* Look up the interpreter for NAME, creating one if none exists yet. | |
96 | If NAME is not a interpreter type previously registered with | |
97 | interp_factory_register, return NULL; otherwise return a pointer to | |
98 | the interpreter. */ | |
99 | extern struct interp *interp_lookup (struct ui *ui, const char *name); | |
100 | ||
60eb5395 PA |
101 | /* Set the current UI's top level interpreter to the interpreter named |
102 | NAME. Throws an error if NAME is not a known interpreter or the | |
103 | interpreter fails to initialize. */ | |
104 | extern void set_top_level_interpreter (const char *name); | |
105 | ||
be0d7abb TT |
106 | /* Temporarily set the current interpreter, and reset it on |
107 | destruction. */ | |
108 | class scoped_restore_interp | |
109 | { | |
110 | public: | |
111 | ||
112 | scoped_restore_interp (const char *name) | |
113 | : m_interp (set_interp (name)) | |
114 | { | |
115 | } | |
116 | ||
117 | ~scoped_restore_interp () | |
118 | { | |
d525a99b | 119 | set_interp (m_interp->name ()); |
be0d7abb TT |
120 | } |
121 | ||
122 | scoped_restore_interp (const scoped_restore_interp &) = delete; | |
123 | scoped_restore_interp &operator= (const scoped_restore_interp &) = delete; | |
124 | ||
125 | private: | |
126 | ||
127 | struct interp *set_interp (const char *name); | |
128 | ||
129 | struct interp *m_interp; | |
130 | }; | |
131 | ||
4a8f6654 | 132 | extern int current_interp_named_p (const char *name); |
92bcb5f9 | 133 | |
37ce89eb SS |
134 | /* Call this function to give the current interpreter an opportunity |
135 | to do any special handling of streams when logging is enabled or | |
616268b6 PA |
136 | disabled. LOGFILE is the stream for the log file when logging is |
137 | starting and is NULL when logging is ending. LOGGING_REDIRECT is | |
138 | the value of the "set logging redirect" setting. If true, the | |
139 | interpreter should configure the output streams to send output only | |
140 | to the logfile. If false, the interpreter should configure the | |
141 | output streams to send output to both the current output stream | |
142 | (i.e., the terminal) and the log file. */ | |
143 | extern void current_interp_set_logging (ui_file_up logfile, | |
144 | bool logging_redirect); | |
37ce89eb | 145 | |
d6f9b0fb | 146 | /* Returns the top-level interpreter. */ |
79a68887 | 147 | extern struct interp *top_level_interpreter (void); |
4a8f6654 | 148 | |
9204d692 PA |
149 | /* Return the current UI's current interpreter. */ |
150 | extern struct interp *current_interpreter (void); | |
151 | ||
17b2616c PA |
152 | extern struct interp *command_interp (void); |
153 | ||
b9362cc7 | 154 | extern void clear_interpreter_hooks (void); |
4a8f6654 | 155 | |
3c216924 PA |
156 | /* Returns true if INTERP supports using the readline library; false |
157 | if it uses GDB's own simplified form of readline. */ | |
158 | extern int interp_supports_command_editing (struct interp *interp); | |
159 | ||
b2d86570 PA |
160 | /* Called before starting an event loop, to give the interpreter a |
161 | chance to e.g., print a prompt. */ | |
162 | extern void interp_pre_command_loop (struct interp *interp); | |
163 | ||
60eb5395 PA |
164 | /* List the possible interpreters which could complete the given |
165 | text. */ | |
eb3ff9a5 PA |
166 | extern void interpreter_completer (struct cmd_list_element *ignore, |
167 | completion_tracker &tracker, | |
168 | const char *text, | |
169 | const char *word); | |
60eb5395 | 170 | |
4a8f6654 AC |
171 | /* well-known interpreters */ |
172 | #define INTERP_CONSOLE "console" | |
173 | #define INTERP_MI1 "mi1" | |
2fcf52f0 AC |
174 | #define INTERP_MI2 "mi2" |
175 | #define INTERP_MI3 "mi3" | |
4a8f6654 | 176 | #define INTERP_MI "mi" |
226361c4 | 177 | #define INTERP_TUI "tui" |
cc4349ed | 178 | #define INTERP_INSIGHT "insight" |
4a8f6654 AC |
179 | |
180 | #endif |