Add RenderText DirectionalityMode enum and support; etc.

ui/gfx/render_text.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_GFX_RENDER_TEXT_H_
 #define UI_GFX_RENDER_TEXT_H_
 
 #include <algorithm>
 #include <cstring>
 #include <string>
@@ skipping 77 matching lines @@
   ui::Range range;
 };
 
 typedef std::vector<StyleRange> StyleRanges;
 
 // TODO(msw): Distinguish between logical character stops and glyph stops?
 // CHARACTER_BREAK cursor movements should stop at neighboring characters.
 // WORD_BREAK cursor movements should stop at the nearest word boundaries.
 // LINE_BREAK cursor movements should stop at the text ends as shown on screen.
 enum BreakType {
-  CHARACTER_BREAK,
+  CHARACTER_BREAK = 0,

[Alexei Svitkine (slow), 2012/07/27 11:40:36]

Does our style guide require this?

[msw, 2012/07/28 01:17:11]

Not explicitly, but the Google C++ style guide shows both enum examples
specifying at least the first value. The Chromium style guide only shows one
enum example (wrt namespaces) and doesn't supply a value. I think it's optional,
but beneficial; I'll remove it if you disagree.

   WORD_BREAK,
   LINE_BREAK,
 };
 
 // Horizontal text alignment styles.
 enum HorizontalAlignment {
-  ALIGN_LEFT,
+  ALIGN_LEFT = 0,
   ALIGN_CENTER,
   ALIGN_RIGHT,
 };
 
+// The directionality modes used to determine the base text direction.
+enum DirectionalityMode {
+  DERIVE_FROM_TEXT = 0, // Use the first strong character's direction.

[Alexei Svitkine (slow), 2012/07/27 11:40:36]

This is not a good name for an enum entry in the gfx namespace.

gfx::DERIVE_FROM_TEXT doesn't tell me what it's talking about (what is it
deriving from the text?).

I suggest prefixing these names with DIRECTIONALITY_*.

I also dislike that these enums are in render_text.h. Code that uses e.g. Label
shouldn't know about RenderText and include its header.

How about making a gfx_constants.h header file and moving these three enums
there?

[msw, 2012/07/28 01:17:11]

Done (ui/gfx/text_constants.h and "DIRECTIONALITY_*" w/o "DERIVE_").

+  DERIVE_FROM_UI,       // Use the UI's language/locale direction.
+  FORCE_LTR,            // Use LTR regardless of the text content or UI locale.
+  FORCE_RTL,            // Use RTL regardless of the text content or UI locale.
+};
+
 // RenderText represents an abstract model of styled text and its corresponding
 // visual layout. Support is built in for a cursor, a selection, simple styling,
 // complex scripts, and bi-directional text. Implementations provide mechanisms
 // for rendering and translation between logical and visual data.
 class UI_EXPORT RenderText {
  public:
   virtual ~RenderText();
 
   // Creates a platform-specific RenderText instance.
   static RenderText* CreateInstance();
@@ skipping 119 matching lines @@
 
   const ui::Range& GetCompositionRange() const;
   void SetCompositionRange(const ui::Range& composition_range);
 
   // Apply |style_range| to the internal style model.
   void ApplyStyleRange(const StyleRange& style_range);
 
   // Apply |default_style_| over the entire text range.
   void ApplyDefaultStyle();
 
-  // Returns the dominant direction of the current text.
-  virtual base::i18n::TextDirection GetTextDirection() = 0;
+  // Set the text directionality mode and get the text direction yielded.
+  void SetDirectionalityMode(DirectionalityMode mode);
+  base::i18n::TextDirection GetTextDirection();
 
   // Returns the visual movement direction corresponding to the logical end
   // of the text, considering only the dominant direction returned by
   // |GetTextDirection()|, not the direction of a particular run.
   VisualCursorDirection GetVisualDirectionOfLogicalEnd();
 
   // Returns the size in pixels of the entire string. For the height, this will
   // return the maximum height among the different fonts in the text runs.
   // Note that this returns the raw size of the string, which does not include
   // the margin area of text shadows.
@@ skipping 171 matching lines @@
   // Draw the selection and cursor.
   void DrawSelection(Canvas* canvas);
   void DrawCursor(Canvas* canvas);
 
   // Logical UTF-16 string data to be drawn.
   string16 text_;
 
   // Horizontal alignment of the text with respect to |display_rect_|.
   HorizontalAlignment horizontal_alignment_;
 
+  // The text directionality mode, defaults to DERIVE_FROM_TEXT.
+  DirectionalityMode directionality_mode_;
+
+  // The cached text direction, potentially computed from the text or UI locale.
+  base::i18n::TextDirection text_direction_;
+
   // A list of fonts used to render |text_|.
   FontList font_list_;
 
   // Logical selection range and visual cursor position.
   SelectionModel selection_model_;
 
   // The cached cursor bounds; get these bounds with GetUpdatedCursorBounds.
   Rect cursor_bounds_;
 
   // Specifies whether the cursor is enabled. If disabled, no space is reserved
@@ skipping 56 matching lines @@
 
   // Text shadows to be drawn.
   ShadowValues text_shadows_;
 
   DISALLOW_COPY_AND_ASSIGN(RenderText);
 };
 
 }  // namespace gfx
 
 #endif  // UI_GFX_RENDER_TEXT_H_