[SuperEditor] - Added logs to SuperIme (#2872)

Author: matthew-carroll

super_editor/example/lib/main.dart

@@ -55,6 +55,7 @@ Future<void> main() async {
     // editorLayoutLog,
     // editorDocLog,
     // editorStyleLog,
+    // superImeLog,
     // textFieldLog,
     // editorUserTagsLog,
     // contentLayersLog,

super_editor/lib/src/default_editor/document_ime/shared_ime.dart

@@ -1,5 +1,6 @@
 import 'package:flutter/cupertino.dart';
 import 'package:flutter/services.dart';
+import 'package:super_editor/src/infrastructure/_logging.dart';
 
 /// A globally shared holder of an IME connection, so that the IME connection
 /// can be seamlessly transferred between the same `SuperEditor` or `SuperTextField`
@@ -68,6 +69,7 @@ class SuperIme with ChangeNotifier {
       _imeConnection = null;
     }
 
+    superImeLog.info("Opening IME connection (owner: '$ownerInputId')");
     _imeConnection ??= TextInput.attach(client, configuration);
     if (showKeyboard) {
       _imeConnection!.show();
@@ -83,6 +85,7 @@ class SuperIme with ChangeNotifier {
       return;
     }
 
+    superImeLog.info("Closing IME connection (owner: '$ownerInputId')");
     _imeConnection?.close();
     _imeConnection = null;
 
@@ -112,6 +115,7 @@ class SuperIme with ChangeNotifier {
       return;
     }
 
+    superImeLog.info("Giving IME ownership to new owner (owner: '$newOwnerInputId')");
     _owner = newOwnerInputId;
 
     notifyListeners();
@@ -133,7 +137,9 @@ class SuperIme with ChangeNotifier {
       return;
     }
 
+    superImeLog.info("Releasing IME ownership (owner: '$ownerInputId')");
     if (clearConnectionOnRelease) {
+      superImeLog.info("Closing connection when releasing IME ownership (owner: '$ownerInputId')");
       clearConnection(ownerInputId);
     }
     _owner = null;

super_editor/lib/src/infrastructure/_logging.dart

@@ -44,6 +44,7 @@ class LogNames {
   static const androidTextField = 'textfield.android';
   static const iosTextField = 'textfield.ios';
 
+  static const superIme = 'superime';
   static const infrastructure = 'infrastructure';
   static const keyboardPanel = 'infrastructure.keyboardPanel';
   static const longPressSelection = 'infrastructure.gestures.longPress';
@@ -91,13 +92,16 @@ final readerStyleLog = logging.Logger(LogNames.readerStyle);
 final readerDocLog = logging.Logger(LogNames.readerDocument);
 final readerOpsLog = logging.Logger(LogNames.readerCommonOps);
 
+// Text Fields.
 final textFieldLog = logging.Logger(LogNames.textField);
 final scrollingTextFieldLog = logging.Logger(LogNames.scrollingTextField);
 final imeTextFieldLog = logging.Logger(LogNames.imeTextField);
 final androidTextFieldLog = logging.Logger(LogNames.androidTextField);
 final iosTextFieldLog = logging.Logger(LogNames.iosTextField);
 
+// Infrastructure.
 final docGesturesLog = logging.Logger(LogNames.documentGestures);
+final superImeLog = logging.Logger(LogNames.superIme);
 final infrastructureLog = logging.Logger(LogNames.infrastructure);
 final keyboardPanelLog = logging.Logger(LogNames.keyboardPanel);
 final longPressSelectionLog = logging.Logger(LogNames.longPressSelection);