binutils-gdb/gdb/tui/tui-wingeneral.c
Andrew Burgess a6924ac89d gdb: make cli_styling static within cli/cli-style.c
The cli_styling variable is controlled by 'set style enabled on|off'
user setting, and is currently globally visible.

In a couple of places we access this variable directly, though in
ui-file.c the accesses are all performed through term_cli_styling(),
which is a function that wraps checking cli_styling along with a check
that GDB's terminal supports styling.

In a future commit, I'd plan to add a new parameter to gdb.execute()
which will allow styling to be temporarily suppressed.  In an earlier
proposal, I made gdb.execute() disable styling by changing the value
of cli_styling, however, this approach has a problem.

If gdb.execute() is used to run 'show style enabled', the changing
cli_styling will change what is printed.  Similarly, if gdb.execute()
is used to execute 'set style enabled on|off' then having
gdb.execute() save and restore the value of cli_styling will undo the
adjustment from 'set style enabled ...'.

So what I plan to do in the future, is add a new control flag which
can be used to temporarily disable styling.

To make this new control variable easier to add, lets force everyone
to call term_cli_styling() to check if styling is enabled or not.  To
force everyone to use term_cli_styling() this commit makes cli_styling
static within gdb/cli/cli-style.c.

Approved-By: Tom Tromey <tom@tromey.com>
2025-03-17 16:59:13 +00:00

178 lines
4.1 KiB
C

/* General window behavior.
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 "tui/tui-data.h"
#include "tui/tui-io.h"
#include "tui/tui-wingeneral.h"
#include "tui/tui-win.h"
#include "cli/cli-style.h"
#include "gdb_curses.h"
/* This is true when there is a live instance of tui_batch_rendering.
The outermost tui_batch_rendering will cause a flush to the
screen. */
static bool suppress_output;
/* See tui-data.h. */
tui_batch_rendering::tui_batch_rendering ()
: m_saved_suppress (suppress_output)
{
suppress_output = true;
}
/* See tui-data.h. */
tui_batch_rendering::~tui_batch_rendering ()
{
suppress_output = m_saved_suppress;
if (!suppress_output)
doupdate ();
}
/* See tui-data.h. */
void
tui_win_info::refresh_window ()
{
if (handle != NULL)
{
if (suppress_output)
wnoutrefresh (handle.get ());
else
wrefresh (handle.get ());
}
}
/* Draw a border around the window. */
static void
box_win (struct tui_win_info *win_info,
bool highlight_flag)
{
WINDOW *win;
int attrs;
win = win_info->handle.get ();
if (highlight_flag)
attrs = tui_active_border_attrs;
else
attrs = tui_border_attrs;
/* tui_apply_style resets the style entirely, so be sure to call it
before applying ATTRS. */
if (term_cli_styling ())
tui_apply_style (win, (highlight_flag
? tui_active_border_style.style ()
: tui_border_style.style ()));
wattron (win, attrs);
wborder (win, tui_border_vline, tui_border_vline,
tui_border_hline, tui_border_hline,
tui_border_ulcorner, tui_border_urcorner,
tui_border_llcorner, tui_border_lrcorner);
if (!win_info->title ().empty ())
{
/* Emit "+-TITLE-+" -- so 2 characters on the right and 2 on
the left. */
int max_len = win_info->width - win_info->box_size () - 2;
if (win_info->title ().size () <= max_len)
mvwaddstr (win, 0, 2, win_info->title ().c_str ());
else
{
std::string truncated
= "..." + win_info->title ().substr (win_info->title ().size ()
- max_len + 3);
mvwaddstr (win, 0, 2, truncated.c_str ());
}
}
wattroff (win, attrs);
tui_apply_style (win, ui_file_style ());
}
void
tui_unhighlight_win (struct tui_win_info *win_info)
{
if (win_info != NULL
&& win_info->can_box ()
&& win_info->handle != NULL)
{
box_win (win_info, false);
win_info->refresh_window ();
win_info->set_highlight (false);
}
}
void
tui_highlight_win (struct tui_win_info *win_info)
{
if (win_info != NULL
&& win_info->can_box ()
&& win_info->handle != NULL)
{
box_win (win_info, true);
win_info->refresh_window ();
win_info->set_highlight (true);
}
}
void
tui_win_info::check_and_display_highlight_if_needed ()
{
if (can_box ())
{
if (is_highlighted)
tui_highlight_win (this);
else
tui_unhighlight_win (this);
}
}
void
tui_win_info::make_window ()
{
handle.reset (newwin (height, width, y, x));
if (handle != NULL)
{
scrollok (handle.get (), TRUE);
if (can_box ())
box_win (this, false);
}
}
/* We can't really make windows visible, or invisible. So we have to
delete the entire window when making it invisible, and create it
again when making it visible. */
void
tui_win_info::make_visible (bool visible)
{
if (is_visible () == visible)
return;
if (visible)
make_window ();
else
handle.reset (nullptr);
}