Adding a word to dictionary should remove spelling markers (Chrome part)

chrome/renderer/spellchecker/spellcheck.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/spellchecker/spellcheck.h"
 
 #include "base/bind.h"
 #include "base/message_loop/message_loop_proxy.h"
 #include "base/strings/utf_string_conversions.h"
 #include "chrome/common/render_messages.h"
 #include "chrome/common/spellcheck_common.h"
 #include "chrome/common/spellcheck_messages.h"
 #include "chrome/common/spellcheck_result.h"
 #include "chrome/renderer/spellchecker/spellcheck_language.h"
 #include "chrome/renderer/spellchecker/spellcheck_provider.h"
+#include "content/public/renderer/render_frame.h"

[groby-ooo-7-16, 2014/08/19 20:42:05]

Do you need this?

[Klemen Forstnerič, 2014/08/20 20:07:16]

Whoops, this is a relic from when I was still evaluating different solutions to
this bug. Removed.

 #include "content/public/renderer/render_thread.h"
 #include "content/public/renderer/render_view.h"
 #include "content/public/renderer/render_view_visitor.h"
+#include "third_party/WebKit/public/web/WebFrame.h"

[groby-ooo-7-16, 2014/08/19 20:42:05]

Or this?

[Klemen Forstnerič, 2014/08/20 20:07:16]

Same as above. Removed.

 #include "third_party/WebKit/public/web/WebTextCheckingCompletion.h"
 #include "third_party/WebKit/public/web/WebTextCheckingResult.h"
 #include "third_party/WebKit/public/web/WebTextDecorationType.h"
 #include "third_party/WebKit/public/web/WebView.h"
 
 using blink::WebVector;
+using blink::WebString;
 using blink::WebTextCheckingResult;
 using blink::WebTextDecorationType;
 
 namespace {
 
 class UpdateSpellcheckEnabled : public content::RenderViewVisitor {
  public:
   explicit UpdateSpellcheckEnabled(bool enabled) : enabled_(enabled) {}
   virtual bool Visit(content::RenderView* render_view) OVERRIDE;
 
@@ skipping 25 matching lines @@
   if (!render_view || !render_view->GetWebView())
     return true;
   WebVector<uint32> markers;
   render_view->GetWebView()->spellingMarkers(&markers);
   for (size_t i = 0; i < markers.size(); ++i)
     markers_.push_back(markers[i]);
   // Visit all render views.
   return true;
 }
 
+class DocumentMarkersRemover : public content::RenderViewVisitor {
+ public:
+  explicit DocumentMarkersRemover(const std::vector<std::string>& words);
+  virtual ~DocumentMarkersRemover() {}
+  virtual bool Visit(content::RenderView* render_view) OVERRIDE;
+
+ private:
+  WebVector<WebString> words_;
+  DISALLOW_COPY_AND_ASSIGN(DocumentMarkersRemover);
+};
+
+DocumentMarkersRemover::DocumentMarkersRemover(
+    const std::vector<std::string>& words)
+    : words_(words.size()) {
+  for (size_t i = 0; i < words.size(); ++i)
+    words_[i] = WebString::fromUTF8(words[i]);
+}
+
+bool DocumentMarkersRemover::Visit(content::RenderView* render_view) {
+  if (render_view && render_view->GetWebView())
+    render_view->GetWebView()->removeSpellingMarkersUnderWords(words_);
+  return true;
+}
+
 }  // namespace
 
 class SpellCheck::SpellcheckRequest {
  public:
   SpellcheckRequest(const base::string16& text,
                     blink::WebTextCheckingCompletion* completion)
       : text_(text), completion_(completion) {
     DCHECK(completion);
   }
   ~SpellcheckRequest() {}
@@ skipping 59 matching lines @@
   auto_spell_correct_turned_on_ = auto_spell_correct;
 #if !defined(OS_MACOSX)
   PostDelayedSpellCheckTask(pending_request_param_.release());
 #endif
 }
 
 void SpellCheck::OnCustomDictionaryChanged(
     const std::vector<std::string>& words_added,
     const std::vector<std::string>& words_removed) {
   custom_dictionary_.OnCustomDictionaryChanged(words_added, words_removed);
+  if (words_added.empty())
+    return;
+  DocumentMarkersRemover markersRemover(words_added);

[groby-ooo-7-16, 2014/08/19 20:42:05]

I'm slightly queasy about this. OnCustomDictionaryChanged is sent to all
renderers, and this in turn forwards it to all RenderViewHosts. That might be a
bit expensive, since it does string checks on all markers. 

Can you do a test with a large number of tabs that have text input, on different
sites?

(Ideally, I'd like to restrict it to currently visible views and just flag
others for re-check, but that should probably be a separate CL :)

[Klemen Forstnerič, 2014/08/20 20:07:16]

I opened 10 tabs, loaded 10 different websites and I pasted a 959 word french
text (which means that almost every word was underlined) to each of these tabs'
input fields. Adding any word on any tab to the dictionary caused the markers to
be removed instantly. :-) Flagging the hidden views sounds like a cool option
though, maybe I could do this for my next patch.

+  content::RenderView::ForEach(&markersRemover);
 }
 
 void SpellCheck::OnEnableAutoSpellCorrect(bool enable) {
   auto_spell_correct_turned_on_ = enable;
 }
 
 void SpellCheck::OnEnableSpellCheck(bool enable) {
   spellcheck_enabled_ = enable;
   UpdateSpellcheckEnabled updater(enable);
   content::RenderView::ForEach(&updater);
@@ skipping 215 matching lines @@
       list.push_back(WebTextCheckingResult(
           static_cast<WebTextDecorationType>(decoration),
           word_location + line_offset,
           word_length,
           spellcheck_results[i].replacement,
           spellcheck_results[i].hash));
     }
   }
   textcheck_results->assign(list);
 }