DOM_TreeWalker.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:10k
源码类别:

词法分析

开发平台:

Visual C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2002 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.  * $Id: DOM_TreeWalker.hpp,v 1.3 2002/11/04 15:04:44 tng Exp $
  58.  */
  59. #ifndef DOM_TreeWalker_HEADER_GUARD_
  60. #define DOM_TreeWalker_HEADER_GUARD_
  61. #include "DOM_Node.hpp"
  62. #include "DOM_NodeFilter.hpp"
  63. XERCES_CPP_NAMESPACE_BEGIN
  64. class TreeWalkerImpl;
  65. /**
  66.  * <code>DOM_TreeWalker</code> objects are used to navigate a document tree or
  67.  * subtree using the view of the document defined by its <code>whatToShow</code>
  68.  * flags and any filters that are defined for the <code>DOM_TreeWalker</code>. Any
  69.  * function which performs navigation using a <code>DOM_TreeWalker</code> will
  70.  * automatically support any view defined by a <code>DOM_TreeWalker</code>.
  71.  *
  72.  * Omitting nodes from the logical view of a subtree can result in a structure that is
  73.  * substantially different from the same subtree in the complete, unfiltered document. Nodes
  74.  * that are siblings in the DOM_TreeWalker view may be children of different, widely separated
  75.  * nodes in the original view. For instance, consider a Filter that skips all nodes except for
  76.  * Text nodes and the root node of a document. In the logical view that results, all text
  77.  * nodes will be siblings and appear as direct children of the root node, no matter how
  78.  * deeply nested the structure of the original document.
  79.  *
  80.  */
  81. class CDOM_EXPORT DOM_TreeWalker {
  82.     public:
  83.         /** @name Constructors and assignment operator */
  84.         //@{
  85.         /**
  86.           * Default constructor.
  87.           */
  88.         DOM_TreeWalker();
  89.         /**
  90.           * Copy constructor.
  91.           *
  92.           * @param other The object to be copied.
  93.           */
  94.         DOM_TreeWalker(const DOM_TreeWalker &other);
  95.         /**
  96.           * Assignment operator.
  97.           *
  98.           * @param other The object to be copied.
  99.           */
  100.         DOM_TreeWalker & operator = (const DOM_TreeWalker &other);
  101.         /**
  102.           * Assignment operator.  This overloaded variant is provided for
  103.           *   the sole purpose of setting a DOM_NodeIterator to null.
  104.           *
  105.           * @param val  Only a value of 0, or null, is allowed.
  106.           */
  107.         DOM_TreeWalker & operator = (const DOM_NullPtr *val);
  108.         //@}
  109.         /** @name Destructor. */
  110.         //@{
  111. /**
  112.   * Destructor for DOM_TreeWalker.
  113.   */
  114.         ~DOM_TreeWalker();
  115.         //@}
  116.         /** @name Equality and Inequality operators. */
  117.         //@{
  118.         /**
  119.          * The equality operator.
  120.          *
  121.          * @param other The object reference with which <code>this</code> object is compared
  122.          * @returns True if both <code>DOM_TreeWalker</code>s refer to the same
  123.          *  actual node, or are both null; return false otherwise.
  124.          */
  125.         bool operator == (const DOM_TreeWalker & other)const;
  126.         /**
  127.           *  Compare with a pointer.  Intended only to allow a convenient
  128.           *    comparison with null.
  129.           */
  130.         bool operator == (const DOM_NullPtr *other) const;
  131.         /**
  132.          * The inequality operator.  See operator ==.
  133.          */
  134.         bool operator != (const DOM_TreeWalker & other) const;
  135.          /**
  136.           *  Compare with a pointer.  Intended only to allow a convenient
  137.           *    comparison with null.
  138.           *
  139.           */
  140.         bool operator != (const DOM_NullPtr * other) const;
  141.         //@}
  142.         /** @name Get functions. */
  143.         //@{
  144.         /**
  145.          * The <code>root</code> node of the <code>TreeWalker</code>, as specified
  146.          * when it was created.
  147.          */
  148.         DOM_Node          getRoot();
  149.         /**
  150.           * Return which node types are presented via the DOM_TreeWalker.
  151.           * These constants are defined in the DOM_NodeFilter interface.
  152.           *
  153.           */
  154.         unsigned long    getWhatToShow();
  155.         /**
  156.           * Return The filter used to screen nodes.
  157.           *
  158.           */
  159.         DOM_NodeFilter* getFilter();
  160.         /**
  161.           * Return the expandEntityReferences flag.
  162.           * The value of this flag determines whether the children of entity reference
  163.           * nodes are visible to the DOM_TreeWalker. If false, they will be skipped over.
  164.           *
  165.           */
  166.         bool getExpandEntityReferences();
  167.         /**
  168.           * Return the node at which the DOM_TreeWalker is currently positioned.
  169.           *
  170.           */
  171.         DOM_Node getCurrentNode();
  172.         /**
  173.           * Moves to and returns the closest visible ancestor node of the current node.
  174.           * If the search for parentNode attempts to step upward from the DOM_TreeWalker's root
  175.           * node, or if it fails to find a visible ancestor node, this method retains the
  176.           * current position and returns null.
  177.           *
  178.           */
  179.         DOM_Node parentNode();
  180.         /**
  181.           * Moves the <code>DOM_TreeWalker</code> to the first child of the current node,
  182.           * and returns the new node. If the current node has no children, returns
  183.           * <code>null</code>, and retains the current node.
  184.           *
  185.           */
  186.         DOM_Node firstChild();
  187.         /**
  188.           * Moves the <code>DOM_TreeWalker</code> to the last child of the current node, and
  189.           * returns the new node. If the current node has no children, returns
  190.           * <code>null</code>, and retains the current node.
  191.           *
  192.           */
  193.         DOM_Node lastChild();
  194.         /**
  195.           * Moves the <code>DOM_TreeWalker</code> to the previous sibling of the current
  196.           * node, and returns the new node. If the current node has no previous sibling,
  197.           * returns <code>null</code>, and retains the current node.
  198.           *
  199.           */
  200.         DOM_Node previousSibling();
  201.         /**
  202.           * Moves the <code>DOM_TreeWalker</code> to the next sibling of the current node,
  203.           * and returns the new node. If the current node has no next sibling, returns
  204.           * <code>null</code>, and retains the current node.
  205.           *
  206.           */
  207.         DOM_Node nextSibling();
  208.         /**
  209.           * Moves the <code>DOM_TreeWalker</code> to the previous visible node in document
  210.           * order relative to the current node, and returns the new node. If the current
  211.           * node has no previous node,
  212.           * or if the search for previousNode attempts to step upward from the DOM_TreeWalker's
  213.           * root node, returns <code>null</code>, and retains the current node.
  214.           *
  215.           */
  216.         DOM_Node previousNode();
  217.         /**
  218.           * Moves the <code>DOM_TreeWalker</code> to the next visible node in document order
  219.           * relative to the current node, and returns the new node. If the current node has
  220.           * no next node,
  221.           * or if the search for nextNode attempts to step upward from the DOM_TreeWalker's
  222.           * root node, returns <code>null</code>, and retains the current node.
  223.           *
  224.           */
  225.         DOM_Node nextNode();
  226.         //@}
  227.         /** @name Set functions. */
  228.         //@{
  229.         /**
  230.           * Set the node at which the DOM_TreeWalker is currently positioned.
  231.           *
  232.           */
  233.         void setCurrentNode(DOM_Node currentNode);
  234.         //@}
  235.     protected:
  236.         DOM_TreeWalker(TreeWalkerImpl* impl);
  237.         friend class DOM_Document;
  238.     private:
  239.         TreeWalkerImpl*         fImpl;
  240. };
  241. XERCES_CPP_NAMESPACE_END
  242. #endif