1 /* TUI display locator.
3 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2006, 2007, 2008,
4 2009 Free Software Foundation, Inc.
6 Contributed by Hewlett-Packard Company.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
25 #include "breakpoint.h"
31 #include "gdb_string.h"
33 #include "tui/tui-data.h"
34 #include "tui/tui-stack.h"
35 #include "tui/tui-wingeneral.h"
36 #include "tui/tui-source.h"
37 #include "tui/tui-winsource.h"
38 #include "tui/tui-file.h"
40 #include "gdb_curses.h"
42 /* Get a printable name for the function at the address.
43 The symbol name is demangled if demangling is turned on.
44 Returns a pointer to a static area holding the result. */
45 static char *tui_get_function_from_frame (struct frame_info
*fi
);
47 /* Set the filename portion of the locator. */
48 static void tui_set_locator_filename (const char *filename
);
50 /* Update the locator, with the provided arguments. */
51 static void tui_set_locator_info (struct gdbarch
*gdbarch
,
54 int lineno
, CORE_ADDR addr
);
56 static void tui_update_command (char *, int);
59 /* Create the status line to display as much information as we can on
60 this single line: target name, process number, current function,
61 current line, current PC, SingleKey mode. */
63 tui_make_status_line (struct tui_locator_element
*loc
)
66 char line_buf
[50], *pname
;
76 struct ui_file
*pc_out
;
78 if (ptid_equal (inferior_ptid
, null_ptid
))
79 pid_name
= "No process";
81 pid_name
= target_pid_to_str (inferior_ptid
);
83 target_width
= strlen (target_shortname
);
84 if (target_width
> MAX_TARGET_WIDTH
)
85 target_width
= MAX_TARGET_WIDTH
;
87 pid_width
= strlen (pid_name
);
88 if (pid_width
> MAX_PID_WIDTH
)
89 pid_width
= MAX_PID_WIDTH
;
91 status_size
= tui_term_width ();
92 string
= (char *) xmalloc (status_size
+ 1);
93 buf
= (char*) alloca (status_size
+ 1);
95 /* Translate line number and obtain its size. */
97 sprintf (line_buf
, "%d", loc
->line_no
);
99 strcpy (line_buf
, "??");
100 line_width
= strlen (line_buf
);
101 if (line_width
< MIN_LINE_WIDTH
)
102 line_width
= MIN_LINE_WIDTH
;
104 /* Translate PC address. */
105 pc_out
= tui_sfileopen (128);
106 fputs_filtered (paddress (loc
->gdbarch
, loc
->addr
), pc_out
);
107 pc_buf
= tui_file_get_strbuf (pc_out
);
108 pc_width
= strlen (pc_buf
);
110 /* First determine the amount of proc name width we have available.
111 The +1 are for a space separator between fields.
112 The -1 are to take into account the \0 counted by sizeof. */
113 proc_width
= (status_size
116 - (sizeof (PROC_PREFIX
) - 1 + 1)
117 - (sizeof (LINE_PREFIX
) - 1 + line_width
+ 1)
118 - (sizeof (PC_PREFIX
) - 1 + pc_width
+ 1)
119 - (tui_current_key_mode
== TUI_SINGLE_KEY_MODE
120 ? (sizeof (SINGLE_KEY
) - 1 + 1)
123 /* If there is no room to print the function name, try by removing
125 if (proc_width
< MIN_PROC_WIDTH
)
127 proc_width
+= target_width
+ 1;
129 if (proc_width
< MIN_PROC_WIDTH
)
131 proc_width
+= pid_width
+ 1;
133 if (proc_width
<= MIN_PROC_WIDTH
)
135 proc_width
+= pc_width
+ sizeof (PC_PREFIX
) - 1 + 1;
139 proc_width
+= line_width
+ sizeof (LINE_PREFIX
) - 1 + 1;
148 /* Now convert elements to string form. */
149 pname
= loc
->proc_name
;
151 /* Now create the locator line from the string version of the
152 elements. We could use sprintf() here but that wouldn't ensure
153 that we don't overrun the size of the allocated buffer.
154 strcat_to_buf() will. */
157 if (target_width
> 0)
159 sprintf (buf
, "%*.*s ",
160 -target_width
, target_width
, target_shortname
);
161 strcat_to_buf (string
, status_size
, buf
);
165 sprintf (buf
, "%*.*s ",
166 -pid_width
, pid_width
, pid_name
);
167 strcat_to_buf (string
, status_size
, buf
);
170 /* Show whether we are in SingleKey mode. */
171 if (tui_current_key_mode
== TUI_SINGLE_KEY_MODE
)
173 strcat_to_buf (string
, status_size
, SINGLE_KEY
);
174 strcat_to_buf (string
, status_size
, " ");
177 /* Procedure/class name. */
180 if (strlen (pname
) > proc_width
)
181 sprintf (buf
, "%s%*.*s* ", PROC_PREFIX
,
182 1 - proc_width
, proc_width
- 1, pname
);
184 sprintf (buf
, "%s%*.*s ", PROC_PREFIX
,
185 -proc_width
, proc_width
, pname
);
186 strcat_to_buf (string
, status_size
, buf
);
191 sprintf (buf
, "%s%*.*s ", LINE_PREFIX
,
192 -line_width
, line_width
, line_buf
);
193 strcat_to_buf (string
, status_size
, buf
);
197 strcat_to_buf (string
, status_size
, PC_PREFIX
);
198 strcat_to_buf (string
, status_size
, pc_buf
);
202 for (i
= strlen (string
); i
< status_size
; i
++)
204 string
[status_size
] = (char) 0;
206 ui_file_delete (pc_out
);
210 /* Get a printable name for the function at the address. The symbol
211 name is demangled if demangling is turned on. Returns a pointer to
212 a static area holding the result. */
214 tui_get_function_from_frame (struct frame_info
*fi
)
216 static char name
[256];
217 struct ui_file
*stream
= tui_sfileopen (256);
220 print_address_symbolic (get_frame_pc (fi
), stream
, demangle
, "");
221 p
= tui_file_get_strbuf (stream
);
223 /* Use simple heuristics to isolate the function name. The symbol
224 can be demangled and we can have function parameters. Remove
225 them because the status line is too short to display them. */
228 strncpy (name
, p
, sizeof (name
));
229 p
= strchr (name
, '(');
231 p
= strchr (name
, '>');
234 p
= strchr (name
, '+');
237 ui_file_delete (stream
);
242 tui_show_locator_content (void)
245 struct tui_gen_win_info
*locator
;
247 locator
= tui_locator_win_info_ptr ();
249 if (locator
!= NULL
&& locator
->handle
!= (WINDOW
*) NULL
)
251 struct tui_win_element
*element
;
253 element
= (struct tui_win_element
*) locator
->content
[0];
255 string
= tui_make_status_line (&element
->which_element
.locator
);
256 wmove (locator
->handle
, 0, 0);
257 wstandout (locator
->handle
);
258 waddstr (locator
->handle
, string
);
259 wclrtoeol (locator
->handle
);
260 wstandend (locator
->handle
);
261 tui_refresh_win (locator
);
262 wmove (locator
->handle
, 0, 0);
264 locator
->content_in_use
= TRUE
;
269 /* Set the filename portion of the locator. */
271 tui_set_locator_filename (const char *filename
)
273 struct tui_gen_win_info
*locator
= tui_locator_win_info_ptr ();
274 struct tui_locator_element
*element
;
276 if (locator
->content
[0] == NULL
)
278 tui_set_locator_info (NULL
, filename
, NULL
, 0, 0);
282 element
= &((struct tui_win_element
*) locator
->content
[0])->which_element
.locator
;
283 element
->file_name
[0] = 0;
284 strcat_to_buf (element
->file_name
, MAX_LOCATOR_ELEMENT_LEN
, filename
);
287 /* Update the locator, with the provided arguments. */
289 tui_set_locator_info (struct gdbarch
*gdbarch
,
290 const char *filename
,
291 const char *procname
,
295 struct tui_gen_win_info
*locator
= tui_locator_win_info_ptr ();
296 struct tui_locator_element
*element
;
298 /* Allocate the locator content if necessary. */
299 if (locator
->content_size
<= 0)
301 locator
->content
= (void **) tui_alloc_content (1, locator
->type
);
302 locator
->content_size
= 1;
305 element
= &((struct tui_win_element
*) locator
->content
[0])->which_element
.locator
;
306 element
->proc_name
[0] = (char) 0;
307 strcat_to_buf (element
->proc_name
, MAX_LOCATOR_ELEMENT_LEN
, procname
);
308 element
->line_no
= lineno
;
309 element
->addr
= addr
;
310 element
->gdbarch
= gdbarch
;
311 tui_set_locator_filename (filename
);
314 /* Update only the filename portion of the locator. */
316 tui_update_locator_filename (const char *filename
)
318 tui_set_locator_filename (filename
);
319 tui_show_locator_content ();
322 /* Function to print the frame information for the TUI. */
324 tui_show_frame_info (struct frame_info
*fi
)
326 struct tui_win_info
*win_info
;
333 struct tui_gen_win_info
*locator
= tui_locator_win_info_ptr ();
334 int source_already_displayed
;
335 struct symtab_and_line sal
;
337 find_frame_sal (fi
, &sal
);
339 source_already_displayed
= sal
.symtab
!= 0
340 && tui_source_is_displayed (sal
.symtab
->filename
);
341 tui_set_locator_info (get_frame_arch (fi
),
342 sal
.symtab
== 0 ? "??" : sal
.symtab
->filename
,
343 tui_get_function_from_frame (fi
),
346 tui_show_locator_content ();
348 for (i
= 0; i
< (tui_source_windows ())->count
; i
++)
350 union tui_which_element
*item
;
351 win_info
= (tui_source_windows ())->list
[i
];
353 item
= &((struct tui_win_element
*) locator
->content
[0])->which_element
;
354 if (win_info
== TUI_SRC_WIN
)
356 start_line
= (item
->locator
.line_no
-
357 (win_info
->generic
.viewport_height
/ 2)) + 1;
363 if (find_pc_partial_function (get_frame_pc (fi
), (char **) NULL
,
364 &low
, (CORE_ADDR
) 0) == 0)
365 error (_("No function contains program counter for selected frame."));
367 low
= tui_get_low_disassembly_address (get_frame_arch (fi
),
368 low
, get_frame_pc (fi
));
371 if (win_info
== TUI_SRC_WIN
)
373 struct tui_line_or_address l
;
375 l
.u
.line_no
= start_line
;
376 if (!(source_already_displayed
377 && tui_line_is_displayed (item
->locator
.line_no
, win_info
, TRUE
)))
378 tui_update_source_window (win_info
, get_frame_arch (fi
),
379 sal
.symtab
, l
, TRUE
);
382 l
.u
.line_no
= item
->locator
.line_no
;
383 tui_set_is_exec_point_at (l
, win_info
);
388 if (win_info
== TUI_DISASM_WIN
)
390 struct tui_line_or_address a
;
393 if (!tui_addr_is_displayed (item
->locator
.addr
, win_info
, TRUE
))
394 tui_update_source_window (win_info
, get_frame_arch (fi
),
395 sal
.symtab
, a
, TRUE
);
398 a
.u
.addr
= item
->locator
.addr
;
399 tui_set_is_exec_point_at (a
, win_info
);
403 tui_update_exec_info (win_info
);
408 tui_set_locator_info (NULL
, NULL
, NULL
, 0, (CORE_ADDR
) 0);
409 tui_show_locator_content ();
410 for (i
= 0; i
< (tui_source_windows ())->count
; i
++)
412 win_info
= (tui_source_windows ())->list
[i
];
413 tui_clear_source_content (win_info
, EMPTY_SOURCE_PROMPT
);
414 tui_update_exec_info (win_info
);
419 /* Function to initialize gdb commands, for tui window stack
422 /* Provide a prototype to silence -Wmissing-prototypes. */
423 extern initialize_file_ftype _initialize_tui_stack
;
426 _initialize_tui_stack (void)
428 add_com ("update", class_tui
, tui_update_command
, _("\
429 Update the source window and locator to display the current execution point.\n"));
432 /* Command to update the display with the current execution point. */
434 tui_update_command (char *arg
, int from_tty
)
436 char cmd
[sizeof("frame 0")];
438 strcpy (cmd
, "frame 0");
439 execute_command (cmd
, from_tty
);