mirror of
https://sourceware.org/git/binutils-gdb.git
synced 2026-08-27 00:26:02 -04:00
0391f70c7d
While working on this series, I found a number of odd styling issues recurred. For instance, the issue where the pager would lose track and style subsequent output incorrectly reappeared. It turned out that different ui_file objects in the output pipeline would get confused about their current style. And, looking deeper at this, I realized that mainly it is the pager that really needs to track the current style at all. All the other file implementations can be purely reactive (except the buffered stream code, as Andrew pointed out). This patch moves m_applied_style from ui_file and into pager_file. This necessitated making ui_file::vprintf virtual, so that the base class could pass in the "plain" style as the starting point, whereas the pager could use the applied style. (I did not investigate whether this was truly necessary, and I somewhat suspect it might not be.) This straightforward approach caused some regressions, mostly involving extra ANSI escapes being emitted. I fixed most of these by arranging for ui_out::call_do_message to track styles a little more thoroughly. Co-Authored-By: Andrew Burgess <aburgess@redhat.com> Approved-By: Andrew Burgess <aburgess@redhat.com>
115 lines
3.5 KiB
C++
115 lines
3.5 KiB
C++
/* Output pager for gdb
|
|
Copyright (C) 2021-2026 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_PAGER_H
|
|
#define GDB_PAGER_H
|
|
|
|
#include "ui-file.h"
|
|
|
|
/* A ui_file that implements output paging and unfiltered output. */
|
|
|
|
class pager_file : public wrapped_file<ui_file_up>
|
|
{
|
|
public:
|
|
/* Create a new pager_file. The new object takes ownership of
|
|
STREAM. */
|
|
explicit pager_file (ui_file_up stream)
|
|
: wrapped_file (std::move (stream))
|
|
{
|
|
}
|
|
|
|
DISABLE_COPY_AND_ASSIGN (pager_file);
|
|
|
|
void write (const char *buf, long length_buf) override;
|
|
|
|
void puts (const char *str) override;
|
|
|
|
void emit_style_escape (const ui_file_style &style) override;
|
|
|
|
void flush () override;
|
|
|
|
void wrap_here (int indent) override;
|
|
|
|
void puts_unfiltered (const char *str) override
|
|
{
|
|
flush_wrap_buffer ();
|
|
m_stream->puts_unfiltered (str);
|
|
}
|
|
|
|
void vprintf (const char *fmt, va_list args) override
|
|
ATTRIBUTE_PRINTF (2, 0);
|
|
|
|
private:
|
|
|
|
void prompt_for_continue ();
|
|
|
|
/* Check if enough characters have been printed such that the current
|
|
output line is full. If this is the case then reset the characters
|
|
printed count to zero, and increment the lines printed count. Call
|
|
prompt_for_continue if the screen is now full.
|
|
|
|
This should only be called at the point where we want to add new
|
|
printable output to the output stream, this defers triggering
|
|
pagination until we really need the additional screen space.
|
|
|
|
LINES_ALLOWED is the number of lines that can be printed before the
|
|
pager needs to activate. */
|
|
void check_for_overfull_line (const unsigned int lines_allowed);
|
|
|
|
/* Flush the wrap buffer to STREAM, if necessary. */
|
|
void flush_wrap_buffer ();
|
|
|
|
/* Set the style of m_stream to STYLE. */
|
|
void set_stream_style (const ui_file_style &style)
|
|
{
|
|
if (m_stream->can_emit_style_escape () && m_stream_style != style)
|
|
{
|
|
m_stream->puts (style.to_ansi ().c_str ());
|
|
m_stream_style = style;
|
|
}
|
|
}
|
|
|
|
/* Contains characters which are waiting to be output (they have
|
|
already been counted in chars_printed). */
|
|
std::string m_wrap_buffer;
|
|
|
|
/* Amount to indent by if the wrap occurs. */
|
|
int m_wrap_indent = 0;
|
|
|
|
/* Column number on the screen where wrap_buffer begins, or 0 if
|
|
wrapping is not in effect. */
|
|
int m_wrap_column = 0;
|
|
|
|
/* The currently applied style. */
|
|
ui_file_style m_applied_style;
|
|
|
|
/* The style applied at the time that wrap_here was called. */
|
|
ui_file_style m_wrap_style;
|
|
|
|
/* The style currently applied to m_stream. While m_applied_style is the
|
|
style that is applied to new content added to m_wrap_buffer, the
|
|
m_stream_style reflects changes that have been flushed to the managed
|
|
stream. */
|
|
ui_file_style m_stream_style;
|
|
|
|
/* This is temporarily set when paging. This will cause some
|
|
methods to change their behavior to ignore the wrap buffer. */
|
|
bool m_paging = false;
|
|
};
|
|
|
|
#endif /* GDB_PAGER_H */
|