DOM_DocumentType.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_DocumentType.hpp,v 1.3 2002/11/04 15:04:44 tng Exp $
  58.  */
  59. #ifndef DOM_DocumentType_HEADER_GUARD_
  60. #define DOM_DocumentType_HEADER_GUARD_
  61. #include <xercesc/util/XercesDefs.hpp>
  62. #include "DOM_Node.hpp"
  63. XERCES_CPP_NAMESPACE_BEGIN
  64. class DOM_NamedNodeMap;
  65. class DocumentTypeImpl;
  66. /**
  67.  * Each <code>Document</code> has a <code>doctype</code> whose value
  68.  * is either <code>null</code> or a <code>DocumentType</code> object.
  69.  *
  70.  * The <code>DOM_DocumentType</code> class provides access
  71.  *  to the list of entities and notations that are defined for the document.
  72.  * <p>The DOM Level 1 doesn't support editing <code>DocumentType</code> nodes.
  73.  */
  74. class CDOM_EXPORT DOM_DocumentType: public DOM_Node {
  75. public:
  76.     /** @name Constructors and assignment operator */
  77.     //@{
  78.     /**
  79.       * Default constructor for DOM_DocumentType.  The resulting object does not
  80.       * refer to an actual DocumentType node; it will compare == to 0, and is similar
  81.       * to a null object reference variable in Java.  It may subsequently be
  82.       * assigned to refer to the actual DocumentType node.
  83.       * <p>
  84.       * A new DocumentType node for a document that does not already have one
  85.       * can be created by DOM_Document::createDocumentType().
  86.       *
  87.       */
  88.     DOM_DocumentType();
  89.     /**
  90.       * Constructor for a null DOM_DocumentType.
  91.       * This allows passing 0 directly as a null DOM_DocumentType to
  92.       * function calls that take DOM_DocumentType as parameters.
  93.       *
  94.       * @param nullPointer Must be 0.
  95.       */
  96.     DOM_DocumentType(int nullPointer);
  97.     /**
  98.       * Copy constructor.  Creates a new <code>DOM_Comment</code> that refers to the
  99.       * same underlying node as the original.
  100.       *
  101.       *
  102.       * @param other The object to be copied.
  103.       */
  104.     DOM_DocumentType(const DOM_DocumentType &other);
  105.     /**
  106.       * Assignment operator.
  107.       *
  108.       * @param other The object to be copied.
  109.       */
  110.     DOM_DocumentType & operator = (const DOM_DocumentType &other);
  111.     /**
  112.       * Assignment operator.  This overloaded variant is provided for
  113.       *   the sole purpose of setting a DOM_Node reference variable to
  114.       *   zero.  Nulling out a reference variable in this way will decrement
  115.       *   the reference count on the underlying Node object that the variable
  116.       *   formerly referenced.  This effect is normally obtained when reference
  117.       *   variable goes out of scope, but zeroing them can be useful for
  118.       *   global instances, or for local instances that will remain in scope
  119.       *   for an extended time,  when the storage belonging to the underlying
  120.       *   node needs to be reclaimed.
  121.       *
  122.       * @param val   Only a value of 0, or null, is allowed.
  123.       */
  124.     DOM_DocumentType & operator = (const DOM_NullPtr *val);
  125.     //@}
  126.     /** @name Destructor. */
  127.     //@{
  128.  /**
  129.   * Destructor for DOM_DocumentType.  The object being destroyed is the reference
  130.       * object, not the underlying DocumentType node itself.
  131.   *
  132.   */
  133.     ~DOM_DocumentType();
  134.     //@}
  135.     /** @name Getter functions. */
  136.     //@{
  137.   /**
  138.    * The name of DTD; i.e., the name immediately following the
  139.    * <code>DOCTYPE</code> keyword in an XML source document.
  140.    */
  141.   DOMString       getName() const;
  142.   /**
  143.    * This function returns a  <code>NamedNodeMap</code> containing the general entities, both
  144.    * external and internal, declared in the DTD. Parameter entities are not contained.
  145.    * Duplicates are discarded.
  146.    * <p>
  147.    * Note: this functionality is not implemented in the initial release
  148.    * of the parser, and the returned NamedNodeMap will be empty.
  149.    */
  150.   DOM_NamedNodeMap getEntities() const;
  151.   /**
  152.    * This function returns a named node map containing an entry for
  153.    * each notation declared in a document's DTD.  Duplicates are discarded.
  154.    *
  155.    * <p>
  156.    * Note: this functionality is not implemented in the initial release
  157.    * of the parser, and the returned NamedNodeMap will be empty.
  158.    */
  159.   DOM_NamedNodeMap getNotations() const;
  160.   //@}
  161.     /** @name Functions introduced in DOM Level 2. */
  162.     //@{
  163.     /**
  164.      * Get the public identifier of the external subset.
  165.      *
  166.      * @return The public identifier of the external subset.
  167.      */
  168.     DOMString     getPublicId() const;
  169.     /**
  170.      * Get the system identifier of the external subset.
  171.      *
  172.      * @return The system identifier of the external subset.
  173.      */
  174.     DOMString     getSystemId() const;
  175.     /**
  176.      * Get the internal subset as a string.
  177.      *
  178.      * @return The internal subset as a string.
  179.      */
  180.     DOMString     getInternalSubset() const;
  181.     //@}
  182. protected:
  183.     DOM_DocumentType(DocumentTypeImpl *);
  184.     friend class DOM_Document;
  185.     friend class DOM_DOMImplementation;
  186. };
  187. XERCES_CPP_NAMESPACE_END
  188. #endif