Refactor the "spell-checker options" submenu.

chrome/browser/tab_contents/render_view_context_menu.cc

 // 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.
 
 #include <algorithm>
 #include <set>
 
 #include "chrome/browser/tab_contents/render_view_context_menu.h"
 
 #include "base/command_line.h"
@@ skipping 21 matching lines @@
 #include "chrome/browser/printing/print_preview_tab_controller.h"
 #include "chrome/browser/printing/print_view_manager.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/profiles/profile_io_data.h"
 #include "chrome/browser/search_engines/template_url.h"
 #include "chrome/browser/search_engines/template_url_service.h"
 #include "chrome/browser/search_engines/template_url_service_factory.h"
 #include "chrome/browser/spellchecker/spellcheck_host.h"
 #include "chrome/browser/spellchecker/spellcheck_host_metrics.h"
 #include "chrome/browser/spellchecker/spellchecker_platform_engine.h"
+#include "chrome/browser/tab_contents/spellchecker_submenu_observer.h"
 #include "chrome/browser/tab_contents/spelling_menu_observer.h"
 #include "chrome/browser/translate/translate_manager.h"
 #include "chrome/browser/translate/translate_prefs.h"
 #include "chrome/browser/translate/translate_tab_helper.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/search_engines/search_engine_tab_helper.h"
 #include "chrome/browser/ui/tab_contents/tab_contents_wrapper.h"
 #include "chrome/common/chrome_constants.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/pref_names.h"
@@ skipping 168 matching lines @@
 static const int kSpellcheckRadioGroup = 1;
 
 RenderViewContextMenu::RenderViewContextMenu(
     TabContents* tab_contents,
     const ContextMenuParams& params)
     : params_(params),
       source_tab_contents_(tab_contents),
       profile_(Profile::FromBrowserContext(tab_contents->browser_context())),
       ALLOW_THIS_IN_INITIALIZER_LIST(menu_model_(this)),
       external_(false),
-      ALLOW_THIS_IN_INITIALIZER_LIST(spellcheck_submenu_model_(this)),
       ALLOW_THIS_IN_INITIALIZER_LIST(speech_input_submenu_model_(this)),
       ALLOW_THIS_IN_INITIALIZER_LIST(bidi_submenu_model_(this)),
       ALLOW_THIS_IN_INITIALIZER_LIST(protocol_handler_submenu_model_(this)),
       protocol_handler_registry_(profile_->GetProtocolHandlerRegistry()) {
 }
 
 RenderViewContextMenu::~RenderViewContextMenu() {
 }
 
 // Menu construction functions -------------------------------------------------
