1*0b57cec5SDimitry Andric //===-- Highlighter.cpp ---------------------------------------------------===//
2*0b57cec5SDimitry Andric //
3*0b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*0b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
5*0b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*0b57cec5SDimitry Andric //
7*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
8*0b57cec5SDimitry Andric 
9*0b57cec5SDimitry Andric #include "lldb/Core/Highlighter.h"
10*0b57cec5SDimitry Andric 
11*0b57cec5SDimitry Andric #include "lldb/Target/Language.h"
12*0b57cec5SDimitry Andric #include "lldb/Utility/AnsiTerminal.h"
13*0b57cec5SDimitry Andric #include "lldb/Utility/StreamString.h"
14*0b57cec5SDimitry Andric #include <optional>
15*0b57cec5SDimitry Andric 
16*0b57cec5SDimitry Andric using namespace lldb_private;
17*0b57cec5SDimitry Andric using namespace lldb_private::ansi;
18*0b57cec5SDimitry Andric 
Apply(Stream & s,llvm::StringRef value) const19*0b57cec5SDimitry Andric void HighlightStyle::ColorStyle::Apply(Stream &s, llvm::StringRef value) const {
20*0b57cec5SDimitry Andric   s << m_prefix << value << m_suffix;
21*0b57cec5SDimitry Andric }
22*0b57cec5SDimitry Andric 
Set(llvm::StringRef prefix,llvm::StringRef suffix)23*0b57cec5SDimitry Andric void HighlightStyle::ColorStyle::Set(llvm::StringRef prefix,
24*0b57cec5SDimitry Andric                                      llvm::StringRef suffix) {
25*0b57cec5SDimitry Andric   m_prefix = FormatAnsiTerminalCodes(prefix);
26*0b57cec5SDimitry Andric   m_suffix = FormatAnsiTerminalCodes(suffix);
27*0b57cec5SDimitry Andric }
28*0b57cec5SDimitry Andric 
Highlight(const HighlightStyle & options,llvm::StringRef line,std::optional<size_t> cursor_pos,llvm::StringRef previous_lines,Stream & s) const29*0b57cec5SDimitry Andric void DefaultHighlighter::Highlight(const HighlightStyle &options,
30*0b57cec5SDimitry Andric                                    llvm::StringRef line,
31*0b57cec5SDimitry Andric                                    std::optional<size_t> cursor_pos,
32*0b57cec5SDimitry Andric                                    llvm::StringRef previous_lines,
33*0b57cec5SDimitry Andric                                    Stream &s) const {
34*0b57cec5SDimitry Andric   // If we don't have a valid cursor, then we just print the line as-is.
35*0b57cec5SDimitry Andric   if (!cursor_pos || *cursor_pos >= line.size()) {
36*0b57cec5SDimitry Andric     s << line;
37*0b57cec5SDimitry Andric     return;
38*0b57cec5SDimitry Andric   }
39*0b57cec5SDimitry Andric 
40*0b57cec5SDimitry Andric   // If we have a valid cursor, we have to apply the 'selected' style around
41*0b57cec5SDimitry Andric   // the character below the cursor.
42*0b57cec5SDimitry Andric 
43*0b57cec5SDimitry Andric   // Split the line around the character which is below the cursor.
44*0b57cec5SDimitry Andric   size_t column = *cursor_pos;
45*0b57cec5SDimitry Andric   // Print the characters before the cursor.
46*0b57cec5SDimitry Andric   s << line.substr(0, column);
47*0b57cec5SDimitry Andric   // Print the selected character with the defined color codes.
48*0b57cec5SDimitry Andric   options.selected.Apply(s, line.substr(column, 1));
49*0b57cec5SDimitry Andric   // Print the rest of the line.
50*0b57cec5SDimitry Andric   s << line.substr(column + 1U);
51*0b57cec5SDimitry Andric }
52*0b57cec5SDimitry Andric 
GetColor(const char * c)53*0b57cec5SDimitry Andric static HighlightStyle::ColorStyle GetColor(const char *c) {
54*0b57cec5SDimitry Andric   return HighlightStyle::ColorStyle(c, "${ansi.normal}");
55*0b57cec5SDimitry Andric }
56*0b57cec5SDimitry Andric 
MakeVimStyle()57*0b57cec5SDimitry Andric HighlightStyle HighlightStyle::MakeVimStyle() {
58*0b57cec5SDimitry Andric   HighlightStyle result;
59*0b57cec5SDimitry Andric   result.comment = GetColor("${ansi.fg.purple}");
60*0b57cec5SDimitry Andric   result.scalar_literal = GetColor("${ansi.fg.red}");
61*0b57cec5SDimitry Andric   result.keyword = GetColor("${ansi.fg.green}");
62*0b57cec5SDimitry Andric   return result;
63*0b57cec5SDimitry Andric }
64*0b57cec5SDimitry Andric 
65*0b57cec5SDimitry Andric const Highlighter &
getHighlighterFor(lldb::LanguageType language_type,llvm::StringRef path) const66*0b57cec5SDimitry Andric HighlighterManager::getHighlighterFor(lldb::LanguageType language_type,
67*0b57cec5SDimitry Andric                                       llvm::StringRef path) const {
68*0b57cec5SDimitry Andric   Language *language = lldb_private::Language::FindPlugin(language_type, path);
69*0b57cec5SDimitry Andric   if (language && language->GetHighlighter())
70*0b57cec5SDimitry Andric     return *language->GetHighlighter();
71*0b57cec5SDimitry Andric   return m_default;
72*0b57cec5SDimitry Andric }
73*0b57cec5SDimitry Andric 
Highlight(const HighlightStyle & options,llvm::StringRef line,std::optional<size_t> cursor_pos,llvm::StringRef previous_lines) const74*0b57cec5SDimitry Andric std::string Highlighter::Highlight(const HighlightStyle &options,
75*0b57cec5SDimitry Andric                                    llvm::StringRef line,
76*0b57cec5SDimitry Andric                                    std::optional<size_t> cursor_pos,
77*0b57cec5SDimitry Andric                                    llvm::StringRef previous_lines) const {
78*0b57cec5SDimitry Andric   StreamString s;
79*0b57cec5SDimitry Andric   Highlight(options, line, cursor_pos, previous_lines, s);
80*0b57cec5SDimitry Andric   s.Flush();
81   return s.GetString().str();
82 }
83