[vtbackend] Add customizable indicator statusline

Signed-off-by: Christian Parpart <[email protected]>

Author: christianparpart

docs/configuration/indicator-statusline.md

@@ -0,0 +1,69 @@
+# Indicator Statusline
+
+The indicator statusline used to be a feature, from the old DEC VT level 4 terminals.
+Contour revives this feature to prominently show the terminal status.
+
+## Configuration
+
+```
+profiles:
+    your_profile:
+        status_line:
+            indicator:
+                left: "{VTType} │ {InputMode:Bold,Color=#C0C030}{Search:Left= │ }{TraceMode:Bold,Color=#FFFF00,Left= │ }{ProtectedMode:Bold,Left= │ }"
+                middle: "{Title:Left= « ,Right= » ,Color=#20c0c0}"
+                right: "{HistoryLineCount:Faint,Color=#c0c0c0} │ {Clock:Bold} "
+```
+
+Each segment, `left`, `middle`, and `right` may contain text to be displayed in the
+left, middle, or right segment of the indicator statusline.
+
+This text may contain placeholders to be replaced by their respective dynamic content.
+
+## Variables
+
+Variable             | Description
+---------------------|--------------------------------------------------------------------
+`{Clock}`            | current clock in HH:MM format
+`{Command}`          | yields the result of the given command prompt
+`{HistoryLineCount}` | number of lines in history (only available in primary screen)
+`{Hyperlink}`        | reveals the hyperlink at the given mouse location
+`{InputMode}`        | current input mode (e.g. INSERT, NORMAL, VISUAL)
+`{ProtectedMode}`    | indicates protected mode, if currently enabled
+`{SearchMode}`       | indicates search highlight mode, if currently active
+`{SearchPrompt}`     | search input prompt, if currently active
+`{Text}`             | given text (makes only sense when customized with flags)
+`{Title}`            | current window title
+`{VTType}`           | currently active VT emulation type
+
+## Formatting Styles
+
+Each Variable, as specified above, can be parametrized for customizing the look of it.
+The common syntax to these variables and their parameters looks as follows:
+
+```
+{VariableName:SomeFlag,SomeKey=SomeValue}
+```
+
+So parameters can be specified after a colon (`:`) as a comma separated list of flags and key/value pairs.
+A key/value pair is further split by equal sign (`=`).
+
+The following list of formatting styles are supported:
+
+Parameter                 | Description
+--------------------------|--------------------------------------------------------------------
+`Left=TEXT`               | text to show on the left side, if the variable is to be shown
+`Right=TEXT`              | text to show on the right side, if the variable is to be shown
+`Color=#RRGGBB`           | text color in hexadecimal RGB notation
+`BackgroundColor=#RRGGBB` | background color in hexadecimal RGB notation
+`Bold`                    | text in bold font face
+`Italic`                  | text in italic font face
+`Underline`               | underline text (only one underline style can be active)
+`CurlyUnderline`          | curly underline text (only one underline style can be active)
+`DoubleUnderline`         | double underline text (only one underline style can be active)
+`DottedUnderline`         | dotted underline text (only one underline style can be active)
+`DashedUnderline`         | dashed underline text (only one underline style can be active)
+`Blinking`                | blinking text
+`RapidBlinking`           | rapid blinking text
+`Overline`                | overline text
+`Inverse`                 | inversed text/background coloring

mkdocs.yml

@@ -90,6 +90,7 @@ nav:
     - configuration/index.md
     - configuration/profiles.md
     - configuration/colors.md
+    - configuration/indicator-statusline.md
     #- Images (Advanced) : configuration/advanced/images.md
     #- Mouse (Advanced) : configuration/advanced/images.md
     #- Misc (Advanced) : configuration/advanced/mouse.md

src/contour/Config.cpp

