Merge pull request #847 from Yaraslaut/master

Add support for infinite grid

src/contour/Config.cpp

@@ -69,6 +69,7 @@ using terminal::Width;
 
 using terminal::CellRGBColorAndAlphaPair;
 using terminal::ColumnCount;
+using terminal::Infinite;
 using terminal::LineCount;
 using terminal::PageSize;
 
@@ -1522,12 +1523,15 @@ TerminalProfile loadTerminalProfile(UsedKeys& _usedKeys,
     else
         errorlog()("Invalid render_mode \"{}\" in configuration.", strValue);
 
-    auto intValue = profile.maxHistoryLineCount;
+    auto intValue = LineCount();
     tryLoadChildRelative(_usedKeys, _profile, basePath, "history.limit", intValue);
-    if (unbox<int>(intValue) < 0)
-        profile.maxHistoryLineCount = LineCount(0);
+    // value -1 is used for infinite grid
+    if (unbox<int>(intValue) == -1)
+        profile.maxHistoryLineCount = Infinite();
+    else if (unbox<int>(intValue) > -1)
+        profile.maxHistoryLineCount = LineCount(intValue);
     else
-        profile.maxHistoryLineCount = intValue;
+        profile.maxHistoryLineCount = LineCount(0);
 
     strValue = fmt::format("{}", ScrollBarPosition::Right);
     if (tryLoadChildRelative(_usedKeys, _profile, basePath, "scrollbar.position", strValue))

src/contour/Config.h

@@ -153,7 +153,7 @@ struct TerminalProfile
     terminal::PageSize terminalSize = { terminal::LineCount(10), terminal::ColumnCount(40) };
     terminal::VTType terminalId = terminal::VTType::VT525;
 
-    terminal::LineCount maxHistoryLineCount;
+    terminal::MaxHistoryLineCount maxHistoryLineCount;
     terminal::LineCount historyScrollMultiplier = terminal::LineCount(3);
     ScrollBarPosition scrollbarPosition = ScrollBarPosition::Right;
     bool hideScrollbarInAltScreen = true;

src/terminal/Grid.cpp

@@ -13,6 +13,7 @@
  */
 #include <terminal/Cell.h>
 #include <terminal/Grid.h>
+#include <terminal/primitives.h>
 
 #include <crispy/assert.h>
 #include <crispy/logstore.h>
@@ -120,25 +121,33 @@ namespace detail
 } // namespace detail
 // {{{ Grid impl
 template <typename Cell>
-Grid<Cell>::Grid(PageSize _pageSize, bool _reflowOnResize, LineCount _maxHistoryLineCount):
+Grid<Cell>::Grid(PageSize _pageSize, bool _reflowOnResize, MaxHistoryLineCount _maxHistoryLineCount):
     pageSize_ { _pageSize },
     reflowOnResize_ { _reflowOnResize },
-    maxHistoryLineCount_ { _maxHistoryLineCount },
+    historyLimit_ { _maxHistoryLineCount },
     lines_ { detail::createLines<Cell>(
-        _pageSize, _maxHistoryLineCount, _reflowOnResize, GraphicsAttributes {}) },
+        _pageSize,
+        [_maxHistoryLineCount]() -> LineCount {
+            if (auto const* maxLineCount = std::get_if<LineCount>(&_maxHistoryLineCount))
+                return *maxLineCount;
+            else
+                return LineCount::cast_from(0);
+        }(),
+        _reflowOnResize,
+        GraphicsAttributes {}) },
     linesUsed_ { _pageSize.lines }
 {
     verifyState();
 }
 
 template <typename Cell>
-void Grid<Cell>::setMaxHistoryLineCount(LineCount _maxHistoryLineCount)
+void Grid<Cell>::setMaxHistoryLineCount(MaxHistoryLineCount _maxHistoryLineCount)
 {
     verifyState();
     rezeroBuffers();
-    lines_.resize(unbox<size_t>(pageSize_.lines + _maxHistoryLineCount));
-    linesUsed_ = min(linesUsed_, pageSize_.lines + _maxHistoryLineCount);
-    maxHistoryLineCount_ = _maxHistoryLineCount;
+    historyLimit_ = _maxHistoryLineCount;
+    lines_.resize(unbox<size_t>(pageSize_.lines + maxHistoryLineCount()));
+    linesUsed_ = min(linesUsed_, pageSize_.lines + maxHistoryLineCount());
     verifyState();
 }
 
