IMKSwift & SessionCtl // Lambda-assign all protocol implementations.

Author: ShikiSuen

Packages/vChewing_IMKUtils/Sources/IMKSwiftModernHeaders/IMKSwift.m

@@ -8,16 +8,14 @@
 /// This file provides the `@implementation` block for `IMKInputSessionController`,
 /// which is declared in `IMKSwift.h` as a subclass of `IMKInputController`.
 ///
-/// Because `IMKInputSessionController` re-declares inherited methods from
-/// `IMKInputController` (with refined nullability and `@MainActor` annotations),
-/// the compiler would normally emit `-Wincomplete-implementation` warnings for
-/// each method that lacks an explicit body.  The `#pragma clang diagnostic`
-/// block suppresses these warnings — the actual implementations are inherited
-/// from `IMKInputController` at runtime via the Objective-C message dispatch.
+/// **All** `IMKInputController` overrides are implemented here; each invokes the
+/// corresponding block property set by the Swift subclass.  The blocks receive
+/// raw memory addresses (`uintptr_t`) instead of object references — no
+/// retain/release is performed on the client or the controller itself.
 ///
-/// **Only** `-activateServer:` and `-deactivateServer:` are implemented here;
-/// they invoke the block properties (`onActivateServer` / `onDeactivateServer`)
-/// set by the Swift subclass and manage the deferred-dealloc timer.
+/// The `-Wincomplete-implementation` pragma is still needed for the remaining
+/// methods that are inherited from `IMKInputController` at runtime without
+/// explicit bodies (e.g. `candidates:`, `doCommandBy:`).
 
 #import <Foundation/Foundation.h>
 #import <InputMethodKit/InputMethodKit.h>
@@ -32,42 +30,46 @@ @implementation IMKInputSessionController {
     void (^_onActivateServer)(uintptr_t, uintptr_t);
     void (^_onDeactivateServer)(uintptr_t, uintptr_t);
     void (^_onDealloc)(uintptr_t);
+    void (^_onShowingPreferences)(uintptr_t, uintptr_t);
+    void (^_onHidingPallettes)(uintptr_t);
+    void (^_onInputControllerWillClose)(uintptr_t);
+    NSRange (^_onProvidingSelectionRange)(uintptr_t);
+    NSMenu * _Nullable (^_onProvidingIMEMenu)(uintptr_t);
+    id _Nullable (^_onProvidingComposedString)(uintptr_t, uintptr_t);
+    void (^_onAutoCommittingComposition)(uintptr_t, uintptr_t);
+    NSUInteger (^_onProvidingRecognizedEvents)(uintptr_t, uintptr_t);
+    BOOL (^_onHandlingGivenNullableEvent)(uintptr_t, uintptr_t, uintptr_t);
+    void (^_onSettingObjCValue)(uintptr_t, intptr_t, uintptr_t, uintptr_t);
 }
 
 // MARK: - Block Properties (MRC)
 