@@ -350,6 +350,13 @@ void YAMLConfigReader::loadFromEntry(YAML::Node const& node, std::string const&
             loadFromEntry(child["status_line"], "position", where.statusDisplayPosition);
             loadFromEntry(child["status_line"], "sync_to_window_title", where.syncWindowTitleWithHostWritableStatusDisplay);
             loadFromEntry(child["status_line"], "display", where.initialStatusDisplayType);
+
+            if (child["status_line"]["indicator"])
+            {
+                loadFromEntry(child["status_line"]["indicator"], "left", where.indicatorStatusLineLeft);
+                loadFromEntry(child["status_line"]["indicator"], "middle", where.indicatorStatusLineMiddle);
+                loadFromEntry(child["status_line"]["indicator"], "right", where.indicatorStatusLineRight);
+            }
         }
         if (child["background"])
         {

src/contour/Config.h

@@ -319,6 +319,18 @@ struct TerminalProfile
     };
     ConfigEntry<vtbackend::StatusDisplayPosition, documentation::StatusDisplayPosition>
         statusDisplayPosition { vtbackend::StatusDisplayPosition::Bottom };
+    ConfigEntry<std::string, documentation::IndicatorStatusLineLeft> indicatorStatusLineLeft {
+        "{VTType} │ {InputMode:Bold,Color=#C0C030}"
+        "{SearchPrompt:Left= │ }"
+        "{TraceMode:Bold,Color=#FFFF00,Left= │ }"
+        "{ProtectedMode:Bold,Left= │ }"
+    };
+    ConfigEntry<std::string, documentation::IndicatorStatusLineMiddle> indicatorStatusLineMiddle {
+        "{Title:Left= « ,Right= » }"
+    };
+    ConfigEntry<std::string, documentation::IndicatorStatusLineRight> indicatorStatusLineRight {
+        "{HistoryLineCount:Faint,Color=#c0c0c0} │ {Clock:Bold} "
+    };
     ConfigEntry<bool, documentation::SyncWindowTitleWithHostWritableStatusDisplay>
         syncWindowTitleWithHostWritableStatusDisplay { false };
     ConfigEntry<bool, documentation::HideScrollbarInAltScreen> hideScrollbarInAltScreen { true };

src/contour/ConfigDocumentation.h

@@ -171,6 +171,10 @@ constexpr StringLiteral StatusDisplayPosition {
     "\n"
 };
 