@@ skipping 326 matching lines @@
     case WebContextMenuData::MediaTypePlugin:
       AppendPluginItems();
       break;
 #ifdef WEBCONTEXT_MEDIATYPEFILE_DEFINED
     case WebContextMenuData::MediaTypeFile:
       break;
 #endif
   }
 
   if (params_.is_editable) {
-    // Add a menu item that shows suggestions from the Spelling service.
-    const CommandLine& command_line = *CommandLine::ForCurrentProcess();
-    if (command_line.HasSwitch(switches::kExperimentalSpellcheckerFeatures)) {
-      PrefService* pref = profile_->GetPrefs();
-      bool use_spelling_service =
-          pref && pref->GetBoolean(prefs::kSpellCheckUseSpellingService);
-      if (use_spelling_service) {
-        if (!spelling_menu_observer_.get())
-            spelling_menu_observer_.reset(new SpellingMenuObserver(this));
-
-        if (spelling_menu_observer_.get())
-          observers_.AddObserver(spelling_menu_observer_.get());
-      }
+    // Add a menu item that shows suggestions.
+    if (!spelling_menu_observer_.get()) {
+      spelling_menu_observer_.reset(
+          new SpellingMenuObserver(this));
     }
+    if (spelling_menu_observer_.get())
+      observers_.AddObserver(spelling_menu_observer_.get());
   }
 
   // Ask our observers to add their menu items.
   FOR_EACH_OBSERVER(RenderViewContextMenuObserver, observers_,
                     InitMenu(params_));
 
   if (params_.is_editable)
     AppendEditableItems();
   else if (has_selection)
     AppendCopyItem();
@@ skipping 10 matching lines @@
 void RenderViewContextMenu::LookUpInDictionary() {
   // Used only in the Mac port.
   NOTREACHED();
 }
 
 void RenderViewContextMenu::AddMenuItem(int command_id,
                                         const string16& title) {
   menu_model_.AddItem(command_id, title);
 }
 
+void RenderViewContextMenu::AddSubMenu(int command_id,
+                                       const string16& label,
+                                       ui::MenuModel* model) {
+  menu_model_.AddSubMenu(command_id, label, model);
+}
+
 void RenderViewContextMenu::UpdateMenuItem(int command_id,
                                            bool enabled,
                                            bool hidden,
                                            const string16& label) {
   // This function needs platform-specific implementation.
   NOTIMPLEMENTED();
 }
 
-
 RenderViewHost* RenderViewContextMenu::GetRenderViewHost() const {
   return source_tab_contents_->render_view_host();
 }
 
 Profile* RenderViewContextMenu::GetProfile() const {
   return profile_;
 }
 
 bool RenderViewContextMenu::AppendCustomItems() {
   size_t total_items = 0;
@@ skipping 261 matching lines @@
   // This functionality is exposed as a keyboard shortcut on Windows & Linux.
   AppendBidiSubMenu();
 #endif  // OS_MACOSX
 
   menu_model_.AddSeparator();
   menu_model_.AddItemWithStringId(IDC_CONTENT_CONTEXT_SELECTALL,
                                   IDS_CONTENT_CONTEXT_SELECTALL);
 }
 
 void RenderViewContextMenu::AppendSpellcheckOptionsSubMenu() {
-  // Add Spell Check languages to sub menu.
-  std::vector<std::string> spellcheck_languages;
-  SpellCheckHost::GetSpellCheckLanguages(profile_,
-      &spellcheck_languages);
-  DCHECK(spellcheck_languages.size() <
-         IDC_SPELLCHECK_LANGUAGES_LAST - IDC_SPELLCHECK_LANGUAGES_FIRST);
-  const std::string app_locale = g_browser_process->GetApplicationLocale();
-  for (size_t i = 0; i < spellcheck_languages.size(); ++i) {
-    string16 display_name(l10n_util::GetDisplayNameForLocale(
-        spellcheck_languages[i], app_locale, true));
-    spellcheck_submenu_model_.AddRadioItem(
-        IDC_SPELLCHECK_LANGUAGES_FIRST + i,
-        display_name,
-        kSpellcheckRadioGroup);
+  if (!spellchecker_submenu_observer_.get()) {
+    spellchecker_submenu_observer_.reset(new SpellCheckerSubMenuObserver(
+        this, this, kSpellcheckRadioGroup));
   }
-
-  // Add item in the sub menu to pop up the fonts and languages options menu.
-  spellcheck_submenu_model_.AddSeparator();
-  spellcheck_submenu_model_.AddItemWithStringId(
-      IDC_CONTENT_CONTEXT_LANGUAGE_SETTINGS,
-      IDS_CONTENT_CONTEXT_LANGUAGE_SETTINGS);
-
-  // Add 'Check the spelling of this field' item in the sub menu.
-  spellcheck_submenu_model_.AddCheckItem(
-      IDC_CHECK_SPELLING_OF_THIS_FIELD,
-      l10n_util::GetStringUTF16(
-          IDS_CONTENT_CONTEXT_CHECK_SPELLING_OF_THIS_FIELD));
-
-  // Add option for showing the spelling panel if the platform spellchecker
-  // supports it.
-  if (SpellCheckerPlatform::SpellCheckerAvailable() &&
-      SpellCheckerPlatform::SpellCheckerProvidesPanel()) {
-    spellcheck_submenu_model_.AddCheckItem(
-        IDC_SPELLPANEL_TOGGLE,
-        l10n_util::GetStringUTF16(
-            SpellCheckerPlatform::SpellingPanelVisible() ?
-                IDS_CONTENT_CONTEXT_HIDE_SPELLING_PANEL :
-                IDS_CONTENT_CONTEXT_SHOW_SPELLING_PANEL));
+  if (spellchecker_submenu_observer_.get()) {
+    spellchecker_submenu_observer_->InitMenu(params_);
+    observers_.AddObserver(spellchecker_submenu_observer_.get());
   }
-
-  menu_model_.AddSubMenu(
-      IDC_SPELLCHECK_MENU,
-      l10n_util::GetStringUTF16(IDS_CONTENT_CONTEXT_SPELLCHECK_MENU),
-      &spellcheck_submenu_model_);
 }
 
 void RenderViewContextMenu::AppendSpeechInputOptionsSubMenu() {
   if (params_.speech_input_enabled) {
     speech_input_submenu_model_.AddCheckItem(
         IDC_CONTENT_CONTEXT_SPEECH_INPUT_FILTER_PROFANITIES,
         l10n_util::GetStringUTF16(
             IDS_CONTENT_CONTEXT_SPEECH_INPUT_FILTER_PROFANITIES));
 
     speech_input_submenu_model_.AddItemWithStringId(
@@ skipping 368 matching lines @@
     case IDC_CONTENT_CONTEXT_PROTOCOL_HANDLER_SETTINGS:
       return true;
 
     default:
       NOTREACHED();
       return false;
   }
 }
 
 bool RenderViewContextMenu::IsCommandIdChecked(int id) const {
+  // If this command is is added by one of our observers, we dispatch it to the
+  // observer.
+  ObserverListBase<RenderViewContextMenuObserver>::Iterator it(observers_);
+  RenderViewContextMenuObserver* observer;
+  while ((observer = it.GetNext()) != NULL) {
+    if (observer->IsCommandIdSupported(id))
+      return observer->IsCommandIdChecked(id);
+  }
+
   // See if the video is set to looping.
   if (id == IDC_CONTENT_CONTEXT_LOOP) {
     return (params_.media_flags &
             WebContextMenuData::MediaLoop) != 0;
   }
 
   if (id == IDC_CONTENT_CONTEXT_CONTROLS) {
     return (params_.media_flags &
             WebContextMenuData::MediaControlRootElement) != 0;
   }
@@ skipping 21 matching lines @@
     if (id == IDC_WRITING_DIRECTION_RTL)
       return params_.writing_direction_right_to_left &
           WebContextMenuData::CheckableMenuItemChecked;
     if (id == IDC_WRITING_DIRECTION_LTR)
       return params_.writing_direction_left_to_right &
           WebContextMenuData::CheckableMenuItemChecked;
     if (id == IDC_CONTENT_CONTEXT_LOOK_UP_IN_DICTIONARY)
       return false;
 #endif  // OS_MACOSX
 
-  // Check box for 'Check the Spelling of this field'.
-  if (id == IDC_CHECK_SPELLING_OF_THIS_FIELD) {
-    return (params_.spellcheck_enabled &&
-            profile_->GetPrefs()->GetBoolean(prefs::kEnableSpellCheck));
-  }
-
   // Check box for menu item 'Block offensive words'.
   if (id == IDC_CONTENT_CONTEXT_SPEECH_INPUT_FILTER_PROFANITIES) {
     return profile_->GetPrefs()->GetBoolean(
         prefs::kSpeechInputFilterProfanities);
   }
 
-  // Don't bother getting the display language vector if this isn't a spellcheck
-  // language.
-  if ((id < IDC_SPELLCHECK_LANGUAGES_FIRST) ||
-      (id >= IDC_SPELLCHECK_LANGUAGES_LAST))
-    return false;
-
-  std::vector<std::string> languages;
-  return SpellCheckHost::GetSpellCheckLanguages(profile_, &languages) ==
-      (id - IDC_SPELLCHECK_LANGUAGES_FIRST);
+  return false;
 }
 
 void RenderViewContextMenu::ExecuteCommand(int id) {
   return ExecuteCommand(id, 0);
 }
 
 void RenderViewContextMenu::ExecuteCommand(int id, int event_flags) {
   // If this command is is added by one of our observers, we dispatch it to the
   // observer.
   ObserverListBase<RenderViewContextMenuObserver>::Iterator it(observers_);
   RenderViewContextMenuObserver* observer;
   while ((observer = it.GetNext()) != NULL) {
     if (observer->IsCommandIdSupported(id))
       return observer->ExecuteCommand(id);
   }
 
-  // Check to see if one of the spell check language ids have been clicked.
-  if (id >= IDC_SPELLCHECK_LANGUAGES_FIRST &&
-      id < IDC_SPELLCHECK_LANGUAGES_LAST) {
-    const size_t language_number = id - IDC_SPELLCHECK_LANGUAGES_FIRST;
-    std::vector<std::string> languages;
-    SpellCheckHost::GetSpellCheckLanguages(profile_, &languages);
-    if (language_number < languages.size()) {
-      StringPrefMember dictionary_language;
-      dictionary_language.Init(prefs::kSpellCheckDictionary,
-          profile_->GetPrefs(), NULL);
-      dictionary_language.SetValue(languages[language_number]);
-    }
-    return;
-  }
-
   RenderViewHost* rvh = source_tab_contents_->render_view_host();
 
   // Process custom actions range.
   if (id >= IDC_CONTENT_CONTEXT_CUSTOM_FIRST &&
       id <= IDC_CONTENT_CONTEXT_CUSTOM_LAST) {
     unsigned action = id - IDC_CONTENT_CONTEXT_CUSTOM_FIRST;
     rvh->ExecuteCustomContextMenuCommand(action, params_.custom_context);
     return;
   }
 
@@ skipping 308 matching lines @@
     case IDC_SPELLCHECK_SUGGESTION_4: {
       rvh->Replace(
           params_.dictionary_suggestions[id - IDC_SPELLCHECK_SUGGESTION_0]);
       // GetSpellCheckHost() can return null when the suggested word is
       // provided by Web SpellCheck API.
       SpellCheckHost* spellcheck_host = profile_->GetSpellCheckHost();
       if (spellcheck_host && spellcheck_host->GetMetrics())
         spellcheck_host->GetMetrics()->RecordReplacedWordStats(1);
       break;
     }
-    case IDC_CHECK_SPELLING_OF_THIS_FIELD: {
-      rvh->Send(new SpellCheckMsg_ToggleSpellCheck(rvh->routing_id()));
-      break;
-    }
     case IDC_SPELLCHECK_ADD_TO_DICTIONARY: {
       // GetSpellCheckHost() can return null when the suggested word is
       // provided by Web SpellCheck API.
       if (profile_->GetSpellCheckHost())
         profile_->GetSpellCheckHost()->AddWord(
             UTF16ToUTF8(params_.misspelled_word));
       SpellCheckerPlatform::AddWord(params_.misspelled_word);
       break;
     }
 
     case IDC_CONTENT_CONTEXT_LANGUAGE_SETTINGS: {
       WindowOpenDisposition disposition =
           ForceNewTabDispositionFromEventFlags(event_flags);
       std::string url = std::string(chrome::kChromeUISettingsURL) +
           chrome::kLanguageOptionsSubPage;
       OpenURL(GURL(url), GURL(), 0, disposition, content::PAGE_TRANSITION_LINK);
       break;
     }
 
-    case IDC_SPELLPANEL_TOGGLE: {
-      rvh->Send(new SpellCheckMsg_ToggleSpellPanel(
-          rvh->routing_id(), SpellCheckerPlatform::SpellingPanelVisible()));
-      break;
-    }
-
 #if defined(OS_MACOSX)
     case IDC_WRITING_DIRECTION_DEFAULT:
       // WebKit's current behavior is for this menu item to always be disabled.
       NOTREACHED();
       break;
     case IDC_WRITING_DIRECTION_RTL:
     case IDC_WRITING_DIRECTION_LTR: {
       WebKit::WebTextDirection dir = WebKit::WebTextDirectionLeftToRight;
       if (id == IDC_WRITING_DIRECTION_RTL)
         dir = WebKit::WebTextDirectionRightToLeft;
@@ skipping 162 matching lines @@
       profile_->GetPrefs()->GetString(prefs::kAcceptLanguages),
       g_browser_process->clipboard());
 }
 
 void RenderViewContextMenu::MediaPlayerActionAt(
     const gfx::Point& location,
     const WebMediaPlayerAction& action) {
   source_tab_contents_->render_view_host()->
       ExecuteMediaPlayerActionAtLocation(location, action);
 }