Handle input connection close

Author: xtyxtyx

Sources/Shaft/Core/Backend.swift

@@ -61,6 +61,9 @@ public protocol NativeView: AnyObject {
     /// and begin receiving these events.
     var onTextComposed: TextComposedCallback? { get set }
 
+    /// A callback that is invoked when the text input connection is closed.
+    var onTextInputClosed: VoidCallback? { get set }
+
     /// Getting/Setting the title of the view if possible.
     var title: String { get set }
 

Sources/Shaft/Services/TextInput.swift

@@ -10,6 +10,7 @@ public class TextInput {
         self.view = view
         view.onTextEditing = handleTextEditing
         view.onTextComposed = handleTextComposed
+        view.onTextInputClosed = handleTextInputClosed
     }
 
     public weak var view: NativeView!
@@ -34,6 +35,11 @@ public class TextInput {
         currentConnection?.client?.onTextComposed(text: text)
     }
 
+    private func handleTextInputClosed() {
+        currentConnection?.client?.onTextInputClosed()
+        currentConnection = nil
+    }
+
     fileprivate func setComposingRect(_ rect: Rect) {
         view.setComposingRect(rect)
     }
@@ -75,6 +81,9 @@ public protocol TextInputClient: AnyObject {
 
     /// Called when the text has been composed and committed.
     func onTextComposed(text: String)
+
+    /// Called when the text input connection is closed.
+    func onTextInputClosed()
 }
 
 /// An interface for interacting with a text input control.

Sources/Shaft/Widgets/Text/EditableText.swift

@@ -1296,6 +1296,13 @@ public final class EditableTextState: State<EditableText>, TextSelectionDelegate
         // no-op
     }
 
+    public func onTextInputClosed() {
+        if hasInputConnection {
+            textInputConnection = nil
+            widget.focusNode.unfocus()
+        }
+    }
+
     /// Sends the current composing rect to the embedder's text input plugin.
     ///
     /// In cases where the composing rect hasn't been updated in the embedder due
@@ -1752,7 +1759,7 @@ public final class EditableTextState: State<EditableText>, TextSelectionDelegate
     }
 
     private var textInputConnection: TextInputConnection?
-    private var hasInputConnection: Bool { textInputConnection != nil }
+    private var hasInputConnection: Bool { textInputConnection?.isActive ?? false }
 
     private func openOrCloseInputConnectionIfNeeded() {
         if hasFocus && widget.focusNode.consumeKeyboardToken() {

Sources/ShaftSDL3/SDLView.swift

@@ -187,6 +187,7 @@ public class SDLView: NativeView {
 
         if SDL_StopTextInput(sdlWindow) {
             backend?.textEditingView = nil
+            onTextInputClosed?()
         } else {
             mark("SDL_StopTextInput failed")
         }
@@ -246,6 +247,10 @@ public class SDLView: NativeView {
     /// events are received.
     public var onTextComposed: TextComposedCallback?
 
+    /// It's the backend's responsibility to call this method when the text input
+    /// connection is closed.
+    public var onTextInputClosed: VoidCallback?
+
     fileprivate func handleEventSync(_ event: inout SDL_Event) -> Bool {
         switch SDL_EventType(event.type.cast()) {
         case SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED:

Tests/ShaftTests/TestUtils/WidgetTester.swift

@@ -491,6 +491,8 @@ class TestBackend: Backend {
 
     var onTextComposed: TextComposedCallback?
 
+    var onTextInputClosed: VoidCallback?
+
     var onKeyEvent: KeyEventCallback?
 
     var targetPlatform: TargetPlatform? {