Fixed StyledLabel size caching

ui/views/controls/styled_label.cc

 // Copyright 2013 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/styled_label.h"
 
 #include <vector>
 
 #include "base/strings/string_util.h"
 #include "ui/gfx/font_list.h"
@@ skipping 124 matching lines @@
 }
 
 void StyledLabel::SetLineHeight(int line_height) {
   specified_line_height_ = line_height;
   PreferredSizeChanged();
 }
 
 void StyledLabel::SetDisplayedOnBackgroundColor(SkColor color) {
   displayed_on_background_color_ = color;
   displayed_on_background_color_set_ = true;
+  calculated_size_ = gfx::Size();  // force layout recalculation

[sky, 2014/11/18 18:30:03]

This comment is a bit wrong. It's not a layout calculation you need, but
recreating the children, right?

[edjomin, 2014/11/19 17:04:00]

Yes, you are right. I reset cached size here to force next call to Layout()
recreate all controls. I'll change the comment

 }
 
 gfx::Insets StyledLabel::GetInsets() const {
   gfx::Insets insets = View::GetInsets();
 
   // We need a focus border iff we contain a link that will have a focus border.
   // That in turn will be true only if the link is non-empty.
   for (StyleRanges::const_iterator i(style_ranges_.begin());
         i != style_ranges_.end(); ++i) {
     if (i->style_info.is_link && !i->range.is_empty()) {
       const gfx::Insets focus_border_padding(
           Label::kFocusBorderPadding, Label::kFocusBorderPadding,
           Label::kFocusBorderPadding, Label::kFocusBorderPadding);
       insets += focus_border_padding;
       break;
     }
   }
 
   return insets;
 }
 
 int StyledLabel::GetHeightForWidth(int w) const {
-  if (w != calculated_size_.width()) {
-    // TODO(erg): Munge the const-ness of the style label. CalculateAndDoLayout
-    // doesn't actually make any changes to member variables when |dry_run| is
-    // set to true. In general, the mutating and non-mutating parts shouldn't
-    // be in the same codepath.
-    calculated_size_ =
-        const_cast<StyledLabel*>(this)->CalculateAndDoLayout(w, true);
-  }
-  return calculated_size_.height();
+  // TODO(erg): Munge the const-ness of the style label. CalculateAndDoLayout
+  // doesn't actually make any changes to member variables when |dry_run| is
+  // set to true. In general, the mutating and non-mutating parts shouldn't
+  // be in the same codepath.
+
+  // do not store calculated_size_ for dry_run call.
+  // calculated_size_ should be cached for non-dry calls only,
+  // because they create controls alongside with size calculation
+  // otherwise all caching is useless
+  return const_cast<StyledLabel*>(this)->CalculateAndDoLayout(w, true).height();

[sky, 2014/11/18 18:30:03]

I think we should continue caching here, but make Layout() do a layout if the
size changes.

[edjomin, 2014/11/19 17:04:00]

This was my first idea but it doesn't work this way.  If I cache size here next
call to Layout will not create controls because size remains the same. If I
force controls recreation in Layout() caching becomes useless. I thought this
solution would be better than adding additional member variables. Which solution
is preferable?

Let me describe situation in which I encountered this issue.
I have view with GridLayout that contains StyledLabel. First of all I get one or
two calls to GetHeightForWidth issued by GridLayout when it calculates row
sizes. Then I get series of 4 calls to Layout from different sources. Size is
not changing but each call to Layout removes all child controls and creates them
again. So view appears with noticeable delay.

[sky, 2014/11/19 19:05:51]

Layout and sizing for this class is expensive, so it's likely worth optimizing
both.

I get what you're saying. I'm suggesting you cache both. The last width Layout()
was done at, and calculated_size_ for the last preferred size that was
calculated.

 }
 
 void StyledLabel::Layout() {
   calculated_size_ = CalculateAndDoLayout(GetLocalBounds().width(), false);
 }
 
 void StyledLabel::PreferredSizeChanged() {
   calculated_size_ = gfx::Size();
   View::PreferredSizeChanged();
 }
 
 void StyledLabel::LinkClicked(Link* source, int event_flags) {
   if (listener_)
     listener_->StyledLabelLinkClicked(link_targets_[source], event_flags);
 }
 
 gfx::Size StyledLabel::CalculateAndDoLayout(int width, bool dry_run) {
+  width -= GetInsets().width();
+  if (width == calculated_size_.width())
+    return calculated_size_;
+
   if (!dry_run) {
     RemoveAllChildViews(true);
     link_targets_.clear();
   }
 
-  width -= GetInsets().width();
   if (width <= 0 || text_.empty())
     return gfx::Size();
 
   const int line_height = specified_line_height_ > 0 ? specified_line_height_
       : CalculateLineHeight(font_list_);
   // The index of the line we're on.
   int line = 0;
   // The x position (in pixels) of the line we're on, relative to content
   // bounds.
   int x = 0;
@@ skipping 107 matching lines @@
   }
 
   // The user-specified line height only applies to interline spacing, so the
   // final line's height is unaffected.
   int total_height = line * line_height +
       CalculateLineHeight(font_list_) + GetInsets().height();
   return gfx::Size(width, total_height);
 }
 
 }  // namespace views