1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2017 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "event-loop.h"
26 struct tl_interp_info;
32 /* The command line is blocked simulating synchronous execution.
33 This is used to implement the foreground execution commands
34 ('run', 'continue', etc.). We won't display the prompt and
35 accept further commands until the execution is actually over. */
38 /* The command finished; display the prompt before returning back to
42 /* We've displayed the prompt already, ready for input. */
46 /* All about a user interface instance. Each user interface has its
47 own I/O files/streams, readline state, its own top level
48 interpreter (for the main UI, this is the interpreter specified
49 with -i on the command line) and secondary interpreters (for
50 interpreter-exec ...), etc. There's always one UI associated with
51 stdin/stdout/stderr, but the user can create secondary UIs, for
52 example, to create a separate MI channel on its own stdio
57 /* Pointer to next in singly-linked list. */
60 /* Convenient handle (UI number). Unique across all UIs. */
63 /* The UI's command line buffer. This is to used to accumulate
64 input until we have a whole command line. */
65 struct buffer line_buffer;
67 /* The callback used by the event loop whenever an event is detected
68 on the UI's input file descriptor. This function incrementally
69 builds a buffer where it accumulates the line read up to the
70 point of invocation. In the special case in which the character
71 read is newline, the function invokes the INPUT_HANDLER callback
73 void (*call_readline) (gdb_client_data);
75 /* The function to invoke when a complete line of input is ready for
77 void (*input_handler) (char *);
79 /* True if this UI is using the readline library for command
80 editing; false if using GDB's own simple readline emulation, with
81 no editing support. */
84 /* Each UI has its own independent set of interpreters. */
85 struct ui_interp_info *interp_info;
87 /* True if the UI is in async mode, false if in sync mode. If in
88 sync mode, a synchronous execution command (e.g, "next") does not
89 return until the command is finished. If in async mode, then
90 running a synchronous command returns right after resuming the
91 target. Waiting for the command's completion is later done on
92 the top event loop. For the main UI, this starts out disabled,
93 until all the explicit command line arguments (e.g., `gdb -ex
94 "start" -ex "next"') are processed. */
97 /* The number of nested readline secondary prompts that are
99 int secondary_prompt_depth;
101 /* The UI's stdin. Set to stdin for the main UI. */
104 /* stdio stream that command input is being read from. Set to stdin
105 normally. Set by source_command to the file we are sourcing.
106 Set to NULL if we are executing a user-defined command or
107 interacting via a GUI. */
109 /* Standard output stream. */
111 /* Standard error stream. */
114 /* The file descriptor for the input stream, so that we can register
115 it with the event loop. */
118 /* Whether ISATTY returns true on input_fd. Cached here because
119 quit_force needs to know this _after_ input_fd might be
121 int input_interactive_p;
123 /* See enum prompt_state's description. */
124 enum prompt_state prompt_state;
126 /* The fields below that start with "m_" are "private". They're
127 meant to be accessed through wrapper macros that make them look
130 /* The ui_file streams. */
132 struct ui_file *m_gdb_stdout;
134 struct ui_file *m_gdb_stdin;
135 /* Serious error notifications */
136 struct ui_file *m_gdb_stderr;
137 /* Log/debug/trace messages that should bypass normal stdout/stderr
138 filtering. For moment, always call this stream using
139 *_unfiltered. In the very near future that restriction shall be
140 removed - either call shall be unfiltered. (cagney 1999-06-13). */
141 struct ui_file *m_gdb_stdlog;
143 /* The current ui_out. */
144 struct ui_out *m_current_uiout;
147 /* The main UI. This is the UI that is bound to stdin/stdout/stderr.
148 It always exists and is created automatically when GDB starts
150 extern struct ui *main_ui;
152 /* The current UI. */
153 extern struct ui *current_ui;
155 /* The list of all UIs. */
156 extern struct ui *ui_list;
158 /* State for SWITCH_THRU_ALL_UIS. */
159 class switch_thru_all_uis
163 switch_thru_all_uis () : m_iter (ui_list), m_save_ui (¤t_ui)
165 current_ui = ui_list;
168 /* If done iterating, return true; otherwise return false. */
171 return m_iter == NULL;
174 /* Move to the next UI, setting current_ui if iteration is not yet
178 m_iter = m_iter->next;
185 /* No need for these. They are intentionally not defined
187 switch_thru_all_uis &operator= (const switch_thru_all_uis &);
188 switch_thru_all_uis (const switch_thru_all_uis &);
190 /* Used to iterate through the UIs. */
193 /* Save and restore current_ui. */
194 scoped_restore_tmpl<struct ui *> m_save_ui;
197 /* Traverse through all UI, and switch the current UI to the one
199 #define SWITCH_THRU_ALL_UIS() \
200 for (switch_thru_all_uis stau_state; !stau_state.done (); stau_state.next ())
202 /* Traverse over all UIs. */
203 #define ALL_UIS(UI) \
204 for (UI = ui_list; UI; UI = UI->next) \
206 /* Create a new UI. */
207 extern struct ui *new_ui (FILE *instream, FILE *outstream, FILE *errstream);
208 extern void delete_ui (struct ui *todel);
210 /* Cleanup that deletes a UI. */
211 extern struct cleanup *make_delete_ui_cleanup (struct ui *ui);
213 /* Register the UI's input file descriptor in the event loop. */
214 extern void ui_register_input_event_handler (struct ui *ui);
216 /* Unregister the UI's input file descriptor from the event loop. */
217 extern void ui_unregister_input_event_handler (struct ui *ui);
220 extern char *saved_command_line;
222 extern char gdb_dirbuf[1024];
223 extern int inhibit_gdbinit;
224 extern const char gdbinit[];
226 extern void print_gdb_version (struct ui_file *);
227 extern void print_gdb_configuration (struct ui_file *);
229 extern void read_command_file (FILE *);
230 extern void init_history (void);
231 extern void command_loop (void);
232 extern int quit_confirm (void);
233 extern void quit_force (int *, int);
234 extern void quit_command (char *, int);
235 extern void quit_cover (void);
236 extern void execute_command (char *, int);
238 /* If the interpreter is in sync mode (we're running a user command's
239 list, running command hooks or similars), and we just ran a
240 synchronous command that started the target, wait for that command
241 to end. WAS_SYNC indicates whether sync_execution was set before
242 the command was run. */
244 extern void maybe_wait_sync_command_done (int was_sync);
246 /* Wait for a synchronous execution command to end. */
247 extern void wait_sync_command_done (void);
249 extern void check_frame_language_change (void);
251 /* Prepare for execution of a command.
252 Call this before every command, CLI or MI.
253 Returns a cleanup to be run after the command is completed. */
254 extern struct cleanup *prepare_execute_command (void);
256 /* This function returns a pointer to the string that is used
257 by gdb for its command prompt. */
258 extern char *get_prompt (void);
260 /* This function returns a pointer to the string that is used
261 by gdb for its command prompt. */
262 extern void set_prompt (const char *s);
264 /* Return 1 if UI's current input handler is a secondary prompt, 0
267 extern int gdb_in_secondary_prompt_p (struct ui *ui);
269 /* From random places. */
270 extern int readnow_symbol_files;
272 /* Perform _initialize initialization. */
273 extern void gdb_init (char *);
275 /* For use by event-top.c. */
276 /* Variables from top.c. */
277 extern int source_line_number;
278 extern const char *source_file_name;
279 extern int history_expansion_p;
280 extern int server_command;
281 extern char *lim_at_start;
283 extern void gdb_add_history (const char *);
285 extern void show_commands (char *args, int from_tty);
287 extern void set_history (char *, int);
289 extern void show_history (char *, int);
291 extern void set_verbose (char *, int, struct cmd_list_element *);
293 extern void do_restore_instream_cleanup (void *stream);
295 extern char *handle_line_of_input (struct buffer *cmd_line_buffer,
296 char *rl, int repeat,
297 const char *annotation_suffix);