+constexpr StringLiteral IndicatorStatusLineLeft { "left: {}\n" };
+constexpr StringLiteral IndicatorStatusLineMiddle { "middle: {}\n" };
+constexpr StringLiteral IndicatorStatusLineRight { "right: {}\n" };
+
 constexpr StringLiteral SyncWindowTitleWithHostWritableStatusDisplay {
     "{comment} Synchronize the window title with the Host Writable status_line if\n"
     "{comment} and only if the host writable status line was denied to be shown.\n"

src/contour/TerminalSession.cpp

@@ -141,6 +141,9 @@ namespace
         settings.maxImageRegisterCount = config.maxImageColorRegisters.value();
         settings.statusDisplayType = profile.initialStatusDisplayType.value();
         settings.statusDisplayPosition = profile.statusDisplayPosition.value();
+        settings.indicatorStatusLine.left = profile.indicatorStatusLineLeft.value();
+        settings.indicatorStatusLine.middle = profile.indicatorStatusLineMiddle.value();
+        settings.indicatorStatusLine.right = profile.indicatorStatusLineRight.value();
         settings.syncWindowTitleWithHostWritableStatusDisplay =
             profile.syncWindowTitleWithHostWritableStatusDisplay.value();
         if (auto const* p = preferredColorPalette(profile.colors.value(), colorPreference))

src/vtbackend/CMakeLists.txt

@@ -39,6 +39,7 @@ set(vtbackend_HEADERS
     Sequence.h
     Sequencer.h
     SixelParser.h
+    StatusLineBuilder.h
     Terminal.h
     VTType.h
     VTWriter.h
@@ -69,6 +70,7 @@ set(vtbackend_SOURCES
     Sequence.cpp
     Sequencer.cpp
     SixelParser.cpp
+    StatusLineBuilder.cpp
     Terminal.cpp
     TerminalState.cpp
     VTType.cpp

src/vtbackend/Color.cpp

@@ -2,6 +2,7 @@
 #include <vtbackend/Color.h>
 
 #include <crispy/overloaded.h>
+#include <crispy/utils.h>
 
 using namespace std;
 
@@ -128,4 +129,47 @@ string to_string(RGBAColor c)
     return fmt::format("#{:02X}{:02X}{:02X}{:02X}", c.red(), c.green(), c.blue(), c.alpha());
 }
 
+optional<RGBColor> parseColor(string_view const& value)
+{
+    try
+    {
+        // "rgb:RR/GG/BB"
+        //  0123456789a
+        if (value.size() == 12 && value.substr(0, 4) == "rgb:" && value[6] == '/' && value[9] == '/')
+        {
+            auto const r = crispy::to_integer<16, uint8_t>(value.substr(4, 2));
+            auto const g = crispy::to_integer<16, uint8_t>(value.substr(7, 2));
+            auto const b = crispy::to_integer<16, uint8_t>(value.substr(10, 2));
+            return RGBColor { r.value(), g.value(), b.value() };
+        }
+
+        // "#RRGGBB"
+        if (value.size() == 7 && value[0] == '#')
+        {
+            auto const r = crispy::to_integer<16, uint8_t>(value.substr(1, 2));
+            auto const g = crispy::to_integer<16, uint8_t>(value.substr(3, 2));
+            auto const b = crispy::to_integer<16, uint8_t>(value.substr(5, 2));
+            return RGBColor { r.value(), g.value(), b.value() };
+        }
+
+        // "#RGB"
+        if (value.size() == 4 && value[0] == '#')
+        {
+            auto const r = crispy::to_integer<16, uint8_t>(value.substr(1, 1));
+            auto const g = crispy::to_integer<16, uint8_t>(value.substr(2, 1));
+            auto const b = crispy::to_integer<16, uint8_t>(value.substr(3, 1));
+            auto const rr = static_cast<uint8_t>(r.value() << 4);
+            auto const gg = static_cast<uint8_t>(g.value() << 4);
+            auto const bb = static_cast<uint8_t>(b.value() << 4);
+            return RGBColor { rr, gg, bb };
+        }
+
+        return std::nullopt;
+    }
+    catch (...)
+    {
+        // that will be a formatting error in stoul() then.
+        return std::nullopt;
+    }
+}
 } // namespace vtbackend

src/vtbackend/Color.h

@@ -395,6 +395,8 @@ constexpr Opacity& operator--(Opacity& value) noexcept
 }
 // }}}
 
+std::optional<RGBColor> parseColor(std::string_view const& value);
+
 } // namespace vtbackend
 
 // {{{ fmtlib custom formatter

src/vtbackend/Screen.cpp

@@ -507,7 +507,7 @@ void Screen<Cell>::writeTextEnd()
         return;
 
     if (vtTraceSequenceLog)
-        vtTraceSequenceLog()("text: \"{}\"", _pendingCharTraceLog);
+        vtTraceSequenceLog()("[{}] text: \"{}\"", _name, _pendingCharTraceLog);
 
     _pendingCharTraceLog.clear();
 #endif
@@ -1790,7 +1790,10 @@ template <typename Cell>
 CRISPY_REQUIRES(CellConcept<Cell>)
 void Screen<Cell>::setGraphicsRendition(GraphicsRendition rendition)
 {
-    _terminal->setGraphicsRendition(rendition);
+    if (rendition == GraphicsRendition::Reset)
+        _cursor.graphicsRendition = {};
+    else
+        _cursor.graphicsRendition.flags = CellUtil::makeCellFlags(rendition, _cursor.graphicsRendition.flags);
 }
 
 template <typename Cell>
@@ -2546,50 +2549,6 @@ namespace impl
             return ApplyResult::Invalid;
         }
 
