Make selection an exclusive range #18106

carlos-zamora · 2024-10-23T20:19:57Z

Summary of the Pull Request

Selection is generally stored as an inclusive start and end. This PR makes the end exclusive which now allows degenerate selections, namely in mark mode. This also modifies mouse selection to round to the nearest cell boundary (see #5099) and improves word boundaries to be a bit more modern and make sense for degenerate selections (similar to #15787).

References and Relevant Issues

Closes #5099
Closes #13447
Closes #17892

Detailed Description of the Pull Request / Additional comments

Buffer, Viewport, and Point
- Introduced a few new functions here to find word boundaries, delimiter class runs, and glyph boundaries.
  - 📝These new functions should be able to replace a few other functions (i.e. GetWordStart --> GetWordStart2). That migration is going to be a part of Refactor Word Expansion in TextBuffer #4423 to reduce the risk of breaking UIA.
- Viewport: added a few functions to handle navigating the exclusive bounds (namely allowing RightExclusive as a position for buffer coordinates). This is important for selection to be able to highlight the entire line.
  - 📝BottomInclusiveRightExclusive() will replace EndExclusive in the UIA code
- Point: iterate_rows_exclusive is similar to iterate_rows, except it has handling for RightExclusive
Renderer
- Use iterate_rows_exclusive for proper handling (this actually fixed a lot of our issues)
- Remove some workarounds in _drawHighlighted (this is a boundary where we got inclusive coords and made them exclusive, but now we don't need that!)
Terminal
- fix selection marker rendering
- _ConvertToBufferCell(): add a param to allow for RightExclusive or clamp it to RightInclusive (original behavior). Both are useful!
- Use new GetWordStart2 and GetWordEnd2 to improve word boundaries and make them feel right now that the selection an exclusive range.
- Convert a few IsInBounds --> IsInExclusiveBounds for safety and correctness
- Add TriggerSelection to SelectNewRegion
  - 📝 We normally called TriggerSelection in a different layer, but it turns out, UIA's Select function wouldn't actually update the renderer. Whoops! This fixes that.
TermControl
- _getTerminalPosition now has a new param to round to the nearest cell (see Mouse selection should begin and end at nearest cell boundary #5099)
UIA
- TermControlUIAProvider::GetSelectionRange no need to convert from inclusive range to exclusive range anymore!
- TextBuffer::GetPlainText now works on an exclusive range, so no need to convert the range anymore!

Validation Steps Performed

This fundamental change impacts a lot of scenarios:

✅Rendering selections
✅Selection markers
✅Copy text
✅Session restore
✅Mark mode navigation (i.e. character, word, line, buffer)
✅Mouse selection (i.e. click+drag, shift+click, multi-click, alt+click)
✅Hyperlinks (interaction and rendering)
✅Accessibility (i.e. get selection, movement, text extraction, selecting text)
Prev/Next Command/Output (untested)
✅Unit tests
We should definitely bug bash this to get good coverage.

Follow-ups

Refactor Word Expansion in TextBuffer #4423
- Now that selection and UIA are both exclusive ranges, it should be a lot easier to deduplicate code between selection and UIA. We should be able to remove EndExclusive as well when we do that. This'll also be an opportunity to modernize that code and use more til classes.

src/buffer/out/textBuffer.cpp

src/types/UiaTextRangeBase.cpp

lhecker · 2024-10-24T20:57:23Z

src/renderer/atlas/AtlasEngine.cpp

        _fillColorBitmap(row, x1, end, fgColor, bgColor);

        // Return early if we couldn't paint the whole region (either this was not the last row, or
        // it was the last row but the highlight ends outside of our x range.)
        // We will resume from here in the next call.
-        if (!isFinalRow || hiEnd.x /*inclusive*/ >= x2 /*exclusive*/)
+        if (!isFinalRow || hiEnd.x > x2)


BTW I think we may have made a mistake here due to my poor understanding of this code. Probably needs to be mulled over once more...

yes, be careful - this is used in TWO places. search highlights and selection rendering. they're both inclusive today. this PR only says it changes one of them.

DHowett · 2024-12-02T21:01:41Z

FYI - the tests failed on all 3 platforms, which indicates a real produce code failure!

lhecker · 2024-12-03T20:12:34Z

src/cascadia/TerminalCore/TerminalSelection.cpp

+        //   To remedy this, decrement the end's position by 1.
+        //   However, only do this when expanding right (it's correct
+        //   as is when expanding left).


I'm not 100% sure if I understand this code, but to me it feels like the calling code should contain the fix for this and not this function. Is this perhaps just a case of floor VS. ceil in the calling code?

Yeah, I'm not happy about this part either. Let me explain what's going on better. The code flow is:

ControlInteractivity::SetEndSelectionPoint() (link) - called on mouse drag

ControlInteractivity::_getTerminalPosition() (link): round to the nearest cell, that way, we have to drag past a cell to "select" it

ControlCore::SetEndSelectionPoint() (link): really just clamps the position to the viewport bounds

Terminal::SetSelectionEnd() (link) --> Terminal::_SetSelectionEnd() (link):

This is the important part of the code, really. It's where we update our selection state for shift+click, pivoting, and multi-clicks (+ dragging).

The issue really only arises when we're multi-clicking+dragging (think "double-click" then drag, as it should expand by word as we drag). So the issue has to do with the expansion part. Anything before that in this function wouldn't make sense to alter, imo.

Terminal::_ExpandSelectionAnchors() (link): this is where we actually expand our selection endpoints if we're multi-clicking.

Thankfully, _ExpandSelectionAnchors() is only used in this spot. I'm not sure where else the change would make sense to go though. Open to suggestions.

carlos-zamora · 2024-12-04T18:22:38Z

All the tests are good now. The only one that failed was:

Release.x64.ConPtyTests::DiesOnClose#metadataSet0 Failed

which seems unrelated, so I'm running it again. /azp run

DHowett

18/30 i have a lot of questions after reading a few tests so i'm checkpointing here

src/host/ut_host/TextBufferTests.cpp

src/host/selection.cpp

src/cascadia/UnitTests_TerminalCore/SelectionTest.cpp

DHowett · 2024-12-11T22:08:40Z

src/cascadia/UnitTests_TerminalCore/SelectionTest.cpp

@@ -709,7 +709,7 @@ namespace TerminalCoreUnitTests
                ValidateLinearSelection(term, { 5, 10 }, { 10, 10 });


I don't understand why these coordinates did not become exclusive

Good catch! Looked into it more. Since we're moving behind the pivot, end is actually inclusive! (which, admittedly, is pretty confusing)

Leaving this thread unresolved in case we want to make any changes because of this

crazy, but i think i understand

carlos-zamora · 2025-01-21T19:11:22Z

Bug bash 1/21

When starting the selection in the right half of a cell and dragging left it'll not select the cell you started in.
...if, on the other hand, you immediately start dragging to the right it'll select both cells.
...one option would be to represent selections in float cell coordinates and use floor(top), ceil(bottom), floor(left+0.5), and ceil(right-0.5) to turn it into integer coordinates, or something.

carlos-zamora · 2025-01-23T18:28:21Z

When starting the selection in the right half of a cell and dragging left it'll not select the cell you started in.

...if, on the other hand, you immediately start dragging to the right it'll select both cells.

@DHowett (I think you filed the bug?) I wasn't able to get the issue to repro (unless I'm misunderstanding it?). Is there a desired behavior you want instead?

DHowett

30/30, couple open comments

src/cascadia/UnitTests_Control/ControlInteractivityTests.cpp

DHowett · 2025-01-23T23:52:49Z

src/cascadia/UnitTests_TerminalCore/SelectionTest.cpp

@@ -709,7 +709,7 @@ namespace TerminalCoreUnitTests
                ValidateLinearSelection(term, { 5, 10 }, { 10, 10 });


crazy, but i think i understand

DHowett · 2025-01-23T23:55:10Z

src/types/viewport.cpp

+{
+    const auto l = static_cast<ptrdiff_t>(_sr.left);
+    const auto t = static_cast<ptrdiff_t>(_sr.top);
+    const auto w = static_cast<ptrdiff_t>(std::max(0, _sr.right - _sr.left + 2));


Did you ever make that change and validate?

src/buffer/out/textBuffer.cpp

DHowett · 2025-01-24T00:07:19Z

src/buffer/out/textBuffer.cpp

+
+    // Try to move forward, but if we hit the buffer boundary, we fail to move.
+    const bool success = bufferSize.IncrementInExclusiveBounds(pos);
+    if (success &&


if we ever have glyphs more than two cells wide, this can easily become while() (i think?)

Leaving this as-is for now. We can change it to while() and fully test it out when that's the case

lhecker

I'd not delay it too much longer and just fix it up in post as needed.

## Summary of the Pull Request Fixes a bug where VT mouse mode would round to the nearest cell when clicking the mouse button. The fix is to round to the nearest cell only when we're selecting text. The other scenarios affected are: - clicking on a hyperlink - vt mouse mode - where the context menu is anchored Really the most notable ones were the first two. So now, we use the position of the cell we clicked on. We only round for selection. ## References and Relevant Issues Follow-up to #18106 ## Detailed Description of the Pull Request / Additional comments ## Validation Steps Performed Opened Midnight Commander in Ubuntu and clicked between the two panes. - Before: threshold was too early to switch between panes - After: threshold is clearly separated between the outline of the two panes --------- Co-authored-by: Dustin L. Howett <duhowett@microsoft.com>

carlos-zamora and others added 17 commits October 15, 2024 10:05

[AtlasEngine] Render selection as exclusive range

aa95790

Fix any side-effects of making GetText exclusive

4697f49

Update selection markers appropriately

4364643

[Mark Mode] Move by character (includes wide-glyph handling)

014f338

[Mark Mode] Move by viewport

ba673a4

[Mark Mode] Move by buffer

cd2da0e

[Mark Mode] Move by word

ff45eb9

[Mark Mode] Handle move up/down onto middle of emoji

659cd02

Bugfix: renderer highlights lines when at x-boundary

e7ca807

Bugfix: move to next word would move past mutable bottom

7ff4838

Fix some more rendering issues

928e9a9

Fix more rendering issues w/ Leonard

9d361d2

Fix highlighting in AtlasEngine

845e43d

fix session restore

8b996a9

Ensure mouse selection scenarios work right

df89ad0

Fix UIA

9e9db42

Fix hyperlinks

eea8399

github-advanced-security bot found potential problems Oct 23, 2024

View reviewed changes

src/buffer/out/textBuffer.cpp Fixed Show fixed Hide fixed

src/buffer/out/textBuffer.cpp Fixed Show fixed Hide fixed

src/buffer/out/textBuffer.cpp Fixed Show fixed Hide fixed

src/buffer/out/textBuffer.cpp Fixed Show fixed Hide fixed

This comment has been minimized.

Sign in to view

carlos-zamora commented Oct 23, 2024

View reviewed changes

src/types/UiaTextRangeBase.cpp Outdated Show resolved Hide resolved

fix tests

7bfd647

This comment has been minimized.

Sign in to view

microsoft-github-policy-service bot added the Issue-Feature Complex enough to require an in depth planning process and actual budgeted, scheduled work. label Oct 24, 2024

lhecker reviewed Oct 24, 2024

View reviewed changes

carlos-zamora added 2 commits November 26, 2024 15:08

bugfix: don't select trailing whitespace with mouse word selection

d179e9c

bugfix: click+drag on cell should select the cell we're on

d2ed09e

carlos-zamora added 2 commits December 3, 2024 10:16

bugfix: double-click + drag would prematurely expand

37ad74f

fix tests; fix conhost block selection

dbfdf81

lhecker reviewed Dec 3, 2024

View reviewed changes

fix terminal core selection tests

bee9371

DHowett requested changes Dec 11, 2024

View reviewed changes

microsoft-github-policy-service bot added Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something and removed Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something labels Dec 11, 2024

carlos-zamora added 2 commits December 13, 2024 17:26

fix tests and add more comments to preserve sanity

44a1e42

simplify and add comment

4764653

carlos-zamora added the zBugBash-Consider label Jan 14, 2025

carlos-zamora added 2 commits January 17, 2025 12:31

Fix failing test & ExpandSelectionToWord

7290330

aha! That's why the .x was there!

260dc99

carlos-zamora added a commit that referenced this pull request Jan 20, 2025

PRE-MERGE #18106 Make selection an exclusive range

02f8e5c

DHowett requested changes Jan 24, 2025

View reviewed changes

microsoft-github-policy-service bot added Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something and removed Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something labels Jan 24, 2025

lhecker approved these changes Jan 27, 2025

View reviewed changes

carlos-zamora added 2 commits January 27, 2025 13:39

remove TODO

c8c0169

Merge branch 'main' into dev/cazamor/sln/exclusive-end

7252ab9

DHowett approved these changes Jan 28, 2025

View reviewed changes

DHowett merged commit 64d4fba into main Jan 28, 2025
20 checks passed

DHowett deleted the dev/cazamor/sln/exclusive-end branch January 28, 2025 22:54

carlos-zamora mentioned this pull request Jan 31, 2025

Bugfix: only round to the nearest cell for selection #18486

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make selection an exclusive range #18106

Make selection an exclusive range #18106

carlos-zamora commented Oct 23, 2024 •

edited

Loading

This comment has been minimized.

This comment has been minimized.

lhecker Oct 24, 2024

DHowett Nov 8, 2024

DHowett commented Dec 2, 2024

lhecker Dec 3, 2024

carlos-zamora Dec 3, 2024

carlos-zamora commented Dec 4, 2024

DHowett left a comment

DHowett Dec 11, 2024

carlos-zamora Dec 14, 2024

DHowett Jan 23, 2025

carlos-zamora commented Jan 21, 2025

carlos-zamora commented Jan 23, 2025

DHowett left a comment

DHowett Jan 23, 2025

DHowett Jan 23, 2025

DHowett Jan 24, 2025

carlos-zamora Jan 27, 2025

lhecker left a comment

		@@ -709,7 +709,7 @@ namespace TerminalCoreUnitTests
		ValidateLinearSelection(term, { 5, 10 }, { 10, 10 });

Make selection an exclusive range #18106

Make selection an exclusive range #18106

Conversation

carlos-zamora commented Oct 23, 2024 • edited Loading

Summary of the Pull Request

References and Relevant Issues

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

Follow-ups

This comment has been minimized.

This comment has been minimized.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DHowett commented Dec 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carlos-zamora commented Dec 4, 2024

DHowett left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carlos-zamora commented Jan 21, 2025

Bug bash 1/21

carlos-zamora commented Jan 23, 2025

DHowett left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lhecker left a comment

Choose a reason for hiding this comment

carlos-zamora commented Oct 23, 2024 •

edited

Loading