[PR #19626] feat: VT margins are meant to be tracked separetly for each page #31900

Open
opened 2026-01-31 09:50:16 +00:00 by claunia · 0 comments
Owner

Original Pull Request: https://github.com/microsoft/terminal/pull/19626

State: closed
Merged: No


Fix: Per-Page Scroll Margins (DECSTBM/DECSLRM)

Issue #19625

Scroll margins were tracked globally instead of per-page, causing margins set on one page to incorrectly affect other pages.

Bug Scenario:

printf "\e#8\e[2 P\e[9;15r\e[1 P\e[999B\n\n\n\n\n\n\n"
  • Fill screen with DECALN
  • Switch to page 2 → Set margins 9-15
  • Switch to page 1 → Scroll with linefeeds
  • Problem: Page 2's margins affected page 1's scrolling

Root Cause

_scrollMargins was a single member variable in AdaptDispatch, shared across all pages. VT spec requires margins to be tracked per-page.

Solution

1. Added Per-Page Storage (PageManager.hpp/cpp)

  • Added std::array<til::inclusive_rect, MAX_PAGES> _scrollMargins{}
  • Added GetScrollMargins(pageNumber) and SetScrollMargins(pageNumber, margins)
  • Reset margins when PageManager resets

2. Updated Margin Management (adaptDispatch.hpp/cpp)

  • Removed global _scrollMargins variable
  • Updated _GetVerticalMargins() and _GetHorizontalMargins() to use page-specific margins
  • Updated _DoSetTopBottomScrollingMargins() and _DoSetLeftRightScrollingMargins() to store margins per-page

3. Updated Tests (adapterTest.cpp)

  • Modified ScrollMarginsTest to access margins via PageManager
  • Added PerPageScrollMarginsTest to verify page isolation

Files Modified

  • src/terminal/adapter/PageManager.hpp
  • src/terminal/adapter/PageManager.cpp
  • src/terminal/adapter/adaptDispatch.hpp
  • src/terminal/adapter/adaptDispatch.cpp
  • src/terminal/adapter/ut_adapter/adapterTest.cpp

Result

Each page now maintains independent scroll margins
Margins set on page 2 no longer affect page 1
Margins persist correctly when switching between pages
Complies with VT programmer's reference specification

**Original Pull Request:** https://github.com/microsoft/terminal/pull/19626 **State:** closed **Merged:** No --- # Fix: Per-Page Scroll Margins (DECSTBM/DECSLRM) ## Issue #19625 Scroll margins were tracked globally instead of per-page, causing margins set on one page to incorrectly affect other pages. **Bug Scenario:** ```bash printf "\e#8\e[2 P\e[9;15r\e[1 P\e[999B\n\n\n\n\n\n\n" ``` - Fill screen with DECALN - Switch to page 2 → Set margins 9-15 - Switch to page 1 → Scroll with linefeeds - **Problem:** Page 2's margins affected page 1's scrolling ## Root Cause `_scrollMargins` was a single member variable in `AdaptDispatch`, shared across all pages. VT spec requires margins to be tracked **per-page**. ## Solution ### 1. Added Per-Page Storage (`PageManager.hpp/cpp`) - Added `std::array<til::inclusive_rect, MAX_PAGES> _scrollMargins{}` - Added `GetScrollMargins(pageNumber)` and `SetScrollMargins(pageNumber, margins)` - Reset margins when PageManager resets ### 2. Updated Margin Management (`adaptDispatch.hpp/cpp`) - Removed global `_scrollMargins` variable - Updated `_GetVerticalMargins()` and `_GetHorizontalMargins()` to use page-specific margins - Updated `_DoSetTopBottomScrollingMargins()` and `_DoSetLeftRightScrollingMargins()` to store margins per-page ### 3. Updated Tests (`adapterTest.cpp`) - Modified `ScrollMarginsTest` to access margins via PageManager - Added `PerPageScrollMarginsTest` to verify page isolation ## Files Modified - `src/terminal/adapter/PageManager.hpp` - `src/terminal/adapter/PageManager.cpp` - `src/terminal/adapter/adaptDispatch.hpp` - `src/terminal/adapter/adaptDispatch.cpp` - `src/terminal/adapter/ut_adapter/adapterTest.cpp` ## Result Each page now maintains independent scroll margins Margins set on page 2 no longer affect page 1 Margins persist correctly when switching between pages Complies with VT programmer's reference specification
claunia added the pull-request label 2026-01-31 09:50:16 +00:00
Sign in to join this conversation.
No Label pull-request
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#31900