/* GDB hooks for TUI.
- Copyright 2001, 2002 Free Software Foundation, Inc.
+ Copyright (C) 2001-2019 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA. */
-
-/* FIXME: cagney/2002-02-28: The GDB coding standard indicates that
- "defs.h" should be included first. Unfortunatly some systems
- (currently Debian GNU/Linux) include the <stdbool.h> via <curses.h>
- and they clash with "bfd.h"'s definiton of true/false. The correct
- fix is to remove true/false from "bfd.h", however, until that
- happens, hack around it by including "config.h" and <curses.h>
- first. */
-
-#include "config.h"
-#ifdef HAVE_NCURSES_H
-#include <ncurses.h>
-#else
-#ifdef HAVE_CURSES_H
-#include <curses.h>
-#endif
-#endif
+ along with this program. If not, see <http://www.gnu.org/licenses/>. */
#include "defs.h"
#include "symtab.h"
#include "event-top.h"
#include "frame.h"
#include "breakpoint.h"
-#include "gdb-events.h"
#include "ui-out.h"
#include "top.h"
-#include <readline/readline.h>
+#include "observable.h"
+#include "source.h"
#include <unistd.h>
#include <fcntl.h>
-#include "tui.h"
-#include "tuiData.h"
-#include "tuiLayout.h"
-#include "tuiIO.h"
-#include "tuiRegs.h"
-#include "tuiWin.h"
-#include "tuiStack.h"
-#include "tuiDataWin.h"
-#include "tuiSourceWin.h"
+#include "tui/tui.h"
+#include "tui/tui-hooks.h"
+#include "tui/tui-data.h"
+#include "tui/tui-layout.h"
+#include "tui/tui-io.h"
+#include "tui/tui-regs.h"
+#include "tui/tui-win.h"
+#include "tui/tui-stack.h"
+#include "tui/tui-winsource.h"
-int tui_target_has_run = 0;
+#include "gdb_curses.h"
-static void (* tui_target_new_objfile_chain) (struct objfile*);
-static void tui_event_loop (void);
-static void tui_command_loop (void);
+/* This redefines CTRL if it is not already defined, so it must come
+ after terminal state releated include files like <term.h> and
+ "gdb_curses.h". */
+#include "readline/readline.h"
static void
tui_new_objfile_hook (struct objfile* objfile)
{
if (tui_active)
tui_display_main ();
-
- if (tui_target_new_objfile_chain)
- tui_target_new_objfile_chain (objfile);
}
-static int
-tui_query_hook (const char * msg, va_list argp)
-{
- int retval;
- int ans2;
- int answer;
-
- /* Automatically answer "yes" if input is not from a terminal. */
- if (!input_from_terminal_p ())
- return 1;
-
- echo ();
- while (1)
- {
- wrap_here (""); /* Flush any buffered output */
- gdb_flush (gdb_stdout);
-
- vfprintf_filtered (gdb_stdout, msg, argp);
- printf_filtered ("(y or n) ");
-
- wrap_here ("");
- gdb_flush (gdb_stdout);
-
- answer = tui_getc (stdin);
- clearerr (stdin); /* in case of C-d */
- if (answer == EOF) /* C-d */
- {
- retval = 1;
- break;
- }
- /* Eat rest of input line, to EOF or newline */
- if (answer != '\n')
- do
- {
- ans2 = tui_getc (stdin);
- clearerr (stdin);
- }
- while (ans2 != EOF && ans2 != '\n' && ans2 != '\r');
-
- if (answer >= 'a')
- answer -= 040;
- if (answer == 'Y')
- {
- retval = 1;
- break;
- }
- if (answer == 'N')
- {
- retval = 0;
- break;
- }
- printf_filtered ("Please answer y or n.\n");
- }
- noecho ();
- return retval;
-}
-
-/* Prevent recursion of registers_changed_hook(). */
+/* Prevent recursion of deprecated_register_changed_hook(). */
static int tui_refreshing_registers = 0;
-static void
-tui_registers_changed_hook (void)
-{
- struct frame_info *fi;
-
- fi = deprecated_selected_frame;
- if (fi && tui_refreshing_registers == 0)
- {
- tui_refreshing_registers = 1;
-#if 0
- tuiCheckDataValues (fi);
-#endif
- tui_refreshing_registers = 0;
- }
-}
+/* Observer for the register_changed notification. */
static void
-tui_register_changed_hook (int regno)
+tui_register_changed (struct frame_info *frame, int regno)
{
struct frame_info *fi;
- fi = deprecated_selected_frame;
- if (fi && tui_refreshing_registers == 0)
+ if (!tui_is_window_visible (DATA_WIN))
+ return;
+
+ /* The frame of the register that was changed may differ from the selected
+ frame, but we only want to show the register values of the selected frame.
+ And even if the frames differ a register change made in one can still show
+ up in the other. So we always use the selected frame here, and ignore
+ FRAME. */
+ fi = get_selected_frame (NULL);
+ if (tui_refreshing_registers == 0)
{
tui_refreshing_registers = 1;
- tuiCheckDataValues (fi);
+ TUI_DATA_WIN->check_register_values (fi);
tui_refreshing_registers = 0;
}
}
/* Breakpoint creation hook.
Update the screen to show the new breakpoint. */
static void
-tui_event_create_breakpoint (int number)
+tui_event_create_breakpoint (struct breakpoint *b)
{
- tui_update_all_breakpoint_info ();
+ tui_update_all_breakpoint_info (nullptr);
}
/* Breakpoint deletion hook.
Refresh the screen to update the breakpoint marks. */
static void
-tui_event_delete_breakpoint (int number)
+tui_event_delete_breakpoint (struct breakpoint *b)
{
- tui_update_all_breakpoint_info ();
+ tui_update_all_breakpoint_info (b);
}
static void
-tui_event_modify_breakpoint (int number)
+tui_event_modify_breakpoint (struct breakpoint *b)
{
- tui_update_all_breakpoint_info ();
+ tui_update_all_breakpoint_info (nullptr);
}
+/* Refresh TUI's frame and register information. This is a hook intended to be
+ used to update the screen after potential frame and register changes.
+
+ REGISTERS_TOO_P controls whether to refresh our register information even
+ if frame information hasn't changed. */
+
static void
-tui_event_default (int number)
+tui_refresh_frame_and_register_information (int registers_too_p)
{
- ;
-}
+ struct frame_info *fi;
+ CORE_ADDR pc;
+ int frame_info_changed_p;
-static struct gdb_events *tui_old_event_hooks;
+ if (!has_stack_frames ())
+ return;
-static struct gdb_events tui_event_hooks =
-{
- tui_event_create_breakpoint,
- tui_event_delete_breakpoint,
- tui_event_modify_breakpoint,
- tui_event_default,
- tui_event_default,
- tui_event_default
-};
-
-/* Called when going to wait for the target.
- Leave curses mode and setup program mode. */
-static ptid_t
-tui_target_wait_hook (ptid_t pid, struct target_waitstatus *status)
-{
- ptid_t res;
+ target_terminal::scoped_restore_terminal_state term_state;
+ target_terminal::ours_for_output ();
- /* Leave tui mode (optional). */
-#if 0
- if (tui_active)
+ fi = get_selected_frame (NULL);
+ /* Ensure that symbols for this frame are read in. Also, determine
+ the source language of this frame, and switch to it if
+ desired. */
+ if (get_frame_pc_if_available (fi, &pc))
{
- target_terminal_ours ();
- endwin ();
- target_terminal_inferior ();
- }
-#endif
- tui_target_has_run = 1;
- res = target_wait (pid, status);
+ struct symtab *s;
- if (tui_active)
- {
- /* TODO: need to refresh (optional). */
+ s = find_pc_line_symtab (pc);
+ /* elz: This if here fixes the problem with the pc not being
+ displayed in the tui asm layout, with no debug symbols. The
+ value of s would be 0 here, and select_source_symtab would
+ abort the command by calling the 'error' function. */
+ if (s)
+ select_source_symtab (s);
}
- return res;
-}
-/* The selected frame has changed. This is happens after a target
- stop or when the user explicitly changes the frame (up/down/thread/...). */
-static void
-tui_selected_frame_level_changed_hook (int level)
-{
- struct frame_info *fi;
+ /* Display the frame position (even if there is no symbols or the PC
+ is not known). */
+ frame_info_changed_p = tui_show_frame_info (fi);
- fi = deprecated_selected_frame;
- /* Ensure that symbols for this frame are read in. Also, determine the
- source language of this frame, and switch to it if desired. */
- if (fi)
+ /* Refresh the register window if it's visible. */
+ if (tui_is_window_visible (DATA_WIN)
+ && (frame_info_changed_p || registers_too_p))
{
- struct symtab *s;
-
- s = find_pc_symtab (fi->pc);
- /* elz: this if here fixes the problem with the pc not being displayed
- in the tui asm layout, with no debug symbols. The value of s
- would be 0 here, and select_source_symtab would abort the
- command by calling the 'error' function */
- if (s)
- select_source_symtab (s);
-
- /* Display the frame position (even if there is no symbols). */
- tuiShowFrameInfo (fi);
-
- /* Refresh the register window if it's visible. */
- if (tui_is_window_visible (DATA_WIN))
- {
- tui_refreshing_registers = 1;
- tuiCheckDataValues (fi);
- tui_refreshing_registers = 0;
- }
+ tui_refreshing_registers = 1;
+ TUI_DATA_WIN->check_register_values (fi);
+ tui_refreshing_registers = 0;
}
}
-/* Called from print_frame_info to list the line we stopped in. */
+/* Dummy callback for deprecated_print_frame_info_listing_hook which is called
+ from print_frame_info. */
+
static void
-tui_print_frame_info_listing_hook (struct symtab *s, int line,
- int stopline, int noerror)
+tui_dummy_print_frame_info_listing_hook (struct symtab *s,
+ int line,
+ int stopline,
+ int noerror)
{
- select_source_symtab (s);
- tuiShowFrameInfo (deprecated_selected_frame);
}
-/* Called when the target process died or is detached.
- Update the status line. */
+/* Perform all necessary cleanups regarding our module's inferior data
+ that is required after the inferior INF just exited. */
+
static void
-tui_detach_hook (void)
+tui_inferior_exit (struct inferior *inf)
{
- tuiShowFrameInfo (0);
+ /* Leave the SingleKey mode to make sure the gdb prompt is visible. */
+ tui_set_key_mode (TUI_COMMAND_MODE);
+ tui_show_frame_info (0);
tui_display_main ();
}
-/* Install the TUI specific hooks. */
-void
-tui_install_hooks (void)
-{
- target_wait_hook = tui_target_wait_hook;
- selected_frame_level_changed_hook = tui_selected_frame_level_changed_hook;
- print_frame_info_listing_hook = tui_print_frame_info_listing_hook;
-
- query_hook = tui_query_hook;
-
- /* Install the event hooks. */
- tui_old_event_hooks = set_gdb_event_hooks (&tui_event_hooks);
+/* Observer for the before_prompt notification. */
- registers_changed_hook = tui_registers_changed_hook;
- register_changed_hook = tui_register_changed_hook;
- detach_hook = tui_detach_hook;
-}
-
-/* Remove the TUI specific hooks. */
-void
-tui_remove_hooks (void)
+static void
+tui_before_prompt (const char *current_gdb_prompt)
{
- target_wait_hook = 0;
- selected_frame_level_changed_hook = 0;
- print_frame_info_listing_hook = 0;
- query_hook = 0;
- registers_changed_hook = 0;
- register_changed_hook = 0;
- detach_hook = 0;
-
- /* Restore the previous event hooks. */
- set_gdb_event_hooks (tui_old_event_hooks);
+ /* This refresh is intended to catch changes to the selected frame following
+ a call to "up", "down" or "frame". As such we don't necessarily want to
+ refresh registers here unless the frame actually changed by one of these
+ commands. Registers will otherwise be refreshed after a normal stop or by
+ our tui_register_changed_hook. */
+ tui_refresh_frame_and_register_information (/*registers_too_p=*/0);
}
-/* Cleanup the tui before exiting. */
+/* Observer for the normal_stop notification. */
+
static void
-tui_exit (void)
+tui_normal_stop (struct bpstats *bs, int print_frame)
{
- /* Disable the tui. Curses mode is left leaving the screen
- in a clean state (see endwin()). */
- tui_disable ();
+ /* This refresh is intended to catch changes to the selected frame and to
+ registers following a normal stop. */
+ tui_refresh_frame_and_register_information (/*registers_too_p=*/1);
}
-/* Initialize all the necessary variables, start the event loop,
- register readline, and stdin, start the loop. */
+/* Token associated with observers registered while TUI hooks are
+ installed. */
+static const gdb::observers::token tui_observers_token {};
+
+/* Attach or detach a single observer, according to ATTACH. */
+
+template<typename T>
static void
-tui_command_loop (void)
+attach_or_detach (T &observable, typename T::func_type func, bool attach)
{
- int length;
- char *a_prompt;
- char *gdb_prompt = get_prompt ();
-
- /* If we are using readline, set things up and display the first
- prompt, otherwise just print the prompt. */
- if (async_command_editing_p)
- {
- /* Tell readline what the prompt to display is and what function it
- will need to call after a whole line is read. This also displays
- the first prompt. */
- length = strlen (PREFIX (0)) + strlen (gdb_prompt) + strlen (SUFFIX (0)) + 1;
- a_prompt = (char *) xmalloc (length);
- strcpy (a_prompt, PREFIX (0));
- strcat (a_prompt, gdb_prompt);
- strcat (a_prompt, SUFFIX (0));
- rl_callback_handler_install (a_prompt, input_handler);
- }
+ if (attach)
+ observable.attach (func, tui_observers_token);
else
- display_gdb_prompt (0);
-
- /* Now it's time to start the event loop. */
- tui_event_loop ();
+ observable.detach (tui_observers_token);
}
-/* Start up the event loop. This is the entry point to the event loop
- from the command loop. */
+/* Attach or detach TUI observers, according to ATTACH. */
static void
-tui_event_loop (void)
+tui_attach_detach_observers (bool attach)
{
- /* Loop until there is nothing to do. This is the entry point to the
- event loop engine. gdb_do_one_event, called via catch_errors()
- will process one event for each invocation. It blocks waits for
- an event and then processes it. >0 when an event is processed, 0
- when catch_errors() caught an error and <0 when there are no
- longer any event sources registered. */
- while (1)
- {
- int result = catch_errors (gdb_do_one_event, 0, "", RETURN_MASK_ALL);
- if (result < 0)
- break;
-
- /* Update gdb output according to TUI mode. Since catch_errors
- preserves the uiout from changing, this must be done at top
- level of event loop. */
- if (tui_active)
- uiout = tui_out;
- else
- uiout = tui_old_uiout;
-
- if (result == 0)
- {
- /* FIXME: this should really be a call to a hook that is
- interface specific, because interfaces can display the
- prompt in their own way. */
- display_gdb_prompt (0);
- /* This call looks bizarre, but it is required. If the user
- entered a command that caused an error,
- after_char_processing_hook won't be called from
- rl_callback_read_char_wrapper. Using a cleanup there
- won't work, since we want this function to be called
- after a new prompt is printed. */
- if (after_char_processing_hook)
- (*after_char_processing_hook) ();
- /* Maybe better to set a flag to be checked somewhere as to
- whether display the prompt or not. */
- }
- }
-
- /* We are done with the event loop. There are no more event sources
- to listen to. So we exit GDB. */
- return;
+ attach_or_detach (gdb::observers::breakpoint_created,
+ tui_event_create_breakpoint, attach);
+ attach_or_detach (gdb::observers::breakpoint_deleted,
+ tui_event_delete_breakpoint, attach);
+ attach_or_detach (gdb::observers::breakpoint_modified,
+ tui_event_modify_breakpoint, attach);
+ attach_or_detach (gdb::observers::inferior_exit,
+ tui_inferior_exit, attach);
+ attach_or_detach (gdb::observers::before_prompt,
+ tui_before_prompt, attach);
+ attach_or_detach (gdb::observers::normal_stop,
+ tui_normal_stop, attach);
+ attach_or_detach (gdb::observers::register_changed,
+ tui_register_changed, attach);
}
-/* Initialize the tui by installing several gdb hooks, initializing
- the tui IO and preparing the readline with the kind binding. */
-static void
-tui_init_hook (char *argv0)
+/* Install the TUI specific hooks. */
+void
+tui_install_hooks (void)
{
- /* Don't enable the TUI if a specific interpreter is installed. */
- if (interpreter_p)
- return;
-
- /* Install exit handler to leave the screen in a good shape. */
- atexit (tui_exit);
-
- initializeStaticData ();
-
- /* Install the permanent hooks. */
- tui_target_new_objfile_chain = target_new_objfile_hook;
- target_new_objfile_hook = tui_new_objfile_hook;
+ /* If this hook is not set to something then print_frame_info will
+ assume that the CLI, not the TUI, is active, and will print the frame info
+ for us in such a way that we are not prepared to handle. This hook is
+ otherwise effectively obsolete. */
+ deprecated_print_frame_info_listing_hook
+ = tui_dummy_print_frame_info_listing_hook;
- tui_initialize_io ();
- tui_initialize_readline ();
+ /* Install the event hooks. */
+ tui_attach_detach_observers (true);
+}
- /* Tell gdb to use the tui_command_loop as the main loop. */
- command_loop_hook = tui_command_loop;
+/* Remove the TUI specific hooks. */
+void
+tui_remove_hooks (void)
+{
+ deprecated_print_frame_info_listing_hook = 0;
- /* Decide in which mode to start using GDB (based on -tui). */
- if (tui_version)
- {
- tui_enable ();
- }
+ /* Remove our observers. */
+ tui_attach_detach_observers (false);
}
-/* Initialize the tui. */
void
-_initialize_tui (void)
+_initialize_tui_hooks (void)
{
- /* Setup initialization hook. */
- init_ui_hook = tui_init_hook;
+ /* Install the permanent hooks. */
+ gdb::observers::new_objfile.attach (tui_new_objfile_hook);
}
-
projects / deliverable / binutils-gdb.git / blobdiff