18 KiB
| author | created on | last updated | issue id |
|---|---|---|---|
| Carlos Zamora @carlos-zamora | 2019-08-30 | 2021-09-23 | 715 |
Keyboard Selection
Abstract
This spec describes a new set of key bindings that allows the user to create and update a selection without the use of a mouse or stylus.
Inspiration
ConHost allows the user to modify a selection using the keyboard. Holding Shift allows the user to move the second selection endpoint in accordance with the arrow keys. The selection endpoint updates by one cell per key event, allowing the user to refine the selected region.
Creating a selection
Mark Mode is a ConHost feature that allows the user to create a selection using only the keyboard. In CMD, pressing ctrl+m enters mark mode. The current cursor position becomes a selection endpoint. The user can use the arrow keys to move that endpoint. While the user then holds shift, the selection endpoint ('start') is anchored to it's current position, and the arrow keys move the other selection endpoint ('end').
Additionally, pressing shift+arrow also initiates a selection, but it anchors the first selection endpoint to the cursor position.
Other terminal emulators have different approaches to this feature. iTerm2, for example, has Copy Mode (documentation linked here). Here, cmd+shift+c makes the current cursor position become a selection endpoint. The arrow keys can be used to move that endpoint. However, unlike Mark Mode, a key binding c+space is used to change the start/stop selecting. The first time it's pressed, the 'start' endpoint is anchored. The second time it's pressed, the 'end' endpoint is set. After this, you can still move a cursor, but the selection persists until a new selection is created (either by pressing the key binding again, or using the mouse).
Though tmux is not a terminal emulator, it does also have Copy Mode that behaves fairly similarly to that of iTerm2's.
Solution Design
The fundamental solution design for keyboard selection is that the responsibilities between the Terminal Control and Terminal Core must be very distinct. The Terminal Control is responsible for handling user interaction and directing the Terminal Core to update the selection. The Terminal Core will need to update the selection according to the direction of the Terminal Control. Terminal Core maintains the state of the selection.
Relatively recently, TerminalControl was split into TerminalControl, ControlInteractivity, and ControlCore. Changes made to ControlInteractivity, ControlCore, and below propagate functionality to all consumers, meaning that the WPF terminal would benefit from these changes with no additional work required.
Fundamental Terminal Control Changes
ControlCore::TrySendKeyEvent() is responsible for handling the key events after key bindings are dealt with in TermControl. At the time of writing this spec, there are 2 cases handled in this order:
- Clear the selection (except in a few key scenarios)
- Send Key Event
The first branch will be updated to modify the selection instead of usually clearing it. This will happen by converting the key event into parameters to forward to TerminalCore, which then updates the selection appropriately.
Idea: Make keyboard selection a collection of standard keybindings
One idea is to introduce an updateSelection action that conditionally works if a selection is active (similar to the copy action). For these key bindings, if there is no selection, the key events are forwarded to the application.
Thanks to Keybinding Args, there would only be 1 new command:
| Action | Keybinding Args | Description |
|---|---|---|
updateSelection |
If a selection exists, moves the last selection endpoint. | |
Enum direction { up, down, left, right } |
The direction the selection will be moved in. | |
Enum mode { char, word, view, buffer } |
The context for which to move the selection endpoint to. (defaults to char) |
By default, the following keybindings will be set:
// Character Selection
{ "command": {"action": "updateSelection", "direction": "left", "mode": "char" }, "keys": "shift+left" },
{ "command": {"action": "updateSelection", "direction": "right", "mode": "char" }, "keys": "shift+right" },
{ "command": {"action": "updateSelection", "direction": "up", "mode": "char" }, "keys": "shift+up" },
{ "command": {"action": "updateSelection", "direction": "down", "mode": "char" }, "keys": "shift+down" },
// Word Selection
{ "command": {"action": "updateSelection", "direction": "left", "mode": "word" }, "keys": "ctrl+shift+left" },
{ "command": {"action": "updateSelection", "direction": "right", "mode": "word" }, "keys": "ctrl+shift+right" },
// Viewport Selection
{ "command": {"action": "updateSelection", "direction": "left", "mode": "view" }, "keys": "shift+home" },
{ "command": {"action": "updateSelection", "direction": "right", "mode": "view" }, "keys": "shift+end" },
{ "command": {"action": "updateSelection", "direction": "up", "mode": "view" }, "keys": "shift+pgup" },
{ "command": {"action": "updateSelection", "direction": "down", "mode": "view" }, "keys": "shift+pgdn" },
// Buffer Corner Selection
{ "command": {"action": "updateSelection", "direction": "up", "mode": "buffer" }, "keys": "ctrl+shift+home" },
{ "command": {"action": "updateSelection", "direction": "down", "mode": "buffer" }, "keys": "ctrl+shift+end" },
These are in accordance with ConHost's keyboard selection model.
This idea was abandoned due to several reasons:
- Keyboard selection should be a standard way to interact with a terminal across all consumers (i.e. WPF control, etc.)
- There isn't really another set of key bindings that makes sense for this. We already hardcoded ESC as a way to clear the selection. This is just an extension of that.
- Adding 12 conditionally effective key bindings takes the spot of 12 potential non-conditional key bindings. It would be nice if a different key binding could be set when the selection is not active, but that makes the settings design much more complicated.
- 12 new items in the command palette is also pretty excessive.
- If proven wrong when this is in WT Preview, we can revisit this and make them customizable then. It's better to add the ability to customize it later than take it away.
Idea: Make keyboard selection a simulation of mouse selection
It may seem that some effort can be saved by making the keyboard selection act as a simulation of mouse selection. There is a union of mouse and keyboard activity that can be represented in a single set of selection motion interfaces that are commanded by the TermControl's Mouse/Keyboard handler and adapted into appropriate motions in the Terminal Core.
However, the mouse handler operates by translating a pixel coordinate on the screen to a text buffer coordinate. This would have to be rewritten and the approach was deemed unworthy.
Fundamental Terminal Core Changes
The Terminal Core will need to expose a UpdateSelection() function that is called by the keybinding handler. The following parameters will need to be passed in:
enum SelectionDirection: the direction that the selection endpoint will attempt to move to. Possible values includeUp,Down,Left, andRight.enum SelectionExpansion: the selection expansion mode that the selection endpoint will adhere to. Possible values includeChar,Word,View,Buffer.
Moving by Cell
For SelectionExpansion = Char, the selection endpoint will be updated according to the buffer's output pattern. For horizontal movements, the selection endpoint will attempt to move left or right. If a viewport boundary is hit, the endpoint will wrap appropriately (i.e.: hitting the left boundary moves it to the last cell of the line above it).
For vertical movements, the selection endpoint will attempt to move up or down. If a viewport boundary is hit and there is a scroll buffer, the endpoint will move and scroll accordingly by a line.
If a buffer boundary is hit, the endpoint will not move. In this case, however, the event will still be considered handled.
NOTE: An important thing to handle properly in all cases is wide glyphs. The user should not be allowed to select a portion of a wide glyph; it should be all or none of it. When calling _ExpandWideGlyphSelection functions, the result must be saved to the endpoint.
Moving by Word
For SelectionExpansion = Word, the selection endpoint will also be updated according to the buffer's output pattern, as above. However, the selection will be updated in accordance with "chunk selection" (performing a double-click and dragging the mouse to expand the selection). For horizontal movements, the selection endpoint will be updated according to the _ExpandDoubleClickSelection functions. The result must be saved to the endpoint. As before, if a boundary is hit, the endpoint will wrap appropriately. See Future Considerations for how this will interact with line wrapping.
For vertical movements, the movement is a little more complicated than before. The selection will still respond to buffer and viewport boundaries as before. If the user is trying to move up, the selection endpoint will attempt to move up by one line, then selection will be expanded leftwards. Alternatively, if the user is trying to move down, the selection endpoint will attempt to move down by one line, then the selection will be expanded rightwards.
Moving by Viewport
For SelectionExpansion = View, the selection endpoint will be updated according to the viewport's height. Horizontal movements will be updated according to the viewport's width, thus resulting in the endpoint being moved to the left/right boundary of the viewport.
Moving by Buffer
For SelectionExpansion = Buffer, the selection endpoint will be moved to the beginning or end of all the text within the buffer. If moving up or left, set the position to 0,0 (the origin of the buffer). If moving down or right, set the position to the last character in the buffer.
NOTE: In all cases, horizontal movements attempting to move past the left/right viewport boundaries result in a wrap. Vertical movements attempting to move past the top/bottom viewport boundaries will scroll such that the selection is at the edge of the screen. Vertical movements attempting to move past the top/bottom buffer boundaries will be clamped to be within buffer boundaries.
NOTE: If copyOnSelect is enabled, we need to make sure we DO NOT update the clipboard on every change in selection. The user must explicitly choose to copy the selected text from the buffer.
Copy Mode
Copy Mode is a mode where the user can create and modify a selection using only the keyboard. The following flowchart covers how the new copymode() action works:
![Copy Mode Flowchart][images/CopyModeFlowchart.png]
NOTE: copyMode() refers to the action, whereas updateSelection() refers to the underlying function that is being called in the code.
If a selection is not active, a "start" and "end" selection point is created at the cursor position. updateSelection() calls then move "start" and "end" together as one position. This position will be denoted with a "y-beam".
![Y-Beam Example][images/Y-Beam.png]
If a selection is active, copyMode leaves the selection untouched, all subsequent updateSelection() calls move "start". The y-beam is then cut vertically in half, where one half is drawn on the "start" endpoint, and the other half is drawn on the "end" endpoint. Since the user is moving "start", only the half-y-beam is drawn on the "start" endpoint.
![Separated Y-Beam Example][images/Half-Y-Beam.png]
NOTE: Both half y-beams could have been presented as shown in the image below. This idea was omitted because then there is no indication for which half y-beam is currently focused.
![Both Separated Y-Beams Example][images/Split-Y-Beam.png]
Invoking copyMode() again, will then anchor "start" (meaning that it will be kept in place). Subsequent updateSelection() calls move the "end" selection point. As before, the half-y-beam is only drawn on the "end" to denote that this is the endpoint that is being moved.
Invoking copyMode() essentially cycles between which selection point is targeted. The half-y-beam is drawn on the targeted endpoint.
Block Selection
A user can normally create a block selection by holding alt then creating a selection.
If the user is in Copy Mode, and desires to make a block selection, they can use the toggleBlockSelection() action. toggleBlockSelection() takes an existing selection, and transforms it into a block selection (or vice-versa).
All selections created in Copy Mode will have block selection disabled by default.
Rendering during Copy Mode
Since we are just moving the selection endpoints, rendering the selection rects should operate normally. We need to ensure that we still scroll when we move a selection point past the top/bottom of the viewport.
In ConHost, output would be paused when a selection was present. Windows Terminal does not pause the output when a selection is present, however, it does not scroll to the new output.
Interaction with CopyOnSelect
If copyOnSelect is enabled, the selection is copied when the selection operation is "complete". Thus, the selection is copied when the copy keybinding is used or the selection is copied using the mouse.
Interaction with Mouse Selection
If a selection exists, the user is basically already in Copy Mode. The user should be modifying the "end" endpoint of the selection when using the updateSelection() bindings. The existing selection should not be cleared (contrary to prior behavior). However, the half-y-beam will not be drawn. Once the user presses the copyMode or moveSelectionPoint keybinding, the half-y-beam is drawn on the targeted endpoint (which will then be "start").
During Copy Mode, if the user attempts to create a selection using the mouse, any existing selections are cleared and the mouse creates a selection normally. However, contrary to prior behavior, the user will still be in Copy Mode. The target endpoint being modified in Copy Mode, however, will be the "end" endpoint of the selection, instead of the cursor (as explained earlier in the flowchart).
Exiting Copy Mode
The user exits copy mode when the selection is cleared. Thus, the user can press...
- the
ESCkey - the
copy()action (which also copies the contents of the selection to the user's clipboard) - keys that generate input and clear a selection
In all of these cases, the selection will be cleared.
If copyOnSelect is enabled, ESC is interpreted as "cancelling" the selection, so nothing is copied. Keys that generate input are also interpreted as "cancelling" the selection. Only the copy keybinding or copying using the mouse is considered "completing" the selection operation, and copying the content to the clipboard.
NOTE - Related to #3884: If the user has chosen to have selections persist after a copy operation, the selection created by Copy Mode is treated no differently than one created with the mouse. The selection will persist after a copy operation. However, if the user exits Copy Mode in any of the other situations, the selection is cleared.
UI/UX Design
Key Bindings
There will only be 1 new command that needs to be added:
| Action | Keybinding Args | Description |
|---|---|---|
selectAll |
Select the entire text buffer. | |
copyMode |
Cycle the selection point targeted by moveSelectionPoint. If no selection exists, a selection is created at the cursor. |
|
toggleBlockSelection |
Transform the existing selection between a block selection and a line selection. |
By default, the following key binding will be set:
{ "command": "selectAll", "keys": "ctrl+shift+a" },
// Copy Mode
{ "command": "copyMode", "keys": "ctrl+shift+m" },
{ "command": "toggleBlockSelection", "keys": "alt+shift+m" },
Capabilities
Accessibility
Using the keyboard is generally a more accessible experience than using the mouse. Being able to modify a selection by using the keyboard is a good first step towards making selecting text more accessible.
Security
N/A
Reliability
With regards to the Terminal Core, the newly introduced code should rely on already existing and tested code. Thus no crash-related bugs are expected.
With regards to Terminal Control and the settings model, crash-related bugs are not expected. However, ensuring that the selection is updated and cleared in general use-case scenarios must be ensured.
Compatibility
N/A
Performance, Power, and Efficiency
N/A
Potential Issues
Grapheme Clusters
When grapheme cluster support is inevitably added to the Text Buffer, moving by "cell" is expected to move by "character" or "cluster". This is similar to how wide glyphs are handled today. Either all of it is selected, or none of it.
Circling the buffer
As usual, if the buffer is circling, the selection should be updated to follow the content (and "scroll up" appropriately).
In the event that one endpoint "scrolls" off the buffer, we must clamp "start" to the buffer origin. Conversely, in the event that both endpoints "scroll" off the buffer, the selection must be considered cleared.
Future considerations
Word Selection Wrap
At the time of writing this spec, expanding or moving by word is interrupted by the beginning or end of the line, regardless of the wrap flag being set. In the future, selection and the accessibility models will respect the wrap flag on the text buffer.