Add Selection and Caret for Next Occurrence of Selection by alfredbaudisch · Pull Request #67644 · godotengine/godot

alfredbaudisch · 2022-10-19T19:54:21Z

Adds the bind add_selection_for_next_occurrence to TextEdit, with CTRL+D as the default shortcut.

When the bind is performed, if a selection is currently active with the last caret in text fields, searches for the next occurrence of the selection, adds a caret and selects the next occurrence.

If no selection is currently active with the last caret in text fields, selects the word currently under the caret.

The action can be performed sequentially for all occurrences of the selection of the last caret and for all existing carets. The viewport is adjusted to the latest newly added caret.

The bind and the behaviour is similar to VS Code's "Add Selection to Next Find Match" and JetBrains' "Add Selection for Next Occurrence". It takes advantage of the multi-caret API.

The default shortcut for select_word_under_caret has been changed to ALT+G, in order to give priority to CTRL+D for add_selection_for_next_occurrence to better align with popular IDEs and editors.

Implements and closes godotengine/godot-proposals#5621

Usage

Define an Editor Shortcut for ui_text_add_selection_for_next_occurrence (default: CTRL+D):

Select text and keep pressing the shortcut to select the next occurrences:

multi-selection-godot3.mp4

If no selection is currently active, it selects the word under caret. If a new caret is manually added with a different selection (or no selection), the selection of the new caret is taken into consideration (like VS Code and JetBrains):

godot-multi-selection-vscode-like.mp4

It also supports manually adding a new caret to skip some occurrences. For example, in this instance I skipped some of the middle @export occurrences:

multi-selection-manually-add-cursor.mp4

Known Limitation

Currently, the selection cannot span more than one line/cannot contain line breaks. In the example video below, I tried to select:

move,
#

But it didn't work because the selection included a new line. Selecting only move, worked:

multi-selection-multi-linesno.mp4

bruvzg

Ctrl/Command + G will conflict with macOS action script_text_editor/find_next Meta + G (Meta and Command are the same key).

alfredbaudisch · 2022-10-20T05:49:41Z

Ctrl/Command + G will conflict with macOS action script_text_editor/find_next Meta + G (Meta and Command are the same key).

