chrome/browser/extensions/api/language_settings_private/language_settings_private_delegate.h

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_EXTENSIONS_API_LANGUAGE_SETTINGS_PRIVATE_LANGUAGE_SETTINGS_PRIVATE_DELEGATE_H_
   6 #define CHROME_BROWSER_EXTENSIONS_API_LANGUAGE_SETTINGS_PRIVATE_LANGUAGE_SETTINGS_PRIVATE_DELEGATE_H_
   7
   8 #include "base/memory/scoped_vector.h"
   9 #include "base/memory/weak_ptr.h"
  10 #include "base/prefs/pref_change_registrar.h"
  11 #include "chrome/browser/spellchecker/spellcheck_custom_dictionary.h"
  12 #include "chrome/browser/spellchecker/spellcheck_hunspell_dictionary.h"
  13 #include "chrome/common/extensions/api/language_settings_private.h"
  14 #include "components/keyed_service/core/keyed_service.h"
  15 #include "content/public/browser/notification_observer.h"
  16 #include "content/public/browser/notification_registrar.h"
  17 #include "extensions/browser/event_router.h"
  18
  19 namespace content {
  20 class BrowserContext;
  21 }
  22
  23 namespace extensions {
  24
  25 // Observes language settings and routes changes as events to listeners of the
  26 // languageSettingsPrivate API.
  27 class LanguageSettingsPrivateDelegate
  28     : public KeyedService,
  29       public EventRouter::Observer,
  30       public content::NotificationObserver,
  31       public SpellcheckHunspellDictionary::Observer,
  32       public SpellcheckCustomDictionary::Observer {
  33  public:
  34   static LanguageSettingsPrivateDelegate* Create(
  35       content::BrowserContext* browser_context);
  36   ~LanguageSettingsPrivateDelegate() override;
  37
  38   // Returns the languages and statuses of the enabled spellcheck dictionaries.
  39   ScopedVector<api::language_settings_private::SpellcheckDictionaryStatus>
  40       GetHunspellDictionaryStatuses();
  41
  42  protected:
  43   explicit LanguageSettingsPrivateDelegate(content::BrowserContext* context);
  44
  45   // KeyedService implementation.
  46   void Shutdown() override;
  47
  48   // EventRouter::Observer implementation.
  49   void OnListenerAdded(const EventListenerInfo& details) override;
  50   void OnListenerRemoved(const EventListenerInfo& details) override;
  51
  52   // content::NotificationObserver implementation.
  53   void Observe(int type,
  54                const content::NotificationSource& source,
  55                const content::NotificationDetails& details) override;
  56
  57   // SpellcheckHunspellDictionary::Observer implementation.
  58   void OnHunspellDictionaryInitialized(const std::string& language) override;
  59   void OnHunspellDictionaryDownloadBegin(const std::string& language) override;
  60   void OnHunspellDictionaryDownloadSuccess(
  61       const std::string& language) override;
  62   void OnHunspellDictionaryDownloadFailure(
  63       const std::string& language) override;
  64
  65   // SpellcheckCustomDictionary::Observer implementation.
  66   void OnCustomDictionaryLoaded() override;
  67   void OnCustomDictionaryChanged(
  68       const SpellcheckCustomDictionary::Change& dictionary_change) override;
  69
  70  private:
  71   typedef std::vector<base::WeakPtr<SpellcheckHunspellDictionary>>
  72       WeakDictionaries;
  73
  74   // Updates the dictionaries that are used for spellchecking.
  75   void RefreshDictionaries(bool was_listening, bool should_listen);
  76
  77   // Returns the hunspell dictionaries that are used for spellchecking.
  78   const WeakDictionaries& GetHunspellDictionaries();
  79
  80   // If there are any JavaScript listeners registered for spellcheck events,
  81   // ensures we are registered for change notifications. Otherwise, unregisters
  82   // any observers.
  83   void StartOrStopListeningForSpellcheckChanges();
  84
  85   // Handles the preference for which languages should be used for spellcheck
  86   // by resetting the dictionaries and broadcasting an event.
  87   void OnSpellcheckDictionariesChanged();
  88
  89   // Broadcasts an event with the list of spellcheck dictionary statuses.
  90   void BroadcastDictionariesChangedEvent();
  91
  92   // Removes observers from hunspell_dictionaries_.
  93   void RemoveDictionaryObservers();
  94
  95   // The hunspell dictionaries that are used for spellchecking.
  96   WeakDictionaries hunspell_dictionaries_;
  97
  98   // The custom dictionary that is used for spellchecking.
  99   SpellcheckCustomDictionary* custom_dictionary_;
 100
 101   content::BrowserContext* context_;
 102
 103   // True if there are observers listening for spellcheck events.
 104   bool listening_spellcheck_;
 105
 106   // True if the profile has finished initializing.
 107   bool profile_added_;
 108
 109   content::NotificationRegistrar notification_registrar_;
 110
 111   PrefChangeRegistrar pref_change_registrar_;
 112
 113   DISALLOW_COPY_AND_ASSIGN(LanguageSettingsPrivateDelegate);
 114 };
 115
 116 }  // namespace extensions
 117
 118 #endif  // CHROME_BROWSER_EXTENSIONS_API_LANGUAGE_SETTINGS_PRIVATE_LANGUAGE_SETTINGS_PRIVATE_DELEGATE_H_