Rejigger ThemeService: move exposure of ThemeProvider interface to a

chrome/browser/themes/theme_service.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/browser/themes/theme_service.h"
 
 #include <algorithm>
 
 #include "base/bind.h"
 #include "base/location.h"
 #include "base/memory/ref_counted_memory.h"
 #include "base/prefs/pref_service.h"
 #include "base/sequenced_task_runner.h"
 #include "base/single_thread_task_runner.h"
 #include "base/strings/string_util.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/thread_task_runner_handle.h"
 #include "chrome/browser/chrome_notification_types.h"
 #include "chrome/browser/extensions/extension_service.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/themes/browser_theme_pack.h"
 #include "chrome/browser/themes/custom_theme_supplier.h"
 #include "chrome/browser/themes/theme_properties.h"
+#include "chrome/browser/themes/theme_service_factory.h"
 #include "chrome/browser/themes/theme_syncable_service.h"
 #include "chrome/common/chrome_constants.h"
 #include "chrome/common/pref_names.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/user_metrics.h"
 #include "extensions/browser/extension_prefs.h"
 #include "extensions/browser/extension_registry.h"
 #include "extensions/browser/extension_system.h"
 #include "extensions/browser/uninstall_reason.h"
 #include "extensions/common/extension.h"
@@ skipping 124 matching lines @@
   ThemeService* theme_service_;
 };
 #endif  // defined(ENABLE_EXTENSIONS)
 
 ThemeService::ThemeService()
     : ready_(false),
       rb_(ResourceBundle::GetSharedInstance()),
       profile_(nullptr),
       installed_pending_load_id_(kDefaultThemeID),
       number_of_infobars_(0),
-      weak_ptr_factory_(this) {
-}
+      original_theme_provider_(*this, false),
+      otr_theme_provider_(*this, true),
+      weak_ptr_factory_(this) {}
 
 ThemeService::~ThemeService() {
   FreePlatformCaches();
 }
 
 void ThemeService::Init(Profile* profile) {
   DCHECK(CalledOnValidThread());
   profile_ = profile;
 
   LoadThemePrefs();
 
   registrar_.Add(this,
                  extensions::NOTIFICATION_EXTENSIONS_READY_DEPRECATED,
                  content::Source<Profile>(profile_));
 
   theme_syncable_service_.reset(new ThemeSyncableService(profile_, this));
 }
 
-gfx::Image ThemeService::GetImageNamed(int id) const {
-  DCHECK(CalledOnValidThread());
-
-  gfx::Image image;
-  if (theme_supplier_.get())
-    image = theme_supplier_->GetImageNamed(id);
-
-  if (image.IsEmpty())
-    image = rb_.GetNativeImageNamed(id);
-
-  return image;
-}
-
 bool ThemeService::IsSystemThemeDistinctFromDefaultTheme() const {
   return false;
 }
 
