Simplify handling of BiDi cursor movement

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_
 #pragma once
 
 #include <algorithm>
 #include <vector>
@@ skipping 73 matching lines @@
   LINE_BREAK,
 };
 
 // Horizontal text alignment styles.
 enum HorizontalAlignment {
   ALIGN_LEFT,
   ALIGN_CENTER,
   ALIGN_RIGHT,
 };
 
-// VisualCursorDirection and LogicalCursorDirection represent directions of
-// motion of the cursor in BiDi text. The combinations that make sense are:
-//
-//  base::i18n::TextDirection  VisualCursorDirection  LogicalCursorDirection
-//       LEFT_TO_RIGHT             CURSOR_LEFT           CURSOR_BACKWARD
-//       LEFT_TO_RIGHT             CURSOR_RIGHT          CURSOR_FORWARD
-//       RIGHT_TO_LEFT             CURSOR_RIGHT          CURSOR_BACKWARD
-//       RIGHT_TO_LEFT             CURSOR_LEFT           CURSOR_FORWARD
-enum VisualCursorDirection {
-  CURSOR_LEFT,
-  CURSOR_RIGHT
-};
-enum LogicalCursorDirection {
-  CURSOR_BACKWARD,
-  CURSOR_FORWARD
-};
-
 // 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* CreateRenderText();
 
   const string16& text() const { return text_; }
   void SetText(const string16& text);
 
   HorizontalAlignment horizontal_alignment() const {
     return horizontal_alignment_;
   }
   void SetHorizontalAlignment(HorizontalAlignment alignment);
 
   const FontList& font_list() const { return font_list_; }
   void SetFontList(const FontList& font_list);
 
   // Set the font size to |size| in pixels.
   void SetFontSize(int size);
 
   // Get the first font in |font_list_|.
   const Font& GetFont() const;
 
-  const SelectionModel& selection_model() const { return selection_model_; }
-
   bool cursor_enabled() const { return cursor_enabled_; }
   void SetCursorEnabled(bool cursor_enabled);
 
   bool cursor_visible() const { return cursor_visible_; }
   void set_cursor_visible(bool visible) { cursor_visible_ = visible; }
 
   bool insert_mode() const { return insert_mode_; }
   void ToggleInsertMode();
 
   SkColor cursor_color() const { return cursor_color_; }
@@ skipping 15 matching lines @@
   void set_fade_head(bool fade_head) { fade_head_ = fade_head; }
   bool fade_head() const { return fade_head_; }
   void set_fade_tail(bool fade_tail) { fade_tail_ = fade_tail; }
   bool fade_tail() const { return fade_tail_; }
 
   bool background_is_transparent() const { return background_is_transparent_; }
   void set_background_is_transparent(bool transparent) {
     background_is_transparent_ = transparent;
   }
 
-  // This cursor position corresponds to SelectionModel::selection_end. In
-  // addition to representing the selection end, it's also where logical text
-  // edits take place, and doesn't necessarily correspond to
-  // SelectionModel::caret_pos.
-  size_t GetCursorPosition() const;
+  const SelectionModel& selection_model() const { return selection_model_; }
+
+  const ui::Range& selection() const { return selection_model_.selection(); }
+
+  size_t cursor_position() const { return selection_model_.caret_pos(); }
   void SetCursorPosition(size_t position);
 
   // Moves the cursor left or right. Cursor movement is visual, meaning that
   // left and right are relative to screen, not the directionality of the text.
   // If |select| is false, the selection start is moved to the same position.
   void MoveCursor(BreakType break_type,
                   VisualCursorDirection direction,
                   bool select);
 
   // Set the selection_model_ to the value of |selection|.
-  // The selection model components are modified if invalid.
+  // The selection range is clamped to text().length() if out of range.
   // Returns true if the cursor position or selection range changed.
-  // If |selectin_start_| or |selection_end_| or |caret_pos_| in
-  // |selection_model| is not a cursorable position (not on grapheme boundary),
-  // it is a NO-OP and returns false.
+  // If any index in |selection_model| is not a cursorable position (not on a
+  // grapheme boundary), it is a no-op and returns false.
   bool MoveCursorTo(const SelectionModel& selection_model);
 
   // Move the cursor to the position associated with the clicked point.
   // If |select| is false, the selection start is moved to the same position.
   // Returns true if the cursor position or selection range changed.
   bool MoveCursorTo(const Point& point, bool select);
 
   // Set the selection_model_ based on |range|.
   // If the |range| start or end is greater than text length, it is modified
   // to be the text length.
   // If the |range| start or end is not a cursorable position (not on grapheme
   // boundary), it is a NO-OP and returns false. Otherwise, returns true.
   bool SelectRange(const ui::Range& range);
 
-  size_t GetSelectionStart() const {
-    return selection_model_.selection_start();
-  }
-  size_t MinOfSelection() const {
-    return std::min(GetSelectionStart(), GetCursorPosition());
-  }
-  size_t MaxOfSelection() const {
-    return std::max(GetSelectionStart(), GetCursorPosition());
-  }
-  bool EmptySelection() const {
-    return GetSelectionStart() == GetCursorPosition();
-  }
-
   // Returns true if the local point is over selected text.
   bool IsPointInSelection(const Point& point);
 
   // Selects no text, all text, or the word at the current cursor position.
   void ClearSelection();
   void SelectAll();
   void SelectWord();
 
   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;
 
   // 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();
 
