Prepare to use gfx::RenderText in views::Label.

ui/views/controls/label.h

 // 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.
 
 #ifndef UI_VIEWS_CONTROLS_LABEL_H_
 #define UI_VIEWS_CONTROLS_LABEL_H_
 
-#include <string>
-#include <vector>
-
 #include "base/compiler_specific.h"
 #include "base/gtest_prod_util.h"
-#include "base/strings/string16.h"
-#include "third_party/skia/include/core/SkColor.h"
-#include "ui/gfx/font_list.h"
-#include "ui/gfx/shadow_value.h"
-#include "ui/gfx/text_constants.h"
+#include "base/memory/scoped_vector.h"
+#include "ui/gfx/render_text.h"
 #include "ui/views/view.h"
 
 namespace views {
 
 // A view subclass that can display a string.
 class VIEWS_EXPORT Label : public View {
  public:
   // Internal class name.
   static const char kViewClassName[];
 
   // The padding for the focus border when rendering focused text.
   static const int kFocusBorderPadding;
 
   Label();
   explicit Label(const base::string16& text);
   Label(const base::string16& text, const gfx::FontList& font_list);
   virtual ~Label();
 
   // Gets or sets the fonts used by this label.
-  const gfx::FontList& font_list() const { return font_list_; }
+  const gfx::FontList& font_list() const { return render_text_->font_list(); }
   virtual void SetFontList(const gfx::FontList& font_list);
 
   // Get or set the label text.
-  const base::string16& text() const { return text_; }
+  const base::string16& text() const { return render_text_->text(); }
   virtual void SetText(const base::string16& text);
 
   // Enables or disables auto-color-readability (enabled by default).  If this
   // is enabled, then calls to set any foreground or background color will
   // trigger an automatic mapper that uses color_utils::GetReadableColor() to
   // ensure that the foreground colors are readable over the background color.
   void SetAutoColorReadabilityEnabled(bool enabled);
 
   // Sets the color.  This will automatically force the color to be readable
-  // over the current background color.
+  // over the current background color, if auto color readability is enabled.
   virtual void SetEnabledColor(SkColor color);
   void SetDisabledColor(SkColor color);
 
   SkColor enabled_color() const { return actual_enabled_color_; }
 
   // Sets the background color.  This won't be explicitly drawn, but the label
   // will force the text color to be readable over it.
   void SetBackgroundColor(SkColor color);
   SkColor background_color() const { return background_color_; }
 
   // Set drop shadows underneath the text.
-  void set_shadows(const gfx::ShadowValues& shadows) {
-    shadows_ = shadows;
-    text_size_valid_ = false;
-  }
-  const gfx::ShadowValues& shadows() const { return shadows_; }
+  void SetShadows(const gfx::ShadowValues& shadows);
+  const gfx::ShadowValues& shadows() const { return render_text_->shadows(); }
 
   // Sets whether subpixel rendering is used; the default is true, but this
   // feature also requires an opaque background color.
-  void set_subpixel_rendering_enabled(bool subpixel_rendering_enabled) {
-    subpixel_rendering_enabled_ = subpixel_rendering_enabled;
-  }
+  void SetSubpixelRenderingEnabled(bool subpixel_rendering_enabled);
 
   // Sets the horizontal alignment; the argument value is mirrored in RTL UI.
   void SetHorizontalAlignment(gfx::HorizontalAlignment alignment);
-  gfx::HorizontalAlignment GetHorizontalAlignment() const;
-
-  // Sets the directionality mode. The default value is DIRECTIONALITY_FROM_UI,
-  // which should be suitable for most text originating from UI string assets.
-  // Most text originating from web content should use DIRECTIONALITY_FROM_TEXT.
-  void set_directionality_mode(gfx::DirectionalityMode mode) {
-    directionality_mode_ = mode;
-  }
-  gfx::DirectionalityMode directionality_mode() const {
-    return directionality_mode_;
+  gfx::HorizontalAlignment horizontal_alignment() const {
+    return render_text_->horizontal_alignment();
   }
 
   // Get or set the distance in pixels between baselines of multi-line text.
   // Default is 0, indicating the distance between lines should be the standard
   // one for the label's text, font list, and platform.
   int line_height() const { return line_height_; }
   void SetLineHeight(int height);
 
   // Get or set if the label text can wrap on multiple lines; default is false.
-  bool is_multi_line() const { return is_multi_line_; }
+  bool multi_line() const { return multi_line_; }
   void SetMultiLine(bool multi_line);
 
   // Get or set if the label text should be obscured before rendering (e.g.
   // should "Password!" display as "*********"); default is false.
-  bool is_obscured() const { return is_obscured_; }
+  bool obscured() const { return render_text_->obscured(); }
   void SetObscured(bool obscured);
 
-  // Get the text as displayed to the user, respecting the 'obscured' flag.
-  const base::string16& layout_text() const { return layout_text_; }
-
   // Sets whether the label text can be split on words.
-  // Default is false. This only works when is_multi_line is true.
+  // Default is false. This only works for multi-line text.
   void SetAllowCharacterBreak(bool allow_character_break);
 
   // Sets the eliding or fading behavior, applied as necessary. The default is
-  // to elide at the end. Eliding is not well supported for multi-line labels.
+  // to elide at the end. Eliding is not well-supported for multi-line labels.
   void SetElideBehavior(gfx::ElideBehavior elide_behavior);
+  gfx::ElideBehavior elide_behavior() const { return elide_behavior_; }
 
   // Sets the tooltip text.  Default behavior for a label (single-line) is to
   // show the full text if it is wider than its bounds.  Calling this overrides
   // the default behavior and lets you set a custom tooltip.  To revert to
   // default behavior, call this with an empty string.
   void SetTooltipText(const base::string16& tooltip_text);
 
   // Resizes the label so its width is set to the width of the longest line and
   // its height deduced accordingly.
   // This is only intended for multi-line labels and is useful when the label's
   // text contains several lines separated with \n.
   // |max_width| is the maximum width that will be used (longer lines will be
   // wrapped).  If 0, no maximum width is enforced.
   void SizeToFit(int max_width);
 
-  // Gets/sets the flag to determine whether the label should be collapsed when
-  // it's hidden (not visible). If this flag is true, the label will return a
-  // preferred size of (0, 0) when it's not visible.
+  // Sets whether the preferred size is empty when the label is not visible.
   void set_collapse_when_hidden(bool value) { collapse_when_hidden_ = value; }
-  bool collapse_when_hidden() const { return collapse_when_hidden_; }
+
+  const base::string16& GetLayoutTextForTesting() const;
 
   // View:
   virtual gfx::Insets GetInsets() const OVERRIDE;
   virtual int GetBaseline() const OVERRIDE;
-  // Overridden to compute the size required to display this label.
   virtual gfx::Size GetPreferredSize() const OVERRIDE;
-  // Returns the width of an ellipsis if the label is non-empty, or 0 otherwise.
   virtual gfx::Size GetMinimumSize() const OVERRIDE;
-  // Returns the height necessary to display this label with the provided width.
-  // This method is used to layout multi-line labels. It is equivalent to
-  // GetPreferredSize().height() if the receiver is not multi-line.
   virtual int GetHeightForWidth(int w) const OVERRIDE;
+  virtual void Layout() OVERRIDE;
   virtual const char* GetClassName() const OVERRIDE;
   virtual View* GetTooltipHandlerForPoint(const gfx::Point& point) OVERRIDE;
   virtual bool CanProcessEventsWithinSubtree() const OVERRIDE;
   virtual void GetAccessibleState(ui::AXViewState* state) OVERRIDE;
-  // Gets the tooltip text for labels that are wider than their bounds, except
-  // when the label is multiline, in which case it just returns false (no
-  // tooltip).  If a custom tooltip has been specified with SetTooltipText()
-  // it is returned instead.
   virtual bool GetTooltipText(const gfx::Point& p,
                               base::string16* tooltip) const OVERRIDE;
+  virtual void OnEnabledChanged() OVERRIDE;
 
  protected:
-  // Called by Paint to paint the text.  Override this to change how
-  // text is painted.
-  virtual void PaintText(gfx::Canvas* canvas,
-                         const base::string16& text,
-                         const gfx::Rect& text_bounds,
-                         int flags);
-
-  virtual gfx::Size GetTextSize() const;
+  void PaintText(gfx::Canvas* canvas);
 
   SkColor disabled_color() const { return actual_disabled_color_; }
 
-  // Overridden from View:
-  // Overridden to dirty our text bounds if we're multi-line.
+  // View:
   virtual void OnBoundsChanged(const gfx::Rect& previous_bounds) OVERRIDE;
   virtual void OnPaint(gfx::Canvas* canvas) OVERRIDE;
   virtual void OnNativeThemeChanged(const ui::NativeTheme* theme) OVERRIDE;
 
  private:
-  // These tests call CalculateDrawStringParams in order to verify the
-  // calculations done for drawing text.
-  FRIEND_TEST_ALL_PREFIXES(LabelTest, DrawSingleLineString);
-  FRIEND_TEST_ALL_PREFIXES(LabelTest, DrawMultiLineString);
-  FRIEND_TEST_ALL_PREFIXES(LabelTest, DrawSingleLineStringInRTL);
-  FRIEND_TEST_ALL_PREFIXES(LabelTest, DrawMultiLineStringInRTL);
-  FRIEND_TEST_ALL_PREFIXES(LabelTest, DirectionalityFromText);
-  FRIEND_TEST_ALL_PREFIXES(LabelTest, DisableSubpixelRendering);
-
-  // Sets both |text_| and |layout_text_| to appropriate values, taking
-  // the label's 'obscured' status into account.
-  void SetTextInternal(const base::string16& text);
-
   void Init(const base::string16& text, const gfx::FontList& font_list);
 
+  void ResetLayout();
+
+  // Get the text broken into lines as needed to fit the given |width|.
+  std::vector<base::string16> GetLinesForWidth(int width) const;
+
+  // Get the natural text size, unelided and only wrapped on newlines.
+  gfx::Size GetTextSize() const;
+
   void RecalculateColors();
 
-  // Returns where the text is drawn, in the receivers coordinate system.
-  gfx::Rect GetTextBounds() const;
-
-  int ComputeDrawStringFlags() const;
-
-  gfx::Rect GetAvailableRect() const;
-
-  // Returns parameters to be used for the DrawString call.
-  void CalculateDrawStringParams(base::string16* paint_text,
-                                 gfx::Rect* text_bounds,
-                                 int* flags) const;
-
   // Updates any colors that have not been explicitly set from the theme.
   void UpdateColorsFromTheme(const ui::NativeTheme* theme);
 
-  // Resets |cached_heights_| and |cached_heights_cursor_| and mark
-  // |text_size_valid_| as false.
-  void ResetCachedSize();
-
   bool ShouldShowDefaultTooltip() const;
 
-  base::string16 text_;
-  base::string16 layout_text_;
-  gfx::FontList font_list_;
+  // An un-elided and single-line RenderText object used for preferred sizing.
+  scoped_ptr<gfx::RenderText> render_text_;
+
+  // The RenderText instances used to display elided and multi-line text.
+  ScopedVector<gfx::RenderText> lines_;
+
+  gfx::ElideBehavior elide_behavior_;
+
   SkColor requested_enabled_color_;
   SkColor actual_enabled_color_;
   SkColor requested_disabled_color_;
   SkColor actual_disabled_color_;
   SkColor background_color_;
 
   // Set to true once the corresponding setter is invoked.
   bool enabled_color_set_;
   bool disabled_color_set_;
   bool background_color_set_;
 
   bool subpixel_rendering_enabled_;
   bool auto_color_readability_;
-  mutable gfx::Size text_size_;
-  mutable bool text_size_valid_;
+  base::string16 tooltip_text_;
+  bool collapse_when_hidden_;
+  bool allow_character_break_;
+  bool multi_line_;
   int line_height_;
-  bool is_multi_line_;
-  bool is_obscured_;
-  bool allow_character_break_;
-  gfx::ElideBehavior elide_behavior_;
-  gfx::HorizontalAlignment horizontal_alignment_;
-  base::string16 tooltip_text_;
-  // Whether to collapse the label when it's not visible.
-  bool collapse_when_hidden_;
-  // Controls whether the directionality is auto-detected based on first strong
-  // directionality character or is determined by the application UI's locale.
-  gfx::DirectionalityMode directionality_mode_;
-  gfx::ShadowValues shadows_;
-
-  // The cached heights to avoid recalculation in GetHeightForWidth().
-  mutable std::vector<gfx::Size> cached_heights_;
-  mutable int cached_heights_cursor_;
+  int max_width_;
 
   DISALLOW_COPY_AND_ASSIGN(Label);
 };
 
 }  // namespace views
 
 #endif  // UI_VIEWS_CONTROLS_LABEL_H_