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

词法分析

开发平台:

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_NodeFilter.hpp,v 1.3 2002/11/04 15:04:44 tng Exp $
  58.  */
  59. // DOM_NodeFilter.h: interface for the DOM_NodeFilter class.
  60. //
  61. //////////////////////////////////////////////////////////////////////
  62. #ifndef DOM_NodeFilter_HEADER_GUARD_
  63. #define DOM_NodeFilter_HEADER_GUARD_
  64. #include "DOM_Node.hpp"
  65. XERCES_CPP_NAMESPACE_BEGIN
  66. class NodeFilterImpl;
  67. /**
  68.  * Filters are objects that know how to "filter out" nodes. If a
  69.  * <code>DOM_NodeIterator</code> or <code>DOM_TreeWalker</code> is given a
  70.  * filter, it applies the filter before it returns the next node.
  71.  *
  72.  * If the filter says to accept the node, the iterator returns it; otherwise, the
  73.  * iterator looks for the next node and pretends that the node that was rejected
  74.  * was not there.
  75.  *
  76.  *  The DOM does not provide any filters. Filter is just an interface that users can
  77.  *  implement to provide their own filters.
  78.  *
  79.  *  Filters do not need to know how to iterate, nor do they need to know anything
  80.  *  about the data structure that is being iterated. This makes it very easy to write
  81.  *  filters, since the only thing they have to know how to do is evaluate a single node.
  82.  *  One filter may be used with a number of different kinds of iterators, encouraging
  83.  *  code reuse.
  84.  *
  85.  */
  86. class CDOM_EXPORT DOM_NodeFilter
  87. {
  88.     public:
  89. /** @name Enumerators for Node Filter */
  90.         //@{
  91. /*
  92.   * <table><tr><td>FILTER_ACCEPT</td>
  93.       *            <td>Accept the node. Navigation methods defined for
  94.       *                NodeIterator or TreeWalker will return this node.</td>
  95.   * </tr>
  96.   * <tr><td>
  97.       *               FILTER_REJECT</td>
  98.       *               <td>Reject the node. Navigation methods defined for
  99.       *               NodeIterator or TreeWalker will not return this
  100.       *               node. For TreeWalker, the children of this node will
  101.       *               also be rejected. Iterators treat this as a synonym
  102.       *               for FILTER_SKIP.</td>
  103.   * </tr>
  104.   * <tr><td>FILTER_SKIP</td>
  105.       *              <td>Reject the node. Navigation methods defined for
  106.       *                  NodeIterator or TreeWalker will not return this
  107.       *                  node. For both NodeIterator and Treewalker, the
  108.       *                  children of this node will still be considered.</td>
  109.     * </tr>
  110.   * </table>
  111.       *
  112.   */
  113.         enum FilterAction {FILTER_ACCEPT = 1,
  114.                            FILTER_REJECT = 2,
  115.                            FILTER_SKIP   = 3};
  116.         enum ShowType {
  117.             SHOW_ALL                       = 0x0000FFFF,
  118.             SHOW_ELEMENT                   = 0x00000001,
  119.             SHOW_ATTRIBUTE                 = 0x00000002,
  120.             SHOW_TEXT                      = 0x00000004,
  121.             SHOW_CDATA_SECTION             = 0x00000008,
  122.             SHOW_ENTITY_REFERENCE          = 0x00000010,
  123.             SHOW_ENTITY                    = 0x00000020,
  124.             SHOW_PROCESSING_INSTRUCTION    = 0x00000040,
  125.             SHOW_COMMENT                   = 0x00000080,
  126.             SHOW_DOCUMENT                  = 0x00000100,
  127.             SHOW_DOCUMENT_TYPE             = 0x00000200,
  128.             SHOW_DOCUMENT_FRAGMENT         = 0x00000400,
  129.             SHOW_NOTATION                  = 0x00000800
  130.         };
  131. //@}
  132.         /** @name Constructors */
  133.         //@{
  134.         /**
  135.           * Default constructor for DOM_NodeFilter.
  136.           */
  137.         DOM_NodeFilter();
  138.         //@}
  139.         /** @name Destructor. */
  140.         //@{
  141. /**
  142.   * Destructor for DOM_NodeFilter.
  143.   */
  144.         virtual ~DOM_NodeFilter();
  145.         //@}
  146.         /** @name Test function. */
  147.         //@{
  148. /**
  149.   * Test whether a specified node is visible in the logical view of a DOM_TreeWalker
  150.   * or DOM_NodeIterator. This function will be called by the implementation of
  151.   * DOM_TreeWalker and DOM_NodeIterator; it is not intended to be called directly from user
  152.   * code.
  153.           *
  154.           * @param node The node to check to see if it passes the filter or not.
  155.           * @return A constant to determine whether the node is accepted, rejected, or skipped.
  156.   */
  157.         virtual short acceptNode (const DOM_Node &node) const =0;
  158.         //@}
  159.     private:
  160.         DOM_NodeFilter(const DOM_NodeFilter &other);
  161.         DOM_NodeFilter & operator = (const DOM_NodeFilter &other);
  162.         bool operator == (const DOM_NodeFilter &other) const;
  163.         bool operator != (const DOM_NodeFilter &other) const;
  164. };
  165. XERCES_CPP_NAMESPACE_END
  166. #endif