forked from JensAyton/KeyNaming
-
Notifications
You must be signed in to change notification settings - Fork 0
/
KeyNaming.c
1095 lines (918 loc) · 29.7 KB
/
KeyNaming.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
KeyNaming.cp
Keynaming 2.2 implementation
© 2001-2008 Jens Ayton <[email protected]>, except where otherwise noted.
Copyright © 2001–2008 Jens Ayton
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#include "KeyNaming.h"
#include "KeyNaming-VKC.h"
#include <Carbon/Carbon.h>
#ifdef KEYNAMING_HID
#warning "KEYNAMING_HID has been renamed KEYNAMING_ENABLE_HID."
#endif
#if !( defined(MAC_OS_X_VERSION_10_5) && (MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_5) )
/* KeyboardLayout was introduced in 10.2 and deprecated in 10.5. If we might run on a pre-10.5 system, include it. */
#define KEYNAMING_USE_KCHR
#endif
#if defined(MAC_OS_X_VERSION_10_5) && (MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5)
/* TIS was introduced in 10.5. If we might run on 10.5 or later, include it. */
#define KEYNAMING_USE_TIS
#endif
#pragma mark * Constants
#define kKey_Command CFSTR("Command")
#define kKey_Shift CFSTR("Shift")
#define kKey_Option CFSTR("Option")
#define kKey_Control CFSTR("Control")
#define kKey_RightCommand CFSTR("Right Command")
#define kKey_RightShift CFSTR("Right Shift")
#define kKey_RightOption CFSTR("Right Option")
#define kKey_RightControl CFSTR("Right Control")
#define kKey_Caps CFSTR("Caps Lock")
#define kKey_Tab CFSTR("Tab")
#define kKey_Space CFSTR("Space")
#define kKey_Left CFSTR("Left Arrow")
#define kKey_Right CFSTR("Right Arrow")
#define kKey_Up CFSTR("Up Arrow")
#define kKey_Down CFSTR("Down Arrow")
#define kKey_Clear CFSTR("Clear")
#define kKey_PgUp CFSTR("Page Up")
#define kKey_PgDn CFSTR("Page Down")
#define kKey_Home CFSTR("Home")
#define kKey_End CFSTR("End")
#define kKey_Esc CFSTR("Escape")
#define kKey_Return CFSTR("Return")
#define kKey_Enter CFSTR("Enter")
#define kKey_Backspace CFSTR("Backspace")
#define kKey_Delete CFSTR("Delete")
#define kKey_Keypad_X CFSTR("Keypad %@")
#define kKey_F1 CFSTR("F1")
#define kKey_F2 CFSTR("F2")
#define kKey_F3 CFSTR("F3")
#define kKey_F4 CFSTR("F4")
#define kKey_F5 CFSTR("F5")
#define kKey_F6 CFSTR("F6")
#define kKey_F7 CFSTR("F7")
#define kKey_F8 CFSTR("F8")
#define kKey_F9 CFSTR("F9")
#define kKey_F10 CFSTR("F10")
#define kKey_F11 CFSTR("F11")
#define kKey_F12 CFSTR("F12")
#define kKey_F13 CFSTR("F13")
#define kKey_F14 CFSTR("F14")
#define kKey_F15 CFSTR("F15")
#define kKey_F16 CFSTR("F16")
#define kKey_F17 CFSTR("F17")
#define kKey_F18 CFSTR("F18")
#define kKey_F19 CFSTR("F19")
#define kKey_F20 CFSTR("F20")
#define kKey_Help CFSTR("Help")
#define kKey_Fn CFSTR("Fn")
#define kKey_Menu CFSTR("Menu")
#define kKey_Mute CFSTR("Mute")
#define kKey_VolumeDown CFSTR("Volume Down")
#define kKey_VolumeUp CFSTR("Volume Up")
#if KEYNAMING_ENABLE_HID
#define kKey_Unknown_N CFSTR("Unknown (%x)")
#define kKey_RightCommand CFSTR("Right Command")
#define kKey_Power CFSTR("Power")
#define kKey_Eject CFSTR("Eject")
#define kKey_F21 CFSTR("F21")
#define kKey_F22 CFSTR("F22")
#define kKey_F23 CFSTR("F23")
#define kKey_F24 CFSTR("F24")
#endif
#define kSeparator CFSTR(" ")
static CFStringRef sStringTable = NULL;
static CFBundleRef sStringBundle = NULL;
static CFStringRef sUnknownCodeString = NULL;
static CFStringRef UnknownCodeString(void);
#if KEYNAMING_ENABLE_HID
#pragma mark * HID to VKC Table
/* Table mapping HID usages in the KeyboardOrKeypad page to virtual key codes.
Names given for keys refer to US layout.
May be copied freely.
*/
#define kVKC_Unknown 0xFFFF
static const uint16_t kHID2VKC[] =
{
kVKC_Unknown, /* Reserved (no event indicated) */
kVKC_Unknown, /* ErrorRollOver */
kVKC_Unknown, /* POSTFail */
kVKC_Unknown, /* ErrorUndefined */
0x00, /* a and A */
0x0B, /* b and B */
0x08, /* ... */
0x02,
0x0E,
0x03,
0x05,
0x04,
0x22,
0x26,
0x28,
0x25,
0x2E,
0x2D,
0x1F,
0x23,
0x0C,
0x0F,
0x01,
0x11,
0x20,
0x09,
0x0D,
0x07,
0x10,
0x06, /* z and Z */
0x12, /* 1 */
0x13, /* 2 */
0x14, /* ... */
0x15,
0x17,
0x16,
0x1A,
0x1C,
0x19, /* 9 */
0x1D, /* 0 */
kVKC_Return, /* Keyboard Return (ENTER) */
kVKC_Esc, /* Escape */
kVKC_Backspace, /* Delete (Backspace) */
0x30, /* Tab */
kVKC_Space, /* Space bar */
0x1B, /* - and _ */
0x18, /* = and + */
0x21, /* [ and { */
0x1E, /* ] and } */
0x2A, /* \ and | */
kVKC_Unknown, /* "Non-US # and ~" ?? */
0x29, /* ; and : */
0x27, /* ' and " */
0x32, /* ` and ~ */
0x2B, /* , and < */
0x2F, /* . and > */
0x2C, /* / and ? */
kVKC_CapsLock, /* Caps Lock */
kVKC_F1, /* F1 */
kVKC_F2, /* ... */
kVKC_F3,
kVKC_F4,
kVKC_F5,
kVKC_F6,
kVKC_F7,
kVKC_F8,
kVKC_F9,
kVKC_F10,
kVKC_F11,
kVKC_F12, /* F12 */
kVKC_Unknown, /* Print Screen */
kVKC_Unknown, /* Scroll Lock */
kVKC_Unknown, /* Pause */
kVKC_Unknown, /* Insert */
kVKC_Home, /* Home */
kVKC_PgUp, /* Page Up */
kVKC_Delete, /* Delete Forward */
kVKC_End, /* End */
kVKC_PgDn, /* Page Down */
kVKC_RArrow, /* Right Arrow */
kVKC_LArrow, /* Left Arrow */
kVKC_DArrow, /* Down Arrow */
kVKC_UArrow, /* Up Arrow */
kVKC_Clear, /* Keypad Num Lock and Clear */
0x4B, /* Keypad / */
0x43, /* Keypad * */
0x4E, /* Keypad - */
0x45, /* Keypad + */
kVKC_KpdEnter, /* Keypad ENTER */
0x53, /* Keypad 1 */
0x54, /* Keypad 2 */
0x55, /* Keypad 3 */
0x56, /* Keypad 4 */
0x57, /* Keypad 5 */
0x58, /* Keypad 6 */
0x59, /* Keypad 7 */
0x5B, /* Keypad 8 */
0x5C, /* Keypad 9 */
0x52, /* Keypad 0 */
0x41, /* Keypad . */
0x32, /* "Keyboard Non-US \ and |" */
kVKC_Unknown, /* "Keyboard Application" (Windows key for Windows 95, and "Compose".) */
kFKC_Power, /* Keyboard Power (status, not key... but Apple doesn't seem to have read the spec properly) */
0x51, /* Keypad = */
kVKC_F13, /* F13 */
kVKC_F14, /* ... */
kVKC_F15,
kVKC_F16,
kVKC_F17,
kVKC_F18,
kVKC_F19,
kVKC_F20,
kFKC_F21,
kFKC_F22,
kFKC_F23,
kFKC_F24, /* F24 */
kVKC_Unknown, /* Keyboard Execute */
kVKC_Help, /* Keyboard Help */
kVKC_Unknown, /* Keyboard Menu */
kVKC_Unknown, /* Keyboard Select */
kVKC_Unknown, /* Keyboard Stop */
kVKC_Unknown, /* Keyboard Again */
kVKC_Unknown, /* Keyboard Undo */
kVKC_Unknown, /* Keyboard Cut */
kVKC_Unknown, /* Keyboard Copy */
kVKC_Unknown, /* Keyboard Paste */
kVKC_Unknown, /* Keyboard Find */
kVKC_Mute, /* Keyboard Mute */
kVKC_VolumeUp, /* Keyboard Volume Up */
kVKC_VolumeDown, /* Keyboard Volume Down */
kVKC_CapsLock, /* Keyboard Locking Caps Lock */
kVKC_Unknown, /* Keyboard Locking Num Lock */
kVKC_Unknown, /* Keyboard Locking Scroll Lock */
0x41, /* Keypad Comma ("Keypad Comma is the appropriate usage for the Brazilian
keypad period (.) key. This represents the closest possible match, and
system software should do the correct mapping based on the current locale
setting." If strange stuff happens on a (physical) Brazilian keyboard,
I'd like to know about it. */
0x51, /* Keypad Equal Sign ("Used on AS/400 Keyboards.") */
kVKC_Unknown, /* Keyboard International1 (Brazilian / and ? key? Kanji?) */
kVKC_Unknown, /* Keyboard International2 (Kanji?) */
kVKC_Unknown, /* Keyboard International3 (Kanji?) */
kVKC_Unknown, /* Keyboard International4 (Kanji?) */
kVKC_Unknown, /* Keyboard International5 (Kanji?) */
kVKC_Unknown, /* Keyboard International6 (Kanji?) */
kVKC_Unknown, /* Keyboard International7 (Kanji?) */
kVKC_Unknown, /* Keyboard International8 (Kanji?) */
kVKC_Unknown, /* Keyboard International9 (Kanji?) */
kVKC_Unknown, /* Keyboard LANG1 (Hangul/English toggle) */
kVKC_Unknown, /* Keyboard LANG2 (Hanja conversion key) */
kVKC_Unknown, /* Keyboard LANG3 (Katakana key) */ // kVKC_Kana?
kVKC_Unknown, /* Keyboard LANG4 (Hirigana key) */
kVKC_Unknown, /* Keyboard LANG5 (Zenkaku/Hankaku key) */
kVKC_Unknown, /* Keyboard LANG6 */
kVKC_Unknown, /* Keyboard LANG7 */
kVKC_Unknown, /* Keyboard LANG8 */
kVKC_Unknown, /* Keyboard LANG9 */
kVKC_Unknown, /* Keyboard Alternate Erase ("Example, Erase-Eaze™ key.") */
kVKC_Unknown, /* Keyboard SysReq/Attention */
kVKC_Unknown, /* Keyboard Cancel */
kVKC_Unknown, /* Keyboard Clear */
kVKC_Unknown, /* Keyboard Prior */
kVKC_Unknown, /* Keyboard Return */
kVKC_Unknown, /* Keyboard Separator */
kVKC_Unknown, /* Keyboard Out */
kVKC_Unknown, /* Keyboard Oper */
kVKC_Unknown, /* Keyboard Clear/Again */
kVKC_Unknown, /* Keyboard CrSel/Props */
kVKC_Unknown, /* Keyboard ExSel */
kVKC_Unknown, /* Reserved */
kVKC_Unknown, /* Reserved */
kVKC_Unknown, /* Reserved */
kVKC_Unknown, /* Reserved */
kVKC_Unknown, /* Reserved */
kVKC_Unknown, /* Reserved */
kVKC_Unknown, /* Reserved */
kVKC_Unknown, /* Reserved */
kVKC_Unknown, /* Reserved */
kVKC_Unknown, /* Reserved */
kVKC_Unknown, /* Reserved */
kVKC_Unknown, /* Keypad 00 */
kVKC_Unknown, /* Keypad 000 */
kVKC_Unknown, /* Thousands Separator */
kVKC_Unknown, /* Decimal Separator */
kVKC_Unknown, /* Currency Unit */
kVKC_Unknown, /* Currency Sub-unit */
kVKC_Unknown, /* Keypad ( */
kVKC_Unknown, /* Keypad ) */
kVKC_Unknown, /* Keypad { */
kVKC_Unknown, /* Keypad } */
kVKC_Unknown, /* Keypad Tab */
kVKC_Unknown, /* Keypad Backspace */
kVKC_Unknown, /* Keypad A */
kVKC_Unknown, /* Keypad B */
kVKC_Unknown, /* Keypad C */
kVKC_Unknown, /* Keypad D */
kVKC_Unknown, /* Keypad E */
kVKC_Unknown, /* Keypad F */
kVKC_Unknown, /* Keypad XOR */
kVKC_Unknown, /* Keypad ^ */
kVKC_Unknown, /* Keypad % */
kVKC_Unknown, /* Keypad < */
kVKC_Unknown, /* Keypad > */
kVKC_Unknown, /* Keypad & */
kVKC_Unknown, /* Keypad && */
kVKC_Unknown, /* Keypad | */
kVKC_Unknown, /* Keypad || */
kVKC_Unknown, /* Keypad : */
kVKC_Unknown, /* Keypad # */
kVKC_Unknown, /* Keypad Space */
kVKC_Unknown, /* Keypad @ */
kVKC_Unknown, /* Keypad ! */
kVKC_Unknown, /* Keypad Memory Store */
kVKC_Unknown, /* Keypad Memory Recall */
kVKC_Unknown, /* Keypad Memory Clear */
kVKC_Unknown, /* Keypad Memory Add */
kVKC_Unknown, /* Keypad Memory Subtract */
kVKC_Unknown, /* Keypad Memory Multiply */
kVKC_Unknown, /* Keypad Memory Divide */
kVKC_Unknown, /* Keypad +/- */
kVKC_Unknown, /* Keypad Clear */
kVKC_Unknown, /* Keypad Clear Entry */
kVKC_Unknown, /* Keypad Binary */
kVKC_Unknown, /* Keypad Octal */
kVKC_Unknown, /* Keypad Decimal */
kVKC_Unknown, /* Keypad Hexadecimal */
kVKC_Unknown, /* Reserved */
kVKC_Unknown, /* Reserved */
kVKC_Control, /* Keyboard LeftControl */
kVKC_Shift, /* Keyboard LeftShift */
kVKC_Option, /* Keyboard LeftAlt */
kVKC_Command, /* Keyboard LeftGUI */
kVKC_rControl, /* Keyboard RightControl */
kVKC_rShift, /* Keyboard RightShift */
kVKC_rOption, /* Keyboard RightAlt */
kFKC_rCommand /* Keyboard RightGUI */
};
enum { kHID2VKCSize = sizeof kHID2VKC / sizeof kHID2VKC[0] };
#endif // KEYNAMING_ENABLE_HID
#pragma mark * Code
#define CopyLocalizedString(str) CFBundleCopyLocalizedString(sStringBundle, str, str, sStringTable)
enum
{
kResType_UCKeyboardLayout = 'uchr'
};
/* If making state cache public, remember to refresh it when the input method is changed
(check GetScriptVariable(GetScriptManagerVariable(smKeyScript), smScriptKeys), or
just refresh it before handling relevant events). It's pretty lightweight anyway.
TODO: use lots of system version checking and dynamic loading to do this using the
non-deprecated path on each system revision, or at least not get warnings even if
there is no non-deprecated way.
*/
typedef struct StateCache
{
#ifdef KEYNAMING_USE_KCHR
Ptr KCHR; /* Old-style keyboard mapping for KeyTranslate() */
TextEncoding encoding; /* Encoding for converting KeyTranslate() chars to CFString */
#endif
UCKeyboardLayout *uchr; /* New-style keyboard mapping for UCKeyTranslate() */
uint8_t keyboardType; /* Magic Number needed by UCKeyTranslate() */
#ifdef KEYNAMING_USE_TIS
CFDataRef uchrData; /* Reference-counted buffer holding the 'uchr' data */
#endif
} StateCache;
static Boolean InitStateCache(StateCache *outState)
{
Boolean doneWithKL = false;
bzero(outState, sizeof(*outState));
if (NULL == sStringTable)
{
sStringTable = CFSTR("KeyNaming");
CFRetain(sStringTable);
}
if (NULL == sStringBundle)
{
sStringBundle = CFBundleGetMainBundle();
CFRetain(sStringBundle);
}
#ifdef KEYNAMING_USE_TIS
if (!doneWithKL && NULL != TISCopyCurrentKeyboardInputSource) {
TISInputSourceRef inputSource = TISCopyCurrentKeyboardInputSource();
if (!outState->uchrData) {
CFDataRef uchrKeyboardLayout = TISGetInputSourceProperty(inputSource, kTISPropertyUnicodeKeyLayoutData);
outState->uchrData = CFDataCreateCopy(kCFAllocatorDefault, uchrKeyboardLayout);
outState->uchr = (UCKeyboardLayout *)CFDataGetBytePtr(outState->uchrData);
}
CFRelease(inputSource);
doneWithKL = true;
}
#endif
#ifdef KEYNAMING_USE_KCHR
if (!doneWithKL && NULL != KLGetCurrentKeyboardLayout)
{
KeyboardLayoutRef layout;
/* Mac OS X 10.2 Keyboard Layout Services */
if (!KLGetCurrentKeyboardLayout(&layout))
{
KLGetKeyboardLayoutProperty(layout, kKLKCHRData, (const void **)&outState->KCHR);
KLGetKeyboardLayoutProperty(layout, kKLuchrData, (const void **)&outState->uchr);
if (outState->KCHR != NULL)
doneWithKL = true;
}
}
if (!doneWithKL)
{
Handle rsrc;
ResID keyLayoutID;
SInt16 keyScript;
outState->KCHR = (Ptr)GetScriptManagerVariable(smKCHRCache);
/* See IM:Supporting Unicode Input */
keyScript = GetScriptManagerVariable(smKeyScript);
keyLayoutID = GetScriptVariable(keyScript, smScriptKeys);
rsrc = GetResource(kResType_UCKeyboardLayout, keyLayoutID);
/* It's OK if this is NULL, we'll fall back on KeyTranslate */
outState->uchr = *(UCKeyboardLayout **)rsrc;
}
outState->encoding = CreateTextEncoding(GetScriptManagerVariable(smKeyScript), kTextEncodingDefaultVariant, kTextEncodingDefaultFormat);
#endif
outState->keyboardType = LMGetKbdType();
return doneWithKL;
}
static void DestroyStateCache(StateCache *outState)
{
#ifdef KEYNAMING_USE_TIS
CFRelease(outState->uchrData);
#endif
bzero(outState, sizeof(*outState));
}
static OSStatus NameOneKey(uint16_t inVKeyCode, CFStringRef *outString, const StateCache *inState, uint8_t *outHandlingMode);
#if KEYNAMING_ENABLE_VKC
CFStringRef KeyNamingCopyOneKeyName(uint16_t inVirtualKeyCode)
{
OSStatus err = noErr;
CFStringRef result = NULL;
StateCache state;
InitStateCache(&state);
err = NameOneKey(inVirtualKeyCode, &result, &state, NULL);
DestroyStateCache(&state);
if (err && NULL != result)
{
CFRelease(result);
result = NULL;
}
return result;
}
CFStringRef KeyNamingCopyKeyNames(uint32_t inCount, const uint16_t * const inVirtualKeyCodes)
{
OSStatus err = noErr;
uint32_t iter;
CFMutableStringRef result = NULL;
CFStringRef curr;
StateCache state;
if (0 == inCount) return CFSTR("");
if (NULL == inVirtualKeyCodes) return NULL;
result = CFStringCreateMutable(kCFAllocatorDefault, 0);
if (NULL == result) return NULL;
InitStateCache(&state);
for (iter = 0; iter != inCount; ++iter)
{
if (0 != iter)
{
CFStringAppend(result, kSeparator);
}
err = NameOneKey(inVirtualKeyCodes[iter], &curr, &state, NULL);
if (err) break;
CFStringAppend(result, curr);
CFRelease(curr);
}
DestroyStateCache(&state);
if (err && NULL != result)
{
CFRelease(result);
result = NULL;
}
return result;
}
CFArrayRef KeyNamingCopyKeyNamesAsArray(uint32_t inCount, const uint16_t * const inVirtualKeyCodes)
{
OSStatus err = noErr;
uint32_t iter;
CFMutableArrayRef result = NULL;
CFStringRef curr;
StateCache state;
if (0 != inCount && NULL == inVirtualKeyCodes) return NULL;
result = CFArrayCreateMutable(kCFAllocatorDefault, 0, &kCFTypeArrayCallBacks);
if (NULL == result) return NULL;
if (0 == inCount) return result;
InitStateCache(&state);
for (iter = 0; iter != inCount; ++iter)
{
err = NameOneKey(inVirtualKeyCodes[iter], &curr, &state, NULL);
if (err) break;
CFArrayAppendValue(result, curr);
CFRelease(curr);
}
DestroyStateCache(&state);
if (err && NULL != result)
{
CFRelease(result);
result = NULL;
}
return result;
}
#endif /* KEYNAMING_ENABLE_VKC */
#if KEYNAMING_ENABLE_HID
CFStringRef KeyNamingCopyOneKeyNameHID(int32_t inUsage)
{
OSStatus err = noErr;
CFStringRef result = NULL;
StateCache state;
uint16_t vkc;
if (inUsage < 0 || kHID2VKCSize <= inUsage) vkc = kVKC_Unknown;
else vkc = kHID2VKC[inUsage];
if (kVKC_Unknown != vkc)
{
InitStateCache(&state);
err = NameOneKey(vkc, &result, &state, NULL);
DestroyStateCache(&state);
if (err && NULL != result)
{
CFRelease(result);
result = NULL;
}
}
if (NULL == result)
{
result = CFStringCreateWithFormat(kCFAllocatorDefault, NULL, UnknownCodeString(), inUsage);
}
return result;
}
CFStringRef KeyNamingCopyKeyNamesHID(uint32_t inCount, const int32_t * const inUsages)
{
OSStatus err = noErr;
uint32_t iter;
CFMutableStringRef result = NULL;
StateCache state;
int32_t usage;
uint16_t vkc;
if (0 == inCount) return CFSTR("");
if (NULL == inUsages) return NULL;
result = CFStringCreateMutable(kCFAllocatorDefault, 0);
if (NULL == result) return NULL;
InitStateCache(&state);
for (iter = 0; iter != inCount; ++iter)
{
CFStringRef curr;
if (0 != iter)
{
CFStringAppend(result, kSeparator);
}
usage = inUsages[iter];
if (usage < 0 || kHID2VKCSize <= usage) vkc = kVKC_Unknown;
else vkc = kHID2VKC[usage];
if (kVKC_Unknown != vkc)
{
err = NameOneKey(vkc, &curr, &state, NULL);
if (err && NULL != curr)
{
CFRelease(curr);
curr = NULL;
}
} else {
curr = NULL;
}
if (NULL == curr)
{
curr = CFStringCreateWithFormat(kCFAllocatorDefault, NULL, UnknownCodeString(), usage);
}
if (NULL != curr)
{
CFStringAppend(result, curr);
CFRelease(curr);
}
}
DestroyStateCache(&state);
if (err && NULL != result)
{
CFRelease(result);
result = NULL;
}
return result;
}
CFArrayRef KeyNamingCopyKeyNamesAsArrayHID(uint32_t inCount, const int32_t * const inUsages)
{
OSStatus err = noErr;
uint32_t iter;
CFMutableArrayRef result = NULL;
StateCache state;
int32_t usage;
uint16_t vkc;
if (0 != inCount && NULL == inUsages) return NULL;
result = CFArrayCreateMutable(kCFAllocatorDefault, 0, &kCFTypeArrayCallBacks);
if (NULL == result) return NULL;
if (0 == inCount) return result;
InitStateCache(&state);
for (iter = 0; iter != inCount; ++iter)
{
CFStringRef curr;
usage = inUsages[iter];
if (usage < 0 || kHID2VKCSize <= usage) vkc = kVKC_Unknown;
else vkc = kHID2VKC[usage];
if (kVKC_Unknown != vkc)
{
err = NameOneKey(vkc, &curr, &state, NULL);
if (err && NULL != curr)
{
CFRelease(curr);
curr = NULL;
}
} else {
curr = NULL;
}
if (NULL == curr)
{
curr = CFStringCreateWithFormat(kCFAllocatorDefault, NULL, UnknownCodeString(), usage);
}
if (NULL != curr)
{
CFArrayAppendValue(result, curr);
CFRelease(curr);
}
}
DestroyStateCache(&state);
if (err && NULL != result)
{
CFRelease(result);
result = NULL;
}
return result;
}
#endif /* KEYNAMING_ENABLE_HID */
static OSStatus NameOneKey(uint16_t inVKeyCode, CFStringRef *outString, const StateCache *inState, uint8_t *outHandlingMode)
{
enum { kLength = 255 };
UInt32 state;
OSStatus err = noErr;
UInt8 charCode;
CFStringRef special = NULL;
UInt16 handlingMode = kNoSpecialHandling;
CFStringRef result = NULL;
CFMutableStringRef tempStr;
/* Sanity checking is the responsibility of the caller. */
/* Get the character code */
state = 0;
charCode = 0;
#ifdef KEYNAMING_USE_KCHR
if (inState->KCHR != NULL) {
UInt32 value = KeyTranslate(inState->KCHR, inVKeyCode, &state);
/* Magic for dead keys (combining accent keys) */
if (!value) value = KeyTranslate(inState->KCHR, inVKeyCode, &state);
charCode = value & 0xFF;
}
#endif
/* Handle the various special cases. There are lots of special cases. */
switch (charCode)
{
case kCC_FKey: handlingMode = kFKeyHandling; break;
case kCC_EscClr: handlingMode = kEscapeClearHandling; break;
case kCC_Tab: special = kKey_Tab; break;
case kCC_Space: special = kKey_Space; break;
}
if (NULL == special && kNoSpecialHandling == handlingMode) switch (inVKeyCode)
{
case kVKC_CapsLock: special = kKey_Caps; break;
case kVKC_Shift: special = kKey_Shift; break;
case kVKC_Control: special = kKey_Control; break;
case kVKC_Option: special = kKey_Option; break;
case kVKC_rShift: special = kKey_RightShift; break;
case kVKC_rControl: special = kKey_RightControl; break;
case kVKC_rOption: special = kKey_RightOption; break;
case kVKC_Command: special = kKey_Command; break;
case kVKC_Return: special = kKey_Return; break;
case kVKC_Backspace: special = kKey_Backspace; break;
case kVKC_Delete: special = kKey_Delete; break;
case kVKC_Help: special = kKey_Help; break;
case kVKC_Home: special = kKey_Home; break;
case kVKC_PgUp: special = kKey_PgUp; break;
case kVKC_PgDn: special = kKey_PgDn; break;
case kVKC_End: special = kKey_End; break;
case kVKC_LArrow: special = kKey_Left; break;
case kVKC_RArrow: special = kKey_Right; break;
case kVKC_UArrow: special = kKey_Up; break;
case kVKC_DArrow: special = kKey_Down; break;
case kVKC_Fn: special = kKey_Fn; break;
case kVKC_KpdEnter: special = kKey_Enter; break;
case kVKC_KbdEnter: special = kKey_Enter; break;
case kVKC_Space: special = kKey_Space; break;
case kVKC_Mute: special = kKey_Mute; break;
case kVKC_VolumeDown: special = kKey_VolumeDown; break;
case kVKC_VolumeUp: special = kKey_VolumeUp; break;
case kVKC_F17: special = kKey_F17; break;
case kVKC_F18: special = kKey_F18; break;
case kVKC_F19: special = kKey_F19; break;
case kVKC_F20: special = kKey_F20; break;
#if KEYNAMING_ENABLE_HID
case kFKC_rCommand: special = kKey_RightCommand; break;
case kFKC_Power: special = kKey_Power; break;
case kFKC_Eject: special = kKey_Eject; break;
case kFKC_F21: special = kKey_F21; break;
case kFKC_F22: special = kKey_F22; break;
case kFKC_F23: special = kKey_F23; break;
case kFKC_F24: special = kKey_F24; break;
#endif
case kVKC_Kpd_0: case kVKC_Kpd_1: case kVKC_Kpd_2: case kVKC_Kpd_3:
case kVKC_Kpd_4: case kVKC_Kpd_5: case kVKC_Kpd_6: case kVKC_Kpd_7:
case kVKC_Kpd_8: case kVKC_Kpd_9: case kVKC_Kpd_A: case kVKC_Kpd_B:
case kVKC_Kpd_C: case kVKC_Kpd_D: case kVKC_Kpd_E: case kVKC_Kpd_F:
handlingMode = kKeypadHandling;
break;
}
switch (handlingMode)
{
case kEscapeClearHandling:
if (kVKC_Esc == inVKeyCode) special = kKey_Esc;
else special = kKey_Clear;
break;
case kFKeyHandling:
switch (inVKeyCode)
{
case kVKC_F1: special = kKey_F1; break;
case kVKC_F2: special = kKey_F2; break;
case kVKC_F3: special = kKey_F3; break;
case kVKC_F4: special = kKey_F4; break;
case kVKC_F5: special = kKey_F5; break;
case kVKC_F6: special = kKey_F6; break;
case kVKC_F7: special = kKey_F7; break;
case kVKC_F8: special = kKey_F8; break;
case kVKC_F9: special = kKey_F9; break;
case kVKC_F10: special = kKey_F10; break;
case kVKC_F11: special = kKey_F11; break;
case kVKC_F12: special = kKey_F12; break;
case kVKC_F13: special = kKey_F13; break;
case kVKC_F14: special = kKey_F14; break;
case kVKC_F15: special = kKey_F15; break;
case kVKC_F16: special = kKey_F16; break;
case kVKC_F17: special = kKey_F17; break;
case kVKC_F18: special = kKey_F18; break;
case kVKC_F19: special = kKey_F19; break;
case kVKC_F20: special = kKey_F20; break;
#if KEYNAMING_ENABLE_HID
case kFKC_F21: special = kKey_F21; break;
case kFKC_F22: special = kKey_F22; break;
case kFKC_F23: special = kKey_F23; break;
case kFKC_F24: special = kKey_F24; break;
#endif
case kVKC_Menu: special = kKey_Menu; break;
default:
result = CFStringCreateWithFormat(kCFAllocatorDefault, NULL, UnknownCodeString(), 0x1000 | inVKeyCode);
}
break;
}
if (NULL != special)
{
result = CopyLocalizedString(special);
}
if (NULL == result || CFEqual(CFSTR(""), result))
{
/* Generic handling
If there's a 'uchr' resource for the key script, we use UCKeyTranslate to create a
Unicode string for the key. Otherwise we convert the old-style KeyTranslate char code to
a Pascal string and then to a CFString.
Then, we capitalize the string. (We want to have an 'A' key rather than an 'a' key,
for instance.) To allow this, we use a temporary mutable CFString.
Note that UCKeyTranslate is allowed to return anything from zero to 255 characters.
*/
tempStr = CFStringCreateMutable(kCFAllocatorDefault, 0);
if (NULL != tempStr)
{
if (inState->uchr)
{
UniChar string[kLength];
UniCharCount length;
/* Use the Unicode key-mapping table to name the key */
length = 0;
err = UCKeyTranslate(inState->uchr, inVKeyCode, kUCKeyActionDisplay, 0, inState->keyboardType, kUCKeyTranslateNoDeadKeysMask, &state, kLength, &length, string);
if (noErr == err) CFStringAppendCharacters(tempStr, string, length);
}
#ifdef KEYNAMING_USE_KCHR
if (NULL == inState->uchr || noErr != err)
{
UInt8 pascalString[2];
/* Use the old-fashioned charCode + script to name the key */
pascalString[0] = 1;
pascalString[1] = charCode;
CFStringAppendPascalString(tempStr, pascalString, inState->encoding);
}
#endif
CFStringUppercase(tempStr, NULL);
result = tempStr;
}
else
{
/* CFStringCreateMutable() failed */
err = memFullErr;
}
}
if (handlingMode == kKeypadHandling)
{
/*
Handle generic keypad keys, such as 0, 1, + etc, for which we want a
string of the form "Keypad X", where X is the relevant charcode.
We've already got the key's name through generic handling above.
Now we prepend "Keypad" using a string of the form "Keypad %@".
*/
CFStringRef keypad_X;
keypad_X = CopyLocalizedString(kKey_Keypad_X);
if (keypad_X)
{
CFStringRef temp = CFStringCreateWithFormat(kCFAllocatorDefault, NULL, keypad_X, result);
if (temp)
{
CFRelease(result);
result = temp;
}
}
}
if (result)
{
if (err)
{
CFRelease(result);
}
else
{
*outString = result;
}
}
else err = memFullErr;
if (outHandlingMode) *outHandlingMode = handlingMode;
return err;