-- (void)setOnActivateServer:(nullable void (^)(uintptr_t, uintptr_t))block {
-    if (_onActivateServer != block) {
-        [_onActivateServer release];
-        _onActivateServer = [block copy];
+#define MRC_BLOCK_PROPERTY(_name, _sig) \
+    - (void)set##_name:(nullable _sig)block { \
+        if (_##_name != block) { \
+            [_##_name release]; \
+            _##_name = [block copy]; \
+        } \
+    } \
+    - (nullable _sig)_name { \
+        return [[_##_name retain] autorelease]; \
     }
-}
-
-- (nullable void (^)(uintptr_t, uintptr_t))onActivateServer {
-    return [[_onActivateServer retain] autorelease];
-}
-
-- (void)setOnDeactivateServer:(nullable void (^)(uintptr_t, uintptr_t))block {
-    if (_onDeactivateServer != block) {
-        [_onDeactivateServer release];
-        _onDeactivateServer = [block copy];
-    }
-}
-
-- (nullable void (^)(uintptr_t, uintptr_t))onDeactivateServer {
-    return [[_onDeactivateServer retain] autorelease];
-}
 
-- (void)setOnDealloc:(nullable void (^)(uintptr_t))block {
-    if (_onDealloc != block) {
-        [_onDealloc release];
-        _onDealloc = [block copy];
-    }
-}
-
-- (nullable void (^)(uintptr_t))onDealloc {
-    return [[_onDealloc retain] autorelease];
-}
+MRC_BLOCK_PROPERTY(onActivateServer, void (^)(uintptr_t, uintptr_t))
+MRC_BLOCK_PROPERTY(onDeactivateServer, void (^)(uintptr_t, uintptr_t))
+MRC_BLOCK_PROPERTY(onDealloc, void (^)(uintptr_t))
+MRC_BLOCK_PROPERTY(onShowingPreferences, void (^)(uintptr_t, uintptr_t))
+MRC_BLOCK_PROPERTY(onHidingPallettes, void (^)(uintptr_t))
+MRC_BLOCK_PROPERTY(onInputControllerWillClose, void (^)(uintptr_t))
+MRC_BLOCK_PROPERTY(onProvidingSelectionRange, NSRange (^)(uintptr_t))
+MRC_BLOCK_PROPERTY(onProvidingIMEMenu, NSMenu * _Nullable (^)(uintptr_t))
+MRC_BLOCK_PROPERTY(onProvidingComposedString, id _Nullable (^)(uintptr_t, uintptr_t))
+MRC_BLOCK_PROPERTY(onAutoCommittingComposition, void (^)(uintptr_t, uintptr_t))
+MRC_BLOCK_PROPERTY(onProvidingRecognizedEvents, NSUInteger (^)(uintptr_t, uintptr_t))
+MRC_BLOCK_PROPERTY(onHandlingGivenNullableEvent, BOOL (^)(uintptr_t, uintptr_t, uintptr_t))
+MRC_BLOCK_PROPERTY(onSettingObjCValue, void (^)(uintptr_t, intptr_t, uintptr_t, uintptr_t))
+
+#undef MRC_BLOCK_PROPERTY
 
 // MARK: - Lifecycle
 
@@ -76,6 +78,16 @@ - (void)dealloc {
     [_onDealloc release];
     [_onActivateServer release];
     [_onDeactivateServer release];
+    [_onShowingPreferences release];
+    [_onHidingPallettes release];
+    [_onInputControllerWillClose release];
+    [_onProvidingSelectionRange release];
+    [_onProvidingIMEMenu release];
+    [_onProvidingComposedString release];
+    [_onAutoCommittingComposition release];
+    [_onProvidingRecognizedEvents release];
+    [_onHandlingGivenNullableEvent release];
+    [_onSettingObjCValue release];
     [self IMKSwift_cancelDelayedDealloc];
     [super dealloc];
 }
@@ -92,6 +104,51 @@ - (void)deactivateServer:(id)sender {
     [self IMKSwift_scheduleDelayedDeallocAfterDelay:3.0];
 }
 
+- (void)showPreferences:(nullable id)sender {
+    if (_onShowingPreferences) _onShowingPreferences((uintptr_t)sender, (uintptr_t)self);
+}
+
+- (void)hidePalettes {
+    if (_onHidingPallettes) _onHidingPallettes((uintptr_t)self);
+}
+
+- (void)inputControllerWillClose {
+    if (_onInputControllerWillClose) _onInputControllerWillClose((uintptr_t)self);
+}
+
+- (NSRange)selectionRange {
+    if (_onProvidingSelectionRange) return _onProvidingSelectionRange((uintptr_t)self);
+    return NSMakeRange(NSNotFound, 0);
+}
+
+- (nullable NSMenu *)menu {
+    if (_onProvidingIMEMenu) return _onProvidingIMEMenu((uintptr_t)self);
+    return [[NSMenu new] autorelease];
+}
+
+- (nullable id)composedString:(id)sender {
+    if (_onProvidingComposedString) return _onProvidingComposedString((uintptr_t)sender, (uintptr_t)self);
+    return nil;
+}
+
+- (void)commitComposition:(id)sender {
+    if (_onAutoCommittingComposition) _onAutoCommittingComposition((uintptr_t)sender, (uintptr_t)self);
+}
+
+- (NSUInteger)recognizedEvents:(id)sender {
+    if (_onProvidingRecognizedEvents) return _onProvidingRecognizedEvents((uintptr_t)sender, (uintptr_t)self);
+    return 0;
+}
+
+- (BOOL)handleEvent:(nullable NSEvent *)event client:(id)sender {
+    if (_onHandlingGivenNullableEvent) return _onHandlingGivenNullableEvent((uintptr_t)event, (uintptr_t)sender, (uintptr_t)self);
+    return NO;
+}
+
+- (void)setValue:(nullable id)value forTag:(NSInteger)tag client:(id)sender {
+    if (_onSettingObjCValue) _onSettingObjCValue((uintptr_t)value, (intptr_t)tag, (uintptr_t)sender, (uintptr_t)self);
+}
+
 // MARK: - Private: Deferred Dealloc
 
 /// Schedules a delayed dealloc of this controller after `delay` seconds.

Packages/vChewing_IMKUtils/Sources/IMKSwiftModernHeaders/include/IMKSwift.h

@@ -900,7 +900,7 @@
 /// @return An array of candidate objects, or `nil` if there are no candidates.
 - (nullable NSArray *)candidates:(nonnull id<IMKTextInput>)sender;
 
-// MARK: Deferred Dealloc Callbacks
+// MARK: Deferred Dealloc & IME Lifecycle Callbacks
 
 /// Block invoked from `-activateServer:` after cancelling any pending delayed
 /// dealloc.  Receives raw memory addresses (`uintptr_t`) of both the
@@ -916,6 +916,36 @@
 /// that must run even if the Swift subclass's `deinit` is skipped.
 @property (copy, nullable) void (^onDealloc)(uintptr_t selfAddr);
 
+/// Block invoked from `-showPreferences:`.
+@property (copy, nullable) void (^onShowingPreferences)(uintptr_t givenClientAddr, uintptr_t selfAddr);
+
+/// Block invoked from `-hidePalettes`.
+@property (copy, nullable) void (^onHidingPallettes)(uintptr_t selfAddr);
+
+/// Block invoked from `-inputControllerWillClose`.
+@property (copy, nullable) void (^onInputControllerWillClose)(uintptr_t selfAddr);
+
+/// Block invoked from `-selectionRange`.
+@property (copy, nullable) NSRange (^onProvidingSelectionRange)(uintptr_t selfAddr);
+
+/// Block invoked from `-menu`.
+@property (copy, nullable) NSMenu * _Nullable (^onProvidingIMEMenu)(uintptr_t selfAddr);
+
+/// Block invoked from `-composedString:`.
+@property (copy, nullable) id _Nullable (^onProvidingComposedString)(uintptr_t givenClientAddr, uintptr_t selfAddr);
+
+/// Block invoked from `-commitComposition:`.
+@property (copy, nullable) void (^onAutoCommittingComposition)(uintptr_t givenClientAddr, uintptr_t selfAddr);
+
+/// Block invoked from `-recognizedEvents:`.
+@property (copy, nullable) NSUInteger (^onProvidingRecognizedEvents)(uintptr_t givenClientAddr, uintptr_t selfAddr);
+
+/// Block invoked from `-handleEvent:client:`.  `nsEventPtr` may be 0 (nil event).
+@property (copy, nullable) BOOL (^onHandlingGivenNullableEvent)(uintptr_t nsEventPtr, uintptr_t givenClientAddr, uintptr_t selfAddr);
+
+/// Block invoked from `-setValue:forTag:client:`.  `valuePtr` may be 0 (nil value).
+@property (copy, nullable) void (^onSettingObjCValue)(uintptr_t valuePtr, intptr_t intTag, uintptr_t givenClientAddr, uintptr_t selfAddr);
+
 @end
 
 #pragma clang attribute pop