Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Top level stuff for GDB, the GNU debugger. |
637537d0 | 2 | |
618f726f | 3 | Copyright (C) 1986-2016 Free Software Foundation, Inc. |
c906108c | 4 | |
c5aa993b | 5 | This file is part of GDB. |
c906108c | 6 | |
c5aa993b JM |
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 | |
a9762ec7 | 9 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 10 | (at your option) any later version. |
c906108c | 11 | |
c5aa993b JM |
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. | |
c906108c | 16 | |
c5aa993b | 17 | You should have received a copy of the GNU General Public License |
a9762ec7 | 18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c | 19 | |
17732724 AC |
20 | #ifndef TOP_H |
21 | #define TOP_H | |
22 | ||
a74e1786 PA |
23 | #include "buffer.h" |
24 | #include "event-loop.h" | |
25 | ||
cb814510 PA |
26 | struct tl_interp_info; |
27 | ||
a74e1786 PA |
28 | /* All about a user interface instance. Each user interface has its |
29 | own I/O files/streams, readline state, its own top level | |
30 | interpreter (for the main UI, this is the interpreter specified | |
31 | with -i on the command line) and secondary interpreters (for | |
32 | interpreter-exec ...), etc. There's always one UI associated with | |
33 | stdin/stdout/stderr, but the user can create secondary UIs, for | |
34 | example, to create a separate MI channel on its own stdio | |
35 | streams. */ | |
36 | ||
37 | struct ui | |
38 | { | |
73ab01a0 PA |
39 | /* Pointer to next in singly-linked list. */ |
40 | struct ui *next; | |
41 | ||
a74e1786 PA |
42 | /* The UI's command line buffer. This is to used to accumulate |
43 | input until we have a whole command line. */ | |
44 | struct buffer line_buffer; | |
45 | ||
46 | /* The callback used by the event loop whenever an event is detected | |
47 | on the UI's input file descriptor. This function incrementally | |
48 | builds a buffer where it accumulates the line read up to the | |
49 | point of invocation. In the special case in which the character | |
50 | read is newline, the function invokes the INPUT_HANDLER callback | |
51 | (see below). */ | |
52 | void (*call_readline) (gdb_client_data); | |
53 | ||
54 | /* The function to invoke when a complete line of input is ready for | |
55 | processing. */ | |
56 | void (*input_handler) (char *); | |
79aa2fe8 | 57 | |
cb814510 PA |
58 | /* Each UI has its own independent set of interpreters. */ |
59 | struct ui_interp_info *interp_info; | |
60 | ||
61 | /* True if the UI is in async mode, false if in sync mode. If in | |
62 | sync mode, a synchronous execution command (e.g, "next") does not | |
63 | return until the command is finished. If in async mode, then | |
64 | running a synchronous command returns right after resuming the | |
65 | target. Waiting for the command's completion is later done on | |
66 | the top event loop. For the main UI, this starts out disabled, | |
67 | until all the explicit command line arguments (e.g., `gdb -ex | |
68 | "start" -ex "next"') are processed. */ | |
69 | int async; | |
70 | ||
f38d3ad1 PA |
71 | /* stdio stream that command input is being read from. Set to stdin |
72 | normally. Set by source_command to the file we are sourcing. | |
73 | Set to NULL if we are executing a user-defined command or | |
74 | interacting via a GUI. */ | |
75 | FILE *instream; | |
76 | ||
41fd2b0f PA |
77 | /* The file descriptor for the input stream, so that we can register |
78 | it with the event loop. */ | |
79 | int input_fd; | |
80 | ||
79aa2fe8 PA |
81 | /* The fields below that start with "m_" are "private". They're |
82 | meant to be accessed through wrapper macros that make them look | |
83 | like globals. */ | |
84 | ||
85 | /* The ui_file streams. */ | |
86 | /* Normal results */ | |
87 | struct ui_file *m_gdb_stdout; | |
88 | /* Input stream */ | |
89 | struct ui_file *m_gdb_stdin; | |
90 | /* Serious error notifications */ | |
91 | struct ui_file *m_gdb_stderr; | |
92 | /* Log/debug/trace messages that should bypass normal stdout/stderr | |
93 | filtering. For moment, always call this stream using | |
94 | *_unfiltered. In the very near future that restriction shall be | |
95 | removed - either call shall be unfiltered. (cagney 1999-06-13). */ | |
96 | struct ui_file *m_gdb_stdlog; | |
a74e1786 PA |
97 | }; |
98 | ||
7c36c34e PA |
99 | /* The main UI. This is the UI that is bound to stdin/stdout/stderr. |
100 | It always exists and is created automatically when GDB starts | |
101 | up. */ | |
102 | extern struct ui *main_ui; | |
103 | ||
73ab01a0 | 104 | /* The current UI. */ |
a74e1786 | 105 | extern struct ui *current_ui; |
b69d38af | 106 | |
73ab01a0 PA |
107 | /* The list of all UIs. */ |
108 | extern struct ui *ui_list; | |
109 | ||
110 | /* State for SWITCH_THRU_ALL_UIS. Declared here because it is meant | |
111 | to be created on the stack, but should be treated as opaque. */ | |
112 | struct switch_thru_all_uis | |
113 | { | |
114 | struct ui *iter; | |
115 | struct cleanup *old_chain; | |
116 | }; | |
117 | ||
118 | /* Functions to drive SWITCH_THRU_ALL_UIS. Though declared here by | |
119 | necessity, these functions should not be used other than via the | |
120 | SWITCH_THRU_ALL_UIS macro defined below. */ | |
121 | extern void switch_thru_all_uis_init (struct switch_thru_all_uis *state); | |
122 | extern int switch_thru_all_uis_cond (struct switch_thru_all_uis *state); | |
123 | extern void switch_thru_all_uis_next (struct switch_thru_all_uis *state); | |
124 | ||
125 | /* Traverse through all UI, and switch the current UI to the one | |
126 | being iterated. */ | |
127 | #define SWITCH_THRU_ALL_UIS(STATE) \ | |
128 | for (switch_thru_all_uis_init (&STATE); \ | |
129 | switch_thru_all_uis_cond (&STATE); \ | |
130 | switch_thru_all_uis_next (&STATE)) | |
131 | ||
c906108c | 132 | /* From top.c. */ |
dc7eb48e | 133 | extern char *saved_command_line; |
698ba934 | 134 | extern int in_user_command; |
e360902b | 135 | extern int confirm; |
c906108c SS |
136 | extern char gdb_dirbuf[1024]; |
137 | extern int inhibit_gdbinit; | |
e655c1a2 | 138 | extern const char gdbinit[]; |
c906108c | 139 | |
d9fcf2fb | 140 | extern void print_gdb_version (struct ui_file *); |
6eaaf48b | 141 | extern void print_gdb_configuration (struct ui_file *); |
c906108c | 142 | |
a14ed312 KB |
143 | extern void read_command_file (FILE *); |
144 | extern void init_history (void); | |
145 | extern void command_loop (void); | |
a14ed312 KB |
146 | extern int quit_confirm (void); |
147 | extern void quit_force (char *, int); | |
148 | extern void quit_command (char *, int); | |
b2cd6b29 | 149 | extern void quit_cover (void); |
a14ed312 | 150 | extern void execute_command (char *, int); |
c906108c | 151 | |
98880d46 PA |
152 | /* If the interpreter is in sync mode (we're running a user command's |
153 | list, running command hooks or similars), and we just ran a | |
154 | synchronous command that started the target, wait for that command | |
155 | to end. WAS_SYNC indicates whether sync_execution was set before | |
156 | the command was run. */ | |
157 | ||
158 | extern void maybe_wait_sync_command_done (int was_sync); | |
159 | ||
0b333c5e PA |
160 | /* Wait for a synchronous execution command to end. */ |
161 | extern void wait_sync_command_done (void); | |
162 | ||
77cce10f PA |
163 | extern void check_frame_language_change (void); |
164 | ||
4e5d721f | 165 | /* Prepare for execution of a command. |
028d0ed5 TJB |
166 | Call this before every command, CLI or MI. |
167 | Returns a cleanup to be run after the command is completed. */ | |
168 | extern struct cleanup *prepare_execute_command (void); | |
4e5d721f | 169 | |
c906108c | 170 | /* This function returns a pointer to the string that is used |
371d5dec | 171 | by gdb for its command prompt. */ |
ab821bc6 | 172 | extern char *get_prompt (void); |
95298e72 PM |
173 | |
174 | /* This function returns a pointer to the string that is used | |
ab821bc6 PA |
175 | by gdb for its command prompt. */ |
176 | extern void set_prompt (const char *s); | |
c906108c | 177 | |
948578a9 PP |
178 | /* Return 1 if the current input handler is a secondary prompt, 0 otherwise. */ |
179 | ||
180 | extern int gdb_in_secondary_prompt_p (void); | |
181 | ||
c906108c | 182 | /* From random places. */ |
c906108c | 183 | extern int readnow_symbol_files; |
392a587b | 184 | |
371d5dec | 185 | /* Perform _initialize initialization. */ |
a14ed312 | 186 | extern void gdb_init (char *); |
0f71a2f6 | 187 | |
371d5dec MS |
188 | /* For use by event-top.c. */ |
189 | /* Variables from top.c. */ | |
0f71a2f6 | 190 | extern int source_line_number; |
05159abe | 191 | extern const char *source_file_name; |
0f71a2f6 JM |
192 | extern int history_expansion_p; |
193 | extern int server_command; | |
6dd77b81 | 194 | extern char *lim_at_start; |
17732724 | 195 | |
08b13bdd PP |
196 | extern void gdb_add_history (const char *); |
197 | ||
b9362cc7 AC |
198 | extern void show_commands (char *args, int from_tty); |
199 | ||
200 | extern void set_history (char *, int); | |
201 | ||
202 | extern void show_history (char *, int); | |
203 | ||
204 | extern void set_verbose (char *, int, struct cmd_list_element *); | |
205 | ||
206 | extern void do_restore_instream_cleanup (void *stream); | |
207 | ||
b69d38af PA |
208 | extern char *handle_line_of_input (struct buffer *cmd_line_buffer, |
209 | char *rl, int repeat, | |
210 | char *annotation_suffix); | |
211 | ||
17732724 | 212 | #endif |