xref: /netbsd-src/external/gpl3/gdb.old/dist/gdb/tui/tui-hooks.c (revision e6c7e151de239c49d2e38720a061ed9d1fa99309)
1 /* GDB hooks for TUI.
2 
3    Copyright (C) 2001-2017 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 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_data_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 ();
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 ();
102 }
103 
104 static void
105 tui_event_modify_breakpoint (struct breakpoint *b)
106 {
107   tui_update_all_breakpoint_info ();
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   struct cleanup *old_chain;
122   int frame_info_changed_p;
123 
124   if (!has_stack_frames ())
125     return;
126 
127   old_chain = make_cleanup_restore_target_terminal ();
128   target_terminal_ours_for_output ();
129 
130   fi = get_selected_frame (NULL);
131   /* Ensure that symbols for this frame are read in.  Also, determine
132      the source language of this frame, and switch to it if
133      desired.  */
134   if (get_frame_pc_if_available (fi, &pc))
135     {
136       struct symtab *s;
137 
138       s = find_pc_line_symtab (pc);
139       /* elz: This if here fixes the problem with the pc not being
140 	 displayed in the tui asm layout, with no debug symbols.  The
141 	 value of s would be 0 here, and select_source_symtab would
142 	 abort the command by calling the 'error' function.  */
143       if (s)
144 	select_source_symtab (s);
145     }
146 
147   /* Display the frame position (even if there is no symbols or the PC
148      is not known).  */
149   frame_info_changed_p = tui_show_frame_info (fi);
150 
151   /* Refresh the register window if it's visible.  */
152   if (tui_is_window_visible (DATA_WIN)
153       && (frame_info_changed_p || registers_too_p))
154     {
155       tui_refreshing_registers = 1;
156       tui_check_data_values (fi);
157       tui_refreshing_registers = 0;
158     }
159 
160   do_cleanups (old_chain);
161 }
162 
163 /* Dummy callback for deprecated_print_frame_info_listing_hook which is called
164    from print_frame_info.  */
165 
166 static void
167 tui_dummy_print_frame_info_listing_hook (struct symtab *s,
168 					 int line,
169 					 int stopline,
170 					 int noerror)
171 {
172 }
173 
174 /* Perform all necessary cleanups regarding our module's inferior data
175    that is required after the inferior INF just exited.  */
176 
177 static void
178 tui_inferior_exit (struct inferior *inf)
179 {
180   /* Leave the SingleKey mode to make sure the gdb prompt is visible.  */
181   tui_set_key_mode (TUI_COMMAND_MODE);
182   tui_show_frame_info (0);
183   tui_display_main ();
184 }
185 
186 /* Observer for the before_prompt notification.  */
187 
188 static void
189 tui_before_prompt (const char *current_gdb_prompt)
190 {
191   /* This refresh is intended to catch changes to the selected frame following
192      a call to "up", "down" or "frame".  As such we don't necessarily want to
193      refresh registers here unless the frame actually changed by one of these
194      commands.  Registers will otherwise be refreshed after a normal stop or by
195      our tui_register_changed_hook.  */
196   tui_refresh_frame_and_register_information (/*registers_too_p=*/0);
197 }
198 
199 /* Observer for the normal_stop notification.  */
200 
201 static void
202 tui_normal_stop (struct bpstats *bs, int print_frame)
203 {
204   /* This refresh is intended to catch changes to the selected frame and to
205      registers following a normal stop.  */
206   tui_refresh_frame_and_register_information (/*registers_too_p=*/1);
207 }
208 
209 /* Observers created when installing TUI hooks.  */
210 static struct observer *tui_bp_created_observer;
211 static struct observer *tui_bp_deleted_observer;
212 static struct observer *tui_bp_modified_observer;
213 static struct observer *tui_inferior_exit_observer;
214 static struct observer *tui_before_prompt_observer;
215 static struct observer *tui_normal_stop_observer;
216 static struct observer *tui_register_changed_observer;
217 
218 /* Install the TUI specific hooks.  */
219 void
220 tui_install_hooks (void)
221 {
222   /* If this hook is not set to something then print_frame_info will
223      assume that the CLI, not the TUI, is active, and will print the frame info
224      for us in such a way that we are not prepared to handle.  This hook is
225      otherwise effectively obsolete.  */
226   deprecated_print_frame_info_listing_hook
227     = tui_dummy_print_frame_info_listing_hook;
228 
229   /* Install the event hooks.  */
230   tui_bp_created_observer
231     = observer_attach_breakpoint_created (tui_event_create_breakpoint);
232   tui_bp_deleted_observer
233     = observer_attach_breakpoint_deleted (tui_event_delete_breakpoint);
234   tui_bp_modified_observer
235     = observer_attach_breakpoint_modified (tui_event_modify_breakpoint);
236   tui_inferior_exit_observer
237     = observer_attach_inferior_exit (tui_inferior_exit);
238   tui_before_prompt_observer
239     = observer_attach_before_prompt (tui_before_prompt);
240   tui_normal_stop_observer
241     = observer_attach_normal_stop (tui_normal_stop);
242   tui_register_changed_observer
243     = observer_attach_register_changed (tui_register_changed);
244 }
245 
246 /* Remove the TUI specific hooks.  */
247 void
248 tui_remove_hooks (void)
249 {
250   deprecated_print_frame_info_listing_hook = 0;
251   deprecated_query_hook = 0;
252   /* Remove our observers.  */
253   observer_detach_breakpoint_created (tui_bp_created_observer);
254   tui_bp_created_observer = NULL;
255   observer_detach_breakpoint_deleted (tui_bp_deleted_observer);
256   tui_bp_deleted_observer = NULL;
257   observer_detach_breakpoint_modified (tui_bp_modified_observer);
258   tui_bp_modified_observer = NULL;
259   observer_detach_inferior_exit (tui_inferior_exit_observer);
260   tui_inferior_exit_observer = NULL;
261   observer_detach_before_prompt (tui_before_prompt_observer);
262   tui_before_prompt_observer = NULL;
263   observer_detach_normal_stop (tui_normal_stop_observer);
264   tui_normal_stop_observer = NULL;
265   observer_detach_register_changed (tui_register_changed_observer);
266   tui_register_changed_observer = NULL;
267 }
268 
269 void _initialize_tui_hooks (void);
270 
271 void
272 _initialize_tui_hooks (void)
273 {
274   /* Install the permanent hooks.  */
275   observer_attach_new_objfile (tui_new_objfile_hook);
276 }
277