Convert extension action icons code to use ImageSkia instead of SkBitmap

chrome/common/extensions/extension_action.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/common/extensions/extension_action.h"
 
 #include <algorithm>
 
 #include "base/logging.h"
 #include "chrome/common/badge_util.h"
 #include "googleurl/src/gurl.h"
 #include "grit/theme_resources.h"
 #include "grit/ui_resources.h"
 #include "third_party/skia/include/core/SkBitmap.h"
 #include "third_party/skia/include/core/SkCanvas.h"
 #include "third_party/skia/include/core/SkDevice.h"
 #include "third_party/skia/include/core/SkPaint.h"
 #include "third_party/skia/include/effects/SkGradientShader.h"
 #include "ui/base/animation/animation_delegate.h"
 #include "ui/base/resource/resource_bundle.h"
 #include "ui/gfx/canvas.h"
 #include "ui/gfx/color_utils.h"
+#include "ui/gfx/image/canvas_image_source.h"
+#include "ui/gfx/image/image_skia.h"
+#include "ui/gfx/image/image_skia_source.h"
 #include "ui/gfx/rect.h"
+#include "ui/gfx/size.h"
 #include "ui/gfx/image/image_skia_source.h"
 #include "ui/gfx/skbitmap_operations.h"
 
 namespace {
 
 // Different platforms need slightly different constants to look good.
 #if defined(OS_LINUX) && !defined(TOOLKIT_VIEWS)
 const float kTextSize = 9.0;
 const int kBottomMargin = 0;
 const int kPadding = 2;
@@ skipping 15 matching lines @@
 // The padding between the top of the badge and the top of the text.
 const int kTopTextPadding = -1;
 #endif
 
 const int kBadgeHeight = 11;
 const int kMaxTextWidth = 23;
 // The minimum width for center-aligning the badge.
 const int kCenterAlignThreshold = 20;
 
 
-int Width(const gfx::Image& image) {
-  if (image.IsEmpty())
-    return 0;
-  return image.ToSkBitmap()->width();
+int Width(const gfx::ImageSkia& image) {
+  return image.size().width();

[Jeffrey Yasskin, 2012/08/09 21:39:04]

Once this function is a single expression, it's probably worth inlining it to
the single call site.

[tbarzic, 2012/08/10 06:24:08]

Done.

 }
 
 class GetAttentionImageSource : public gfx::ImageSkiaSource {
  public:
-  explicit GetAttentionImageSource(const gfx::Image& icon)
-      : icon_(*icon.ToImageSkia()) {}
+  explicit GetAttentionImageSource(const gfx::ImageSkia& icon)
+      : icon_(icon) {}
 
   // gfx::ImageSkiaSource overrides:
   virtual gfx::ImageSkiaRep GetImageForScale(ui::ScaleFactor scale_factor)
       OVERRIDE {
     gfx::ImageSkiaRep icon_rep = icon_.GetRepresentation(scale_factor);
     color_utils::HSL shift = {-1, 0, 0.5};
     return gfx::ImageSkiaRep(
         SkBitmapOperations::CreateHSLShiftedBitmap(icon_rep.sk_bitmap(), shift),
         icon_rep.scale_factor());
   }
@@ skipping 29 matching lines @@
     Done();
   }
 
   void Done() {
     delete this;
   }
 
   IconAnimation animation_;
 };
 
+// TODO(tbarzic): Merge AnimationIconImageSource and IconAnimation together.
+// Source for painting animated skia image.
+class ExtensionAction::AnimatedIconImageSource : public gfx::ImageSkiaSource {
+ public:
+  AnimatedIconImageSource(const gfx::ImageSkia& image,
+                          IconAnimationWrapper* animation)
+      : image_(image),
+        animation_(animation->AsWeakPtr()) {
+  }
+
+ private:
+  virtual ~AnimatedIconImageSource() {}
+
+  virtual gfx::ImageSkiaRep GetImageForScale(ui::ScaleFactor scale) OVERRIDE {
+    gfx::ImageSkiaRep original_rep = image_.GetRepresentation(scale);
+    if (!animation_)
+      return original_rep;
+
+    // Original representation's scale factor may be different from scale

[Jeffrey Yasskin, 2012/08/09 21:39:04]

It would be nice if CanvasImageSource supported this use case. Not something to
do in this CL, of course.

[tbarzic, 2012/08/10 06:24:08]

yep.. TODO already added :)

+    // factor passed to this method. We want to use the former (since we are
+    // using bitmap for that scale).
+    return gfx::ImageSkiaRep(
+        animation_->animation()->Apply(original_rep.sk_bitmap()),
+        original_rep.scale_factor());
+  }
+
+  gfx::ImageSkia image_;
+  base::WeakPtr<IconAnimationWrapper> animation_;
+
+  DISALLOW_COPY_AND_ASSIGN(AnimatedIconImageSource);
+};
+
+// CanvasImageSource for creating browser action icon with a badge.
+class ExtensionAction::IconWithBadgeImageSource
+    : public gfx::CanvasImageSource {
+ public:
+  IconWithBadgeImageSource(const gfx::ImageSkia& icon,
+                           const gfx::Size& spacing,
+                           const std::string& text,
+                           const SkColor& text_color,
+                           const SkColor& background_color)
+      : gfx::CanvasImageSource(icon.size(), false),
+        icon_(icon),
+        spacing_(spacing),
+        text_(text),
+        text_color_(text_color),
+        background_color_(background_color) {
+  }
+
+  virtual ~IconWithBadgeImageSource() {}
+
+ private:
+  virtual void Draw(gfx::Canvas* canvas) OVERRIDE {
+    canvas->DrawImageInt(icon_, 0, 0, SkPaint());
+
+    gfx::Rect bounds(size_.width() + spacing_.width(),
+                     size_.height() + spacing_.height());
+
+    // Draw a badge on the provided browser action icon's canvas.
+    ExtensionAction::DoPaintBadge(canvas, bounds, text_, text_color_,
+        background_color_, size_.width());
+  }
+
+  // Browser action icon image.
+  gfx::ImageSkia icon_;
+  // Extra spacing for badge compared to icon bounds.
+  gfx::Size spacing_;
+  // Text to be displayed on the badge.
+  std::string text_;
+  // Color of badge text.
+  SkColor text_color_;
+  // Color of the badge.
+  SkColor background_color_;
+
+  DISALLOW_COPY_AND_ASSIGN(IconWithBadgeImageSource);
+};
+
+
 const int ExtensionAction::kDefaultTabId = -1;
 
 ExtensionAction::IconAnimation::IconAnimation(
     ui::AnimationDelegate* delegate)
     // 100ms animation at 50fps (so 5 animation frames in total).
     : ui::LinearAnimation(100, 50, delegate) {}
 
 ExtensionAction::IconAnimation::~IconAnimation() {}
 
 const SkBitmap& ExtensionAction::IconAnimation::Apply(
@@ skipping 84 matching lines @@
   return !GetPopupUrl(tab_id).is_empty();
 }
 
 GURL ExtensionAction::GetPopupUrl(int tab_id) const {
   return GetValue(&popup_url_, tab_id);
 }
 
 void ExtensionAction::CacheIcon(const std::string& path,
                                 const gfx::Image& icon) {
   if (!icon.IsEmpty())
-    path_to_icon_cache_.insert(std::make_pair(path, icon));
+    path_to_icon_cache_.insert(std::make_pair(path, *icon.ToImageSkia()));
 }
 
