Enable KeyDown events unconditionally on MacOS #15740

mikeyusc · 2024-05-16T04:44:37Z

What does the pull request do?

KeyDown events were removed on MacOS from being fired for controls with an IME.

On Windows & Linux, every KeyStroke generates a KeyDown Event, then a TextInputEvent, followed by a KeyUp event.
This also happens on MacOS, unless focus is on a control with an IME, where they KeyDown Events are being consumed, unless there is a modifier key present.

This removes the ability to use a Tunneling Event Handler to validate input, or check for a localized hotkey, and set the event as handled, so that the keystroke never makes it to the IME.

Currently, the following code for a TextBox (MyText) is never executed on MacOS, it functions correctly on Windows & Linux

MyText.AddHandler(KeyDownEvent, (sender, args) =>
{
    Debugger.Break();
}, RoutingStrategies.Tunnel);

This PR fixes this behavior.

What is the current behavior?

KeyDown events are consumed by the IME.

What is the updated/expected behavior with this PR?

KeyDown events are fired unconditionally, allowing the equivalent functionality of a PreviewKeyDown from WPF land, implemented as the Tunnel routing strategy.

How was the solution implemented (if it's not obvious)?

Remove conditional checks before calling handleKeyDown

Checklist

Added unit tests (if possible)?
Added XML documentation to any related classes?
Consider submitting a PR to https://github.com/AvaloniaUI/avalonia-docs with user documentation

Breaking changes

None Known, but because of the location of this code it obviously needs to be carefully considered.

Obsoletions / Deprecations

N/A

Fixed issues

Fixes #15727

Gillibald · 2024-05-16T04:59:02Z

native/Avalonia.Native/src/OSX/AvnView.mm

@@ -544,26 +544,15 @@ - (void)keyDown:(NSEvent *)event

    //InputMethod is active
    if(_parent->InputMethod->IsActive()){


We can simplify this condition as well

if(_parent->InputMethod->IsActive()) { [[self inputContext] handleEvent:event]; } else { https://github.com/AvaloniaUI/Avalonia/blob/3fb7a820a11866a54130cfa595c95867655ebc0f/native/Avalonia.Native/src/OSX/AvnView.mm#L564

I'm trying to put this simplification into context.. are you saying to remove the handleKeyDown call? That call is necessary, and needs to be made before allowing the inputContext to handle the event, as if the KeyDown call handles it, the inputContext should never get it.

Wrap the input context call with that condition. Raise a synthetic text input event when the condition isn't met. Always process key down.

avaloniaui-bot · 2024-05-16T05:07:11Z

You can test this PR using the following package version. 11.2.999-cibuild0048483-alpha. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

cla-avalonia · 2024-05-16T05:07:24Z

@mikeyusc,

Please read the following Contributor License Agreement (CLA). If you agree with the CLA, please reply with the following:

@cla-avalonia agree

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ),
and conveys certain license rights to the AvaloniaUI OÜ ( “AvaloniaUI OÜ” ) for Your contributions to
AvaloniaUI OÜ open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to AvaloniaUI OÜ under this Agreement.

“Project” means any of the projects owned or managed by AvaloniaUI OÜ and offered under a license
approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your
original work. Should You wish to Submit materials that are not Your original work,
You may Submit them separately to the Project if You (a) retain all copyright and
license information that was in the materials as you received them, (b) in the
description accompanying your Submission, include the phrase "Submission
containing materials of a third party:" followed by the names of the third party and any
licenses or other restrictions of which You are aware, and (c) follow any other
instructions in the Project's written guidelines concerning Submissions.

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant AvaloniaUI OÜ, and those who receive the Submission directly
or indirectly from AvaloniaUI OÜ, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable
license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform,
and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing
rights to third parties.

b. Patent License. You grant AvaloniaUI OÜ, and those who receive the Submission directly or
indirectly from AvaloniaUI OÜ, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license
under Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3 ). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to AvaloniaUI OÜ. You agree to notify AvaloniaUI OÜ in writing of any facts or
circumstances of which You later become aware that would make Your representations in this
Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the Republic of Estonia, and
the parties consent to exclusive jurisdiction and venue in the courts sitting in Talinn,
Estonia. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by AvaloniaUI OÜ.

AvaloniaUI OÜ dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.

mikeyusc · 2024-05-16T05:11:39Z

@cla-avalonia agree

mikeyusc · 2024-05-16T22:24:54Z

Integration tests failing appears to be a tooling problem, they all pass fine on my machine.

Gillibald · 2024-05-17T04:56:55Z

Can you apply the requested changes?

kekekeks · 2024-05-17T06:40:33Z

App should never attempt to intercept keys before IME has a chance of processing those, since they don't know and can't know how IME would process events.

Keys are being pre-filtered by IME, which is consistent with other platforms.

If one wants to have a way to preview KeyDown they need to disable IME for a particular control or the entire window, that will switch Avalonia to the "traditional" KeyDown (app can do whatever it wants) -> TextInput -> KeyUp model at the cost of not supporting CJK input.

mikeyusc · 2024-05-17T12:57:54Z

Keys are being pre-filtered by IME, which is consistent with other platforms.

But here's the thing.. It's not consistent, even in Avalonia.. The behavior this PR supplies on MacOS is the behavior that already exists in Avalonia, on both Windows & Linux. If you run the sample app attached, you WILL get the KeyDown called before the IME processes the Input. So either this behavior is broken on the other two platforms, which I would say it is not, or it was broken on MacOS & should be restored to parity with the other two platforms.

AvaloniaTest.zip

Gillibald · 2024-05-17T14:16:32Z

Please use an actual IME that interacts with the keyboard

kekekeks · 2024-05-18T10:51:35Z

When IM is active the owner of the keyboard is IM and not the app. Apps should never react to keys that are handled by IME, because they don't have information about the way the IM handled the key (e. g. it could have been used for navigating completion list, as a hotkey, etc, etc, the app has no knowledge of this) and the app shouldn't attempt to guess if it's safe to handle the key before IME sees it, because app author can not know about all possible IM systems in the world. If app tries to mess with the external logic it has no understanding of, it leads to text input being broken.

If you are seeing a KeyDown event, it either means that IM is not active (which is the case for Linux most of the time, we only auto-enable IM for CJK locales) or that IM decided to not filter the key.
With macOS IM is the only way to properly get key input with all locales, so it's always active for textboxes unless InputMethod.IsInputMethodEnabled is false.

There is a fallback to map keys to chars that is auto enabled for views that opt-out of IME, but it only works with input systems where there is 1-to-1 mapping between a key and a char.

If you want to be able to handle all KeyDown events yourself and be able to filter out TextInput events based on KeyDown events, you can disable IM via InputMethod.IsInputMethodEnabled property.

We could perhaps implement Key.ImeProcessed and KeyDown from WPF for completeness, but handling it on the app sidet will NOT prevent the key being processed by IM and apps should never use such API for triggering actions like hotkeys.

Restore KeyDown events unconditionally

3fb7a82

Gillibald reviewed May 16, 2024

View reviewed changes

maxkatz6 requested a review from Gillibald May 16, 2024 11:55

kekekeks closed this May 17, 2024

kekekeks added the by-design The behavior reported in the issue is actually correct. label May 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable KeyDown events unconditionally on MacOS #15740

Enable KeyDown events unconditionally on MacOS #15740

mikeyusc commented May 16, 2024 •

edited

Gillibald May 16, 2024

mikeyusc May 16, 2024 •

edited

Gillibald May 17, 2024

avaloniaui-bot commented May 16, 2024

cla-avalonia commented May 16, 2024 •

edited

Contribution License Agreement

mikeyusc commented May 16, 2024

mikeyusc commented May 16, 2024

Gillibald commented May 17, 2024

kekekeks commented May 17, 2024

mikeyusc commented May 17, 2024

Gillibald commented May 17, 2024

kekekeks commented May 18, 2024

		@@ -544,26 +544,15 @@ - (void)keyDown:(NSEvent *)event

		//InputMethod is active
		if(_parent->InputMethod->IsActive()){

Enable KeyDown events unconditionally on MacOS #15740

Enable KeyDown events unconditionally on MacOS #15740

Conversation

mikeyusc commented May 16, 2024 • edited

What does the pull request do?

What is the current behavior?

What is the updated/expected behavior with this PR?

How was the solution implemented (if it's not obvious)?

Checklist

Breaking changes

Obsoletions / Deprecations

Fixed issues

Gillibald May 16, 2024

Choose a reason for hiding this comment

mikeyusc May 16, 2024 • edited

Choose a reason for hiding this comment

Gillibald May 17, 2024

Choose a reason for hiding this comment

avaloniaui-bot commented May 16, 2024

cla-avalonia commented May 16, 2024 • edited

Contribution License Agreement

mikeyusc commented May 16, 2024

mikeyusc commented May 16, 2024

Gillibald commented May 17, 2024

kekekeks commented May 17, 2024

mikeyusc commented May 17, 2024

Gillibald commented May 17, 2024

kekekeks commented May 18, 2024

mikeyusc commented May 16, 2024 •

edited

mikeyusc May 16, 2024 •

edited

cla-avalonia commented May 16, 2024 •

edited