1 /* TUI Interpreter definitions for GDB, the GNU debugger.
3 Copyright (C) 2003, 2007, 2008, 2009, 2010 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/>. */
23 #include "event-top.h"
24 #include "event-loop.h"
27 #include "tui/tui-data.h"
28 #include "readline/readline.h"
29 #include "tui/tui-win.h"
31 #include "tui/tui-io.h"
32 #include "exceptions.h"
34 /* Set to 1 when the TUI mode must be activated when we first start
36 static int tui_start_enabled = 0;
38 /* Cleanup the tui before exiting. */
43 /* Disable the tui. Curses mode is left leaving the screen in a
44 clean state (see endwin()). */
48 /* True if TUI is the top-level interpreter. */
49 static int tui_is_toplevel = 0;
51 /* These implement the TUI interpreter. */
54 tui_init (int top_level)
56 tui_is_toplevel = top_level;
58 /* Install exit handler to leave the screen in a good shape. */
61 tui_initialize_static_data ();
64 tui_initialize_win ();
65 if (ui_file_isatty (gdb_stdout))
66 tui_initialize_readline ();
71 /* True if enabling the TUI is allowed. Example, if the top level
72 interpreter is MI, enabling curses will certainly lose. */
77 /* Only if TUI is the top level interpreter. Also don't try to
78 setup curses (and print funny control characters) if we're not
79 outputting to a terminal. */
80 return tui_is_toplevel && ui_file_isatty (gdb_stdout);
84 tui_resume (void *data)
86 struct ui_file *stream;
88 /* gdb_setup_readline will change gdb_stdout. If the TUI was
89 previously writing to gdb_stdout, then set it to the new
90 gdb_stdout afterwards. */
92 stream = cli_out_set_stream (tui_old_uiout, gdb_stdout);
93 if (stream != gdb_stdout)
95 cli_out_set_stream (tui_old_uiout, stream);
99 gdb_setup_readline ();
102 cli_out_set_stream (tui_old_uiout, gdb_stdout);
104 if (tui_start_enabled)
110 tui_suspend (void *data)
112 tui_start_enabled = tui_active;
117 /* Display the prompt if we are silent. */
120 tui_display_prompt_p (void *data)
122 if (interp_quiet_p (NULL))
128 static struct gdb_exception
129 tui_exec (void *data, const char *command_str)
131 internal_error (__FILE__, __LINE__, _("tui_exec called"));
135 /* Initialize all the necessary variables, start the event loop,
136 register readline, and stdin, start the loop. */
139 tui_command_loop (void *data)
141 /* If we are using readline, set things up and display the first
142 prompt, otherwise just print the prompt. */
143 if (async_command_editing_p)
147 char *gdb_prompt = get_prompt ();
149 /* Tell readline what the prompt to display is and what function
150 it will need to call after a whole line is read. This also
151 displays the first prompt. */
152 length = strlen (PREFIX (0))
153 + strlen (gdb_prompt) + strlen (SUFFIX (0)) + 1;
154 a_prompt = (char *) alloca (length);
155 strcpy (a_prompt, PREFIX (0));
156 strcat (a_prompt, gdb_prompt);
157 strcat (a_prompt, SUFFIX (0));
158 rl_callback_handler_install (a_prompt, input_handler);
161 display_gdb_prompt (0);
163 /* Loop until there is nothing to do. This is the entry point to the
164 event loop engine. gdb_do_one_event, called via catch_errors()
165 will process one event for each invocation. It blocks waits for
166 an event and then processes it. >0 when an event is processed, 0
167 when catch_errors() caught an error and <0 when there are no
168 longer any event sources registered. */
171 int result = catch_errors (gdb_do_one_event, 0, "", RETURN_MASK_ALL);
176 /* Update gdb output according to TUI mode. Since catch_errors
177 preserves the uiout from changing, this must be done at top
178 level of event loop. */
182 uiout = tui_old_uiout;
186 /* If any exception escaped to here, we better enable
187 stdin. Otherwise, any command that calls async_disable_stdin,
188 and then throws, will leave stdin inoperable. */
189 async_enable_stdin ();
190 /* FIXME: this should really be a call to a hook that is
191 interface specific, because interfaces can display the
192 prompt in their own way. */
193 display_gdb_prompt (0);
194 /* This call looks bizarre, but it is required. If the user
195 entered a command that caused an error,
196 after_char_processing_hook won't be called from
197 rl_callback_read_char_wrapper. Using a cleanup there
198 won't work, since we want this function to be called
199 after a new prompt is printed. */
200 if (after_char_processing_hook)
201 (*after_char_processing_hook) ();
202 /* Maybe better to set a flag to be checked somewhere as to
203 whether display the prompt or not. */
207 /* We are done with the event loop. There are no more event sources
208 to listen to. So we exit GDB. */
212 /* Provide a prototype to silence -Wmissing-prototypes. */
213 extern initialize_file_ftype _initialize_tui_interp;
216 _initialize_tui_interp (void)
218 static const struct interp_procs procs = {
223 tui_display_prompt_p,
227 /* Create a default uiout builder for the TUI. */
228 tui_out = tui_out_new (gdb_stdout);
229 interp_add (interp_new (INTERP_TUI, NULL, tui_out, &procs));
230 if (interpreter_p && strcmp (interpreter_p, INTERP_TUI) == 0)
231 tui_start_enabled = 1;
233 if (interpreter_p && strcmp (interpreter_p, INTERP_CONSOLE) == 0)
235 xfree (interpreter_p);
236 interpreter_p = xstrdup (INTERP_TUI);