Repository navigation
macOS: the first Apple Korean key in a fresh PdfCraft composes (winit#4744) - #680
Merged
echelon merged 3 commits intoOct 10, 2026
Merged
Conversation
… (winit#4650) winit 0.30.13 reports insertText as Ime::Commit only while marked text is left, and after any commit it swallows the next key. Real paths where that loses text: - input methods that end a composition with unmarkText, then insertText (rust-windowing/winit#3925): the committed text was dropped; - Apple Korean 2-Set, for the key typed after a syllable: on 한 then 5 it calls setMarkedText("한"), insertText("한"), setMarkedText(""), insertText("5"), so the 5 (or ;, or any key that ends the syllable) was dropped; - a commit made outside a key press (a candidate clicked with the mouse, dictation): no key follows to reset the state, so the next key (for example Backspace) was swallowed. vendor/winit now commits when a composition was started (pending_commit, set in setMarkedText, cleared by the commit and when IME is disallowed); other insertText calls still reach the app as KeyboardInput. A commit outside keyDown clears the marked text and returns to the ground state. validAttributesForMarkedText lists the underline and marked-clause attributes, which some input methods need before they compose. This is rust-windowing/winit#4650, the 0.30 backport of storytold#4651 (merged on winit master), plus the part of storytold#4748 that fixes storytold#4651's out-of-key-press case (storytold#4748's other parts are not included). One correction: upstream spells the underline attribute "NSUnderlineStyle", but AppKit's NSUnderlineStyleAttributeName is "NSUnderline" (printed on macOS 14), so the AppKit value is used. Checked with the real input methods on macOS 14.7.1 (a scratch winit app fed key events through AppKit): with the patch 한+5 and 한+; commit the 5 and ;, unmarkText-then-insertText commits, and Backspace after a commit outside a key press is delivered; ABC typing, held keys, Japanese (日本, あ), Cangjie (日) and Korean composition give the same events as before. A test fails if a re-vendored winit loses the patch. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…#4744) On the first key after PdfCraft starts, Apple Korean 2-Set can answer interpretKeyEvents with insertText and the raw compatibility jamo instead of setMarkedText. winit sends that key to the app as an ordinary key, and the next keys compose without it: g k s Space typed ㅎㅏㄴ instead of 한 (Search, form fields, comments; rust-windowing/winit#3095). vendor/winit now ports rust-windowing/winit#4744: keyDown interprets that one key a second time, synchronously, before any KeyboardInput is sent, and only when every condition holds: Apple Korean, IME allowed and not yet composing, no pending commit or marked text, no Command/Control/Option, not a repeat, the key window's first responder, the only callback is one insertText of that same single jamo, and focus and input source unchanged afterwards. The decision is ImeStartup (ime_startup.rs, copied with its seven tests); no timer, no key queue, no text rewriting. It sits on top of the previous macOS IME change (pending_commit, in_key_down); the retry runs inside in_key_down. Command maps to ModifiersState::SUPER in winit 0.30 (META on winit master). Checked with the real input method on macOS 14.7.1 (scratch winit app, fresh process each time): without the patch g k s Space gave ㅎ as a key, then ㅏ and ㄴ committed separately, 3 runs out of 3; with it, ㅎ → 하 → 한 → 한 committed, 3 out of 3. All other traces (Japanese, Cangjie, ABC, held keys, later Korean keys) are unchanged. ImeStartup's tests pass with rustc --test. A test fails if a re-vendored winit loses the patch. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This was referenced Oct 10, 2026
Member
|
Merged, thank you! The first Apple Korean key in a fresh composition now composes (winit#4744). I ran If you haven't already, come join us on Discord: https://discord.gg/artcraft |
This was referenced Oct 10, 2026
krichelj
pushed a commit
to krichelj/pdfcraft
that referenced
this pull request
Oct 11, 2026
…#4744) (storytold#680) * macOS: IME text committed after the marked text is cleared isn't lost (winit#4650) winit 0.30.13 reports insertText as Ime::Commit only while marked text is left, and after any commit it swallows the next key. Real paths where that loses text: - input methods that end a composition with unmarkText, then insertText (rust-windowing/winit#3925): the committed text was dropped; - Apple Korean 2-Set, for the key typed after a syllable: on 한 then 5 it calls setMarkedText("한"), insertText("한"), setMarkedText(""), insertText("5"), so the 5 (or ;, or any key that ends the syllable) was dropped; - a commit made outside a key press (a candidate clicked with the mouse, dictation): no key follows to reset the state, so the next key (for example Backspace) was swallowed. vendor/winit now commits when a composition was started (pending_commit, set in setMarkedText, cleared by the commit and when IME is disallowed); other insertText calls still reach the app as KeyboardInput. A commit outside keyDown clears the marked text and returns to the ground state. validAttributesForMarkedText lists the underline and marked-clause attributes, which some input methods need before they compose. This is rust-windowing/winit#4650, the 0.30 backport of storytold#4651 (merged on winit master), plus the part of storytold#4748 that fixes storytold#4651's out-of-key-press case (storytold#4748's other parts are not included). One correction: upstream spells the underline attribute "NSUnderlineStyle", but AppKit's NSUnderlineStyleAttributeName is "NSUnderline" (printed on macOS 14), so the AppKit value is used. Checked with the real input methods on macOS 14.7.1 (a scratch winit app fed key events through AppKit): with the patch 한+5 and 한+; commit the 5 and ;, unmarkText-then-insertText commits, and Backspace after a commit outside a key press is delivered; ABC typing, held keys, Japanese (日本, あ), Cangjie (日) and Korean composition give the same events as before. A test fails if a re-vendored winit loses the patch. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * macOS: the first Apple Korean key in a fresh PdfCraft composes (winit#4744) On the first key after PdfCraft starts, Apple Korean 2-Set can answer interpretKeyEvents with insertText and the raw compatibility jamo instead of setMarkedText. winit sends that key to the app as an ordinary key, and the next keys compose without it: g k s Space typed ㅎㅏㄴ instead of 한 (Search, form fields, comments; rust-windowing/winit#3095). vendor/winit now ports rust-windowing/winit#4744: keyDown interprets that one key a second time, synchronously, before any KeyboardInput is sent, and only when every condition holds: Apple Korean, IME allowed and not yet composing, no pending commit or marked text, no Command/Control/Option, not a repeat, the key window's first responder, the only callback is one insertText of that same single jamo, and focus and input source unchanged afterwards. The decision is ImeStartup (ime_startup.rs, copied with its seven tests); no timer, no key queue, no text rewriting. It sits on top of the previous macOS IME change (pending_commit, in_key_down); the retry runs inside in_key_down. Command maps to ModifiersState::SUPER in winit 0.30 (META on winit master). Checked with the real input method on macOS 14.7.1 (scratch winit app, fresh process each time): without the patch g k s Space gave ㅎ as a key, then ㅏ and ㄴ committed separately, 3 runs out of 3; with it, ㅎ → 하 → 한 → 한 committed, 3 out of 3. All other traces (Japanese, Cangjie, ABC, held keys, later Korean keys) are unchanged. ImeStartup's tests pass with rustc --test. A test fails if a re-vendored winit loses the patch. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Brandon Thomas <echelon@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
On macOS, the first Korean word typed in a freshly started PdfCraft comes out broken: g k s Space gives ㅎㅏㄴ instead of 한. On the first key, Apple Korean can call
insertTextwith the raw compatibility jamo instead of starting a composition. winit sends it to the app as an ordinary key, and the next keys compose without it. This interprets that one key a second time, synchronously, before it is sent, and only in exactly that situation.Port of rust-windowing/winit#4744 (reviewed head
5c5c4db9af; related winit#3095), whose author reproduced it with eframe 0.36 on winit 0.30.13.PdfCraft impact
The first Korean key in Search, a form field or any egui text field after each launch.
Change
ime_startup.rs(ImeStartup) is copied from Dynamic XFA: a repeating subform with occur min="2" loses its second instance in scripts once a script writes into the first #4744 with its seven tests: the policy that decides on the retry.view.rs:keyDown:asks the policy beforeinterpretKeyEvents, and retries the same retained event once afterwards only if every condition holds:insertTextof that same single jamo;setMarkedText,unmarkTextanddoCommandBySelectorcancel a retry, and allowing or disallowing IME resets the policy.There is no timer, no key queue, no text rewriting, and no
RefCellborrow across AppKit calls.Adapted for winit 0.30
ime_allowedstands in for master'sime_capabilities.ModifiersState::SUPERin 0.30 (METAon master).in_key_down, from the PR this builds on.set_ime_allowedchanges state, where master usesenable_ime/disable_ime.How the macOS changes were checked
A scratch winit app (not committed) built against the vendored winit, first unpatched, then with each patch. It picks an input source on its own input context (
NSTextInputContext.selectedKeyboardInputSource), posts key events made fromCGEventCreateKeyboardEventto itself, so AppKit routes them throughkeyDown:andinterpretKeyEvents, and the real input method composes them. It prints winit'sImeandKeyboardInputevents, and AppKit'sNSTextInputClientcalls from winit's own trace spans. Machine: macOS 14.7.1 (23H222), Apple Korean 2-Set, Japanese (Romaji), Cangjie, ABC. Afterwards the input source was set back to ABC.The scenarios are: Korean syllables followed by Space, a digit,
;, Return and Backspace; Space with nothing composed; Japanese 日本 and あ; Cangjie 日; ABC typing; a held key with auto-repeat; IME disallowed and allowed again mid-composition; commits made outside a key press; andunmarkTextfollowed byinsertText. How egui then uses these events was read fromegui-winit0.36.2 (KeyboardInputtext becomesEvent::Text;Ime::Commitinserts into the focusedTextEdit).Before → after (a fresh process each run, Apple Korean, g k s Space as the first keys):
KeyboardInput("ㅎ"),Preedit("ㅏ"),Commit("ㅏ"),Preedit("ㄴ"),Commit("ㄴ ")Preedit("ㅎ"),Preedit("하"),Preedit("한"),Preedit("한 "),Commit("한 ")Every other scenario (later Korean keys, Japanese, Cangjie, ABC, held keys) gave identical events.
ImeStartup's seven tests pass (rustc --test; vendored crates' own tests don't run in the workspace).apps/pdfcraft/tests/winit_macos_korean_first_key.rsfails if a re-vendored winit loses the patch.Automated checks
aarch64-apple-darwin,x86_64-pc-windows-msvcandx86_64-unknown-linux-musl(cargo clippy --lib, lints capped to warnings): the warnings are the same as onmainfor all three (the one existingclippy::iter_kv_mapinlinux/x11/event_processor.rs).cargo check --locked -p winitinside the PdfCraft workspace, with PdfCraft's ownCargo.lock, on macOS and on the tree with all nine fixes merged: clean.main(fails);rustfmt --checkandclippy -D warningson it are clean.cargo test --workspaceand workspace clippy (the machine is short of disk space for a full build). CI runs them on Linux and Windows.Risk
The retry needs every condition above. Shortcuts, repeats, other input sources, keys while the canvas has focus (IME disallowed), a composition in progress, or any other callback all fall through to the existing path, which was checked to give identical events.
Revert and removal
This change can be reverted on its own; it needs the macOS IME commit PR. Drop it, together with
ime_startup.rs, the test and README item (10), once PdfCraft uses a winit release that includes rust-windowing/winit#4744 or an equivalent fix.Merging alongside the other winit PRs
This is one of nine fixes to
vendor/winitsent together: #672 (Wayland IME after a capability change), #673 (Windows Korean IME caret), #674 (Windows maximized start-up), #675 (X11 input context focus), #676 (macOS IME commit state), #677 (macOS stale composition), and, building on #676, #678 (macOS emoji picker), #679 (macOS Korean double space), #680 (macOS first Korean key). Each adds one numbered item to the single winit row invendor/README.md, so they conflict with each other on that one line, and nowhere else (each test is in its own file). The item numbers (2)–(10) are fixed in advance: to resolve, keep every item in numeric order. All nine were merged locally in one tree (only that line conflicted); the combined vendored winit builds for macOS, Windows and Linux with the same clippy output asmain, and all nine tests pass on it.🤖 Generated with Claude Code