Cache DrawStringParams in views::Label

ui/views/controls/label.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 "ui/views/controls/label.h"
 
 #include <algorithm>
 #include <cmath>
 #include <limits>
 #include <vector>
@@ skipping 38 matching lines @@
 Label::Label(const base::string16& text, const gfx::FontList& font_list) {
   Init(text, font_list);
 }
 
 Label::~Label() {
 }
 
 void Label::SetFontList(const gfx::FontList& font_list) {
   is_first_paint_text_ = true;
   font_list_ = font_list;
-  ResetCachedSize();
+  ResetLayoutCache();
   PreferredSizeChanged();
   SchedulePaint();
 }
 
 void Label::SetText(const base::string16& text) {
   if (text != text_)
     SetTextInternal(text);
 }
 
 void Label::SetTextInternal(const base::string16& text) {
   is_first_paint_text_ = true;
   text_ = text;
 
   if (obscured_) {
     size_t obscured_text_length =
         static_cast<size_t>(gfx::UTF16IndexToOffset(text_, 0, text_.length()));
     layout_text_.assign(obscured_text_length, kPasswordReplacementChar);
   } else {
     layout_text_ = text_;
   }
 
-  ResetCachedSize();
+  ResetLayoutCache();
   PreferredSizeChanged();
   SchedulePaint();
 }
 
 void Label::SetAutoColorReadabilityEnabled(bool enabled) {
   is_first_paint_text_ = true;
   auto_color_readability_ = enabled;
   RecalculateColors();
 }
 
@@ skipping 15 matching lines @@
   is_first_paint_text_ = true;
   background_color_ = color;
   background_color_set_ = true;
   RecalculateColors();
 }
 
 void Label::SetShadows(const gfx::ShadowValues& shadows) {
   is_first_paint_text_ = true;
   shadows_ = shadows;
   text_size_valid_ = false;
+  cached_draw_params_.reset();

[msw, 2015/01/07 20:35:56]

Maybe just ResetLayoutCache(); here.

[ckocagil, 2015/01/07 22:55:08]

Done.

 }
 
 void Label::SetSubpixelRenderingEnabled(bool subpixel_rendering_enabled) {
   is_first_paint_text_ = true;
   subpixel_rendering_enabled_ = subpixel_rendering_enabled;
 }
 
 void Label::SetHorizontalAlignment(gfx::HorizontalAlignment alignment) {
   is_first_paint_text_ = true;
   // If the UI layout is right-to-left, flip the alignment direction.
@@ skipping 14 matching lines @@
 
   const base::i18n::TextDirection dir =
       base::i18n::GetFirstStrongCharacterDirection(layout_text_);
   return dir == base::i18n::RIGHT_TO_LEFT ? gfx::ALIGN_RIGHT : gfx::ALIGN_LEFT;
 }
 
 void Label::SetLineHeight(int height) {
   is_first_paint_text_ = true;
   if (height != line_height_) {
     line_height_ = height;
-    ResetCachedSize();
+    ResetLayoutCache();
     PreferredSizeChanged();
     SchedulePaint();
   }
 }
 
 void Label::SetMultiLine(bool multi_line) {
   is_first_paint_text_ = true;
   DCHECK(!multi_line || (elide_behavior_ == gfx::ELIDE_TAIL ||
                          elide_behavior_ == gfx::NO_ELIDE));
   if (multi_line != multi_line_) {
     multi_line_ = multi_line;
-    ResetCachedSize();
+    ResetLayoutCache();
     PreferredSizeChanged();
     SchedulePaint();
   }
 }
 
 void Label::SetObscured(bool obscured) {
   is_first_paint_text_ = true;
   if (obscured != obscured_) {
     obscured_ = obscured;
     SetTextInternal(text_);
   }
 }
 
 void Label::SetAllowCharacterBreak(bool allow_character_break) {
   is_first_paint_text_ = true;
   if (allow_character_break != allow_character_break_) {
     allow_character_break_ = allow_character_break;
-    ResetCachedSize();
+    ResetLayoutCache();
     PreferredSizeChanged();
     SchedulePaint();
   }
 }
 
 void Label::SetElideBehavior(gfx::ElideBehavior elide_behavior) {
   is_first_paint_text_ = true;
   DCHECK(!multi_line_ || (elide_behavior_ == gfx::ELIDE_TAIL ||
                           elide_behavior_ == gfx::NO_ELIDE));
   if (elide_behavior != elide_behavior_) {
     elide_behavior_ = elide_behavior;
-    ResetCachedSize();
+    ResetLayoutCache();
     PreferredSizeChanged();
     SchedulePaint();
   }
 }
 
 void Label::SetTooltipText(const base::string16& tooltip_text) {
   DCHECK(handles_tooltips_);
   tooltip_text_ = tooltip_text;
 }
 
