Enable custom separators to treat different characters as words

[vgezer]

Implements proposal written here: godotengine/godot-proposals#9837, including comment godotengine/godot-proposals#9837 (comment)

Adds two options in Editor Settings to treat custom defined words as word delimiters/separators. If the first option is enabled, it uses the list below to stop caret on these characters to ease subword movement as in VSCode and some other editors.

Uses #46721, fixes godotengine/godot-proposals#5731 and closes #69254 and closes #91964

The functionality is disabled by default.

[AThousandShips]

Is this meant to implement:

• Improve Godot Text Editor to enable precise navigation using keyboard godot-proposals#9837

Or is more required for that?

[bruvzg]

This should be set when line RIDs are initialized, if it's used here, it will do unnecessary full text reprocessing and won't apply custom separators to the line breaking.

[vgezer]

Any suggestions where it may best fit?

[bruvzg]

In the TextEdit::Text::invalidate_cache and TextEdit::Text::invalidate_all_lines() (see how brk_flags are handled, for example).

• Add set_word_separators implementation to the TextEdit::Text.
• Add TS->shaped_text_set_custom_punctuation call to the Text::invalidate_*.
• Call text.set_word_separators and text.invalidate_all_lines from the set_use_custom_separators.

[vgezer]

Great tip thanks! However, now I caused a bug I guess:

1) If we change the enable/disable custom separators flag
2) change file
3) close using X without saving the file
4) clicking on save & quit option

does not save the file.

If I do not touch the status of the custom separators flag and perform 2 3 4, it does save the file... Any help how I caused this?

[vgezer]

Apparently this bug was already there. I created an issue on godot for this.

#92683

[vgezer]

Is this meant to implement:

• Improve Godot Text Editor to enable precise navigation using keyboard godot-proposals#9837

Or is more required for that?

Maybe 90 % is done. It also needs camel case subword navigation, which I will look at later after this is merged :)

[AThousandShips]

You used a merge commit to update your branch, please use rebase in the future instead, see here, this grabbed an unrelated commit into the history, you need to remove this

To do this do this:

git reset --hard 195180b
git rebase -i master
git push --force

You will need to make the changes you did after you did the merge commit again

[vgezer]

You used a merge commit to update your branch, please use rebase in the future instead, see here, this grabbed an unrelated commit into the history, you need to remove this.

Sorry, I was doing it before pushing it, but accidentally pushed before squishing them.

[AThousandShips]

Once you've applied the changes (in the future please use the batch suggestions option to make all in one change) please squash your commits into one, see here

[vgezer]

Once you've applied the changes (in the future please use the batch suggestions option to make all in one change) please squash your commits into one, see here

Thanks for the reviews! Sorry, my first PR and wanted to squash them in local after applying them all.

[vgezer]

Some cleanup and added this functionality to the inspector as well, to be used in CodeEditor and TextEditor nodes.

[akien-mga]

Looks good to me.

This is a new feature but it also fixes a recent regression, so I'll merge this for 4.3 despite the feature freeze.

[akien-mga]

Thanks! And congrats for your first merged Godot contribution 🎉