Implement Keyboard Selection #10824

carlos-zamora · 2021-07-29T23:46:39Z

Summary of the Pull Request

Implements the following keyboard selection non-configurable key bindings:

shift+arrow --> move endpoint by character
ctrl+shift+left/right --> move endpoint by word
shift+home/end --> move to beginning/end of line
ctrl+shift+home/end --> move to beginning/end of buffer

This was purposefully done in the ControlCore layer to make keyboard selection an innate part of how the terminal functions (aka a shared component across terminal consumers).

References

#715 - Keyboard Selection
#2840 - Spec

Detailed Description of the Pull Request / Additional comments

The most relevant section is TerminalSelection.cpp, where we define how each movement operates. It's basically a giant embedded switch-case statement. We leverage a lot of the work done in a11y to perform the movements.

Validation Steps Performed

General cases:
- test all of the key bindings added
Corner cases:
- char: wide glyph support
- word: move towards, away, and across the selection pivot
- automatically scroll viewport
- ESC (and other key combos) are still clearing the selection properly

carlos-zamora · 2021-07-29T23:47:07Z

Discussion

settings names:
- "mode" --> "expansionMode"? More descriptive but might not be necessary
- "updateSelection" --> "moveSelectionAnchor"? Sounds too descriptive imo
- "view" --> "viewport"? Unsure if "view" is clear, but "viewport" is too in-the-know
- "buffer" --> ???
- ~~"cell" --> "char"? We support wide glyphs, so this might be more correct?~~ Resolved by 5b4dd33
behavior:
- word selection currently operates like mouse selection (select by runs of same delimiter class, not "words" [i.e. "abc " is "abc" and " "]). Text editors behave differently by (un)selecting the whitespace next to the word. Should we consider this a backlog follow-up item? Do we want selection to work this way?
- buffer selection moves to the end of the full buffer. Something we can't see and that isn't very helpful. Should we set the "end of the buffer" to something more useful/reasonable? Like the bottom of the mutable viewport? Resolved by Implement Keyboard Selection #10824 (comment)
known issues (unrelated to this PR)
- ~~rendering issue:~~ Resolved by Implement Keyboard Selection #10824 (comment)
  - ~~select up by viewport; select one cell down; BUG: top line still selected~~
  - ~~NOTE: select up one cell and down again and it fixes itself~~

zadjii-msft

I guess I'm blocking only for the GenerateName thing? And update the docs? But I suppose the second can wait for the naming discussions to be finalized. Code looks great though.

Already looking forward to 1.12!

src/cascadia/TerminalSettingsModel/ActionArgs.cpp

zadjii-msft · 2021-08-11T13:41:49Z

src/cascadia/TerminalSettingsModel/defaults.json

+        { "command": {"action": "updateSelection", "direction": "down", "mode": "view" }, "keys": "shift+pgdn" },
+        { "command": {"action": "updateSelection", "direction": "up", "mode": "buffer" }, "keys": "ctrl+shift+home" },
+        { "command": {"action": "updateSelection", "direction": "down", "mode": "buffer" }, "keys": "ctrl+shift+end" },
+


ah ohkay, we'll need a separate action for selectAll. That's fine.

Yeah, that can be a separate PR too

src/cascadia/TerminalCore/TerminalSelection.cpp

zadjii-msft · 2021-08-11T13:48:19Z

src/cascadia/TerminalCore/TerminalSelection.cpp

