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.

lhecker · 2024-10-24T20:59:11Z

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));


I think this should be +1. BTW is this function really needed? We already have WalkInBounds with the allowEndExclusive parameter that we could set to false no?

Ah, so allowEndExclusive is slightly different. EndExclusive = (Left, BottomExclusive). allowEndExclusive was designed to make WalkInBounds(true) still walk from Left --> RightInclusive, but when we get to the last cell of the bottom inclusive row, we wrap onto the next line (EndExclusive). This made it so that we're able to represent the UIA start/end as an exclusive range, and we'd be able to include the last cell of the buffer by making end = EndExclusive.

In hindsight, I think the right move should've been to make EndExclusive = (RightExclusive, BottomInclusive). This PR makes selection do that and adds these extra APIs. I think it's much cleaner. But yeah, I wouldn't want to port UIA over to this system until it gets reviewed and merged. So I'm making that work a part of #4423 as a follow-up (where we should be able to remove EndExclusive altogether).

As for the +1, I honestly don't remember why I made it +2... you're probably right. I'll make that change and validate.

DHowett

IOU a review here - thanks for doing it!

DHowett · 2024-11-04T23:19:14Z

However, all of the tests exploded so... I may wait. :P

DHowett

Have you tested...

detecting URls
selecting URLs
search highlights (with and without regexes)

src/buffer/out/UTextAdapter.cpp

DHowett · 2024-11-07T23:56:41Z

src/cascadia/TerminalControl/ControlCore.cpp

        til::point terminalPosition{
-            std::clamp(position.x, 0, _terminal->GetViewport().Width() - 1),
+            std::clamp(position.x, -1, _terminal->GetViewport().Width()),


i see the comment says "allow range of", but... i can see that from the code too. why?

DHowett · 2024-11-08T00:06:49Z

src/renderer/base/renderer.cpp

@@ -342,9 +342,8 @@ try
            const til::rect vp{ _viewport.ToExclusive() };
            for (auto&& sp : spans)
            {
-                sp.iterate_rows(bufferWidth, [&](til::CoordType row, til::CoordType min, til::CoordType max) {
+                sp.iterate_rows_exclusive(bufferWidth, [&](til::CoordType row, til::CoordType min, til::CoordType max) {


careful! this touches conhost code too. ... !

this may make selections not work properly in conhost

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 removed the Priority-3 A description (P3) label Oct 25, 2024

microsoft-github-policy-service bot added the Priority-3 A description (P3) label Oct 25, 2024

DHowett reviewed Nov 4, 2024

View reviewed changes

fix other tests

52f3bc0

This comment has been minimized.

Sign in to view

carlos-zamora added 4 commits November 5, 2024 15:43

spell

408d149

[UIA] allow end exclusive

57b82cb

audit

e98033e

fix some more tests

e621c1c

carlos-zamora requested review from lhecker and DHowett November 7, 2024 20:00

DHowett reviewed Nov 7, 2024

View reviewed changes

DHowett reviewed Nov 8, 2024

View reviewed changes

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

lhecker Oct 24, 2024

carlos-zamora Oct 30, 2024

DHowett left a comment

DHowett commented Nov 4, 2024

This comment has been minimized.

DHowett left a comment

DHowett Nov 7, 2024

DHowett Nov 8, 2024

Make selection an exclusive range #18106

Are you sure you want to change the base?

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.

lhecker Oct 24, 2024

Choose a reason for hiding this comment

DHowett Nov 8, 2024

Choose a reason for hiding this comment

lhecker Oct 24, 2024

Choose a reason for hiding this comment

carlos-zamora Oct 30, 2024

Choose a reason for hiding this comment

DHowett left a comment

Choose a reason for hiding this comment

DHowett commented Nov 4, 2024

This comment has been minimized.

DHowett left a comment

Choose a reason for hiding this comment

DHowett Nov 7, 2024

Choose a reason for hiding this comment

DHowett Nov 8, 2024

Choose a reason for hiding this comment

carlos-zamora commented Oct 23, 2024 •

edited

Loading