Include period as delimiter & support Ctrl+Delete in InputText #6067

ajweeks · 2023-01-09T10:22:36Z

This change includes period (.) as a delimiter so that pressing ctrl+arrow key or ctrl+backspace/delete in InputText fields doesn't skip past them.

Hitting ctrl+backspace with the cursor at the end of a buffer containing a command in the form cmd.shadows.enabled| will, after this change, result in cmd.shadows.| where previously the entire buffer would be cleared.

This change also introduces support for ctrl+delete, matching the behavior of ctrl+backspace but in the opposite direction. shift+delete still works to cut text with this change.

These are standard behaviors in all text editors, so this change makes InputText widgets better match what users' intuitions are.

In the following video you can see the effect of consecutively pressing ctrl+backspace, and then once again from the beginning with ctrl+delete:

2023_01_09_input_text.mp4

ajweeks · 2023-01-09T10:25:42Z

imgui_widgets.cpp

+static int is_word_boundary_from_right(ImGuiInputTextState* obj, int idx)
+{
+    if (obj->Flags & ImGuiInputTextFlags_Password) return 0;
+    if (is_separator(obj->TextW[idx])) return 1;


This line was added so that ctrl+backspace only deletes one character when the cursor is in front of a separator, which matches the behavior of nearly all text editors. Without this line, the buffer cmd.| will be fully cleared on ctrl+backspace, where with this line only the period will be deleted.

@restore deleted

ajweeks · 2023-01-09T10:27:16Z

imgui_widgets.cpp

+                if (is_wordmove_key_down)
+                    state->OnKeyPressed(STB_TEXTEDIT_K_WORDRIGHT | STB_TEXTEDIT_K_SHIFT);
+                else if (is_osx && io.KeySuper && !io.KeyAlt && !io.KeyCtrl)
+                    state->OnKeyPressed(STB_TEXTEDIT_K_LINEEND | STB_TEXTEDIT_K_SHIFT);


I'm a little bit unsure about this line, and can't test as I don't have a Mac, though I think it's logical to pass LINEEND, where the equivalent code for ctrl+backspace uses LINESTART (see L4348)

ocornut · 2023-01-10T13:50:21Z

Hello,
Thanks for the PR.
Could you please massage the commit history so that the two different features are in separate commits? (and force-push)
I can imagine easily merging the CTRL+Delete change but other will need more review.

ajweeks · 2023-01-12T07:58:21Z

I've broke the changes into two cleaner commits now.

…#6067)

ocornut · 2023-01-25T13:42:53Z

Thank you!

I'm a little bit unsure about this line, and can't test as I don't have a Mac, though I think it's logical to pass LINEEND, where the equivalent code for ctrl+backspace uses LINESTART (see L4348)

I've tested this on a Mac with a Delete key and surprisingly even though Super+Backspace is supported, Super+Delete does nothing, so I haven't added that part of the code (and added corresponding comment).

Merged that commit as f4ef420

…y tests for now) Intent to test further changes such as ocornut/imgui#6067

ocornut · 2023-01-25T20:51:02Z

As for "include period delimiter", I believe this break other common behavior.

I started gathering behavior for Visual Studio (windows), Firefox (windows), Xcode (mac), Firefox (mac)

Behaviors

        /*
        // Action   VS(Win)                     Firefox(Win)        XCode(OSX)                  Firefox(OSX)
        //------------------------------------------------------------------------------------------------------
        //         |Hello                      |Hello              |Hello                       ==
        // Ctrl->   Hello |world                ==                  Hello|                      ==
        // Ctrl->   Hello world|.               (skip)              Hello world|.               ==
        // Ctrl->   Hello world. |Foo           ==                  (skip)                      (skip)
        // Ctrl->   Hello world. Foo|.bar       (skip)              Hello world. Foo|.bar       (skip)
        // Ctrl->   Hello world. Foo.|bar       ==                  (skip)                      (skip)
        // Ctrl->   Hello world. Foo.bar|       (skip)              Hello world. Foo.bar|       ==
        // Ctrl->   Hello world. Foo.bar!!!|    ==                  (next line word)            (eol)
        //
        //          Hello world. Foo.bar!!!|    ==                  Hello world. Foo.bar!!!|    ==
        // Ctrl<-   Hello world. Foo.bar|!!!    (skip)              (skip)                      (skip)
        // Ctrl<-   Hello world. Foo.|bar!!!    ==                  Hello world. Foo.|bar!!!    (skip)
        // Ctrl<-   Hello world. Foo|.bar!!!    (skip)              (skip)                      (skip)
        // Ctrl<-   Hello world. |Foo.bar!!!    ==                  Hello world. |Foo.bar!!!    ==
        // Ctrl<-   Hello world|. Foo.bar!!!    (skip)              (skip)                      (skip)
        // Ctrl<-   Hello |world. Foo.bar!!!    ==                  Hello |world. Foo.bar!!!    ==
        // Ctrl<-   |Hello world. Foo.bar!!!    ==                  Hello world. Foo.bar!!!     ==
        //
        // (*) Firefox: tested GitHub, Google, WhatsApp text fields with same results.
        */