+    // 4. Scroll (if necessary)
+    if (const auto viewport = _GetVisibleViewport(); !viewport.IsInBounds(targetPos))
+    {
+        if (const auto amtAboveView = viewport.Top() - targetPos.Y; amtAboveView > 0)


little surprised that spellbot didn't complain about amt here.

src/cascadia/TerminalCore/TerminalSelection.cpp

zadjii-msft · 2021-08-11T14:15:51Z

settings names:

"cell" --> "char"? We support wide glyphs, so this might be more correct?

this is the only change I feel is necessary. char is better. The rest are fine

behavior:

...Text editors behave differently by (un)selecting the whitespace next to the word. Should we consider this a backlog follow-up item? Do we want selection to work this way?

please no god no. IMO, bad text editors behave this way. Code editors generally don't.

buffer selection moves to the end of the full buffer. Something we can't see and that isn't very helpful. Should we set the "end of the buffer" to something more useful/reasonable? Like the bottom of the mutable viewport?

Yea, the mutable bottom is more reasonable. The "scroll forward" doesn't exist for all intents and purposes.

zadjii-msft · 2021-08-18T15:46:42Z

shh bot

carlos-zamora · 2021-08-18T22:46:36Z

buffer selection moves to the end of the full buffer. Something we can't see and that isn't very helpful. Should we set the "end of the buffer" to something more useful/reasonable? Like the bottom of the mutable viewport?

Yea, the mutable bottom is more reasonable. The "scroll forward" doesn't exist for all intents and purposes.

Updated _MoveByViewport and _MoveByBuffer to clamp to the mutable bottom. It feels really nice!

carlos-zamora · 2021-08-18T23:57:44Z

It looks like Terminal.hpp can't find SelectionExpansion from ICoreSettings.idl when in CI, but it builds just fine locally. Any ideas?

zadjii-msft · 2021-09-09T14:35:36Z

That's so bizarre that this works locally, but not in CI. My guess is related to this bit at the top of Terminal.hpp:

// You have to forward decl the ICoreSettings here, instead of including the header.
// If you include the header, there will be compilation errors with other
//      headers that include Terminal.hpp
namespace winrt::Microsoft::Terminal::Core
{
    struct ICoreSettings;
    struct ICoreAppearance;
}

OH I know why, it's because you're not building PublicTerminalCore locally. That's the one that's failing 😋

zadjii-msft · 2021-09-09T15:05:22Z

ad99008 might work to fix this. It certainly did locally. Take it or leave it :P

src/cascadia/TerminalCore/Terminal.hpp

zadjii-msft

I hate the duplicated enums, but I understand the world we live in

src/cascadia/PublicTerminalCore/HwndTerminal.cpp

src/cascadia/TerminalCore/Terminal.cpp

Dismissing Mike's review because this iteration was a major design change and I wanna make sure he's on board.

carlos-zamora · 2021-09-17T21:30:33Z

Assigning @DHowett because he has some very passionate thoughts on keyboard selection haha

zadjii-msft

lhecker · 2021-09-22T16:18:34Z

src/buffer/out/textBuffer.cpp

 // Return Value:
 // - pos - The COORD for the last cell of the current glyph (exclusive)
-const til::point TextBuffer::GetGlyphEnd(const til::point pos, std::optional<til::point> limitOptional) const
+const til::point TextBuffer::GetGlyphEnd(const til::point pos, bool accessibilityMode, std::optional<til::point> limitOptional) const


(The amount of arguments our TextBuffer member functions have is worrying ngl. 😄)

Why does "accessibility mode" mean "become exclusive" here? Don't you mean "bool exclusivePosition"?

Yeeeeaaaaah. So, a11y and selection have a lot of similarities and very small/important differences. Some highlights include...

Selection A11y

endpoint representation both endpoints are inclusive; start <= end inclusive start; exclusive end; start <= end

definition of a word a run of legible characters run of legible characters + run of whitespace after it (until next word starts)

I just chose to name the parameter accessibilityMode to make it clear what and when we're only doing some extra work for a11y.

src/cascadia/TerminalControl/ControlCore.cpp

src/cascadia/TerminalCore/TerminalSelection.cpp

zadjii-msft · 2021-09-23T17:39:03Z

src/cascadia/TerminalControl/ControlCore.cpp

-        // GH#8522, GH#3758 - Only dismiss the selection on key _down_. If we
-        // dismiss on key up, then there's chance that we'll immediately dismiss
+        // GH#8522, GH#3758 - Only modify the selection on key _down_. If we
+        // modify on key up, then there's chance that we'll immediately dismiss


<showerthought>

If we could handle this modification on key up, then could we do something like bind markMode to shift+left, and have the shift+left keydown enter mark mode, and the keyup extend the selection to the left? Essentially getting quickedit-like selection?

This is of course, crazy, but something to think about

HECK IT DOESN"T EVEN MATTER

a user could just bind markmost to shift+left, and that would start a selection at the cursor, and the subsequent keypresses would extend it without hitting the keybinding, which is actually just like conhost. Brilliant 🥂

zadjii-msft · 2021-09-23T19:16:11Z

ghost · 2021-10-20T17:07:55Z

🎉Windows Terminal Preview v1.12.2922.0 has been released which incorporates this pull request.:tada:

Handy links:

## Summary of the Pull Request 1.14 port of #13318 Introduced in #10824, this fixes a bug where you could use keyboard selection to move below the scroll area. Instead, we now clamp movement to the mutable viewport (aka the scrollable area). Specifically, we only clamp the y-coordinate to make the experience similar to that of mouse selection. ## Validation Steps Performed ✅ (no output) try to move past bottom of viewport ✅ (with output, at bottom of scroll area) try to move past viewport ✅ (with output, NOT at bottom of scroll area) try to move past viewport ✅ try to move past top of viewport

## Summary of the Pull Request Introduced in #10824, this fixes a bug where you could use keyboard selection to move below the scroll area. Instead, we now clamp movement to the mutable viewport (aka the scrollable area). Specifically, we clamp to the corners (i.e. 0,0 or bottom right cell of scroll area). ## Validation Steps Performed ✅ (no output) try to move past bottom of viewport ✅ (with output, at bottom of scroll area) try to move past viewport ✅ (with output, NOT at bottom of scroll area) try to move past viewport ✅ try to move past top of viewport

carlos-zamora force-pushed the dev/cazamor/keyboard-selection branch 2 times, most recently from 1df76e6 to 841cd2a Compare July 31, 2021 00:13

carlos-zamora mentioned this pull request Aug 4, 2021

Add selection marker overlays for keyboard selection #10865

Merged

zadjii-msft requested changes Aug 11, 2021

View reviewed changes

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Aug 11, 2021

zadjii-msft mentioned this pull request Aug 11, 2021

Keyboard Selection Spec #2840

Merged

ghost added the No-Recent-Activity This issue/PR is going stale and may be auto-closed without further activity. label Aug 18, 2021

This comment has been minimized.

Sign in to view

zadjii-msft removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Aug 18, 2021

ghost removed the No-Recent-Activity This issue/PR is going stale and may be auto-closed without further activity. label Aug 18, 2021

carlos-zamora force-pushed the dev/cazamor/keyboard-selection branch from 5b4dd33 to b2a7a19 Compare August 18, 2021 23:20

carlos-zamora marked this pull request as ready for review August 18, 2021 23:20

carlos-zamora mentioned this pull request Aug 18, 2021

Document Keyboard Selection MicrosoftDocs/terminal#390

Merged

zadjii-msft added this to the Terminal v1.12 milestone Aug 26, 2021

carlos-zamora force-pushed the dev/cazamor/keyboard-selection branch from 5297b80 to 0cc9bd0 Compare September 2, 2021 22:04

zadjii-msft assigned carlos-zamora Sep 9, 2021

carlos-zamora force-pushed the dev/cazamor/keyboard-selection branch from 95967ec to 7179804 Compare September 14, 2021 00:07

zadjii-msft reviewed Sep 14, 2021

View reviewed changes

src/cascadia/TerminalCore/Terminal.hpp Outdated Show resolved Hide resolved

zadjii-msft previously approved these changes Sep 14, 2021

View reviewed changes

src/cascadia/PublicTerminalCore/HwndTerminal.cpp Outdated Show resolved Hide resolved

carlos-zamora removed their assignment Sep 14, 2021

carlos-zamora commented Sep 14, 2021

View reviewed changes

src/cascadia/TerminalCore/Terminal.cpp Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

carlos-zamora marked this pull request as draft September 16, 2021 22:19

remove configurability

118d1cd

carlos-zamora force-pushed the dev/cazamor/keyboard-selection branch from e498dea to 118d1cd Compare September 17, 2021 02:58

carlos-zamora marked this pull request as ready for review September 17, 2021 02:59

polish and fix build

30009eb

carlos-zamora assigned DHowett Sep 17, 2021

zadjii-msft approved these changes Sep 22, 2021

View reviewed changes

zadjii-msft added the Needs-Second It's a PR that needs another sign-off label Sep 22, 2021

ghost requested review from miniksa, leonMSFT, PankajBhojwani and lhecker September 22, 2021 15:31

lhecker reviewed Sep 22, 2021

View reviewed changes

carlos-zamora unassigned DHowett Sep 23, 2021

zadjii-msft reviewed Sep 23, 2021

View reviewed changes

address Leonard's comments

b784262

lhecker approved these changes Sep 23, 2021

View reviewed changes

carlos-zamora merged commit c070be1 into main Sep 23, 2021

carlos-zamora deleted the dev/cazamor/keyboard-selection branch September 23, 2021 19:24

zadjii-msft mentioned this pull request Dec 2, 2021

Vi mode (READ: Allow selection keys to be rebound to different keys) #11868

Open

zadjii-msft mentioned this pull request Mar 14, 2022

Scenario: Keyboard Text Selection #4993

Open

11 tasks

carlos-zamora mentioned this pull request May 5, 2022

Add ability to select all text in the buffer #13045

Merged

2 tasks

This was referenced Jun 17, 2022

Fix moving selection past scroll area #13318

Merged

[1.14] Fix moving selection past scroll area #13353

Merged

carlos-zamora mentioned this pull request Jun 28, 2022

Moving the cursor when scrolling in the history to select text #4985

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Keyboard Selection #10824

Implement Keyboard Selection #10824

carlos-zamora commented Jul 29, 2021 •

edited

Loading

carlos-zamora commented Jul 29, 2021 •

edited

Loading

zadjii-msft left a comment

zadjii-msft Aug 11, 2021

carlos-zamora Aug 18, 2021

zadjii-msft Aug 11, 2021

zadjii-msft commented Aug 11, 2021

This comment has been minimized.

zadjii-msft commented Aug 18, 2021

carlos-zamora commented Aug 18, 2021

carlos-zamora commented Aug 18, 2021

zadjii-msft commented Sep 9, 2021

zadjii-msft commented Sep 9, 2021

zadjii-msft left a comment

This comment has been minimized.

carlos-zamora commented Sep 17, 2021

zadjii-msft left a comment

lhecker Sep 22, 2021 •

edited

Loading

carlos-zamora Sep 23, 2021

zadjii-msft Sep 23, 2021

zadjii-msft Sep 23, 2021

zadjii-msft commented Sep 23, 2021

ghost commented Oct 20, 2021

	Selection	A11y
endpoint representation	both endpoints are inclusive; start <= end	inclusive start; exclusive end; start <= end
definition of a word	a run of legible characters	run of legible characters + run of whitespace after it (until next word starts)

Implement Keyboard Selection #10824

Implement Keyboard Selection #10824

Conversation

carlos-zamora commented Jul 29, 2021 • edited Loading

Summary of the Pull Request

References

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

carlos-zamora commented Jul 29, 2021 • edited Loading

Discussion

zadjii-msft left a comment

Choose a reason for hiding this comment

zadjii-msft Aug 11, 2021

Choose a reason for hiding this comment

carlos-zamora Aug 18, 2021

Choose a reason for hiding this comment

zadjii-msft Aug 11, 2021

Choose a reason for hiding this comment

zadjii-msft commented Aug 11, 2021

This comment has been minimized.

zadjii-msft commented Aug 18, 2021

carlos-zamora commented Aug 18, 2021

carlos-zamora commented Aug 18, 2021

zadjii-msft commented Sep 9, 2021

zadjii-msft commented Sep 9, 2021

zadjii-msft left a comment

Choose a reason for hiding this comment

This comment has been minimized.

carlos-zamora commented Sep 17, 2021

zadjii-msft left a comment

Choose a reason for hiding this comment

lhecker Sep 22, 2021 • edited Loading

Choose a reason for hiding this comment

carlos-zamora Sep 23, 2021

Choose a reason for hiding this comment

zadjii-msft Sep 23, 2021

Choose a reason for hiding this comment

zadjii-msft Sep 23, 2021

Choose a reason for hiding this comment

zadjii-msft commented Sep 23, 2021

ghost commented Oct 20, 2021

carlos-zamora commented Jul 29, 2021 •

edited

Loading

carlos-zamora commented Jul 29, 2021 •

edited

Loading

lhecker Sep 22, 2021 •

edited

Loading