-  // Get the width of the entire string.
-  virtual int GetStringWidth() = 0;
+  // Get the size in pixels of the entire string.
+  virtual Size GetStringSize() = 0;
 
   void Draw(Canvas* canvas);
 
   // Gets the SelectionModel from a visual point in local coordinates.
   virtual SelectionModel FindCursorPosition(const Point& point) = 0;
 
   // Get the visual bounds of a cursor at |selection|. These bounds typically
   // represent a vertical line, but if |insert_mode| is true they contain the
   // bounds of the associated glyph. These bounds are in local coordinates, but
   // may be outside the visible region if the text is longer than the textfield.
   // Subsequent text, cursor, or bounds changes may invalidate returned values.
-  virtual Rect GetCursorBounds(const SelectionModel& selection,
-                               bool insert_mode) = 0;
+  Rect GetCursorBounds(const SelectionModel& selection, bool insert_mode);
 
   // Compute the current cursor bounds, panning the text to show the cursor in
   // the display rect if necessary. These bounds are in local coordinates.
   // Subsequent text, cursor, or bounds changes may invalidate returned values.
   const Rect& GetUpdatedCursorBounds();
 
   // Given an |index| in text(), return the next or previous grapheme boundary
   // in logical order (that is, the nearest index for which
   // |IsCursorablePosition(index)| returns true). The return value is in the
   // range 0 to text().length() inclusive (the input is clamped if it is out of
@@ skipping 30 matching lines @@
       VisualCursorDirection direction) = 0;
 
   // Get the selection model visually left/right of |selection| by one word.
   // The returned value represents a cursor/caret position without a selection.
   virtual SelectionModel AdjacentWordSelectionModel(
       const SelectionModel& selection,
       VisualCursorDirection direction) = 0;
 
   // Get the SelectionModels corresponding to visual text ends.
   // The returned value represents a cursor/caret position without a selection.
-  virtual SelectionModel EdgeSelectionModel(
-      VisualCursorDirection direction) = 0;
+  SelectionModel EdgeSelectionModel(VisualCursorDirection direction);
 
   // Sets the selection model, the argument is assumed to be valid.
   virtual void SetSelectionModel(const SelectionModel& model);
 
-  // Get the visual bounds containing the logical substring within |from| to
-  // |to|. If |from| equals |to|, the result is empty. These bounds could be
-  // visually discontinuous if the substring is split by a LTR/RTL level change.
+  // Get the height and horizontal bounds (relative to the left of the text, not
+  // the view) of the glyph starting at |index|. If the glyph is RTL then
+  // xspan->is_reversed(). This does not return a Rect because a Rect can't have
+  // a negative width.
+  virtual void GetGlyphBounds(size_t index, ui::Range* xspan, int* height) = 0;
+
+  // Get the visual bounds containing the logical substring within the |range|.
+  // If |range| is empty, the result is empty. These bounds could be visually
+  // discontinuous if the substring is split by a LTR/RTL level change.
   // These bounds are in local coordinates, but may be outside the visible
   // region if the text is longer than the textfield. Subsequent text, cursor,
   // or bounds changes may invalidate returned values.
-  virtual std::vector<Rect> GetSubstringBounds(size_t from, size_t to) = 0;
+  virtual std::vector<Rect> GetSubstringBounds(ui::Range range) = 0;
 
   // Return true if cursor can appear in front of the character at |position|,
   // which means it is a grapheme boundary or the first character in the text.
   virtual bool IsCursorablePosition(size_t position) = 0;
 
   // Update the layout so that the next draw request can correctly
   // render the text and its attributes.
   virtual void UpdateLayout() = 0;
 
   // Ensure the text is laid out.
@@ skipping 24 matching lines @@
 
   // Returns display offset based on current text alignment.
   Point GetAlignmentOffset();
 
   // Returns the origin point for drawing text via Skia.
   Point GetOriginForSkiaDrawing();
 
   // Applies fade effects to |renderer|.
   void ApplyFadeEffects(internal::SkiaTextRenderer* renderer);
 
+  // A convenience function to check whether the glyph attached to the caret
+  // is within the given range.
+  static bool RangeContainsCaret(const ui::Range& range,
+                                 size_t caret_pos,
+                                 LogicalCursorDirection caret_affinity);
+
  private:
   friend class RenderTextTest;
 
   FRIEND_TEST_ALL_PREFIXES(RenderTextTest, DefaultStyle);
   FRIEND_TEST_ALL_PREFIXES(RenderTextTest, CustomDefaultStyle);
   FRIEND_TEST_ALL_PREFIXES(RenderTextTest, ApplyStyleRange);
   FRIEND_TEST_ALL_PREFIXES(RenderTextTest, StyleRangesAdjust);
   FRIEND_TEST_ALL_PREFIXES(RenderTextTest, PasswordCensorship);
   FRIEND_TEST_ALL_PREFIXES(RenderTextTest, GraphemePositions);
-  FRIEND_TEST_ALL_PREFIXES(RenderTextTest, SelectionModels);
+  FRIEND_TEST_ALL_PREFIXES(RenderTextTest, EdgeSelectionModels);
   FRIEND_TEST_ALL_PREFIXES(RenderTextTest, OriginForSkiaDrawing);
 
   // Set the cursor to |position|, with the caret trailing the previous
   // grapheme, or if there is no previous grapheme, leading the cursor position.
   // If |select| is false, the selection start is moved to the same position.
   // If the |position| is not a cursorable position (not on grapheme boundary),
   // it is a NO-OP.
   void MoveCursorTo(size_t position, bool select);
 
   // Update the cached bounds and display offset to ensure that the current
@@ skipping 61 matching lines @@
   // The cached bounds and offset are invalidated by changes to the cursor,
   // selection, font, and other operations that adjust the visible text bounds.
   bool cached_bounds_and_offset_valid_;
 
   DISALLOW_COPY_AND_ASSIGN(RenderText);
 };
 
 }  // namespace gfx
 
 #endif  // UI_GFX_RENDER_TEXT_H_