-        optional<RGBColor> parseColor(string_view const& value)
-        {
-            try
-            {
-                // "rgb:RR/GG/BB"
-                //  0123456789a
-                if (value.size() == 12 && value.substr(0, 4) == "rgb:" && value[6] == '/' && value[9] == '/')
-                {
-                    auto const r = crispy::to_integer<16, uint8_t>(value.substr(4, 2));
-                    auto const g = crispy::to_integer<16, uint8_t>(value.substr(7, 2));
-                    auto const b = crispy::to_integer<16, uint8_t>(value.substr(10, 2));
-                    return RGBColor { r.value(), g.value(), b.value() };
-                }
-
-                // "#RRGGBB"
-                if (value.size() == 7 && value[0] == '#')
-                {
-                    auto const r = crispy::to_integer<16, uint8_t>(value.substr(1, 2));
-                    auto const g = crispy::to_integer<16, uint8_t>(value.substr(3, 2));
-                    auto const b = crispy::to_integer<16, uint8_t>(value.substr(5, 2));
-                    return RGBColor { r.value(), g.value(), b.value() };
-                }
-
-                // "#RGB"
-                if (value.size() == 4 && value[0] == '#')
-                {
-                    auto const r = crispy::to_integer<16, uint8_t>(value.substr(1, 1));
-                    auto const g = crispy::to_integer<16, uint8_t>(value.substr(2, 1));
-                    auto const b = crispy::to_integer<16, uint8_t>(value.substr(3, 1));
-                    auto const rr = static_cast<uint8_t>(r.value() << 4);
-                    auto const gg = static_cast<uint8_t>(g.value() << 4);
-                    auto const bb = static_cast<uint8_t>(b.value() << 4);
-                    return RGBColor { rr, gg, bb };
-                }
-
-                return std::nullopt;
-            }
-            catch (...)
-            {
-                // that will be a formatting error in stoul() then.
-                return std::nullopt;
-            }
-        }
-
         Color parseColor(Sequence const& seq, size_t* pi)
         {
             // We are at parameter index `i`.
@@ -2701,9 +2660,7 @@ namespace impl
             return Color {};
         }
 
-        template <typename Target>
-        CRISPY_REQUIRES((CellConcept<Target> || std::is_same_v<Target, Terminal>) )
-        ApplyResult applySGR(Target& target, Sequence const& seq, size_t parameterStart, size_t parameterEnd)
+        ApplyResult applySGR(auto& target, Sequence const& seq, size_t parameterStart, size_t parameterEnd)
         {
             if (parameterStart == parameterEnd)
             {
@@ -2916,7 +2873,7 @@ namespace impl
             auto const& value = seq.intermediateCharacters();
             if (value == "?")
                 screen.requestDynamicColor(name);
-            else if (auto color = parseColor(value); color.has_value())
+            else if (auto color = vtbackend::parseColor(value); color.has_value())
                 screen.setDynamicColor(name, color.value());
             else
                 return ApplyResult::Invalid;
@@ -2948,7 +2905,7 @@ namespace impl
                     queryColor((uint8_t) index);
                     index = -1;
                 }
-                else if (auto const color = parseColor(value))
+                else if (auto const color = vtbackend::parseColor(value))
                 {
                     setColor((uint8_t) index, color.value());
                     index = -1;
@@ -3408,10 +3365,10 @@ void Screen<Cell>::processSequence(Sequence const& seq)
     {
         if (auto const* fd = seq.functionDefinition(_terminal->activeSequences()))
         {
-            vtTraceSequenceLog()("Processing {:<14} {}", fd->documentation.mnemonic, seq.text());
+            vtTraceSequenceLog()("[{}] Processing {:<14} {}", _name, fd->documentation.mnemonic, seq.text());
         }
         else
-            vtTraceSequenceLog()("Processing unknown sequence: {}", seq.text());
+            vtTraceSequenceLog()("[{}] Processing unknown sequence: {}", _name, seq.text());
     }
 #endif
 
@@ -3750,7 +3707,7 @@ ApplyResult Screen<Cell>::apply(FunctionDefinition const& function, Sequence con
         case SCOSC: saveCursor(); break;
         case SD: scrollDown(seq.param_or<LineCount>(0, LineCount { 1 })); break;
         case SETMARK: setMark(); break;
-        case SGR: return impl::applySGR(*_terminal, seq, 0, seq.parameterCount());
+        case SGR: return impl::applySGR(*this, seq, 0, seq.parameterCount());
         case SGRRESTORE: restoreGraphicsRendition(); return ApplyResult::Ok;
         case SGRSAVE: saveGraphicsRendition(); return ApplyResult::Ok;
         case SM: {