Cherry Pick: [Spellcheck] Expose macOS spellcheck API's in dart (Resolves #2189) (#2231)

Author: github-actions[bot]

super_editor_spellcheck/example/integration_test/plugin_integration_test.dart

@@ -1,7 +1,9 @@
+import 'dart:math';
+import 'dart:ui';
+
 import 'package:flutter/material.dart';
 import 'dart:async';
 
-import 'package:flutter/services.dart';
 import 'package:super_editor_spellcheck/super_editor_spellcheck.dart';
 
 void main() {
@@ -16,48 +18,214 @@ class MyApp extends StatefulWidget {
 }
 
 class _MyAppState extends State<MyApp> {
-  String _platformVersion = 'Unknown';
-  final _superEditorSpellcheckPlugin = SuperEditorSpellcheck();
+  final _superEditorSpellcheckPlugin = SuperEditorSpellCheckerPlugin();
+  final _textController = TextEditingController(text: 'She go to the store everys day.');
+
+  List<TextSuggestion> _suggestions = [];
+
+  TextRange _firstMispelledWord = TextRange.empty;
+  List<String> _firstMispelledWordSuggestions = [];
+  CheckGrammarResult? _grammarAnalysis;
+  int? _wordCount;
+  int? _documentTag;
+  Map<String, String> _userReplacementsDictionary = <String, String>{};
+  List<String> _completionsForLastWord = [];
+  Timer? _searchTimer;
 
   @override
   void initState() {
     super.initState();
-    initPlatformState();
+
+    _textController.addListener(_onTextChanged);
+    _fetchSuggestions();
   }
 
-  // Platform messages are asynchronous, so we initialize in an async method.
-  Future<void> initPlatformState() async {
-    String platformVersion;
-    // Platform messages may fail, so we use a try/catch PlatformException.
-    // We also handle the message potentially returning null.
-    try {
-      platformVersion =
-          await _superEditorSpellcheckPlugin.getPlatformVersion() ?? 'Unknown platform version';
-    } on PlatformException {
-      platformVersion = 'Failed to get platform version.';
+  @override
+  void dispose() {
+    _textController.removeListener(_onTextChanged);
+    _textController.dispose();
+    if (_documentTag != null) {
+      _superEditorSpellcheckPlugin.macSpellChecker.closeSpellDocumentWithTag(_documentTag!);
     }
+    super.dispose();
+  }
+
+  void _onTextChanged() {
+    _searchTimer?.cancel();
+    _searchTimer = Timer(
+      const Duration(milliseconds: 300),
+      _fetchSuggestions,
+    );
+  }
+
+  Future<void> _fetchSuggestions() async {
+    final textToSearch = _textController.text;
+    final locale = PlatformDispatcher.instance.locale;
+
+    int? tag = _documentTag;
+    tag ??= await _superEditorSpellcheckPlugin.macSpellChecker.uniqueSpellDocumentTag();
 
-    // If the widget was removed from the tree while the asynchronous platform
-    // message was in flight, we want to discard the reply rather than calling
-    // setState to update our non-existent appearance.
-    if (!mounted) return;
+    final language = _superEditorSpellcheckPlugin.macSpellChecker.convertDartLocaleToMacLanguageCode(locale)!;
+
+    final suggestions = await _superEditorSpellcheckPlugin.fetchSuggestions(
+      locale,
+      textToSearch,
+    );
+
+    if (_shouldAbortCurrentSearch(textToSearch)) {
+      return;
+    }
+
+    final firstMisspelled = await _superEditorSpellcheckPlugin.macSpellChecker.checkSpelling(
+      stringToCheck: textToSearch,
+      startingOffset: 0,
+      language: language,
+    );
+
+    if (_shouldAbortCurrentSearch(textToSearch)) {
+      return;
+    }
+
+    final firstSuggestions = firstMisspelled.isValid
+        ? await _superEditorSpellcheckPlugin.macSpellChecker.guesses(
+            range: firstMisspelled,
+            text: textToSearch,
+            language: language,
+          )
+        : <String>[];
+
+    if (_shouldAbortCurrentSearch(textToSearch)) {
+      return;
+    }
+
+    final grammarAnalysis = await _superEditorSpellcheckPlugin.macSpellChecker.checkGrammar(
+      stringToCheck: textToSearch,
+      startingOffset: 0,
+      language: language,
+    );
+
+    if (_shouldAbortCurrentSearch(textToSearch)) {
+      return;
+    }
+
+    final wordCount = await _superEditorSpellcheckPlugin.macSpellChecker.countWords(
+      text: textToSearch,
+      language: language,
+    );
+
+    if (_shouldAbortCurrentSearch(textToSearch)) {
+      return;
+    }
+
+    final replacements = await _superEditorSpellcheckPlugin.macSpellChecker.userReplacementsDictionary();
+
+    if (_shouldAbortCurrentSearch(textToSearch)) {
+      return;
+    }
+
+    final completionOffset = max(textToSearch.lastIndexOf(' '), 0);
+
+    final completions = await _superEditorSpellcheckPlugin.macSpellChecker.completions(
+      partialWordRange: TextRange(start: completionOffset, end: textToSearch.length),
+      text: textToSearch,
+      language: language,
+    );
+
+    if (_shouldAbortCurrentSearch(textToSearch)) {
+      return;
+    }
 
     setState(() {
-      _platformVersion = platformVersion;
+      _documentTag = tag;
+      _suggestions = suggestions;
+      _firstMispelledWord = firstMisspelled;
+      _firstMispelledWordSuggestions = firstSuggestions;
+      _grammarAnalysis = grammarAnalysis;
+      _wordCount = wordCount;
+      _userReplacementsDictionary = replacements;
+      _completionsForLastWord = completions;
     });
   }
 
+  bool _shouldAbortCurrentSearch(String textToSearch) {
+    if (!mounted) {
+      return true;
+    }
+
+    if (textToSearch != _textController.text) {
+      // The user changed the text while the search was happening. Ignore the results,
+      // because a new search will happen.
+      return true;
+    }
+
+    return false;
+  }
+
   @override
   Widget build(BuildContext context) {
     return MaterialApp(
       home: Scaffold(
         appBar: AppBar(
           title: const Text('Plugin example app'),
         ),
-        body: Center(
-          child: Text('Running on: $_platformVersion\n'),
+        body: Padding(
+          padding: const EdgeInsets.all(8.0),
+          child: Column(
+            children: [
+              TextField(
+                controller: _textController,
+              ),
+              if (_documentTag != null) //
+                Text('Document tag: $_documentTag'),
+              if (_wordCount != null) //
+                Text('Word count: $_wordCount'),
+              if (_firstMispelledWord.isValid)
+                Text('First misspelled word: ${_textController.text.substring(
+                  _firstMispelledWord.start,
+                  _firstMispelledWord.end,
+                )}'),
+              if (_firstMispelledWordSuggestions.isNotEmpty)
+                Text('Suggestions for first misspelled word: ${_firstMispelledWordSuggestions.join(', ')}'),
+              const SizedBox(height: 10),
+              _suggestions.isEmpty
+                  ? const Text('No spelling errors found.')
+                  : Column(
+                      crossAxisAlignment: CrossAxisAlignment.start,
+                      children: _suggestions.map(_buildSuggestions).toList(),
+                    ),
+              if (_grammarAnalysis != null)
+                Column(
+                  crossAxisAlignment: CrossAxisAlignment.start,
+                  children: _grammarAnalysis!.details.map(_buildGrammarAnalysis).toList(),
+                ),
+              Column(
+                crossAxisAlignment: CrossAxisAlignment.start,
+                children: _userReplacementsDictionary.entries.map(_buildReplacement).toList(),
+              ),
+              if (_completionsForLastWord.isNotEmpty)
+                Text('Completions for last word: ${_completionsForLastWord.join(', ')}'),
+            ],
+          ),
         ),
       ),
     );
   }
+
+  Widget _buildSuggestions(TextSuggestion span) {
+    return Text(
+      '${_textController.text.substring(span.range.start, span.range.end)}: ${span.suggestions.join(', ')}',
+    );
+  }
+
+  Widget _buildGrammarAnalysis(GrammaticalAnalysisDetail? detail) {
+    return Text(
+      '${_textController.text.substring(detail!.range.start, detail.range.end)}: ${detail.userDescription}',
+    );
+  }
+
+  Widget _buildReplacement(MapEntry<String, String> entry) {
+    return Text(
+      'Replace ${entry.key} with ${entry.value}',
+    );
+  }
 }

super_editor_spellcheck/example/lib/main.dart

@@ -6,4 +6,8 @@ class AppDelegate: FlutterAppDelegate {
   override func applicationShouldTerminateAfterLastWindowClosed(_ sender: NSApplication) -> Bool {
     return true
   }
+
+  override func applicationSupportsSecureRestorableState(_ app: NSApplication) -> Bool {
+    return true
+  }
 }