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

词法分析

开发平台:

Visual C++

  1. #ifndef DOMNodeFilter_HEADER_GUARD_
  2. #define DOMNodeFilter_HEADER_GUARD_
  3. /*
  4.  * The Apache Software License, Version 1.1
  5.  *
  6.  * Copyright (c) 2001-2002 The Apache Software Foundation.  All rights
  7.  * reserved.
  8.  *
  9.  * Redistribution and use in source and binary forms, with or without
  10.  * modification, are permitted provided that the following conditions
  11.  * are met:
  12.  *
  13.  * 1. Redistributions of source code must retain the above copyright
  14.  *    notice, this list of conditions and the following disclaimer.
  15.  *
  16.  * 2. Redistributions in binary form must reproduce the above copyright
  17.  *    notice, this list of conditions and the following disclaimer in
  18.  *    the documentation and/or other materials provided with the
  19.  *    distribution.
  20.  *
  21.  * 3. The end-user documentation included with the redistribution,
  22.  *    if any, must include the following acknowledgment:
  23.  *       "This product includes software developed by the
  24.  *        Apache Software Foundation (http://www.apache.org/)."
  25.  *    Alternately, this acknowledgment may appear in the software itself,
  26.  *    if and wherever such third-party acknowledgments normally appear.
  27.  *
  28.  * 4. The names "Xerces" and "Apache Software Foundation" must
  29.  *    not be used to endorse or promote products derived from this
  30.  *    software without prior written permission. For written
  31.  *    permission, please contact apache@apache.org.
  32.  *
  33.  * 5. Products derived from this software may not be called "Apache",
  34.  *    nor may "Apache" appear in their name, without prior written
  35.  *    permission of the Apache Software Foundation.
  36.  *
  37.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  38.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  39.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  40.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  41.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  42.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  43.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  44.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  45.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  46.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  47.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  48.  * SUCH DAMAGE.
  49.  * ====================================================================
  50.  *
  51.  * This software consists of voluntary contributions made by many
  52.  * individuals on behalf of the Apache Software Foundation, and was
  53.  * originally based on software copyright (c) 2001, International
  54.  * Business Machines, Inc., http://www.ibm.com .  For more information
  55.  * on the Apache Software Foundation, please see
  56.  * <http://www.apache.org/>.
  57.  */
  58. /*
  59.  * $Id: DOMNodeFilter.hpp,v 1.6 2003/03/07 19:59:06 tng Exp $
  60.  */
  61. #include "DOMNode.hpp"
  62. XERCES_CPP_NAMESPACE_BEGIN
  63. /**
  64.  * Filters are objects that know how to "filter out" nodes. If a
  65.  * <code>DOMNodeIterator</code> or <code>DOMTreeWalker</code> is given a
  66.  * <code>DOMNodeFilter</code>, it applies the filter before it returns the next
  67.  * node. If the filter says to accept the node, the traversal logic returns
  68.  * it; otherwise, traversal looks for the next node and pretends that the
  69.  * node that was rejected was not there.
  70.  * <p>The DOM does not provide any filters. <code>DOMNodeFilter</code> is just an
  71.  * interface that users can implement to provide their own filters.
  72.  * <p><code>DOMNodeFilters</code> do not need to know how to traverse from node
  73.  * to node, nor do they need to know anything about the data structure that
  74.  * is being traversed. This makes it very easy to write filters, since the
  75.  * only thing they have to know how to do is evaluate a single node. One
  76.  * filter may be used with a number of different kinds of traversals,
  77.  * encouraging code reuse.
  78.  * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Traversal-Range-20001113'>Document Object Model (DOM) Level 2 Traversal and Range Specification</a>.
  79.  * @since DOM Level 2
  80.  */
  81. class CDOM_EXPORT DOMNodeFilter
  82. {
  83. protected:
  84.     // -----------------------------------------------------------------------
  85.     //  Hidden constructors
  86.     // -----------------------------------------------------------------------
  87.     /** @name Hidden constructors */
  88.     //@{    
  89.     DOMNodeFilter() {};
  90.     //@}    
  91. private:
  92.     // -----------------------------------------------------------------------
  93.     // Unimplemented constructors and operators
  94.     // -----------------------------------------------------------------------
  95.     /** @name Unimplemented constructors and operators */
  96.     //@{
  97.     DOMNodeFilter(const DOMNodeFilter &);
  98.     DOMNodeFilter & operator = (const DOMNodeFilter &);
  99.     //@}
  100. public:
  101.     // -----------------------------------------------------------------------
  102.     //  All constructors are hidden, just the destructor is available
  103.     // -----------------------------------------------------------------------
  104.     /** @name Destructor */
  105.     //@{
  106.     /**
  107.      * Destructor
  108.      *
  109.      */
  110.     virtual ~DOMNodeFilter() {};
  111.     //@}
  112.     // -----------------------------------------------------------------------
  113.     //  Class Types
  114.     // -----------------------------------------------------------------------
  115.     /** @name Public Contants */
  116.     //@{
  117.     /**
  118.      * Constants returned by acceptNode.
  119.      *
  120.      * <p><code>FILTER_ACCEPT:</code>
  121.      * Accept the node. Navigation methods defined for
  122.      * <code>DOMNodeIterator</code> or <code>DOMTreeWalker</code> will return this
  123.      * node.</p>
  124.      *
  125.      * <p><code>FILTER_REJECT:</code>
  126.      * Reject the node. Navigation methods defined for
  127.      * <code>DOMNodeIterator</code> or <code>DOMTreeWalker</code> will not return
  128.      * this node. For <code>DOMTreeWalker</code>, the children of this node
  129.      * will also be rejected. <code>DOMNodeIterators</code> treat this as a
  130.      * synonym for <code>FILTER_SKIP.</code></p>
  131.      *
  132.      * <p><code>FILTER_SKIP:</code>
  133.      * Skip this single node. Navigation methods defined for
  134.      * <code>DOMNodeIterator</code> or <code>DOMTreeWalker</code> will not return
  135.      * this node. For both <code>DOMNodeIterator</code> and
  136.      * <code>DOMTreeWalker</code>, the children of this node will still be
  137.      * considered.</p>
  138.      *
  139.      * @since DOM Level 2
  140.      */
  141.     enum FilterAction {FILTER_ACCEPT = 1,
  142.                        FILTER_REJECT = 2,
  143.                        FILTER_SKIP   = 3};
  144.     /**
  145.      * Constants for whatToShow
  146.      *
  147.      * <p><code>SHOW_ALL:</code>
  148.      * Show all <code>DOMNode(s)</code>.</p>
  149.      *
  150.      * <p><code>SHOW_ELEMENT:</code>
  151.      * Show <code>DOMElement</code> nodes.</p>
  152.      *
  153.      * <p><code>SHOW_ATTRIBUTE:</code>
  154.      * Show <code>DOMAttr</code> nodes. This is meaningful only when creating an
  155.      * <code>DOMNodeIterator</code> or <code>DOMTreeWalker</code> with an
  156.      * attribute node as its <code>root</code>; in this case, it means that
  157.      * the attribute node will appear in the first position of the iteration
  158.      * or traversal. Since attributes are never children of other nodes,
  159.      * they do not appear when traversing over the document tree.</p>
  160.      *
  161.      * <p><code>SHOW_TEXT:</code>
  162.      * Show <code>DOMText</code> nodes.</p>
  163.      *
  164.      * <p><code>SHOW_CDATA_SECTION:</code>
  165.      * Show <code>DOMCDATASection</code> nodes.</p>
  166.      *
  167.      * <p><code>SHOW_ENTITY_REFERENCE:</code>
  168.      * Show <code>DOMEntityReference</code> nodes.</p>
  169.      *
  170.      * <p><code>SHOW_ENTITY:</code>
  171.      * Show <code>DOMEntity</code> nodes. This is meaningful only when creating
  172.      * an <code>DOMNodeIterator</code> or <code>DOMTreeWalker</code> with an
  173.      * <code>DOMEntity</code> node as its <code>root</code>; in this case, it
  174.      * means that the <code>DOMEntity</code> node will appear in the first
  175.      * position of the traversal. Since entities are not part of the
  176.      * document tree, they do not appear when traversing over the document
  177.      * tree.</p>
  178.      *
  179.      * <p><code>SHOW_PROCESSING_INSTRUCTION:</code>
  180.      * Show <code>DOMProcessingInstruction</code> nodes.</p>
  181.      *
  182.      * <p><code>SHOW_COMMENT:</code>
  183.      * Show <code>DOMComment</code> nodes.</p>
  184.      *
  185.      * <p><code>SHOW_DOCUMENT:</code>
  186.      * Show <code>DOMDocument</code> nodes.</p>
  187.      *
  188.      * <p><code>SHOW_DOCUMENT_TYPE:</code>
  189.      * Show <code>DOMDocumentType</code> nodes.</p>
  190.      *
  191.      * <p><code>SHOW_DOCUMENT_FRAGMENT:</code>
  192.      * Show <code>DOMDocumentFragment</code> nodes.</p>
  193.      *
  194.      * <p><code>SHOW_NOTATION:</code>
  195.      * Show <code>DOMNotation</code> nodes. This is meaningful only when creating
  196.      * an <code>DOMNodeIterator</code> or <code>DOMTreeWalker</code> with a
  197.      * <code>DOMNotation</code> node as its <code>root</code>; in this case, it
  198.      * means that the <code>DOMNotation</code> node will appear in the first
  199.      * position of the traversal. Since notations are not part of the
  200.      * document tree, they do not appear when traversing over the document
  201.      * tree.</p>
  202.      *
  203.      * @since DOM Level 2
  204.      */
  205.     enum ShowType {
  206.         SHOW_ALL                       = 0x0000FFFF,
  207.         SHOW_ELEMENT                   = 0x00000001,
  208.         SHOW_ATTRIBUTE                 = 0x00000002,
  209.         SHOW_TEXT                      = 0x00000004,
  210.         SHOW_CDATA_SECTION             = 0x00000008,
  211.         SHOW_ENTITY_REFERENCE          = 0x00000010,
  212.         SHOW_ENTITY                    = 0x00000020,
  213.         SHOW_PROCESSING_INSTRUCTION    = 0x00000040,
  214.         SHOW_COMMENT                   = 0x00000080,
  215.         SHOW_DOCUMENT                  = 0x00000100,
  216.         SHOW_DOCUMENT_TYPE             = 0x00000200,
  217.         SHOW_DOCUMENT_FRAGMENT         = 0x00000400,
  218.         SHOW_NOTATION                  = 0x00000800
  219.     };
  220.     //@}
  221.     // -----------------------------------------------------------------------
  222.     //  Virtual DOMNodeFilter interface
  223.     // -----------------------------------------------------------------------
  224.     /** @name Functions introduced in DOM Level 2 */
  225.     //@{
  226.     /**
  227.      * Test whether a specified node is visible in the logical view of a
  228.      * <code>DOMTreeWalker</code> or <code>DOMNodeIterator</code>. This function
  229.      * will be called by the implementation of <code>DOMTreeWalker</code> and
  230.      * <code>DOMNodeIterator</code>; it is not normally called directly from
  231.      * user code. (Though you could do so if you wanted to use the same
  232.      * filter to guide your own application logic.)
  233.      * @param node The node to check to see if it passes the filter or not.
  234.      * @return A constant to determine whether the node is accepted,
  235.      *   rejected, or skipped, as defined above.
  236.      * @since DOM Level 2
  237.      */
  238.     virtual short acceptNode (const DOMNode* node) const =0;
  239.     //@}
  240. };
  241. XERCES_CPP_NAMESPACE_END
  242. #endif