2 * Copyright (C) 2007, 2009 Apple Inc. All rights reserved.
3 * Copyright (C) 2012 Google Inc. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15 * its contributors may be used to endorse or promote products derived
16 * from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 #include "core/page/DOMSelection.h"
34 #include "bindings/v8/ExceptionMessages.h"
35 #include "bindings/v8/ExceptionState.h"
36 #include "bindings/v8/ExceptionStatePlaceholder.h"
37 #include "core/dom/Document.h"
38 #include "core/dom/ExceptionCode.h"
39 #include "core/dom/Node.h"
40 #include "core/dom/Range.h"
41 #include "core/dom/TreeScope.h"
42 #include "core/editing/FrameSelection.h"
43 #include "core/editing/TextIterator.h"
44 #include "core/editing/htmlediting.h"
45 #include "core/frame/LocalFrame.h"
46 #include "wtf/text/WTFString.h"
50 static Node* selectionShadowAncestor(LocalFrame* frame)
52 Node* node = frame->selection().selection().base().anchorNode();
56 if (!node->isInShadowTree())
59 return frame->document()->ancestorInThisScope(node);
62 DOMSelection::DOMSelection(const TreeScope* treeScope)
63 : DOMWindowProperty(treeScope->rootNode().document().frame())
64 , m_treeScope(treeScope)
66 ScriptWrappable::init(this);
69 void DOMSelection::clearTreeScope()
71 m_treeScope = nullptr;
74 const VisibleSelection& DOMSelection::visibleSelection() const
77 return m_frame->selection().selection();
80 static Position anchorPosition(const VisibleSelection& selection)
82 Position anchor = selection.isBaseFirst() ? selection.start() : selection.end();
83 return anchor.parentAnchoredEquivalent();
86 static Position focusPosition(const VisibleSelection& selection)
88 Position focus = selection.isBaseFirst() ? selection.end() : selection.start();
89 return focus.parentAnchoredEquivalent();
92 static Position basePosition(const VisibleSelection& selection)
94 return selection.base().parentAnchoredEquivalent();
97 static Position extentPosition(const VisibleSelection& selection)
99 return selection.extent().parentAnchoredEquivalent();
102 Node* DOMSelection::anchorNode() const
107 return shadowAdjustedNode(anchorPosition(visibleSelection()));
110 int DOMSelection::anchorOffset() const
115 return shadowAdjustedOffset(anchorPosition(visibleSelection()));
118 Node* DOMSelection::focusNode() const
123 return shadowAdjustedNode(focusPosition(visibleSelection()));
126 int DOMSelection::focusOffset() const
131 return shadowAdjustedOffset(focusPosition(visibleSelection()));
134 Node* DOMSelection::baseNode() const
139 return shadowAdjustedNode(basePosition(visibleSelection()));
142 int DOMSelection::baseOffset() const
147 return shadowAdjustedOffset(basePosition(visibleSelection()));
150 Node* DOMSelection::extentNode() const
155 return shadowAdjustedNode(extentPosition(visibleSelection()));
158 int DOMSelection::extentOffset() const
163 return shadowAdjustedOffset(extentPosition(visibleSelection()));
166 bool DOMSelection::isCollapsed() const
168 if (!m_frame || selectionShadowAncestor(m_frame))
170 return !m_frame->selection().isRange();
173 String DOMSelection::type() const
178 FrameSelection& selection = m_frame->selection();
180 // This is a WebKit DOM extension, incompatible with an IE extension
181 // IE has this same attribute, but returns "none", "text" and "control"
182 // http://msdn.microsoft.com/en-us/library/ms534692(VS.85).aspx
183 if (selection.isNone())
185 if (selection.isCaret())
190 int DOMSelection::rangeCount() const
194 return m_frame->selection().isNone() ? 0 : 1;
197 void DOMSelection::collapse(Node* node, int offset, ExceptionState& exceptionState)
204 exceptionState.throwDOMException(IndexSizeError, String::number(offset) + " is not a valid offset.");
208 if (!isValidForPosition(node))
211 // FIXME: Eliminate legacy editing positions
212 m_frame->selection().moveTo(VisiblePosition(createLegacyEditingPosition(node, offset), DOWNSTREAM));
215 void DOMSelection::collapse(Node* node, ExceptionState& exceptionState)
217 collapse(node, 0, exceptionState);
220 void DOMSelection::collapseToEnd(ExceptionState& exceptionState)
225 const VisibleSelection& selection = m_frame->selection().selection();
227 if (selection.isNone()) {
228 exceptionState.throwDOMException(InvalidStateError, "there is no selection.");
232 m_frame->selection().moveTo(VisiblePosition(selection.end(), DOWNSTREAM));
235 void DOMSelection::collapseToStart(ExceptionState& exceptionState)
240 const VisibleSelection& selection = m_frame->selection().selection();
242 if (selection.isNone()) {
243 exceptionState.throwDOMException(InvalidStateError, "there is no selection.");
247 m_frame->selection().moveTo(VisiblePosition(selection.start(), DOWNSTREAM));
250 void DOMSelection::empty()
254 m_frame->selection().clear();
257 void DOMSelection::setBaseAndExtent(Node* baseNode, int baseOffset, Node* extentNode, int extentOffset, ExceptionState& exceptionState)
262 if (baseOffset < 0) {
263 exceptionState.throwDOMException(IndexSizeError, String::number(baseOffset) + " is not a valid base offset.");
267 if (extentOffset < 0) {
268 exceptionState.throwDOMException(IndexSizeError, String::number(extentOffset) + " is not a valid extent offset.");
272 if (!isValidForPosition(baseNode) || !isValidForPosition(extentNode))
275 // FIXME: Eliminate legacy editing positions
276 VisiblePosition visibleBase = VisiblePosition(createLegacyEditingPosition(baseNode, baseOffset), DOWNSTREAM);
277 VisiblePosition visibleExtent = VisiblePosition(createLegacyEditingPosition(extentNode, extentOffset), DOWNSTREAM);
279 m_frame->selection().moveTo(visibleBase, visibleExtent);
282 void DOMSelection::modify(const String& alterString, const String& directionString, const String& granularityString)
287 FrameSelection::EAlteration alter;
288 if (equalIgnoringCase(alterString, "extend"))
289 alter = FrameSelection::AlterationExtend;
290 else if (equalIgnoringCase(alterString, "move"))
291 alter = FrameSelection::AlterationMove;
295 SelectionDirection direction;
296 if (equalIgnoringCase(directionString, "forward"))
297 direction = DirectionForward;
298 else if (equalIgnoringCase(directionString, "backward"))
299 direction = DirectionBackward;
300 else if (equalIgnoringCase(directionString, "left"))
301 direction = DirectionLeft;
302 else if (equalIgnoringCase(directionString, "right"))
303 direction = DirectionRight;
307 TextGranularity granularity;
308 if (equalIgnoringCase(granularityString, "character"))
309 granularity = CharacterGranularity;
310 else if (equalIgnoringCase(granularityString, "word"))
311 granularity = WordGranularity;
312 else if (equalIgnoringCase(granularityString, "sentence"))
313 granularity = SentenceGranularity;
314 else if (equalIgnoringCase(granularityString, "line"))
315 granularity = LineGranularity;
316 else if (equalIgnoringCase(granularityString, "paragraph"))
317 granularity = ParagraphGranularity;
318 else if (equalIgnoringCase(granularityString, "lineboundary"))
319 granularity = LineBoundary;
320 else if (equalIgnoringCase(granularityString, "sentenceboundary"))
321 granularity = SentenceBoundary;
322 else if (equalIgnoringCase(granularityString, "paragraphboundary"))
323 granularity = ParagraphBoundary;
324 else if (equalIgnoringCase(granularityString, "documentboundary"))
325 granularity = DocumentBoundary;
329 m_frame->selection().modify(alter, direction, granularity);
332 void DOMSelection::extend(Node* node, int offset, ExceptionState& exceptionState)
338 exceptionState.throwDOMException(TypeMismatchError, ExceptionMessages::argumentNullOrIncorrectType(1, "Node"));
343 exceptionState.throwDOMException(IndexSizeError, String::number(offset) + " is not a valid offset.");
346 if (offset > (node->offsetInCharacters() ? caretMaxOffset(node) : (int)node->countChildren())) {
347 exceptionState.throwDOMException(IndexSizeError, String::number(offset) + " is larger than the given node's length.");
351 if (!isValidForPosition(node))
354 // FIXME: Eliminate legacy editing positions
355 m_frame->selection().setExtent(VisiblePosition(createLegacyEditingPosition(node, offset), DOWNSTREAM));
358 PassRefPtrWillBeRawPtr<Range> DOMSelection::getRangeAt(int index, ExceptionState& exceptionState)
363 if (index < 0 || index >= rangeCount()) {
364 exceptionState.throwDOMException(IndexSizeError, String::number(index) + " is not a valid index.");
368 // If you're hitting this, you've added broken multi-range selection support
369 ASSERT(rangeCount() == 1);
371 if (Node* shadowAncestor = selectionShadowAncestor(m_frame)) {
372 ASSERT(!shadowAncestor->isShadowRoot());
373 ContainerNode* container = shadowAncestor->parentOrShadowHostNode();
374 int offset = shadowAncestor->nodeIndex();
375 return Range::create(shadowAncestor->document(), container, offset, container, offset);
378 return m_frame->selection().firstRange();
381 void DOMSelection::removeAllRanges()
385 m_frame->selection().clear();
388 void DOMSelection::addRange(Range* newRange)
393 // FIXME: Should we throw DOMException for error cases below?
395 addConsoleError("The given range is null.");
399 if (!newRange->startContainer()) {
400 addConsoleError("The given range has no container. Perhaps 'detach()' has been invoked on it?");
404 FrameSelection& selection = m_frame->selection();
406 if (selection.isNone()) {
407 selection.setSelectedRange(newRange, VP_DEFAULT_AFFINITY);
411 RefPtrWillBeRawPtr<Range> originalRange = selection.firstRange();
413 if (originalRange->startContainer()->document() != newRange->startContainer()->document()) {
414 addConsoleError("The given range does not belong to the current selection's document.");
417 if (originalRange->startContainer()->treeScope() != newRange->startContainer()->treeScope()) {
418 addConsoleError("The given range and the current selection belong to two different document fragments.");
422 if (originalRange->compareBoundaryPoints(Range::START_TO_END, newRange, ASSERT_NO_EXCEPTION) < 0
423 || newRange->compareBoundaryPoints(Range::START_TO_END, originalRange.get(), ASSERT_NO_EXCEPTION) < 0) {
424 addConsoleError("Discontiguous selection is not supported.");
428 // FIXME: "Merge the ranges if they intersect" is Blink-specific behavior; other browsers supporting discontiguous
429 // selection (obviously) keep each Range added and return it in getRangeAt(). But it's unclear if we can really
430 // do the same, since we don't support discontiguous selection. Further discussions at
431 // <https://code.google.com/p/chromium/issues/detail?id=353069>.
433 Range* start = originalRange->compareBoundaryPoints(Range::START_TO_START, newRange, ASSERT_NO_EXCEPTION) < 0 ? originalRange.get() : newRange;
434 Range* end = originalRange->compareBoundaryPoints(Range::END_TO_END, newRange, ASSERT_NO_EXCEPTION) < 0 ? newRange : originalRange.get();
435 RefPtrWillBeRawPtr<Range> merged = Range::create(originalRange->startContainer()->document(), start->startContainer(), start->startOffset(), end->endContainer(), end->endOffset());
436 EAffinity affinity = selection.selection().affinity();
437 selection.setSelectedRange(merged.get(), affinity);
440 void DOMSelection::deleteFromDocument()
445 FrameSelection& selection = m_frame->selection();
447 if (selection.isNone())
450 RefPtrWillBeRawPtr<Range> selectedRange = selection.selection().toNormalizedRange();
454 selectedRange->deleteContents(ASSERT_NO_EXCEPTION);
456 setBaseAndExtent(selectedRange->startContainer(), selectedRange->startOffset(), selectedRange->startContainer(), selectedRange->startOffset(), ASSERT_NO_EXCEPTION);
459 bool DOMSelection::containsNode(const Node* n, bool allowPartial) const
464 FrameSelection& selection = m_frame->selection();
466 if (!n || m_frame->document() != n->document() || selection.isNone())
469 unsigned nodeIndex = n->nodeIndex();
470 RefPtrWillBeRawPtr<Range> selectedRange = selection.selection().toNormalizedRange();
472 ContainerNode* parentNode = n->parentNode();
476 TrackExceptionState exceptionState;
477 bool nodeFullySelected = Range::compareBoundaryPoints(parentNode, nodeIndex, selectedRange->startContainer(), selectedRange->startOffset(), exceptionState) >= 0 && !exceptionState.hadException()
478 && Range::compareBoundaryPoints(parentNode, nodeIndex + 1, selectedRange->endContainer(), selectedRange->endOffset(), exceptionState) <= 0 && !exceptionState.hadException();
479 if (exceptionState.hadException())
481 if (nodeFullySelected)
484 bool nodeFullyUnselected = (Range::compareBoundaryPoints(parentNode, nodeIndex, selectedRange->endContainer(), selectedRange->endOffset(), exceptionState) > 0 && !exceptionState.hadException())
485 || (Range::compareBoundaryPoints(parentNode, nodeIndex + 1, selectedRange->startContainer(), selectedRange->startOffset(), exceptionState) < 0 && !exceptionState.hadException());
486 ASSERT(!exceptionState.hadException());
487 if (nodeFullyUnselected)
490 return allowPartial || n->isTextNode();
493 void DOMSelection::selectAllChildren(Node* n, ExceptionState& exceptionState)
498 // This doesn't (and shouldn't) select text node characters.
499 setBaseAndExtent(n, 0, n, n->countChildren(), exceptionState);
502 String DOMSelection::toString()
507 return plainText(m_frame->selection().selection().toNormalizedRange().get());
510 Node* DOMSelection::shadowAdjustedNode(const Position& position) const
512 if (position.isNull())
515 Node* containerNode = position.containerNode();
516 Node* adjustedNode = m_treeScope->ancestorInThisScope(containerNode);
521 if (containerNode == adjustedNode)
522 return containerNode;
524 ASSERT(!adjustedNode->isShadowRoot());
525 return adjustedNode->parentOrShadowHostNode();
528 int DOMSelection::shadowAdjustedOffset(const Position& position) const
530 if (position.isNull())
533 Node* containerNode = position.containerNode();
534 Node* adjustedNode = m_treeScope->ancestorInThisScope(containerNode);
539 if (containerNode == adjustedNode)
540 return position.computeOffsetInContainerNode();
542 return adjustedNode->nodeIndex();
545 bool DOMSelection::isValidForPosition(Node* node) const
550 return node->document() == m_frame->document();
553 void DOMSelection::addConsoleError(const String& message)
556 m_treeScope->document().addConsoleMessage(JSMessageSource, ErrorMessageLevel, message);
559 } // namespace WebCore