Integrating Mac OS Grammar checker into Chromium.

chrome/renderer/render_view.h

 // Copyright (c) 2011 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.
 
 #ifndef CHROME_RENDERER_RENDER_VIEW_H_
 #define CHROME_RENDERER_RENDER_VIEW_H_
 #pragma once
 
 #include <deque>
 #include <map>
 #include <queue>
 #include <set>
 #include <string>
 #include <vector>
 
 #include "app/surface/transport_dib.h"
 #include "base/basictypes.h"
 #include "base/gtest_prod_util.h"
+#include "base/id_map.h"
 #include "base/linked_ptr.h"
 #include "base/observer_list.h"
 #include "base/timer.h"
 #include "base/weak_ptr.h"
 #include "build/build_config.h"
 #include "chrome/common/content_settings.h"
 #include "chrome/common/edit_command.h"
 #include "chrome/common/navigation_gesture.h"
 #include "chrome/common/page_zoom.h"
 #include "chrome/common/render_messages_params.h"
@@ skipping 103 matching lines @@
 class WebImage;
 class WebInputElement;
 class WebKeyboardEvent;
 class WebMediaPlayer;
 class WebMediaPlayerClient;
 class WebMouseEvent;
 class WebPlugin;
 class WebSpeechInputController;
 class WebSpeechInputListener;
 class WebStorageNamespace;
+class WebTextCheckingResult;
 class WebURLRequest;
 class WebView;
 struct WebContextMenuData;
 struct WebFileChooserParams;
 struct WebFindOptions;
 struct WebPluginParams;
 struct WebPoint;
 struct WebWindowFeatures;
 }
 
@@ skipping 259 matching lines @@
   virtual void didChangeLoadProgress(WebKit::WebFrame* frame,
                                      double load_progress);
   virtual bool isSmartInsertDeleteEnabled();
   virtual bool isSelectTrailingWhitespaceEnabled();
   virtual void didChangeSelection(bool is_selection_empty);
   virtual void didExecuteCommand(const WebKit::WebString& command_name);
   virtual bool handleCurrentKeyboardEvent();
   virtual void spellCheck(const WebKit::WebString& text,
                           int& offset,
                           int& length);
+  virtual void requestCheckingOfText(

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

I'd call this |-requestTextChecking|. It's more in line with the naming
elsewhere.

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

I cannot change the name
because this API overrides a WebKit-provided abstract class.
(The name comes from Cocoa thing.)

+      const WebKit::WebString& text,
+      WebKit::WebTextCheckingCompletion* completion);
   virtual WebKit::WebString autoCorrectWord(
       const WebKit::WebString& misspelled_word);
   virtual void showSpellingUI(bool show);
   virtual bool isShowingSpellingUI();
   virtual void updateSpellingUIWithMisspelledWord(
       const WebKit::WebString& word);
   virtual void continuousSpellCheckingEnabledStateChanged();
   virtual bool runFileChooser(
       const WebKit::WebFileChooserParams& params,
       WebKit::WebFileChooserCompletion* chooser_completion);
@@ skipping 249 matching lines @@
   FRIEND_TEST_ALL_PREFIXES(RenderViewTest, OnHandleKeyboardEvent);
   FRIEND_TEST_ALL_PREFIXES(RenderViewTest, InsertCharacters);
 #if defined(OS_MACOSX)
   FRIEND_TEST_ALL_PREFIXES(RenderViewTest, MacTestCmdUp);
 #endif
   FRIEND_TEST_ALL_PREFIXES(RenderViewTest, JSBlockSentAfterPageLoad);
   FRIEND_TEST_ALL_PREFIXES(RenderViewTest, UpdateTargetURLWithInvalidURL);
 
   typedef std::map<GURL, ContentSettings> HostContentSettings;
   typedef std::map<GURL, double> HostZoomLevels;
+  typedef IDMap<WebKit::WebTextCheckingCompletion> TextCheckCompletions;
 
   // Cannot use std::set unfortunately since linked_ptr<> does not support
   // operator<.
   typedef std::vector<linked_ptr<webkit_glue::ImageResourceFetcher> >
       ImageResourceFetcherList;
 
   // Identifies an accessibility notification from webkit.
   struct RendererAccessibilityNotification {
    public:
     bool ShouldIncludeChildren();
@@ skipping 221 matching lines @@
   void OnSetWindowVisibility(bool visible);
 #endif
   void OnSetZoomLevel(double zoom_level);
   void OnSetZoomLevelForLoadingURL(const GURL& url, double zoom_level);
   void OnShouldClose();
   void OnStop();
   void OnStopFinding(const ViewMsg_StopFinding_Params& params);
   void OnThemeChanged();
   void OnToggleSpellCheck();
   void OnToggleSpellPanel(bool is_currently_visible);
+  void OnRespondTextCheck(
+      int identifier,
+      int tag,
+      const std::vector<WebKit::WebTextCheckingResult>& results);
+
   void OnUndo();
   void OnUpdateBrowserWindowId(int window_id);
   void OnUpdateTargetURLAck();
   void OnUpdateWebPreferences(const WebPreferences& prefs);
 #if defined(OS_MACOSX)
   void OnWindowFrameChanged(const gfx::Rect& window_frame,
                             const gfx::Rect& view_frame);
   void OnSelectPopupMenuItem(int selected_index);
 #endif
   void OnZoom(PageZoom::Function function);
@@ skipping 500 matching lines @@
   // The node that the context menu was pressed over.
   WebKit::WebNode context_menu_node_;
 
   // Reports load progress to the browser.
   scoped_ptr<LoadProgressTracker> load_progress_tracker_;
 
   // All the registered observers.  We expect this list to be small, so vector
   // is fine.
   ObserverList<RenderViewObserver> observers_;
 
+  // Holds ongoing spellchecking operations, assigns IDs

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

dont wrap early. Put as much of the comment on this line as possible before
wrapping.

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

Done.

+  // for the IPC routing.
+  TextCheckCompletions text_check_completions_;
+
   // ---------------------------------------------------------------------------
   // ADDING NEW DATA? Please see if it fits appropriately in one of the above
   // sections rather than throwing it randomly at the end. If you're adding a
   // bunch of stuff, you should probably create a helper class and put your
   // data and methods on that to avoid bloating RenderView more.  You can use
   // the Observer interface to filter IPC messages and receive frame change
   // notifications.
   // ---------------------------------------------------------------------------
 
   DISALLOW_COPY_AND_ASSIGN(RenderView);
 };
 
 #endif  // CHROME_RENDERER_RENDER_VIEW_H_