Commit | Line | Data |
---|---|---|
4a8f6654 AC |
1 | /* Manages interpreters for GDB, the GNU debugger. |
2 | ||
61baf725 | 3 | Copyright (C) 2000-2017 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 AC |
37 | |
38 | extern int interp_resume (struct interp *interp); | |
39 | extern int interp_suspend (struct interp *interp); | |
71fff37b AC |
40 | extern struct gdb_exception interp_exec (struct interp *interp, |
41 | const char *command); | |
4a8f6654 AC |
42 | extern int interp_quiet_p (struct interp *interp); |
43 | ||
d6f9b0fb PA |
44 | class interp |
45 | { | |
46 | public: | |
47 | explicit interp (const char *name); | |
48 | virtual ~interp () = 0; | |
4a8f6654 | 49 | |
d6f9b0fb PA |
50 | virtual void init (bool top_level) |
51 | {} | |
37ce89eb | 52 | |
d6f9b0fb PA |
53 | virtual void resume () = 0; |
54 | virtual void suspend () = 0; | |
3c216924 | 55 | |
d6f9b0fb | 56 | virtual gdb_exception exec (const char *command) = 0; |
4801a9a3 PA |
57 | |
58 | /* Returns the ui_out currently used to collect results for this | |
59 | interpreter. It can be a formatter for stdout, as is the case | |
60 | for the console & mi outputs, or it might be a result | |
61 | formatter. */ | |
d6f9b0fb | 62 | virtual ui_out *interp_ui_out () = 0; |
4801a9a3 | 63 | |
37ce89eb SS |
64 | /* Provides a hook for interpreters to do any additional |
65 | setup/cleanup that they might need when logging is enabled or | |
66 | disabled. */ | |
d6f9b0fb | 67 | virtual void set_logging (ui_file_up logfile, bool logging_redirect) = 0; |
37ce89eb | 68 | |
b2d86570 PA |
69 | /* Called before starting an event loop, to give the interpreter a |
70 | chance to e.g., print a prompt. */ | |
d6f9b0fb PA |
71 | virtual void pre_command_loop () |
72 | {} | |
3c216924 PA |
73 | |
74 | /* Returns true if this interpreter supports using the readline | |
75 | library; false if it uses GDB's own simplified readline | |
76 | emulation. */ | |
d6f9b0fb PA |
77 | virtual bool supports_command_editing () |
78 | { return false; } | |
79 | ||
80 | /* This is the name in "-i=" and "set interpreter". */ | |
81 | const char *name; | |
82 | ||
83 | /* Interpreters are stored in a linked list, this is the next | |
84 | one... */ | |
85 | struct interp *next; | |
86 | ||
87 | /* Has the init method been run? */ | |
88 | bool inited; | |
89 | ||
90 | bool quiet_p; | |
4a8f6654 AC |
91 | }; |
92 | ||
8322445e | 93 | extern void interp_add (struct ui *ui, struct interp *interp); |
d6f9b0fb | 94 | extern void interp_set (struct interp *interp, bool top_level); |
8322445e PA |
95 | |
96 | /* Look up the interpreter for NAME, creating one if none exists yet. | |
97 | If NAME is not a interpreter type previously registered with | |
98 | interp_factory_register, return NULL; otherwise return a pointer to | |
99 | the interpreter. */ | |
100 | extern struct interp *interp_lookup (struct ui *ui, const char *name); | |
101 | ||
60eb5395 PA |
102 | /* Set the current UI's top level interpreter to the interpreter named |
103 | NAME. Throws an error if NAME is not a known interpreter or the | |
104 | interpreter fails to initialize. */ | |
105 | extern void set_top_level_interpreter (const char *name); | |
106 | ||
4a8f6654 | 107 | extern struct ui_out *interp_ui_out (struct interp *interp); |
4801a9a3 | 108 | extern const char *interp_name (struct interp *interp); |
c41535fd | 109 | extern struct interp *interp_set_temp (const char *name); |
4a8f6654 AC |
110 | |
111 | extern int current_interp_named_p (const char *name); | |
92bcb5f9 | 112 | |
37ce89eb SS |
113 | /* Call this function to give the current interpreter an opportunity |
114 | to do any special handling of streams when logging is enabled or | |
616268b6 PA |
115 | disabled. LOGFILE is the stream for the log file when logging is |
116 | starting and is NULL when logging is ending. LOGGING_REDIRECT is | |
117 | the value of the "set logging redirect" setting. If true, the | |
118 | interpreter should configure the output streams to send output only | |
119 | to the logfile. If false, the interpreter should configure the | |
120 | output streams to send output to both the current output stream | |
121 | (i.e., the terminal) and the log file. */ | |
122 | extern void current_interp_set_logging (ui_file_up logfile, | |
123 | bool logging_redirect); | |
37ce89eb | 124 | |
d6f9b0fb | 125 | /* Returns the top-level interpreter. */ |
79a68887 | 126 | extern struct interp *top_level_interpreter (void); |
4a8f6654 | 127 | |
9204d692 PA |
128 | /* Return the current UI's current interpreter. */ |
129 | extern struct interp *current_interpreter (void); | |
130 | ||
17b2616c PA |
131 | extern struct interp *command_interp (void); |
132 | ||
b9362cc7 | 133 | extern void clear_interpreter_hooks (void); |
4a8f6654 | 134 | |
3c216924 PA |
135 | /* Returns true if INTERP supports using the readline library; false |
136 | if it uses GDB's own simplified form of readline. */ | |
137 | extern int interp_supports_command_editing (struct interp *interp); | |
138 | ||
b2d86570 PA |
139 | /* Called before starting an event loop, to give the interpreter a |
140 | chance to e.g., print a prompt. */ | |
141 | extern void interp_pre_command_loop (struct interp *interp); | |
142 | ||
60eb5395 PA |
143 | /* List the possible interpreters which could complete the given |
144 | text. */ | |
145 | extern VEC (char_ptr) *interpreter_completer (struct cmd_list_element *ignore, | |
146 | const char *text, | |
147 | const char *word); | |
148 | ||
4a8f6654 AC |
149 | /* well-known interpreters */ |
150 | #define INTERP_CONSOLE "console" | |
151 | #define INTERP_MI1 "mi1" | |
2fcf52f0 AC |
152 | #define INTERP_MI2 "mi2" |
153 | #define INTERP_MI3 "mi3" | |
4a8f6654 | 154 | #define INTERP_MI "mi" |
226361c4 | 155 | #define INTERP_TUI "tui" |
cc4349ed | 156 | #define INTERP_INSIGHT "insight" |
4a8f6654 AC |
157 | |
158 | #endif |