(WIP) Reset to alphabet input mode on <Escape> or <Enter> key #15590

qqkookie · 2023-06-22T02:58:06Z

Summary of the Pull Request

When pressing <Escape> or <Enter> key, reset (CJK) keyboard IME input state to alphabet input mode.

References and Relevant Issues

Adds new feature:
#1304 Feature Request: IME mode after pressing Escape or Enter key in CJK input.

Detailed Description of the Pull Request / Additional comments

Use case: CJK user types shell command line using CJK input IME, or edits text file using Linux text editors like Vim (vi), nano or emacs editor.
Problem: After typing CJK words and phrases in CJK-script composition mode, user have to manually exit CJK input mode by pressing the composition key again and return to alphabet input mode. All shell commands and editor commands are alphabet/English word or key. So, CJK input after <Escape> or <Enter> key always causes command error. It is very error-prone and very, very annoying.
Solution: This PR solves such annoyance by switching IME input mode to alphabet input mode automatically upon pressing <Escape> or <Enter> key. This can be turned on/off at terminal/interaction setting pane.
Caveats: To type multi-line CJK phrases, user have to press CJK composition key after pressing each <Enter> key to go next line.
TODO: Setting toggle switch works as expected. Done.

Validation Steps Performed

This feature is widely supported in many open-source or commercial CJK-aware terminal emulator/SSH/Telnet client software or editors like Korean-localized xterm, hanterm, iPuTTY, XShell, and some MinTTY. It is such universally requested feature for Korean command line users.

PR Checklist

Closes Feature Request: IME mode after pressing Escape or Enter key in CJK input #1304
Tests added/passed
Documentation updated
- If checked, please file a pull request on our docs repo and link it here: #xxx
Schema updated (if necessary)

"src/terminal/input/terminalInput.cpp" : TerminalInput::HandleKey()

TODO: Apply globals.KeyAlphaMode setting to TerminalInput::CheckAlphaMode()

Don't exclude nuget `packages/` in vscode. Excluding via `file.exclude` also excludes them from c++ language extension's `includePath` and generates missing include files and header errors. We might still like to exclude them from full text search, so we do it using `search.exclude`. Closes microsoft#15578

This PR adds a `searchWeb` command to search the selected text on the web. Arguments: - `queryUrl`: URL of the web page to launch (the selected text will be inserted where the first `%s` is found in the query string) To make the search text more "compact" and handle multi-line selections, I'm concatenating the selected lines and replacing consecutive whitespaces with a single space (we may change this with something more clever in case). ## Validation Steps Performed Manual testing with single, multi-line, block selections. Closes microsoft#10175 --------- Co-authored-by: Marco Pelagatti <marco.pelagatti@iongroup.com> Co-authored-by: Mike Griese <migrie@microsoft.com>

…osoft#15582) As a shortcut, GetLastNonSpaceCharacter can start with the last committed row. It's guaranteed that there isn't anything of worth below that point, so why bother checking? Without this, Terminal immediately commits the entire 9031-line buffer on startup while trying to--get this!--clear the screen! --------- Co-authored-by: Leonard Hecker <lhecker@microsoft.com>

…5568) I originally intended to add the Drop Validator (which is a compliance requirement) task to the build, but I quickly realized that we weren't generating a complete SBOM manifest covering every artifact that we produced. We were generating the SBOM manifest, and then re-packing the Terminal app which very likely invalidated all of the hashes and signatures in the SBOM manifest! We were also missing the unpackaged build. I've removed the `appx-PLATFORM-CONFIG` and `unpackaged-PLAT-CONF` artifacts and combined them into a single one, `terminal-PLAT-CONF`.

TODO: Apply globals.KeyAlphaMode setting to TerminalInput::CheckAlphaMode()

qqkookie · 2023-06-22T04:18:05Z

@microsoft-github-policy-service agree

src/terminal/input/terminalInput.cpp