-bool ThemeService::UsingSystemTheme() const {
-  return UsingDefaultTheme();
-}
-
-gfx::ImageSkia* ThemeService::GetImageSkiaNamed(int id) const {
-  gfx::Image image = GetImageNamed(id);
-  if (image.IsEmpty())
-    return nullptr;
-  // TODO(pkotwicz): Remove this const cast.  The gfx::Image interface returns
-  // its images const. GetImageSkiaNamed() also should but has many callsites.
-  return const_cast<gfx::ImageSkia*>(image.ToImageSkia());
-}
-
-SkColor ThemeService::GetColor(int id) const {
-  DCHECK(CalledOnValidThread());
-  SkColor color;
-  if (theme_supplier_.get() && theme_supplier_->GetColor(id, &color))
-    return color;
-
-  // For backward compat with older themes, some newer colors are generated from
-  // older ones if they are missing.
-  switch (id) {
-    case Properties::COLOR_TOOLBAR_BUTTON_ICON:
-      return color_utils::HSLShift(gfx::kChromeIconGrey,
-                                   GetTint(Properties::TINT_BUTTONS));
-    case Properties::COLOR_TOOLBAR_BUTTON_ICON_INACTIVE:
-      // The active color is overridden in Gtk2UI.
-      return SkColorSetA(GetColor(Properties::COLOR_TOOLBAR_BUTTON_ICON), 0x33);
-    case Properties::COLOR_NTP_SECTION_HEADER_TEXT:
-      return IncreaseLightness(GetColor(Properties::COLOR_NTP_TEXT), 0.30);
-    case Properties::COLOR_NTP_SECTION_HEADER_TEXT_HOVER:
-      return GetColor(Properties::COLOR_NTP_TEXT);
-    case Properties::COLOR_NTP_SECTION_HEADER_RULE:
-      return IncreaseLightness(GetColor(Properties::COLOR_NTP_TEXT), 0.70);
-    case Properties::COLOR_NTP_SECTION_HEADER_RULE_LIGHT:
-      return IncreaseLightness(GetColor(Properties::COLOR_NTP_TEXT), 0.86);
-    case Properties::COLOR_NTP_TEXT_LIGHT:
-      return IncreaseLightness(GetColor(Properties::COLOR_NTP_TEXT), 0.40);
-    case Properties::COLOR_TAB_THROBBER_SPINNING:
-    case Properties::COLOR_TAB_THROBBER_WAITING: {
-      SkColor base_color =
-          ui::GetAuraColor(id == Properties::COLOR_TAB_THROBBER_SPINNING
-                               ? ui::NativeTheme::kColorId_ThrobberSpinningColor
-                               : ui::NativeTheme::kColorId_ThrobberWaitingColor,
-                           nullptr);
-      color_utils::HSL hsl = GetTint(Properties::TINT_BUTTONS);
-      return color_utils::HSLShift(base_color, hsl);
-    }
-#if defined(ENABLE_SUPERVISED_USERS)
-    case Properties::COLOR_SUPERVISED_USER_LABEL:
-      return color_utils::GetReadableColor(
-          SK_ColorWHITE,
-          GetColor(Properties::COLOR_SUPERVISED_USER_LABEL_BACKGROUND));
-    case Properties::COLOR_SUPERVISED_USER_LABEL_BACKGROUND:
-      return color_utils::BlendTowardOppositeLuminance(
-          GetColor(Properties::COLOR_FRAME), 0x80);
-    case Properties::COLOR_SUPERVISED_USER_LABEL_BORDER:
-      return color_utils::AlphaBlend(
-          GetColor(Properties::COLOR_SUPERVISED_USER_LABEL_BACKGROUND),
-          SK_ColorBLACK,
-          230);
-#endif
-    case Properties::COLOR_STATUS_BAR_TEXT: {
-      // A long time ago, we blended the toolbar and the tab text together to
-      // get the status bar text because, at the time, our text rendering in
-      // views couldn't do alpha blending. Even though this is no longer the
-      // case, this blending decision is built into the majority of themes that
-      // exist, and we must keep doing it.
-      SkColor toolbar_color = GetColor(Properties::COLOR_TOOLBAR);
-      SkColor text_color = GetColor(Properties::COLOR_TAB_TEXT);
-      return SkColorSetARGB(
-          SkColorGetA(text_color),
-          (SkColorGetR(text_color) + SkColorGetR(toolbar_color)) / 2,
-          (SkColorGetG(text_color) + SkColorGetR(toolbar_color)) / 2,
-          (SkColorGetB(text_color) + SkColorGetR(toolbar_color)) / 2);
-    }
-  }
-
-  return Properties::GetDefaultColor(id);
-}
-
-int ThemeService::GetDisplayProperty(int id) const {
-  int result = 0;
-  if (theme_supplier_.get() &&
-      theme_supplier_->GetDisplayProperty(id, &result)) {
-    return result;
-  }
-
-  switch (id) {
-    case Properties::NTP_BACKGROUND_ALIGNMENT:
-      return Properties::ALIGN_CENTER;
-
-    case Properties::NTP_BACKGROUND_TILING:
-      return Properties::NO_REPEAT;
-
-    case Properties::NTP_LOGO_ALTERNATE:
-      return UsingDefaultTheme() || UsingSystemTheme() ||
-          (!HasCustomImage(IDR_THEME_NTP_BACKGROUND) &&
-           IsColorGrayscale(GetColor(Properties::COLOR_NTP_BACKGROUND))) ?
-          0 : 1;
-
-    default:
-      return -1;
-  }
-}
-
-bool ThemeService::ShouldUseNativeFrame() const {
-  if (HasCustomImage(IDR_THEME_FRAME))
-    return false;
-#if defined(OS_WIN)
-  return ui::win::IsAeroGlassEnabled();
-#else
-  return false;
-#endif
-}
-
-bool ThemeService::HasCustomImage(int id) const {
-  return BrowserThemePack::IsPersistentImageID(id) &&
-      theme_supplier_ && theme_supplier_->HasCustomImage(id);
-}
-
-base::RefCountedMemory* ThemeService::GetRawData(
-    int id,
-    ui::ScaleFactor scale_factor) const {
-  // Check to see whether we should substitute some images.
-  int ntp_alternate = GetDisplayProperty(Properties::NTP_LOGO_ALTERNATE);
-  if (id == IDR_PRODUCT_LOGO && ntp_alternate != 0)
-    id = IDR_PRODUCT_LOGO_WHITE;
-
-  base::RefCountedMemory* data = nullptr;
-  if (theme_supplier_.get())
-    data = theme_supplier_->GetRawData(id, scale_factor);
-  if (!data)
-    data = rb_.LoadDataResourceBytesForScale(id, ui::SCALE_FACTOR_100P);
-
-  return data;
-}
-
 void ThemeService::Shutdown() {
 #if defined(ENABLE_EXTENSIONS)
   theme_observer_.reset();
 #endif
 }
 
 void ThemeService::Observe(int type,
                            const content::NotificationSource& source,
                            const content::NotificationDetails& details) {
   using content::Details;
@@ skipping 132 matching lines @@
 }
 
 std::string ThemeService::GetThemeID() const {
   return profile_->GetPrefs()->GetString(prefs::kCurrentThemeID);
 }
 
 color_utils::HSL ThemeService::GetTint(int id) const {
   DCHECK(CalledOnValidThread());
 
   color_utils::HSL hsl;
-  if (theme_supplier_.get() && theme_supplier_->GetTint(id, &hsl))
+  if (theme_supplier_ && theme_supplier_->GetTint(id, &hsl))
     return hsl;
 
   return ThemeProperties::GetDefaultTint(id);
 }
 
 void ThemeService::ClearAllThemeData() {
   if (!ready_)
     return;
 
   SwapThemeSupplier(nullptr);
@@ skipping 37 matching lines @@
   bool loaded_pack = false;
 
   // If we don't have a file pack, we're updating from an old version, or the
   // pack was created for an alternative MaterialDesignController::Mode.
   base::FilePath path = prefs->GetFilePath(prefs::kCurrentThemePackFilename);
   if (path != base::FilePath()) {
     path = path.Append(ui::MaterialDesignController::IsModeMaterial()
                            ? chrome::kThemePackMaterialDesignFilename
                            : chrome::kThemePackFilename);
     SwapThemeSupplier(BrowserThemePack::BuildFromDataPack(path, current_id));
-    loaded_pack = theme_supplier_.get() != nullptr;
+    loaded_pack = theme_supplier_ != nullptr;
   }
 
   if (loaded_pack) {
     content::RecordAction(UserMetricsAction("Themes.Loaded"));
     set_ready();
   }
   // Else: wait for the extension service to be ready so that the theme pack
   // can be recreated from the extension.
 }
 
