Merge pull request #1485 from contour-terminal/refactor/terminal-state

Refactoring Terminal's internal state storage
contour-terminal · Mar 17, 2024 · 521b140 · 521b140
2 parents bf6e914 + 4547ff2
commit 521b140
Show file tree

Hide file tree

Showing 23 changed files with 1,064 additions and 645 deletions.
diff --git a/src/contour/TerminalSession.cpp b/src/contour/TerminalSession.cpp
@@ -470,7 +470,7 @@ void TerminalSession::executeShowHostWritableStatusLine(bool allow, bool remembe
     _terminal.setStatusDisplay(vtbackend::StatusDisplayType::HostWritable);
     displayLog()("requestCaptureBuffer: Finished. Waking up I/O thread.");
     flushInput();
-    _terminal.state().syncWindowTitleWithHostWritableStatusDisplay = false;
+    _terminal.setSyncWindowTitleWithHostWritableStatusDisplay(false);
 }
 
 vtbackend::FontDef TerminalSession::getFontDef()
@@ -1017,16 +1017,22 @@ bool TerminalSession::operator()(actions::DecreaseOpacity)
 
 bool TerminalSession::operator()(actions::FocusNextSearchMatch)
 {
-    if (_terminal.state().viCommands.jumpToNextMatch(1))
-        _terminal.viewport().makeVisibleWithinSafeArea(_terminal.state().viCommands.cursorPosition.line);
+    auto const nextPosition = _terminal.searchNextMatch(_terminal.normalModeCursorPosition());
+    if (!nextPosition)
+        return false;
+    _terminal.moveNormalModeCursorTo(nextPosition.value());
+    _terminal.viewport().makeVisibleWithinSafeArea(nextPosition->line);
     // TODO why didn't the makeVisibleWithinSafeArea() call from inside jumpToNextMatch not work?
     return true;
 }
 
 bool TerminalSession::operator()(actions::FocusPreviousSearchMatch)
 {
-    if (_terminal.state().viCommands.jumpToPreviousMatch(1))
-        _terminal.viewport().makeVisibleWithinSafeArea(_terminal.state().viCommands.cursorPosition.line);
+    auto const nextPosition = _terminal.searchPrevMatch(_terminal.normalModeCursorPosition());
+    if (!nextPosition)
+        return false;
+    _terminal.moveNormalModeCursorTo(nextPosition.value());
+    _terminal.viewport().makeVisibleWithinSafeArea(nextPosition->line);
     // TODO why didn't the makeVisibleWithinSafeArea() call from inside jumpToPreviousMatch not work?
     return true;
 }
@@ -1265,16 +1271,16 @@ bool TerminalSession::operator()(actions::ToggleInputProtection)
 bool TerminalSession::operator()(actions::ToggleStatusLine)
 {
     auto const l = scoped_lock { _terminal };
-    if (terminal().state().statusDisplayType != StatusDisplayType::Indicator)
+    if (terminal().statusDisplayType() != StatusDisplayType::Indicator)
         terminal().setStatusDisplay(StatusDisplayType::Indicator);
     else
         terminal().setStatusDisplay(StatusDisplayType::None);
 
     // `savedStatusDisplayType` holds only a value if the application has been overriding
     // the status display type. But the user now actively requests a given type,
     // so make sure restoring will not destroy the user's desire.
-    if (terminal().state().savedStatusDisplayType)
-        terminal().state().savedStatusDisplayType = terminal().state().statusDisplayType;
+    if (terminal().savedStatusDisplayType())
+        terminal().setSavedStatusDisplayType(terminal().statusDisplayType());
 
     return true;
 }
@@ -1334,7 +1340,7 @@ void TerminalSession::setDefaultCursor()
         return;
 
     using Type = vtbackend::ScreenType;
