5f99e0d4b9
When you run lldb without colors (`-X`), the status line looks weird because it doesn't have a background. You end up with what appears to be floating text at the bottom of your terminal. This patch changes the statusline to use the reverse video effect, even when colors are off. The effect doesn't introduce any new colors and just inverts the foreground and background color. I considered an alternative approach which changes the behavior of the `-X` option, so that turning off colors doesn't prevent emitting non-color related control characters such as bold, underline, and reverse video. I decided to go with this more targeted fix as (1) nobody is asking for this more general change and (2) it introduces significant complexity to plumb this through using a setting and driver flag so that it can be disabled when running the tests. Fixes #134112.
148 lines
4.5 KiB
C++
148 lines
4.5 KiB
C++
//===-- Statusline.cpp ---------------------------------------------------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "lldb/Core/Statusline.h"
|
|
#include "lldb/Core/Debugger.h"
|
|
#include "lldb/Core/FormatEntity.h"
|
|
#include "lldb/Host/StreamFile.h"
|
|
#include "lldb/Interpreter/CommandInterpreter.h"
|
|
#include "lldb/Symbol/SymbolContext.h"
|
|
#include "lldb/Target/StackFrame.h"
|
|
#include "lldb/Utility/AnsiTerminal.h"
|
|
#include "lldb/Utility/StreamString.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/Support/Locale.h"
|
|
|
|
#define ESCAPE "\x1b"
|
|
#define ANSI_NORMAL ESCAPE "[0m"
|
|
#define ANSI_SAVE_CURSOR ESCAPE "7"
|
|
#define ANSI_RESTORE_CURSOR ESCAPE "8"
|
|
#define ANSI_CLEAR_BELOW ESCAPE "[J"
|
|
#define ANSI_CURSOR_DOWN ESCAPE "[B"
|
|
#define ANSI_CLEAR_LINE ESCAPE "[2K"
|
|
#define ANSI_SET_SCROLL_ROWS ESCAPE "[0;%ur"
|
|
#define ANSI_TO_START_OF_ROW ESCAPE "[%u;0f"
|
|
#define ANSI_REVERSE_VIDEO ESCAPE "[7m"
|
|
#define ANSI_UP_ROWS ESCAPE "[%dA"
|
|
|
|
using namespace lldb;
|
|
using namespace lldb_private;
|
|
|
|
Statusline::Statusline(Debugger &debugger)
|
|
: m_debugger(debugger), m_terminal_width(m_debugger.GetTerminalWidth()),
|
|
m_terminal_height(m_debugger.GetTerminalHeight()) {
|
|
Enable();
|
|
}
|
|
|
|
Statusline::~Statusline() { Disable(); }
|
|
|
|
void Statusline::TerminalSizeChanged() {
|
|
UpdateTerminalProperties();
|
|
|
|
// This definitely isn't signal safe, but the best we can do, until we
|
|
// have proper signal-catching thread.
|
|
Redraw(/*update=*/false);
|
|
}
|
|
|
|
void Statusline::Enable() {
|
|
// Reduce the scroll window to make space for the status bar below.
|
|
UpdateScrollWindow(EnableStatusline);
|
|
|
|
// Draw the statusline.
|
|
Redraw(/*update=*/true);
|
|
}
|
|
|
|
void Statusline::Disable() {
|
|
// Extend the scroll window to cover the status bar.
|
|
UpdateScrollWindow(DisableStatusline);
|
|
}
|
|
|
|
void Statusline::Draw(std::string str) {
|
|
lldb::LockableStreamFileSP stream_sp = m_debugger.GetOutputStreamSP();
|
|
if (!stream_sp)
|
|
return;
|
|
|
|
m_last_str = str;
|
|
|
|
str = ansi::TrimAndPad(str, m_terminal_width);
|
|
|
|
LockedStreamFile locked_stream = stream_sp->Lock();
|
|
locked_stream << ANSI_SAVE_CURSOR;
|
|
locked_stream.Printf(ANSI_TO_START_OF_ROW,
|
|
static_cast<unsigned>(m_terminal_height));
|
|
|
|
// Use "reverse video" to make sure the statusline has a background. Only do
|
|
// this when colors are disabled, and rely on the statusline format otherwise.
|
|
if (!m_debugger.GetUseColor())
|
|
locked_stream << ANSI_REVERSE_VIDEO;
|
|
|
|
locked_stream << str;
|
|
locked_stream << ANSI_NORMAL;
|
|
locked_stream << ANSI_RESTORE_CURSOR;
|
|
}
|
|
|
|
void Statusline::UpdateTerminalProperties() {
|
|
UpdateScrollWindow(DisableStatusline);
|
|
m_terminal_width = m_debugger.GetTerminalWidth();
|
|
m_terminal_height = m_debugger.GetTerminalHeight();
|
|
UpdateScrollWindow(EnableStatusline);
|
|
}
|
|
|
|
void Statusline::UpdateScrollWindow(ScrollWindowMode mode) {
|
|
assert(m_terminal_width != 0 && m_terminal_height != 0);
|
|
|
|
lldb::LockableStreamFileSP stream_sp = m_debugger.GetOutputStreamSP();
|
|
if (!stream_sp)
|
|
return;
|
|
|
|
const unsigned scroll_height =
|
|
(mode == DisableStatusline) ? m_terminal_height : m_terminal_height - 1;
|
|
|
|
LockedStreamFile locked_stream = stream_sp->Lock();
|
|
locked_stream << ANSI_SAVE_CURSOR;
|
|
locked_stream.Printf(ANSI_SET_SCROLL_ROWS, scroll_height);
|
|
locked_stream << ANSI_RESTORE_CURSOR;
|
|
switch (mode) {
|
|
case EnableStatusline:
|
|
// Move everything on the screen up.
|
|
locked_stream.Printf(ANSI_UP_ROWS, 1);
|
|
locked_stream << '\n';
|
|
break;
|
|
case DisableStatusline:
|
|
// Clear the screen below to hide the old statusline.
|
|
locked_stream << ANSI_CLEAR_BELOW;
|
|
break;
|
|
}
|
|
}
|
|
|
|
void Statusline::Redraw(bool update) {
|
|
if (!update) {
|
|
Draw(m_last_str);
|
|
return;
|
|
}
|
|
|
|
StreamString stream;
|
|
ExecutionContext exe_ctx =
|
|
m_debugger.GetCommandInterpreter().GetExecutionContext();
|
|
|
|
// For colors and progress events, the format entity needs access to the
|
|
// debugger, which requires a target in the execution context.
|
|
if (!exe_ctx.HasTargetScope())
|
|
exe_ctx.SetTargetPtr(&m_debugger.GetSelectedOrDummyTarget());
|
|
|
|
SymbolContext symbol_ctx;
|
|
if (auto frame_sp = exe_ctx.GetFrameSP())
|
|
symbol_ctx = frame_sp->GetSymbolContext(eSymbolContextEverything);
|
|
|
|
if (auto *format = m_debugger.GetStatuslineFormat())
|
|
FormatEntity::Format(*format, stream, &symbol_ctx, &exe_ctx, nullptr,
|
|
nullptr, false, false);
|
|
|
|
Draw(std::string(stream.GetString()));
|
|
}
|