gdb/tui/tui-status.c - binutils-gdb - Git at Google

 /* TUI status line.

    Copyright (C) 1998-2024 Free Software Foundation, Inc.

    Contributed by Hewlett-Packard Company.

    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 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    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, see <http://www.gnu.org/licenses/>.  */

 #include "symtab.h"
 #include "frame.h"
 #include "command.h"
 #include "inferior.h"
 #include "target.h"
 #include "top.h"
 #include "gdb-demangle.h"
 #include "tui/tui.h"
 #include "tui/tui-data.h"
 #include "tui/tui-status.h"
 #include "tui/tui-wingeneral.h"
 #include "tui/tui-winsource.h"
 #include "tui/tui-location.h"

 #include "gdb_curses.h"

 static const std::string PROC_PREFIX = "In: ";
 static const std::string LINE_PREFIX = "L";
 static const std::string PC_PREFIX = "PC: ";

 /* Strings to display in the TUI status line.  */
 static const std::string SINGLE_KEY = "(SingleKey)";

 /* Minimum/Maximum length of some fields displayed in the TUI status
    line.  */
 #define MIN_LINE_WIDTH     4	/* Use at least 4 digits for line
 				   numbers.  */
 #define MIN_PROC_WIDTH    12
 #define MAX_TARGET_WIDTH  10
 #define MAX_PID_WIDTH     19


 std::string
 tui_status_window::make_status_line () const
 {
   char line_buf[50];
   int status_size;
   int proc_width;
   const char *pid_name;
   int target_width;
   int pid_width;
   int line_width;

   std::string pid_name_holder;
   if (inferior_ptid == null_ptid)
     pid_name = "No process";
   else
     {
       pid_name_holder = target_pid_to_str (inferior_ptid);
       pid_name = pid_name_holder.c_str ();
     }

   target_width = strlen (target_shortname ());
   if (target_width > MAX_TARGET_WIDTH)
     target_width = MAX_TARGET_WIDTH;

   pid_width = strlen (pid_name);
   if (pid_width > MAX_PID_WIDTH)
     pid_width = MAX_PID_WIDTH;

   status_size = width;

   /* Translate line number and obtain its size.  */
   int line_no = tui_location.line_no ();
   if (line_no > 0)
     xsnprintf (line_buf, sizeof (line_buf), "%d", line_no);
   else
     strcpy (line_buf, "??");
   line_width = strlen (line_buf);
   if (line_width < MIN_LINE_WIDTH)
     line_width = MIN_LINE_WIDTH;

   /* Translate PC address.  */
   struct gdbarch *gdbarch = tui_location.gdbarch ();
   CORE_ADDR addr = tui_location.addr ();
   std::string pc_out (gdbarch
 		      ? paddress (gdbarch, addr)
 		      : "??");
   const char *pc_buf = pc_out.c_str ();
   int pc_width = pc_out.size ();

   /* Width of the field showing the window with current focus.  For a window
      named "src" we show "(src)".  */
   int focus_width = (tui_win_with_focus () != nullptr
 		     ? 1 + strlen (tui_win_with_focus ()->name ()) + 1
 		     : 0);

   /* First determine the amount of proc name width we have available.
      The +1 are for a space separator between fields.  */
   proc_width = (status_size
 		- (target_width + 1)
 		- (pid_width + 1)
 		- (PROC_PREFIX.size () + 1)
 		- (LINE_PREFIX.size () + line_width + 1)
 		- (PC_PREFIX.size () + pc_width + 1)
 		- (tui_current_key_mode == TUI_SINGLE_KEY_MODE
 		   ? (SINGLE_KEY.size () + 1)
 		   : 0)
 		- (focus_width > 0
 		   ? focus_width + 1
 		   : 0));

   /* If there is no room to print the function name, try by removing
      some fields.  */
   if (proc_width < MIN_PROC_WIDTH)
     {
       proc_width += target_width + 1;
       target_width = 0;
       if (proc_width < MIN_PROC_WIDTH)
 	{
 	  proc_width += pid_width + 1;
 	  pid_width = 0;
 	  if (proc_width <= MIN_PROC_WIDTH)
 	    {
 	      proc_width += pc_width + PC_PREFIX.size () + 1;
 	      pc_width = 0;
 	      if (proc_width < 0)
 		{
 		  proc_width += line_width + LINE_PREFIX.size () + 1;
 		  line_width = 0;
 		  if (proc_width < 0)
 		    proc_width = 0;
 		}
 	    }
 	}
     }

   /* Now create the status line from the string version of the
      elements.  */
   string_file string;

   if (target_width > 0)
     string.printf ("%*.*s ", -target_width, target_width, target_shortname ());
   if (pid_width > 0)
     string.printf ("%*.*s ", -pid_width, pid_width, pid_name);

   /* Show whether we are in SingleKey mode.  */
   if (tui_current_key_mode == TUI_SINGLE_KEY_MODE)
     {
       string.puts (SINGLE_KEY.c_str ());
       string.puts (" ");
     }

   if (tui_win_with_focus () != nullptr)
     {
       string.puts ("(");
       string.puts (tui_win_with_focus ()->name ());
       string.puts (") ");
     }

   /* Procedure/class name.  */
   if (proc_width > 0)
     {
       const std::string &proc_name = tui_location.proc_name ();
       if (proc_name.size () > proc_width)
 	string.printf ("%s%*.*s* ", PROC_PREFIX.c_str (),
 		       1 - proc_width, proc_width - 1, proc_name.c_str ());
       else
 	string.printf ("%s%*.*s ", PROC_PREFIX.c_str (),
 		       -proc_width, proc_width, proc_name.c_str ());
     }

   if (line_width > 0)
     string.printf ("%s%*.*s ", LINE_PREFIX.c_str (),
 		   -line_width, line_width, line_buf);
   if (pc_width > 0)
     {
       string.puts (PC_PREFIX.c_str ());
       string.puts (pc_buf);
     }

   std::string string_val = string.release ();

   size_t len = string_val.size ();
   if (len < status_size)
     string_val.append (status_size - len, ' ');
   else if (len > status_size)
     string_val.erase (status_size, len);

   gdb_assert (string_val.size () == status_size);

   return string_val;
 }

 /* Get a printable name for the function at the address.  The symbol
    name is demangled if demangling is turned on.  Returns a pointer to
    a static area holding the result.  */
 static char*
 tui_get_function_from_frame (const frame_info_ptr &fi)
 {
   static char name[256];
   string_file stream;

   print_address_symbolic (get_frame_arch (fi), get_frame_pc (fi),
 			  &stream, demangle, "");

   /* Use simple heuristics to isolate the function name.  The symbol
      can be demangled and we can have function parameters.  Remove
      them because the status line is too short to display them.  */
   const char *d = stream.c_str ();
   if (*d == '<')
     d++;
   strncpy (name, d, sizeof (name) - 1);
   name[sizeof (name) - 1] = 0;

   char *p = strchr (name, '(');
   if (!p)
     p = strchr (name, '>');
   if (p)
     *p = 0;
   p = strchr (name, '+');
   if (p)
     *p = 0;
   return name;
 }

 void
 tui_status_window::rerender ()
 {
   gdb_assert (handle != NULL);

   std::string string = make_status_line ();
   scrollok (handle.get (), FALSE);
   wmove (handle.get (), 0, 0);
   /* We ignore the return value from wstandout and wstandend, casting them
      to void in order to avoid a compiler warning.  The warning itself was
      introduced by a patch to ncurses 5.7 dated 2009-08-29, changing these
      macro to expand to code that causes the compiler to generate an
      unused-value warning.  */
   (void) wstandout (handle.get ());
   waddstr (handle.get (), string.c_str ());
   wclrtoeol (handle.get ());
   (void) wstandend (handle.get ());
   refresh_window ();
   wmove (handle.get (), 0, 0);
 }

 /* Function to print the frame information for the TUI.  The windows
    are refreshed only if frame information has changed since the last
    refresh.  */

 void
 tui_show_frame_info (const frame_info_ptr &fi)
 {
   bool status_changed_p;

   if (fi != nullptr)
     {
       symtab_and_line sal = find_frame_sal (fi);

       const char *func_name;
       /* find_frame_sal does not always set PC, but we want to ensure
 	 that it is available in the SAL.  */
       if (get_frame_pc_if_available (fi, &sal.pc))
 	func_name = tui_get_function_from_frame (fi);
       else
 	func_name = _("<unavailable>");

       status_changed_p
 	= tui_location.set_location (get_frame_arch (fi), sal, func_name);

       /* If the status information has not changed, then frame information has
 	 not changed.  If frame information has not changed, then the windows'
 	 contents will not change.  So don't bother refreshing the windows.  */
       if (!status_changed_p)
 	return;

       for (struct tui_source_window_base *win_info : tui_source_windows ())
 	{
 	  win_info->maybe_update (fi, sal);
 	  win_info->update_exec_info ();
 	}
     }
   else
     {
       symtab_and_line sal {};

       status_changed_p = tui_location.set_location (NULL, sal, "");

       if (!status_changed_p)
 	return;

       for (struct tui_source_window_base *win_info : tui_source_windows ())
 	win_info->erase_source_content ();
     }
 }

 void
 tui_show_status_content ()
 {
   if (tui_is_window_visible (STATUS_WIN))
     tui_status_win ()->rerender ();
 }

 /* Command to update the display with the current execution point.  */
 static void
 tui_update_command (const char *arg, int from_tty)
 {
   execute_command ("frame 0", from_tty);
 }

 /* Function to initialize gdb commands, for tui window stack
    manipulation.  */

 void _initialize_tui_stack ();
 void
 _initialize_tui_stack ()
 {
   add_com ("update", class_tui, tui_update_command,
 	   _("\
 Update the source window to display the current execution point.\n\
 Usage: update"));
 }
	/* TUI status line.

	Copyright (C) 1998-2024 Free Software Foundation, Inc.

	Contributed by Hewlett-Packard Company.

	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 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	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, see <http://www.gnu.org/licenses/>. */

	#include "symtab.h"
	#include "frame.h"
	#include "command.h"
	#include "inferior.h"
	#include "target.h"
	#include "top.h"
	#include "gdb-demangle.h"
	#include "tui/tui.h"
	#include "tui/tui-data.h"
	#include "tui/tui-status.h"
	#include "tui/tui-wingeneral.h"
	#include "tui/tui-winsource.h"
	#include "tui/tui-location.h"

	#include "gdb_curses.h"

	static const std::string PROC_PREFIX = "In: ";
	static const std::string LINE_PREFIX = "L";
	static const std::string PC_PREFIX = "PC: ";

	/* Strings to display in the TUI status line. */
	static const std::string SINGLE_KEY = "(SingleKey)";

	/* Minimum/Maximum length of some fields displayed in the TUI status
	line. */
	#define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line
	numbers. */
	#define MIN_PROC_WIDTH 12
	#define MAX_TARGET_WIDTH 10
	#define MAX_PID_WIDTH 19



	std::string
	tui_status_window::make_status_line () const
	{
	char line_buf[50];
	int status_size;
	int proc_width;
	const char *pid_name;
	int target_width;
	int pid_width;
	int line_width;

	std::string pid_name_holder;
	if (inferior_ptid == null_ptid)
	pid_name = "No process";
	else
	{
	pid_name_holder = target_pid_to_str (inferior_ptid);
	pid_name = pid_name_holder.c_str ();
	}

	target_width = strlen (target_shortname ());
	if (target_width > MAX_TARGET_WIDTH)
	target_width = MAX_TARGET_WIDTH;

	pid_width = strlen (pid_name);
	if (pid_width > MAX_PID_WIDTH)
	pid_width = MAX_PID_WIDTH;

	status_size = width;

	/* Translate line number and obtain its size. */
	int line_no = tui_location.line_no ();
	if (line_no > 0)
	xsnprintf (line_buf, sizeof (line_buf), "%d", line_no);
	else
	strcpy (line_buf, "??");
	line_width = strlen (line_buf);
	if (line_width < MIN_LINE_WIDTH)
	line_width = MIN_LINE_WIDTH;

	/* Translate PC address. */
	struct gdbarch *gdbarch = tui_location.gdbarch ();
	CORE_ADDR addr = tui_location.addr ();
	std::string pc_out (gdbarch
	? paddress (gdbarch, addr)
	: "??");
	const char *pc_buf = pc_out.c_str ();
	int pc_width = pc_out.size ();

	/* Width of the field showing the window with current focus. For a window
	named "src" we show "(src)". */
	int focus_width = (tui_win_with_focus () != nullptr
	? 1 + strlen (tui_win_with_focus ()->name ()) + 1
	: 0);

	/* First determine the amount of proc name width we have available.
	The +1 are for a space separator between fields. */
	proc_width = (status_size
	- (target_width + 1)
	- (pid_width + 1)
	- (PROC_PREFIX.size () + 1)
	- (LINE_PREFIX.size () + line_width + 1)
	- (PC_PREFIX.size () + pc_width + 1)
	- (tui_current_key_mode == TUI_SINGLE_KEY_MODE
	? (SINGLE_KEY.size () + 1)
	: 0)
	- (focus_width > 0
	? focus_width + 1
	: 0));

	/* If there is no room to print the function name, try by removing
	some fields. */
	if (proc_width < MIN_PROC_WIDTH)
	{
	proc_width += target_width + 1;
	target_width = 0;
	if (proc_width < MIN_PROC_WIDTH)
	{
	proc_width += pid_width + 1;
	pid_width = 0;
	if (proc_width <= MIN_PROC_WIDTH)
	{
	proc_width += pc_width + PC_PREFIX.size () + 1;
	pc_width = 0;
	if (proc_width < 0)
	{
	proc_width += line_width + LINE_PREFIX.size () + 1;
	line_width = 0;
	if (proc_width < 0)
	proc_width = 0;
	}
	}
	}
	}

	/* Now create the status line from the string version of the
	elements. */
	string_file string;

	if (target_width > 0)
	string.printf ("%.s ", -target_width, target_width, target_shortname ());
	if (pid_width > 0)
	string.printf ("%.s ", -pid_width, pid_width, pid_name);

	/* Show whether we are in SingleKey mode. */
	if (tui_current_key_mode == TUI_SINGLE_KEY_MODE)
	{
	string.puts (SINGLE_KEY.c_str ());
	string.puts (" ");
	}

	if (tui_win_with_focus () != nullptr)
	{
	string.puts ("(");
	string.puts (tui_win_with_focus ()->name ());
	string.puts (") ");
	}

	/* Procedure/class name. */
	if (proc_width > 0)
	{
	const std::string &proc_name = tui_location.proc_name ();
	if (proc_name.size () > proc_width)
	string.printf ("%s%.s* ", PROC_PREFIX.c_str (),
	1 - proc_width, proc_width - 1, proc_name.c_str ());
	else
	string.printf ("%s%.s ", PROC_PREFIX.c_str (),
	-proc_width, proc_width, proc_name.c_str ());
	}

	if (line_width > 0)
	string.printf ("%s%.s ", LINE_PREFIX.c_str (),
	-line_width, line_width, line_buf);
	if (pc_width > 0)
	{
	string.puts (PC_PREFIX.c_str ());
	string.puts (pc_buf);
	}

	std::string string_val = string.release ();

	size_t len = string_val.size ();
	if (len < status_size)
	string_val.append (status_size - len, ' ');
	else if (len > status_size)
	string_val.erase (status_size, len);

	gdb_assert (string_val.size () == status_size);

	return string_val;
	}

	/* Get a printable name for the function at the address. The symbol
	name is demangled if demangling is turned on. Returns a pointer to
	a static area holding the result. */
	static char*
	tui_get_function_from_frame (const frame_info_ptr &fi)
	{
	static char name[256];
	string_file stream;

	print_address_symbolic (get_frame_arch (fi), get_frame_pc (fi),
	&stream, demangle, "");

	/* Use simple heuristics to isolate the function name. The symbol
	can be demangled and we can have function parameters. Remove
	them because the status line is too short to display them. */
	const char *d = stream.c_str ();
	if (*d == '<')
	d++;
	strncpy (name, d, sizeof (name) - 1);
	name[sizeof (name) - 1] = 0;

	char *p = strchr (name, '(');
	if (!p)
	p = strchr (name, '>');
	if (p)
	*p = 0;
	p = strchr (name, '+');
	if (p)
	*p = 0;
	return name;
	}

	void
	tui_status_window::rerender ()
	{
	gdb_assert (handle != NULL);

	std::string string = make_status_line ();
	scrollok (handle.get (), FALSE);
	wmove (handle.get (), 0, 0);
	/* We ignore the return value from wstandout and wstandend, casting them
	to void in order to avoid a compiler warning. The warning itself was
	introduced by a patch to ncurses 5.7 dated 2009-08-29, changing these
	macro to expand to code that causes the compiler to generate an
	unused-value warning. */
	(void) wstandout (handle.get ());
	waddstr (handle.get (), string.c_str ());
	wclrtoeol (handle.get ());
	(void) wstandend (handle.get ());
	refresh_window ();
	wmove (handle.get (), 0, 0);
	}

	/* Function to print the frame information for the TUI. The windows
	are refreshed only if frame information has changed since the last
	refresh. */

	void
	tui_show_frame_info (const frame_info_ptr &fi)
	{
	bool status_changed_p;

	if (fi != nullptr)
	{
	symtab_and_line sal = find_frame_sal (fi);

	const char *func_name;
	/* find_frame_sal does not always set PC, but we want to ensure
	that it is available in the SAL. */
	if (get_frame_pc_if_available (fi, &sal.pc))
	func_name = tui_get_function_from_frame (fi);
	else
	func_name = _("<unavailable>");

	status_changed_p
	= tui_location.set_location (get_frame_arch (fi), sal, func_name);

	/* If the status information has not changed, then frame information has
	not changed. If frame information has not changed, then the windows'
	contents will not change. So don't bother refreshing the windows. */
	if (!status_changed_p)
	return;

	for (struct tui_source_window_base *win_info : tui_source_windows ())
	{
	win_info->maybe_update (fi, sal);
	win_info->update_exec_info ();
	}
	}
	else
	{
	symtab_and_line sal {};

	status_changed_p = tui_location.set_location (NULL, sal, "");

	if (!status_changed_p)
	return;

	for (struct tui_source_window_base *win_info : tui_source_windows ())
	win_info->erase_source_content ();
	}
	}

	void
	tui_show_status_content ()
	{
	if (tui_is_window_visible (STATUS_WIN))
	tui_status_win ()->rerender ();
	}

	/* Command to update the display with the current execution point. */
	static void
	tui_update_command (const char *arg, int from_tty)
	{
	execute_command ("frame 0", from_tty);
	}

	/* Function to initialize gdb commands, for tui window stack
	manipulation. */

	void _initialize_tui_stack ();
	void
	_initialize_tui_stack ()
	{
	add_com ("update", class_tui, tui_update_command,
	_("\
	Update the source window to display the current execution point.\n\
	Usage: update"));
	}