NodeIteratorImpl.cpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:14k
源码类别:

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 1999, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56. /*
  57.  * $Log: NodeIteratorImpl.cpp,v $
  58.  * Revision 1.12  2001/10/18 18:01:29  tng
  59.  * [Bug 1699] Redirect "delete this" to a temp ptr to bypass AIX xlC v5 optimization memory leak problem.
  60.  *
  61.  * Revision 1.11  2000/11/01 01:26:30  andyh
  62.  * DOM NodeIterator bug fix - iterators would sometimes continue beyond
  63.  * their starting (root) node.  Fix from Tinny Ng.
  64.  *
  65.  * Revision 1.10  2000/07/17 23:00:16  jpolast
  66.  * bug fix for SHOW_ELEMENT flag incorrectly being retreived.
  67.  * contributed by Grace Yan and Joe Kesselman.
  68.  *
  69.  * Revision 1.9  2000/03/02 19:54:03  roddey
  70.  * This checkin includes many changes done while waiting for the
  71.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  72.  * available elsewhere.
  73.  *
  74.  * Revision 1.8  2000/02/08 20:26:11  aruna1
  75.  * NodeIterator problem solved
  76.  *
  77.  * Revision 1.7  2000/02/08 01:16:18  aruna1
  78.  * nodeIterator previous tracking problem solved
  79.  *
  80.  * Revision 1.6  2000/02/06 07:47:33  rahulj
  81.  * Year 2K copyright swat.
  82.  *
  83.  * Revision 1.5  2000/02/04 01:49:26  aruna1
  84.  * TreeWalker and NodeIterator changes
  85.  *
  86.  * Revision 1.4  1999/11/30 21:16:25  roddey
  87.  * Changes to add the transcode() method to DOMString, which returns a transcoded
  88.  * version (to local code page) of the DOM string contents. And I changed all of the
  89.  * exception 'throw by pointer' to 'throw by value' style.
  90.  *
  91.  * Revision 1.3  1999/11/23 01:48:16  rahulj
  92.  * Changed 0L to 0. CC under HPUX is happy now.
  93.  *
  94.  * Revision 1.2  1999/11/20 00:56:39  rahulj
  95.  * Source files must end with an un-escaped newline.
  96.  *
  97.  * Revision 1.1.1.1  1999/11/09 01:09:15  twl
  98.  * Initial checkin
  99.  *
  100.  * Revision 1.2  1999/11/08 20:44:30  rahul
  101.  * Swat for adding in Product name and CVS comment log variable.
  102.  *
  103.  */
  104. // NodeIteratorImpl.cpp: implementation of the NodeIteratorImpl class.
  105. //
  106. //////////////////////////////////////////////////////////////////////
  107. #include "NodeIteratorImpl.hpp"
  108. #include "DOM_Document.hpp"
  109. #include "DOM_DOMException.hpp"
  110. #include "DocumentImpl.hpp"
  111. //////////////////////////////////////////////////////////////////////
  112. // Construction/Destruction
  113. //////////////////////////////////////////////////////////////////////
  114. NodeIteratorImpl::NodeIteratorImpl ()
  115. : fDetached(false),
  116.     fNodeFilter(0)
  117. {
  118. }
  119. NodeIteratorImpl::~NodeIteratorImpl ()
  120. {
  121. fDetached = false;
  122. }
  123. void NodeIteratorImpl::detach ()
  124. {
  125. fDetached = true;
  126. }
  127. NodeIteratorImpl::NodeIteratorImpl (
  128.                                     DOM_Node root,
  129.                                     unsigned long whatToShow,
  130.                                     DOM_NodeFilter* nodeFilter,
  131.                                     bool expandEntityRef)
  132. :   fDetached(false),
  133.     fRoot(root),
  134.     fCurrentNode(0),
  135.     fWhatToShow(whatToShow),
  136.     fNodeFilter(nodeFilter),
  137.     fForward(true),
  138.     fExpandEntityReferences(expandEntityRef)
  139. {
  140. }
  141. NodeIteratorImpl::NodeIteratorImpl ( const NodeIteratorImpl& toCopy)
  142.     :   fDetached(toCopy.fDetached),
  143.     fRoot(toCopy.fRoot),
  144.     fCurrentNode(toCopy.fCurrentNode),
  145.     fWhatToShow(toCopy.fWhatToShow),
  146.     fNodeFilter(toCopy.fNodeFilter),
  147.     fForward(toCopy.fForward),
  148.     fExpandEntityReferences(toCopy.fExpandEntityReferences)
  149. {
  150. }
  151. NodeIteratorImpl& NodeIteratorImpl::operator= (const NodeIteratorImpl& other) {
  152.     fRoot                   = other.fRoot;
  153.     fCurrentNode            = other.fRoot;
  154.     fWhatToShow             = other.fWhatToShow;
  155.     fNodeFilter             = other.fNodeFilter;
  156.     fForward                = other.fForward;
  157. fDetached               = other.fDetached;
  158.     fExpandEntityReferences = other.fExpandEntityReferences;
  159.     return *this;
  160. }
  161. // Implementation Note: Note that the iterator looks at whatToShow
  162. // and filter values at each call, and therefore one _could_ add
  163. // setters for these values and alter them while iterating!
  164. /** Return the whatToShow value */
  165. unsigned long NodeIteratorImpl::getWhatToShow () {
  166.     return fWhatToShow;
  167. }
  168. /** Return the filter */
  169. DOM_NodeFilter* NodeIteratorImpl::getFilter () {
  170.     return fNodeFilter;
  171. }
  172. /** Get the expandEntity reference flag. */
  173. bool NodeIteratorImpl::getExpandEntityReferences()
  174. {
  175.     return fExpandEntityReferences;
  176. }
  177. /** Return the next DOM_Node in the Iterator. The node is the next node in
  178.  *  depth-first order which also passes the filter, and whatToShow.
  179.  *  A null return means either that
  180.  */
  181. DOM_Node NodeIteratorImpl::nextNode () {
  182. if (fDetached)
  183. throw DOM_DOMException(DOM_DOMException::INVALID_STATE_ERR, null);
  184. DOM_Node result;
  185.     // if root is null there is no next node.
  186.     if (fRoot.isNull())
  187. return result;
  188.     DOM_Node aNextNode = fCurrentNode;
  189.     bool accepted = false; // the next node has not been accepted.
  190.     while (!accepted) {
  191.         // if last direction is not forward, repeat node.
  192.         if (!fForward && !aNextNode.isNull()) {
  193.             //System.out.println("nextNode():!fForward:"+fCurrentNode.getNodeName());
  194.             aNextNode = fCurrentNode;
  195.         } else {
  196.         // else get the next node via depth-first
  197.             aNextNode = nextNode(aNextNode, true);
  198.         }
  199.         fForward = true; //REVIST: should direction be set forward before null check?
  200.         // nothing in the list. return null.
  201.         if (aNextNode.isNull())
  202. return result;
  203.         // does node pass the filters and whatToShow?
  204.         accepted = acceptNode(aNextNode);
  205.         if (accepted) {
  206.             // if so, then the node is the current node.
  207.             fCurrentNode = aNextNode;
  208.             return fCurrentNode;
  209. }
  210.     }
  211.     // no nodes, or no accepted nodes.
  212.     return result;
  213. }
  214. /** Return the previous Node in the Iterator. The node is the next node in
  215.  *  _backwards_ depth-first order which also passes the filter, and whatToShow.
  216.  */
  217. DOM_Node NodeIteratorImpl::previousNode () {
  218. if (fDetached)
  219. throw DOM_DOMException(DOM_DOMException::INVALID_STATE_ERR, null);
  220. DOM_Node result;
  221.     // if the root is null, or the current node is null, return null.
  222.     if (fRoot.isNull() || fCurrentNode.isNull())
  223. return result;
  224.     DOM_Node aPreviousNode = fCurrentNode;
  225.     bool accepted = false;
  226.     while (!accepted) {
  227.         if (fForward && ! aPreviousNode.isNull()) {
  228.             //repeat last node.
  229.             aPreviousNode = fCurrentNode;
  230.         } else {
  231.             // get previous node in backwards depth first order.
  232.             aPreviousNode = previousNode(aPreviousNode);
  233.         }
  234.         // we are going backwards
  235.         fForward = false;
  236.         // if the new previous node is null, we're at head or past the root,
  237.         // so return null.
  238.         if (aPreviousNode.isNull())
  239. return result;
  240.         // check if node passes filters and whatToShow.
  241.         accepted = acceptNode(aPreviousNode);
  242.         if (accepted) {
  243.             // if accepted, update the current node, and return it.
  244.             fCurrentNode = aPreviousNode;
  245.             return fCurrentNode;
  246.         }
  247.     }
  248.     // there are no nodes?
  249.     return result;
  250. }
  251. /** The node is accepted if it passes the whatToShow and the filter. */
  252. bool NodeIteratorImpl::acceptNode (DOM_Node node) {
  253. if (fDetached)
  254. throw DOM_DOMException(DOM_DOMException::INVALID_STATE_ERR, null);
  255.     if (fNodeFilter == 0) {
  256.         return ((fWhatToShow & (1 << (node.getNodeType() - 1))) != 0);
  257.     } else {
  258.         return ((fWhatToShow & (1 << (node.getNodeType() - 1))) != 0)
  259.             && fNodeFilter->acceptNode(node) == DOM_NodeFilter::FILTER_ACCEPT;
  260.     }
  261. }
  262. /** Return node, if matches or any parent if matches. */
  263. DOM_Node NodeIteratorImpl::matchNodeOrParent (DOM_Node node) {
  264. DOM_Node result;
  265.     for (DOM_Node n = node; n != fRoot; n = n.getParentNode()) {
  266.         if (node == n) return n;
  267.     }
  268.     return result;
  269. }
  270. /** The method nextNode(DOM_Node, bool) returns the next node
  271.  *  from the actual DOM tree.
  272.  *
  273.  *  The bool visitChildren determines whether to visit the children.
  274.  *  The result is the nextNode.
  275.  */
  276. DOM_Node NodeIteratorImpl::nextNode (DOM_Node node, bool visitChildren) {
  277. if (fDetached)
  278. throw DOM_DOMException(DOM_DOMException::INVALID_STATE_ERR, null);
  279.     if (node.isNull()) return fRoot;
  280.     DOM_Node result;
  281.     // only check children if we visit children.
  282.     if (visitChildren) {
  283.         //if hasChildren, return 1st child.
  284.         if (node.hasChildNodes()) {
  285.             result = node.getFirstChild();
  286.             return result;
  287.         }
  288.     }
  289.     // if hasSibling, return sibling
  290.     if (node != fRoot) {
  291.         result = node.getNextSibling();
  292.         if (! result.isNull()) return result;
  293.         // return parent's 1st sibling.
  294.         DOM_Node parent = node.getParentNode();
  295.         while (!parent.isNull() && parent != fRoot) {
  296.             result = parent.getNextSibling();
  297.             if (!result.isNull()) {
  298.                 return result;
  299.             } else {
  300.                 parent = parent.getParentNode();
  301.             }
  302.         } // while (parent != null && parent != fRoot) {
  303.     }
  304.     // end of list, return null
  305.     DOM_Node aNull;
  306.     return aNull;
  307. }
  308. /** The method previousNode(DOM_Node) returns the previous node
  309.  *  from the actual DOM tree.
  310.  */
  311. DOM_Node NodeIteratorImpl::previousNode (DOM_Node node) {
  312. if (fDetached)
  313. throw DOM_DOMException(DOM_DOMException::INVALID_STATE_ERR, null);
  314.     DOM_Node result;
  315.     // if we're at the root, return null.
  316.     if (node == fRoot)
  317. return result;
  318.     // get sibling
  319.     result = node.getPreviousSibling();
  320.     if (result.isNull()) {
  321.         //if 1st sibling, return parent
  322.         result = node.getParentNode();
  323.         return result;
  324.     }
  325.     // if sibling has children, keep getting last child of child.
  326.     if (result.hasChildNodes()) {
  327.         while (result.hasChildNodes()) {
  328.             result = result.getLastChild();
  329.         }
  330.     }
  331.     return result;
  332. }
  333. /** Fix-up the iterator on a remove. Called by DOM or otherwise,
  334.  *  before an actual DOM remove.
  335.  */
  336. void NodeIteratorImpl::removeNode (DOM_Node node) {
  337. if (fDetached)
  338. throw DOM_DOMException(DOM_DOMException::INVALID_STATE_ERR, null);
  339.     // Implementation note: Fix-up means setting the current node properly
  340.     // after a remove.
  341.     if (node.isNull())
  342. return;
  343.     DOM_Node deleted = matchNodeOrParent(node);
  344.     if (deleted.isNull()) return;
  345.     if (fForward) {
  346.         fCurrentNode = previousNode(deleted);
  347.     } else
  348.     // if (!fForward)
  349.     {
  350.         DOM_Node next = nextNode(deleted, false);
  351.         if (! next.isNull()) {
  352.             // normal case: there _are_ nodes following this in the iterator.
  353.             fCurrentNode = next;
  354.         } else {
  355.             // the last node in the iterator is to be removed,
  356.             // so we set the current node to be the previous one.
  357.             fCurrentNode = previousNode(deleted);
  358.             fForward = true;
  359.         }
  360.     }
  361. }
  362. void NodeIteratorImpl::unreferenced()
  363. {
  364.     DOM_Document doc = fRoot.getOwnerDocument();
  365.     DocumentImpl* impl;
  366.     if (! doc.isNull()) {
  367.         impl = (DocumentImpl *) doc.fImpl;
  368.     }
  369.     else
  370.         impl = (DocumentImpl *) fRoot.fImpl;
  371.     if (impl->iterators != 0L) {
  372.         int i;
  373.         int sz = impl->iterators->size();
  374.         for (i = 0; i < sz; i++)
  375.             if (impl->iterators->elementAt(i) == this) {
  376.                 impl->iterators->removeElementAt(i);
  377.                 break;
  378.             }
  379.     }
  380. //    delete this;
  381.     NodeIteratorImpl* ptr = this;
  382.     delete ptr;
  383. }