-void ExtensionAction::SetIcon(int tab_id, const SkBitmap& bitmap) {
-  SetValue(&icon_, tab_id, gfx::Image(bitmap));
+void ExtensionAction::SetIcon(int tab_id, const gfx::Image& image) {
+  SetValue(&icon_, tab_id, *image.ToImageSkia());
 }
 
 gfx::Image ExtensionAction::GetIcon(int tab_id) const {
   // Check if a specific icon is set for this tab.
-  gfx::Image icon = GetValue(&icon_, tab_id);
-  if (icon.IsEmpty()) {
+  gfx::ImageSkia icon = GetValue(&icon_, tab_id);
+  if (icon.empty()) {
     // Need to find an icon from a path.
     const std::string* path = NULL;
     // Check if one of the elements of icon_path() was selected.
     int icon_index = GetIconIndex(tab_id);
     if (icon_index >= 0) {
       path = &icon_paths()->at(icon_index);
     } else {
       // Otherwise, use the default icon.
       path = &default_icon_path();
     }
 
-    std::map<std::string, gfx::Image>::const_iterator cached_icon =
+    std::map<std::string, gfx::ImageSkia>::const_iterator cached_icon =
         path_to_icon_cache_.find(*path);
     if (cached_icon != path_to_icon_cache_.end()) {
       icon = cached_icon->second;
     } else {
-      icon = ui::ResourceBundle::GetSharedInstance().GetImageNamed(
+      icon = *ui::ResourceBundle::GetSharedInstance().GetImageSkiaNamed(
           IDR_EXTENSIONS_FAVICON);
     }
   }
 
-  if (GetValue(&appearance_, tab_id) == WANTS_ATTENTION) {
-    icon = gfx::Image(gfx::ImageSkia(new GetAttentionImageSource(icon),
-                                     icon.ToImageSkia()->size()));
-  }
+  if (GetValue(&appearance_, tab_id) == WANTS_ATTENTION)
+    icon = gfx::ImageSkia(new GetAttentionImageSource(icon), icon.size());
 
-  return ApplyIconAnimation(tab_id, icon);
+  return gfx::Image(ApplyIconAnimation(tab_id, icon));
 }
 
 void ExtensionAction::SetIconIndex(int tab_id, int index) {
   if (static_cast<size_t>(index) >= icon_paths_.size()) {
     NOTREACHED();
     return;
   }
   SetValue(&icon_index_, tab_id, index);
 }
 
@@ skipping 22 matching lines @@
   badge_text_.erase(tab_id);
   badge_text_color_.erase(tab_id);
   badge_background_color_.erase(tab_id);
   appearance_.erase(tab_id);
   icon_animation_.erase(tab_id);
 }
 
 void ExtensionAction::PaintBadge(gfx::Canvas* canvas,
                                  const gfx::Rect& bounds,
                                  int tab_id) {
-  std::string text = GetBadgeText(tab_id);
+  ExtensionAction::DoPaintBadge(
+      canvas,
+      bounds,
+      GetBadgeText(tab_id),
+      GetBadgeTextColor(tab_id),
+      GetBadgeBackgroundColor(tab_id),
+      Width(GetValue(&icon_, tab_id)));
+}
+
+gfx::ImageSkia ExtensionAction::GetIconWithBadge(
+    const gfx::ImageSkia& icon,
+    int tab_id,
+    const gfx::Size& spacing) const {
+  if (tab_id < 0)
+    return icon;
+
+  return gfx::ImageSkia(
+      new IconWithBadgeImageSource(icon,
+                                   spacing,
+                                   GetBadgeText(tab_id),
+                                   GetBadgeTextColor(tab_id),
+                                   GetBadgeBackgroundColor(tab_id)),
+     icon.size());
+}
+
+// static
+void ExtensionAction::DoPaintBadge(gfx::Canvas* canvas,
+                                   const gfx::Rect& bounds,
+                                   const std::string& text,
+                                   const SkColor& text_color_in,
+                                   const SkColor& background_color_in,
+                                   int icon_width) {
   if (text.empty())
     return;
 
-  SkColor text_color = GetBadgeTextColor(tab_id);
-  SkColor background_color = GetBadgeBackgroundColor(tab_id);
+  SkColor text_color = (SkColorGetA(text_color_in) == 0x00) ?

[Jeffrey Yasskin, 2012/08/09 21:39:04]

Interesting. I would probably have kept the if statements, since I find ternary
operators harder to read, but it's not a big deal.

[tbarzic, 2012/08/10 06:24:08]

Done.

+      SK_ColorWHITE : text_color_in;
 
-  if (SkColorGetA(text_color) == 0x00)
-    text_color = SK_ColorWHITE;
-
-  if (SkColorGetA(background_color) == 0x00)
-    background_color = SkColorSetARGB(255, 218, 0, 24);  // Default badge color.
+  SkColor background_color = (SkColorGetA(background_color_in) == 0x00) ?
+      SkColorSetARGB(255, 218, 0, 24) : background_color_in;
 
   canvas->Save();
 
   SkPaint* text_paint = badge_util::GetBadgeTextPaintSingleton();
   text_paint->setTextSize(SkFloatToScalar(kTextSize));
   text_paint->setColor(text_color);
 
   // Calculate text width. We clamp it to a max size.
-  SkScalar text_width = text_paint->measureText(text.c_str(), text.size());
-  text_width = SkIntToScalar(
-      std::min(kMaxTextWidth, SkScalarFloor(text_width)));
+  SkScalar sk_text_width = text_paint->measureText(text.c_str(), text.size());
+  int text_width = std::min(kMaxTextWidth, SkScalarFloor(sk_text_width));
 
   // Calculate badge size. It is clamped to a min width just because it looks
   // silly if it is too skinny.
-  int badge_width = SkScalarFloor(text_width) + kPadding * 2;
-  int icon_width = Width(GetValue(&icon_, tab_id));
+  int badge_width = text_width + kPadding * 2;
   // Force the pixel width of badge to be either odd (if the icon width is odd)
   // or even otherwise. If there is a mismatch you get http://crbug.com/26400.
   if (icon_width != 0 && (badge_width % 2 != icon_width % 2))
     badge_width += 1;
   badge_width = std::max(kBadgeHeight, badge_width);
 
   // Paint the badge background color in the right location. It is usually
   // right-aligned, but it can also be center-aligned if it is large.
-  SkRect rect;
-  rect.fBottom = SkIntToScalar(bounds.bottom() - kBottomMargin);
-  rect.fTop = rect.fBottom - SkIntToScalar(kBadgeHeight);
-  if (badge_width >= kCenterAlignThreshold) {
-    rect.fLeft = SkIntToScalar(
-                     SkScalarFloor(SkIntToScalar(bounds.x()) +
-                                   SkIntToScalar(bounds.width()) / 2 -
-                                   SkIntToScalar(badge_width) / 2));
-    rect.fRight = rect.fLeft + SkIntToScalar(badge_width);
-  } else {
-    rect.fRight = SkIntToScalar(bounds.right());
-    rect.fLeft = rect.fRight - badge_width;
-  }
+  int rect_height = kBadgeHeight;
+  int rect_y = bounds.bottom() - kBottomMargin - kBadgeHeight;
+  int rect_width = badge_width;
+  int rect_x = (badge_width >= kCenterAlignThreshold) ?
+      (bounds.x() + bounds.width()) / 2 - badge_width / 2 :
+      bounds.right() - badge_width;
+  gfx::Rect rect(rect_x, rect_y, rect_width, rect_height);
 
   SkPaint rect_paint;
   rect_paint.setStyle(SkPaint::kFill_Style);
   rect_paint.setAntiAlias(true);
   rect_paint.setColor(background_color);
-  canvas->sk_canvas()->drawRoundRect(rect, SkIntToScalar(2),
-                                     SkIntToScalar(2), rect_paint);
+  canvas->DrawRoundRect(rect, 2, rect_paint);
 
   // Overlay the gradient. It is stretchy, so we do this in three parts.
   ui::ResourceBundle& rb = ui::ResourceBundle::GetSharedInstance();
-  SkBitmap* gradient_left = rb.GetBitmapNamed(IDR_BROWSER_ACTION_BADGE_LEFT);
-  SkBitmap* gradient_right = rb.GetBitmapNamed(IDR_BROWSER_ACTION_BADGE_RIGHT);
-  SkBitmap* gradient_center = rb.GetBitmapNamed(
+  gfx::ImageSkia* gradient_left = rb.GetImageSkiaNamed(
+      IDR_BROWSER_ACTION_BADGE_LEFT);
+  gfx::ImageSkia* gradient_right = rb.GetImageSkiaNamed(
+      IDR_BROWSER_ACTION_BADGE_RIGHT);
+  gfx::ImageSkia* gradient_center = rb.GetImageSkiaNamed(
       IDR_BROWSER_ACTION_BADGE_CENTER);
 
-  canvas->sk_canvas()->drawBitmap(*gradient_left, rect.fLeft, rect.fTop);
+  canvas->DrawImageInt(*gradient_left, rect.x(), rect.y());
   canvas->TileImageInt(*gradient_center,
-      SkScalarFloor(rect.fLeft) + gradient_left->width(),
-      SkScalarFloor(rect.fTop),
-      SkScalarFloor(rect.width()) - gradient_left->width() -
-                    gradient_right->width(),
-      SkScalarFloor(rect.height()));
-  canvas->sk_canvas()->drawBitmap(*gradient_right,
-      rect.fRight - SkIntToScalar(gradient_right->width()), rect.fTop);
+      rect.x() + gradient_left->width(),
+      rect.y(),
+      rect.width() - gradient_left->width() - gradient_right->width(),
+      rect.height());
+  canvas->DrawImageInt(*gradient_right,
+      rect.right() - gradient_right->width(), rect.y());
 
   // Finally, draw the text centered within the badge. We set a clip in case the
   // text was too large.
-  rect.fLeft += kPadding;
-  rect.fRight -= kPadding;
-  canvas->sk_canvas()->clipRect(rect);
+  rect.Inset(kPadding, 0);
+  canvas->ClipRect(rect);
   canvas->sk_canvas()->drawText(text.c_str(), text.size(),
-                                rect.fLeft + (rect.width() - text_width) / 2,
-                                rect.fTop + kTextSize + kTopTextPadding,
+                                rect.x() + (rect.width() - text_width) / 2,
+                                rect.y() + kTextSize + kTopTextPadding,
                                 *text_paint);
   canvas->Restore();
 }
 
 ExtensionAction::IconAnimationWrapper* ExtensionAction::GetIconAnimationWrapper(
     int tab_id) const {
   std::map<int, base::WeakPtr<IconAnimationWrapper> >::iterator it =
       icon_animation_.find(tab_id);
   if (it == icon_animation_.end())
     return NULL;
@@ skipping 14 matching lines @@
   return NULL;
 }
 
 base::WeakPtr<ExtensionAction::IconAnimation> ExtensionAction::GetIconAnimation(
     int tab_id) const {
   IconAnimationWrapper* wrapper = GetIconAnimationWrapper(tab_id);
   return wrapper ? wrapper->animation()->AsWeakPtr()
       : base::WeakPtr<IconAnimation>();
 }
 
-gfx::Image ExtensionAction::ApplyIconAnimation(int tab_id,
-                                               const gfx::Image& orig) const {
-  IconAnimationWrapper* wrapper = GetIconAnimationWrapper(tab_id);
-  if (wrapper == NULL)
-    return orig;
-  return gfx::Image(wrapper->animation()->Apply(*orig.ToSkBitmap()));
+gfx::ImageSkia ExtensionAction::ApplyIconAnimation(
+    int tab_id,
+    const gfx::ImageSkia& icon) const {
+  IconAnimationWrapper* animation_wrapper = GetIconAnimationWrapper(tab_id);
+  if (animation_wrapper == NULL)
+    return icon;
+
+  return gfx::ImageSkia(new AnimatedIconImageSource(icon, animation_wrapper),
+                        icon.size());
 }
 
 void ExtensionAction::RunIconAnimation(int tab_id) {
   IconAnimationWrapper* icon_animation =
       new IconAnimationWrapper();
   icon_animation_[tab_id] = icon_animation->AsWeakPtr();
   icon_animation->animation()->Start();
 }