gdb/tui/tui-hooks.c

   1 /* GDB hooks for TUI.
   2
   3    Copyright (C) 2001-2016 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 "observer.h"
  36 #include <unistd.h>
  37 #include <fcntl.h>
  38
  39 #include "tui/tui.h"
  40 #include "tui/tui-hooks.h"
  41 #include "tui/tui-data.h"
  42 #include "tui/tui-layout.h"
  43 #include "tui/tui-io.h"
  44 #include "tui/tui-regs.h"
  45 #include "tui/tui-win.h"
  46 #include "tui/tui-stack.h"
  47 #include "tui/tui-windata.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 int tui_target_has_run = 0;
  58
  59 static void
  60 tui_new_objfile_hook (struct objfile* objfile)
  61 {
  62   if (tui_active)
  63     tui_display_main ();
  64 }
  65
  66 /* Prevent recursion of deprecated_register_changed_hook().  */
  67 static int tui_refreshing_registers = 0;
  68
  69 /* Observer for the register_changed notification.  */
  70
  71 static void
  72 tui_register_changed (struct frame_info *frame, int regno)
  73 {
  74   struct frame_info *fi;
  75
  76   /* The frame of the register that was changed may differ from the selected
  77      frame, but we only want to show the register values of the selected frame.
  78      And even if the frames differ a register change made in one can still show
  79      up in the other.  So we always use the selected frame here, and ignore
  80      FRAME.  */
  81   fi = get_selected_frame (NULL);
  82   if (tui_refreshing_registers == 0)
  83     {
  84       tui_refreshing_registers = 1;
  85       tui_check_data_values (fi);
  86       tui_refreshing_registers = 0;
  87     }
  88 }
  89
  90 /* Breakpoint creation hook.
  91    Update the screen to show the new breakpoint.  */
  92 static void
  93 tui_event_create_breakpoint (struct breakpoint *b)
  94 {
  95   tui_update_all_breakpoint_info ();
  96 }
  97
  98 /* Breakpoint deletion hook.
  99    Refresh the screen to update the breakpoint marks.  */
 100 static void
 101 tui_event_delete_breakpoint (struct breakpoint *b)
 102 {
 103   tui_update_all_breakpoint_info ();
 104 }
 105
 106 static void
 107 tui_event_modify_breakpoint (struct breakpoint *b)
 108 {
 109   tui_update_all_breakpoint_info ();
 110 }
 111
 112 /* Called when a command is about to proceed the inferior.  */
 113
 114 static void
 115 tui_about_to_proceed (void)
 116 {
 117   /* Leave tui mode (optional).  */
 118 #if 0
 119   if (tui_active)
 120     {
 121       target_terminal_ours ();
 122       endwin ();
 123       target_terminal_inferior ();
 124     }
 125 #endif
 126   tui_target_has_run = 1;
 127 }
 128
 129 /* Refresh TUI's frame and register information.  This is a hook intended to be
 130    used to update the screen after potential frame and register changes.
 131
 132    REGISTERS_TOO_P controls whether to refresh our register information even
 133    if frame information hasn't changed.  */
 134
 135 static void
 136 tui_refresh_frame_and_register_information (int registers_too_p)
 137 {
 138   struct frame_info *fi;
 139   CORE_ADDR pc;
 140   struct cleanup *old_chain;
 141   int frame_info_changed_p;
 142
 143   if (!has_stack_frames ())
 144     return;
 145
 146   old_chain = make_cleanup_restore_target_terminal ();
 147   target_terminal_ours_for_output ();
 148
 149   fi = get_selected_frame (NULL);
 150   /* Ensure that symbols for this frame are read in.  Also, determine
 151      the source language of this frame, and switch to it if
 152      desired.  */
 153   if (get_frame_pc_if_available (fi, &pc))
 154     {
 155       struct symtab *s;
 156
 157       s = find_pc_line_symtab (pc);
 158       /* elz: This if here fixes the problem with the pc not being
 159          displayed in the tui asm layout, with no debug symbols.  The
 160          value of s would be 0 here, and select_source_symtab would
 161          abort the command by calling the 'error' function.  */
 162       if (s)
 163         select_source_symtab (s);
 164     }
 165
 166   /* Display the frame position (even if there is no symbols or the PC
 167      is not known).  */
 168   frame_info_changed_p = tui_show_frame_info (fi);
 169
 170   /* Refresh the register window if it's visible.  */
 171   if (tui_is_window_visible (DATA_WIN)
 172       && (frame_info_changed_p || registers_too_p))
 173     {
 174       tui_refreshing_registers = 1;
 175       tui_check_data_values (fi);
 176       tui_refreshing_registers = 0;
 177     }
 178
 179   do_cleanups (old_chain);
 180 }
 181
 182 /* Dummy callback for deprecated_print_frame_info_listing_hook which is called
 183    from print_frame_info.  */
 184
 185 static void
 186 tui_dummy_print_frame_info_listing_hook (struct symtab *s,
 187                                          int line,
 188                                          int stopline,
 189                                          int noerror)
 190 {
 191 }
 192
 193 /* Perform all necessary cleanups regarding our module's inferior data
 194    that is required after the inferior INF just exited.  */
 195
 196 static void
 197 tui_inferior_exit (struct inferior *inf)
 198 {
 199   /* Leave the SingleKey mode to make sure the gdb prompt is visible.  */
 200   tui_set_key_mode (TUI_COMMAND_MODE);
 201   tui_show_frame_info (0);
 202   tui_display_main ();
 203 }
 204
 205 /* Observer for the before_prompt notification.  */
 206
 207 static void
 208 tui_before_prompt (const char *current_gdb_prompt)
 209 {
 210   /* This refresh is intended to catch changes to the selected frame following
 211      a call to "up", "down" or "frame".  As such we don't necessarily want to
 212      refresh registers here unless the frame actually changed by one of these
 213      commands.  Registers will otherwise be refreshed after a normal stop or by
 214      our tui_register_changed_hook.  */
 215   tui_refresh_frame_and_register_information (/*registers_too_p=*/0);
 216 }
 217
 218 /* Observer for the normal_stop notification.  */
 219
 220 static void
 221 tui_normal_stop (struct bpstats *bs, int print_frame)
 222 {
 223   /* This refresh is intended to catch changes to the selected frame and to
 224      registers following a normal stop.  */
 225   tui_refresh_frame_and_register_information (/*registers_too_p=*/1);
 226 }
 227
 228 /* Observers created when installing TUI hooks.  */
 229 static struct observer *tui_bp_created_observer;
 230 static struct observer *tui_bp_deleted_observer;
 231 static struct observer *tui_bp_modified_observer;
 232 static struct observer *tui_inferior_exit_observer;
 233 static struct observer *tui_about_to_proceed_observer;
 234 static struct observer *tui_before_prompt_observer;
 235 static struct observer *tui_normal_stop_observer;
 236 static struct observer *tui_register_changed_observer;
 237
 238 /* Install the TUI specific hooks.  */
 239 void
 240 tui_install_hooks (void)
 241 {
 242   /* If this hook is not set to something then print_frame_info will
 243      assume that the CLI, not the TUI, is active, and will print the frame info
 244      for us in such a way that we are not prepared to handle.  This hook is
 245      otherwise effectively obsolete.  */
 246   deprecated_print_frame_info_listing_hook
 247     = tui_dummy_print_frame_info_listing_hook;
 248
 249   /* Install the event hooks.  */
 250   tui_bp_created_observer
 251     = observer_attach_breakpoint_created (tui_event_create_breakpoint);
 252   tui_bp_deleted_observer
 253     = observer_attach_breakpoint_deleted (tui_event_delete_breakpoint);
 254   tui_bp_modified_observer
 255     = observer_attach_breakpoint_modified (tui_event_modify_breakpoint);
 256   tui_inferior_exit_observer
 257     = observer_attach_inferior_exit (tui_inferior_exit);
 258   tui_about_to_proceed_observer
 259     = observer_attach_about_to_proceed (tui_about_to_proceed);
 260   tui_before_prompt_observer
 261     = observer_attach_before_prompt (tui_before_prompt);
 262   tui_normal_stop_observer
 263     = observer_attach_normal_stop (tui_normal_stop);
 264   tui_register_changed_observer
 265     = observer_attach_register_changed (tui_register_changed);
 266 }
 267
 268 /* Remove the TUI specific hooks.  */
 269 void
 270 tui_remove_hooks (void)
 271 {
 272   deprecated_print_frame_info_listing_hook = 0;
 273   deprecated_query_hook = 0;
 274   /* Remove our observers.  */
 275   observer_detach_breakpoint_created (tui_bp_created_observer);
 276   tui_bp_created_observer = NULL;
 277   observer_detach_breakpoint_deleted (tui_bp_deleted_observer);
 278   tui_bp_deleted_observer = NULL;
 279   observer_detach_breakpoint_modified (tui_bp_modified_observer);
 280   tui_bp_modified_observer = NULL;
 281   observer_detach_inferior_exit (tui_inferior_exit_observer);
 282   tui_inferior_exit_observer = NULL;
 283   observer_detach_about_to_proceed (tui_about_to_proceed_observer);
 284   tui_about_to_proceed_observer = NULL;
 285   observer_detach_before_prompt (tui_before_prompt_observer);
 286   tui_before_prompt_observer = NULL;
 287   observer_detach_normal_stop (tui_normal_stop_observer);
 288   tui_normal_stop_observer = NULL;
 289   observer_detach_register_changed (tui_register_changed_observer);
 290   tui_register_changed_observer = NULL;
 291 }
 292
 293 void _initialize_tui_hooks (void);
 294
 295 void
 296 _initialize_tui_hooks (void)
 297 {
 298   /* Install the permanent hooks.  */
 299   observer_attach_new_objfile (tui_new_objfile_hook);
 300 }