/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is mozilla.org code. * * The Initial Developer of the Original Code is * Netscape Communications Corporation. * Portions created by the Initial Developer are Copyright (C) 1998 * the Initial Developer. All Rights Reserved. * * Contributor(s): * * Alternatively, the contents of this file may be used under the terms of * either of the GNU General Public License Version 2 or later (the "GPL"), * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ /* * Implementation of the DOM nsIDOMRange object. */ #include "nscore.h" #include "nsRange.h" #include "nsString.h" #include "nsReadableUtils.h" #include "nsIDOMNode.h" #include "nsIDOMDocument.h" #include "nsIDOMNSDocument.h" #include "nsIDOMDocumentFragment.h" #include "nsIContent.h" #include "nsIDocument.h" #include "nsIDOMText.h" #include "nsDOMError.h" #include "nsIContentIterator.h" #include "nsIDOMNodeList.h" #include "nsContentUtils.h" nsresult NS_NewContentIterator(nsIContentIterator** aInstancePtrResult); nsresult NS_NewContentSubtreeIterator(nsIContentIterator** aInstancePtrResult); /****************************************************** * stack based utilty class for managing monitor ******************************************************/ // NS_ERROR_DOM_NOT_OBJECT_ERR is not the correct one to throw, but spec doesn't say // what is #define VALIDATE_ACCESS(node_) \ PR_BEGIN_MACRO \ if (!node_) { \ return NS_ERROR_DOM_NOT_OBJECT_ERR; \ } \ if (!nsContentUtils::CanCallerAccess(node_)) { \ return NS_ERROR_DOM_SECURITY_ERR; \ } \ if (IsDetached()) { \ return NS_ERROR_DOM_INVALID_STATE_ERR; \ } \ PR_END_MACRO /* static */ PRInt32 nsRange::ComparePoints(nsIDOMNode* aParent1, PRInt32 aOffset1, nsIDOMNode* aParent2, PRInt32 aOffset2) { if (aParent1 == aParent2) { return (aOffset1 < aOffset2) ? -1 : ((aOffset1 > aOffset2) ? 1 : 0); } return IsIncreasing(aParent1, aOffset1, aParent2, aOffset2) ? -1 : 1; } // Utility routine to detect if a content node intersects a range /* static */ PRBool nsRange::IsNodeIntersectsRange(nsIContent* aNode, nsIDOMRange* aRange) { // create a pair of dom points that expresses location of node: // NODE(start), NODE(end) // Let incoming range be: // {RANGE(start), RANGE(end)} // if (RANGE(start) < NODE(end)) and (RANGE(end) > NODE(start)) // then the Node intersect the Range. if (!aNode) return PR_FALSE; nsCOMPtr parent, rangeStartParent, rangeEndParent; PRInt32 nodeStart, nodeEnd, rangeStartOffset, rangeEndOffset; // gather up the dom point info if (!GetNodeBracketPoints(aNode, address_of(parent), &nodeStart, &nodeEnd)) return PR_FALSE; if (NS_FAILED(aRange->GetStartContainer(getter_AddRefs(rangeStartParent)))) return PR_FALSE; if (NS_FAILED(aRange->GetStartOffset(&rangeStartOffset))) return PR_FALSE; if (NS_FAILED(aRange->GetEndContainer(getter_AddRefs(rangeEndParent)))) return PR_FALSE; if (NS_FAILED(aRange->GetEndOffset(&rangeEndOffset))) return PR_FALSE; // is RANGE(start) < NODE(end) ? PRInt32 comp = ComparePoints(rangeStartParent, rangeStartOffset, parent, nodeEnd); if (comp >= 0) return PR_FALSE; // range start is after node end // is RANGE(end) > NODE(start) ? comp = ComparePoints(rangeEndParent, rangeEndOffset, parent, nodeStart); if (comp <= 0) return PR_FALSE; // range end is before node start // if we got here then the node intersects the range return PR_TRUE; } // Utility routine to detect if a content node is completely contained in a range // If outNodeBefore is returned true, then the node starts before the range does. // If outNodeAfter is returned true, then the node ends after the range does. // Note that both of the above might be true. // If neither are true, the node is contained inside of the range. // XXX - callers responsibility to ensure node in same doc as range! // static nsresult nsRange::CompareNodeToRange(nsIContent* aNode, nsIDOMRange* aRange, PRBool *outNodeBefore, PRBool *outNodeAfter) { // create a pair of dom points that expresses location of node: // NODE(start), NODE(end) // Let incoming range be: // {RANGE(start), RANGE(end)} // if (RANGE(start) <= NODE(start)) and (RANGE(end) => NODE(end)) // then the Node is contained (completely) by the Range. if (!aNode) return NS_ERROR_NULL_POINTER; if (!aRange) return NS_ERROR_NULL_POINTER; if (!outNodeBefore) return NS_ERROR_NULL_POINTER; if (!outNodeAfter) return NS_ERROR_NULL_POINTER; PRBool isPositioned; nsresult err = ((nsRange*)aRange)->GetIsPositioned(&isPositioned); // Why do I have to cast above? Because GetIsPositioned() is // mysteriously missing from the nsIDOMRange interface. dunno why. if (NS_FAILED(err)) return err; if (!isPositioned) return NS_ERROR_UNEXPECTED; nsCOMPtr parent, rangeStartParent, rangeEndParent; PRInt32 nodeStart, nodeEnd, rangeStartOffset, rangeEndOffset; // gather up the dom point info if (!GetNodeBracketPoints(aNode, address_of(parent), &nodeStart, &nodeEnd)) return NS_ERROR_FAILURE; if (NS_FAILED(aRange->GetStartContainer(getter_AddRefs(rangeStartParent)))) return NS_ERROR_FAILURE; if (NS_FAILED(aRange->GetStartOffset(&rangeStartOffset))) return NS_ERROR_FAILURE; if (NS_FAILED(aRange->GetEndContainer(getter_AddRefs(rangeEndParent)))) return NS_ERROR_FAILURE; if (NS_FAILED(aRange->GetEndOffset(&rangeEndOffset))) return NS_ERROR_FAILURE; *outNodeBefore = PR_FALSE; *outNodeAfter = PR_FALSE; // is RANGE(start) <= NODE(start) ? PRInt32 comp = ComparePoints(rangeStartParent, rangeStartOffset, parent, nodeStart); if (comp > 0) *outNodeBefore = PR_TRUE; // range start is after node start // is RANGE(end) >= NODE(end) ? comp = ComparePoints(rangeEndParent, rangeEndOffset, parent, nodeEnd); if (comp < 0) *outNodeAfter = PR_TRUE; // range end is before node end return NS_OK; } // Utility routine to create a pair of dom points to represent // the start and end locations of a single node. Return false // if we dont' succeed. PRBool GetNodeBracketPoints(nsIContent* aNode, nsCOMPtr* outParent, PRInt32* outStartOffset, PRInt32* outEndOffset) { if (!aNode) return PR_FALSE; if (!outParent) return PR_FALSE; if (!outStartOffset) return PR_FALSE; if (!outEndOffset) return PR_FALSE; nsIContent* parent = aNode->GetParent(); if (!parent) // special case for root node { // can't make a parent/offset pair to represent start or // end of the root node, becasue it has no parent. // so instead represent it by (node,0) and (node,numChildren) *outParent = do_QueryInterface(aNode); PRUint32 indx = aNode->GetChildCount(); if (!indx) return PR_FALSE; *outStartOffset = 0; *outEndOffset = indx; } else { *outParent = do_QueryInterface(parent); *outStartOffset = parent->IndexOf(aNode); *outEndOffset = *outStartOffset+1; } return PR_TRUE; } /****************************************************** * non members ******************************************************/ nsresult NS_NewRangeUtils(nsIRangeUtils** aResult) { NS_ENSURE_ARG_POINTER(aResult); nsRangeUtils* rangeUtil = new nsRangeUtils(); if (!rangeUtil) { return NS_ERROR_OUT_OF_MEMORY; } return CallQueryInterface(rangeUtil, aResult); } /****************************************************** * constructor/destructor ******************************************************/ nsRangeUtils::nsRangeUtils() { } nsRangeUtils::~nsRangeUtils() { } /****************************************************** * nsISupports ******************************************************/ NS_IMPL_ISUPPORTS1(nsRangeUtils, nsIRangeUtils) /****************************************************** * nsIRangeUtils methods ******************************************************/ NS_IMETHODIMP_(PRInt32) nsRangeUtils::ComparePoints(nsIDOMNode* aParent1, PRInt32 aOffset1, nsIDOMNode* aParent2, PRInt32 aOffset2) { return nsRange::ComparePoints(aParent1, aOffset1, aParent2, aOffset2); } NS_IMETHODIMP_(PRBool) nsRangeUtils::IsNodeIntersectsRange(nsIContent* aNode, nsIDOMRange* aRange) { return nsRange::IsNodeIntersectsRange( aNode, aRange); } NS_IMETHODIMP nsRangeUtils::CompareNodeToRange(nsIContent* aNode, nsIDOMRange* aRange, PRBool *outNodeBefore, PRBool *outNodeAfter) { return nsRange::CompareNodeToRange(aNode, aRange, outNodeBefore, outNodeAfter); } /****************************************************** * non members ******************************************************/ nsresult NS_NewRange(nsIDOMRange** aResult) { NS_ENSURE_ARG_POINTER(aResult); nsRange * range = new nsRange(); if (!range) { return NS_ERROR_OUT_OF_MEMORY; } return CallQueryInterface(range, aResult); } /****************************************************** * constructor/destructor ******************************************************/ nsRange::nsRange() : mIsPositioned(PR_FALSE), mIsDetached(PR_FALSE), mStartOffset(0), mEndOffset(0), mStartParent(), mEndParent() { } nsRange::~nsRange() { DoSetRange(nsCOMPtr(),0,nsCOMPtr(),0); // we want the side effects (releases and list removals) // note that "nsCOMPtr()" is the moral equivalent of null } /****************************************************** * nsISupports ******************************************************/ // QueryInterface implementation for nsRange NS_INTERFACE_MAP_BEGIN(nsRange) NS_INTERFACE_MAP_ENTRY(nsIDOMRange) NS_INTERFACE_MAP_ENTRY(nsIDOMNSRange) NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIDOMRange) NS_INTERFACE_MAP_ENTRY_CONTENT_CLASSINFO(Range) NS_INTERFACE_MAP_END NS_IMPL_ADDREF(nsRange) NS_IMPL_RELEASE(nsRange) /******************************************************** * Utilities for comparing points: API from nsIDOMNSRange ********************************************************/ NS_IMETHODIMP nsRange::IsPointInRange(nsIDOMNode* aParent, PRInt32 aOffset, PRBool* aResult) { PRInt16 compareResult = 0; nsresult res; res = ComparePoint(aParent, aOffset, &compareResult); if (compareResult) *aResult = PR_FALSE; else *aResult = PR_TRUE; return res; } // returns -1 if point is before range, 0 if point is in range, // 1 if point is after range. NS_IMETHODIMP nsRange::ComparePoint(nsIDOMNode* aParent, PRInt32 aOffset, PRInt16* aResult) { // check arguments if (!aResult) return NS_ERROR_NULL_POINTER; // no trivial cases please if (!aParent) return NS_ERROR_NULL_POINTER; // our range is in a good state? if (!mIsPositioned) return NS_ERROR_NOT_INITIALIZED; // check common case first if ((aParent == mStartParent.get()) && (aParent == mEndParent.get())) { if (aOffsetmEndOffset) { *aResult = 1; return NS_OK; } *aResult = 0; return NS_OK; } // more common cases if ((aParent == mStartParent.get()) && (aOffset == mStartOffset)) { *aResult = 0; return NS_OK; } if ((aParent == mEndParent.get()) && (aOffset == mEndOffset)) { *aResult = 0; return NS_OK; } // ok, do it the hard way if (IsIncreasing(aParent,aOffset,mStartParent,mStartOffset)) *aResult = -1; else if (IsIncreasing(mEndParent,mEndOffset,aParent,aOffset)) *aResult = 1; else *aResult = 0; return NS_OK; } NS_IMETHODIMP nsRange::IntersectsNode(nsIDOMNode* aNode, PRBool* aReturn) { if (!aReturn) return NS_ERROR_NULL_POINTER; nsCOMPtr content (do_QueryInterface(aNode)); if (!content) { *aReturn = 0; return NS_ERROR_UNEXPECTED; } *aReturn = IsNodeIntersectsRange(content, this); return NS_OK; } // HOW does the node intersect the range? NS_IMETHODIMP nsRange::CompareNode(nsIDOMNode* aNode, PRUint16* aReturn) { if (!aReturn) return NS_ERROR_NULL_POINTER; *aReturn = 0; PRBool nodeBefore, nodeAfter; nsCOMPtr content (do_QueryInterface(aNode)); if (!content) return NS_ERROR_UNEXPECTED; nsresult res = CompareNodeToRange(content, this, &nodeBefore, &nodeAfter); if (NS_FAILED(res)) return res; // nodeBefore -> range start after node start, i.e. node starts before range. // nodeAfter -> range end before node end, i.e. node ends after range. // But I know that I get nodeBefore && !nodeAfter when the node is // entirely inside the selection! This doesn't make sense. if (nodeBefore && !nodeAfter) *aReturn = nsIDOMNSRange::NODE_BEFORE; // May or may not intersect else if (!nodeBefore && nodeAfter) *aReturn = nsIDOMNSRange::NODE_AFTER; // May or may not intersect else if (nodeBefore && nodeAfter) *aReturn = nsIDOMNSRange::NODE_BEFORE_AND_AFTER; // definitely intersects else *aReturn = nsIDOMNSRange::NODE_INSIDE; // definitely intersects return NS_OK; } nsresult nsRange::NSDetach() { return DoSetRange(nsnull,0,nsnull,0); } /****************************************************** * Private helper routines ******************************************************/ nsresult nsRange::AddToListOf(nsIDOMNode* aNode) { if (!aNode) return NS_ERROR_NULL_POINTER; nsresult res; nsCOMPtr cN = do_QueryInterface(aNode, &res); if (NS_FAILED(res)) return res; res = cN->RangeAdd(NS_STATIC_CAST(nsIDOMRange*,this)); return res; } void nsRange::RemoveFromListOf(nsIDOMNode* aNode) { nsCOMPtr content(do_QueryInterface(aNode)); if (content) content->RangeRemove(NS_STATIC_CAST(nsIDOMRange *, this)); } // Get the length of aNode PRInt32 nsRange::GetNodeLength(nsIDOMNode *aNode) { if (!aNode) return 0; PRUint16 nodeType; PRInt32 len = -1; aNode->GetNodeType(&nodeType); if( (nodeType == nsIDOMNode::CDATA_SECTION_NODE) || (nodeType == nsIDOMNode::TEXT_NODE) ) { nsCOMPtr textText = do_QueryInterface(aNode); if (textText) textText->GetLength((PRUint32 *)&len); } else { nsCOMPtr childList; nsresult res = aNode->GetChildNodes(getter_AddRefs(childList)); if (NS_SUCCEEDED(res) && childList) childList->GetLength((PRUint32 *)&len); } return len; } // It's important that all setting of the range start/end points // go through this function, which will do all the right voodoo // for content notification of range ownership. // Calling DoSetRange with either parent argument null will collapse // the range to have both endpoints point to the other node nsresult nsRange::DoSetRange(nsIDOMNode* aStartN, PRInt32 aStartOffset, nsIDOMNode* aEndN, PRInt32 aEndOffset) { //if only one endpoint is null, set it to the other one if (aStartN && !aEndN) { aEndN = aStartN; aEndOffset = aStartOffset; } if (aEndN && !aStartN) { aStartN = aEndN; aStartOffset = aEndOffset; } if (mStartParent && (mStartParent.get() != aStartN) && (mStartParent.get() != aEndN)) { // if old start parent no longer involved, remove range from that // node's range list. RemoveFromListOf(mStartParent); } if (mEndParent && (mEndParent.get() != aStartN) && (mEndParent.get() != aEndN)) { // if old end parent no longer involved, remove range from that // node's range list. RemoveFromListOf(mEndParent); } if (mStartParent.get() != aStartN) { mStartParent = do_QueryInterface(aStartN); if (mStartParent) // if it has a new start node, put it on it's list { AddToListOf(mStartParent); // AddToList() detects duplication for us } } mStartOffset = aStartOffset; if (mEndParent.get() != aEndN) { mEndParent = do_QueryInterface(aEndN); if (mEndParent) // if it has a new end node, put it on it's list { AddToListOf(mEndParent); // AddToList() detects duplication for us } } mEndOffset = aEndOffset; if (mStartParent) mIsPositioned = PR_TRUE; else mIsPositioned = PR_FALSE; // FIX ME need to handle error cases // (range lists return error, or setting only one endpoint to null) return NS_OK; } PRBool nsRange::IsIncreasing(nsIDOMNode* aStartN, PRInt32 aStartOffset, nsIDOMNode* aEndN, PRInt32 aEndOffset) { // no trivial cases please if (!aStartN || !aEndN) return PR_FALSE; // check common case first if (aStartN == aEndN) { return aStartOffset <= aEndOffset; } nsCOMPtr startCont = do_QueryInterface(aStartN); nsCOMPtr endCont = do_QueryInterface(aEndN); nsAutoVoidArray startAncestors, endAncestors; nsIContent* node = startCont; while (node) { startAncestors.AppendElement(node); node = node->GetParent(); } node = endCont; while (node) { endAncestors.AppendElement(node); node = node->GetParent(); } // Get the number of ancestors, adjusting for zero-based counting. PRInt32 startIdx = startAncestors.Count() - 1; PRInt32 endIdx = endAncestors.Count() - 1; // Ensure that we actually have ancestors to iterate through if (startIdx < 0) { if (startIdx < endIdx) { return PR_TRUE; } return PR_FALSE; } if (endIdx < 0) { return PR_FALSE; } // back through the ancestors, starting from the root, until first non-matching ancestor found do { --startIdx; --endIdx; // numStartAncestors will only be <0 if one endpoint's node is the // common ancestor of the other } while (startIdx >= 0 && endIdx >= 0 && startAncestors.FastElementAt(startIdx) == endAncestors.FastElementAt(endIdx)); // now back up one and that's the last common ancestor from the root, // or the first common ancestor from the leaf perspective ++startIdx; ++endIdx; // both indexes are now >= 0 PRInt32 commonNodeStartOffset = startIdx == 0 ? aStartOffset : NS_STATIC_CAST(nsIContent*, startAncestors.FastElementAt(startIdx))->IndexOf( NS_STATIC_CAST(nsIContent*, startAncestors.FastElementAt(startIdx - 1))); PRInt32 commonNodeEndOffset = endIdx == 0 ? aEndOffset : NS_STATIC_CAST(nsIContent*, endAncestors.FastElementAt(endIdx))->IndexOf( NS_STATIC_CAST(nsIContent*, endAncestors.FastElementAt(endIdx - 1))); if (commonNodeStartOffset > commonNodeEndOffset) { return PR_FALSE; } if (commonNodeStartOffset < commonNodeEndOffset) { return PR_TRUE; } // The offsets are equal. This can happen when one endpoint parent is the common parent // of both endpoints. In this case, we compare the depth of the ancestor tree to determine // the ordering. NS_ASSERTION(startIdx != endIdx, "whoa nelly. this shouldn't happen"); return startIdx < endIdx; } PRInt32 nsRange::IndexOf(nsIDOMNode* aChildNode) { // convert node to nsIContent, so that we can find the child index nsCOMPtr contentChild = do_QueryInterface(aChildNode); if (!contentChild) return 0; nsIContent *parent = contentChild->GetParent(); if (!parent) return 0; // finally we get the index return parent->IndexOf(contentChild); } nsresult nsRange::PopRanges(nsIDOMNode* aDestNode, PRInt32 aOffset, nsIContent* aSourceNode) { // utility routine to pop all the range endpoints inside the content subtree defined by // aSourceNode, into the node/offset represented by aDestNode/aOffset. nsCOMPtr iter; nsresult res = NS_NewContentIterator(getter_AddRefs(iter)); iter->Init(aSourceNode); const nsVoidArray* theRangeList; while (!iter->IsDone()) { nsIContent *cN = iter->GetCurrentNode(); theRangeList = cN->GetRangeList(); if (theRangeList) { nsRange* theRange; PRInt32 theCount = theRangeList->Count(); while (theCount) { theRange = NS_STATIC_CAST(nsRange*, (theRangeList->ElementAt(0))); if (theRange) { nsCOMPtr domNode(do_QueryInterface(cN)); NS_POSTCONDITION(domNode, "error updating range list"); // sanity check - do range and content agree over ownership? res = theRange->ContentOwnsUs(domNode); NS_POSTCONDITION(NS_SUCCEEDED(res), "range and content disagree over range ownership"); if (theRange->mStartParent == domNode) { // promote start point up to replacement point res = theRange->SetStart(aDestNode, aOffset); NS_POSTCONDITION(NS_SUCCEEDED(res), "nsRange::PopRanges() got error from SetStart()"); if (NS_FAILED(res)) return res; } if (theRange->mEndParent == domNode) { // promote end point up to replacement point res = theRange->SetEnd(aDestNode, aOffset); NS_POSTCONDITION(NS_SUCCEEDED(res), "nsRange::PopRanges() got error from SetEnd()"); if (NS_FAILED(res)) return res; } } // must refresh theRangeList - it might have gone away! theRangeList = cN->GetRangeList(); if (theRangeList) theCount = theRangeList->Count(); else theCount = 0; } } iter->Next(); } return NS_OK; } // sanity check routine for content helpers. confirms that given // node owns one or both range endpoints. nsresult nsRange::ContentOwnsUs(nsIDOMNode* domNode) { NS_PRECONDITION(domNode, "null pointer"); if ((mStartParent.get() != domNode) && (mEndParent.get() != domNode)) { NS_NOTREACHED("nsRange::ContentOwnsUs"); return NS_ERROR_UNEXPECTED; } return NS_OK; } /****************************************************** * public functionality ******************************************************/ nsresult nsRange::GetIsPositioned(PRBool* aIsPositioned) { *aIsPositioned = mIsPositioned; return NS_OK; } nsresult nsRange::GetStartContainer(nsIDOMNode** aStartParent) { if (!mIsPositioned) return NS_ERROR_NOT_INITIALIZED; if (!aStartParent) return NS_ERROR_NULL_POINTER; *aStartParent = mStartParent; NS_IF_ADDREF(*aStartParent); return NS_OK; } nsresult nsRange::GetStartOffset(PRInt32* aStartOffset) { if (!mIsPositioned) return NS_ERROR_NOT_INITIALIZED; if (!aStartOffset) return NS_ERROR_NULL_POINTER; *aStartOffset = mStartOffset; return NS_OK; } nsresult nsRange::GetEndContainer(nsIDOMNode** aEndParent) { if (!mIsPositioned) return NS_ERROR_NOT_INITIALIZED; if (!aEndParent) return NS_ERROR_NULL_POINTER; //NS_IF_RELEASE(*aEndParent); don't think we should be doing this *aEndParent = mEndParent; NS_IF_ADDREF(*aEndParent); return NS_OK; } nsresult nsRange::GetEndOffset(PRInt32* aEndOffset) { if (!mIsPositioned) return NS_ERROR_NOT_INITIALIZED; if (!aEndOffset) return NS_ERROR_NULL_POINTER; *aEndOffset = mEndOffset; return NS_OK; } nsresult nsRange::GetCollapsed(PRBool* aIsCollapsed) { if(IsDetached()) return NS_ERROR_DOM_INVALID_STATE_ERR; if (!mIsPositioned) return NS_ERROR_NOT_INITIALIZED; if (mEndParent == 0 || (mStartParent == mEndParent && mStartOffset == mEndOffset)) *aIsCollapsed = PR_TRUE; else *aIsCollapsed = PR_FALSE; return NS_OK; } nsresult nsRange::GetCommonAncestorContainer(nsIDOMNode** aCommonParent) { if(IsDetached()) return NS_ERROR_DOM_INVALID_STATE_ERR; return nsContentUtils::GetCommonAncestor(mStartParent, mEndParent, aCommonParent); } nsresult nsRange::IsValidBoundary(nsIDOMNode* aNode) { if (!aNode) { // DOM 2 Range specification doesn't define the error code for this case, // but this is the best one we have. return NS_ERROR_DOM_RANGE_BAD_BOUNDARYPOINTS_ERR; } PRUint16 nodeType = 0; aNode->GetNodeType(&nodeType); switch (nodeType) { case nsIDOMNode::DOCUMENT_TYPE_NODE: case nsIDOMNode::ENTITY_NODE: case nsIDOMNode::NOTATION_NODE: return NS_ERROR_DOM_RANGE_INVALID_NODE_TYPE_ERR; case nsIDOMNode::DOCUMENT_NODE: case nsIDOMNode::DOCUMENT_FRAGMENT_NODE: case nsIDOMNode::ATTRIBUTE_NODE: return NS_OK; default: break; } nsCOMPtr content = do_QueryInterface(aNode); if (!content) { // DOM 2 Range specification doesn't define the error code for this case, // but this is the best one we have. return NS_ERROR_DOM_RANGE_BAD_BOUNDARYPOINTS_ERR; } // Elements etc. must be in document or in document fragment, // text nodes in document, in document fragment or in attribute. if (content->IsInDoc()) { return NS_OK; } nsINode* parent = content->GetNodeParent(); if (parent) { if (parent->IsNodeOfType(nsINode::eATTRIBUTE)) { return NS_OK; } do { if (parent->IsNodeOfType(nsINode::eDOCUMENT_FRAGMENT)) { return NS_OK; } parent = parent->GetNodeParent(); } while(parent); } #ifdef DEBUG_smaug nsAutoString name; content->Tag()->ToString(name); printf("nsRange::IsValidBoundary: node is not a valid boundary point [%s]\n", NS_ConvertUTF16toUTF8(name).get()); #endif // DOM 2 Range specification doesn't define the error code for this case, // but this is the best one we have. return NS_ERROR_DOM_RANGE_BAD_BOUNDARYPOINTS_ERR; } nsresult nsRange::SetStart(nsIDOMNode* aParent, PRInt32 aOffset) { VALIDATE_ACCESS(aParent); nsresult rv = IsValidBoundary(aParent); NS_ENSURE_SUCCESS(rv, rv); PRInt32 len = GetNodeLength(aParent); if ( (aOffset < 0) || (len < 0) || (aOffset > len) ) return NS_ERROR_DOM_INDEX_SIZE_ERR; if (mIsPositioned) { // if not in the same document as the endpoint, // collapse the endpoint to the new start. if (!nsContentUtils::InSameDoc(aParent, mEndParent)) { return DoSetRange(aParent, aOffset, aParent, aOffset); } // the start must be before the end if (!IsIncreasing(aParent, aOffset, mEndParent, mEndOffset)) { return NS_ERROR_ILLEGAL_VALUE; } } // if it's in an attribute node, end must be in or descended from same node // XXX write me! return DoSetRange(aParent, aOffset, mEndParent, mEndOffset); } nsresult nsRange::SetStartBefore(nsIDOMNode* aSibling) { VALIDATE_ACCESS(aSibling); nsCOMPtr nParent; nsresult res = aSibling->GetParentNode(getter_AddRefs(nParent)); if (NS_FAILED(res) || !nParent) return NS_ERROR_DOM_RANGE_INVALID_NODE_TYPE_ERR; PRInt32 indx = IndexOf(aSibling); return SetStart(nParent,indx); } nsresult nsRange::SetStartAfter(nsIDOMNode* aSibling) { VALIDATE_ACCESS(aSibling); nsCOMPtr nParent; nsresult res = aSibling->GetParentNode(getter_AddRefs(nParent)); if (NS_FAILED(res) || !nParent) return NS_ERROR_DOM_RANGE_INVALID_NODE_TYPE_ERR; PRInt32 indx = IndexOf(aSibling) + 1; return SetStart(nParent,indx); } nsresult nsRange::SetEnd(nsIDOMNode* aParent, PRInt32 aOffset) { VALIDATE_ACCESS(aParent); nsresult rv = IsValidBoundary(aParent); NS_ENSURE_SUCCESS(rv, rv); PRInt32 len = GetNodeLength(aParent); if ( (aOffset < 0) || (len < 0) || (aOffset > len) ) return NS_ERROR_DOM_INDEX_SIZE_ERR; nsresult res; nsCOMPtrtheParent( do_QueryInterface(aParent) ); // must be in same document as startpoint, else // endpoint is collapsed to new end. if (mIsPositioned && !nsContentUtils::InSameDoc(theParent,mStartParent)) { res = DoSetRange(theParent,aOffset,theParent,aOffset); return res; } // start must be before end if (mIsPositioned && !IsIncreasing(mStartParent,mStartOffset,theParent,aOffset)) return NS_ERROR_ILLEGAL_VALUE; // if it's in an attribute node, start must be in or descended from same node // (haven't done this one yet) res = DoSetRange(mStartParent,mStartOffset,theParent,aOffset); return res; } nsresult nsRange::SetEndBefore(nsIDOMNode* aSibling) { VALIDATE_ACCESS(aSibling); nsCOMPtr nParent; nsresult res = aSibling->GetParentNode(getter_AddRefs(nParent)); if (NS_FAILED(res) || !nParent) return NS_ERROR_DOM_RANGE_INVALID_NODE_TYPE_ERR; PRInt32 indx = IndexOf(aSibling); return SetEnd(nParent,indx); } nsresult nsRange::SetEndAfter(nsIDOMNode* aSibling) { VALIDATE_ACCESS(aSibling); nsCOMPtr nParent; nsresult res = aSibling->GetParentNode(getter_AddRefs(nParent)); if (NS_FAILED(res) || !nParent) return NS_ERROR_DOM_RANGE_INVALID_NODE_TYPE_ERR; PRInt32 indx = IndexOf(aSibling) + 1; return SetEnd(nParent,indx); } nsresult nsRange::Collapse(PRBool aToStart) { if(IsDetached()) return NS_ERROR_DOM_INVALID_STATE_ERR; if (!mIsPositioned) return NS_ERROR_NOT_INITIALIZED; if (aToStart) return DoSetRange(mStartParent,mStartOffset,mStartParent,mStartOffset); else return DoSetRange(mEndParent,mEndOffset,mEndParent,mEndOffset); } nsresult nsRange::SelectNode(nsIDOMNode* aN) { VALIDATE_ACCESS(aN); nsCOMPtr parent; PRInt32 start, end; PRUint16 type = 0; aN->GetNodeType(&type); switch (type) { case nsIDOMNode::ATTRIBUTE_NODE : case nsIDOMNode::ENTITY_NODE : case nsIDOMNode::DOCUMENT_NODE : case nsIDOMNode::DOCUMENT_FRAGMENT_NODE : case nsIDOMNode::NOTATION_NODE : return NS_ERROR_DOM_RANGE_INVALID_NODE_TYPE_ERR; } nsresult res; res = aN->GetParentNode(getter_AddRefs(parent)); if(NS_SUCCEEDED(res) && parent) { nsCOMPtr doc(do_QueryInterface(parent)); if(doc) { nsCOMPtrcontent(do_QueryInterface(aN)); if(!content) return NS_ERROR_DOM_RANGE_INVALID_NODE_TYPE_ERR; parent = aN;//parent is now equal to the node you passed in // which is the root. start is zero, end is the number of children start = 0; end = content->GetChildCount(); } else { start = IndexOf(aN); end = start + 1; } return DoSetRange(parent,start,parent,end); } return NS_ERROR_DOM_RANGE_INVALID_NODE_TYPE_ERR; } nsresult nsRange::SelectNodeContents(nsIDOMNode* aN) { VALIDATE_ACCESS(aN); nsCOMPtr theNode( do_QueryInterface(aN) ); nsCOMPtr aChildNodes; nsresult res = aN->GetChildNodes(getter_AddRefs(aChildNodes)); if (NS_FAILED(res)) return res; if (!aChildNodes) return NS_ERROR_UNEXPECTED; PRUint32 indx; res = aChildNodes->GetLength(&indx); if (NS_FAILED(res)) return res; return DoSetRange(theNode,0,theNode,indx); } // The Subtree Content Iterator only returns subtrees that are // completely within a given range. It doesn't return a CharacterData // node that contains either the start or end point of the range. // We need an iterator that will also include these start/end points // so that our methods/algorithms aren't cluttered with special // case code that tries to include these points while iterating. // // The RangeSubtreeIterator class mimics the nsIContentIterator // methods we need, so should the Content Iterator support the // start/end points in the future, we can switchover relatively // easy. class RangeSubtreeIterator { private: enum RangeSubtreeIterState { eDone=0, eUseStartCData, eUseIterator, eUseEndCData }; nsCOMPtr mIter; RangeSubtreeIterState mIterState; nsCOMPtr mStartCData; nsCOMPtr mEndCData; public: RangeSubtreeIterator() : mIterState(eDone) { } ~RangeSubtreeIterator() { } nsresult Init(nsIDOMRange *aRange); already_AddRefed GetCurrentNode(); void First(); void Last(); void Next(); void Prev(); PRBool IsDone() { return mIterState == eDone; } }; nsresult RangeSubtreeIterator::Init(nsIDOMRange *aRange) { mIterState = eDone; nsCOMPtr node; // Grab the start point of the range and QI it to // a CharacterData pointer. If it is CharacterData store // a pointer to the node. nsresult res = aRange->GetStartContainer(getter_AddRefs(node)); if (!node) return NS_ERROR_FAILURE; mStartCData = do_QueryInterface(node); // Grab the end point of the range and QI it to // a CharacterData pointer. If it is CharacterData store // a pointer to the node. res = aRange->GetEndContainer(getter_AddRefs(node)); if (!node) return NS_ERROR_FAILURE; mEndCData = do_QueryInterface(node); if (mStartCData && mStartCData == mEndCData) { // The range starts and stops in the same CharacterData // node. Null out the end pointer so we only visit the // node once! mEndCData = nsnull; } else { // Now create a Content Subtree Iterator to be used // for the subtrees between the end points! res = NS_NewContentSubtreeIterator(getter_AddRefs(mIter)); if (NS_FAILED(res)) return res; res = mIter->Init(aRange); if (NS_FAILED(res)) return res; if (mIter->IsDone()) { // The subtree iterator thinks there's nothing // to iterate over, so just free it up so we // don't accidentally call into it. mIter = nsnull; } } // Initialize the iterator by calling First(). // Note that we are ignoring the return value on purpose! First(); return NS_OK; } already_AddRefed RangeSubtreeIterator::GetCurrentNode() { nsIDOMNode *node = nsnull; if (mIterState == eUseStartCData && mStartCData) { NS_ADDREF(node = mStartCData); } else if (mIterState == eUseEndCData && mEndCData) NS_ADDREF(node = mEndCData); else if (mIterState == eUseIterator && mIter) { nsIContent *content = mIter->GetCurrentNode(); if (content) { CallQueryInterface(content, &node); } } return node; } void RangeSubtreeIterator::First() { if (mStartCData) mIterState = eUseStartCData; else if (mIter) { mIter->First(); mIterState = eUseIterator; } else if (mEndCData) mIterState = eUseEndCData; else mIterState = eDone; } void RangeSubtreeIterator::Last() { if (mEndCData) mIterState = eUseEndCData; else if (mIter) { mIter->Last(); mIterState = eUseIterator; } else if (mStartCData) mIterState = eUseStartCData; else mIterState = eDone; } void RangeSubtreeIterator::Next() { if (mIterState == eUseStartCData) { if (mIter) { mIter->First(); mIterState = eUseIterator; } else if (mEndCData) mIterState = eUseEndCData; else mIterState = eDone; } else if (mIterState == eUseIterator) { mIter->Next(); if (mIter->IsDone()) { if (mEndCData) mIterState = eUseEndCData; else mIterState = eDone; } } else mIterState = eDone; } void RangeSubtreeIterator::Prev() { if (mIterState == eUseEndCData) { if (mIter) { mIter->Last(); mIterState = eUseIterator; } else if (mStartCData) mIterState = eUseStartCData; else mIterState = eDone; } else if (mIterState == eUseIterator) { mIter->Prev(); if (mIter->IsDone()) { if (mStartCData) mIterState = eUseStartCData; else mIterState = eDone; } } else mIterState = eDone; } // CollapseRangeAfterDelete() is a utiltiy method that is used by // DeleteContents() and ExtractContents() to collapse the range // in the correct place, under the range's root container (the // range end points common container) as outlined by the Range spec: // // http://www.w3.org/TR/2000/REC-DOM-Level-2-Traversal-Range-20001113/ranges.html // The assumption made by this method is that the delete or extract // has been done already, and left the range in a state where there is // no content between the 2 end points. nsresult nsRange::CollapseRangeAfterDelete(nsIDOMRange *aRange) { NS_ENSURE_ARG_POINTER(aRange); // Check if range gravity took care of collapsing the range for us! PRBool isCollapsed = PR_FALSE; nsresult res = aRange->GetCollapsed(&isCollapsed); if (NS_FAILED(res)) return res; if (isCollapsed) { // aRange is collapsed so there's nothing for us to do. // // There are 2 possible scenarios here: // // 1. aRange could've been collapsed prior to the delete/extract, // which would've resulted in nothing being removed, so aRange // is already where it should be. // // 2. Prior to the delete/extract, aRange's start and end were in // the same container which would mean everything between them // was removed, causing range gravity to collapse the range. return NS_OK; } // aRange isn't collapsed so figure out the appropriate place to collapse! // First get both end points and their common ancestor. nsCOMPtr commonAncestor; res = aRange->GetCommonAncestorContainer(getter_AddRefs(commonAncestor)); if(NS_FAILED(res)) return res; nsCOMPtr startContainer, endContainer; res = aRange->GetStartContainer(getter_AddRefs(startContainer)); if (NS_FAILED(res)) return res; res = aRange->GetEndContainer(getter_AddRefs(endContainer)); if (NS_FAILED(res)) return res; // Collapse to one of the end points if they are already in the // commonAncestor. This should work ok since this method is called // immediately after a delete or extract that leaves no content // between the 2 end points! if (startContainer == commonAncestor) return aRange->Collapse(PR_TRUE); if (endContainer == commonAncestor) return aRange->Collapse(PR_FALSE); // End points are at differing levels. We want to collapse to the // point that is between the 2 subtrees that contain each point, // under the common ancestor. nsCOMPtr nodeToSelect(startContainer), parent; while (nodeToSelect) { nsresult res = nodeToSelect->GetParentNode(getter_AddRefs(parent)); if (NS_FAILED(res)) return res; if (parent == commonAncestor) break; // We found the nodeToSelect! nodeToSelect = parent; } if (!nodeToSelect) return NS_ERROR_FAILURE; // This should never happen! res = aRange->SelectNode(nodeToSelect); if (NS_FAILED(res)) return res; return aRange->Collapse(PR_FALSE); } nsresult nsRange::DeleteContents() { if(IsDetached()) return NS_ERROR_DOM_INVALID_STATE_ERR; // Save the range end points locally to avoid interference // of Range gravity during our edits! nsCOMPtr startContainer(mStartParent); PRInt32 startOffset = mStartOffset; nsCOMPtr endContainer(mEndParent); PRInt32 endOffset = mEndOffset; // Create and initialize a subtree iterator that will give // us all the subtrees within the range. RangeSubtreeIterator iter; nsresult res = iter.Init(this); if (NS_FAILED(res)) return res; if (iter.IsDone()) { // There's nothing for us to delete. return CollapseRangeAfterDelete(this); } // We delete backwards to avoid iterator problems! iter.Last(); PRBool handled = PR_FALSE; // With the exception of text nodes that contain one of the range // end points, the subtree iterator should only give us back subtrees // that are completely contained between the range's end points. while (!iter.IsDone()) { nsCOMPtr node(iter.GetCurrentNode()); // Before we delete anything, advance the iterator to the // next subtree. iter.Prev(); handled = PR_FALSE; // If it's CharacterData, make sure we might need to delete // part of the data, instead of removing the whole node. // // XXX_kin: We need to also handle ProcessingInstruction // XXX_kin: according to the spec. nsCOMPtr charData(do_QueryInterface(node)); if (charData) { PRUint32 dataLength = 0; if (node == startContainer) { if (node == endContainer) { // This range is completely contained within a single text node. // Delete the data between startOffset and endOffset. if (endOffset > startOffset) { res = charData->DeleteData(startOffset, endOffset - startOffset); if (NS_FAILED(res)) return res; } handled = PR_TRUE; } else { // Delete everything after startOffset. res = charData->GetLength(&dataLength); if (NS_FAILED(res)) return res; if (dataLength > (PRUint32)startOffset) { res = charData->DeleteData(startOffset, dataLength - startOffset); if (NS_FAILED(res)) return res; } handled = PR_TRUE; } } else if (node == endContainer) { // Delete the data between 0 and endOffset. if (endOffset > 0) { res = charData->DeleteData(0, endOffset); if (NS_FAILED(res)) return res; } handled = PR_TRUE; } } if (!handled) { // node was not handled above, so it must be completely contained // within the range. Just remove it from the tree! nsCOMPtr parent, tmpNode; node->GetParentNode(getter_AddRefs(parent)); if (parent) { res = parent->RemoveChild(node, getter_AddRefs(tmpNode)); if (NS_FAILED(res)) return res; } } } // XXX_kin: At this point we should be checking for the case // XXX_kin: where we have 2 adjacent text nodes left, each // XXX_kin: containing one of the range end points. The spec // XXX_kin: says the 2 nodes should be merged in that case, // XXX_kin: and to use Normalize() to do the merging, but // XXX_kin: calling Normalize() on the common parent to accomplish // XXX_kin: this might also normalize nodes that are outside the // XXX_kin: range but under the common parent. Need to verify // XXX_kin: with the range commitee members that this was the // XXX_kin: desired behavior. For now we don't merge anything! return CollapseRangeAfterDelete(this); } NS_IMETHODIMP nsRange::CompareBoundaryPoints(PRUint16 how, nsIDOMRange* srcRange, PRInt16* aCmpRet) { if(IsDetached()) return NS_ERROR_DOM_INVALID_STATE_ERR; nsresult res; if (aCmpRet == 0) return NS_ERROR_NULL_POINTER; if (srcRange == 0) return NS_ERROR_INVALID_ARG; nsCOMPtr boundaryNode; // the Invoking range nsCOMPtr sourceNode; // the sourceRange PRInt32 boundaryOffset, sourceOffset; switch (how) { case nsIDOMRange::START_TO_START: // where is the start point of boundary range boundaryNode = mStartParent; // relative to the start point of the source range? boundaryOffset = mStartOffset; res = srcRange->GetStartContainer(getter_AddRefs(sourceNode)); if (NS_SUCCEEDED(res)) res = srcRange->GetStartOffset(&sourceOffset); break; case nsIDOMRange::START_TO_END: // where is the end point of the boundary range boundaryNode = mEndParent; // relative to the start point of source range? boundaryOffset = mEndOffset; res = srcRange->GetStartContainer(getter_AddRefs(sourceNode)); if (NS_SUCCEEDED(res)) res = srcRange->GetStartOffset(&sourceOffset); break; case nsIDOMRange::END_TO_START: // where is the the start point of the boundary range boundaryNode = mStartParent; // relative to end point of source range? boundaryOffset = mStartOffset; res = srcRange->GetEndContainer(getter_AddRefs(sourceNode)); if (NS_SUCCEEDED(res)) res = srcRange->GetEndOffset(&sourceOffset); break; case nsIDOMRange::END_TO_END: // where is the end point of boundary range boundaryNode = mEndParent; // relative to the end point of the source range? boundaryOffset = mEndOffset; res = srcRange->GetEndContainer(getter_AddRefs(sourceNode)); if (NS_SUCCEEDED(res)) res = srcRange->GetEndOffset(&sourceOffset); break; default: // shouldn't get here return NS_ERROR_ILLEGAL_VALUE; } if (NS_FAILED(res)) return res; if ((boundaryNode == sourceNode) && (boundaryOffset == sourceOffset)) *aCmpRet = 0;//then the points are equal else if (IsIncreasing(boundaryNode, boundaryOffset, sourceNode, sourceOffset)) *aCmpRet = -1;//then boundary point is before source point else *aCmpRet = 1;//then boundary point is after source point return NS_OK; } nsresult nsRange::ExtractContents(nsIDOMDocumentFragment** aReturn) { if(IsDetached()) return NS_ERROR_DOM_INVALID_STATE_ERR; // XXX_kin: The spec says that nodes that are completely in the // XXX_kin: range should be moved into the document fragment, not // XXX_kin: copied. This method will have to be rewritten using // XXX_kin: DeleteContents() as a template, with the charData cloning // XXX_kin: code from CloneContents() merged in. nsresult res = CloneContents(aReturn); if (NS_FAILED(res)) return res; res = DeleteContents(); return res; } nsresult nsRange::CloneParentsBetween(nsIDOMNode *aAncestor, nsIDOMNode *aNode, nsIDOMNode **aClosestAncestor, nsIDOMNode **aFarthestAncestor) { NS_ENSURE_ARG_POINTER((aAncestor && aNode && aClosestAncestor && aFarthestAncestor)); *aClosestAncestor = nsnull; *aFarthestAncestor = nsnull; if (aAncestor == aNode) return NS_OK; nsCOMPtr parent, firstParent, lastParent; nsresult res = aNode->GetParentNode(getter_AddRefs(parent)); while(parent && parent != aAncestor) { nsCOMPtr clone, tmpNode; res = parent->CloneNode(PR_FALSE, getter_AddRefs(clone)); if (NS_FAILED(res)) return res; if (!clone) return NS_ERROR_FAILURE; if (! firstParent) firstParent = lastParent = clone; else { res = clone->AppendChild(lastParent, getter_AddRefs(tmpNode)); if (NS_FAILED(res)) return res; lastParent = clone; } tmpNode = parent; res = tmpNode->GetParentNode(getter_AddRefs(parent)); } *aClosestAncestor = firstParent; NS_IF_ADDREF(*aClosestAncestor); *aFarthestAncestor = lastParent; NS_IF_ADDREF(*aFarthestAncestor); return NS_OK; } nsresult nsRange::CloneContents(nsIDOMDocumentFragment** aReturn) { if (IsDetached()) return NS_ERROR_DOM_INVALID_STATE_ERR; nsresult res; nsCOMPtr commonAncestor; res = GetCommonAncestorContainer(getter_AddRefs(commonAncestor)); if (NS_FAILED(res)) return res; nsCOMPtr document; res = mStartParent->GetOwnerDocument(getter_AddRefs(document)); if (NS_FAILED(res)) return res; if (!document) { document = do_QueryInterface(mStartParent); } NS_ASSERTION(document, "CloneContents needs a document to continue."); if (!document) return NS_ERROR_FAILURE; // Create a new document fragment in the context of this document, // which might be null nsCOMPtr clonedFrag; nsCOMPtr doc(do_QueryInterface(document)); res = NS_NewDocumentFragment(getter_AddRefs(clonedFrag), doc->NodeInfoManager()); if (NS_FAILED(res)) return res; nsCOMPtr commonCloneAncestor(do_QueryInterface(clonedFrag)); if (!commonCloneAncestor) return NS_ERROR_FAILURE; // Create and initialize a subtree iterator that will give // us all the subtrees within the range. RangeSubtreeIterator iter; res = iter.Init(this); if (NS_FAILED(res)) return res; if (iter.IsDone()) { // There's nothing to add to the doc frag, we must be done! *aReturn = clonedFrag; NS_IF_ADDREF(*aReturn); return NS_OK; } iter.First(); // With the exception of text nodes that contain one of the range // end points, the subtree iterator should only give us back subtrees // that are completely contained between the range's end points. // // Unfortunately these subtrees don't contain the parent hierarchy/context // that the Range spec requires us to return. This loop clones the // parent hierarchy, adds a cloned version of the subtree, to it, then // correctly places this new subtree into the doc fragment. while (!iter.IsDone()) { nsCOMPtr node(iter.GetCurrentNode()); // Clone the current subtree! nsCOMPtr clone; res = node->CloneNode(PR_TRUE, getter_AddRefs(clone)); if (NS_FAILED(res)) return res; // If it's CharacterData, make sure we only clone what // is in the range. // // XXX_kin: We need to also handle ProcessingInstruction // XXX_kin: according to the spec. nsCOMPtr charData(do_QueryInterface(clone)); if (charData) { if (node == mEndParent) { // We only need the data before mEndOffset, so get rid of any // data after it. PRUint32 dataLength = 0; res = charData->GetLength(&dataLength); if (NS_FAILED(res)) return res; if (dataLength > (PRUint32)mEndOffset) { res = charData->DeleteData(mEndOffset, dataLength - mEndOffset); if (NS_FAILED(res)) return res; } } if (node == mStartParent) { // We don't need any data before mStartOffset, so just // delete it! if (mStartOffset > 0) { res = charData->DeleteData(0, mStartOffset); if (NS_FAILED(res)) return res; } } } // Clone the parent hierarchy between commonAncestor and node. nsCOMPtr closestAncestor, farthestAncestor; res = CloneParentsBetween(commonAncestor, node, getter_AddRefs(closestAncestor), getter_AddRefs(farthestAncestor)); if (NS_FAILED(res)) return res; // Hook the parent hierarchy/context of the subtree into the clone tree. nsCOMPtr tmpNode; if (farthestAncestor) { res = commonCloneAncestor->AppendChild(farthestAncestor, getter_AddRefs(tmpNode)); if (NS_FAILED(res)) return res; } // Place the cloned subtree into the cloned doc frag tree! if (closestAncestor) { // Append the subtree under closestAncestor since it is the // immediate parent of the subtree. res = closestAncestor->AppendChild(clone, getter_AddRefs(tmpNode)); } else { // If we get here, there is no missing parent hierarchy between // commonAncestor and node, so just append clone to commonCloneAncestor. res = commonCloneAncestor->AppendChild(clone, getter_AddRefs(tmpNode)); } if (NS_FAILED(res)) return res; // Get the next subtree to be processed. The idea here is to setup // the parameters for the next iteration of the loop. iter.Next(); if (iter.IsDone()) break; // We must be done! nsCOMPtr nextNode(iter.GetCurrentNode()); if (!nextNode) return NS_ERROR_FAILURE; // Get node and nextNode's common parent. nsContentUtils::GetCommonAncestor(node, nextNode, getter_AddRefs(commonAncestor)); if (!commonAncestor) return NS_ERROR_FAILURE; // Find the equivalent of commonAncestor in the cloned tree! while (node && node != commonAncestor) { tmpNode = node; res = tmpNode->GetParentNode(getter_AddRefs(node)); if (NS_FAILED(res)) return res; if (!node) return NS_ERROR_FAILURE; tmpNode = clone; res = tmpNode->GetParentNode(getter_AddRefs(clone)); if (NS_FAILED(res)) return res; if (!node) return NS_ERROR_FAILURE; } commonCloneAncestor = clone; } *aReturn = clonedFrag; NS_IF_ADDREF(*aReturn); return NS_OK; } nsresult nsRange::CloneRange(nsIDOMRange** aReturn) { if(IsDetached()) return NS_ERROR_DOM_INVALID_STATE_ERR; if (aReturn == 0) return NS_ERROR_NULL_POINTER; nsresult res = NS_NewRange(aReturn); if (NS_FAILED(res)) return res; res = (*aReturn)->SetStart(mStartParent, mStartOffset); if (NS_FAILED(res)) return res; res = (*aReturn)->SetEnd(mEndParent, mEndOffset); return res; } nsresult nsRange::InsertNode(nsIDOMNode* aN) { VALIDATE_ACCESS(aN); nsresult res; PRInt32 tStartOffset; this->GetStartOffset(&tStartOffset); nsCOMPtr tStartContainer; res = this->GetStartContainer(getter_AddRefs(tStartContainer)); if(NS_FAILED(res)) return res; nsCOMPtr startTextNode(do_QueryInterface(tStartContainer)); if (startTextNode) { nsCOMPtr tSCParentNode; res = tStartContainer->GetParentNode(getter_AddRefs(tSCParentNode)); if(NS_FAILED(res)) return res; PRBool isCollapsed; res = GetCollapsed(&isCollapsed); if(NS_FAILED(res)) return res; PRInt32 tEndOffset; GetEndOffset(&tEndOffset); nsCOMPtr secondPart; res = startTextNode->SplitText(tStartOffset, getter_AddRefs(secondPart)); if (NS_FAILED(res)) return res; // SplitText collapses the range; fix that (bug 253609) if (!isCollapsed) { res = SetEnd(secondPart, tEndOffset - tStartOffset); if(NS_FAILED(res)) return res; } nsCOMPtr tResultNode; return tSCParentNode->InsertBefore(aN, secondPart, getter_AddRefs(tResultNode)); } nsCOMPtrtChildList; res = tStartContainer->GetChildNodes(getter_AddRefs(tChildList)); if(NS_FAILED(res)) return res; PRUint32 tChildListLength; res = tChildList->GetLength(&tChildListLength); if(NS_FAILED(res)) return res; // find the insertion point in the DOM and insert the Node nsCOMPtrtChildNode; res = tChildList->Item(tStartOffset, getter_AddRefs(tChildNode)); if(NS_FAILED(res)) return res; nsCOMPtr tResultNode; return tStartContainer->InsertBefore(aN, tChildNode, getter_AddRefs(tResultNode)); } nsresult nsRange::SurroundContents(nsIDOMNode* aNewParent) { VALIDATE_ACCESS(aNewParent); // Extract the contents within the range. nsCOMPtr docFrag; nsresult res = ExtractContents(getter_AddRefs(docFrag)); if (NS_FAILED(res)) return res; if (!docFrag) return NS_ERROR_FAILURE; // Spec says we need to remove all of aNewParent's // children prior to insertion. nsCOMPtr children; res = aNewParent->GetChildNodes(getter_AddRefs(children)); if (NS_FAILED(res)) return res; if (!children) return NS_ERROR_FAILURE; PRUint32 numChildren = 0; res = children->GetLength(&numChildren); if (NS_FAILED(res)) return res; nsCOMPtr tmpNode; while (numChildren) { nsCOMPtr child; res = children->Item(--numChildren, getter_AddRefs(child)); if (NS_FAILED(res)) return res; if (!child) return NS_ERROR_FAILURE; res = aNewParent->RemoveChild(child, getter_AddRefs(tmpNode)); if (NS_FAILED(res)) return res; } // Insert aNewParent at the range's start point. res = InsertNode(aNewParent); if (NS_FAILED(res)) return res; // Append the content we extracted under aNewParent. res = aNewParent->AppendChild(docFrag, getter_AddRefs(tmpNode)); if (NS_FAILED(res)) return res; // Select aNewParent, and its contents. return SelectNode(aNewParent); } nsresult nsRange::ToString(nsAString& aReturn) { if(IsDetached()) return NS_ERROR_DOM_INVALID_STATE_ERR; nsCOMPtr cStart( do_QueryInterface(mStartParent) ); nsCOMPtr cEnd( do_QueryInterface(mEndParent) ); // clear the string aReturn.Truncate(); // If we're unpositioned, return the empty string if (!cStart || !cEnd) { return NS_OK; } #ifdef DEBUG_range printf("Range dump: -----------------------\n"); #endif /* DEBUG */ // effeciency hack for simple case if (cStart == cEnd) { nsCOMPtr textNode( do_QueryInterface(mStartParent) ); if (textNode) { #ifdef DEBUG_range // If debug, dump it: nsCOMPtr cN (do_QueryInterface(mStartParent)); if (cN) cN->List(stdout); printf("End Range dump: -----------------------\n"); #endif /* DEBUG */ // grab the text if (NS_FAILED(textNode->SubstringData(mStartOffset,mEndOffset-mStartOffset,aReturn))) return NS_ERROR_UNEXPECTED; return NS_OK; } } /* complex case: cStart != cEnd, or cStart not a text node revisit - there are potential optimizations here and also tradeoffs. */ nsCOMPtr iter; NS_NewContentIterator(getter_AddRefs(iter)); iter->Init(this); nsString tempString; // loop through the content iterator, which returns nodes in the range in // close tag order, and grab the text from any text node while (!iter->IsDone()) { nsIContent *cN = iter->GetCurrentNode(); #ifdef DEBUG_range // If debug, dump it: cN->List(stdout); #endif /* DEBUG */ nsCOMPtr textNode( do_QueryInterface(cN) ); if (textNode) // if it's a text node, get the text { if (cN == cStart) // only include text past start offset { PRUint32 strLength; textNode->GetLength(&strLength); textNode->SubstringData(mStartOffset,strLength-mStartOffset,tempString); aReturn += tempString; } else if (cN == cEnd) // only include text before end offset { textNode->SubstringData(0,mEndOffset,tempString); aReturn += tempString; } else // grab the whole kit-n-kaboodle { textNode->GetData(tempString); aReturn += tempString; } } iter->Next(); } #ifdef DEBUG_range printf("End Range dump: -----------------------\n"); #endif /* DEBUG */ return NS_OK; } nsresult nsRange::Detach() { if(IsDetached()) return NS_ERROR_DOM_INVALID_STATE_ERR; mIsDetached = PR_TRUE; return DoSetRange(nsnull,0,nsnull,0); } nsresult nsRange::OwnerGone(nsIContent* aDyingNode) { // nothing for now - should be impossible to getter here // No node should be deleted if it holds a range endpoint, // since the range endpoint addrefs the node. NS_ASSERTION(PR_FALSE,"Deleted content holds a range endpoint"); return NS_OK; } nsresult nsRange::OwnerChildInserted(nsIContent* aParentNode, PRInt32 aOffset) { // sanity check - null nodes shouldn't have enclosed ranges if (!aParentNode) return NS_ERROR_UNEXPECTED; nsCOMPtr parent( do_QueryInterface(aParentNode) ); // quick return if no range list const nsVoidArray *theRangeList = parent->GetRangeList(); if (!theRangeList) return NS_OK; nsresult res; nsCOMPtr domNode(do_QueryInterface(parent)); if (!domNode) return NS_ERROR_UNEXPECTED; PRInt32 count = theRangeList->Count(); for (PRInt32 loop = 0; loop < count; loop++) { nsRange* theRange = NS_STATIC_CAST(nsRange*, (theRangeList->ElementAt(loop))); NS_ASSERTION(theRange, "oops, no range"); // sanity check - do range and content agree over ownership? res = theRange->ContentOwnsUs(domNode); NS_PRECONDITION(NS_SUCCEEDED(res), "range and content disagree over range ownership"); if (NS_SUCCEEDED(res)) { if (theRange->mStartParent == domNode) { // if child inserted before start, move start offset right one if (aOffset < theRange->mStartOffset) theRange->mStartOffset++; } if (theRange->mEndParent == domNode) { // if child inserted before end, move end offset right one if (aOffset < theRange->mEndOffset) theRange->mEndOffset++; } NS_PRECONDITION(NS_SUCCEEDED(res), "error updating range list"); } } return NS_OK; } nsresult nsRange::OwnerChildRemoved(nsIContent* aParentNode, PRInt32 aOffset, nsIContent* aRemovedNode) { // sanity check - null nodes shouldn't have enclosed ranges if (!aParentNode) return NS_ERROR_UNEXPECTED; nsCOMPtr parent( do_QueryInterface(aParentNode) ); nsCOMPtr removed( do_QueryInterface(aRemovedNode) ); // any ranges in the content subtree rooted by aRemovedNode need to // have the enclosed endpoints promoted up to the parentNode/offset nsCOMPtr domNode(do_QueryInterface(parent)); if (!domNode) return NS_ERROR_UNEXPECTED; nsresult res = PopRanges(domNode, aOffset, removed); // quick return if no range list const nsVoidArray *theRangeList = parent->GetRangeList(); if (!theRangeList) return NS_OK; PRInt32 count = theRangeList->Count(); for (PRInt32 loop = 0; loop < count; loop++) { nsRange* theRange = NS_STATIC_CAST(nsRange*, (theRangeList->ElementAt(loop))); NS_ASSERTION(theRange, "oops, no range"); // sanity check - do range and content agree over ownership? res = theRange->ContentOwnsUs(domNode); NS_PRECONDITION(NS_SUCCEEDED(res), "range and content disagree over range ownership"); if (NS_SUCCEEDED(res)) { if (theRange->mStartParent == domNode) { // if child deleted before start, move start offset left one if (aOffset < theRange->mStartOffset) theRange->mStartOffset--; } if (theRange->mEndParent == domNode) { // if child deleted before end, move end offset left one if (aOffset < theRange->mEndOffset) { if (theRange->mEndOffset>0) theRange->mEndOffset--; } } } } return NS_OK; } nsresult nsRange::OwnerChildReplaced(nsIContent* aParentNode, PRInt32 aOffset, nsIContent* aReplacedNode) { // sanity check - null nodes shouldn't have enclosed ranges if (!aParentNode) return NS_ERROR_UNEXPECTED; // don't need to adjust ranges whose endpoints are in this parent, // but we do need to pop out any range endpoints inside the subtree // rooted by aReplacedNode. nsCOMPtr parent( do_QueryInterface(aParentNode) ); nsCOMPtr replaced( do_QueryInterface(aReplacedNode) ); nsCOMPtr parentDomNode( do_QueryInterface(parent) ); if (!parentDomNode) return NS_ERROR_UNEXPECTED; return PopRanges(parentDomNode, aOffset, replaced); } nsresult nsRange::TextOwnerChanged(nsIContent* aTextNode, const nsVoidArray *aRangeList, PRInt32 aStartChanged, PRInt32 aEndChanged, PRInt32 aReplaceLength) { NS_ASSERTION(aRangeList, "Don't call TextOwnerChanged if aTextNode is not in a range!"); NS_ASSERTION(aTextNode, "Null nodes don't have enclosed ranges!"); nsCOMPtr domNode(do_QueryInterface(aTextNode)); if (!domNode) return NS_ERROR_UNEXPECTED; PRInt32 count = aRangeList->Count(); for (PRInt32 loop = 0; loop < count; loop++) { nsRange* theRange = NS_STATIC_CAST(nsRange*, (aRangeList->ElementAt(loop))); NS_ASSERTION(theRange, "oops, no range"); // sanity check - do range and content agree over ownership? nsresult res = theRange->ContentOwnsUs(domNode); NS_PRECONDITION(NS_SUCCEEDED(res), "range and content disagree over range ownership"); if (NS_SUCCEEDED(res)) { PRBool bStartPointInChangedText = PR_FALSE; if (theRange->mStartParent == domNode) { // if range start is inside changed text, position it after change if ((aStartChanged <= theRange->mStartOffset) && (aEndChanged >= theRange->mStartOffset)) { theRange->mStartOffset = aStartChanged+aReplaceLength; bStartPointInChangedText = PR_TRUE; } // else if text changed before start, adjust start offset else if (aEndChanged <= theRange->mStartOffset) theRange->mStartOffset += aStartChanged + aReplaceLength - aEndChanged; } if (theRange->mEndParent == domNode) { // if range end is inside changed text, position it before change if ((aStartChanged <= theRange->mEndOffset) && (aEndChanged >= theRange->mEndOffset)) { theRange->mEndOffset = aStartChanged; // hack: if BOTH range endpoints were inside the change, then they // both get collapsed to the beginning of the change. if (bStartPointInChangedText) theRange->mStartOffset = aStartChanged; } // else if text changed before end, adjust end offset else if (aEndChanged <= theRange->mEndOffset) theRange->mEndOffset += aStartChanged + aReplaceLength - aEndChanged; } } } return NS_OK; } // nsIDOMNSRange interface NS_IMETHODIMP nsRange::CreateContextualFragment(const nsAString& aFragment, nsIDOMDocumentFragment** aReturn) { return mIsPositioned ? nsContentUtils::CreateContextualFragment(mStartParent, aFragment, aReturn) : NS_ERROR_FAILURE; } NS_IMETHODIMP nsRange::GetHasGeneratedBefore(PRBool *aBool) { NS_ENSURE_ARG_POINTER(aBool); *aBool = mBeforeGenContent; return NS_OK; } NS_IMETHODIMP nsRange::GetHasGeneratedAfter(PRBool *aBool) { NS_ENSURE_ARG_POINTER(aBool); *aBool = mAfterGenContent; return NS_OK; } NS_IMETHODIMP nsRange::SetHasGeneratedBefore(PRBool aBool) { mBeforeGenContent = aBool; return NS_OK; } NS_IMETHODIMP nsRange::SetHasGeneratedAfter(PRBool aBool) { mAfterGenContent = aBool; return NS_OK; } NS_IMETHODIMP nsRange::SetBeforeAndAfter(PRBool aBefore, PRBool aAfter) { mBeforeGenContent = aBefore; mBeforeGenContent = aAfter; return NS_OK; }