Which opens the question of which behavior we should follow : coding env or web env?
I'd tend for coding env as a reference.

I also started working on a Regression Test for this:
ocornut/imgui_test_engine@890bab1

In the Test (Windows only for now) the blocks under #if IMGUI_BROKEN_TESTS are those where our behavior doesn't match Visual Studio in current version. Your patch fixes some of tests but breaks others.

At a first step we should get the Windows behavior to pass all Windows tests, then we can work on adding Mac tests and fix that too. The system allows for simulating Mac behavior if you set our config flags.

Would you like to work on finishing this and make it pass all tests? (replace #if IMGUI_BROKEN_TESTS with #if 1 while working locally, then by #if IMGUI_VERSION_NUM > xxxx once a fix is pushed).

ajweeks · 2023-01-28T14:52:14Z

Great, I'm on it :) I agree that we should aim to support the behaviour seen in most coding environments.

Requires imgui_test_engine/pull/9 to pass tests

ajweeks · 2023-01-29T17:35:13Z

I've got the current tests passing on both Windows and Mac (simulated), only once I made some changes to imgui_test_engine though (imgui_test_engine/pull/9)

I think it would be good however to have more tests for Mac (as your comments point out), and also some tests of the super key? But I'm fairly confident the Windows behaviour is now matching exactly what I would expect from VS.

I also have to say, the test engine repro is pretty amazing :) It looks like an amazingly-handy tool and it seems to be really well designed! Nice work!

…iter and tweak prev/next words logic. (#6067)

ocornut · 2023-03-22T19:50:03Z

Merged as 821814b
I went ahead and didn't add more tests for OSX, will revisit when needed.

…ocornut#6067)

…iter and tweak prev/next words logic. (ocornut#6067)

ajweeks commented Jan 9, 2023

View reviewed changes

ocornut added the inputtext label Jan 10, 2023

AJ Weeks added 2 commits January 10, 2023 16:20

Support ctrl+delete in input text fields

20e75a0

Include period as delimiter and improve delimiter navigation

d36153b

ajweeks force-pushed the patch-1 branch from 08defdc to d36153b Compare January 10, 2023 15:29

ocornut pushed a commit that referenced this pull request Jan 25, 2023

InputText: Added support for Ctrl+Delete to delete up to end of word. (…

f4ef420

…#6067)

ocornut added a commit to ocornut/imgui_test_engine that referenced this pull request Jan 25, 2023

TestSuite: add "widgets_inputtext_cursor_prevnext_words" (Windows onl…

890bab1

…y tests for now) Intent to test further changes such as ocornut/imgui#6067

ocornut added the osx/ios label Jan 25, 2023

ajweeks mentioned this pull request Jan 29, 2023

Fix input text cursor movement tests ocornut/imgui_test_engine#9

Closed

Fix input text cursor movement tests (Win + Mac)

a39c0e0

Requires imgui_test_engine/pull/9 to pass tests

Merge branch 'master' into patch-1

a0df116

ocornut force-pushed the master branch from 4812791 to fac19e1 Compare February 7, 2023 18:29

ocornut pushed a commit that referenced this pull request Mar 22, 2023

InputText: Reworked prev/next-word behavior . Include period as delim…

821814b

…iter and tweak prev/next words logic. (#6067)

ocornut closed this Mar 22, 2023

ajweeks deleted the patch-1 branch March 26, 2023 14:39

kjblanchard pushed a commit to kjblanchard/imgui that referenced this pull request May 5, 2023

InputText: Added support for Ctrl+Delete to delete up to end of word. (…

64e5eb5

…ocornut#6067)

kjblanchard pushed a commit to kjblanchard/imgui that referenced this pull request May 5, 2023

InputText: Reworked prev/next-word behavior . Include period as delim…

7e83b6a

…iter and tweak prev/next words logic. (ocornut#6067)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Include period as delimiter & support Ctrl+Delete in InputText #6067

Include period as delimiter & support Ctrl+Delete in InputText #6067

ajweeks commented Jan 9, 2023

ajweeks Jan 9, 2023

NicWoo90 Mar 3, 2023

ajweeks Jan 9, 2023

ocornut commented Jan 10, 2023

ajweeks commented Jan 12, 2023

ocornut commented Jan 25, 2023

ocornut commented Jan 25, 2023

ajweeks commented Jan 28, 2023

ajweeks commented Jan 29, 2023

ocornut commented Mar 22, 2023 •

edited

Loading

Include period as delimiter & support Ctrl+Delete in InputText #6067

Include period as delimiter & support Ctrl+Delete in InputText #6067

Conversation

ajweeks commented Jan 9, 2023

ajweeks Jan 9, 2023

Choose a reason for hiding this comment

NicWoo90 Mar 3, 2023

Choose a reason for hiding this comment

ajweeks Jan 9, 2023

Choose a reason for hiding this comment

ocornut commented Jan 10, 2023

ajweeks commented Jan 12, 2023

ocornut commented Jan 25, 2023

ocornut commented Jan 25, 2023

ajweeks commented Jan 28, 2023

ajweeks commented Jan 29, 2023

ocornut commented Mar 22, 2023 • edited Loading

ocornut commented Mar 22, 2023 •

edited

Loading