chrome/browser/extensions/api/font_settings/font_settings_api.h

   1 // Copyright (c) 2012 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 // Defines the classes to realize the Font Settings Extension API as specified
   6 // in the extension API JSON.
   7
   8 #ifndef CHROME_BROWSER_EXTENSIONS_API_FONT_SETTINGS_FONT_SETTINGS_API_H_
   9 #define CHROME_BROWSER_EXTENSIONS_API_FONT_SETTINGS_FONT_SETTINGS_API_H_
  10
  11 #include <string>
  12
  13 #include "base/memory/scoped_ptr.h"
  14 #include "base/prefs/pref_change_registrar.h"
  15 #include "base/prefs/pref_service.h"
  16 #include "chrome/browser/extensions/chrome_extension_function.h"
  17 #include "extensions/browser/browser_context_keyed_api_factory.h"
  18 #include "extensions/browser/event_router.h"
  19 #include "extensions/browser/extension_event_histogram_value.h"
  20
  21 class Profile;
  22
  23 namespace content {
  24 class BrowserContext;
  25 }
  26
  27 namespace extensions {
  28
  29 // This class observes pref changed events on a profile and dispatches the
  30 // corresponding extension API events to extensions.
  31 class FontSettingsEventRouter {
  32  public:
  33   // Constructor for observing pref changed events on |profile|. Stores a
  34   // pointer to |profile| but does not take ownership. |profile| must be
  35   // non-NULL and remain alive for the lifetime of the instance.
  36   explicit FontSettingsEventRouter(Profile* profile);
  37   virtual ~FontSettingsEventRouter();
  38
  39  private:
  40   // Observes browser pref |pref_name|. When a change is observed, dispatches
  41   // event |event_name| to extensions. A JavaScript object is passed to the
  42   // extension event function with the new value of the pref in property |key|.
  43   void AddPrefToObserve(const char* pref_name,
  44                         events::HistogramValue histogram_value,
  45                         const char* event_name,
  46                         const char* key);
  47
  48   // Decodes a preference change for a font family map and invokes
  49   // OnFontNamePrefChange with the right parameters.
  50   void OnFontFamilyMapPrefChanged(const std::string& pref_name);
  51
  52   // Dispatches a changed event for the font setting for |generic_family| and
  53   // |script| to extensions. The new value of the setting is the value of
  54   // browser pref |pref_name|.
  55   void OnFontNamePrefChanged(const std::string& pref_name,
  56                              const std::string& generic_family,
  57                              const std::string& script);
  58
  59   // Dispatches the setting changed event |event_name| to extensions. The new
  60   // value of the setting is the value of browser pref |pref_name|. This value
  61   // is passed in the JavaScript object argument to the extension event function
  62   // under the key |key|.
  63   void OnFontPrefChanged(events::HistogramValue histogram_value,
  64                          const std::string& event_name,
  65                          const std::string& key,
  66                          const std::string& pref_name);
  67
  68   // Manages pref observation registration.
  69   PrefChangeRegistrar registrar_;
  70
  71   // Weak, owns us (transitively via ExtensionService).
  72   Profile* profile_;
  73
  74   DISALLOW_COPY_AND_ASSIGN(FontSettingsEventRouter);
  75 };
  76
  77 // The profile-keyed service that manages the font_settings extension API.
  78 // This is not an EventRouter::Observer (and does not lazily initialize) because
  79 // doing so caused a regression in perf tests. See crbug.com/163466.
  80 class FontSettingsAPI : public BrowserContextKeyedAPI {
  81  public:
  82   explicit FontSettingsAPI(content::BrowserContext* context);
  83   ~FontSettingsAPI() override;
  84
  85   // BrowserContextKeyedAPI implementation.
  86   static BrowserContextKeyedAPIFactory<FontSettingsAPI>* GetFactoryInstance();
  87
  88  private:
  89   friend class BrowserContextKeyedAPIFactory<FontSettingsAPI>;
  90
  91   // BrowserContextKeyedAPI implementation.
  92   static const char* service_name() {
  93     return "FontSettingsAPI";
  94   }
  95   static const bool kServiceIsNULLWhileTesting = true;
  96
  97   scoped_ptr<FontSettingsEventRouter> font_settings_event_router_;
  98 };
  99
 100 // fontSettings.clearFont API function.
 101 class FontSettingsClearFontFunction : public ChromeSyncExtensionFunction {
 102  public:
 103   DECLARE_EXTENSION_FUNCTION("fontSettings.clearFont", FONTSETTINGS_CLEARFONT)
 104
 105  protected:
 106   // RefCounted types have non-public destructors, as with all extension
 107   // functions in this file.
 108   ~FontSettingsClearFontFunction() override {}
 109
 110   // ExtensionFunction:
 111   bool RunSync() override;
 112 };
 113
 114 // fontSettings.getFont API function.
 115 class FontSettingsGetFontFunction : public ChromeSyncExtensionFunction {
 116  public:
 117   DECLARE_EXTENSION_FUNCTION("fontSettings.getFont", FONTSETTINGS_GETFONT)
 118
 119  protected:
 120   ~FontSettingsGetFontFunction() override {}
 121
 122   // ExtensionFunction:
 123   bool RunSync() override;
 124 };
 125
 126 // fontSettings.setFont API function.
 127 class FontSettingsSetFontFunction : public ChromeSyncExtensionFunction {
 128  public:
 129   DECLARE_EXTENSION_FUNCTION("fontSettings.setFont", FONTSETTINGS_SETFONT)
 130
 131  protected:
 132   ~FontSettingsSetFontFunction() override {}
 133
 134   // ExtensionFunction:
 135   bool RunSync() override;
 136 };
 137
 138 // fontSettings.getFontList API function.
 139 class FontSettingsGetFontListFunction : public ChromeAsyncExtensionFunction {
 140  public:
 141   DECLARE_EXTENSION_FUNCTION("fontSettings.getFontList",
 142                              FONTSETTINGS_GETFONTLIST)
 143
 144  protected:
 145   ~FontSettingsGetFontListFunction() override {}
 146
 147   // ExtensionFunction:
 148   bool RunAsync() override;
 149
 150  private:
 151   void FontListHasLoaded(scoped_ptr<base::ListValue> list);
 152   bool CopyFontsToResult(base::ListValue* fonts);
 153 };
 154
 155 // Base class for extension API functions that clear a browser font pref.
 156 class ClearFontPrefExtensionFunction : public ChromeSyncExtensionFunction {
 157  protected:
 158   ~ClearFontPrefExtensionFunction() override {}
 159
 160   // ExtensionFunction:
 161   bool RunSync() override;
 162
 163   // Implementations should return the name of the preference to clear, like
 164   // "webkit.webprefs.default_font_size".
 165   virtual const char* GetPrefName() = 0;
 166 };
 167
 168 // Base class for extension API functions that get a browser font pref.
 169 class GetFontPrefExtensionFunction : public ChromeSyncExtensionFunction {
 170  protected:
 171   ~GetFontPrefExtensionFunction() override {}
 172
 173   // ExtensionFunction:
 174   bool RunSync() override;
 175
 176   // Implementations should return the name of the preference to get, like
 177   // "webkit.webprefs.default_font_size".
 178   virtual const char* GetPrefName() = 0;
 179
 180   // Implementations should return the key for the value in the extension API,
 181   // like "pixelSize".
 182   virtual const char* GetKey() = 0;
 183 };
 184
 185 // Base class for extension API functions that set a browser font pref.
 186 class SetFontPrefExtensionFunction : public ChromeSyncExtensionFunction {
 187  protected:
 188   ~SetFontPrefExtensionFunction() override {}
 189
 190   // ExtensionFunction:
 191   bool RunSync() override;
 192
 193   // Implementations should return the name of the preference to set, like
 194   // "webkit.webprefs.default_font_size".
 195   virtual const char* GetPrefName() = 0;
 196
 197   // Implementations should return the key for the value in the extension API,
 198   // like "pixelSize".
 199   virtual const char* GetKey() = 0;
 200 };
 201
 202 // The following are get/set/clear API functions that act on a browser font
 203 // pref.
 204
 205 class FontSettingsClearDefaultFontSizeFunction
 206     : public ClearFontPrefExtensionFunction {
 207  public:
 208   DECLARE_EXTENSION_FUNCTION("fontSettings.clearDefaultFontSize",
 209                              FONTSETTINGS_CLEARDEFAULTFONTSIZE)
 210
 211  protected:
 212   ~FontSettingsClearDefaultFontSizeFunction() override {}
 213
 214   // ClearFontPrefExtensionFunction:
 215   const char* GetPrefName() override;
 216 };
 217
 218 class FontSettingsGetDefaultFontSizeFunction
 219     : public GetFontPrefExtensionFunction {
 220  public:
 221   DECLARE_EXTENSION_FUNCTION("fontSettings.getDefaultFontSize",
 222                              FONTSETTINGS_GETDEFAULTFONTSIZE)
 223
 224  protected:
 225   ~FontSettingsGetDefaultFontSizeFunction() override {}
 226
 227   // GetFontPrefExtensionFunction:
 228   const char* GetPrefName() override;
 229   const char* GetKey() override;
 230 };
 231
 232 class FontSettingsSetDefaultFontSizeFunction
 233     : public SetFontPrefExtensionFunction {
 234  public:
 235   DECLARE_EXTENSION_FUNCTION("fontSettings.setDefaultFontSize",
 236                              FONTSETTINGS_SETDEFAULTFONTSIZE)
 237
 238  protected:
 239   ~FontSettingsSetDefaultFontSizeFunction() override {}
 240
 241   // SetFontPrefExtensionFunction:
 242   const char* GetPrefName() override;
 243   const char* GetKey() override;
 244 };
 245
 246 class FontSettingsClearDefaultFixedFontSizeFunction
 247     : public ClearFontPrefExtensionFunction {
 248  public:
 249   DECLARE_EXTENSION_FUNCTION("fontSettings.clearDefaultFixedFontSize",
 250                              FONTSETTINGS_CLEARDEFAULTFIXEDFONTSIZE)
 251
 252  protected:
 253   ~FontSettingsClearDefaultFixedFontSizeFunction() override {}
 254
 255   // ClearFontPrefExtensionFunction:
 256   const char* GetPrefName() override;
 257 };
 258
 259 class FontSettingsGetDefaultFixedFontSizeFunction
 260     : public GetFontPrefExtensionFunction {
 261  public:
 262   DECLARE_EXTENSION_FUNCTION("fontSettings.getDefaultFixedFontSize",
 263                              FONTSETTINGS_GETDEFAULTFIXEDFONTSIZE)
 264
 265  protected:
 266   ~FontSettingsGetDefaultFixedFontSizeFunction() override {}
 267
 268   // GetFontPrefExtensionFunction:
 269   const char* GetPrefName() override;
 270   const char* GetKey() override;
 271 };
 272
 273 class FontSettingsSetDefaultFixedFontSizeFunction
 274     : public SetFontPrefExtensionFunction {
 275  public:
 276   DECLARE_EXTENSION_FUNCTION("fontSettings.setDefaultFixedFontSize",
 277                              FONTSETTINGS_SETDEFAULTFIXEDFONTSIZE)
 278
 279  protected:
 280   ~FontSettingsSetDefaultFixedFontSizeFunction() override {}
 281
 282   // SetFontPrefExtensionFunction:
 283   const char* GetPrefName() override;
 284   const char* GetKey() override;
 285 };
 286
 287 class FontSettingsClearMinimumFontSizeFunction
 288     : public ClearFontPrefExtensionFunction {
 289  public:
 290   DECLARE_EXTENSION_FUNCTION("fontSettings.clearMinimumFontSize",
 291                              FONTSETTINGS_CLEARMINIMUMFONTSIZE)
 292
 293  protected:
 294   ~FontSettingsClearMinimumFontSizeFunction() override {}
 295
 296   // ClearFontPrefExtensionFunction:
 297   const char* GetPrefName() override;
 298 };
 299
 300 class FontSettingsGetMinimumFontSizeFunction
 301     : public GetFontPrefExtensionFunction {
 302  public:
 303   DECLARE_EXTENSION_FUNCTION("fontSettings.getMinimumFontSize",
 304                              FONTSETTINGS_GETMINIMUMFONTSIZE)
 305
 306  protected:
 307   ~FontSettingsGetMinimumFontSizeFunction() override {}
 308
 309   // GetFontPrefExtensionFunction:
 310   const char* GetPrefName() override;
 311   const char* GetKey() override;
 312 };
 313
 314 class FontSettingsSetMinimumFontSizeFunction
 315     : public SetFontPrefExtensionFunction {
 316  public:
 317   DECLARE_EXTENSION_FUNCTION("fontSettings.setMinimumFontSize",
 318                              FONTSETTINGS_SETMINIMUMFONTSIZE)
 319
 320  protected:
 321   ~FontSettingsSetMinimumFontSizeFunction() override {}
 322
 323   // SetFontPrefExtensionFunction:
 324   const char* GetPrefName() override;
 325   const char* GetKey() override;
 326 };
 327
 328 }  // namespace extensions
 329
 330 #endif  // CHROME_BROWSER_EXTENSIONS_API_FONT_SETTINGS_FONT_SETTINGS_API_H_