Improve exception messages for detached Range objects.

Source/core/dom/Range.cpp

 /*
  * (C) 1999 Lars Knoll (knoll@kde.org)
  * (C) 2000 Gunnstein Lye (gunnstein@netcom.no)
  * (C) 2000 Frederik Holljen (frederik.holljen@hig.no)
  * (C) 2001 Peter Kelly (pmk@post.com)
  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
  * Copyright (C) 2011 Motorola Mobility. All rights reserved.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
@@ skipping 113 matching lines @@
     m_ownerDocument->detachRange(this);
     m_ownerDocument = &document;
     m_start.setToStartOfNode(&document);
     m_end.setToStartOfNode(&document);
     m_ownerDocument->attachRange(this);
 }
 
 Node* Range::startContainer(ExceptionState& es) const
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("startContainer", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return 0;
     }
 
     return m_start.container();
 }
 
 int Range::startOffset(ExceptionState& es) const
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("startOffset", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return 0;
     }
 
     return m_start.offset();
 }
 
 Node* Range::endContainer(ExceptionState& es) const
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("endContainer", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return 0;
     }
 
     return m_end.container();
 }
 
 int Range::endOffset(ExceptionState& es) const
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("endOffset", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return 0;
     }
 
     return m_end.offset();
 }
 
 Node* Range::commonAncestorContainer(ExceptionState& es) const
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("commonAncestorContainer", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return 0;
     }
 
     return commonAncestorContainer(m_start.container(), m_end.container());
 }
 
 Node* Range::commonAncestorContainer(Node* containerA, Node* containerB)
 {
     for (Node* parentA = containerA; parentA; parentA = parentA->parentNode()) {
         for (Node* parentB = containerB; parentB; parentB = parentB->parentNode()) {
             if (parentA == parentB)
                 return parentA;
         }
     }
     return 0;
 }
 
 bool Range::collapsed(ExceptionState& es) const
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("collapsed", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return 0;
     }
 
     return m_start == m_end;
 }
 
 static inline bool checkForDifferentRootContainer(const RangeBoundaryPoint& start, const RangeBoundaryPoint& end)
 {
     Node* endRootContainer = end.container();
     while (endRootContainer->parentNode())
         endRootContainer = endRootContainer->parentNode();
     Node* startRootContainer = start.container();
     while (startRootContainer->parentNode())
         startRootContainer = startRootContainer->parentNode();
 
     return startRootContainer != endRootContainer || (Range::compareBoundaryPoints(start, end, ASSERT_NO_EXCEPTION) > 0);
 }
 
 void Range::setStart(PassRefPtr<Node> refNode, int offset, ExceptionState& es)
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("setStart", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return;
     }
 
     if (!refNode) {
         es.throwDOMException(NotFoundError);
         return;
     }
 
     bool didMoveDocument = false;
     if (&refNode->document() != m_ownerDocument) {
         setDocument(refNode->document());
         didMoveDocument = true;
     }
 
     Node* childNode = checkNodeWOffset(refNode.get(), offset, es);
     if (es.hadException())
         return;
 
     m_start.set(refNode, offset, childNode);
 
     if (didMoveDocument || checkForDifferentRootContainer(m_start, m_end))
         collapse(true, es);
 }
 
 void Range::setEnd(PassRefPtr<Node> refNode, int offset, ExceptionState& es)
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("setEnd", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return;
     }
 
     if (!refNode) {
         es.throwDOMException(NotFoundError);
         return;
     }
 
     bool didMoveDocument = false;
     if (&refNode->document() != m_ownerDocument) {
@@ skipping 19 matching lines @@
 
 void Range::setEnd(const Position& end, ExceptionState& es)
 {
     Position parentAnchored = end.parentAnchoredEquivalent();
     setEnd(parentAnchored.containerNode(), parentAnchored.offsetInContainerNode(), es);
 }
 
 void Range::collapse(bool toStart, ExceptionState& es)
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("collapse", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return;
     }
 
     if (toStart)
         m_end = m_start;
     else
         m_start = m_end;
 }
 
 bool Range::isPointInRange(Node* refNode, int offset, ExceptionState& es)
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("isPointInRange", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return false;
     }
 
     if (!refNode) {
         es.throwDOMException(HierarchyRequestError);
         return false;
     }
 
     if (!refNode->attached() || &refNode->document() != m_ownerDocument) {
         return false;
     }
 
     checkNodeWOffset(refNode, offset, es);
     if (es.hadException())
         return false;
 
     return compareBoundaryPoints(refNode, offset, m_start.container(), m_start.offset(), es) >= 0 && !es.hadException()
         && compareBoundaryPoints(refNode, offset, m_end.container(), m_end.offset(), es) <= 0 && !es.hadException();
 }
 
 short Range::comparePoint(Node* refNode, int offset, ExceptionState& es) const
 {
     // http://developer.mozilla.org/en/docs/DOM:range.comparePoint
     // This method returns -1, 0 or 1 depending on if the point described by the
     // refNode node and an offset within the node is before, same as, or after the range respectively.
 
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("comparePoint", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return 0;
     }
 
     if (!refNode) {
         es.throwDOMException(HierarchyRequestError);
         return 0;
     }
 
     if (!refNode->attached() || &refNode->document() != m_ownerDocument) {
         es.throwDOMException(WrongDocumentError);
@@ skipping 62 matching lines @@
     }
     // starts at or after the range start
     if (comparePoint(parentNode, nodeIndex + 1, es) > 0) // ends after the range
         return NODE_AFTER;
     return NODE_INSIDE; // ends inside the range
 }
 
 short Range::compareBoundaryPoints(CompareHow how, const Range* sourceRange, ExceptionState& es) const
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("compareBoundaryPoints", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return 0;
     }
 
     if (!sourceRange) {
         es.throwDOMException(NotFoundError);
         return 0;
     }
 
     Node* thisCont = commonAncestorContainer(es);
     if (es.hadException())
@@ skipping 132 matching lines @@
 }
 
 bool Range::boundaryPointsValid() const
 {
     TrackExceptionState es;
     return m_start.container() && compareBoundaryPoints(m_start, m_end, es) <= 0 && !es.hadException();
 }
 
 void Range::deleteContents(ExceptionState& es)
 {
-    checkDeleteExtract(es);
+    checkDeleteExtract("deleteContents", es);
     if (es.hadException())
         return;
 
     processContents(DELETE_CONTENTS, es);
 }
 
 bool Range::intersectsNode(Node* refNode, ExceptionState& es)
 {
     // http://developer.mozilla.org/en/docs/DOM:range.intersectsNode
     // Returns a bool if the node intersects the range.
 
     // Throw exception if the range is already detached.
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("intersectsNode", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return false;
     }
     if (!refNode) {
         es.throwDOMException(NotFoundError);
         return false;
     }
 
     if (!refNode->attached() || &refNode->document() != m_ownerDocument) {
         // Firefox doesn't throw an exception for these cases; it returns false.
         return false;
@@ skipping 334 matching lines @@
             }
         }
         firstChildInAncestorToProcess = direction == ProcessContentsForward ? ancestor->nextSibling() : ancestor->previousSibling();
     }
 
     return clonedContainer.release();
 }
 
 PassRefPtr<DocumentFragment> Range::extractContents(ExceptionState& es)
 {
-    checkDeleteExtract(es);
+    checkDeleteExtract("extractContents", es);
     if (es.hadException())
         return 0;
 
     return processContents(EXTRACT_CONTENTS, es);
 }
 
 PassRefPtr<DocumentFragment> Range::cloneContents(ExceptionState& es)
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("cloneContents", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return 0;
     }
 
     return processContents(CLONE_CONTENTS, es);
 }
 
 void Range::insertNode(PassRefPtr<Node> prpNewNode, ExceptionState& es)
 {
     RefPtr<Node> newNode = prpNewNode;
 
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("insertNode", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return;
     }
 
     if (!newNode) {
         es.throwDOMException(NotFoundError);
         return;
     }
 
     // HierarchyRequestError: Raised if the container of the start of the Range is of a type that
     // does not allow children of the type of newNode or if newNode is an ancestor of the container.
@@ skipping 84 matching lines @@
             return;
 
         if (collapsed && numNewChildren)
             m_end.set(m_start.container(), startOffset + numNewChildren, lastChild.get());
     }
 }
 
 String Range::toString(ExceptionState& es) const
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("toString", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return String();
     }
 
     StringBuilder builder;
 
     Node* pastLast = pastLastNode();
     for (Node* n = firstNode(); n != pastLast; n = NodeTraversal::next(n)) {
         if (n->nodeType() == Node::TEXT_NODE || n->nodeType() == Node::CDATA_SECTION_NODE) {
             String data = toCharacterData(n)->data();
             int length = data.length();
@@ skipping 19 matching lines @@
     // We need to update layout, since plainText uses line boxes in the render tree.
     // FIXME: As with innerText, we'd like this to work even if there are no render objects.
     m_start.container()->document().updateLayout();
 
     return plainText(this);
 }
 
 PassRefPtr<DocumentFragment> Range::createContextualFragment(const String& markup, ExceptionState& es)
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("createContextualFragment", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return 0;
     }
 
     Node* element = m_start.container()->isElementNode() ? m_start.container() : m_start.container()->parentNode();
     if (!element || !element->isHTMLElement()) {
         es.throwDOMException(NotSupportedError);
         return 0;
     }
 
     RefPtr<DocumentFragment> fragment = WebCore::createContextualFragment(markup, toHTMLElement(element), AllowScriptingContentAndDoNotMarkAlreadyStarted, es);
     if (!fragment)
         return 0;
 
     return fragment.release();
 }
 
 
 void Range::detach(ExceptionState& es)
 {
     // Check first to see if we've already detached:
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("detach", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return;
     }
 
     m_ownerDocument->detachRange(this);
 
     m_start.clear();
     m_end.clear();
 }
 
 Node* Range::checkNodeWOffset(Node* n, int offset, ExceptionState& es) const
@@ skipping 24 matching lines @@
             Node* childBefore = n->childNode(offset - 1);
             if (!childBefore)
                 es.throwDOMException(IndexSizeError);
             return childBefore;
         }
     }
     ASSERT_NOT_REACHED();
     return 0;
 }
 
-void Range::checkNodeBA(Node* n, ExceptionState& es, const char* methodName) const
+void Range::checkNodeBA(Node* n, const String& methodName, ExceptionState& es) const
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute(methodName, "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return;
     }
 
     if (!n) {
         es.throwDOMException(NotFoundError);
         return;
     }
 
     // InvalidNodeTypeError: Raised if the root container of refNode is not an
     // Attr, Document, DocumentFragment or ShadowRoot node, or part of a SVG shadow DOM tree,
@@ skipping 41 matching lines @@
         case Node::TEXT_NODE:
         case Node::XPATH_NAMESPACE_NODE:
             es.throwDOMException(InvalidNodeTypeError);
             return;
     }
 }
 
 PassRefPtr<Range> Range::cloneRange(ExceptionState& es) const
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("cloneRange", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return 0;
     }
 
     return Range::create(*m_ownerDocument.get(), m_start.container(), m_start.offset(), m_end.container(), m_end.offset());
 }
 
 void Range::setStartAfter(Node* refNode, ExceptionState& es)
 {
-    checkNodeBA(refNode, es, "setStartAfter");
+    checkNodeBA(refNode, "setStartAfter", es);
     if (es.hadException())
         return;
 
     setStart(refNode->parentNode(), refNode->nodeIndex() + 1, es);
 }
 
 void Range::setEndBefore(Node* refNode, ExceptionState& es)
 {
-    checkNodeBA(refNode, es, "setEndBefore");
+    checkNodeBA(refNode, "setEndBefore", es);
     if (es.hadException())
         return;
 
     setEnd(refNode->parentNode(), refNode->nodeIndex(), es);
 }
 
 void Range::setEndAfter(Node* refNode, ExceptionState& es)
 {
-    checkNodeBA(refNode, es, "setEndAfter");
+    checkNodeBA(refNode, "setEndAfter", es);
     if (es.hadException())
         return;
 
     setEnd(refNode->parentNode(), refNode->nodeIndex() + 1, es);
 }
 
 void Range::selectNode(Node* refNode, ExceptionState& es)
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("selectNode", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return;
     }
 
     if (!refNode) {
         es.throwDOMException(NotFoundError);
         return;
     }
 
     if (!refNode->parentNode()) {
         es.throwDOMException(InvalidNodeTypeError, ExceptionMessages::failedToExecute("selectNode", "Range", "the given Node has no parent."));
@@ skipping 44 matching lines @@
     if (m_ownerDocument != &refNode->document())
         setDocument(refNode->document());
 
     setStartBefore(refNode);
     setEndAfter(refNode);
 }
 
 void Range::selectNodeContents(Node* refNode, ExceptionState& es)
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("selectNodeContents", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return;
     }
 
     if (!refNode) {
         es.throwDOMException(NotFoundError);
         return;
     }
 
     // InvalidNodeTypeError: Raised if refNode or an ancestor of refNode is an Entity, Notation
     // or DocumentType node.
@@ skipping 22 matching lines @@
 
     m_start.setToStartOfNode(refNode);
     m_end.setToEndOfNode(refNode);
 }
 
 void Range::surroundContents(PassRefPtr<Node> passNewParent, ExceptionState& es)
 {
     RefPtr<Node> newParent = passNewParent;
 
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute("surroundContents", "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return;
     }
 
     if (!newParent) {
         es.throwDOMException(NotFoundError);
         return;
     }
 
     // InvalidNodeTypeError: Raised if node is an Attr, Entity, DocumentType, Notation,
     // Document, or DocumentFragment node.
@@ skipping 60 matching lines @@
     if (es.hadException())
         return;
     newParent->appendChild(fragment.release(), es);
     if (es.hadException())
         return;
     selectNode(newParent.get(), es);
 }
 
 void Range::setStartBefore(Node* refNode, ExceptionState& es)
 {
-    checkNodeBA(refNode, es, "setStartBefore");
+    checkNodeBA(refNode, "setStartBefore", es);
     if (es.hadException())
         return;
 
     setStart(refNode->parentNode(), refNode->nodeIndex(), es);
 }
 
-void Range::checkDeleteExtract(ExceptionState& es)
+void Range::checkDeleteExtract(const String& methodName, ExceptionState& es)
 {
     if (!m_start.container()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, ExceptionMessages::failedToExecute(methodName, "Range", "The range has no container. Perhaps 'detatch()' has been invoked on this object?"));
         return;
     }
 
     if (!commonAncestorContainer(es) || es.hadException())
         return;
 
     Node* pastLast = pastLastNode();
     for (Node* n = firstNode(); n != pastLast; n = NodeTraversal::next(n)) {
         if (n->nodeType() == Node::DOCUMENT_TYPE_NODE) {
             es.throwDOMException(HierarchyRequestError);
@@ skipping 424 matching lines @@
 
 void showTree(const WebCore::Range* range)
 {
     if (range && range->boundaryPointsValid()) {
         range->startContainer()->showTreeAndMark(range->startContainer(), "S", range->endContainer(), "E");
         fprintf(stderr, "start offset: %d, end offset: %d\n", range->startOffset(), range->endOffset());
     }
 }
 
 #endif