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

词法分析

开发平台:

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_NodeList.hpp,v 1.3 2002/11/04 15:04:44 tng Exp $
  58.  */
  59. #ifndef DOM_NodeList_HEADER_GUARD_
  60. #define DOM_NodeList_HEADER_GUARD_
  61. #include <xercesc/util/XercesDefs.hpp>
  62. #include "DOM_Node.hpp"
  63. XERCES_CPP_NAMESPACE_BEGIN
  64. class NodeListImpl;
  65. /**
  66.  * The <code>NodeList</code> interface provides the abstraction of an ordered
  67.  * collection of nodes.  NodeLists are created by DOM_Document::getElementsByTagName(),
  68.  * DOM_Node::getChildNodes(),
  69.  *
  70.  * <p>The items in the <code>NodeList</code> are accessible via an integral
  71.  * index, starting from 0.
  72.  *
  73.  * NodeLists are "live", in that any changes to the document tree are immediately
  74.  * reflected in any NodeLists that may have been created for that tree.
  75.  */
  76. class  CDOM_EXPORT DOM_NodeList {
  77. private:
  78.     NodeListImpl *fImpl;
  79. public:
  80.     /** @name Constructors and assignment operator */
  81.     //@{
  82.     /**
  83.       * Default constructor for DOM_NodeList.  The resulting object does not
  84.       * refer to an actual NodeList; it will compare == to 0, and is similar
  85.       * to a null object reference variable in Java.  It may subsequently be
  86.       * assigned to refer to an actual NodeList.
  87.       *
  88.       */
  89.     DOM_NodeList();
  90.     /**
  91.       * Copy constructor.
  92.       *
  93.       * @param other The object to be copied.
  94.       */
  95.     DOM_NodeList(const DOM_NodeList &other);
  96.     /**
  97.       * Assignment operator.
  98.       *
  99.       * @param other The object to be copied.
  100.       */
  101.     DOM_NodeList & operator = (const DOM_NodeList &other);
  102.     /**
  103.       * Assignment operator.  This overloaded variant is provided for
  104.       *   the sole purpose of setting a DOM_Node reference variable to
  105.       *   zero.  Nulling out a reference variable in this way will decrement
  106.       *   the reference count on the underlying Node object that the variable
  107.       *   formerly referenced.  This effect is normally obtained when reference
  108.       *   variable goes out of scope, but zeroing them can be useful for
  109.       *   global instances, or for local instances that will remain in scope
  110.       *   for an extended time,  when the storage belonging to the underlying
  111.       *   node needs to be reclaimed.
  112.       *
  113.       * @param val   Only a value of 0, or null, is allowed.
  114.       */
  115.     DOM_NodeList & operator = (const DOM_NullPtr *val);
  116.     //@}
  117.     /** @name Destructor. */
  118.     //@{
  119.  /**
  120.   * Destructor for DOM_NodeList.  The object being destroyed is the reference
  121.       * object, not the underlying NodeList node itself.
  122.   *
  123.       * <p>Like most other DOM types in this implementation, memory management
  124.       * of Node Lists is automatic.  Instances of DOM_NodeList function
  125.       * as references to an underlying heap based implementation object,
  126.       * and should never be explicitly new-ed or deleted in application code, but
  127.       * should appear only as local variables or function parameters.
  128.   */
  129.     ~DOM_NodeList();
  130.     //@}
  131.     /** @name Comparison operators. */
  132.     //@{
  133.     /**
  134.       *  Equality operator.
  135.       *  Compares whether two node list
  136.       *  variables refer to the same underlying node list.  It does
  137.       *  not compare the contents of the node lists themselves.
  138.       *
  139.       *  @param other The value to be compared
  140.       *  @return Returns true if node list refers to same underlying node list
  141.       */
  142.     bool operator == (const DOM_NodeList &other) const;
  143.     /**
  144.      *  Use this comparison operator to test whether a Node List reference
  145.      *  is null.
  146.      *
  147.      *  @param nullPtr The value to be compared, which must be 0 or null.
  148.      *  @return Returns true if node list reference is null
  149.      */
  150.     bool operator == (const DOM_NullPtr *nullPtr) const;
  151.      /**
  152.       *  Inequality operator.
  153.       *  Compares whether two node list
  154.       *  variables refer to the same underlying node list.  It does
  155.       *  not compare the contents of the node lists themselves.
  156.       *
  157.       *  @param other The value to be compared
  158.       *  @return Returns true if node list refers to a different underlying node list
  159.       */
  160.     bool operator != (const DOM_NodeList &other) const;
  161.     /**
  162.      *  Use this comparison operator to test whether a Node List reference
  163.      *  is not null.
  164.      *
  165.      *  @param nullPtr The value to be compared, which must be 0 or null.
  166.      *  @return Returns true if node list reference is not null
  167.      */
  168.     bool operator != (const DOM_NullPtr *nullPtr) const;
  169.     //@}
  170.     /** @name Get functions. */
  171.     //@{
  172.     /**
  173.      * Returns the <code>index</code>th item in the collection.
  174.      *
  175.      * If <code>index</code> is greater than or equal to the number of nodes in
  176.      * the list, this returns <code>null</code>.
  177.      *
  178.      * @param index Index into the collection.
  179.      * @return The node at the <code>index</code>th position in the
  180.      *   <code>NodeList</code>, or <code>null</code> if that is not a valid
  181.      *   index.
  182.      */
  183.     DOM_Node  item(unsigned int index) const;
  184.     /**
  185.      * Returns the number of nodes in the list.
  186.      *
  187.      * The range of valid child node indices is 0 to <code>length-1</code> inclusive.
  188.      */
  189.     unsigned int getLength() const;
  190.     //@}
  191. protected:
  192.     DOM_NodeList(NodeListImpl *impl);
  193.     friend class DOM_Document;
  194.     friend class DOM_Element;
  195.     friend class DOM_Node;
  196.     friend class DOM_Entity;
  197. };
  198. XERCES_CPP_NAMESPACE_END
  199. #endif