Integrating Mac OS Grammar checker into Chromium.

chrome/browser/spellchecker_mac.mm

 // Copyright (c) 2006-2009 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // This file implements the interface defined in spellchecker_platform_engine.h
 // for the OS X platform.
 
 #include "chrome/browser/spellchecker_platform_engine.h"
 
 #import <Cocoa/Cocoa.h>
 
 #include "base/logging.h"
 #include "base/metrics/histogram.h"
+#include "base/task.h"
 #include "base/time.h"
 #include "base/sys_string_conversions.h"
+#include "chrome/browser/browser_thread.h"
+#include "chrome/browser/browser_message_filter.h"
+#include "chrome/common/render_messages.h"
 #include "chrome/common/spellcheck_common.h"
+#include "third_party/WebKit/Source/WebKit/chromium/public/WebTextCheckingResult.h"
 
 using base::TimeTicks;
 namespace {
 // The number of characters in the first part of the language code.
 const unsigned int kShortLanguageCodeSize = 2;
 
+class TextCheckingTask : public Task {

[Hironori Bono, 2011/02/10 11:02:56]

nit: I would be great if this class has a class comment.

[pink (ping after 24hrs), 2011/02/11 17:33:40]

100% agreed. not a nit at all.

[gmorrita, 2011/02/17 11:39:44]

Added an description.

+ public:
+  TextCheckingTask(BrowserMessageFilter* destination,
+                   int route_id,
+                   int identifier,
+                   const string16& text,
+                   int document_tag)
+      : destination_(destination_),
+        route_id_(route_id),
+        identifier_(identifier),
+        text_(text),
+        document_tag_(document_tag) {
+  }
+
+  virtual void Run() {
+    // TODO(morrita): Use [NSSpellChecker requestCheckingOfString]
+    // when the build target goes upto 10.6

[pink (ping after 24hrs), 2011/02/11 17:33:40]

s/upto/up to.

Can you do a respondsToSelector: check and use it for OS's that currently
support it? It's ok if it's not available in the sdk if you do a check before
use.

[gmorrita, 2011/02/17 11:39:44]

Fixed.
New API has much different style:
uses worker thread and returns the result asynchronously. 
I'd like to keep current API to avoid maintaining different versions of code.

+    std::vector<WebKit::WebTextCheckingResult> check_results;
+    NSString* text_to_check = base::SysUTF16ToNSString(text_);
+    size_t starting_at = 0;
+    while (starting_at < text_.size()) {
+      NSRange range = [[NSSpellChecker sharedSpellChecker]
+                       checkSpellingOfString:text_to_check
+                       startingAt:starting_at

[pink (ping after 24hrs), 2011/02/11 17:33:40]

line up colons

[gmorrita, 2011/02/17 11:39:44]

Done.

+                       language:nil wrap:NO
+                       inSpellDocumentWithTag:document_tag_
+                       wordCount:NULL];
+      if (0 == range.length)

[pink (ping after 24hrs), 2011/02/11 17:33:40]

if (range.length == 0). The constant before is much less readable, and we have
warnings enabled to catch inadvertent assignment in expressions.

[gmorrita, 2011/02/17 11:39:44]

Done.

+        break;
+      check_results.push_back(WebKit::WebTextCheckingResult(
+          WebKit::WebTextCheckingResult::ErrorSpelling,
+          range.location,
+          range.length));
+      starting_at = range.location + range.length;
+    }
+
+    BrowserThread::PostTask(
+        BrowserThread::UI, FROM_HERE, NewRunnableMethod(
+            destination_, &BrowserMessageFilter::Send,
+            new ViewMsg_SpellChecker_RespondTextCheck(route_id_,
+                                                      identifier_,
+                                                      document_tag_,
+                                                      check_results)));
+  }
+
+ private:
+  BrowserMessageFilter* destination_;

[pink (ping after 24hrs), 2011/02/11 17:33:40]

comment this is a weak pointer.

[gmorrita, 2011/02/17 11:39:44]

Noticed we have to own it to avoiding the dangling pointer.
So changed to use scoped_refptr.

+  int route_id_;
+  int identifier_;
+  string16 text_;
+  int document_tag_;
+};
+
 // A private utility function to convert hunspell language codes to os x
 // language codes.
 NSString* ConvertLanguageCodeToMac(const std::string& hunspell_lang_code) {
   NSString* whole_code = base::SysUTF8ToNSString(hunspell_lang_code);
 
   if ([whole_code length] > kShortLanguageCodeSize) {
     NSString* lang_code = [whole_code
                            substringToIndex:kShortLanguageCodeSize];
     // Add 1 here to skip the underscore.
     NSString* region_code = [whole_code
@@ skipping 168 matching lines @@
   return static_cast<int>(doc_tag);
 }
 
 void IgnoreWord(const string16& word) {
   [[NSSpellChecker sharedSpellChecker] ignoreWord:base::SysUTF16ToNSString(word)
                            inSpellDocumentWithTag:last_seen_tag_];
 }
 
 void CloseDocumentWithTag(int tag) {
   [[NSSpellChecker sharedSpellChecker]
-      closeSpellDocumentWithTag:static_cast<NSInteger>(tag)];
+    closeSpellDocumentWithTag:static_cast<NSInteger>(tag)];
+}
+
+void RequestTextCheck(int route_id,
+                      int identifier,
+                      int document_tag,
+                      const string16& text, BrowserMessageFilter* destination) {
+  BrowserThread::PostTask(
+      BrowserThread::IO, FROM_HERE,
+      new TextCheckingTask(
+          destination, route_id, identifier, text, document_tag));
 }
 
 }  // namespace SpellCheckerPlatform