@@ -360,6 +369,13 @@ LineCount Grid<Cell>::scrollUp(LineCount linesCountToScrollUp, GraphicsAttribute
     verifyState();
     if (unbox<size_t>(linesUsed_) == lines_.size()) // with all grid lines in-use
     {
+        if (std::get_if<Infinite>(&historyLimit_))
+        {
+            for ([[maybe_unused]] auto const _: ranges::views::iota(0, unbox<int>(linesCountToScrollUp)))
+                lines_.emplace_back(defaultLineFlags(),
+                                    TrivialLineBuffer { pageSize_.columns, GraphicsAttributes {} });
+            return scrollUp(linesCountToScrollUp, _defaultAttributes);
+        }
         // TODO: ensure explicit test for this case
         rotateBuffersLeft(linesCountToScrollUp);
 
@@ -608,7 +624,7 @@ CellLocation Grid<Cell>::growLines(LineCount _newHeight, CellLocation _cursor)
     Require(*totalLinesToExtend >= 0);
     // ? Require(linesToTakeFromSavedLines == LineCount(0));
 
-    auto const newTotalLineCount = maxHistoryLineCount_ + _newHeight;
+    auto const newTotalLineCount = maxHistoryLineCount() + _newHeight;
     auto const currentTotalLineCount = LineCount::cast_from(lines_.size());
     auto const linesToFill = max(0, *newTotalLineCount - *currentTotalLineCount);
 
@@ -619,7 +635,7 @@ CellLocation Grid<Cell>::growLines(LineCount _newHeight, CellLocation _cursor)
     linesUsed_ = min(linesUsed_ + totalLinesToExtend, LineCount::cast_from(lines_.size()));
 
     Ensures(pageSize_.lines == _newHeight);
-    Ensures(lines_.size() >= unbox<size_t>(maxHistoryLineCount_ + pageSize_.lines));
+    Ensures(lines_.size() >= unbox<size_t>(maxHistoryLineCount() + pageSize_.lines));
     verifyState();
 
     return cursorMove;
@@ -653,7 +669,7 @@ CellLocation Grid<Cell>::resize(PageSize _newSize, CellLocation _currentCursorPo
             pageSize_.lines - boxed_cast<LineCount>(_cursor.line + 1);
         auto const cutoffCount = min(numLinesToShrink, linesAvailableBelowCursorBeforeShrink);
         auto const numLinesToPushUp = numLinesToShrink - cutoffCount;
-        auto const numLinesToPushUpCapped = min(numLinesToPushUp, maxHistoryLineCount_);
+        auto const numLinesToPushUpCapped = min(numLinesToPushUp, maxHistoryLineCount());
 
         GridLog()(" -> shrink lines: numLinesToShrink {}, linesAvailableBelowCursorBeforeShrink {}, "
                   "cutoff {}, pushUp "
@@ -782,7 +798,7 @@ CellLocation Grid<Cell>::resize(PageSize _newSize, CellLocation _currentCursorPo
             linesUsed_ = LineCount::cast_from(grownLines.size());
 
             // Fill scrollback lines.
-            auto const totalLineCount = unbox<size_t>(pageSize_.lines + maxHistoryLineCount_);
+            auto const totalLineCount = unbox<size_t>(pageSize_.lines + maxHistoryLineCount());
             while (grownLines.size() < totalLineCount)
                 grownLines.emplace_back(
                     defaultLineFlags(),
@@ -845,7 +861,7 @@ CellLocation Grid<Cell>::resize(PageSize _newSize, CellLocation _currentCursorPo
             LineBuffer wrappedColumns;
             LineFlags previousFlags = lines_.front().inheritableFlags();
 
-            auto const totalLineCount = unbox<size_t>(pageSize_.lines + maxHistoryLineCount_);
+            auto const totalLineCount = unbox<size_t>(pageSize_.lines + maxHistoryLineCount());
             shrinkedLines.reserve(totalLineCount);
             Require(totalLineCount == unbox<size_t>(this->totalLineCount()));
 

src/terminal/Grid.h

@@ -383,21 +383,31 @@ class Grid
 {
     // TODO: Rename all "History" to "Scrollback"?
   public:
-    Grid(PageSize _pageSize, bool _reflowOnResize, LineCount _maxHistoryLineCount);
+    Grid(PageSize _pageSize, bool _reflowOnResize, MaxHistoryLineCount _maxHistoryLineCount);
 
     Grid(): Grid(PageSize { LineCount(25), ColumnCount(80) }, false, LineCount(0)) {}
 
     void reset();
 
     // {{{ grid global properties
-    [[nodiscard]] LineCount maxHistoryLineCount() const noexcept { return maxHistoryLineCount_; }
-    void setMaxHistoryLineCount(LineCount _maxHistoryLineCount);
+    [[nodiscard]] LineCount maxHistoryLineCount() const noexcept
+    {
+        if (auto const* maxLineCount = std::get_if<LineCount>(&historyLimit_))
+            return *maxLineCount;
+        else
+            return LineCount::cast_from(lines_.size()) - pageSize_.lines;
+    }
 
-    [[nodiscard]] LineCount totalLineCount() const noexcept { return maxHistoryLineCount_ + pageSize_.lines; }
+    void setMaxHistoryLineCount(MaxHistoryLineCount _maxHistoryLineCount);
+
+    [[nodiscard]] LineCount totalLineCount() const noexcept
+    {
+        return maxHistoryLineCount() + pageSize_.lines;
+    }
 
     [[nodiscard]] LineCount historyLineCount() const noexcept
     {
-        return std::min(maxHistoryLineCount_, linesUsed_ - pageSize_.lines);
+        return std::min(maxHistoryLineCount(), linesUsed_ - pageSize_.lines);
     }
 
     [[nodiscard]] bool reflowOnResize() const noexcept { return reflowOnResize_; }
@@ -567,7 +577,7 @@ class Grid
     //
     PageSize pageSize_;
     bool reflowOnResize_ = false;
-    LineCount maxHistoryLineCount_;
+    MaxHistoryLineCount historyLimit_;
 
     // Number of lines is at least the sum of maxHistoryLineCount_ + pageSize_.lines,
     // because shrinking the page height does not necessarily

src/terminal/Grid_test.cpp

@@ -846,4 +846,24 @@ TEST_CASE("Grid.reflow.tripple", "[grid]")
         // }}}
     }
 }
+
+TEST_CASE("Grid infinite", "[grid]")
+{
+    auto grid_finite = Grid<Cell>(PageSize { LineCount(2), ColumnCount(8) }, true, LineCount(0));
+    grid_finite.setLineText(LineOffset { 0 }, "ABCDEFGH"sv);
+    grid_finite.setLineText(LineOffset { 1 }, "abcdefgh"sv);
+    grid_finite.scrollUp(LineCount { 1 });
+    REQUIRE(grid_finite.lineText(LineOffset(0)) == "abcdefgh");
+    REQUIRE(grid_finite.lineText(LineOffset(-1)) == std::string(8, ' '));
+
+    auto grid_infinite = Grid<Cell>(PageSize { LineCount(2), ColumnCount(8) }, true, Infinite());
+    grid_infinite.setLineText(LineOffset { 0 }, "ABCDEFGH"sv);
+    grid_infinite.setLineText(LineOffset { 1 }, "abcdefgh"sv);
+    grid_infinite.scrollUp(LineCount { 1 });
+    REQUIRE(grid_infinite.lineText(LineOffset(0)) == "abcdefgh");
+    REQUIRE(grid_infinite.lineText(LineOffset(-1)) == "ABCDEFGH");
+    grid_infinite.scrollUp(LineCount { 97 });
+    REQUIRE(grid_infinite.lineText(LineOffset(-97)) == "abcdefgh");
+    REQUIRE(grid_infinite.lineText(LineOffset(-98)) == "ABCDEFGH");
+}
 // }}}

src/terminal/Terminal.cpp

@@ -87,7 +87,7 @@ Terminal::Terminal(unique_ptr<Pty> _pty,
                    size_t ptyBufferObjectSize,
                    size_t _ptyReadBufferSize,
                    Terminal::Events& _eventListener,
-                   LineCount _maxHistoryLineCount,
+                   MaxHistoryLineCount _maxHistoryLineCount,
                    LineOffset _copyLastMarkRangeOffset,
                    chrono::milliseconds _cursorBlinkInterval,
                    chrono::steady_clock::time_point _now,
@@ -1715,7 +1715,7 @@ void Terminal::onBufferScrolled(LineCount _n) noexcept
 }
 // }}}
 
-void Terminal::setMaxHistoryLineCount(LineCount _maxHistoryLineCount)
+void Terminal::setMaxHistoryLineCount(MaxHistoryLineCount _maxHistoryLineCount)
 {
     primaryScreen_.grid().setMaxHistoryLineCount(_maxHistoryLineCount);
 }

src/terminal/Terminal.h

@@ -93,7 +93,7 @@ class Terminal
              size_t ptyBufferObjectSize,
              size_t _ptyReadBufferSize,
              Events& _eventListener,
-             LineCount _maxHistoryLineCount = LineCount(0),
+             MaxHistoryLineCount _maxHistoryLineCount = LineCount(0),
              LineOffset _copyLastMarkRangeOffset = LineOffset(0),
              std::chrono::milliseconds _cursorBlinkInterval = std::chrono::milliseconds { 500 },
              std::chrono::steady_clock::time_point _now = std::chrono::steady_clock::now(),
@@ -113,7 +113,7 @@ class Terminal
     void setRefreshRate(double _refreshRate);
     void setLastMarkRangeOffset(LineOffset _value) noexcept;
 
-    void setMaxHistoryLineCount(LineCount _maxHistoryLineCount);
+    void setMaxHistoryLineCount(MaxHistoryLineCount _maxHistoryLineCount);
     LineCount maxHistoryLineCount() const noexcept;
 
     void setTerminalId(VTType _id) noexcept { state_.terminalId = _id; }

src/terminal/TerminalState.cpp

@@ -22,7 +22,7 @@ class Terminal;
 
 TerminalState::TerminalState(Terminal& _terminal,
                              PageSize _pageSize,
-                             LineCount _maxHistoryLineCount,
+                             MaxHistoryLineCount _maxHistoryLineCount,
                              ImageSize _maxImageSize,
                              unsigned _maxImageColorRegisters,
                              bool _sixelCursorConformance,

src/terminal/TerminalState.h

@@ -127,7 +127,7 @@ struct TerminalState
 {
     TerminalState(Terminal& _terminal,
                   PageSize _pageSize,
-                  LineCount _maxHistoryLineCount,
+                  MaxHistoryLineCount _maxHistoryLineCount,
                   ImageSize _maxImageSize,
                   unsigned _maxImageColorRegisters,
                   bool _sixelCursorConformance,

src/terminal/primitives.h

@@ -23,6 +23,7 @@
 #include <limits>
 #include <ostream>
 #include <type_traits>
+#include <variant>
 
 // TODO
 // - [ ] rename all History to Scrollback
@@ -82,6 +83,13 @@ using ColumnOffset = crispy::boxed<int, detail::tags::ColumnOffset>;
 /// LineCount represents a number of lines.
 using LineCount = crispy::boxed<int, detail::tags::LineCount>;
 
+// clang-format off
+/// Special structure for inifinite history of Grid
+struct Infinite {};
+// clang-format on
+/// MaxHistoryLineCount represents type that are used to store number
+/// of lines that can be stored in history
+using MaxHistoryLineCount = std::variant<LineCount, Infinite>;
 /// Represents the line offset relative to main-page top.
 ///
 /// *  0  is top-most line on main page