1259692 - [TSF] TSFTextStore should send keyboard events to TextEventDispatcher during composition

Status: RESOLVED FIXED

(Core :: Widget: Win32, defect, P4)

Description

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)]

Currently, TSFTextStore receives WM_KEYDOWN, WM_KEYUP, WM_SYSKEYDOWN and WM_SYSKEYUP in TSFTextStore::ProcessRawKeyMessage().  However, different from IMM, if IME (TIP) consumes the key message, the messages won't be sent to the windowproc.  Therefore, we cannot dispatch keyboard events which are consumed by IME only in TSF mode.

For example, you don't see a keydown event before compositionstart.

I think that TSFTextStore should store current key message into a static variable. And if windowproc isn't called, it should dispatch key event(s) with the stored message.

Comment 2

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=05cc2fd5f7282491bef57dedfb7f1ab4f1ddfd57

Comment 3

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)]

Attachment: Bug 1259692 - Make TSFTextStore dispatch eKeyDown or eKeyUp event when TIP processes a WM_KEYDOWN or WM_KEYUP message

TSF doesn't send WM_KEYDOWN nor WM_KEYUP to us while it handles a key message
with ITfKeystrokeMgr::KeyDown() or ITfKeystrokeMgr::KeyUp().  Therefore,
TSFTextStore needs to store handling key event message during calling
those methods and if it does something, we need to dispatch eKeyDown event
or eKeyUp event before dispatching any events.

However, we shouldn't dispatch WidgetKeyboardEvent during a document lock
because TSF/TIP do not assume that document is broken during a document lock.
Therefore, TSFTextStore needs to put it as a pending action into the queue.

So, this patch wraps this with
TSFTextStore::MaybeDispatchKeyboardEventAsProcessedByIME().  It checks if
there is a document lock when it's called.  If it's locked (and not yet
dispatched keyboard event for the handling key message), it adds pending
action to dispatch keyboard event later.  Otherwise, (and not yet dispatched
one), it dispatches keyboard event directly.

Review commit: https://reviewboard.mozilla.org/r/225198/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/225198/

Comment 4

[Makoto Kato [:m_kato]]

Comment on attachment 8956335 [details]
Bug 1259692 - Make TSFTextStore dispatch eKeyDown or eKeyUp event when TIP processes a WM_KEYDOWN or WM_KEYUP message

https://reviewboard.mozilla.org/r/225198/#review231260

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/19de31537925
Make TSFTextStore dispatch eKeyDown or eKeyUp event when TIP processes a WM_KEYDOWN or WM_KEYUP message r=m_kato

Comment 6

[Arthur Iakab [arthur_iakab]]

https://hg.mozilla.org/mozilla-central/rev/19de31537925