Introduce LocalCaretRect for refactoring Local{Caret,Selection}RectPosition()

third_party/WebKit/Source/core/editing/VisibleUnits.cpp

 /*
  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
@@ skipping 1245 matching lines @@
                                                            primary_direction);
 }
 
 InlineBoxPosition ComputeInlineBoxPosition(const PositionInFlatTree& position,
                                            TextAffinity affinity,
                                            TextDirection primary_direction) {
   return ComputeInlineBoxPositionTemplate<EditingInFlatTreeStrategy>(
       position, affinity, primary_direction);
 }
 
+// TODO(editing-dev): Once we mark |LayoutObject::LocalCaretRect()| |const|,
+// we should make this function to take |const LayoutObject&|.
+static LocalCaretRect ComputeLocalCaretRect(
+    LayoutObject* layout_object,
+    const InlineBoxPosition box_position) {
+  return LocalCaretRect(
+      layout_object, layout_object->LocalCaretRect(box_position.inline_box,
+                                                   box_position.offset_in_box));
+}
+
 template <typename Strategy>
-LayoutRect LocalCaretRectOfPositionTemplate(
-    const PositionWithAffinityTemplate<Strategy>& position,
-    LayoutObject*& layout_object) {
-  if (position.IsNull()) {
-    layout_object = nullptr;
-    return LayoutRect();
-  }
-  Node* node = position.AnchorNode();
+LocalCaretRect LocalCaretRectOfPositionTemplate(
+    const PositionWithAffinityTemplate<Strategy>& position) {
+  if (position.IsNull())
+    return LocalCaretRect();
+  Node* const node = position.AnchorNode();
+  if (!node->GetLayoutObject())

[Xiaocheng, 2017/06/08 21:00:42]

We should store

LayoutObject* const layout_object = node->GetLayoutObject();

here to avoid repeated calls of Node::GetLayoutObject().

[yosin_UTC9, 2017/06/09 06:13:29]

Done.

+    return LocalCaretRect();
 
-  layout_object = node->GetLayoutObject();
-  if (!layout_object)
-    return LayoutRect();
-
-  InlineBoxPosition box_position =
+  const InlineBoxPosition& box_position =
       ComputeInlineBoxPosition(position.GetPosition(), position.Affinity());
 
-  if (box_position.inline_box)
-    layout_object = LineLayoutAPIShim::LayoutObjectFrom(
-        box_position.inline_box->GetLineLayoutItem());
+  if (!box_position.inline_box)
+    return ComputeLocalCaretRect(node->GetLayoutObject(), box_position);

[Xiaocheng, 2017/06/08 21:00:41]

We can use early return style without switching the if and else branches.

Let's do that to be git log friendly.

[yosin_UTC9, 2017/06/09 06:13:29]

Done.

 
-  return layout_object->LocalCaretRect(box_position.inline_box,
-                                       box_position.offset_in_box);
+  return ComputeLocalCaretRect(
+      LineLayoutAPIShim::LayoutObjectFrom(
+          box_position.inline_box->GetLineLayoutItem()),
+      box_position);
 }
 
 // This function was added because the caret rect that is calculated by
 // using the line top value instead of the selection top.
 template <typename Strategy>
-LayoutRect LocalSelectionRectOfPositionTemplate(
-    const PositionWithAffinityTemplate<Strategy>& position,
-    LayoutObject*& layout_object) {
-  if (position.IsNull()) {
-    layout_object = nullptr;
-    return LayoutRect();
-  }
-  Node* node = position.AnchorNode();
-  layout_object = node->GetLayoutObject();
-  if (!layout_object)
-    return LayoutRect();
+LocalCaretRect LocalSelectionRectOfPositionTemplate(
+    const PositionWithAffinityTemplate<Strategy>& position) {
+  if (position.IsNull())
+    return LocalCaretRect();
+  Node* const node = position.AnchorNode();
+  if (!node->GetLayoutObject())
+    return LocalCaretRect();
 
-  InlineBoxPosition box_position =
+  const InlineBoxPosition& box_position =
       ComputeInlineBoxPosition(position.GetPosition(), position.Affinity());
 
   if (!box_position.inline_box)
-    return LayoutRect();
+    return LocalCaretRect();

[Xiaocheng, 2017/06/08 21:00:42]

The original code returns a non-null LayoutObject.

Let's not change that.

[yosin_UTC9, 2017/06/09 06:13:29]

I create another patch to return nullptr for layout object.
http://crrev.com/2925323004

 
-  layout_object = LineLayoutAPIShim::LayoutObjectFrom(
+  LayoutObject* const layout_object = LineLayoutAPIShim::LayoutObjectFrom(
       box_position.inline_box->GetLineLayoutItem());
 
-  LayoutRect rect = layout_object->LocalCaretRect(box_position.inline_box,
-                                                  box_position.offset_in_box);
+  const LayoutRect& rect = layout_object->LocalCaretRect(
+      box_position.inline_box, box_position.offset_in_box);
 
   if (rect.IsEmpty())
-    return rect;
+    return LocalCaretRect();

[Xiaocheng, 2017/06/08 21:00:42]

Ditto.

[yosin_UTC9, 2017/06/09 06:13:29]

I create another patch to return nullptr for layout object.
http://crrev.com/2925323004

 
   InlineBox* const box = box_position.inline_box;
   if (layout_object->Style()->IsHorizontalWritingMode()) {
-    rect.SetY(box->Root().SelectionTop());
-    rect.SetHeight(box->Root().SelectionHeight());
-    return rect;
+    return LocalCaretRect(
+        layout_object,
+        LayoutRect(LayoutPoint(rect.X(), box->Root().SelectionTop()),
+                   LayoutSize(rect.Width(), box->Root().SelectionHeight())));
   }
 
-  rect.SetX(box->Root().SelectionTop());
-  rect.SetWidth(box->Root().SelectionHeight());
-  return rect;
+  return LocalCaretRect(
+      layout_object,
+      LayoutRect(LayoutPoint(box->Root().SelectionTop(), rect.Y()),
+                 LayoutSize(box->Root().SelectionHeight(), rect.Height())));
 }
 
-LayoutRect LocalCaretRectOfPosition(const PositionWithAffinity& position,
-                                    LayoutObject*& layout_object) {
-  return LocalCaretRectOfPositionTemplate<EditingStrategy>(position,
-                                                           layout_object);
+LocalCaretRect LocalCaretRectOfPosition(const PositionWithAffinity& position) {
+  return LocalCaretRectOfPositionTemplate<EditingStrategy>(position);
 }
 
-LayoutRect LocalSelectionRectOfPosition(const PositionWithAffinity& position,
-                                        LayoutObject*& layout_object) {
-  return LocalSelectionRectOfPositionTemplate<EditingStrategy>(position,
-                                                               layout_object);
+static LocalCaretRect LocalSelectionRectOfPosition(
+    const PositionWithAffinity& position) {
+  return LocalSelectionRectOfPositionTemplate<EditingStrategy>(position);
 }
 
-LayoutRect LocalCaretRectOfPosition(
-    const PositionInFlatTreeWithAffinity& position,
-    LayoutObject*& layout_object) {
-  return LocalCaretRectOfPositionTemplate<EditingInFlatTreeStrategy>(
-      position, layout_object);
+LocalCaretRect LocalCaretRectOfPosition(
+    const PositionInFlatTreeWithAffinity& position) {
+  return LocalCaretRectOfPositionTemplate<EditingInFlatTreeStrategy>(position);
 }
 
 static LayoutUnit BoundingBoxLogicalHeight(LayoutObject* o,
                                            const LayoutRect& rect) {
   return o->Style()->IsHorizontalWritingMode() ? rect.Height() : rect.Width();
 }
 
 bool HasRenderedNonAnonymousDescendantsWithHeight(LayoutObject* layout_object) {
   LayoutObject* stop = layout_object->NextInPreOrderAfterChildren();
   for (LayoutObject* o = layout_object->SlowFirstChild(); o && o != stop;
@@ skipping 120 matching lines @@
       return text_offset == text_layout_object->CaretMinOffset() ||
              text_offset == NextGraphemeBoundaryOf(
                                 anchor_node, PreviousGraphemeBoundaryOf(
                                                  anchor_node, text_offset));
     }
   }
 
   return false;
 }
 
+FloatQuad LocalCaretRect::LocalToAbsoluteQuad() const {
+  return layout_object->LocalToAbsoluteQuad(FloatRect(rect));
+}
+
 bool RendersInDifferentPosition(const Position& position1,
                                 const Position& position2) {
   if (position1.IsNull() || position2.IsNull())
     return false;
-  LayoutObject* layout_object1;
-  const LayoutRect& rect1 =
-      LocalCaretRectOfPosition(PositionWithAffinity(position1), layout_object1);
-  LayoutObject* layout_object2;
-  const LayoutRect& rect2 =
-      LocalCaretRectOfPosition(PositionWithAffinity(position2), layout_object2);
-  if (!layout_object1 || !layout_object2)
-    return layout_object1 != layout_object2;
-  return layout_object1->LocalToAbsoluteQuad(FloatRect(rect1)) !=
-         layout_object2->LocalToAbsoluteQuad(FloatRect(rect2));
+  const LocalCaretRect& caret_rect1 =
+      LocalCaretRectOfPosition(PositionWithAffinity(position1));
+  const LocalCaretRect& caret_rect2 =
+      LocalCaretRectOfPosition(PositionWithAffinity(position2));
+  if (!caret_rect1.layout_object || !caret_rect2.layout_object)
+    return caret_rect1.layout_object != caret_rect2.layout_object;
+  return caret_rect1.LocalToAbsoluteQuad() != caret_rect2.LocalToAbsoluteQuad();
 }
 
 static bool IsVisuallyEmpty(const LayoutObject* layout) {
   for (LayoutObject* child = layout->SlowFirstChild(); child;
        child = child->NextSibling()) {
     // TODO(xiaochengh): Replace type-based conditioning by virtual function.
     if (child->IsBox()) {
       if (!ToLayoutBox(child)->Size().IsEmpty())
         return false;
     } else if (child->IsLayoutInline()) {
@@ skipping 493 matching lines @@
 
 bool IsVisuallyEquivalentCandidate(const PositionInFlatTree& position) {
   return IsVisuallyEquivalentCandidateAlgorithm<EditingInFlatTreeStrategy>(
       position);
 }
 
 template <typename Strategy>
 static IntRect AbsoluteCaretBoundsOfAlgorithm(
     const VisiblePositionTemplate<Strategy>& visible_position) {
   DCHECK(visible_position.IsValid()) << visible_position;
-  LayoutObject* layout_object;
-  LayoutRect local_rect = LocalCaretRectOfPosition(
-      visible_position.ToPositionWithAffinity(), layout_object);
-  if (local_rect.IsEmpty() || !layout_object)
+  const LocalCaretRect& caret_rect =
+      LocalCaretRectOfPosition(visible_position.ToPositionWithAffinity());
+  if (caret_rect.IsEmpty())
     return IntRect();
-
-  return layout_object->LocalToAbsoluteQuad(FloatRect(local_rect))
-      .EnclosingBoundingBox();
+  return caret_rect.LocalToAbsoluteQuad().EnclosingBoundingBox();
 }
 
 IntRect AbsoluteCaretBoundsOf(const VisiblePosition& visible_position) {
   return AbsoluteCaretBoundsOfAlgorithm<EditingStrategy>(visible_position);
 }
 
 template <typename Strategy>
 static IntRect AbsoluteSelectionBoundsOfAlgorithm(
     const VisiblePositionTemplate<Strategy>& visible_position) {
   DCHECK(visible_position.IsValid()) << visible_position;
-  LayoutObject* layout_object;
-  LayoutRect local_rect = LocalSelectionRectOfPosition(
-      visible_position.ToPositionWithAffinity(), layout_object);
-  if (local_rect.IsEmpty() || !layout_object)
+  const LocalCaretRect& caret_rect =
+      LocalSelectionRectOfPosition(visible_position.ToPositionWithAffinity());
+  if (caret_rect.IsEmpty())
     return IntRect();
-
-  return layout_object->LocalToAbsoluteQuad(FloatRect(local_rect))
-      .EnclosingBoundingBox();
+  return caret_rect.LocalToAbsoluteQuad().EnclosingBoundingBox();
 }
 
 IntRect AbsoluteSelectionBoundsOf(const VisiblePosition& visible_position) {
   return AbsoluteSelectionBoundsOfAlgorithm<EditingStrategy>(visible_position);
 }
 
 IntRect AbsoluteCaretBoundsOf(
     const VisiblePositionInFlatTree& visible_position) {
   return AbsoluteCaretBoundsOfAlgorithm<EditingInFlatTreeStrategy>(
       visible_position);
@@ skipping 719 matching lines @@
 
 IntRect ComputeTextRect(const EphemeralRangeInFlatTree& range) {
   return EnclosingIntRect(ComputeTextRectTemplate(range));
 }
 
 FloatRect ComputeTextFloatRect(const EphemeralRange& range) {
   return ComputeTextRectTemplate(range);
 }
 
 }  // namespace blink