Skip to content

Commit 64e1991

Browse files
[lldb] improve the heuristics for checking if a terminal supports Unicode (#168603)
This patch improves the way lldb checks if the terminal it's opened in (if any) supports Unicode or not. On POSIX systems, we check if `LANG` contains `UTF-8`. On Windows, we always return `true` since we use the `WriteToConsoleW` api.
1 parent 4424a58 commit 64e1991

File tree

3 files changed

+30
-5
lines changed

3 files changed

+30
-5
lines changed

lldb/include/lldb/Host/Terminal.h

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,18 @@ class Terminal {
6868

6969
llvm::Error SetHardwareFlowControl(bool enabled);
7070

71+
/// Returns whether or not the current terminal supports Unicode rendering.
72+
///
73+
/// The value is cached after the first computation.
74+
///
75+
/// On POSIX systems, we check if the LANG environment variable contains the
76+
/// substring "UTF-8", case insensitive.
77+
///
78+
/// On Windows, we always return true since we use the `WriteConsoleW` API
79+
/// internally. Note that the default Windows codepage (437) does not support
80+
/// all Unicode characters. This function does not check the codepage.
81+
static bool SupportsUnicode();
82+
7183
protected:
7284
struct Data;
7385

lldb/source/Host/common/DiagnosticsRendering.cpp

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
//===----------------------------------------------------------------------===//
88

99
#include "lldb/Host/common/DiagnosticsRendering.h"
10+
#include "lldb/Host/Terminal.h"
11+
1012
#include <cstdint>
1113

1214
using namespace lldb_private;
@@ -97,12 +99,8 @@ void RenderDiagnosticDetails(Stream &stream,
9799
return;
98100
}
99101

100-
// Since there is no other way to find this out, use the color
101-
// attribute as a proxy for whether the terminal supports Unicode
102-
// characters. In the future it might make sense to move this into
103-
// Host so it can be customized for a specific platform.
104102
llvm::StringRef cursor, underline, vbar, joint, hbar, spacer;
105-
if (stream.AsRawOstream().colors_enabled()) {
103+
if (Terminal::SupportsUnicode()) {
106104
cursor = "˄";
107105
underline = "˜";
108106
vbar = "";

lldb/source/Host/common/Terminal.cpp

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -400,6 +400,21 @@ llvm::Error Terminal::SetHardwareFlowControl(bool enabled) {
400400
#endif // LLDB_ENABLE_TERMIOS
401401
}
402402

403+
bool Terminal::SupportsUnicode() {
404+
static std::optional<bool> result;
405+
if (result)
406+
return result.value();
407+
#ifdef _WIN32
408+
return true;
409+
#else
410+
const char *lang_var = std::getenv("LANG");
411+
if (!lang_var)
412+
return false;
413+
result = llvm::StringRef(lang_var).lower().find("utf-8") != std::string::npos;
414+
#endif
415+
return result.value();
416+
}
417+
403418
TerminalState::TerminalState(Terminal term, bool save_process_group)
404419
: m_tty(term) {
405420
Save(term, save_process_group);

0 commit comments

Comments
 (0)