gdb/tui/tui-hooks.c

   1 /* GDB hooks for TUI.
   2
   3    Copyright (C) 2001-2019 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   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.
  11
  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.
  16
  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/>.  */
  19
  20 #include "defs.h"
  21 #include "symtab.h"
  22 #include "inferior.h"
  23 #include "command.h"
  24 #include "bfd.h"
  25 #include "symfile.h"
  26 #include "objfiles.h"
  27 #include "target.h"
  28 #include "gdbcore.h"
  29 #include "event-loop.h"
  30 #include "event-top.h"
  31 #include "frame.h"
  32 #include "breakpoint.h"
  33 #include "ui-out.h"
  34 #include "top.h"
  35 #include "observable.h"
  36 #include "source.h"
  37 #include <unistd.h>
  38 #include <fcntl.h>
  39
  40 #include "tui/tui.h"
  41 #include "tui/tui-hooks.h"
  42 #include "tui/tui-data.h"
  43 #include "tui/tui-layout.h"
  44 #include "tui/tui-io.h"
  45 #include "tui/tui-regs.h"
  46 #include "tui/tui-win.h"
  47 #include "tui/tui-stack.h"
  48 #include "tui/tui-winsource.h"
  49
  50 #include "gdb_curses.h"
  51
  52 /* This redefines CTRL if it is not already defined, so it must come
  53    after terminal state releated include files like <term.h> and
  54    "gdb_curses.h".  */
  55 #include "readline/readline.h"
  56
  57 static void
  58 tui_new_objfile_hook (struct objfile* objfile)
  59 {
  60   if (tui_active)
  61     tui_display_main ();
  62 }
  63
  64 /* Prevent recursion of deprecated_register_changed_hook().  */
  65 static int tui_refreshing_registers = 0;
  66
  67 /* Observer for the register_changed notification.  */
  68
  69 static void
  70 tui_register_changed (struct frame_info *frame, int regno)
  71 {
  72   struct frame_info *fi;
  73
  74   /* The frame of the register that was changed may differ from the selected
  75      frame, but we only want to show the register values of the selected frame.
  76      And even if the frames differ a register change made in one can still show
  77      up in the other.  So we always use the selected frame here, and ignore
  78      FRAME.  */
  79   fi = get_selected_frame (NULL);
  80   if (tui_refreshing_registers == 0)
  81     {
  82       tui_refreshing_registers = 1;
  83       tui_check_register_values (fi);
  84       tui_refreshing_registers = 0;
  85     }
  86 }
  87
  88 /* Breakpoint creation hook.
  89    Update the screen to show the new breakpoint.  */
  90 static void
  91 tui_event_create_breakpoint (struct breakpoint *b)
  92 {
  93   tui_update_all_breakpoint_info (nullptr);
  94 }
  95
  96 /* Breakpoint deletion hook.
  97    Refresh the screen to update the breakpoint marks.  */
  98 static void
  99 tui_event_delete_breakpoint (struct breakpoint *b)
 100 {
 101   tui_update_all_breakpoint_info (b);
 102 }
 103
 104 static void
 105 tui_event_modify_breakpoint (struct breakpoint *b)
 106 {
 107   tui_update_all_breakpoint_info (nullptr);
 108 }
 109
 110 /* Refresh TUI's frame and register information.  This is a hook intended to be
 111    used to update the screen after potential frame and register changes.
 112
 113    REGISTERS_TOO_P controls whether to refresh our register information even
 114    if frame information hasn't changed.  */
 115
 116 static void
 117 tui_refresh_frame_and_register_information (int registers_too_p)
 118 {
 119   struct frame_info *fi;
 120   CORE_ADDR pc;
 121   int frame_info_changed_p;
 122
 123   if (!has_stack_frames ())
 124     return;
 125
 126   target_terminal::scoped_restore_terminal_state term_state;
 127   target_terminal::ours_for_output ();
 128
 129   fi = get_selected_frame (NULL);
 130   /* Ensure that symbols for this frame are read in.  Also, determine
 131      the source language of this frame, and switch to it if
 132      desired.  */
 133   if (get_frame_pc_if_available (fi, &pc))
 134     {
 135       struct symtab *s;
 136
 137       s = find_pc_line_symtab (pc);
 138       /* elz: This if here fixes the problem with the pc not being
 139          displayed in the tui asm layout, with no debug symbols.  The
 140          value of s would be 0 here, and select_source_symtab would
 141          abort the command by calling the 'error' function.  */
 142       if (s)
 143         select_source_symtab (s);
 144     }
 145
 146   /* Display the frame position (even if there is no symbols or the PC
 147      is not known).  */
 148   frame_info_changed_p = tui_show_frame_info (fi);
 149
 150   /* Refresh the register window if it's visible.  */
 151   if (tui_is_window_visible (DATA_WIN)
 152       && (frame_info_changed_p || registers_too_p))
 153     {
 154       tui_refreshing_registers = 1;
 155       tui_check_register_values (fi);
 156       tui_refreshing_registers = 0;
 157     }
 158 }
 159
 160 /* Dummy callback for deprecated_print_frame_info_listing_hook which is called
 161    from print_frame_info.  */
 162
 163 static void
 164 tui_dummy_print_frame_info_listing_hook (struct symtab *s,
 165                                          int line,
 166                                          int stopline,
 167                                          int noerror)
 168 {
 169 }
 170
 171 /* Perform all necessary cleanups regarding our module's inferior data
 172    that is required after the inferior INF just exited.  */
 173
 174 static void
 175 tui_inferior_exit (struct inferior *inf)
 176 {
 177   /* Leave the SingleKey mode to make sure the gdb prompt is visible.  */
 178   tui_set_key_mode (TUI_COMMAND_MODE);
 179   tui_show_frame_info (0);
 180   tui_display_main ();
 181 }
 182
 183 /* Observer for the before_prompt notification.  */
 184
 185 static void
 186 tui_before_prompt (const char *current_gdb_prompt)
 187 {
 188   /* This refresh is intended to catch changes to the selected frame following
 189      a call to "up", "down" or "frame".  As such we don't necessarily want to
 190      refresh registers here unless the frame actually changed by one of these
 191      commands.  Registers will otherwise be refreshed after a normal stop or by
 192      our tui_register_changed_hook.  */
 193   tui_refresh_frame_and_register_information (/*registers_too_p=*/0);
 194 }
 195
 196 /* Observer for the normal_stop notification.  */
 197
 198 static void
 199 tui_normal_stop (struct bpstats *bs, int print_frame)
 200 {
 201   /* This refresh is intended to catch changes to the selected frame and to
 202      registers following a normal stop.  */
 203   tui_refresh_frame_and_register_information (/*registers_too_p=*/1);
 204 }
 205
 206 /* Token associated with observers registered while TUI hooks are
 207    installed.  */
 208 static const gdb::observers::token tui_observers_token {};
 209
 210 /* Attach or detach a single observer, according to ATTACH.  */
 211
 212 template<typename T>
 213 static void
 214 attach_or_detach (T &observable, typename T::func_type func, bool attach)
 215 {
 216   if (attach)
 217     observable.attach (func, tui_observers_token);
 218   else
 219     observable.detach (tui_observers_token);
 220 }
 221
 222 /* Attach or detach TUI observers, according to ATTACH.  */
 223
 224 static void
 225 tui_attach_detach_observers (bool attach)
 226 {
 227   attach_or_detach (gdb::observers::breakpoint_created,
 228                     tui_event_create_breakpoint, attach);
 229   attach_or_detach (gdb::observers::breakpoint_deleted,
 230                     tui_event_delete_breakpoint, attach);
 231   attach_or_detach (gdb::observers::breakpoint_modified,
 232                     tui_event_modify_breakpoint, attach);
 233   attach_or_detach (gdb::observers::inferior_exit,
 234                     tui_inferior_exit, attach);
 235   attach_or_detach (gdb::observers::before_prompt,
 236                     tui_before_prompt, attach);
 237   attach_or_detach (gdb::observers::normal_stop,
 238                     tui_normal_stop, attach);
 239   attach_or_detach (gdb::observers::register_changed,
 240                     tui_register_changed, attach);
 241 }
 242
 243 /* Install the TUI specific hooks.  */
 244 void
 245 tui_install_hooks (void)
 246 {
 247   /* If this hook is not set to something then print_frame_info will
 248      assume that the CLI, not the TUI, is active, and will print the frame info
 249      for us in such a way that we are not prepared to handle.  This hook is
 250      otherwise effectively obsolete.  */
 251   deprecated_print_frame_info_listing_hook
 252     = tui_dummy_print_frame_info_listing_hook;
 253
 254   /* Install the event hooks.  */
 255   tui_attach_detach_observers (true);
 256 }
 257
 258 /* Remove the TUI specific hooks.  */
 259 void
 260 tui_remove_hooks (void)
 261 {
 262   deprecated_print_frame_info_listing_hook = 0;
 263
 264   /* Remove our observers.  */
 265   tui_attach_detach_observers (false);
 266 }
 267
 268 void
 269 _initialize_tui_hooks (void)
 270 {
 271   /* Install the permanent hooks.  */
 272   gdb::observers::new_objfile.attach (tui_new_objfile_hook);
 273 }