Any suggestion @bruvzg ? I was thinking ALT+G then (at least it's the default in Rider).

bruvzg · 2022-10-20T05:56:27Z

Any suggestion @bruvzg ? I was thinking ALT+G then (at least it's the default in Rider).

I'm not sure. Alt + G is used to input © symbol (we already use shortcuts like Alt + 1/2/3 which is also used for input, so it might be OK, if someone will need it is always possible to rebind it on the user side).

coppolaemilio · 2022-10-20T17:42:36Z

If this is a keyboard shortcut that exists in JetBrains or VS Code we could use their combination for mac? Not sure where I can find that info myself at the moment 😅

alfredbaudisch · 2022-10-20T17:45:27Z

If this is a keyboard shortcut that exists in JetBrains or VS Code we could use their combination for mac? Not sure where I can find that info myself at the moment 😅

@coppolaemilio The names in both VS Code and JetBrains:

bruvzg · 2022-10-20T17:45:35Z

VSCode on macOS use ⌘ + D for "select next match" and F3 for "find next" (Shift + F3 for previous).

Paulb23

I would be tempted to swap the ui_text_select_word_under_caret and ui_text_add_selection_for_next_occurrence shortcuts to better align with other editors.

In VSCode, rather then only using the last caret, seems to check whether all carets have the same word selected before selecting the next occurrence. Though interestingly sublime and Jetbrains do only use the last caret. Not necessary need to change, but probably worth putting in the docs.

Secondly, in both VSCode and sublime, if one or more carets do not have a selection it behaves like ui_text_select_word_under_caret (without deselecting). Jetbrains has the same behaviour but only for the last caret.

alfredbaudisch · 2022-10-20T19:02:31Z

Secondly, in both VSCode and sublime, if one or more carets do not have a selection it behaves like ui_text_select_word_under_caret (without deselecting). Jetbrains has the same behaviour but only for the last caret.

@Paulb23 that's a good one. I'll add the ui_text_select_word_under_caret behaviour to the feature, it makes sense, but it will be like Jetbrains. What do you think?

Paulb23 · 2022-10-20T19:20:48Z

I'll add the ui_text_select_word_under_caret behaviour to the feature, it makes sense, but it will be like Jetbrains. What do you think?

No strong preference, both are good. Can go with the Jetbrains approach for now as it's simpler. Can always change it later.

Adds the bind `add_selection_for_next_occurrence` to TextEdit, with CTRL+D as the default shortcut. When the bind is performed, ff a selection is currently active with the last caret in text fields, searches for the next occurrence of the selection, adds a caret and selects the next occurrence. If no selection is currently active with the last caret in text fields, selects the word currently under the caret. The action can be performed sequentially for all occurrences of the selection of the last caret and for all existing carets. The viewport is adjusted to the latest newly added caret. The bind and the behaviour is similar to VS Code's "Add Selection to Next Find Match" and JetBrains' "Add Selection for Next Occurrence". It takes advantage of the multi-caret API. The default shortcut for `select_word_under_caret` has been changed to ALT+G, in order to give priority to CTRL+D for `add_selection_for_next_occurrence` to better align with popular IDEs and editors.

alfredbaudisch · 2022-10-21T06:32:32Z

I'll add the ui_text_select_word_under_caret behaviour to the feature, it makes sense, but it will be like Jetbrains. What do you think?

No strong preference, both are good. Can go with the Jetbrains approach for now as it's simpler. Can always change it later.

@Paulb23 Ok, I just implemented the JetBrains behaviour (and all other changes we talked about). The PR has also been updated with an additional example video (regarding the JetBrains select word under caret behavior) and new instructions.

Paulb23

Looks great!

clayjohn

Looks good to me and Paulb23 is the maintainer here, so let's go ahead and merge

clayjohn · 2022-10-28T00:21:55Z

Thanks!

Adds the bind `ui_text_remove_secondary_carets` to TextEdit, with ESC as the default shortcut. When the bind is performed, if the TextEdit has multiple carets, `remove_secondary_carets` is called and secondary carets are removed. This is useful when multiple selects are performed with `add_select_for_next_occurrence` godotengine#67644 or when multiple multiple carets are manually added, then it's possible to go back to a single caret with a shortcut. Closes godotengine#67991

tonywei92 · 2023-05-30T09:13:18Z

How do i add the key binding? my Editor shortcut UI is a bit different from the one posted above.

YuriSizov · 2023-05-30T09:18:54Z

my Editor shortcut UI is a bit different from the one posted above

You seem to be using Godot 3, and this PR is for Godot 4.

PLyczkowski · 2023-11-04T20:40:01Z

Current implementation is missing the option to select next occurrence if it's a whole word only. To activate this is VSCode you can use this option:

In Godot, this is ignored:

alfredbaudisch requested review from a team as code owners October 19, 2022 19:54

alfredbaudisch force-pushed the add-selection-next-occurrence branch from 9608cd1 to d29ccba Compare October 19, 2022 19:55

bruvzg reviewed Oct 20, 2022

View reviewed changes

Comment thread scene/gui/text_edit.cpp Outdated

alfredbaudisch force-pushed the add-selection-next-occurrence branch from d29ccba to 0c1a348 Compare October 20, 2022 06:03

alfredbaudisch requested a review from a team as a code owner October 20, 2022 06:03

alfredbaudisch force-pushed the add-selection-next-occurrence branch 3 times, most recently from dae3e41 to caece58 Compare October 20, 2022 06:34

Paulb23 requested changes Oct 20, 2022

View reviewed changes

alfredbaudisch force-pushed the add-selection-next-occurrence branch from caece58 to 7d15ecc Compare October 21, 2022 06:26

Chaosus added enhancement topic:input topic:gui labels Oct 21, 2022

Chaosus modified the milestones: 4.0, 4.x Oct 21, 2022

Paulb23 approved these changes Oct 21, 2022

View reviewed changes

clayjohn approved these changes Oct 28, 2022

View reviewed changes

clayjohn merged commit 0486810 into godotengine:master Oct 28, 2022

alfredbaudisch deleted the add-selection-next-occurrence branch October 28, 2022 09:26

This was referenced Oct 28, 2022

Improve TextEdit::add_selection_for_next_occurrence test case #67976

Merged

Script Editor Ctrl+D no longer works (regression) #67962

Closed

akien-mga modified the milestones: 4.x, 4.0 Oct 31, 2022

This was referenced Oct 31, 2022

Shortcut and Bind to Remove Secondary Carets #68089

Merged

Bug when using backspace when using multiple carets #67992

Closed

Uh oh!

Conversation

alfredbaudisch commented Oct 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Usage

Known Limitation

Uh oh!

bruvzg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

alfredbaudisch commented Oct 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bruvzg commented Oct 20, 2022

Uh oh!

coppolaemilio commented Oct 20, 2022

Uh oh!

alfredbaudisch commented Oct 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bruvzg commented Oct 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Paulb23 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alfredbaudisch commented Oct 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Paulb23 commented Oct 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alfredbaudisch commented Oct 21, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Paulb23 left a comment

Choose a reason for hiding this comment

Uh oh!

clayjohn left a comment

Choose a reason for hiding this comment

Uh oh!

clayjohn commented Oct 28, 2022

Uh oh!

tonywei92 commented May 30, 2023

Uh oh!

YuriSizov commented May 30, 2023

Uh oh!

PLyczkowski commented Nov 4, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

alfredbaudisch commented Oct 19, 2022 •

edited

Loading

alfredbaudisch commented Oct 20, 2022 •

edited

Loading

alfredbaudisch commented Oct 20, 2022 •

edited

Loading

bruvzg commented Oct 20, 2022 •

edited

Loading

alfredbaudisch commented Oct 20, 2022 •

edited

Loading

Paulb23 commented Oct 20, 2022 •

edited

Loading

alfredbaudisch commented Oct 21, 2022 •

edited

Loading