Implements the ability to get and set the caret position and the current selection from anywhere in…

Source/modules/accessibility/AXLayoutObject.cpp

 /*
 * Copyright (C) 2008 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 15 matching lines @@
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
 #include "config.h"
 #include "modules/accessibility/AXLayoutObject.h"
 
 #include "bindings/core/v8/ExceptionStatePlaceholder.h"
 #include "core/CSSPropertyNames.h"
 #include "core/InputTypeNames.h"
 #include "core/dom/ElementTraversal.h"
+#include "core/dom/Range.h"
 #include "core/dom/shadow/ShadowRoot.h"
 #include "core/editing/FrameSelection.h"
 #include "core/editing/RenderedPosition.h"
 #include "core/editing/VisibleUnits.h"
 #include "core/editing/htmlediting.h"
 #include "core/editing/iterators/CharacterIterator.h"
 #include "core/editing/iterators/TextIterator.h"
 #include "core/frame/LocalFrame.h"
 #include "core/frame/Settings.h"
 #include "core/html/HTMLImageElement.h"
 #include "core/html/HTMLLabelElement.h"
 #include "core/html/HTMLOptionElement.h"
 #include "core/html/HTMLSelectElement.h"
 #include "core/html/HTMLTextAreaElement.h"
 #include "core/html/shadow/ShadowElementNames.h"
 #include "core/layout/HitTestResult.h"
 #include "core/layout/LayoutFieldset.h"
 #include "core/layout/LayoutFileUploadControl.h"
 #include "core/layout/LayoutHTMLCanvas.h"
 #include "core/layout/LayoutImage.h"
 #include "core/layout/LayoutInline.h"
 #include "core/layout/LayoutListMarker.h"
 #include "core/layout/LayoutMenuList.h"
 #include "core/layout/LayoutPart.h"
+#include "core/layout/LayoutTextControl.h"
 #include "core/layout/LayoutTextControlSingleLine.h"
 #include "core/layout/LayoutTextFragment.h"
 #include "core/layout/LayoutView.h"
 #include "core/loader/ProgressTracker.h"
 #include "core/page/Page.h"
 #include "core/paint/DeprecatedPaintLayer.h"
 #include "core/style/ComputedStyleConstants.h"
 #include "core/svg/SVGDocumentExtensions.h"
 #include "core/svg/SVGSVGElement.h"
 #include "core/svg/graphics/SVGImage.h"
@@ skipping 1757 matching lines @@
 }
 
 Widget* AXLayoutObject::widgetForAttachmentView() const
 {
     if (!isAttachment())
         return 0;
     return toLayoutPart(m_layoutObject)->widget();
 }
 
 //
-// Selected text.
+// Get the current selection.
 //
 
-AXObject::PlainTextRange AXLayoutObject::selectedTextRange() const
+AXObject::AXRange AXLayoutObject::selection() const
 {
-    if (!isTextControl())
-        return PlainTextRange();
+    AXRange textSelection = textControlSelection();
+    if (!textSelection.isNull())
+        return textSelection;
 
-    if (m_layoutObject->isTextControl()) {
-        HTMLTextFormControlElement* textControl = toLayoutTextControl(m_layoutObject)->textFormControlElement();
-        return PlainTextRange(textControl->selectionStart(), textControl->selectionEnd() - textControl->selectionStart());
+    if (!layoutObject() || !layoutObject()->frame())
+        return AXRange();
+
+    VisibleSelection selection = layoutObject()->frame()->selection().selection();
+    RefPtrWillBeRawPtr<Range> selectionRange = selection.firstRange();
+    if (!selectionRange)
+        return AXRange();
+
+    Node* anchorNode = selectionRange->startContainer();
+    ASSERT(anchorNode);
+
+    RefPtrWillBeRawPtr<AXObject> anchorObject = nullptr;
+    // Find the closest node that has a corresponding AXObject.
+    while (anchorNode && !(anchorObject = axObjectCache().getOrCreate(anchorNode))
+        && (!anchorObject->isAXLayoutObject() || !anchorObject->node() || anchorObject->accessibilityIsIgnored())) {
+        if (anchorNode->nextSibling())

[dmazzoni, 2015/06/26 06:14:38]

I think you should update anchorOffset here.

To take a completely contrived but simple example, suppose you have <div
aria-hidden="true">Hello World</div> and the word "World" is selected, so
anchorOffset is 6. As you go to nextSibling or parentNode from here, I think you
should reset anchorOffset to 0.

Anyway, these are corner cases and I'm okay with deferring them for a follow-up
change that adds more unit tests for those types of cases.

+            anchorNode = anchorNode->nextSibling();
+        else
+            anchorNode = anchorNode->parentNode();
     }
 
-    return visibleSelectionUnderObject();
+    Node* focusNode = selectionRange->endContainer();
+    ASSERT(focusNode);
+
+    RefPtrWillBeRawPtr<AXObject> focusObject = nullptr;
+    while (focusNode && !(focusObject = axObjectCache().getOrCreate(focusNode))
+        && (!focusObject->isAXLayoutObject() || !focusObject->node() || focusObject->accessibilityIsIgnored())) {
+        if (focusNode->previousSibling())
+            focusNode = focusNode->previousSibling();
+        else
+            focusNode = focusNode->parentNode();
+    }
+
+    if (!anchorObject || !focusObject)
+        return AXRange();
+
+    int anchorOffset = selectionRange->startOffset();
+    ASSERT(anchorOffset >= 0);
+    int focusOffset = selectionRange->endOffset();
+    ASSERT(focusOffset >= 0);
+
+    return AXRange(
+        anchorObject, anchorOffset,
+        focusObject, focusOffset);
 }
 
-VisibleSelection AXLayoutObject::selection() const
+// Gets only the start and end offsets of the selection computed using the
+// current object as the starting point. Returns a null selection if there is
+// no selection in the subtree rooted at this object.
+AXObject::AXRange AXLayoutObject::selectionUnderObject() const
 {
-    return m_layoutObject->frame()->selection().selection();
+    AXRange textSelection = textControlSelection();
+    if (!textSelection.isNull())
+        return textSelection;
+
+    if (!layoutObject() || !layoutObject()->frame())
+        return AXRange();
+
+    VisibleSelection selection = layoutObject()->frame()->selection().selection();
+    RefPtrWillBeRawPtr<Range> selectionRange = selection.firstRange();
+    if (!selectionRange
+        || selectionRange->compareNode(node(), IGNORE_EXCEPTION) != Range::NODE_BEFORE_AND_AFTER)
+        return AXRange();
+
+    int start = indexForVisiblePosition(selection.visibleStart());
+    ASSERT(start >= 0);
+    int end = indexForVisiblePosition(selection.visibleEnd());
+    ASSERT(end >= 0);
+
+    return AXRange(start, end);
+}
+
+AXObject::AXRange AXLayoutObject::textControlSelection() const
+{
+    if (!layoutObject())
+        return AXRange();
+
+    LayoutObject* layout = nullptr;
+    if (layoutObject()->isTextControl()) {
+        layout = layoutObject();
+    } else {
+        Element* focusedElement = document()->focusedElement();
+        if (focusedElement && focusedElement->layoutObject()
+            && focusedElement->layoutObject()->isTextControl())
+            layout = focusedElement->layoutObject();
+    }
+
+    if (!layout)
+        return AXRange();
+
+    AXObject* axObject = axObjectCache().getOrCreate(layout);
+    if (!axObject || !axObject->isAXLayoutObject())
+        return AXRange();
+
+    HTMLTextFormControlElement* textControl = toLayoutTextControl(
+        layout)->textFormControlElement();
+    ASSERT(textControl);
+    int start = textControl->selectionStart();
+    int end = textControl->selectionEnd();
+    return AXRange(axObject, start, axObject, end);
+}
+
+int AXLayoutObject::indexForVisiblePosition(const VisiblePosition& position) const
+{
+    if (layoutObject() && layoutObject()->isTextControl()) {
+        HTMLTextFormControlElement* textControl = toLayoutTextControl(
+            layoutObject())->textFormControlElement();
+        return textControl->indexForVisiblePosition(position);
+    }
+
+    if (!node())
+        return 0;
+
+    Position indexPosition = position.deepEquivalent();
+    if (indexPosition.isNull())
+        return 0;
+
+    RefPtrWillBeRawPtr<Range> range = Range::create(*document());
+    range->setStart(node(), 0, IGNORE_EXCEPTION);
+    range->setEnd(indexPosition, IGNORE_EXCEPTION);
+
+    return TextIterator::rangeLength(range->startPosition(), range->endPosition());
 }
 
 //
 // Modify or take an action on an object.
 //
 
-void AXLayoutObject::setSelectedTextRange(const PlainTextRange& range)
+void AXLayoutObject::setSelection(const AXRange& selection)
 {
-    if (m_layoutObject->isTextControl()) {
-        HTMLTextFormControlElement* textControl = toLayoutTextControl(m_layoutObject)->textFormControlElement();
-        textControl->setSelectionRange(range.start, range.start + range.length, SelectionHasNoDirection, NotDispatchSelectEvent);
+    if (!layoutObject() || selection.isNull())
+        return;
+
+    if (selection.anchorObject

[dmazzoni, 2015/06/26 06:14:38]

Nit: this could be a helper function like IsValidSelectionBound(AXObject* obj)
that you could call on anchorObject and focusObject.

+        && (selection.anchorObject->isDetached()
+        || !selection.anchorObject->isAXLayoutObject()
+        || selection.anchorObject->layoutObject()->frame() != layoutObject()->frame()
+        || &selection.anchorObject->axObjectCache() != &axObjectCache()))
+        return;
+
+    if (selection.focusObject
+        && (selection.focusObject->isDetached()
+        || !selection.focusObject->isAXLayoutObject()
+        || selection.focusObject->layoutObject()->frame() != layoutObject()->frame()
+        || &selection.focusObject->axObjectCache() != &axObjectCache()))
+        return;
+
+    AXObject* anchorObject = selection.anchorObject ?

[dmazzoni, 2015/06/26 06:14:38]

You could maybe combine this too - have the helper return the valid bound or
|this|.

+        selection.anchorObject.get() : this;
+    AXObject* focusObject = selection.focusObject ?
+        selection.focusObject.get() : this;
+
+    if (anchorObject == this && anchorObject == focusObject
+        && layoutObject()->isTextControl()) {
+        HTMLTextFormControlElement* textControl = toLayoutTextControl(
+            layoutObject())->textFormControlElement();

[dmazzoni, 2015/06/26 06:14:38]

When the indentation is 4 spaces, I think the line continuation should be 8
spaces. I think it should already be part of a presubmit check, but if not try
running Tools/Scripts/check-webkit-style and fix any issues it raises.

+        textControl->setSelectionRange(selection.anchorOffset, selection.focusOffset,
+            SelectionHasNoDirection, NotDispatchSelectEvent);
         return;
     }
 
-    Document& document = m_layoutObject->document();
-    LocalFrame* frame = document.frame();
+    Node* anchorNode = nullptr;

[dmazzoni, 2015/06/26 06:14:38]

Possibly a helper here, like nearestNodeFromAXObject?

Note that if a helper doesn't need to be a member function, i.e. if it doesn't
need |this|, then just declare it as a static function immediately above this
one. You'll see several other similar examples in this source file, a static
non-member helper function.

+    while (anchorObject && !anchorNode) {
+        anchorNode = anchorObject->node();
+        anchorObject = anchorObject->parentObject();
+    }
+
+    Node* focusNode = nullptr;
+    while (focusObject && !focusNode) {
+        focusNode = focusObject->node();
+        focusObject = focusObject->parentObject();
+    }
+
+    if (!anchorNode || !focusNode)
+        return;
+
+    LocalFrame* frame = layoutObject()->frame();
     if (!frame)
         return;
-    Node* node = m_layoutObject->node();
-    frame->selection().setSelection(VisibleSelection(Position(node, range.start, Position::PositionIsOffsetInAnchor),
-        Position(node, range.start + range.length, Position::PositionIsOffsetInAnchor), DOWNSTREAM));
+
+    frame->selection().setSelection(VisibleSelection(Position(anchorNode,
+        selection.anchorOffset, Position::PositionIsOffsetInAnchor),
+        Position(focusNode, selection.focusOffset,
+        Position::PositionIsOffsetInAnchor), DOWNSTREAM));
 }
 
 void AXLayoutObject::setValue(const String& string)
 {
     if (!node() || !node()->isElementNode())
         return;
     if (!m_layoutObject || !m_layoutObject->isBoxModelObject())
         return;
 
     LayoutBoxModelObject* layoutObject = toLayoutBoxModelObject(m_layoutObject);
@@ skipping 114 matching lines @@
     Position start, end;
     bool selected = Range::selectNodeContents(node, start, end);
     if (!selected)
         return VisiblePosition();
 
     CharacterIterator it(start, end);
     it.advance(index - 1);
     return VisiblePosition(Position(it.currentContainer(), it.endOffset(), Position::PositionIsOffsetInAnchor), UPSTREAM);
 }
 
-int AXLayoutObject::indexForVisiblePosition(const VisiblePosition& pos) const
-{
-    if (m_layoutObject->isTextControl()) {
-        HTMLTextFormControlElement* textControl = toLayoutTextControl(m_layoutObject)->textFormControlElement();
-        return textControl->indexForVisiblePosition(pos);
-    }
-
-    if (!isTextControl())
-        return 0;
-
-    Node* node = m_layoutObject->node();
-    if (!node)
-        return 0;
-
-    Position indexPosition = pos.deepEquivalent();
-    if (indexPosition.isNull()
-        || (highestEditableRoot(indexPosition) != node
-        && highestEditableRoot(indexPosition, HasEditableAXRole) != node))
-        return 0;
-
-    RefPtrWillBeRawPtr<Range> range = Range::create(m_layoutObject->document());
-    range->setStart(node, 0, IGNORE_EXCEPTION);
-    range->setEnd(indexPosition, IGNORE_EXCEPTION);
-
-    return TextIterator::rangeLength(range->startPosition(), range->endPosition());
-}
-
 void AXLayoutObject::addInlineTextBoxChildren(bool force)
 {
     Settings* settings = document()->settings();
     if (!force && (!settings || !settings->inlineTextBoxAccessibilityEnabled()))
         return;
 
     if (!layoutObject() || !layoutObject()->isText())
         return;
 
     if (layoutObject()->needsLayout()) {
@@ skipping 61 matching lines @@
     for (const auto& child : children()) {
         // Every child should have aria-role option, and if so, check for selected attribute/state.
         if (child->isSelected() && child->ariaRoleAttribute() == ListBoxOptionRole) {
             result.append(child);
             if (!isMulti)
                 return;
         }
     }
 }
 
-AXObject::PlainTextRange AXLayoutObject::visibleSelectionUnderObject() const
-{
-    Node* node = m_layoutObject->node();
-    if (!node)
-        return PlainTextRange();
-
-    VisibleSelection visibleSelection = selection();
-    RefPtrWillBeRawPtr<Range> currentSelectionRange = visibleSelection.toNormalizedRange();
-    if (!currentSelectionRange || !currentSelectionRange->intersectsNode(node, IGNORE_EXCEPTION))
-        return PlainTextRange();
-
-    int start = indexForVisiblePosition(visibleSelection.visibleStart());
-    int end = indexForVisiblePosition(visibleSelection.visibleEnd());
-
-    return PlainTextRange(start, end - start);
-}
-
 bool AXLayoutObject::nodeIsTextControl(const Node* node) const
 {
     if (!node)
         return false;
 
     const AXObject* axObjectForNode = axObjectCache().getOrCreate(const_cast<Node*>(node));
     if (!axObjectForNode)
         return false;
 
     return axObjectForNode->isTextControl();
@@ skipping 361 matching lines @@
         if (label && label->layoutObject()) {
             LayoutRect labelRect = axObjectCache().getOrCreate(label)->elementRect();
             result.unite(labelRect);
         }
     }
 
     return result;
 }
 
 } // namespace blink