forked from Imagelibrary/binutils-gdb
e5348a7ab3
Currently, gdb.execute emits styled output when the command is sending its output to GDB's stdout, and produces unstyled output when the output is going to a string. But it is not unreasonable that a user might wish to capture styled output from a gdb.execute call, for example, the user might want to display the styled output are part of some larger UI output block. At the same time, I don't think it makes sense to always produce styled output when capturing the output in a string; if what the user wants is to parse the output, then the style escape sequences make this far harder. I propose that gdb.execute gain a new argument 'styling'. When False we would always produce unstyled output, and when True we would produce styled output if styling is not disabled by some other means. For example, if GDB's 'set style enabled' is off, then I think gdb.execute() should respect that. My assumption here is that gdb.execute() might be executed by some extension. If the extension thinks "styled output world work here", but the user hates styled output, and has turned it off, then the extension should not be forcing styled output on the user. I chose 'styling' instead of 'styled' as the Python argument name because we already use 'styling' in gdb.Value.format_string, and we don't use 'styled' anywhere else. This is only a little bit of consistency, but I still think it's a good thing. The default for 'styling' will change depending on where the output is going. When gdb.execute is sending the output to GDB's stdout then the default for 'styling' is True. When the output is going to a string, then the default for 'styling' will be False. Not only does this match the existing behaviour, but I think this makes sense. By default we assume that output captured in a string is going to be parsed, and therefore styling markup is unhelpful, while output going to stdout should receive styling. This fixes part of the problem described in PR gdb/32676. That bug tries to capture styled source listing in a string, which wasn't previously possible. There are some additional issues with capturing source code; GDB caches the source code in the source code cache. However, GDB doesn't check if the cached content is styled or not. As a consequence, if the first time the source of a file is shown it is unstyled, then the cached will hold the unstyled source code, and future requests will return that unstyled source. I'll address this issue in a separate patch. Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=32676 Approved-By: Tom Tromey <tom@tromey.com>
194 lines
6.3 KiB
C++
194 lines
6.3 KiB
C++
/* CLI stylizing
|
|
|
|
Copyright (C) 2018-2024 Free Software Foundation, Inc.
|
|
|
|
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/>. */
|
|
|
|
#ifndef GDB_CLI_CLI_STYLE_H
|
|
#define GDB_CLI_CLI_STYLE_H
|
|
|
|
#include "ui-file.h"
|
|
#include "command.h"
|
|
#include "gdbsupport/observable.h"
|
|
|
|
/* A single CLI style option. */
|
|
class cli_style_option
|
|
{
|
|
public:
|
|
|
|
/* Construct a CLI style option with a foreground color. */
|
|
cli_style_option (const char *name, ui_file_style::basic_color fg,
|
|
ui_file_style::intensity = ui_file_style::NORMAL);
|
|
|
|
/* Construct a CLI style option with an intensity. */
|
|
cli_style_option (const char *name, ui_file_style::intensity i);
|
|
|
|
/* Return a ui_file_style corresponding to the settings in this CLI
|
|
style. */
|
|
ui_file_style style () const;
|
|
|
|
/* Return the style name. */
|
|
const char *name () { return m_name; };
|
|
|
|
/* Call once to register this CLI style with the CLI engine. Returns
|
|
the set/show prefix commands for the style. */
|
|
set_show_commands add_setshow_commands (enum command_class theclass,
|
|
const char *prefix_doc,
|
|
struct cmd_list_element **set_list,
|
|
struct cmd_list_element **show_list,
|
|
bool skip_intensity);
|
|
|
|
/* Return the 'set style NAME' command list, that can be used
|
|
to build a lambda DO_SET to call add_setshow_commands. */
|
|
struct cmd_list_element *set_list () { return m_set_list; };
|
|
|
|
/* Same as SET_LIST but for the show command list. */
|
|
struct cmd_list_element *show_list () { return m_show_list; };
|
|
|
|
/* This style can be observed for any changes. */
|
|
gdb::observers::observable<> changed;
|
|
|
|
private:
|
|
|
|
/* The style name. */
|
|
const char *m_name;
|
|
|
|
/* The foreground. */
|
|
ui_file_style::color m_foreground;
|
|
/* The background. */
|
|
ui_file_style::color m_background;
|
|
/* The intensity. */
|
|
const char *m_intensity;
|
|
|
|
/* Storage for command lists needed when registering
|
|
subcommands. */
|
|
struct cmd_list_element *m_set_list = nullptr;
|
|
struct cmd_list_element *m_show_list = nullptr;
|
|
|
|
/* Callback to notify the observable. */
|
|
static void do_set_value (const char *ignore, int from_tty,
|
|
struct cmd_list_element *cmd);
|
|
|
|
/* Callback to show the foreground. */
|
|
static void do_show_foreground (struct ui_file *file, int from_tty,
|
|
struct cmd_list_element *cmd,
|
|
const char *value);
|
|
/* Callback to show the background. */
|
|
static void do_show_background (struct ui_file *file, int from_tty,
|
|
struct cmd_list_element *cmd,
|
|
const char *value);
|
|
/* Callback to show the intensity. */
|
|
static void do_show_intensity (struct ui_file *file, int from_tty,
|
|
struct cmd_list_element *cmd,
|
|
const char *value);
|
|
};
|
|
|
|
/* Chains containing all defined "set/show style" subcommands. */
|
|
extern struct cmd_list_element *style_set_list;
|
|
extern struct cmd_list_element *style_show_list;
|
|
|
|
/* The file name style. */
|
|
extern cli_style_option file_name_style;
|
|
|
|
/* The function name style. */
|
|
extern cli_style_option function_name_style;
|
|
|
|
/* The variable name style. */
|
|
extern cli_style_option variable_name_style;
|
|
|
|
/* The address style. */
|
|
extern cli_style_option address_style;
|
|
|
|
/* The highlight style. */
|
|
extern cli_style_option highlight_style;
|
|
|
|
/* The title style. */
|
|
extern cli_style_option title_style;
|
|
|
|
/* Style used for commands. */
|
|
extern cli_style_option command_style;
|
|
|
|
/* The metadata style. */
|
|
extern cli_style_option metadata_style;
|
|
|
|
/* The disassembler style for mnemonics or assembler directives
|
|
(e.g. '.byte', etc). */
|
|
extern cli_style_option disasm_mnemonic_style;
|
|
|
|
/* The disassembler style for register names. */
|
|
extern cli_style_option disasm_register_style;
|
|
|
|
/* The disassembler style for numerical values that are not addresses, this
|
|
includes immediate operands (e.g. in, an add instruction), but also
|
|
address offsets (e.g. in a load instruction). */
|
|
extern cli_style_option disasm_immediate_style;
|
|
|
|
/* The disassembler style for comments. */
|
|
extern cli_style_option disasm_comment_style;
|
|
|
|
/* The border style of a TUI window that does not have the focus. */
|
|
extern cli_style_option tui_border_style;
|
|
|
|
/* The border style of a TUI window that does have the focus. */
|
|
extern cli_style_option tui_active_border_style;
|
|
|
|
/* The style to use for the GDB version string. */
|
|
extern cli_style_option version_style;
|
|
|
|
/* The style for a line number. */
|
|
extern cli_style_option line_number_style;
|
|
|
|
/* True if source styling is enabled. */
|
|
extern bool source_styling;
|
|
|
|
/* True if disassembler styling is enabled. */
|
|
extern bool disassembler_styling;
|
|
|
|
/* Check for environment variables that indicate styling should start as
|
|
disabled. If any are found then disable styling. Styling is never
|
|
enabled by this call. If styling was already disabled then it remains
|
|
disabled after this call. */
|
|
extern void disable_styling_from_environment ();
|
|
|
|
/* Equivalent to 'set style enabled off'. Can be used during GDB's start
|
|
up if a command line option, or environment variable, indicates that
|
|
styling should be turned off. */
|
|
extern void disable_cli_styling ();
|
|
|
|
/* Return true styled output is currently enabled. */
|
|
extern bool term_cli_styling ();
|
|
|
|
/* Allow styling to be temporarily suppressed without changing the value of
|
|
'set style enabled' user setting. This is useful in, for example, the
|
|
Python gdb.execute() call which can produce unstyled output. */
|
|
struct scoped_disable_styling
|
|
{
|
|
/* Temporarily suppress styling without changing the value of 'set
|
|
style enabled' user setting. */
|
|
scoped_disable_styling ();
|
|
|
|
/* If the constructor started suppressing styling, then styling is
|
|
resumed after this destructor call. */
|
|
~scoped_disable_styling ();
|
|
|
|
private:
|
|
|
|
/* The value to restore in the destructor. */
|
|
bool m_old_value;
|
|
};
|
|
|
|
#endif /* GDB_CLI_CLI_STYLE_H */
|