Make DOMSelection cache Range

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

 /*
  * Copyright (C) 2007, 2009 Apple Inc. All rights reserved.
  * Copyright (C) 2012 Google 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.
@@ skipping 157 matching lines @@
   if (selection.isNone())
     return "None";
   if (selection.isCaret())
     return "Caret";
   return "Range";
 }
 
 int DOMSelection::rangeCount() const {
   if (!isAvailable())
     return 0;
+  if (isTreeScopeDocument() && documentCachedRange())
+    return 1;
   return frame()->selection().isNone() ? 0 : 1;
 }
 
 void DOMSelection::collapse(Node* node,
                             int offset,
                             ExceptionState& exceptionState) {
   if (!isAvailable())
     return;
 
   if (!node) {
@@ skipping 91 matching lines @@
     return;
   }
   if (!extentNode) {
     UseCounter::count(frame(), UseCounter::SelectionSetBaseAndExtentNull);
     extentOffset = 0;
   }
 
   if (!isValidForPosition(baseNode) || !isValidForPosition(extentNode))
     return;
 
+  if (isTreeScopeDocument())
+    clearDocumentCachedRange();
+
   // TODO(editing-dev): The use of updateStyleAndLayoutIgnorePendingStylesheets
   // needs to be audited.  See http://crbug.com/590369 for more details.
   // In the long term, we should change FrameSelection::setSelection to take a
   // parameter that does not require clean layout, so that modifying selection
   // no longer performs synchronous layout by itself.
   // TODO(editing-dev): Once SVG USE element doesn't modifies DOM tree, we
   // should get rid of this update layout call.
   // See http://crbug.com/566281
   // See "svg/text/textpath-reference-crash.html"
   frame()->document()->updateStyleAndLayoutIgnorePendingStylesheets();
@@ skipping 77 matching lines @@
   if (static_cast<unsigned>(offset) > node->lengthOfContents()) {
     exceptionState.throwDOMException(
         IndexSizeError,
         String::number(offset) + " is larger than the given node's length.");
     return;
   }
 
   if (!isValidForPosition(node))
     return;
 
+  if (isTreeScopeDocument())
+    clearDocumentCachedRange();
   const Position& base = frame()->selection().base();
   if (base.isNull()) {
     // TODO(editing-dev): We should throw |InvalidStateError| if selection is
     // none to follow the spec.
     frame()->selection().setSelection(SelectionInDOMTree::Builder()
                                           .collapse(Position(node, offset))
                                           .setIsDirectional(true)
                                           .build());
     return;
   }
@@ skipping 10 matching lines @@
 
   if (index < 0 || index >= rangeCount()) {
     exceptionState.throwDOMException(
         IndexSizeError, String::number(index) + " is not a valid index.");
     return nullptr;
   }
 
   // If you're hitting this, you've added broken multi-range selection support
   DCHECK_EQ(rangeCount(), 1);
 
+  if (!isTreeScopeDocument())

[yosin_UTC9, 2017/02/09 06:52:06]

If we have |cachedRangeIfDocumentSlection()| and
|cacheRangeIfDocumentSelection()|

if (Range* cachedRange = cachedRangeIfDocumentSelection())
  return range;
return cacheRangeIfDocumentSelection(createRangeFromSelectionEditor());

It seems |cachedRangeXXX()| and |cacheRangeXXX() are very similar, we should
have
another name like |rememberRangeIfDocumentSelection()| or another to have visual
difference.

[yoichio, 2017/02/09 09:31:19]

Done.

+    return createRangeFromSelectionEditor();
+
+  if (Range* cachedRange = documentCachedRange())
+    return cachedRange;
+
+  Range* range = createRangeFromSelectionEditor();
+  cacheRangeOfDocument(range);
+  return range;
+}
+
+Range* DOMSelection::createRangeFromSelectionEditor() {
   Position anchor = anchorPosition(visibleSelection());
   if (!anchor.anchorNode()->isInShadowTree())
     return frame()->selection().firstRange();
 
   Node* node = shadowAdjustedNode(anchor);
   if (!node)  // crbug.com/595100
     return nullptr;
   if (!visibleSelection().isBaseFirst())
     return Range::create(*anchor.document(), focusNode(), focusOffset(), node,
                          anchorOffset());
   return Range::create(*anchor.document(), node, anchorOffset(), focusNode(),
                        focusOffset());
 }
 
+bool DOMSelection::isTreeScopeDocument() const {

[yosin_UTC9, 2017/02/09 06:52:06]

nit: s/isTreeScopeDocument/isSelectionForDocument/

It is hard to see relationship between DOMSelection and TreeScope.

[yoichio, 2017/02/09 09:31:19]

Done.

+  return m_treeScope == m_treeScope->document();
+}
+
+void DOMSelection::cacheRangeOfDocument(Range* range) {
+  DCHECK(isTreeScopeDocument());
+  frame()->selection().cacheRangeOfDocument(range);
+}
+
+Range* DOMSelection::documentCachedRange() const {
+  DCHECK(isTreeScopeDocument());
+  return frame()->selection().documentCachedRange();
+}
+
+void DOMSelection::clearDocumentCachedRange() {
+  frame()->selection().clearDocumentCachedRange();

[yosin_UTC9, 2017/02/09 06:52:06]

Let's add |DCHECK(isTreeScopeDocument())|.

It seems |if (isTreeScopeDocument()) ...| pattern is verbose.

|clearCachedRangeIfDocument()| is simpler.

[yoichio, 2017/02/09 09:31:19]

Done.

+}
+
 void DOMSelection::removeAllRanges() {
   if (!isAvailable())
     return;
   frame()->selection().clear();
 }
 
 void DOMSelection::addRange(Range* newRange) {
   DCHECK(newRange);
 
   if (!isAvailable())
@@ skipping 16 matching lines @@
 
   // TODO(xiaochengh): The use of updateStyleAndLayoutIgnorePendingStylesheets
   // needs to be audited.  See http://crbug.com/590369 for more details.
   // In the long term, we should change FrameSelection::setSelection to take a
   // parameter that does not require clean layout, so that modifying selection
   // no longer performs synchronous layout by itself.
   frame()->document()->updateStyleAndLayoutIgnorePendingStylesheets();
 
   if (selection.isNone()) {
     selection.setSelectedRange(EphemeralRange(newRange), VP_DEFAULT_AFFINITY);
+    if (isTreeScopeDocument())

[yosin_UTC9, 2017/02/09 06:52:06]

|cacheRangeIfDocumentSlection(newRange)| is simpler.

[yoichio, 2017/02/09 09:31:19]

Done.

+      cacheRangeOfDocument(newRange);
     return;
   }
 
   Range* originalRange = selection.firstRange();
 
   if (originalRange->startContainer()->document() !=
       newRange->startContainer()->document()) {
     addConsoleError(
         "The given range does not belong to the current selection's document.");
     return;
@@ skipping 27 matching lines @@
                      ? originalRange
                      : newRange;
   Range* end = originalRange->compareBoundaryPoints(Range::kEndToEnd, newRange,
                                                     ASSERT_NO_EXCEPTION) < 0
                    ? newRange
                    : originalRange;
   const EphemeralRange merged =
       EphemeralRange(start->startPosition(), end->endPosition());
   TextAffinity affinity = selection.selection().affinity();
   selection.setSelectedRange(merged, affinity);
+  if (isTreeScopeDocument())
+    cacheRangeOfDocument(newRange);
 }
 
 void DOMSelection::deleteFromDocument() {
   if (!isAvailable())
     return;
 
   FrameSelection& selection = frame()->selection();
 
   if (selection.isNone())
     return;
@@ skipping 145 matching lines @@
     m_treeScope->document().addConsoleMessage(
         ConsoleMessage::create(JSMessageSource, ErrorMessageLevel, message));
 }
 
 DEFINE_TRACE(DOMSelection) {
   visitor->trace(m_treeScope);
   ContextClient::trace(visitor);
 }
 
 }  // namespace blink