modification to RenderText for inheritance/SelectionModel

ui/gfx/render_text.cc

Index: ui/gfx/render_text.cc
===================================================================
--- ui/gfx/render_text.cc	(revision 95245)
+++ ui/gfx/render_text.cc	(working copy)
@@ -11,6 +11,7 @@
 #include "base/stl_util.h"
 #include "ui/gfx/canvas.h"
 #include "ui/gfx/canvas_skia.h"
+#include "unicode/uchar.h"
 
 namespace {
 
@@ -38,26 +39,26 @@
 }
 #endif
 
-void ApplyStyleRangeImpl(gfx::StyleRanges& style_ranges,
+void ApplyStyleRangeImpl(gfx::StyleRanges* style_ranges,
                          gfx::StyleRange style_range) {
   const ui::Range& new_range = style_range.range;
   // Follow StyleRanges invariant conditions: sorted and non-overlapping ranges.
   gfx::StyleRanges::iterator i;
-  for (i = style_ranges.begin(); i != style_ranges.end();) {
+  for (i = style_ranges->begin(); i != style_ranges->end();) {
     if (i->range.end() < new_range.start()) {
       i++;
     } else if (i->range.start() == new_range.end()) {
       break;
     } else if (new_range.Contains(i->range)) {
-      i = style_ranges.erase(i);
-      if (i == style_ranges.end())
+      i = style_ranges->erase(i);
+      if (i == style_ranges->end())
         break;
     } else if (i->range.start() < new_range.start() &&
                i->range.end() > new_range.end()) {
       // Split the current style into two styles.
       gfx::StyleRange split_style = gfx::StyleRange(*i);
       split_style.range.set_end(new_range.start());
-      i = style_ranges.insert(i, split_style) + 1;
+      i = style_ranges->insert(i, split_style) + 1;
       i->range.set_start(new_range.end());
       break;
     } else if (i->range.start() < new_range.start()) {
@@ -70,7 +71,7 @@
       NOTREACHED();
   }
   // Add the new range in its sorted location.
-  style_ranges.insert(i, style_range);
+  style_ranges->insert(i, style_range);
 }
 
 }  // namespace
@@ -85,6 +86,45 @@
       range() {
 }
 
+SelectionModel::SelectionModel() {
+  Init(0, 0, 0, PREVIOUS_GRAPHEME_TRAILING);
+}
+
+SelectionModel::SelectionModel(size_t pos) {
+  Init(pos, pos, pos, PREVIOUS_GRAPHEME_TRAILING);
+}
+
+SelectionModel::SelectionModel(size_t end, size_t pos,
+                               CaretPlacement placement) {

[msw, 2011/08/03 23:44:38]

If the arguments don't all fit on one line, they'll have to be each on their own
line, like ApplyStyleRangeImpl.

[xji, 2011/08/04 06:26:50]

Done.

+  Init(end, end, pos, placement);
+}
+
+SelectionModel::SelectionModel(size_t start, size_t end, size_t pos,

[msw, 2011/08/03 23:44:38]

ditto (args on new lines)

[xji, 2011/08/04 06:26:50]

Done.

+                               CaretPlacement placement) {
+  Init(start, end, pos, placement);
+}
+
+SelectionModel::~SelectionModel() {
+}
+
+bool SelectionModel::Equals(const SelectionModel& sel) const {
+  return selection_start_ == sel.selection_start()

[msw, 2011/08/03 23:44:38]

&& goes on the end of the line.

[xji, 2011/08/04 06:26:50]

Done.

+         && selection_end_ == sel.selection_end()
+         && caret_pos_ == sel.caret_pos()
+         && caret_placement_ == sel.caret_placement();
+}
+
+void SelectionModel::Init(size_t start, size_t end, size_t pos,

[msw, 2011/08/03 23:44:38]

ditto (args on new lines)

[xji, 2011/08/04 06:26:50]

Done.

+                          CaretPlacement placement) {
+  selection_start_ = start;
+  selection_end_ = end;
+  caret_pos_ = pos;
+  caret_placement_ = placement;
+}
+
+RenderText::~RenderText() {
+}
+
 void RenderText::SetText(const string16& text) {
   size_t old_text_length = text_.length();
   text_ = text;
@@ -114,119 +154,127 @@
 #endif
 }
 
+void RenderText::SetSelectionModel(const SelectionModel& sel) {
+  size_t start = sel.selection_start();
+  size_t end = sel.selection_end();
+  selection_model_.set_selection_start(std::min(start, text().length()));
+  selection_model_.set_selection_end(std::min(end, text().length()));
+  selection_model_.set_caret_pos(std::min(sel.caret_pos(), text().length()));
+  selection_model_.set_caret_placement(sel.caret_placement());
+
+  cursor_bounds_valid_ = false;
+}
+
+
 size_t RenderText::GetCursorPosition() const {
-  return GetSelection().end();
+  return selection_model_.selection_end();
 }

[msw, 2011/08/03 23:44:38]

Add a blank line between these function definitions.

[xji, 2011/08/04 06:26:50]

Done.

-
 void RenderText::SetCursorPosition(const size_t position) {
-  SetSelection(ui::Range(position, position));
+  SelectionModel sel(selection_model());
+  sel.set_selection_start(position);
+  sel.set_selection_end(position);
+  SetSelectionModel(sel);
 }
 
 void RenderText::MoveCursorLeft(BreakType break_type, bool select) {
   if (break_type == LINE_BREAK) {
-    MoveCursorTo(0, select);
+    SelectionModel selection(GetSelectionStart(), 0,
+                             0, SelectionModel::LEADING);
+    if (!select)
+      selection.set_selection_start(selection.selection_end());
+    MoveCursorTo(selection);
     return;
   }
-  size_t position = GetCursorPosition();
+  SelectionModel position = selection_model_;
   // Cancelling a selection moves to the edge of the selection.
-  if (!GetSelection().is_empty() && !select) {
+  if (!EmptySelection() && !select) {
     // Use the selection start if it is left of the selection end.
-    if (GetCursorBounds(GetSelection().start(), false).x() <
+    SelectionModel selection_start(GetSelectionStart(), GetSelectionStart(),
+        GetSelectionStart(), SelectionModel::LEADING);
+    if (GetCursorBounds(selection_start, false).x() <
         GetCursorBounds(position, false).x())
-      position = GetSelection().start();
+      position = selection_start;
     // If |move_by_word|, use the nearest word boundary left of the selection.
     if (break_type == WORD_BREAK)
       position = GetLeftCursorPosition(position, true);
   } else {
     position = GetLeftCursorPosition(position, break_type == WORD_BREAK);
   }
-  MoveCursorTo(position, select);
+  if (!select)
+    position.set_selection_start(position.selection_end());
+  MoveCursorTo(position);
 }
 
 void RenderText::MoveCursorRight(BreakType break_type, bool select) {
   if (break_type == LINE_BREAK) {
-    MoveCursorTo(text().length(), select);
+    SelectionModel selection(GetSelectionStart(), text().length(),
+        text().length(), SelectionModel::PREVIOUS_GRAPHEME_TRAILING);
+    if (!select)
+      selection.set_selection_start(selection.selection_end());
+    MoveCursorTo(selection);
     return;
   }
-  size_t position = GetCursorPosition();
+  SelectionModel position = selection_model_;
   // Cancelling a selection moves to the edge of the selection.
-  if (!GetSelection().is_empty() && !select) {
+  if (!EmptySelection() && !select) {
     // Use the selection start if it is right of the selection end.
-    if (GetCursorBounds(GetSelection().start(), false).x() >
+    SelectionModel selection_start(GetSelectionStart(), GetSelectionStart(),
+        GetSelectionStart(), SelectionModel::LEADING);
+    if (GetCursorBounds(selection_start, false).x() >
         GetCursorBounds(position, false).x())
-      position = GetSelection().start();
+      position = selection_start;
     // If |move_by_word|, use the nearest word boundary right of the selection.
     if (break_type == WORD_BREAK)
       position = GetRightCursorPosition(position, true);
   } else {
     position = GetRightCursorPosition(position, break_type == WORD_BREAK);
   }
-  MoveCursorTo(position, select);
+  if (!select)
+    position.set_selection_start(position.selection_end());
+  MoveCursorTo(position);
 }
 
-bool RenderText::MoveCursorTo(size_t position, bool select) {
-  bool changed = GetCursorPosition() != position ||
-                 select == GetSelection().is_empty();
-  if (select)
-    SetSelection(ui::Range(GetSelection().start(), position));
-  else
-    SetSelection(ui::Range(position, position));
+bool RenderText::MoveCursorTo(const SelectionModel& selection) {
+  bool changed = !selection.Equals(selection_model_);
+  SetSelectionModel(selection);
   return changed;
 }
 
 bool RenderText::MoveCursorTo(const Point& point, bool select) {
-  // TODO(msw): Make this function support cursor placement via mouse near BiDi
-  //  level changes. The visual cursor appearance will depend on the location
-  //  clicked, not solely the resulting logical cursor position. See the TODO
-  //  note pertaining to selection_range_ for more information.
-  return MoveCursorTo(FindCursorPosition(point), select);
+  SelectionModel selection = FindCursorPosition(point);
+  if (select)
+    selection.set_selection_start(GetSelectionStart());
+  else
+    selection.set_selection_start(selection.selection_end());
+  return MoveCursorTo(selection);
 }
 
-const ui::Range& RenderText::GetSelection() const {
-  return selection_range_;
+bool RenderText::IsPointInSelection(const Point& point) {
+  // TODO(xji): should this check whether the point is inside the visual
+  // selection bounds? In case of "abcFED", if "ED" is selected, |point| points
+  // to the right half of 'c', is the point in selection?
+  size_t pos = FindCursorPosition(point).selection_end();
+  return (pos >= MinOfSelection() && pos < MaxOfSelection());
 }
 
-void RenderText::SetSelection(const ui::Range& range) {
-  selection_range_.set_end(std::min(range.end(), text().length()));
-  selection_range_.set_start(std::min(range.start(), text().length()));
-
-  // Update |display_offset_| to ensure the current cursor is visible.
-  Rect cursor_bounds(GetCursorBounds(GetCursorPosition(), insert_mode()));
-  int display_width = display_rect_.width();
-  int string_width = GetStringWidth();
-  if (string_width < display_width) {
-    // Show all text whenever the text fits to the size.
-    display_offset_.set_x(0);
-  } else if ((display_offset_.x() + cursor_bounds.right()) > display_width) {
-    // Pan to show the cursor when it overflows to the right,
-     display_offset_.set_x(display_width - cursor_bounds.right());
-  } else if ((display_offset_.x() + cursor_bounds.x()) < 0) {
-    // Pan to show the cursor when it overflows to the left.
-    display_offset_.set_x(-cursor_bounds.x());
-  }
-}
-
-bool RenderText::IsPointInSelection(const Point& point) const {
-  size_t pos = FindCursorPosition(point);
-  return (pos >= GetSelection().GetMin() && pos < GetSelection().GetMax());
-}
-
 void RenderText::ClearSelection() {
   SetCursorPosition(GetCursorPosition());
 }
 
 void RenderText::SelectAll() {
-  SetSelection(ui::Range(0, text().length()));
+  SelectionModel sel(0, text().length(),
+                     text().length(), SelectionModel::LEADING);
+  SetSelectionModel(sel);
 }
 
 void RenderText::SelectWord() {
-  size_t selection_start = GetSelection().start();
+  size_t selection_start = GetSelectionStart();
   size_t cursor_position = GetCursorPosition();
-  // First we setup selection_start_ and cursor_pos_. There are so many cases
+  // First we setup selection_start_ and selection_end_. There are so many cases
   // because we try to emulate what select-word looks like in a gtk textfield.
   // See associated testcase for different cases.
   if (cursor_position > 0 && cursor_position < text().length()) {
-    if (isalnum(text()[cursor_position])) {
+    if (u_isalnum(text()[cursor_position])) {
       selection_start = cursor_position;
       cursor_position++;
     } else
@@ -247,7 +295,7 @@
       break;
   }
 
-  // Now we move cursor_pos_ to end of selection. Selection boundary
+  // Now we move selection_end_ to end of selection. Selection boundary
   // is defined as the position where we have alpha-num character on one side
   // and non-alpha-num char on the other side.
   for (; cursor_position < text().length(); cursor_position++) {
@@ -255,7 +303,11 @@
       break;
   }
 
-  SetSelection(ui::Range(selection_start, cursor_position));
+  SelectionModel sel(selection_model());
+  sel.set_selection_start(selection_start);
+  sel.set_selection_end(cursor_position);
+  sel.set_caret_placement(SelectionModel::PREVIOUS_GRAPHEME_TRAILING);
+  SetSelectionModel(sel);
 }
 
 const ui::Range& RenderText::GetCompositionRange() const {
@@ -275,10 +327,12 @@
     return;
   CHECK(!new_range.is_reversed());
   CHECK(ui::Range(0, text_.length()).Contains(new_range));
-  ApplyStyleRangeImpl(style_ranges_, style_range);
+  ApplyStyleRangeImpl(&style_ranges_, style_range);
 #ifndef NDEBUG
   CheckStyleRanges(style_ranges_, text_.length());
 #endif
+  // TODO(xji): only invalidate cursor_bounds if font or underline change.
+  cursor_bounds_valid_ = false;
 }
 
 void RenderText::ApplyDefaultStyle() {
@@ -286,6 +340,7 @@
   StyleRange style = StyleRange(default_style_);
   style.range.set_end(text_.length());
   style_ranges_.push_back(style);
+  cursor_bounds_valid_ = false;
 }
 
 base::i18n::TextDirection RenderText::GetTextDirection() const {
@@ -294,8 +349,8 @@
   return base::i18n::LEFT_TO_RIGHT;
 }
 
-int RenderText::GetStringWidth() const {
-  return GetSubstringBounds(ui::Range(0, text_.length()))[0].width();
+int RenderText::GetStringWidth() {
+  return GetSubstringBounds(0, text_.length())[0].width();
 }
 
 void RenderText::Draw(Canvas* canvas) {
@@ -304,7 +359,8 @@
                       display_rect_.width(), display_rect_.height());
 
   // Draw the selection.
-  std::vector<Rect> selection(GetSubstringBounds(GetSelection()));
+  std::vector<Rect> selection(GetSubstringBounds(GetSelectionStart(),
+                                                 GetCursorPosition()));
   SkColor selection_color =
       focused() ? kFocusedSelectionColor : kUnfocusedSelectionColor;
   for (std::vector<Rect>::const_iterator i = selection.begin();
@@ -318,25 +374,8 @@
   }
 
   // Create a temporary copy of the style ranges for composition and selection.
-  // TODO(msw): This pattern ought to be reconsidered; what about composition
-  //            and selection overlaps, retain existing local style features?
   StyleRanges style_ranges(style_ranges_);
-  // Apply a composition style override to a copy of the style ranges.
-  if (composition_range_.IsValid() && !composition_range_.is_empty()) {
-    StyleRange composition_style(default_style_);
-    composition_style.underline = true;
-    composition_style.range.set_start(composition_range_.start());
-    composition_style.range.set_end(composition_range_.end());
-    ApplyStyleRangeImpl(style_ranges, composition_style);
-  }
-  // Apply a selection style override to a copy of the style ranges.
-  if (selection_range_.IsValid() && !selection_range_.is_empty()) {
-    StyleRange selection_style(default_style_);
-    selection_style.foreground = kSelectedTextColor;
-    selection_style.range.set_start(selection_range_.GetMin());
-    selection_style.range.set_end(selection_range_.GetMax());
-    ApplyStyleRangeImpl(style_ranges, selection_style);
-  }
+  ApplyCompositionAndSelectionStyles(&style_ranges);
 
   // Draw the text.
   Rect bounds(display_rect_);
@@ -368,7 +407,7 @@
 
   // Paint cursor. Replace cursor is drawn as rectangle for now.
   if (cursor_visible() && focused()) {
-    bounds = GetCursorBounds(GetCursorPosition(), insert_mode());
+    bounds = CursorBounds();
     bounds.Offset(display_offset_);
     if (!bounds.IsEmpty())
       canvas->DrawRectInt(kCursorColor,
@@ -379,7 +418,7 @@
   }
 }
 
-size_t RenderText::FindCursorPosition(const Point& point) const {
+SelectionModel RenderText::FindCursorPosition(const Point& point) {
   const Font& font = default_style_.font;
   int left = 0;
   int left_pos = 0;
@@ -387,31 +426,31 @@
   int right_pos = text().length();
 
   int x = point.x();
-  if (x <= left) return left_pos;
-  if (x >= right) return right_pos;
+  if (x <= left) return SelectionModel(left_pos);
+  if (x >= right) return SelectionModel(right_pos);
   // binary searching the cursor position.
   // TODO(oshima): use the center of character instead of edge.
   // Binary search may not work for language like arabic.
-  while (std::abs(static_cast<long>(right_pos - left_pos) > 1)) {
+  while (std::abs(static_cast<long>(right_pos - left_pos)) > 1) {
     int pivot_pos = left_pos + (right_pos - left_pos) / 2;
     int pivot = font.GetStringWidth(text().substr(0, pivot_pos));
     if (pivot < x) {
       left = pivot;
       left_pos = pivot_pos;
     } else if (pivot == x) {
-      return pivot_pos;
+      return SelectionModel(pivot_pos);
     } else {
       right = pivot;
       right_pos = pivot_pos;
     }
   }
-  return left_pos;
+  return SelectionModel(left_pos);
 }
 
 std::vector<Rect> RenderText::GetSubstringBounds(
-    const ui::Range& range) const {
-  size_t start = range.GetMin();
-  size_t end = range.GetMax();
+    size_t from, size_t to) const {
+  size_t start = std::min(from, to);
+  size_t end = std::max(from, to);
   const Font& font = default_style_.font;
   int start_x = font.GetStringWidth(text().substr(0, start));
   int end_x = font.GetStringWidth(text().substr(0, end));
@@ -420,7 +459,9 @@
   return bounds;
 }
 
-Rect RenderText::GetCursorBounds(size_t cursor_pos, bool insert_mode) const {
+Rect RenderText::GetCursorBounds(const SelectionModel& selection,
+                                 bool insert_mode) {
+  size_t cursor_pos = selection.selection_end();
   const Font& font = default_style_.font;
   int x = font.GetStringWidth(text_.substr(0U, cursor_pos));
   DCHECK_GE(x, 0);
@@ -431,10 +472,37 @@
   return bounds;
 }
 
-size_t RenderText::GetLeftCursorPosition(size_t position,
-                                         bool move_by_word) const {
-  if (!move_by_word)
-    return position == 0? position : position - 1;
+Rect RenderText::CursorBounds() {
+  if (cursor_bounds_valid_ == false) {
+    UpdateCursorBoundsAndDisplayOffset();
+    cursor_bounds_valid_ = true;
+  }
+  return cursor_bounds_;
+}
+
+RenderText::RenderText()
+    : text_(),
+      selection_model_(),
+      cursor_bounds_(),
+      cursor_bounds_valid_(false),
+      cursor_visible_(false),
+      insert_mode_(true),
+      composition_range_(),
+      style_ranges_(),
+      default_style_(),
+      display_rect_(),
+      display_offset_() {
+}
+
+SelectionModel RenderText::GetLeftCursorPosition(const SelectionModel& current,
+                                                 bool move_by_word) {
+  size_t position = current.selection_end();
+  SelectionModel left = current;
+  if (!move_by_word) {
+    left.set_selection_end(std::max(static_cast<long>(position - 1),
+                                    static_cast<long>(0)));
+    return left;
+  }
   // Notes: We always iterate words from the begining.
   // This is probably fast enough for our usage, but we may
   // want to modify WordIterator so that it can start from the
@@ -442,8 +510,10 @@
   base::i18n::BreakIterator iter(text(), base::i18n::BreakIterator::BREAK_WORD);
   bool success = iter.Init();
   DCHECK(success);
-  if (!success)
-    return position;
+  if (!success) {
+    left.set_selection_end(position);
+    return left;
+  }
   int last = 0;
   while (iter.Advance()) {
     if (iter.IsWord()) {
@@ -452,7 +522,7 @@
         // The cursor is at the beginning of a word.
         // Move to previous word.
         break;
-      } else if(iter.pos() >= position) {
+      } else if (iter.pos() >= position) {
         // The cursor is in the middle or at the end of a word.
         // Move to the top of current word.
         last = begin;
@@ -463,18 +533,27 @@
     }
   }
 
-  return last;
+  left.set_selection_end(last);
+  return left;
 }
 
-size_t RenderText::GetRightCursorPosition(size_t position,
-                                          bool move_by_word) const {
-  if (!move_by_word)
-    return std::min(position + 1, text().length());
+SelectionModel RenderText::GetRightCursorPosition(const SelectionModel& current,
+                                                  bool move_by_word) {
+  size_t position = current.selection_end();
+  SelectionModel right = current;
+
+  if (!move_by_word) {
+    right.set_selection_end(std::min(position + 1, text().length()));
+    return right;
+  }
+
   base::i18n::BreakIterator iter(text(), base::i18n::BreakIterator::BREAK_WORD);
   bool success = iter.Init();
   DCHECK(success);
-  if (!success)
-    return position;
+  if (!success) {
+    right.set_selection_end(position);
+    return right;
+  }
   size_t pos = 0;
   while (iter.Advance()) {
     pos = iter.pos();
@@ -482,27 +561,52 @@
       break;
     }
   }
-  return pos;
+  right.set_selection_end(pos);
+  return right;
 }
 
-RenderText::RenderText()
-    : text_(),
-      selection_range_(),
-      cursor_visible_(false),
-      insert_mode_(true),
-      composition_range_(),
-      style_ranges_(),
-      default_style_(),
-      display_rect_(),
-      display_offset_() {
+void RenderText::ApplyCompositionAndSelectionStyles(
+    StyleRanges* style_ranges) const {
+  // TODO(msw): This pattern ought to be reconsidered; what about composition
+  //            and selection overlaps, retain existing local style features?
+  // Apply a composition style override to a copy of the style ranges.
+  if (composition_range_.IsValid() && !composition_range_.is_empty()) {
+    StyleRange composition_style(default_style_);
+    composition_style.underline = true;
+    composition_style.range.set_start(composition_range_.start());
+    composition_style.range.set_end(composition_range_.end());
+    ApplyStyleRangeImpl(style_ranges, composition_style);
+  }
+  // Apply a selection style override to a copy of the style ranges.
+  if (!EmptySelection()) {
+    StyleRange selection_style(default_style_);
+    selection_style.foreground = kSelectedTextColor;
+    selection_style.range.set_start(MinOfSelection());
+    selection_style.range.set_end(MaxOfSelection());
+    ApplyStyleRangeImpl(style_ranges, selection_style);
+  }
 }
 
-RenderText::~RenderText() {
+bool RenderText::IsPositionAtWordSelectionBoundary(size_t pos) {
+  return pos == 0 || (u_isalnum(text()[pos - 1]) && !u_isalnum(text()[pos])) ||
+      (!u_isalnum(text()[pos - 1]) && u_isalnum(text()[pos]));
 }
 
-bool RenderText::IsPositionAtWordSelectionBoundary(size_t pos) {
-  return pos == 0 || (isalnum(text()[pos - 1]) && !isalnum(text()[pos])) ||
-      (!isalnum(text()[pos - 1]) && isalnum(text()[pos]));
+void RenderText::UpdateCursorBoundsAndDisplayOffset() {
+  cursor_bounds_ = GetCursorBounds(selection_model_, insert_mode());
+  // Update |display_offset_| to ensure the current cursor is visible.
+  int display_width = display_rect_.width();
+  int string_width = GetStringWidth();
+  if (string_width < display_width) {
+    // Show all text whenever the text fits to the size.
+    display_offset_.set_x(0);
+  } else if ((display_offset_.x() + cursor_bounds_.right()) > display_width) {
+    // Pan to show the cursor when it overflows to the right,
+     display_offset_.set_x(display_width - cursor_bounds_.right());
+  } else if ((display_offset_.x() + cursor_bounds_.x()) < 0) {
+    // Pan to show the cursor when it overflows to the left.
+    display_offset_.set_x(-cursor_bounds_.x());
+  }
 }
 
 }  // namespace gfx