-    switch (terminal().screenType())
+    switch (_terminal.screenType())
     {
         case Type::Primary: _display->setMouseCursorShape(MouseCursorShape::IBeam); break;
         case Type::Alternate: _display->setMouseCursorShape(MouseCursorShape::Arrow); break;
@@ -1450,7 +1456,7 @@ void TerminalSession::configureTerminal()
 
     sessionLog()("Setting terminal ID to {}.", _profile.terminalId.value());
     _terminal.setTerminalId(_profile.terminalId.value());
-    _terminal.setMaxImageColorRegisters(_config.maxImageColorRegisters.value());
+    _terminal.setMaxSixelColorRegisters(_config.maxImageColorRegisters.value());
     _terminal.setMaxImageSize(_config.maxImageSize.value());
     _terminal.setMode(vtbackend::DECMode::NoSixelScrolling, !_config.sixelScrolling.value());
     _terminal.setStatusDisplay(_profile.initialStatusDisplayType.value());
@@ -1532,7 +1538,7 @@ uint8_t TerminalSession::matchModeFlags() const
     if (_terminal.inputHandler().mode() == ViMode::Insert)
         flags |= static_cast<uint8_t>(MatchModes::Flag::Insert);
 
-    if (!_terminal.state().searchMode.pattern.empty())
+    if (!_terminal.search().pattern.empty())
         flags |= static_cast<uint8_t>(MatchModes::Flag::Search);
 
     if (_terminal.executionMode() != ExecutionMode::Normal)

diff --git a/src/vtbackend/CMakeLists.txt b/src/vtbackend/CMakeLists.txt
@@ -72,7 +72,6 @@ set(vtbackend_SOURCES
     SixelParser.cpp
     StatusLineBuilder.cpp
     Terminal.cpp
-    TerminalState.cpp
     VTType.cpp
     VTWriter.cpp
     Viewport.cpp

diff --git a/src/vtbackend/Cursor.h b/src/vtbackend/Cursor.h
@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: Apache-2.0
+#pragma once
+
+#include <vtbackend/Charset.h>
+#include <vtbackend/GraphicsAttributes.h>
+#include <vtbackend/Hyperlink.h>
+#include <vtbackend/primitives.h>
+
+namespace vtbackend
+{
+
+/// Terminal cursor data structure.
+///
+/// NB: Take care what to store here, as DECSC/DECRC will save/restore this struct.
+struct Cursor
+{
+    CellLocation position { LineOffset(0), ColumnOffset(0) };
+    bool autoWrap = true; // false;
+    bool originMode = false;
+    bool wrapPending = false;
+    GraphicsAttributes graphicsRendition {};
+    CharsetMapping charsets {};
+    HyperlinkId hyperlink {};
+    // TODO: selective erase attribute
+    // TODO: SS2/SS3 states
+    // TODO: CharacterSet for GL and GR
+};
+
+} // namespace vtbackend
diff --git a/src/vtbackend/Hyperlink.h b/src/vtbackend/Hyperlink.h
@@ -74,7 +74,7 @@ using HyperlinkCache = crispy::lru_cache<HyperlinkId, std::shared_ptr<HyperlinkI
 
 struct HyperlinkStorage
 {
-    HyperlinkCache cache { 1024 };
+    mutable HyperlinkCache cache { 1024 };
     HyperlinkId nextHyperlinkId = HyperlinkId(1);
 
     std::shared_ptr<HyperlinkInfo> hyperlinkById(HyperlinkId id) noexcept
@@ -93,7 +93,7 @@ struct HyperlinkStorage
         return {};
     }
 
-    HyperlinkId hyperlinkIdByUserId(std::string const& id) noexcept
+    HyperlinkId hyperlinkIdByUserId(std::string const& id) const noexcept
     {
         for (auto& href: cache)
         {

diff --git a/src/vtbackend/MockTerm.h b/src/vtbackend/MockTerm.h
@@ -29,8 +29,6 @@ class MockTerm: public Terminal::NullEvents
     }
 
     decltype(auto) pageSize() const noexcept { return terminal.pageSize(); }
-    decltype(auto) state() noexcept { return terminal.state(); }
-    decltype(auto) state() const noexcept { return terminal.state(); }
 
     PtyDevice& mockPty() noexcept { return static_cast<PtyDevice&>(terminal.device()); }
     PtyDevice const& mockPty() const noexcept { return static_cast<PtyDevice const&>(terminal.device()); }

diff --git a/src/vtbackend/RenderBufferBuilder.cpp b/src/vtbackend/RenderBufferBuilder.cpp
@@ -136,7 +136,7 @@ optional<RenderCursor> RenderBufferBuilder<Cell>::renderCursor() const
     // TODO: check if CursorStyle has changed, and update render context accordingly.
 
     auto constexpr InactiveCursorShape = CursorShape::Rectangle; // TODO configurable
-    auto const shape = _terminal->state().focused ? _terminal->cursorShape() : InactiveCursorShape;
+    auto const shape = _terminal->focused() ? _terminal->cursorShape() : InactiveCursorShape;
 
     auto const cursorScreenPosition =
         CellLocation { _baseLine + _cursorPosition->line
@@ -311,7 +311,7 @@ bool RenderBufferBuilder<Cell>::gridLineContainsCursor(LineOffset lineOffset) co
     if (_terminal->currentScreen().cursor().position.line == lineOffset)
         return true;
 
-    if (_cursorPosition && _terminal->state().inputHandler.mode() != ViMode::Insert)
+    if (_cursorPosition && _terminal->inputHandler().mode() != ViMode::Insert)
     {
         auto const viCursor = _terminal->viewport().translateGridToScreenCoordinate(_cursorPosition->line);
         if (viCursor == lineOffset)
@@ -399,21 +399,21 @@ void RenderBufferBuilder<Cell>::matchSearchPattern(T const& cellText)
     if (_highlightSearchMatches == HighlightSearchMatches::No)
         return;
 
-    auto const& searchMode = _terminal->state().searchMode;
-    if (searchMode.pattern.empty())
+    auto const& search = _terminal->search();
+    if (search.pattern.empty())
         return;
 
     auto const isFullMatch = [&]() -> bool {
         if constexpr (std::is_same_v<Cell, T>)
         {
-            return !CellUtil::beginsWith(u32string_view(searchMode.pattern.data() + _searchPatternOffset,
-                                                        searchMode.pattern.size() - _searchPatternOffset),
+            return !CellUtil::beginsWith(u32string_view(search.pattern.data() + _searchPatternOffset,
+                                                        search.pattern.size() - _searchPatternOffset),
                                          cellText);
         }
         else
         {
-            return crispy::beginsWith(u32string_view(searchMode.pattern.data() + _searchPatternOffset,
-                                                     searchMode.pattern.size() - _searchPatternOffset),
+            return crispy::beginsWith(u32string_view(search.pattern.data() + _searchPatternOffset,
+                                                     search.pattern.size() - _searchPatternOffset),
                                       cellText);
         }
     }();
@@ -430,7 +430,7 @@ void RenderBufferBuilder<Cell>::matchSearchPattern(T const& cellText)
     else
         _searchPatternOffset += cellText.size();
 
-    if (_searchPatternOffset < searchMode.pattern.size())
+    if (_searchPatternOffset < search.pattern.size())
         return; // match incomplete
 
     // match complete
@@ -442,21 +442,21 @@ void RenderBufferBuilder<Cell>::matchSearchPattern(T const& cellText)
             _output->cells[offsetIntoFront].position,
             _output->cells.back().position,
         }
-            .contains(_terminal->viewport().translateGridToScreenCoordinate(
-                _terminal->state().viCommands.cursorPosition));
+            .contains(
+                _terminal->viewport().translateGridToScreenCoordinate(_terminal->normalModeCursorPosition()));
 
     auto highlightColors = [&]() -> CellRGBColorAndAlphaPair {
         // Oh yeah, this can be optimized :)
         if (isFocusedMatch)
         {
-            if (_terminal->state().searchMode.initiatedByDoubleClick)
+            if (_terminal->search().initiatedByDoubleClick)
                 return _terminal->colorPalette().wordHighlightCurrent;
             else
                 return _terminal->colorPalette().searchHighlightFocused;
         }
         else
         {
-            if (_terminal->state().searchMode.initiatedByDoubleClick)
+            if (_terminal->search().initiatedByDoubleClick)
                 return _terminal->colorPalette().wordHighlight;
             else
                 return _terminal->colorPalette().searchHighlight;
@@ -616,13 +616,8 @@ void RenderBufferBuilder<Cell>::renderCell(Cell const& screenCell, LineOffset li
     _prevWidth = screenCell.width();
     _prevHasCursor = _cursorPosition && gridPosition == *_cursorPosition;
 
-    _output->cells.emplace_back(makeRenderCell(_terminal->colorPalette(),
-                                               _terminal->state().hyperlinks,
-                                               screenCell,
-                                               fg,
-                                               bg,
-                                               _baseLine + line,
-                                               column));
+    _output->cells.emplace_back(makeRenderCell(
+        _terminal->colorPalette(), _terminal->hyperlinks(), screenCell, fg, bg, _baseLine + line, column));
 
     if (column == ColumnOffset(0))
         _output->cells.back().groupStart = true;