Reduce the number of text reshaping in RenderText

ui/gfx/render_text.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/gfx/render_text.h"
 
 #include <algorithm>
 #include <climits>
 
 #include "base/command_line.h"
 #include "base/i18n/break_iterator.h"
 #include "base/logging.h"
 #include "base/stl_util.h"
 #include "base/strings/string_util.h"
 #include "base/strings/utf_string_conversions.h"
+#include "base/trace_event/trace_event.h"
 #include "third_party/icu/source/common/unicode/rbbi.h"
 #include "third_party/icu/source/common/unicode/utf16.h"
 #include "third_party/skia/include/core/SkTypeface.h"
 #include "third_party/skia/include/effects/SkGradientShader.h"
 #include "ui/gfx/canvas.h"
 #include "ui/gfx/geometry/insets.h"
 #include "ui/gfx/geometry/safe_integer_conversions.h"
 #include "ui/gfx/render_text_harfbuzz.h"
 #include "ui/gfx/scoped_canvas.h"
 #include "ui/gfx/skia_util.h"
@@ skipping 430 matching lines @@
 }
 
 void RenderText::SetFontList(const FontList& font_list) {
   font_list_ = font_list;
   const int font_style = font_list.GetFontStyle();
   SetStyle(BOLD, (font_style & gfx::Font::BOLD) != 0);
   SetStyle(ITALIC, (font_style & gfx::Font::ITALIC) != 0);
   SetStyle(UNDERLINE, (font_style & gfx::Font::UNDERLINE) != 0);
   baseline_ = kInvalidBaseline;
   cached_bounds_and_offset_valid_ = false;
-  ResetLayout();
+  OnLayoutTextShapeChanged(false);
 }
 
 void RenderText::SetCursorEnabled(bool cursor_enabled) {
   cursor_enabled_ = cursor_enabled;
   cached_bounds_and_offset_valid_ = false;
 }
 
 void RenderText::ToggleInsertMode() {
   insert_mode_ = !insert_mode_;
   cached_bounds_and_offset_valid_ = false;
@@ skipping 21 matching lines @@
   replace_newline_chars_with_symbols_ = replace;
   cached_bounds_and_offset_valid_ = false;
   UpdateLayoutText();
 }
 
 void RenderText::SetMultiline(bool multiline) {
   if (multiline != multiline_) {
     multiline_ = multiline;
     cached_bounds_and_offset_valid_ = false;
     lines_.clear();
+    OnElidedTextShapeChanged();
   }
 }
 
 void RenderText::SetMinLineHeight(int line_height) {
   if (min_line_height_ == line_height)
     return;
   min_line_height_ = line_height;
   cached_bounds_and_offset_valid_ = false;
   lines_.clear();
+  OnElidedTextShapeChanged();
 }
 
 void RenderText::SetElideBehavior(ElideBehavior elide_behavior) {
   // TODO(skanuj) : Add a test for triggering layout change.
   if (elide_behavior_ != elide_behavior) {
     elide_behavior_ = elide_behavior;
-    UpdateLayoutText();
+    OnElidedTextShapeChanged();
   }
 }
 
 void RenderText::SetDisplayRect(const Rect& r) {
   if (r != display_rect_) {
     display_rect_ = r;
     baseline_ = kInvalidBaseline;
     cached_bounds_and_offset_valid_ = false;
     lines_.clear();
-    if (elide_behavior_ != NO_ELIDE)
-      UpdateLayoutText();
+    if (elide_behavior_ != NO_ELIDE &&
+        elide_behavior_ != FADE_TAIL) {
+      OnElidedTextShapeChanged();
+    }
   }
 }
 
 void RenderText::SetCursorPosition(size_t position) {
   MoveCursorTo(position, false);
 }
 
 void RenderText::MoveCursor(BreakType break_type,
                             VisualCursorDirection direction,
                             bool select) {
@@ skipping 105 matching lines @@
 
 const Range& RenderText::GetCompositionRange() const {
   return composition_range_;
 }
 
 void RenderText::SetCompositionRange(const Range& composition_range) {
   CHECK(!composition_range.IsValid() ||
         Range(0, text_.length()).Contains(composition_range));
   composition_range_.set_end(composition_range.end());
   composition_range_.set_start(composition_range.start());
-  ResetLayout();
+  OnLayoutTextShapeChanged(false);
 }
 
 void RenderText::SetColor(SkColor value) {
   colors_.SetValue(value);
 }
 
 void RenderText::ApplyColor(SkColor value, const Range& range) {
   colors_.ApplyValue(value, range);
 }
 
 void RenderText::SetStyle(TextStyle style, bool value) {
   styles_[style].SetValue(value);
 
   cached_bounds_and_offset_valid_ = false;
-  ResetLayout();
+  OnLayoutTextShapeChanged(false);
 }
 
 void RenderText::ApplyStyle(TextStyle style, bool value, const Range& range) {
   // Do not change styles mid-grapheme to avoid breaking ligatures.
   const size_t start = IsValidCursorIndex(range.start()) ? range.start() :
       IndexOfAdjacentGrapheme(range.start(), CURSOR_BACKWARD);
   const size_t end = IsValidCursorIndex(range.end()) ? range.end() :
       IndexOfAdjacentGrapheme(range.end(), CURSOR_FORWARD);
   styles_[style].ApplyValue(value, Range(start, end));
 
   cached_bounds_and_offset_valid_ = false;
-  ResetLayout();
+  OnLayoutTextShapeChanged(false);
 }
 
 bool RenderText::GetStyle(TextStyle style) const {
   return (styles_[style].breaks().size() == 1) &&
       styles_[style].breaks().front().second;
 }
 
 void RenderText::SetDirectionalityMode(DirectionalityMode mode) {
   if (mode == directionality_mode_)
     return;
 
   directionality_mode_ = mode;
   text_direction_ = base::i18n::UNKNOWN_DIRECTION;
   cached_bounds_and_offset_valid_ = false;
-  ResetLayout();
+  OnLayoutTextShapeChanged(false);
 }
 
 base::i18n::TextDirection RenderText::GetTextDirection() {
   if (text_direction_ == base::i18n::UNKNOWN_DIRECTION) {
     switch (directionality_mode_) {
       case DIRECTIONALITY_FROM_TEXT:
         // Derive the direction from the display text, which differs from text()
         // in the case of obscured (password) textfields.
         text_direction_ =
             base::i18n::GetFirstStrongCharacterDirection(GetLayoutText());
@@ skipping 211 matching lines @@
       selection_background_focused_color_(kDefaultSelectionBackgroundColor),
       focused_(false),
       composition_range_(Range::InvalidRange()),
       colors_(kDefaultColor),
       styles_(NUM_TEXT_STYLES),
       composition_and_selection_styles_applied_(false),
       obscured_(false),
       obscured_reveal_index_(-1),
       truncate_length_(0),
       elide_behavior_(NO_ELIDE),
+      text_elided_(false),
       replace_newline_chars_with_symbols_(true),
       min_line_height_(0),
       multiline_(false),
       background_is_transparent_(false),
       clip_to_display_rect_(true),
       baseline_(kInvalidBaseline),
       cached_bounds_and_offset_valid_(false) {
 }
 
 SelectionModel RenderText::GetAdjacentSelectionModel(
@@ skipping 16 matching lines @@
     return SelectionModel(text().length(), CURSOR_FORWARD);
   return SelectionModel(0, CURSOR_BACKWARD);
 }
 
 void RenderText::SetSelectionModel(const SelectionModel& model) {
   DCHECK_LE(model.selection().GetMax(), text().length());
   selection_model_ = model;
   cached_bounds_and_offset_valid_ = false;
 }
 
-const base::string16& RenderText::GetLayoutText() const {
-  return layout_text_;
+void RenderText::UpdateElidedText(float visual_width) {
+  if (multiline_ ||
+      elide_behavior() == NO_ELIDE ||
+      elide_behavior() == FADE_TAIL ||
+      visual_width < display_rect_.width() ||
+      layout_text_.empty()) {
+    text_elided_ = false;
+    elided_text_.clear();
+    return;
+  }
+
+  // This doesn't trim styles so ellipsis may get rendered as a different
+  // style than the preceding text. See crbug.com/327850.
+  elided_text_.assign(Elide(layout_text_,
+                            visual_width,
+                            static_cast<float>(display_rect_.width()),
+                            elide_behavior_));
+
+  text_elided_ = elided_text_ != layout_text_;
+  if (!text_elided_)
+    elided_text_.clear();
 }
 
 const BreakList<size_t>& RenderText::GetLineBreaks() {
   if (line_breaks_.max() != 0)
     return line_breaks_;
 
   const base::string16& layout_text = GetLayoutText();
   const size_t text_length = layout_text.length();
   line_breaks_.SetValue(0);
   line_breaks_.SetMax(text_length);
@@ skipping 187 matching lines @@
 void RenderText::MoveCursorTo(size_t position, bool select) {
   size_t cursor = std::min(position, text().length());
   if (IsValidCursorIndex(cursor))
     SetSelectionModel(SelectionModel(
         Range(select ? selection().start() : cursor, cursor),
         (cursor == 0) ? CURSOR_FORWARD : CURSOR_BACKWARD));
 }
 
 void RenderText::UpdateLayoutText() {
   layout_text_.clear();
+  elided_text_.clear();
   line_breaks_.SetMax(0);
 
   if (obscured_) {
     size_t obscured_text_length =
         static_cast<size_t>(UTF16IndexToOffset(text_, 0, text_.length()));
     layout_text_.assign(obscured_text_length, kPasswordReplacementChar);
 
     if (obscured_reveal_index_ >= 0 &&
         obscured_reveal_index_ < static_cast<int>(text_.length())) {
       // Gets the index range in |text_| to be revealed.
@@ skipping 28 matching lines @@
       const size_t ellipsis_end = iter.getIndex();
       DCHECK_LE(ellipsis_start, ellipsis_end);
       layout_text_.assign(text.substr(0, ellipsis_start) + kEllipsisUTF16 +
                           text.substr(ellipsis_end));
     } else {
       iter.setIndex32(truncate_length_ - 1);
       layout_text_.assign(text.substr(0, iter.getIndex()) + kEllipsisUTF16);
     }
   }
 
-  if (elide_behavior_ != NO_ELIDE &&
-      elide_behavior_ != FADE_TAIL &&
-      !layout_text_.empty() &&
-      GetContentWidth() > display_rect_.width()) {
-    // This doesn't trim styles so ellipsis may get rendered as a different
-    // style than the preceding text. See crbug.com/327850.
-    layout_text_.assign(Elide(layout_text_,
-                              static_cast<float>(display_rect_.width()),
-                              elide_behavior_));
-  }
-
   // Replace the newline character with a newline symbol in single line mode.
   static const base::char16 kNewline[] = { '\n', 0 };
   static const base::char16 kNewlineSymbol[] = { 0x2424, 0 };
   if (!multiline_ && replace_newline_chars_with_symbols_)
     base::ReplaceChars(layout_text_, kNewline, kNewlineSymbol, &layout_text_);
 
-  ResetLayout();
+  OnLayoutTextShapeChanged(true);
 }
 
 base::string16 RenderText::Elide(const base::string16& text,
+                                 float visual_width,

[msw, 2015/02/12 22:45:06]

nit: match the argument name with the declaration's |text_width|

[oshima, 2015/02/13 00:29:43]

Done.

                                  float available_width,
                                  ElideBehavior behavior) {
   if (available_width <= 0 || text.empty())
     return base::string16();
   if (behavior == ELIDE_EMAIL)
     return ElideEmail(text, available_width);
+  TRACE_EVENT0("ui", "RenderText::Elide");

[Jun Mukai, 2015/02/12 21:56:46]

Is this intentionally added?

[oshima, 2015/02/12 22:09:17]

Yes. This is very expensive operation and I think it's worth showing this in
chrome://tracing.

 
   // Create a RenderText copy with attributes that affect the rendering width.
   scoped_ptr<RenderText> render_text = CreateInstanceOfSameType();
   render_text->SetFontList(font_list_);
   render_text->SetDirectionalityMode(directionality_mode_);
   render_text->SetCursorEnabled(cursor_enabled_);
   render_text->set_truncate_length(truncate_length_);
   render_text->styles_ = styles_;
   render_text->colors_ = colors_;
-  render_text->SetText(text);
-  if (render_text->GetContentWidthF() <= available_width)
+  if (visual_width == 0) {
+    render_text->SetText(text);
+    visual_width = render_text->GetContentWidthF();
+  }
+  if (visual_width <= available_width)

[msw, 2015/02/12 22:45:06]

nit: return at the top if a non-zero visual_width <= available_width

[oshima, 2015/02/13 00:29:43]

Done.

     return text;
 
   const base::string16 ellipsis = base::string16(kEllipsisUTF16);
   const bool insert_ellipsis = (behavior != TRUNCATE);
   const bool elide_in_middle = (behavior == ELIDE_MIDDLE);
   const bool elide_at_beginning = (behavior == ELIDE_HEAD);
+
+  if (insert_ellipsis) {
+    render_text->SetText(ellipsis);
+    const float ellipsis_width = render_text->GetContentWidthF();

[msw, 2015/02/12 22:45:06]

I doubt it, but maybe it'd be helpful to cache the ellipses width?
(I doubt this function is called with repeated layout attributes)

[oshima, 2015/02/13 00:29:43]

The ellipse size depends on the font list, so we can't cache it easily.

+    if (ellipsis_width > available_width)
+      return base::string16();
+  }
+
   StringSlicer slicer(text, ellipsis, elide_in_middle, elide_at_beginning);
 
-  render_text->SetText(ellipsis);
-  const float ellipsis_width = render_text->GetContentWidthF();
-
-  if (insert_ellipsis && (ellipsis_width > available_width))
-    return base::string16();
-
   // Use binary search to compute the elided text.
   size_t lo = 0;
   size_t hi = text.length() - 1;
   const base::i18n::TextDirection text_direction = GetTextDirection();
   for (size_t guess = (lo + hi) / 2; lo <= hi; guess = (lo + hi) / 2) {
     // Restore colors. They will be truncated to size by SetText.
     render_text->colors_ = colors_;
     base::string16 new_text =
         slicer.CutString(guess, insert_ellipsis && behavior != ELIDE_TAIL);
     render_text->SetText(new_text);
@@ skipping 88 matching lines @@
     // Elide the domain so that it only takes half of the available width.
     // Should the username not need all the width available in its half, the
     // domain will occupy the leftover width.
     // If |desired_domain_width| is greater than |available_domain_width|: the
     // minimal username elision allowed by the specifications will not fit; thus
     // |desired_domain_width| must be <= |available_domain_width| at all cost.
     const float desired_domain_width =
         std::min<float>(available_domain_width,
             std::max<float>(available_width - full_username_width,
                             available_width / 2));
-    domain = Elide(domain, desired_domain_width, ELIDE_MIDDLE);
+    domain = Elide(domain, 0, desired_domain_width, ELIDE_MIDDLE);
     // Failing to elide the domain such that at least one character remains
     // (other than the ellipsis itself) remains: return a single ellipsis.
     if (domain.length() <= 1U)
       return base::string16(kEllipsisUTF16);
   }
 
   // Fit the username in the remaining width (at this point the elided username
   // is guaranteed to fit with at least one character remaining given all the
   // precautions taken earlier).
   available_width -= GetStringWidthF(domain, font_list());
-  username = Elide(username, available_width, ELIDE_TAIL);
+  username = Elide(username, 0, available_width, ELIDE_TAIL);
   return username + kAtSignUTF16 + domain;
 }
 
 void RenderText::UpdateCachedBoundsAndOffset() {
   if (cached_bounds_and_offset_valid_)
     return;
 
   // TODO(ckocagil): Add support for scrolling multiline text.
 
   int delta_x = 0;
@@ skipping 10 matching lines @@
     if (cursor_bounds_.right() > display_rect_.right())
       delta_x = display_rect_.right() - cursor_bounds_.right();
     else if (cursor_bounds_.x() < display_rect_.x())
       delta_x = display_rect_.x() - cursor_bounds_.x();
   }
 
   SetDisplayOffset(display_offset_.x() + delta_x);
 }
 
 void RenderText::DrawSelection(Canvas* canvas) {
-  const std::vector<Rect> sel = GetSubstringBounds(selection());
-  for (std::vector<Rect>::const_iterator i = sel.begin(); i < sel.end(); ++i)
-    canvas->FillRect(*i, selection_background_focused_color_);
+  const std::vector<Rect> selections = GetSubstringBounds(selection());

[msw, 2015/02/12 22:45:06]

nit: I think you can inline this in the range-based for loop below without
re-evaluating GetSubStringBounds on each iteration.

[oshima, 2015/02/13 00:29:43]

Done.

+  for (const Rect& s : selections)
+    canvas->FillRect(s, selection_background_focused_color_);
 }
 
 }  // namespace gfx