src/cascadia/TerminalSettingsEditor/Resources/en-US/Resources.resw

src/terminal/input/terminalInput.cpp

DHowett · 2023-06-22T15:25:21Z

Thanks for submitting this! I have a couple architecture concerns. I have not reviewed the code in-depth yet, sorry.

In our project, the TerminalInput module is used to translate Console Key events into VT (so, VK_RIGHT becomes ^[ [ C, as well as a bunch of other things.)

It is supposed to be relatively well-contained and not call out to the OS or support any user configuration.

This is because TerminalInput is also used in the Windows Console Host (conhost) and on OneCore/NanoServer, two very minimal versions of Windows with no dependencies.

For Windows Terminal, the right place to change the input behavior is on the TerminalCore or TerminalControl projects. Keeping your input behavior changes in the src/cascadia directory tree will make sure that they do not impact the Windows Console Host or NanoServer. 😄

qqkookie · 2023-06-26T10:40:55Z

Why some check is failing (PowerScipt fail? What is it?) and some checks take so long? Over a days pass and still in progress. :( Should I re-commit to start over?

lhecker · 2023-06-26T10:47:49Z

The code formatting check failed. If you open PowerShell inside the terminal project you can execute these two lines:

Import-Module .\tools\OpenConsole.psm1
Invoke-CodeFormat

lhecker · 2023-06-26T11:03:47Z

I'd also be happy to fix the PR's coding style for you. 🙂 If you'd be fine with that, just let me know once you feel like this PR works correctly for you.

@DHowett Can you check your mails, if you ever got a response to your IMM/CoreText questions (#1304 (comment))?

Import-Module .\tools\OpenConsole.psm1 Invoke-CodeFormat done

qqkookie · 2023-06-26T12:23:11Z

The code formatting check failed. If you open PowerShell inside the terminal project you can execute these two lines:
Import-Module .\tools\OpenConsole.psm1
Invoke-CodeFormat

Thank you for kindly help.

I'd also be happy to fix the PR's coding style for you. 🙂 If you'd be fine with that, just let me know once you feel like this PR works correctly for you.

@DHowett Can you check your mails, if you ever got a response to your IMM/CoreText questions (#1304 (comment))?

I haven't receive any response on that.
I am new to here. Your help will be always welcome and appreciated. :)

Now all check is passed and what should I do next?
How can I turn draft PR to normal PR? Ready for review?

lhecker · 2023-06-26T21:14:54Z

Now all check is passed and what should I do next?

FYI it might take a little while to get this PR merged and shipped. One of the main developers of Windows Terminal is currently out of office and we still need to properly test it. It'll then ship in the next preview version (1.19) in a month or so. I'm sorry for the wait!

cmplstofB · 2023-07-04T04:38:44Z

How about a proposal mentioned here? --- to be able to interpret the escape sequence controlling the IME which had already implemented by several other terminal software.
The implementation might be a bit complicated, but this method --- the Windows Terminal only provides IME control features and each shell or editor etc actually uses it in its own way --- will give users a more flexible way to switch IME state as there wish.

qqkookie · 2023-07-05T06:51:38Z

How about a proposal mentioned here? --- to be able to interpret the escape sequence controlling the IME which had already implemented by several other terminal software. The implementation might be a bit complicated, but this method --- the Windows Terminal only provides IME control features and each shell or editor etc actually uses it in its own way --- will give users a more flexible way to switch IME state as there wish.

Such feature is separate feature from automatic IME handing of this PR, not alternative of each other, IMHO.

Such feature is to let client program or remote app (like Vim editor or cmd.exe/shell ) can control the user-side local IME of terminal emulator by sending such control sequence. For example, editor can set IME off on command mode. But it requires support from the editor itself.

If many shell/editor application request/support such feature, such IME-controlling control-sequence processing can be implemented with IMM routines, if needed.

zadjii-msft

Structurally, this seems mostly good. I'd have probably wrapped the IMM support into a helper class / struct (rather than just some global statics), but that's minor.

I'd probably want to double-check this UX with some of our other IME experts, but I'd need to find them first 😛 If there's existing precedent for this kind of behavior, and it's toggleable with a setting, then I'd be hard pressed to say no

.github/actions/spelling/expect/alphabet.txt

CppProperties.json

src/cascadia/TerminalControl/TermControl.cpp

src/cascadia/TerminalSettingsModel/MTSMSettings.h

@zadjii-msft

Code clean up per advice of @zadjii-msft

@zadjii-msft

Code clean up per advice of @zadjii-msft

KalleOlaviNiemitalo · 2023-07-16T09:51:26Z

I won't be reviewing this.

zadjii-msft · 2023-07-19T11:11:42Z

quick notes from the discussion we had:

making this a setting is great. If this breaks someone's workflow, well, they don't need to turn it on 😉
Technically, the Terminal is already pre-loading the IMM dll immediately on startup, but it's probably good to wrap this code in delayloads anyways. Maybe someday a dependnecy won't pull it in automatically, so this would be helpful to have then.
We're a little worried that mixing and matching the raw IMM functions with the WinRT ones (used in TSFInputControl, see CoreTextEditContext) might not work as expected. We wanted to validate with someone who might know the internals better (though, we don't know who that is).
we didn't really come to a name consensus. alphaKbdOnEsc is certainly better, but something more semantic like resetToAlphaKbdMode or something. We probably need to discuss more.

Thanks for bearing with us while we sort this out!

addenda: we also discussed how we really need to get our IME support figured out by an expert. Cases in point: this thread, #13681, #14407 and the long list of issues before those.

zadjii-msft · 2024-04-29T19:00:32Z

@lhecker did this get obsoleted by your IME rewrite?

lhecker · 2024-04-29T21:10:28Z

Oh, yes it did! @qqkookie Thank you so much for the PR, but you've probably already seen my update in the corresponding issue. The new IME rewrite should be much more robust in general.

qqkookie and others added 14 commits June 20, 2023 14:41

Added KeyInputAlphabetMode() call in

bcdd215

"src/terminal/input/terminalInput.cpp" : TerminalInput::HandleKey()

Added KeyInputAlphabetMode() call in

c2966b5

"src/terminal/input/terminalInput.cpp" : TerminalInput::HandleKey()

Merged 1.17

5db018d

Added KeyAlphaMode in Settings/Interactive (WIP)

5502103

KeyAlphaMode settings/interaction 2nd try.

e7cde46

Add Settings/interaction KeyAlphaMode setting as toggle swiich. (WIP)

94e9cb3

TODO: Apply globals.KeyAlphaMode setting to TerminalInput::CheckAlphaMode()

Add Settings/interaction KeyAlphaMode setting as toggle swiich. (WIP)

744c1cc

TODO: Apply globals.KeyAlphaMode setting to TerminalInput::CheckAlphaMode()

Added KeyAlphaMode in Settings/Interactive (WIP)

9733bdf

Add Settings/interaction KeyAlphaMode setting as toggle swiich. (WIP)

0ac5755

TODO: Apply globals.KeyAlphaMode setting to TerminalInput::CheckAlphaMode()

Merge branch 'main' into Kookie

ee56507

This comment has been minimized.

Sign in to view

KalleOlaviNiemitalo reviewed Jun 22, 2023

View reviewed changes

qqkookie changed the title ~~Kookie~~ (WIP) Reset to alphabet input mode on <Escape> or <Return> key Jun 22, 2023

qqkookie changed the title ~~(WIP) Reset to alphabet input mode on <Escape> or <Return> key~~ (WIP) Reset to alphabet input mode on <Escape> or <Enter> key Jun 22, 2023

lhecker reviewed Jun 22, 2023

View reviewed changes

src/terminal/input/terminalInput.cpp Outdated Show resolved Hide resolved

KalleOlaviNiemitalo reviewed Jun 22, 2023

View reviewed changes

src/terminal/input/terminalInput.cpp Outdated Show resolved Hide resolved

Global setting KeyAlphaMode works. Need clean up.

9ac3592

This comment has been minimized.

Sign in to view

Merge branch 'microsoft:main' into Kookie

e411534

This comment has been minimized.

Sign in to view

Code cleanup. Misspellings,

5a28313

Code cleanup. Misspellings

c053d74

fix PowerScript fail

773172e

Import-Module .\tools\OpenConsole.psm1 Invoke-CodeFormat done

qqkookie marked this pull request as ready for review June 26, 2023 12:24

zadjii-msft reviewed Jul 10, 2023

View reviewed changes

qqkookie added 3 commits July 13, 2023 05:57

KeyAlphaMode -> AlphaKbdOnEscKey

c9cacf4

Code clean up per advice of @zadjii-msft

Merge branch 'microsoft:main' into Kookie

48a7c8c

KeyAlphaMode -> AlphaKbdOnEscKey

9789832

Code clean up per advice of @zadjii-msft

zadjii-msft added the Needs-Discussion Something that requires a team discussion before we can proceed label Jul 13, 2023

qqkookie requested review from zadjii-msft, lhecker and KalleOlaviNiemitalo July 15, 2023 11:15

lhecker added this to the Terminal v1.19 milestone Jul 24, 2023

lhecker removed the Needs-Discussion Something that requires a team discussion before we can proceed label Jul 24, 2023

lhecker closed this Apr 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(WIP) Reset to alphabet input mode on <Escape> or <Enter> key #15590

(WIP) Reset to alphabet input mode on <Escape> or <Enter> key #15590

qqkookie commented Jun 22, 2023 •

edited

Loading

This comment has been minimized.

qqkookie commented Jun 22, 2023

DHowett commented Jun 22, 2023

This comment has been minimized.

This comment has been minimized.

qqkookie commented Jun 26, 2023

lhecker commented Jun 26, 2023 •

edited

Loading

lhecker commented Jun 26, 2023

qqkookie commented Jun 26, 2023

lhecker commented Jun 26, 2023 •

edited

Loading

cmplstofB commented Jul 4, 2023

qqkookie commented Jul 5, 2023 •

edited

Loading

zadjii-msft left a comment

KalleOlaviNiemitalo commented Jul 16, 2023

zadjii-msft commented Jul 19, 2023

zadjii-msft commented Apr 29, 2024

lhecker commented Apr 29, 2024

(WIP) Reset to alphabet input mode on <Escape> or <Enter> key #15590

(WIP) Reset to alphabet input mode on <Escape> or <Enter> key #15590

Conversation

qqkookie commented Jun 22, 2023 • edited Loading

Summary of the Pull Request

References and Relevant Issues

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

PR Checklist

This comment has been minimized.

qqkookie commented Jun 22, 2023

DHowett commented Jun 22, 2023

This comment has been minimized.

This comment has been minimized.

qqkookie commented Jun 26, 2023

lhecker commented Jun 26, 2023 • edited Loading

lhecker commented Jun 26, 2023

qqkookie commented Jun 26, 2023

lhecker commented Jun 26, 2023 • edited Loading

cmplstofB commented Jul 4, 2023

qqkookie commented Jul 5, 2023 • edited Loading

zadjii-msft left a comment

Choose a reason for hiding this comment

KalleOlaviNiemitalo commented Jul 16, 2023

zadjii-msft commented Jul 19, 2023

zadjii-msft commented Apr 29, 2024

lhecker commented Apr 29, 2024

qqkookie commented Jun 22, 2023 •

edited

Loading

lhecker commented Jun 26, 2023 •

edited

Loading

lhecker commented Jun 26, 2023 •

edited

Loading

qqkookie commented Jul 5, 2023 •

edited

Loading