Change chrome:// favicons in tabstrip based on theming.

chrome/browser/ui/views/tabs/tab.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/ui/views/tabs/tab.h"
 
 #include <stddef.h>
 #include <limits>
 #include <utility>
 
 #include "base/command_line.h"
 #include "base/debug/alias.h"
 #include "base/macros.h"
 #include "base/strings/utf_string_conversions.h"
 #include "build/build_config.h"
 #include "chrome/browser/themes/theme_properties.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/layout_constants.h"
 #include "chrome/browser/ui/tab_contents/core_tab_helper.h"
 #include "chrome/browser/ui/tabs/tab_utils.h"
 #include "chrome/browser/ui/view_ids.h"
 #include "chrome/browser/ui/views/tabs/alert_indicator_button.h"
 #include "chrome/browser/ui/views/tabs/tab_controller.h"
 #include "chrome/browser/ui/views/touch_uma/touch_uma.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/grit/generated_resources.h"
 #include "content/public/browser/user_metrics.h"
+#include "content/public/common/url_constants.h"
 #include "grit/components_scaled_resources.h"
 #include "grit/components_strings.h"
 #include "grit/theme_resources.h"
 #include "third_party/skia/include/effects/SkGradientShader.h"
 #include "third_party/skia/include/pathops/SkPathOps.h"
 #include "ui/accessibility/ax_view_state.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/material_design/material_design_controller.h"
 #include "ui/base/models/list_selection_model.h"
 #include "ui/base/resource/resource_bundle.h"
@@ skipping 118 matching lines @@
   void AnimateToState(double state) override {
     const double kHidingOffset =
         Tab::GetMinimumInactiveSize().height() - GetLayoutInsets(TAB).height();
 
     if (state < .5) {
       // Animate the normal icon down.
       target_->SetFaviconHidingOffset(
           static_cast<int>(floor(kHidingOffset * 2.0 * state)));
     } else {
       // Animate the crashed icon up.
-      target_->set_should_display_crashed_favicon();
+      target_->SetShouldDisplayCrashedFavicon(true);
       target_->SetFaviconHidingOffset(
           static_cast<int>(
               floor(kHidingOffset - ((state - .5) * 2.0 * kHidingOffset))));
     }
   }
 
  private:
   Tab* target_;
 
   DISALLOW_COPY_AND_ASSIGN(FaviconCrashAnimation);
@@ skipping 422 matching lines @@
     title = data_.loading ?
         l10n_util::GetStringUTF16(IDS_TAB_LOADING_TITLE) :
         CoreTabHelper::GetDefaultTitle();
   } else {
     Browser::FormatTitleForDisplay(&title);
   }
   title_->SetText(title);
 
   if (!data_.IsCrashed()) {
     crash_icon_animation_->Stop();
-    should_display_crashed_favicon_ = false;
+    SetShouldDisplayCrashedFavicon(false);
     favicon_hiding_offset_ = 0;
   } else if (!should_display_crashed_favicon_ &&
              !crash_icon_animation_->is_animating()) {
     data_.alert_state = TabAlertState::NONE;
     crash_icon_animation_->Start();
   }
 
   if (data_.alert_state != old.alert_state)
     alert_indicator_button_->TransitionToAlertState(data_.alert_state);
 
