Add new method channel

shell/platform/android/BUILD.gn

@@ -236,6 +236,7 @@ android_java_sources = [
   "io/flutter/embedding/engine/systemchannels/PlatformViewsChannel.java",
   "io/flutter/embedding/engine/systemchannels/RestorationChannel.java",
   "io/flutter/embedding/engine/systemchannels/SettingsChannel.java",
+  "io/flutter/embedding/engine/systemchannels/SpellCheckChannel.java",
   "io/flutter/embedding/engine/systemchannels/SystemChannel.java",
   "io/flutter/embedding/engine/systemchannels/TextInputChannel.java",
   "io/flutter/plugin/common/ActivityLifecycleListener.java",
@@ -260,6 +261,7 @@ android_java_sources = [
   "io/flutter/plugin/editing/ImeSyncDeferringInsetsCallback.java",
   "io/flutter/plugin/editing/InputConnectionAdaptor.java",
   "io/flutter/plugin/editing/ListenableEditingState.java",
+  "io/flutter/plugin/editing/SpellCheckPlugin.java",
   "io/flutter/plugin/editing/TextEditingDelta.java",
   "io/flutter/plugin/editing/TextInputPlugin.java",
   "io/flutter/plugin/localization/LocalizationPlugin.java",

shell/platform/android/io/flutter/embedding/android/FlutterView.java

@@ -57,6 +57,7 @@
 import io.flutter.embedding.engine.renderer.FlutterUiDisplayListener;
 import io.flutter.embedding.engine.renderer.RenderSurface;
 import io.flutter.embedding.engine.systemchannels.SettingsChannel;
+import io.flutter.plugin.editing.SpellCheckPlugin;
 import io.flutter.plugin.editing.TextInputPlugin;
 import io.flutter.plugin.localization.LocalizationPlugin;
 import io.flutter.plugin.mouse.MouseCursorPlugin;
@@ -124,6 +125,7 @@ public class FlutterView extends FrameLayout implements MouseCursorPlugin.MouseC
   // existing, stateless system channels, e.g., KeyEventChannel, TextInputChannel, etc.
   @Nullable private MouseCursorPlugin mouseCursorPlugin;
   @Nullable private TextInputPlugin textInputPlugin;
+  @Nullable private SpellCheckPlugin spellCheckPlugin;
   @Nullable private LocalizationPlugin localizationPlugin;
   @Nullable private KeyboardManager keyboardManager;
   @Nullable private AndroidTouchProcessor androidTouchProcessor;
@@ -1120,6 +1122,7 @@ public void attachToFlutterEngine(@NonNull FlutterEngine flutterEngine) {
             this,
             this.flutterEngine.getTextInputChannel(),
             this.flutterEngine.getPlatformViewsController());
+    spellCheckPlugin = new SpellCheckPlugin(this, this.flutterEngine.getSpellCheckChannel());
     localizationPlugin = this.flutterEngine.getLocalizationPlugin();
 
     keyboardManager =

shell/platform/android/io/flutter/embedding/engine/FlutterEngine.java

@@ -33,6 +33,7 @@
 import io.flutter.embedding.engine.systemchannels.PlatformChannel;
 import io.flutter.embedding.engine.systemchannels.RestorationChannel;
 import io.flutter.embedding.engine.systemchannels.SettingsChannel;
+import io.flutter.embedding.engine.systemchannels.SpellCheckChannel;
 import io.flutter.embedding.engine.systemchannels.SystemChannel;
 import io.flutter.embedding.engine.systemchannels.TextInputChannel;
 import io.flutter.plugin.localization.LocalizationPlugin;
@@ -95,6 +96,7 @@ public class FlutterEngine {
   @NonNull private final RestorationChannel restorationChannel;
   @NonNull private final PlatformChannel platformChannel;
   @NonNull private final SettingsChannel settingsChannel;
+  @NonNull private final SpellCheckChannel spellCheckChannel;
   @NonNull private final SystemChannel systemChannel;
   @NonNull private final TextInputChannel textInputChannel;
 
@@ -309,6 +311,7 @@ public FlutterEngine(
     platformChannel = new PlatformChannel(dartExecutor);
     restorationChannel = new RestorationChannel(dartExecutor, waitForRestorationData);
     settingsChannel = new SettingsChannel(dartExecutor);
+    spellCheckChannel = new SpellCheckChannel(dartExecutor);
     systemChannel = new SystemChannel(dartExecutor);
     textInputChannel = new TextInputChannel(dartExecutor);
 
@@ -559,6 +562,12 @@ public TextInputChannel getTextInputChannel() {
     return textInputChannel;
   }
 
+  /** System channel that sends and receives requests related to spell check. */
+  @NonNull
+  public SpellCheckChannel getSpellCheckChannel() {
+    return spellCheckChannel;
+  }
+
   /**
    * Plugin registry, which registers plugins that want to be applied to this {@code FlutterEngine}.
    */

shell/platform/android/io/flutter/embedding/engine/systemchannels/SpellCheckChannel.java

@@ -0,0 +1,84 @@
+package io.flutter.embedding.engine.systemchannels;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import androidx.annotation.VisibleForTesting;
+import io.flutter.Log;
+import io.flutter.embedding.engine.dart.DartExecutor;
+import io.flutter.plugin.common.JSONMethodCodec;
+import io.flutter.plugin.common.MethodCall;
+import io.flutter.plugin.common.MethodChannel;
+import java.util.ArrayList;
+import java.util.Arrays;
+import org.json.JSONArray;
+import org.json.JSONException;
+
+public class SpellCheckChannel {
+  private static final String TAG = "SpellCheckChannel";
+
+  @NonNull public final MethodChannel channel;
+  @Nullable private SpellCheckMethodHandler spellCheckMethodHandler;
+
+  @NonNull @VisibleForTesting
+  final MethodChannel.MethodCallHandler parsingMethodHandler =
+      new MethodChannel.MethodCallHandler() {
+        @Override
+        public void onMethodCall(@NonNull MethodCall call, @NonNull MethodChannel.Result result) {
+          if (spellCheckMethodHandler == null) {
+            // If no explicit SpellCheckMethodHandler has been registered then we don't
+            // need to forward this call to an API. Return.
+            return;
+          }
+          String method = call.method;
+          Object args = call.arguments;
+          Log.v(TAG, "Received '" + method + "' message.");
+          switch (method) {
+            case "SpellCheck.initiateSpellChecking":
+              System.out.println("-----------FETCH RECEIVED IN ENGINE------------------");
+              try {
+                final JSONArray argumentList = (JSONArray) args;
+                String locale = argumentList.getString(0);
+                String text = argumentList.getString(1);
+                spellCheckMethodHandler.initiateSpellChecking(locale, text);
+                result.success(null);
+              } catch (JSONException exception) {
+                result.error("error", exception.getMessage(), null);
+              }
+              break;
+            default:
+              System.out.println(
+                  "-----------WRONG METHOD BEING CALLED IN ENGINE------------------");
+              result.notImplemented();
+              break;
+          }
+        }
+      };
+
+  public SpellCheckChannel(@NonNull DartExecutor dartExecutor) {
+    // TODO(camillesimon): Use JSON?
+    this.channel = new MethodChannel(dartExecutor, "flutter/spellcheck", JSONMethodCodec.INSTANCE);
+    channel.setMethodCallHandler(parsingMethodHandler);
+  }
+
+  /** Responsible for sending spell checker results across to the framework. */
+  public void updateSpellCheckerResults(
+      ArrayList<String> spellCheckerResults, String spellCheckedText) {
+    channel.invokeMethod(
+        "TextInputClient.updateSpellCheckerResults",
+        Arrays.asList(spellCheckerResults, spellCheckedText));
+  }
+
+  public void setSpellCheckMethodHandler(
+      @Nullable SpellCheckMethodHandler spellCheckMethodHandler) {
+    System.out.println("-------------------SPELL CHECK HANDLER SET-------------------");
+    this.spellCheckMethodHandler = spellCheckMethodHandler;
+  }
+
+  public interface SpellCheckMethodHandler {
+    /**
+     * Requests that spell checking is initiated for the inputted text recognized by the framework,
+     * which will automatically result in spell checking resutls being sent back to the framework.
+     */
+    void initiateSpellChecking(String locale, String text);
+  }
+}

shell/platform/android/io/flutter/embedding/engine/systemchannels/TextInputChannel.java

@@ -13,6 +13,8 @@
 import io.flutter.plugin.common.MethodCall;
 import io.flutter.plugin.common.MethodChannel;
 import io.flutter.plugin.editing.TextEditingDelta;
+//TODO(camillesimon): Remove, using for testing:
+import io.flutter.plugin.editing.SpellCheckPlugin;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashMap;
@@ -44,6 +46,9 @@ public class TextInputChannel {
   @NonNull public final MethodChannel channel;
   @Nullable private TextInputMethodHandler textInputMethodHandler;
 
+  //TODO(camillesimon): Remove, using for testing:
+  @Nullable private SpellCheckMethodHandler spellCheckMethodHandler;
+
   @NonNull @VisibleForTesting
   final MethodChannel.MethodCallHandler parsingMethodHandler =
       new MethodChannel.MethodCallHandler() {
@@ -150,7 +155,8 @@ public void onMethodCall(@NonNull MethodCall call, @NonNull MethodChannel.Result
                 final JSONArray argumentList = (JSONArray) args;
                 String locale = argumentList.getString(0);
                 String text = argumentList.getString(1);
-                textInputMethodHandler.initiateSpellChecking(locale, text);
+                //TODO(camillesimon): Remove, use for testing
+                spellCheckMethodHandler.initiateSpellChecking(locale, text);
                 result.success(null);
               } catch (JSONException exception) {
                 result.error("error", exception.getMessage(), null);
@@ -372,7 +378,7 @@ public void updateSpellCheckerResults(
       int inputClientId, ArrayList<String> spellCheckerResults, String spellCheckedText) {
     channel.invokeMethod(
         "TextInputClient.updateSpellCheckerResults",
-        Arrays.asList(inputClientId, spellCheckerResults, spellCheckedText));
+        Arrays.asList(0, spellCheckerResults, spellCheckedText));
   }
 
   /**
@@ -383,6 +389,19 @@ public void setTextInputMethodHandler(@Nullable TextInputMethodHandler textInput
     this.textInputMethodHandler = textInputMethodHandler;
   }
 
+  //TODO(camillesimon): Remove, using for testing
+  public void setSpellCheckMethodHandler(@Nullable SpellCheckMethodHandler spellCheckMethodHandler) {
+    this.spellCheckMethodHandler = spellCheckMethodHandler;
+  }
+
+  public interface SpellCheckMethodHandler {
+    /**
+     * Requests that spell checking is initiated for the inputted text recognized by the framework,
+     * which will automatically result in spell checking resutls being sent back to the framework.
+     */
+    void initiateSpellChecking(String locale, String text);
+  }
+
   public interface TextInputMethodHandler {
     // TODO(mattcarroll): javadoc
     void show();

shell/platform/android/io/flutter/plugin/editing/SpellCheckPlugin.java

@@ -0,0 +1,121 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package io.flutter.plugin.editing;
+
+import android.content.Context;
+import android.view.View;
+import android.view.textservice.SentenceSuggestionsInfo;
+import android.view.textservice.SpellCheckerInfo;
+import android.view.textservice.SpellCheckerSession;
+import android.view.textservice.SuggestionsInfo;
+import android.view.textservice.TextInfo;
+import android.view.textservice.TextServicesManager;
+import androidx.annotation.NonNull;
+import io.flutter.embedding.engine.systemchannels.SpellCheckChannel;
+import java.util.ArrayList;
+import java.util.Locale;
+
+public class SpellCheckPlugin implements SpellCheckerSession.SpellCheckerSessionListener {
+
+  @NonNull private final View mView;
+  @NonNull private final SpellCheckChannel mSpellCheckChannel;
+  @NonNull private final TextServicesManager tsm;
+  private SpellCheckerSession mSpellCheckerSession;
+
+  // String of spell checked text for testing
+  private String currentSpellCheckedText;
+
+  public SpellCheckPlugin(@NonNull View view, @NonNull SpellCheckChannel spellCheckChannel) {
+    System.out.println("----------------SpellCheckPlugin INITIATED-------------");
+    mView = view;
+    mSpellCheckChannel = spellCheckChannel;
+    tsm =
+        (TextServicesManager)
+            view.getContext().getSystemService(Context.TEXT_SERVICES_MANAGER_SERVICE);
+
+    mSpellCheckChannel.setSpellCheckMethodHandler(
+        new SpellCheckChannel.SpellCheckMethodHandler() {
+          @Override
+          public void initiateSpellChecking(String locale, String text) {
+            currentSpellCheckedText = text;
+            performSpellCheck(locale, text);
+          }
+        });
+  }
+
+  // Responsible for calling the Android spell checker API to retrieve spell
+  // checking results.
+  public void performSpellCheck(String locale, String text) {
+    String[] localeCodes = locale.split("-");
+    Locale localeToUse;
+
+    if (localeCodes.length == 3) {
+      localeToUse = new Locale(localeCodes[0], localeCodes[1], localeCodes[2]);
+    } else if (localeCodes.length == 2) {
+      localeToUse = new Locale(localeCodes[0], localeCodes[1]);
+    } else {
+      localeToUse = new Locale(localeCodes[0]);
+    }
+
+    // Open a new spell checker session when a new text input client is set.
+    // Closes spell checker session if one previously in use.
+    // TODO(camillesimon): Figure out proper session management.
+    if (mSpellCheckerSession != null) {
+      mSpellCheckerSession.close();
+      mSpellCheckerSession = tsm.newSpellCheckerSession(null, Locale.ENGLISH, this, true);
+    } else {
+      mSpellCheckerSession = tsm.newSpellCheckerSession(null, Locale.ENGLISH, this, true);
+    }
+    SpellCheckerInfo infoChecker = mSpellCheckerSession.getSpellChecker();
+
+    // Define TextInfo[] object (textInfos) based on the current input to be
+    // spell checked.
+    TextInfo[] textInfos = new TextInfo[] {new TextInfo(text)};
+
+    // Make API call. Maximum suggestions requested set to 3 for now.
+    System.out.println("----------------SpellCheckPlugin FETCH INITIATED-------------");
+    mSpellCheckerSession.getSentenceSuggestions(textInfos, 3);
+  }
+
+  // Responsible for decomposing spell checker results into an object that can
+  // then be sent to the framework.
+  @Override
+  public void onGetSentenceSuggestions(SentenceSuggestionsInfo[] results) {
+    ArrayList<String> spellCheckerSuggestionSpans = new ArrayList<String>();
+
+    for (int i = 0; i < results[0].getSuggestionsCount(); i++) {
+      SuggestionsInfo suggestionsInfo = results[0].getSuggestionsInfoAt(i);
+      int suggestionsCount = suggestionsInfo.getSuggestionsCount();
+
+      if (suggestionsCount > 0) {
+        String spellCheckerSuggestionSpan = "";
+        int start = results[0].getOffsetAt(i);
+        int length = results[0].getLengthAt(i);
+
+        spellCheckerSuggestionSpan += (String.valueOf(start) + ".");
+        spellCheckerSuggestionSpan += (String.valueOf(start + (length - 1)) + ".");
+
+        for (int j = 0; j < suggestionsCount; j++) {
+          String key = "suggestion_" + String.valueOf(j);
+          spellCheckerSuggestionSpan += (suggestionsInfo.getSuggestionAt(j) + ",");
+        }
+
+        spellCheckerSuggestionSpans.add(
+            spellCheckerSuggestionSpan.substring(0, spellCheckerSuggestionSpan.length() - 1));
+      }
+    }
+
+    // Make call to update the spell checker results in the framework.
+    // Current text being passed for testing purposes.
+    // TODO(camillesimon): Don't pass text back to framework.
+    mSpellCheckChannel.updateSpellCheckerResults(
+        spellCheckerSuggestionSpans, currentSpellCheckedText);
+  }
+
+  @Override
+  public void onGetSuggestions(SuggestionsInfo[] results) {
+    // Callback for a deprecated method, so will not use.
+  }
+}

shell/platform/android/io/flutter/plugin/platform/PlatformPlugin.java

@@ -370,6 +370,9 @@ private void setSystemChromeSystemUIOverlayStyle(
     WindowInsetsControllerCompat windowInsetsControllerCompat =
         new WindowInsetsControllerCompat(window, view);
 
+    window.addFlags(WindowManager.LayoutParams.FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS);
+    window.clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
+
     // SYSTEM STATUS BAR -------------------------------------------------------------------
     // You can't change the color of the system status bar until SDK 21, and you can't change the
     // color of the status icons until SDK 23. We only allow both starting at 23 to ensure buttons
@@ -433,8 +436,6 @@ private void setSystemChromeSystemUIOverlayStyle(
     }
     // You can't change the color of the navigation bar divider color until SDK 28.
     if (systemChromeStyle.systemNavigationBarDividerColor != null && Build.VERSION.SDK_INT >= 28) {
-      window.addFlags(WindowManager.LayoutParams.FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS);
-      window.clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
       window.setNavigationBarDividerColor(systemChromeStyle.systemNavigationBarDividerColor);
     }