Change SpellCheckProvider into a RenderFrameObserver

chrome/renderer/chrome_content_renderer_client.cc

 // Copyright (c) 2012 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.
 
 #include "chrome/renderer/chrome_content_renderer_client.h"
 
 #include <memory>
 #include <utility>
 
 #include "base/bind.h"
@@ skipping 73 matching lines @@
 #include "components/task_scheduler_util/renderer/initialization.h"
 #include "components/version_info/version_info.h"
 #include "components/visitedlink/renderer/visitedlink_slave.h"
 #include "components/web_cache/renderer/web_cache_impl.h"
 #include "content/public/common/content_constants.h"
 #include "content/public/common/content_switches.h"
 #include "content/public/common/service_names.mojom.h"
 #include "content/public/common/url_constants.h"
 #include "content/public/renderer/plugin_instance_throttler.h"
 #include "content/public/renderer/render_frame.h"
+#include "content/public/renderer/render_frame_visitor.h"
 #include "content/public/renderer/render_thread.h"
 #include "content/public/renderer/render_view.h"
-#include "content/public/renderer/render_view_visitor.h"
 #include "extensions/common/constants.h"
 #include "extensions/features/features.h"
 #include "ipc/ipc_sync_channel.h"
 #include "media/media_features.h"
 #include "net/base/net_errors.h"
 #include "ppapi/c/private/ppb_pdf.h"
 #include "ppapi/features/features.h"
 #include "ppapi/shared_impl/ppapi_switches.h"
 #include "printing/features/features.h"
 #include "services/service_manager/public/cpp/connector.h"
@@ skipping 140 matching lines @@
     names[existing_size + i] = WebString::FromUTF16(additional_names[i]);
     values[existing_size + i] = WebString::FromUTF16(additional_values[i]);
   }
 
   existing_names->Swap(names);
   existing_values->Swap(values);
 }
 #endif  // BUILDFLAG(ENABLE_PLUGINS)
 
 #if BUILDFLAG(ENABLE_SPELLCHECK)
-class SpellCheckReplacer : public content::RenderViewVisitor {
+class SpellCheckReplacer : public content::RenderFrameVisitor {
  public:
   explicit SpellCheckReplacer(SpellCheck* spellcheck)
       : spellcheck_(spellcheck) {}
-  bool Visit(content::RenderView* render_view) override;
+  bool Visit(content::RenderFrame* render_frame) override;

[Lei Zhang, 2017/04/12 00:34:28]

BTW, can you add a dtor and remember to use override keyword?

[Xiaocheng, 2017/04/12 00:54:13]

Done.

 
  private:
   SpellCheck* spellcheck_;  // New shared spellcheck for all views. Weak Ptr.

[Lei Zhang, 2017/04/12 00:34:28]

SpellCheck* const, since it never changes.

[Xiaocheng, 2017/04/12 00:54:13]

Done.

   DISALLOW_COPY_AND_ASSIGN(SpellCheckReplacer);
 };
 
-bool SpellCheckReplacer::Visit(content::RenderView* render_view) {
-  SpellCheckProvider* provider = SpellCheckProvider::Get(render_view);
+bool SpellCheckReplacer::Visit(content::RenderFrame* render_frame) {
+  SpellCheckProvider* provider = SpellCheckProvider::Get(render_frame);
   DCHECK(provider);
   provider->set_spellcheck(spellcheck_);
   return true;
 }
 #endif
 
 #if BUILDFLAG(ENABLE_EXTENSIONS)
 bool IsStandaloneExtensionProcess() {
   return base::CommandLine::ForCurrentProcess()->HasSwitch(
       extensions::switches::kExtensionProcess);
@@ skipping 288 matching lines @@
     new subresource_filter::SubresourceFilterAgent(
         render_frame, subresource_filter_ruleset_dealer_.get());
   }
 
   if (command_line->HasSwitch(switches::kInstantProcess) &&
       render_frame->IsMainFrame()) {
     new SearchBox(render_frame);
   }
 
 #if BUILDFLAG(ENABLE_SPELLCHECK)
-  // TODO(xiaochengh): Use a different SpellCheckProvider for each RenderFrame.
-  if (SpellCheckProvider* provider =
-          SpellCheckProvider::Get(render_frame->GetRenderView())) {
-    render_frame->GetWebFrame()->SetTextCheckClient(provider);
-  }
+  new SpellCheckProvider(render_frame, spellcheck_.get());
 #endif
 }
 
 void ChromeContentRendererClient::RenderViewCreated(
     content::RenderView* render_view) {
 #if BUILDFLAG(ENABLE_EXTENSIONS)
   ChromeExtensionsRendererClient::GetInstance()->RenderViewCreated(render_view);
 #endif
 #if BUILDFLAG(ENABLE_SPELLCHECK)
-  SpellCheckProvider* provider =
-      new SpellCheckProvider(render_view, spellcheck_.get());
-  // For a main frame of a view, RenderFrameCreated is called earlier than
-  // RenderViewCreated. This workaround ensures that WebTextCheckClient is
-  // still set for any main frame.
-  // TODO(xiaochengh): Remove this workaround once SpellCheckProvider becomes
-  // a RenderFrameObserver.
-  if (content::RenderFrame* main_frame = render_view->GetMainRenderFrame())
-    main_frame->GetWebFrame()->SetTextCheckClient(provider);
-
+  // This is a workaround keeping the behavior that, the Blink side spellcheck
+  // enabled state is initialized on RenderView creation.
+  // TODO(xiaochengh): Design better way to sync between Chrome-side and
+  // Blink-side spellcheck enabled states.  See crbug.com/710097.
+  if (SpellCheckProvider* provider =
+          SpellCheckProvider::Get(render_view->GetMainRenderFrame()))
+    provider->EnableSpellcheck(spellcheck_->IsSpellcheckEnabled());
   new SpellCheckPanel(render_view);
 #endif
   new prerender::PrerendererClient(render_view);
 
   new ChromeRenderViewObserver(render_view, web_cache_impl_.get());
 
   new password_manager::CredentialManagerClient(render_view);
 }
 
 
@@ skipping 621 matching lines @@
   return true;
 }
 
 #if BUILDFLAG(ENABLE_SPELLCHECK)
 void ChromeContentRendererClient::SetSpellcheck(SpellCheck* spellcheck) {
   RenderThread* thread = RenderThread::Get();
   if (spellcheck_.get() && thread)
     thread->RemoveObserver(spellcheck_.get());
   spellcheck_.reset(spellcheck);
   SpellCheckReplacer replacer(spellcheck_.get());
-  content::RenderView::ForEach(&replacer);
+  content::RenderFrame::ForEach(&replacer);
   if (thread)
     thread->AddObserver(spellcheck_.get());
 }
 #endif
 
 bool ChromeContentRendererClient::IsExternalPepperPlugin(
     const std::string& module_name) {
   // TODO(bbudge) remove this when the trusted NaCl plugin has been removed.
   // We must defer certain plugin events for NaCl instances since we switch
   // from the in-process to the out-of-process proxy after instantiating them.
@@ skipping 294 matching lines @@
 
   RecordYouTubeRewriteUMA(result);
   return corrected_url.ReplaceComponents(r);
 }
 
 std::unique_ptr<base::TaskScheduler::InitParams>
 ChromeContentRendererClient::GetTaskSchedulerInitParams() {
   return task_scheduler_util::
       GetRendererTaskSchedulerInitParamsFromCommandLine();
 }