@@ skipping 185 matching lines @@
     const gfx::Insets shadow_margin = -gfx::ShadowValue::GetMargin(shadows_);
     text_size_.Enlarge(shadow_margin.width(), shadow_margin.height());
     text_size_valid_ = true;
   }
 
   return text_size_;
 }
 
 void Label::OnBoundsChanged(const gfx::Rect& previous_bounds) {
   text_size_valid_ &= !multi_line_;
+  cached_draw_params_.reset();
 }
 
 void Label::OnPaint(gfx::Canvas* canvas) {
   OnPaintBackground(canvas);
   // We skip painting the focus border because it is being handled seperately by
   // some subclasses of Label. We do not want View's focus border painting to
   // interfere with that.
   OnPaintBorder(canvas);
 
-  base::string16 paint_text;
-  gfx::Rect text_bounds;
-  int flags = 0;
-  CalculateDrawStringParams(&paint_text, &text_bounds, &flags);
+  const DrawStringParams* paint_params = CalculateDrawStringParams();

[msw, 2015/01/07 20:35:56]

nit: |draw_params| or just |params|?

[ckocagil, 2015/01/07 22:55:08]

Done, it's |params| now.

   if (is_first_paint_text_) {
     // TODO(vadimt): Remove ScopedTracker below once crbug.com/431326 is fixed.
     tracked_objects::ScopedTracker tracking_profile(
         FROM_HERE_WITH_EXPLICIT_FUNCTION("431326 Label::PaintText first"));
 
     is_first_paint_text_ = false;
-    PaintText(canvas, paint_text, text_bounds, flags);
+    PaintText(canvas, paint_params->text, paint_params->bounds,
+              paint_params->flags);
   } else {
     // TODO(vadimt): Remove ScopedTracker below once crbug.com/431326 is fixed.
     tracked_objects::ScopedTracker tracking_profile(
         FROM_HERE_WITH_EXPLICIT_FUNCTION("431326 Label::PaintText not first"));
 
-    PaintText(canvas, paint_text, text_bounds, flags);
+    PaintText(canvas, paint_params->text, paint_params->bounds,
+              paint_params->flags);
   }
 }
 
 void Label::OnNativeThemeChanged(const ui::NativeTheme* theme) {
   UpdateColorsFromTheme(theme);
 }
 
 void Label::Init(const base::string16& text, const gfx::FontList& font_list) {
   font_list_ = font_list;
   enabled_color_set_ = disabled_color_set_ = background_color_set_ = false;
   subpixel_rendering_enabled_ = true;
   auto_color_readability_ = true;
   UpdateColorsFromTheme(ui::NativeTheme::instance());
   horizontal_alignment_ = gfx::ALIGN_CENTER;
   line_height_ = 0;
   multi_line_ = false;
   obscured_ = false;
   allow_character_break_ = false;
   elide_behavior_ = gfx::ELIDE_TAIL;
   handles_tooltips_ = true;
   collapse_when_hidden_ = false;
   cached_heights_.resize(kCachedSizeLimit);
-  ResetCachedSize();
+  ResetLayoutCache();
   is_first_paint_text_ = true;
 
   SetText(text);
 }
 
 void Label::RecalculateColors() {
   actual_enabled_color_ = auto_color_readability_ ?
       color_utils::GetReadableColor(requested_enabled_color_,
                                     background_color_) :
       requested_enabled_color_;
@@ skipping 76 matching lines @@
 
   return flags;
 }
 
 gfx::Rect Label::GetAvailableRect() const {
   gfx::Rect bounds(size());
   bounds.Inset(GetInsets());
   return bounds;
 }
 