@@ skipping 351 matching lines @@
     // provided vertical space.
     title_->SetBoundsRect(
         gfx::Rect(title_left, lb.y(), std::max(title_width, 0), lb.height()));
   }
   title_->SetVisible(show_title);
 }
 
 void Tab::OnThemeChanged() {
   LoadTabImages();
   OnButtonColorMaybeChanged();
+  favicon_ = gfx::ImageSkia();
 }
 
 const char* Tab::GetClassName() const {
   return kViewClassName;
 }
 
 bool Tab::GetTooltipText(const gfx::Point& p, base::string16* tooltip) const {
   // Note: Anything that affects the tooltip text should be accounted for when
   // calling TooltipTextChanged() from Tab::DataChanged().
   *tooltip = chrome::AssembleTabTooltipText(data_.title, data_.alert_state);
@@ skipping 162 matching lines @@
   const int ideal_delta = width() - GetPinnedWidth();
   const int ideal_x = (GetPinnedWidth() - bounds->width()) / 2;
   bounds->set_x(
       bounds->x() + static_cast<int>(
           (1 - static_cast<float>(ideal_delta) /
               static_cast<float>(kPinnedTabExtraWidthToRenderAsNormal)) *
           (ideal_x - bounds->x())));
 }
 
 void Tab::DataChanged(const TabRendererData& old) {
+  // Clear the cached themed favicon except in the case of about:crash, which
+  // should go on using the old icon, whatever it was.
+  if (data().url != GURL(content::kChromeUICrashURL))
+    favicon_ = gfx::ImageSkia();

[Peter Kasting, 2016/06/30 00:07:04]

Do we have to clear on every change?  Are there changes that wouldn't change the
favicon, which we can avoid clearing for?

[Evan Stade, 2016/06/30 15:39:45]

I think the answer is yes, but I'm not sure if it's easy to know with certainty
whether we can avoid clearing the cache. In the normal case (non-chrome://
pages) clearing the cache is harmless as there's no computation done during
paint.

In any case, I've changed this check such that it should catch some more cases
where we don't need to reset the cache, which also has the nice side effect of
eliminating this reference to about:crash.

+
   if (data().alert_state != old.alert_state || data().title != old.title)
     TooltipTextChanged();
 
   if (data().blocked == old.blocked)
     return;
 
   if (data().blocked)
     StartPulse();
   else
     StopPulse();
@@ skipping 239 matching lines @@
   // by incrementing by the top padding, since it's a simple rectangle.
   canvas->TileImageInt(*fill_image, x_offset + mask_images_.l_width,
                        y_offset + tab_insets.top(), mask_images_.l_width,
                        tab_insets.top(),
                        width() - mask_images_.l_width - mask_images_.r_width,
                        height() - tab_insets.top() - toolbar_overlap);
 }
 
 void Tab::PaintPinnedTabTitleChangedIndicatorAndIcon(
     gfx::Canvas* canvas,
-    const gfx::ImageSkia& favicon,
     const gfx::Rect& favicon_draw_bounds) {
   // The pinned tab title changed indicator consists of two parts:
   // . a clear (totally transparent) part over the bottom right (or left in rtl)
   //   of the favicon. This is done by drawing the favicon to a canvas, then
   //   drawing the clear part on top of the favicon.
   // . a circle in the bottom right (or left in rtl) of the favicon.
-  if (!favicon.isNull()) {
+  if (!favicon_.isNull()) {
     const float kIndicatorCropRadius = 4.5;
     gfx::Canvas icon_canvas(gfx::Size(gfx::kFaviconSize, gfx::kFaviconSize),
                             canvas->image_scale(), false);
-    icon_canvas.DrawImageInt(favicon, 0, 0);
+    icon_canvas.DrawImageInt(favicon_, 0, 0);
     SkPaint clear_paint;
     clear_paint.setAntiAlias(true);
     clear_paint.setXfermodeMode(SkXfermode::kClear_Mode);
     const int circle_x = base::i18n::IsRTL() ? 0 : gfx::kFaviconSize;
     icon_canvas.DrawCircle(gfx::PointF(circle_x, gfx::kFaviconSize),
                            kIndicatorCropRadius, clear_paint);
     canvas->DrawImageInt(gfx::ImageSkia(icon_canvas.ExtractImageRep()), 0, 0,
                          favicon_draw_bounds.width(),
                          favicon_draw_bounds.height(), favicon_draw_bounds.x(),
                          favicon_draw_bounds.y(), favicon_draw_bounds.width(),
@@ skipping 15 matching lines @@
 }
 
 void Tab::PaintIcon(gfx::Canvas* canvas) {
   gfx::Rect bounds = favicon_bounds_;
   bounds.set_x(GetMirroredXForRect(bounds));
   bounds.Offset(0, favicon_hiding_offset_);
   bounds.Intersect(GetContentsBounds());
   if (bounds.IsEmpty())
     return;
 
-  if (data().network_state != TabRendererData::NETWORK_STATE_NONE) {
-    // Throbber will do its own painting.
+  // Throbber will do its own painting.
+  if (data().network_state != TabRendererData::NETWORK_STATE_NONE)
     return;
+
+  // Ensure that |favicon_| is created.
+  if (favicon_.isNull()) {
+    ui::ResourceBundle* rb = &ui::ResourceBundle::GetSharedInstance();
+    favicon_ = should_display_crashed_favicon_
+                   ? *rb->GetImageSkiaNamed(IDR_CRASH_SAD_FAVICON)
+                   : data().favicon;
+    // Themify the icon if it's a chrome:// page or if it's the sadtab favicon.

[Peter Kasting, 2016/06/30 00:07:04]

Should this share code with the bookmark bar?  Should the two note the existence
of the other?

[Evan Stade, 2016/06/30 15:39:45]

I didn't share code because I didn't see a clear and useful way to do so. The
only shared bits are url.SchemeIs(content::kChromeUIScheme) and the
CreateHSLShiftedImage invocation.

I can add cross-references in comments.

+    if (!favicon_.isNull() &&
+        (should_display_crashed_favicon_ ||
+         (data().url.SchemeIs(content::kChromeUIScheme)) ||
+         favicon_.BackedBySameObjectAs(
+             *rb->GetImageSkiaNamed(IDR_DEFAULT_FAVICON)))) {
+      color_utils::HSL icon_shift =
+          GetThemeProvider()->GetTint(ThemeProperties::TINT_BUTTONS);
+      favicon_ =
+          gfx::ImageSkiaOperations::CreateHSLShiftedImage(favicon_, icon_shift);
+    }
   }
-  const gfx::ImageSkia& favicon =
-      should_display_crashed_favicon_
-          ? *ui::ResourceBundle::GetSharedInstance().GetImageSkiaNamed(
-                IDR_CRASH_SAD_FAVICON)
-          : data().favicon;
 
   if (showing_pinned_tab_title_changed_indicator_ &&
       !should_display_crashed_favicon_) {
-    PaintPinnedTabTitleChangedIndicatorAndIcon(canvas, favicon, bounds);
-  } else if (!favicon.isNull()) {
-    canvas->DrawImageInt(favicon, 0, 0, bounds.width(), bounds.height(),
+    PaintPinnedTabTitleChangedIndicatorAndIcon(canvas, bounds);
+  } else if (!favicon_.isNull()) {
+    canvas->DrawImageInt(favicon_, 0, 0, bounds.width(), bounds.height(),
                          bounds.x(), bounds.y(), bounds.width(),
                          bounds.height(), false);
   }
 }
 
 void Tab::AdvanceLoadingAnimation() {
   const TabRendererData::NetworkState state = data().network_state;
   if (controller_->IsImmersiveStyle()) {
     throbber_->SetVisible(false);
     if (state == TabRendererData::NETWORK_STATE_WAITING) {
@@ skipping 93 matching lines @@
   const double offset =
       is_selected ? (kSelectedTabThrobScale * kHoverOpacity) : kHoverOpacity;
 
   if (pulse_animation_->is_animating())
     val += pulse_animation_->GetCurrentValue() * offset;
   else if (hover_controller_.ShouldDraw())
     val += hover_controller_.GetAnimationValue() * offset;
   return val;
 }
 
+void Tab::SetShouldDisplayCrashedFavicon(bool value) {
+  if (value == should_display_crashed_favicon_)
+    return;
+
+  should_display_crashed_favicon_ = value;
+  favicon_ = gfx::ImageSkia();
+}
+
 void Tab::SetFaviconHidingOffset(int offset) {
   favicon_hiding_offset_ = offset;
   ScheduleIconPaint();
 }
 
 void Tab::OnButtonColorMaybeChanged() {
   // The theme provider may be null if we're not currently in a widget
   // hierarchy.
   const ui::ThemeProvider* theme_provider = GetThemeProvider();
   if (!theme_provider)
@@ skipping 134 matching lines @@
   inactive_images_.image_c = rb.GetImageSkiaNamed(IDR_TAB_INACTIVE_CENTER);
   inactive_images_.image_r = rb.GetImageSkiaNamed(IDR_TAB_INACTIVE_RIGHT);
   inactive_images_.l_width = inactive_images_.image_l->width();
   inactive_images_.r_width = inactive_images_.image_r->width();
 
   mask_images_.image_l = rb.GetImageSkiaNamed(IDR_TAB_ALPHA_LEFT);
   mask_images_.image_r = rb.GetImageSkiaNamed(IDR_TAB_ALPHA_RIGHT);
   mask_images_.l_width = mask_images_.image_l->width();
   mask_images_.r_width = mask_images_.image_r->width();
 }