This document discusses the InputMethodKit (IMK) framework in Mac OS X, which provides APIs for developing input methods (keyboards). IMK uses a client-server model where the input method acts as the server and text input applications are clients. It describes key classes like IMKServer, IMKTextInput protocol, and IMKCandidate for displaying candidate words. The document also covers topics like loading input methods as bundles, handling keyboard events, and compatibility with Xcode for debugging.

1. InputMethodKit
IMK
a.k.a zonble

2. IMK
• developer
• hack
• NSTextView NSTextField
UI
developer

3. zonble

4. zonble
• OpenVanilla

5. zonble
• OpenVanilla
• Yahoo

6. zonble
• OpenVanilla
• Yahoo
• X1

7. zonble
• OpenVanilla
• Yahoo
• X1
• Mac

8. zonble
• OpenVanilla
• Yahoo
• X1
• Mac
•

9. IMK
• Mac OS X 10.5
• Mac OS X 10.4 TSM
…

10. Dynamic Loading
vs
Client/Server

11. …
dylib crash
Finder
crash
Finder crash
crash…

12. IMK
Input Client Input Server
用來打字的應用程式 輸入法
IMK client/server
app app plug-in
32/64

13. crash app
IMK

14. IMK
Input Controller
輸入法邏輯
Input Client
用來打字的應用程式
Input Server
Proxy 監聽輸入事件的 server
IPC
server server
controller

15. Input Controller
delegate …
Delegate
Input Controller
輸入法邏輯
Input Client
用來打字的應用程式
Proxy
Input Server
監聽輸入事件的 server
delegate
Input Controller

16. Input Controllre
•
delegate
•
…

17. Delegate IMKServerInput
Input Controller IMKStateSetting
輸入法邏輯
Input Client
IMKTextInput 用來打字的應用程式
Proxy
Input Server
監聽輸入事件的 server

18. IMKTextInput
protocol
App
informal protocol

19. setMarkedText:selectionRange:
replacementRange:
• - (void)setMarkedText:(id)string selectionRange:
(NSRange)selectionRange replacementRange:
(NSRange)replacementRange
• method
•
•

20. setMarkedText:selectionRange:
replacementRange:
Opera

21. setMarkedText:selectionRange:
replacementRange:

22. setMarkedText:selectionRange:
replacementRange:
Nally
yllan++

23. setMarkedText:selectionRange:
replacementRange:
iTerm2
Leafy patch :D

24. attributesForCharacterIndex:li
neHeightRectangle:
• - (NSDictionary*)attributesForCharacterIndex:
(NSUInteger)index lineHeightRectangle:
(NSRect*)lineRect
• attributes
• lineRect

25. attributesForCharacterIndex:li
neHeightRectangle:
x -30000
…
Mac OS X

26. …

27. IMK

28. template
• Xcode project
template
• OpenVanilla Syrup
• https://github.com/lukhnos/syrup
• template :p

29. info.plist
<key>TISInputSourceID</key>
<string>org.openvanilla.inputmethod.syrup</string>
id
id
inputmethod
net.zonble.inputmethod.myinputmethod…

30. Info.plist
<key>TISIntendedLanguage</key>
<string>zh-Hant</string>
10.6
bug
— Security Bug
=_=

31. Main.m
IMKServer *server = [[IMKServer alloc]
initWithName:kConnectionName bundleIdentifier:
[[NSBundle mainBundle] bundleIdentifier]];
server
connection name info.plist

32. • compile app bundle ~/
Library/Input Methods/
• syrup tistool
tistool -r
<PATH_OF_YOUR_INPUT_METHOD>
• script compile

33. • TIS Text Input Service API
• TISRegisterInputSource((CFURLRef)inBund
leURL)

34. protocol

35. IMKStateSetting protocol
Input Controller
• activateServer:
•
• init
• deactivateServer:
•
• …

36. IMKServerInput protocol
Input Controller delegate
•
• /
• input client input buffer
• input client
• /

37. /
•
• – handleEvent:client:
• – inputText:key:modifiers:client:
• – inputText:client: –
didCommandBySelector:client:

38. – handleEvent:client:
• NSEvent
• -characters //
• -keyCode // key code
• -modifierFlags // command
shift option ctrl
• – inputText:key:modifiers:client:

39. modifierFlags
• flags & NSShiftKeyMask // shift
• flags & NSControlKeyMask // control
• flags & NSAlternateKeyMask // option
• flags & NSCommandKeyMask // command
• flags & NSNumericPadKeyMask //
•

40. Key Code
• Key Code char
Key Code char
• Key Code
QWERTY Dvorak
• overrideKeyboardWithKeyboardNamed
Input Client Keyboard Layout

41. characters
• NSString
•
• -characters
• -charactersIgnoringModifiers

42. – inputText:key:modifiers:client:
• – handleEvent:client:
NSEvent :)
• NSResponder interpretKeyEvents:
•

43. inputText:client: –
didCommandBySelector:client:
• inputText:client:
• didCommandBySelector:client:
NSResponder Action Messages
• insertNewline: insertTab:…
• NSResponder -doCommandBySelector:
method action
editor :)

44. inputText:client: –
didCommandBySelector:client:
• selector keycode
• Command
Selector
• Shift …

45. input client
• Input Client
setMarkedText:selectionRange:replacement
Range:
• [client setMarkedText:inputString
selectionRange:NSMakeRange(cursorIndex, 0)
replacementRange:NSMakeRange(NSNotFound,
NSNotFound)];
• selectionRange
replacementRange

46. input
- (void)commitComposition:(id)client
{
[client insertText:_composingBuffer
replacementRange:NSMakeRange(NSNotFou
nd, NSNotFound)];
//

47. • IMK IMKCandidate
• class

48. IMKCandidate
•
• Grid
•
•
•

49. IMKCandidate
•
• setSelectionkeys:
keyCode …
• Shift+

50. • NSWindow sublcass
• main window key window
window level
• window level
3D level
CGShieldingWindowLevel() + 1
• input client window level

51. InputController
• -menu

52. IMKTextInput
protocol

53. IMKTextInput
• IMKTextInput input client
protocol input client
•
• input client window
window frame
input client

54. IMKTextInput
• 10.7
( TextEdit
•
• -
(NSDictionary*)attributesForChara
cterIndex:(NSUInteger)index
lineHeightRectangle:
(NSRect*)lineRect

56. • Xcode attach
process Xcode Editor
• Xcode crash
• Xcode debug
NSLog Console

57. • 10.7 Sandboxing
• Input Methods

59. 喻

60. •
•
•

61. •
•
•
…