-void Label::CalculateDrawStringParams(base::string16* paint_text,
-                                      gfx::Rect* text_bounds,
-                                      int* flags) const {
-  DCHECK(paint_text && text_bounds && flags);
+const Label::DrawStringParams* Label::CalculateDrawStringParams() const {
+  if (!cached_draw_params_) {
+    DrawStringParams* paint_params = new DrawStringParams();

[msw, 2015/01/07 20:35:56]

Can you just do cached_draw_params_.reset(new DrawStringParams());?
Otherwise consider |draw_params| or just |params|?

[ckocagil, 2015/01/07 22:55:08]

It's |params| now. |cached_draw_params_| is longer to type, and I'd prefer it to
stay a const pointer.

 
-  const bool forbid_ellipsis = elide_behavior_ == gfx::NO_ELIDE ||
-                               elide_behavior_ == gfx::FADE_TAIL;
-  if (multi_line_ || forbid_ellipsis) {
-    *paint_text = layout_text_;
-  } else {
-    *paint_text = gfx::ElideText(layout_text_, font_list_,
-                                 GetAvailableRect().width(), elide_behavior_);
+    const bool forbid_ellipsis = elide_behavior_ == gfx::NO_ELIDE ||
+        elide_behavior_ == gfx::FADE_TAIL;

[msw, 2015/01/07 20:35:56]

nit: retain relative indent.

[ckocagil, 2015/01/07 22:55:08]

Done.

+    if (multi_line_ || forbid_ellipsis) {
+      paint_params->text = layout_text_;
+    }
+    else {

[msw, 2015/01/07 20:35:56]

nit: else on line above.

[ckocagil, 2015/01/07 22:55:08]

Done.

+      paint_params->text = gfx::ElideText(layout_text_, font_list_,
+          GetAvailableRect().width(), elide_behavior_);
+    }
+
+    paint_params->bounds = GetTextBounds();
+    paint_params->flags = ComputeDrawStringFlags();
+    // TODO(msw): Elide multi-line text with ElideRectangleText instead.
+    if (!multi_line_ || forbid_ellipsis)
+      paint_params->flags |= gfx::Canvas::NO_ELLIPSIS;
+
+    cached_draw_params_.reset(paint_params);
   }
 
-  *text_bounds = GetTextBounds();
-  *flags = ComputeDrawStringFlags();
-  // TODO(msw): Elide multi-line text with ElideRectangleText instead.
-  if (!multi_line_ || forbid_ellipsis)
-    *flags |= gfx::Canvas::NO_ELLIPSIS;
+  return cached_draw_params_.get();
 }
 
 void Label::UpdateColorsFromTheme(const ui::NativeTheme* theme) {
   if (!enabled_color_set_) {
     requested_enabled_color_ = theme->GetSystemColor(
         ui::NativeTheme::kColorId_LabelEnabledColor);
   }
   if (!disabled_color_set_) {
     requested_disabled_color_ = theme->GetSystemColor(
         ui::NativeTheme::kColorId_LabelDisabledColor);
   }
   if (!background_color_set_) {
     background_color_ = theme->GetSystemColor(
         ui::NativeTheme::kColorId_LabelBackgroundColor);
   }
   RecalculateColors();
 }
 
-void Label::ResetCachedSize() {
+void Label::ResetLayoutCache() {
+  cached_draw_params_.reset();
   text_size_valid_ = false;
   cached_heights_cursor_ = 0;
   for (int i = 0; i < kCachedSizeLimit; ++i)
     cached_heights_[i] = gfx::Size();
 }
 
 bool Label::ShouldShowDefaultTooltip() const {
   const gfx::Size text_size = GetTextSize();
   const gfx::Size size = GetContentsBounds().size();
   return !obscured() && (text_size.width() > size.width() ||
                          (multi_line_ && text_size.height() > size.height()));
 }
 
 }  // namespace views