@@ skipping 17 matching lines @@
     theme_syncable_service_->OnThemeChange();
   }
 }
 
 #if defined(USE_AURA)
 void ThemeService::FreePlatformCaches() {
   // Views (Skia) has no platform image cache to clear.
 }
 #endif
 
+bool ThemeService::UsingSystemTheme() const {
+  return UsingDefaultTheme();
+}
+
+gfx::ImageSkia* ThemeService::GetImageSkiaNamed(int id) const {
+  gfx::Image image = GetImageNamed(id);
+  if (image.IsEmpty())
+    return nullptr;
+  // TODO(pkotwicz): Remove this const cast.  The gfx::Image interface returns
+  // its images const. GetImageSkiaNamed() also should but has many callsites.
+  return const_cast<gfx::ImageSkia*>(image.ToImageSkia());
+}
+
+SkColor ThemeService::GetColor(int id) const {
+  DCHECK(CalledOnValidThread());
+  // Custom themes always use the original (non-incognito) color.
+  int original_id = Properties::IncognitoPropertyToProperty(id);
+  SkColor color;

[pkotwicz, 2015/12/04 23:16:49]

CustomThemeProviders do provide some incognito colors.
COLOR_FRAME_INCOGNITO and COLOR_FRAME_INCOGNITO_INACTIVE in particular

I think that this is clearer:

if (theme_supplier_) {
  SkColor color;
  if (theme_supplier_->GetColor(id, &color))
    return color;
  int original_id = Properties::IncognitoPropertyToProperty(id)
  if (id != original_id && theme_supplier_->GetColor(original_id, &color)
    return color;
}

[Evan Stade, 2015/12/09 00:57:10]

changed to pkasting's suggestion

+  if (theme_supplier_ && theme_supplier_->GetColor(original_id, &color))
+    return color;
+
+  // For backward compat with older themes, some newer colors are generated from
+  // older ones if they are missing.
+  switch (id) {
+    case Properties::COLOR_TOOLBAR_BUTTON_ICON:
+      return color_utils::HSLShift(gfx::kChromeIconGrey,
+                                   GetTint(Properties::TINT_BUTTONS));
+    case Properties::COLOR_TOOLBAR_BUTTON_ICON_INACTIVE:
+      // The active color is overridden in Gtk2UI.
+      return SkColorSetA(GetColor(Properties::COLOR_TOOLBAR_BUTTON_ICON), 0x33);
+    case Properties::COLOR_NTP_SECTION_HEADER_TEXT:
+      return IncreaseLightness(GetColor(Properties::COLOR_NTP_TEXT), 0.30);
+    case Properties::COLOR_NTP_SECTION_HEADER_TEXT_HOVER:
+      return GetColor(Properties::COLOR_NTP_TEXT);
+    case Properties::COLOR_NTP_SECTION_HEADER_RULE:
+      return IncreaseLightness(GetColor(Properties::COLOR_NTP_TEXT), 0.70);
+    case Properties::COLOR_NTP_SECTION_HEADER_RULE_LIGHT:
+      return IncreaseLightness(GetColor(Properties::COLOR_NTP_TEXT), 0.86);
+    case Properties::COLOR_NTP_TEXT_LIGHT:
+      return IncreaseLightness(GetColor(Properties::COLOR_NTP_TEXT), 0.40);
+    case Properties::COLOR_TAB_THROBBER_SPINNING:
+    case Properties::COLOR_TAB_THROBBER_WAITING: {
+      SkColor base_color =
+          ui::GetAuraColor(id == Properties::COLOR_TAB_THROBBER_SPINNING
+                               ? ui::NativeTheme::kColorId_ThrobberSpinningColor
+                               : ui::NativeTheme::kColorId_ThrobberWaitingColor,
+                           nullptr);
+      color_utils::HSL hsl = GetTint(Properties::TINT_BUTTONS);
+      return color_utils::HSLShift(base_color, hsl);
+    }
+#if defined(ENABLE_SUPERVISED_USERS)
+    case Properties::COLOR_SUPERVISED_USER_LABEL:
+      return color_utils::GetReadableColor(
+          SK_ColorWHITE,
+          GetColor(Properties::COLOR_SUPERVISED_USER_LABEL_BACKGROUND));
+    case Properties::COLOR_SUPERVISED_USER_LABEL_BACKGROUND:
+      return color_utils::BlendTowardOppositeLuminance(
+          GetColor(Properties::COLOR_FRAME), 0x80);
+    case Properties::COLOR_SUPERVISED_USER_LABEL_BORDER:
+      return color_utils::AlphaBlend(
+          GetColor(Properties::COLOR_SUPERVISED_USER_LABEL_BACKGROUND),
+          SK_ColorBLACK, 230);
+#endif
+    case Properties::COLOR_STATUS_BAR_TEXT: {
+      // A long time ago, we blended the toolbar and the tab text together to
+      // get the status bar text because, at the time, our text rendering in
+      // views couldn't do alpha blending. Even though this is no longer the
+      // case, this blending decision is built into the majority of themes that
+      // exist, and we must keep doing it.
+      SkColor toolbar_color = GetColor(Properties::COLOR_TOOLBAR);
+      SkColor text_color = GetColor(Properties::COLOR_TAB_TEXT);
+      return SkColorSetARGB(
+          SkColorGetA(text_color),
+          (SkColorGetR(text_color) + SkColorGetR(toolbar_color)) / 2,
+          (SkColorGetG(text_color) + SkColorGetR(toolbar_color)) / 2,
+          (SkColorGetB(text_color) + SkColorGetR(toolbar_color)) / 2);
+    }
+  }
+
+  return Properties::GetDefaultColor(id);
+}
+
+int ThemeService::GetDisplayProperty(int id) const {
+  int result = 0;
+  if (theme_supplier_ && theme_supplier_->GetDisplayProperty(id, &result)) {
+    return result;
+  }
+
+  switch (id) {
+    case Properties::NTP_BACKGROUND_ALIGNMENT:
+      return Properties::ALIGN_CENTER;
+
+    case Properties::NTP_BACKGROUND_TILING:
+      return Properties::NO_REPEAT;
+
+    case Properties::NTP_LOGO_ALTERNATE:
+      return UsingDefaultTheme() || UsingSystemTheme() ||
+                     (!HasCustomImage(IDR_THEME_NTP_BACKGROUND) &&
+                      IsColorGrayscale(
+                          GetColor(Properties::COLOR_NTP_BACKGROUND)))

[pkotwicz, 2015/12/04 23:16:49]

Nit: Alignment looks off

[Evan Stade, 2015/12/09 00:57:10]

in what way? this is the output of git cl format

+                 ? 0
+                 : 1;
+
+    default:
+      return -1;
+  }
+}
+
+bool ThemeService::ShouldUseNativeFrame() const {
+  if (HasCustomImage(IDR_THEME_FRAME))
+    return false;
+#if defined(OS_WIN)
+  return ui::win::IsAeroGlassEnabled();
+#else
+  return false;
+#endif
+}
+
+bool ThemeService::HasCustomImage(int id) const {
+  return BrowserThemePack::IsPersistentImageID(id) && theme_supplier_ &&
+         theme_supplier_->HasCustomImage(id);
+}
+
+base::RefCountedMemory* ThemeService::GetRawData(
+    int id,
+    ui::ScaleFactor scale_factor) const {
+  // Check to see whether we should substitute some images.
+  int ntp_alternate = GetDisplayProperty(Properties::NTP_LOGO_ALTERNATE);
+  if (id == IDR_PRODUCT_LOGO && ntp_alternate != 0)
+    id = IDR_PRODUCT_LOGO_WHITE;
+
+  base::RefCountedMemory* data = nullptr;
+  if (theme_supplier_)
+    data = theme_supplier_->GetRawData(id, scale_factor);
+  if (!data)
+    data = rb_.LoadDataResourceBytesForScale(id, ui::SCALE_FACTOR_100P);
+
+  return data;
+}
+
+gfx::Image ThemeService::GetImageNamed(int id) const {
+  DCHECK(CalledOnValidThread());
+
+  gfx::Image image;
+  if (theme_supplier_)
+    image = theme_supplier_->GetImageNamed(id);
+
+  if (image.IsEmpty())
+    image = rb_.GetNativeImageNamed(id);
+
+  return image;
+}
+
 void ThemeService::OnExtensionServiceReady() {
   if (!ready_) {
     // If the ThemeService is not ready yet, the custom theme data pack needs to
     // be recreated from the extension.
     MigrateTheme();
     set_ready();
 
     // Send notification in case anyone requested data and cached it when the
     // theme service was not ready yet.
     NotifyThemeChanged();
@@ skipping 26 matching lines @@
     content::RecordAction(UserMetricsAction("Themes.Migrated"));
   } else {
     DLOG(ERROR) << "Theme is mysteriously gone.";
     ClearAllThemeData();
     content::RecordAction(UserMetricsAction("Themes.Gone"));
   }
 }
 
 void ThemeService::SwapThemeSupplier(
     scoped_refptr<CustomThemeSupplier> theme_supplier) {
-  if (theme_supplier_.get())
+  if (theme_supplier_)
     theme_supplier_->StopUsingTheme();
   theme_supplier_ = theme_supplier;
-  if (theme_supplier_.get())
+  if (theme_supplier_)
     theme_supplier_->StartUsingTheme();
 }
 
 void ThemeService::SavePackName(const base::FilePath& pack_path) {
   profile_->GetPrefs()->SetFilePath(
       prefs::kCurrentThemePackFilename, pack_path);
 }
 
 void ThemeService::SaveThemeID(const std::string& id) {
   profile_->GetPrefs()->SetString(prefs::kCurrentThemeID, id);
@@ skipping 46 matching lines @@
 void ThemeService::OnInfobarDestroyed() {
   number_of_infobars_--;
 
   if (number_of_infobars_ == 0)
     RemoveUnusedThemes(false);
 }
 
 ThemeSyncableService* ThemeService::GetThemeSyncableService() const {
   return theme_syncable_service_.get();
 }
+
+// static
+const ui::ThemeProvider& ThemeService::GetThemeProviderForProfile(

[pkotwicz, 2015/12/04 23:16:49]

I kind of like the idea of having
ThemeProviderFactory::GetForProfile()

That would require adding accessors to |ThemeService::original_theme_provider_|
and |ThemeService::otr_theme_provider_| to the ThemeService public API.

I will differ to pkasting@ for his opinion

[Evan Stade, 2015/12/09 00:57:11]

hmm, pkasting, wdyt? I like having this factory function be part of
ThemeService. It seems a bit heavyweight (and encapsulation-breaking) to
introduce a whole new class that you have to friend just to implement a single
function.

[Peter Kasting, 2015/12/09 01:31:59]

I don't feel like I care much either way.  The idea of getting the ThemeProvider
from a "theme provider factory" instead of the theme service is sort of
appealing, but mostly on a superficial level; I don't think it makes anything
easier or clearer, really.  So leaving it as you have it seems OK, especially
since it seems like that will be shorter.

+    Profile* profile) {
+  ThemeService* service = ThemeServiceFactory::GetForProfile(profile);
+#if defined(OS_MACOSX)
+  // TODO(estade): this doesn't work for OSX yet; fall back to normal theming
+  // in incognito. Since the OSX version of ThemeService caches colors, and
+  // both ThemeProviders use the same ThemeService some code needs to be
+  // rearranged.
+  bool off_the_record = false;
+#else
+  bool off_the_record = profile->IsOffTheRecord();
+#endif
+  return off_the_record ? service->otr_theme_provider_
+                        : service->original_theme_provider_;
+}
+
+ThemeService::BrowserThemeProvider::BrowserThemeProvider(
+    const ThemeService& theme_service,
+    bool otr)
+    : theme_service_(theme_service), otr_(otr) {}
+
+ThemeService::BrowserThemeProvider::~BrowserThemeProvider() {}
+
+gfx::ImageSkia* ThemeService::BrowserThemeProvider::GetImageSkiaNamed(
+    int id) const {
+  return theme_service_.GetImageSkiaNamed(id);
+}
+
+SkColor ThemeService::BrowserThemeProvider::GetColor(int id) const {
+  int id_for_profile =
+      otr_ ? ThemeProperties::PropertyToIncognitoProperty(id) : id;

[Peter Kasting, 2015/12/08 22:52:58]

Rather than map here, and then map back the other way in
ThemeService::GetColor(), I would make ThemeService::GetColor() take two args, a
color ID and a bool about whether the profile is off the record, and then let it
decide how to map colors based on those params.

[Evan Stade, 2015/12/09 00:57:11]

Done.

+  return theme_service_.GetColor(id_for_profile);
+}
+
+int ThemeService::BrowserThemeProvider::GetDisplayProperty(int id) const {
+  return theme_service_.GetDisplayProperty(id);
+}
+
+bool ThemeService::BrowserThemeProvider::ShouldUseNativeFrame() const {
+  return theme_service_.ShouldUseNativeFrame();
+}
+
+bool ThemeService::BrowserThemeProvider::HasCustomImage(int id) const {
+  return theme_service_.HasCustomImage(id);
+}
+
+base::RefCountedMemory* ThemeService::BrowserThemeProvider::GetRawData(
+    int id,
+    ui::ScaleFactor scale_factor) const {
+  return theme_service_.GetRawData(id, scale_factor);
+}