-
Notifications
You must be signed in to change notification settings - Fork 421
/
Copy pathSquirrelInputController.mm
1132 lines (1047 loc) · 41.3 KB
/
SquirrelInputController.mm
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
#import "SquirrelInputController.hh"
#import "SquirrelApplicationDelegate.hh"
#import "SquirrelConfig.hh"
#import "SquirrelPanel.hh"
#import "macos_keycode.hh"
#import <rime_api.h>
#import <rime/key_table.h>
__attribute__((objc_direct_members))
@interface SquirrelInputController (Private)
- (void)createSession;
- (void)destroySession;
- (BOOL)rimeConsumeCommittedText;
- (void)rimeUpdate;
- (void)updateAppOptions;
- (void)updateCandidate:(RimeCandidate*)candidate atIndex:(NSUInteger)index;
@end
static NSString* const kFullWidthSpace = @" ";
static const int N_KEY_ROLL_OVER = 50;
@implementation SquirrelInputController {
NSMutableAttributedString* _preeditString;
NSString* _originalString;
NSString* _composedString;
NSString* _schemaId;
NSString* _currentApp;
NSRange _selRange;
NSRange _candidateIndices;
NSUInteger _caretPos;
NSUInteger _converted;
NSUInteger _currentIndex;
NSEventModifierFlags _lastModifiers;
NSEventType _lastEventType;
uint _lastEventCount;
RimeSessionId _session;
BOOL _inlinePreedit;
BOOL _inlineCandidate;
BOOL _goodOldCapsLock;
BOOL _showingSwitcherMenu;
// for chord-typing
NSTimer* _chordTimer;
NSTimeInterval _chordDuration;
int _chordKeyCodes[N_KEY_ROLL_OVER];
int _chordModifiers[N_KEY_ROLL_OVER];
int _chordKeyCount;
}
static SquirrelInputController __weak* _currentController = nil;
static NSString* _currentApp;
static Bool _asciiMode = -1;
+ (void)setCurrentController:(SquirrelInputController*)controller {
_currentController = controller;
NSApp.squirrelAppDelegate.panel.IbeamRect = NSZeroRect;
}
+ (SquirrelInputController*)currentController {
return _currentController;
}
- (NSAppearance*)viewEffectiveAppearance API_AVAILABLE(macos(10.14)) {
return [self.client performSelector:@selector(viewEffectiveAppearance)]
?: NSApp.effectiveAppearance;
}
+ (NSSet<NSString*>*)keyPathsForValuesAffectingViewEffectiveAppearance {
return [NSSet setWithObjects:@"client.viewEffectiveAppearance", nil];
}
/*!
@method
@abstract Receive incoming event
@discussion This method receives key events from the client application.
*/
- (BOOL)handleEvent:(NSEvent*)event client:(id)sender {
// Return YES to indicate the the key input was received and dealt with.
// Key processing will not continue in that case. In other words the
// system will not deliver a key down event to the application.
// Returning NO means the original key down will be passed on to the client.
NSEventModifierFlags modifiers = event.modifierFlags;
BOOL handled = NO;
@autoreleasepool {
if (!_session || !rime_get_api()->find_session(_session)) {
[self createSession];
if (!_session) {
return NO;
}
}
NSString* app = [sender bundleIdentifier];
if (![_currentApp isEqualToString:app]) {
_currentApp = [app copy];
[self updateAppOptions];
}
switch (event.type) {
case NSEventTypeFlagsChanged: {
if (_lastModifiers == modifiers) {
handled = YES;
break;
}
// NSLog(@"FLAGSCHANGED client: %@, modifiers: 0x%lx", sender,
// modifiers);
int rime_modifiers = osx_modifiers_to_rime_modifiers(modifiers);
ushort keyCode = (ushort)CGEventGetIntegerValueField(
event.CGEvent, kCGKeyboardEventKeycode);
int release_mask = 0;
int rime_keycode = osx_keycode_to_rime_keycode((int)keyCode, 0, 0, 0);
NSUInteger changes = _lastModifiers ^ modifiers;
if (changes & NSEventModifierFlagCapsLock) {
// NOTE: rime assumes XK_Caps_Lock to be sent before modifier changes,
// while NSFlagsChanged event has the flag changed already.
// so it is necessary to revert kLockMask.
rime_modifiers ^= kLockMask;
[self processKey:rime_keycode modifiers:rime_modifiers];
}
if (changes & NSEventModifierFlagShift) {
release_mask =
modifiers & NSEventModifierFlagShift ? 0 : kReleaseMask;
[self processKey:rime_keycode
modifiers:(rime_modifiers | release_mask)];
}
if (changes & NSEventModifierFlagControl) {
release_mask =
modifiers & NSEventModifierFlagControl ? 0 : kReleaseMask;
[self processKey:rime_keycode
modifiers:(rime_modifiers | release_mask)];
}
if (changes & NSEventModifierFlagOption) {
release_mask =
modifiers & NSEventModifierFlagOption ? 0 : kReleaseMask;
[self processKey:rime_keycode
modifiers:(rime_modifiers | release_mask)];
}
if (changes & NSEventModifierFlagCommand) {
release_mask =
modifiers & NSEventModifierFlagCommand ? 0 : kReleaseMask;
[self processKey:rime_keycode
modifiers:(rime_modifiers | release_mask)];
// do not update UI when using Command key
break;
}
[self rimeUpdate];
} break;
case NSEventTypeKeyDown: {
// ignore Command+X hotkeys.
if (modifiers & NSEventModifierFlagCommand) {
break;
}
ushort keyCode = event.keyCode;
NSString* keyChars = ((modifiers & NSEventModifierFlagShift) &&
!(modifiers & NSEventModifierFlagControl) &&
!(modifiers & NSEventModifierFlagOption))
? event.characters
: event.charactersIgnoringModifiers;
// NSLog(@"KEYDOWN client: %@, modifiers: 0x%lx, keyCode: %d, keyChars:
// [%@]",
// sender, modifiers, keyCode, keyChars);
// translate osx keyevents to rime keyevents
int rime_keycode = osx_keycode_to_rime_keycode(
(int)keyCode, (int)[keyChars characterAtIndex:0],
(int)(modifiers & NSEventModifierFlagShift),
(int)(modifiers & NSEventModifierFlagCapsLock));
if (rime_keycode) {
int rime_modifiers = osx_modifiers_to_rime_modifiers(modifiers);
handled = [self processKey:rime_keycode modifiers:rime_modifiers];
[self rimeUpdate];
}
} break;
default:
break;
}
}
_lastModifiers = modifiers;
_lastEventType = event.type;
return handled;
}
- (BOOL)mouseDownOnCharacterIndex:(NSUInteger)index
coordinate:(NSPoint)point
withModifier:(NSUInteger)flags
continueTracking:(BOOL*)keepTracking
client:(id)sender {
*keepTracking = NO;
@autoreleasepool {
if ((!_inlinePreedit && !_inlineCandidate) || _composedString.length == 0 ||
_caretPos == index ||
(flags & NSEventModifierFlagDeviceIndependentFlagsMask)) {
return NO;
}
NSRange markedRange = [sender markedRange];
NSPoint head =
[[sender attributesForCharacterIndex:0
lineHeightRectangle:NULL][@"IMKBaseline"] pointValue];
NSPoint tail =
[[sender attributesForCharacterIndex:markedRange.length - 1
lineHeightRectangle:NULL][@"IMKBaseline"] pointValue];
if (point.x > tail.x || index >= markedRange.length) {
if (_inlineCandidate && !_inlinePreedit) {
return NO;
}
[self performAction:kPROCESS onIndex:kEndKey];
} else if (point.x < head.x || index <= 0) {
[self performAction:kPROCESS onIndex:kHomeKey];
} else {
[self moveCursor:_caretPos
toPosition:index
inlinePreedit:_inlinePreedit
inlineCandidate:_inlineCandidate];
}
return YES;
}
}
- (BOOL)processKey:(int)rime_keycode
modifiers:(int)rime_modifiers __attribute__((objc_direct)) {
SquirrelPanel* panel = NSApp.squirrelAppDelegate.panel;
// with linear candidate list, arrow keys may behave differently.
Bool is_linear = (Bool)panel.linear;
if (is_linear != rime_get_api()->get_option(_session, "_linear")) {
rime_get_api()->set_option(_session, "_linear", is_linear);
}
// with vertical text, arrow keys may behave differently.
Bool is_vertical = (Bool)panel.vertical;
if (is_vertical != rime_get_api()->get_option(_session, "_vertical")) {
rime_get_api()->set_option(_session, "_vertical", is_vertical);
}
if (panel.tabular && !rime_modifiers && panel.visible &&
(is_vertical
? rime_keycode == XK_Left || rime_keycode == XK_KP_Left ||
rime_keycode == XK_Right || rime_keycode == XK_KP_Right
: rime_keycode == XK_Up || rime_keycode == XK_KP_Up ||
rime_keycode == XK_Down || rime_keycode == XK_KP_Down)) {
if (rime_keycode >= XK_KP_Left && rime_keycode <= XK_KP_Down) {
rime_keycode = rime_keycode - XK_KP_Left + XK_Left;
}
NSUInteger newIndex =
[panel candidateIndexOnDirection:(SquirrelIndex)rime_keycode];
if (newIndex != NSNotFound) {
if (!panel.locked && !panel.expanded &&
rime_keycode == (is_vertical ? XK_Left : XK_Down)) {
[panel setExpanded:YES];
}
rime_get_api()->highlight_candidate(_session, newIndex);
return YES;
} else if (!panel.locked && panel.expanded && panel.sectionNum == 0 &&
rime_keycode == (is_vertical ? XK_Right : XK_Up)) {
[panel setExpanded:NO];
return YES;
}
}
BOOL handled =
(BOOL)rime_get_api()->process_key(_session, rime_keycode, rime_modifiers);
// NSLog(@"rime_keycode: 0x%x, rime_modifiers: 0x%x, handled = %d",
// rime_keycode, rime_modifiers, handled);
// TODO add special key event postprocessing here
if (!handled) {
BOOL isVimBackInCommandMode =
rime_keycode == XK_Escape ||
((rime_modifiers & kControlMask) &&
(rime_keycode == XK_c || rime_keycode == XK_C ||
rime_keycode == XK_bracketleft));
if (isVimBackInCommandMode &&
rime_get_api()->get_option(_session, "vim_mode") &&
!rime_get_api()->get_option(_session, "ascii_mode")) {
[self cancelComposition];
rime_get_api()->set_option(_session, "ascii_mode", True);
// NSLog(@"turned Chinese mode off in vim-like editor's command mode");
return YES;
}
}
// Simulate key-ups for every interesting key-down for chord-typing.
if (handled) {
BOOL is_chording_key =
(rime_keycode >= XK_space && rime_keycode <= XK_asciitilde) ||
rime_keycode == XK_Control_L || rime_keycode == XK_Control_R ||
rime_keycode == XK_Alt_L || rime_keycode == XK_Alt_R ||
rime_keycode == XK_Shift_L || rime_keycode == XK_Shift_R;
if (is_chording_key &&
rime_get_api()->get_option(_session, "_chord_typing")) {
[self updateChord:rime_keycode modifiers:rime_modifiers];
} else if ((rime_modifiers & kReleaseMask) == 0) {
// non-chording key pressed
[self clearChord];
}
}
return handled;
}
- (void)moveCursor:(NSUInteger)cursorPosition
toPosition:(NSUInteger)targetPosition
inlinePreedit:(BOOL)inlinePreedit
inlineCandidate:(BOOL)inlineCandidate __attribute__((objc_direct)) {
BOOL vertical = NSApp.squirrelAppDelegate.panel.vertical;
@autoreleasepool {
NSString* composition = !inlinePreedit && !inlineCandidate
? _composedString
: _preeditString.string;
RIME_STRUCT(RimeContext, ctx);
if (cursorPosition > targetPosition) {
NSString* targetPrefix = [[composition substringToIndex:targetPosition]
stringByReplacingOccurrencesOfString:@" "
withString:@""];
NSString* prefix = [[composition substringToIndex:cursorPosition]
stringByReplacingOccurrencesOfString:@" "
withString:@""];
while (targetPrefix.length < prefix.length) {
rime_get_api()->process_key(_session, vertical ? XK_Up : XK_Left,
kControlMask);
rime_get_api()->get_context(_session, &ctx);
if (inlineCandidate) {
size_t length =
ctx.composition.cursor_pos < ctx.composition.sel_end
? (size_t)ctx.composition.cursor_pos
: strlen(ctx.commit_text_preview) -
(inlinePreedit ? 0
: (size_t)(ctx.composition.cursor_pos -
ctx.composition.sel_end));
prefix = [[NSString.alloc initWithBytes:ctx.commit_text_preview
length:(NSUInteger)length
encoding:NSUTF8StringEncoding]
stringByReplacingOccurrencesOfString:@" "
withString:@""];
} else {
prefix = [[NSString.alloc
initWithBytes:ctx.composition.preedit
length:(NSUInteger)ctx.composition.cursor_pos
encoding:NSUTF8StringEncoding]
stringByReplacingOccurrencesOfString:@" "
withString:@""];
}
rime_get_api()->free_context(&ctx);
}
} else if (cursorPosition < targetPosition) {
NSString* targetSuffix = [[composition substringFromIndex:targetPosition]
stringByReplacingOccurrencesOfString:@" "
withString:@""];
NSString* suffix = [[composition substringFromIndex:cursorPosition]
stringByReplacingOccurrencesOfString:@" "
withString:@""];
while (targetSuffix.length < suffix.length) {
rime_get_api()->process_key(_session, vertical ? XK_Down : XK_Right,
kControlMask);
rime_get_api()->get_context(_session, &ctx);
suffix = [@(ctx.composition.preedit + ctx.composition.cursor_pos +
(!inlinePreedit && !inlineCandidate ? 3 : 0))
stringByReplacingOccurrencesOfString:@" "
withString:@""];
rime_get_api()->free_context(&ctx);
}
}
}
[self rimeUpdate];
}
- (void)performAction:(SquirrelAction)action
onIndex:(SquirrelIndex)index __attribute__((objc_direct)) {
// NSLog(@"perform action: %lu on index: %lu", action, index);
bool handled = false;
switch (action) {
case kPROCESS:
if (index >= 0xff08 && index <= 0xffff) {
handled = rime_get_api()->process_key(_session, (int)index, 0);
} else if (index >= kExpandButton && index <= kLockButton) {
handled = true;
_currentIndex = NSNotFound;
}
break;
case kSELECT:
handled = rime_get_api()->select_candidate(_session, index);
break;
case kHIGHLIGHT:
handled = rime_get_api()->highlight_candidate(_session, index);
_currentIndex = NSNotFound;
break;
case kDELETE:
handled = rime_get_api()->delete_candidate(_session, index);
break;
}
if (handled) {
[self rimeUpdate];
}
}
- (void)onChordTimer:(NSTimer*)timer {
// chord release triggered by timer
int processed_keys = 0;
if (_chordKeyCount && _session) {
// simulate key-ups
for (int i = 0; i < _chordKeyCount; ++i) {
if (rime_get_api()->process_key(_session, _chordKeyCodes[i],
(_chordModifiers[i] | kReleaseMask)))
++processed_keys;
}
}
[self clearChord];
if (processed_keys) {
[self rimeUpdate];
}
}
- (void)updateChord:(int)keycode
modifiers:(int)modifiers __attribute__((objc_direct)) {
// NSLog(@"update chord: {%s} << %x", _chord, keycode);
for (int i = 0; i < _chordKeyCount; ++i) {
if (_chordKeyCodes[i] == keycode)
return;
}
if (_chordKeyCount >= N_KEY_ROLL_OVER) {
// you are cheating. only one human typist (fingers <= 10) is supported.
return;
}
_chordKeyCodes[_chordKeyCount] = keycode;
_chordModifiers[_chordKeyCount] = modifiers;
++_chordKeyCount;
// reset timer
if (_chordTimer.valid) {
[_chordTimer invalidate];
}
_chordDuration = 0.1;
NSNumber* duration = [NSApp.squirrelAppDelegate.config
getOptionalDoubleForOption:@"chord_duration"];
if (duration.doubleValue > 0) {
_chordDuration = duration.doubleValue;
}
_chordTimer = [NSTimer scheduledTimerWithTimeInterval:_chordDuration
target:self
selector:@selector(onChordTimer:)
userInfo:nil
repeats:NO];
}
- (void)clearChord __attribute__((objc_direct)) {
_chordKeyCount = 0;
if (_chordTimer.valid) {
[_chordTimer invalidate];
_chordTimer = nil;
}
}
- (NSUInteger)recognizedEvents:(id)sender {
// NSLog(@"recognizedEvents:");
return NSEventMaskKeyDown | NSEventMaskFlagsChanged |
NSEventMaskLeftMouseDown;
}
static NSString* getOptionLabel(RimeSessionId session,
const char* option,
Bool state) {
RimeStringSlice short_label =
rime_get_api()->get_state_label_abbreviated(session, option, state, True);
if (short_label.str && short_label.length >= strlen(short_label.str)) {
return @(short_label.str);
} else {
RimeStringSlice long_label = rime_get_api()->get_state_label_abbreviated(
session, option, state, False);
NSString* label = long_label.str ? @(long_label.str) : nil;
return [label
substringWithRange:[label rangeOfComposedCharacterSequenceAtIndex:0]];
}
}
- (void)showInitialStatus __attribute__((objc_direct)) {
RIME_STRUCT(RimeStatus, status);
if (_session && rime_get_api()->get_status(_session, &status)) {
_schemaId = @(status.schema_id);
NSString* schemaName =
status.schema_name ? @(status.schema_name) : @(status.schema_id);
NSMutableArray<NSString*>* options =
[NSMutableArray.alloc initWithCapacity:3];
NSString* asciiMode =
getOptionLabel(_session, "ascii_mode", status.is_ascii_mode);
if (asciiMode) {
[options addObject:asciiMode];
}
NSString* fullShape =
getOptionLabel(_session, "full_shape", status.is_full_shape);
if (fullShape) {
[options addObject:fullShape];
}
NSString* asciiPunct =
getOptionLabel(_session, "ascii_punct", status.is_ascii_punct);
if (asciiPunct) {
[options addObject:asciiPunct];
}
rime_get_api()->free_status(&status);
NSString* foldedOptions =
options.count == 0
? schemaName
: [NSString
stringWithFormat:@"%@｜%@", schemaName,
[options componentsJoinedByString:@" "]];
[NSApp.squirrelAppDelegate.panel updateStatusLong:foldedOptions
statusShort:schemaName];
if (@available(macOS 14.0, *)) {
_lastModifiers |= NSEventModifierFlagHelp;
}
[self rimeUpdate];
}
}
- (void)activateServer:(id)sender {
// NSLog(@"activateServer:");
[SquirrelInputController setCurrentController:self];
[self addObserver:NSApp.squirrelAppDelegate.panel
forKeyPath:@"viewEffectiveAppearance"
options:NSKeyValueObservingOptionNew |
NSKeyValueObservingOptionInitial
context:nil];
NSString* keyboardLayout =
[NSApp.squirrelAppDelegate.config getStringForOption:@"keyboard_layout"];
if ([@"last" caseInsensitiveCompare:keyboardLayout] == NSOrderedSame ||
[keyboardLayout isEqualToString:@""]) {
keyboardLayout = nil;
} else if ([@"default" caseInsensitiveCompare:keyboardLayout] ==
NSOrderedSame) {
keyboardLayout = @"com.apple.keylayout.ABC";
} else if (![keyboardLayout hasPrefix:@"com.apple.keylayout."]) {
keyboardLayout =
[@"com.apple.keylayout." stringByAppendingString:keyboardLayout];
}
if (keyboardLayout) {
[sender overrideKeyboardWithKeyboardNamed:keyboardLayout];
}
SquirrelConfig* defaultConfig = SquirrelConfig.alloc.init;
if ([defaultConfig openWithConfigId:@"default"] &&
[defaultConfig hasSection:@"ascii_composer"]) {
_goodOldCapsLock =
[defaultConfig getBoolForOption:@"ascii_composer/good_old_caps_lock"];
}
[defaultConfig close];
if (!NSApp.squirrelAppDelegate.isCurrentInputMethod) {
NSApp.squirrelAppDelegate.isCurrentInputMethod = YES;
if (NSApp.squirrelAppDelegate.showNotifications ==
kShowNotificationsAlways) {
[self showInitialStatus];
}
}
[super activateServer:sender];
}
- (instancetype)initWithServer:(IMKServer*)server
delegate:(id)delegate
client:(id)inputClient {
// NSLog(@"initWithServer:delegate:client:");
self = [super initWithServer:server delegate:delegate client:inputClient];
if (self) {
[self createSession];
self.delegate = self;
_candidateTexts = NSMutableArray.alloc.init;
_candidateComments = NSMutableArray.alloc.init;
}
return self;
}
- (void)deactivateServer:(id)sender {
// NSLog(@"deactivateServer:");
_asciiMode = rime_get_api()->get_option(_session, "ascii_mode");
[self commitComposition:sender];
[self removeObserver:NSApp.squirrelAppDelegate.panel
forKeyPath:@"viewEffectiveAppearance"];
[super deactivateServer:sender];
}
/*!
@method
@abstract Called when a user action was taken that ends an input session.
Typically triggered by the user selecting a new input method
or keyboard layout.
@discussion When this method is called your controller should send the
current input buffer to the client via a call to
insertText:replacementRange:. Additionally, this is the time
to clean up if that is necessary.
*/
- (void)commitComposition:(id)sender {
// NSLog(@"commitComposition:");
[self commitString:[self composedString:sender]];
if (_session) {
rime_get_api()->clear_composition(_session);
}
[self hidePalettes];
}
- (void)clearBuffer __attribute__((objc_direct)) {
NSApp.squirrelAppDelegate.panel.IbeamRect = NSZeroRect;
_preeditString = nil;
_originalString = nil;
_composedString = nil;
}
// a piece of comment from SunPinyin's macos wrapper says:
// > though we specified the showPrefPanel: in SunPinyinApplicationDelegate as
// the > action receiver, the IMKInputController will actually receive the
// event. so here we deliver messages to our responsible
// SquirrelApplicationDelegate
- (void)showSwitcher:(id)sender {
[NSApp.squirrelAppDelegate showSwitcher:@(_session)];
[self rimeUpdate];
}
- (void)deploy:(id)sender {
[NSApp.squirrelAppDelegate deploy:sender];
}
- (void)syncUserData:(id)sender {
[NSApp.squirrelAppDelegate syncUserData:sender];
}
- (void)configure:(id)sender {
[NSApp.squirrelAppDelegate configure:sender];
}
- (void)checkForUpdates:(id)sender {
[NSApp.squirrelAppDelegate.updater performSelector:@selector(checkForUpdates:)
withObject:sender];
}
- (void)openWiki:(id)sender {
[NSApp.squirrelAppDelegate openWiki:sender];
}
- (NSMenu*)menu {
return NSApp.squirrelAppDelegate.menu;
}
- (NSAttributedString*)originalString:(id)sender {
return [NSAttributedString.alloc initWithString:_originalString];
}
- (id)composedString:(id)sender {
return [_composedString stringByReplacingOccurrencesOfString:@" "
withString:@""];
}
- (NSArray*)candidates:(id)sender {
return [_candidateTexts subarrayWithRange:_candidateIndices];
}
- (void)hidePalettes {
[NSApp.squirrelAppDelegate.panel hide];
if (_session) {
rime_get_api()->clear_composition(_session);
}
[super hidePalettes];
}
- (void)dealloc {
// NSLog(@"dealloc");
[self destroySession];
[self clearBuffer];
}
- (NSRange)selectionRange {
return NSMakeRange(_caretPos, 0);
}
- (NSRange)replacementRange {
return NSMakeRange(NSNotFound, NSNotFound);
}
- (void)commitString:(id)string {
// NSLog(@"commitString:");
if (string) {
[self.client insertText:string
replacementRange:NSMakeRange(NSNotFound, NSNotFound)];
}
[self clearBuffer];
}
- (void)cancelComposition {
[self commitString:[self originalString:self.client]];
[self hidePalettes];
if (_session) {
rime_get_api()->clear_composition(_session);
}
}
- (void)updateComposition {
[self.client setMarkedText:_preeditString
selectionRange:NSMakeRange(_caretPos, 0)
replacementRange:NSMakeRange(NSNotFound, NSNotFound)];
}
- (void)showPreeditString:(NSString*)preedit
selRange:(NSRange)range
caretPos:(NSUInteger)pos __attribute__((objc_direct)) {
// NSLog(@"showPreeditString: '%@'", preedit);
if ([preedit isEqualToString:_preeditString.string] &&
NSEqualRanges(range, _selRange) && pos == _caretPos) {
return;
}
_selRange = range;
_caretPos = pos;
// NSLog(@"selRange.location = %ld, selRange.length = %ld; caretPos = %ld",
// range.location, range.length, pos);
NSDictionary* attrs = [self markForStyle:kTSMHiliteRawText
atRange:NSMakeRange(0, preedit.length)];
_preeditString = [[NSMutableAttributedString alloc] initWithString:preedit
attributes:attrs];
if (range.location > 0) {
[_preeditString
addAttributes:[self markForStyle:kTSMHiliteConvertedText
atRange:NSMakeRange(0, range.location)]
range:NSMakeRange(0, range.location)];
}
if (range.location < pos) {
[_preeditString addAttributes:[self markForStyle:kTSMHiliteSelectedRawText
atRange:range]
range:range];
}
[self updateComposition];
}
- (CGRect)getIbeamRect __attribute__((objc_direct)) {
NSRect IbeamRect = NSZeroRect;
[self.client attributesForCharacterIndex:0 lineHeightRectangle:&IbeamRect];
if (NSEqualRects(IbeamRect, NSZeroRect) && _preeditString.length == 0) {
if (self.client.selectedRange.length == 0) {
// activate inline session, in e.g. table cells, by fake inputs
[self.client setMarkedText:@" "
selectionRange:NSMakeRange(0, 0)
replacementRange:NSMakeRange(NSNotFound, NSNotFound)];
[self.client attributesForCharacterIndex:0
lineHeightRectangle:&IbeamRect];
[self.client setMarkedText:_preeditString
selectionRange:NSMakeRange(0, 0)
replacementRange:NSMakeRange(NSNotFound, NSNotFound)];
} else {
[self.client
attributesForCharacterIndex:self.client.selectedRange.location
lineHeightRectangle:&IbeamRect];
}
}
if (NSIsEmptyRect(IbeamRect)) {
return IbeamRect;
}
if (@available(
macOS 14.0, *)) { // avoid overlapping with cursor effects view
if (_goodOldCapsLock && (_lastModifiers & NSEventModifierFlagCapsLock)) {
_lastModifiers &= ~NSEventModifierFlagHelp;
NSRect screenRect = NSScreen.mainScreen.frame;
if (NSIntersectsRect(IbeamRect, screenRect)) {
screenRect = NSScreen.mainScreen.visibleFrame;
if (NSWidth(IbeamRect) > NSHeight(IbeamRect)) {
NSRect capslockAccessory =
NSMakeRect(NSMinX(IbeamRect) - 30, NSMinY(IbeamRect), 27,
NSHeight(IbeamRect));
if (NSMinX(capslockAccessory) < NSMinX(screenRect)) {
capslockAccessory.origin.x = NSMinX(screenRect);
}
if (NSMaxX(capslockAccessory) > NSMaxX(screenRect)) {
capslockAccessory.origin.x =
NSMaxX(screenRect) - NSWidth(capslockAccessory);
}
IbeamRect = NSUnionRect(IbeamRect, capslockAccessory);
} else {
NSRect capslockAccessory =
NSMakeRect(NSMinX(IbeamRect), NSMinY(IbeamRect) - 26,
NSWidth(IbeamRect), 23);
if (NSMinY(capslockAccessory) < NSMinY(screenRect)) {
capslockAccessory.origin.y = NSMaxY(screenRect) + 3;
}
if (NSMaxY(capslockAccessory) > NSMaxY(screenRect)) {
capslockAccessory.origin.y =
NSMaxY(screenRect) - NSHeight(capslockAccessory);
}
IbeamRect = NSUnionRect(IbeamRect, capslockAccessory);
}
}
}
}
return IbeamRect;
}
- (void)showPanelWithPreedit:(NSString*)preedit
selRange:(NSRange)selRange
caretPos:(NSUInteger)caretPos
candidateIndices:(NSRange)candidateIndices
highlightedIndex:(NSUInteger)highlightedIndex
pageNum:(NSUInteger)pageNum
finalPage:(BOOL)finalPage
didCompose:(BOOL)didCompose __attribute__((objc_direct)) {
// NSLog(@"showPanelWithPreedit:...:");
SquirrelPanel* panel = NSApp.squirrelAppDelegate.panel;
panel.IbeamRect = [self getIbeamRect];
if (NSIsEmptyRect(panel.IbeamRect) && panel.statusMessage.length > 0) {
[panel updateStatusLong:nil statusShort:nil];
} else {
_candidateIndices = candidateIndices;
[panel showPreedit:preedit
selRange:selRange
caretPos:caretPos
candidateIndices:candidateIndices
highlightedIndex:highlightedIndex
pageNum:pageNum
finalPage:finalPage
didCompose:didCompose];
}
}
@end // SquirrelController
// implementation of private interface
@implementation SquirrelInputController (Private)
- (void)createSession {
NSString* app = self.client.bundleIdentifier;
// NSLog(@"createSession: %@", app);
_session = rime_get_api()->create_session();
_schemaId = nil;
if (_session) {
[self updateAppOptions];
}
if ([app isEqualToString:_currentApp] && _asciiMode >= 0) {
rime_get_api()->set_option(_session, "ascii_mode", _asciiMode);
}
_currentApp = app;
_asciiMode = -1;
_lastModifiers = 0;
_lastEventCount = 0;
NSApp.squirrelAppDelegate.panel.IbeamRect = NSZeroRect;
[self rimeUpdate];
}
- (void)updateAppOptions {
if (!_currentApp)
return;
SquirrelAppOptions* appOptions =
[NSApp.squirrelAppDelegate.config getAppOptions:_currentApp];
for (NSString* key in appOptions) {
NSNumber* number = appOptions[key];
if (!strcmp(number.objCType, @encode(BOOL))) {
Bool value = number.intValue;
// NSLog(@"set app option: %@ = %d", key, value);
rime_get_api()->set_option(_session, key.UTF8String, value);
}
}
}
- (void)destroySession {
// NSLog(@"destroySession:");
if (_session) {
rime_get_api()->destroy_session(_session);
_session = 0;
}
[self clearChord];
}
- (BOOL)rimeConsumeCommittedText {
RIME_STRUCT(RimeCommit, commit);
if (rime_get_api()->get_commit(_session, &commit)) {
NSString* commitText = @(commit.text);
[self commitString:commitText];
rime_get_api()->free_commit(&commit);
return YES;
}
return NO;
}
static NSUInteger inline UTF8LengthToUTF16Length(const char* string,
int length) {
return [[NSString alloc] initWithBytes:string
length:(NSUInteger)length
encoding:NSUTF8StringEncoding]
.length;
}
- (void)rimeUpdate {
// NSLog(@"rimeUpdate");
BOOL didCommit = self.rimeConsumeCommittedText;
BOOL didCompose = didCommit;
SquirrelPanel* panel = NSApp.squirrelAppDelegate.panel;
RIME_STRUCT(RimeStatus, status);
if (rime_get_api()->get_status(_session, &status)) {
// enable schema specific ui style
if (!_schemaId || strcmp(_schemaId.UTF8String, status.schema_id)) {
_schemaId = @(status.schema_id);
_showingSwitcherMenu = (BOOL)rime_get_api()->get_option(_session, "dumb");
if (!_showingSwitcherMenu) {
[NSApp.squirrelAppDelegate loadSchemaSpecificLabels:_schemaId];
[NSApp.squirrelAppDelegate loadSchemaSpecificSettings:_schemaId
withRimeSession:_session];
// inline preedit
_inlinePreedit = (panel.inlinePreedit &&
!rime_get_api()->get_option(_session, "no_inline")) ||
rime_get_api()->get_option(_session, "inline");
_inlineCandidate = panel.inlineCandidate &&
!rime_get_api()->get_option(_session, "no_inline");
// if not inline, embed soft cursor in preedit string
rime_get_api()->set_option(_session, "soft_cursor", !_inlinePreedit);
} else {
[NSApp.squirrelAppDelegate loadSchemaSpecificLabels:@""];
}
didCompose = YES;
}
rime_get_api()->free_status(&status);
}
RIME_STRUCT(RimeContext, ctx);
if (rime_get_api()->get_context(_session, &ctx)) {
BOOL showingStatus = panel.statusMessage.length > 0;
// update preedit text
const char* preedit = ctx.composition.preedit;
NSString* preeditText = preedit ? @(preedit) : @"";
// update raw input
const char* raw_input = rime_get_api()->get_input(_session);
NSString* originalString = raw_input ? @(raw_input) : @"";
didCompose |= ![originalString isEqualToString:_originalString];
_originalString = originalString;
// update composed string
if (!preedit || _showingSwitcherMenu) {
_composedString = @"";
} else if (!_inlinePreedit) { // remove soft cursor
size_t cursorPos =
(size_t)ctx.composition.cursor_pos -
(ctx.composition.cursor_pos < ctx.composition.sel_end ? 3 : 0);
char composed[strlen(preedit) - 2];
strlcpy(composed, preedit, cursorPos + 1);
strlcat(composed, preedit + cursorPos + 3, strlen(preedit) - 2);
_composedString = @(composed);
} else {
_composedString = @(preedit);
}
NSUInteger start =
UTF8LengthToUTF16Length(preedit, ctx.composition.sel_start);
NSUInteger end = UTF8LengthToUTF16Length(preedit, ctx.composition.sel_end);
NSUInteger caretPos =
UTF8LengthToUTF16Length(preedit, ctx.composition.cursor_pos);
NSUInteger length =
UTF8LengthToUTF16Length(preedit, ctx.composition.length);
NSUInteger numCandidates = (NSUInteger)ctx.menu.num_candidates;
NSUInteger pageNum = (NSUInteger)ctx.menu.page_no;
NSUInteger pageSize = (NSUInteger)ctx.menu.page_size;
NSUInteger highlightedIndex =
numCandidates == 0 ? NSNotFound
: (NSUInteger)ctx.menu.highlighted_candidate_index;
BOOL finalPage = (BOOL)ctx.menu.is_last_page;
didCompose |= start != _converted;
_converted = start;
// update expander and section status in tabular layout;
// already processed the action if _currentIndex == NSNotFound
if (panel.tabular && !showingStatus) {
if (numCandidates == 0 || didCompose) {
panel.sectionNum = 0;
} else if (_currentIndex != NSNotFound) {
NSUInteger currentPageNum = _currentIndex / pageSize;
if (!panel.locked && panel.expanded && panel.firstLine &&
pageNum == 0 && highlightedIndex == 0 && _currentIndex == 0) {
panel.expanded = NO;
} else if (!panel.locked && !panel.expanded &&
pageNum > currentPageNum) {
panel.expanded = YES;
}
if (panel.expanded && pageNum > currentPageNum &&
panel.sectionNum < (panel.vertical ? 2 : 4)) {
panel.sectionNum =
MIN(panel.sectionNum + pageNum - currentPageNum,
(finalPage ? 4UL : 3UL) - (panel.vertical ? 2UL : 0UL));
} else if (panel.expanded && pageNum < currentPageNum &&
panel.sectionNum > 0) {
panel.sectionNum = MAX(panel.sectionNum + pageNum - currentPageNum,
pageNum == 0 ? 0UL : 1UL);
}
}
highlightedIndex += pageSize * panel.sectionNum;
}
NSUInteger extraCandidates =
panel.expanded && caretPos >= end
? (finalPage ? panel.sectionNum : (panel.vertical ? 2 : 4)) *
pageSize
: 0;
NSRange candidateIndices =
NSMakeRange((pageNum - panel.sectionNum) * pageSize,
numCandidates + extraCandidates);