DOM_DocumentType.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:8k
源码类别:

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  * 
  4.  * Copyright (c) 1999-2000 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.  * $Log: DOM_DocumentType.hpp,v $
  58.  * Revision 1.8  2000/03/10 02:14:39  chchou
  59.  * add null DOM_DocumentType constructor
  60.  *
  61.  * Revision 1.7  2000/03/02 19:53:55  roddey
  62.  * This checkin includes many changes done while waiting for the
  63.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  64.  * available elsewhere.
  65.  *
  66.  * Revision 1.6  2000/02/24 20:11:27  abagchi
  67.  * Swat for removing Log from API docs
  68.  *
  69.  * Revision 1.5  2000/02/17 17:47:24  andyh
  70.  * Update Doc++ API comments
  71.  * NameSpace update to track W3C
  72.  * Changes were made by Chih Hsiang Chou
  73.  *
  74.  * Revision 1.4  2000/02/10 23:35:11  andyh
  75.  * Update DOM_DOMImplementation::CreateDocumentType and
  76.  * DOM_DocumentType to match latest from W3C
  77.  *
  78.  * Revision 1.3  2000/02/06 07:47:29  rahulj
  79.  * Year 2K copyright swat.
  80.  *
  81.  * Revision 1.2  2000/01/05 01:16:07  andyh
  82.  * DOM Level 2 core, namespace support added.
  83.  *
  84.  * Revision 1.1.1.1  1999/11/09 01:08:52  twl
  85.  * Initial checkin
  86.  *
  87.  * Revision 1.3  1999/11/08 20:44:16  rahul
  88.  * Swat for adding in Product name and CVS comment log variable.
  89.  *
  90.  */
  91. #ifndef DOM_DocumentType_HEADER_GUARD_
  92. #define DOM_DocumentType_HEADER_GUARD_
  93. #include <util/XercesDefs.hpp>
  94. #include <dom/DOM_Node.hpp>
  95. class DOM_NamedNodeMap;
  96. class DocumentTypeImpl;
  97. /**
  98.  * Each <code>Document</code> has a <code>doctype</code> whose value 
  99.  * is either <code>null</code> or a <code>DocumentType</code> object. 
  100.  *
  101.  * The <code>DOM_DocumentType</code> class provides access
  102.  *  to the list of entities and notations that are defined for the document.
  103.  * <p>The DOM Level 1 doesn't support editing <code>DocumentType</code> nodes.
  104.  */
  105. class CDOM_EXPORT DOM_DocumentType: public DOM_Node {
  106. public:
  107.     /** @name Constructors and assignment operator */
  108.     //@{
  109.     /**
  110.       * Default constructor for DOM_DocumentType.  The resulting object does not
  111.       * refer to an actual DocumentType node; it will compare == to 0, and is similar
  112.       * to a null object reference variable in Java.  It may subsequently be
  113.       * assigned to refer to the actual DocumentType node.
  114.       * <p>
  115.       * A new DocumentType node for a document that does not already have one
  116.       * can be created by DOM_Document::createDocumentType().     
  117.       *
  118.       */
  119.     DOM_DocumentType();
  120.     /**
  121.       * Constructor for a null DOM_DocumentType.
  122.       * This allows passing 0 directly as a null DOM_DocumentType to
  123.       * function calls that take DOM_DocumentType as parameters.
  124.       *
  125.       * @param nullPointer Must be 0.
  126.       */
  127.     DOM_DocumentType(int nullPointer);
  128.     /**
  129.       * Copy constructor.  Creates a new <code>DOM_Comment</code> that refers to the
  130.       * same underlying node as the original.  
  131.       *
  132.       *
  133.       * @param other The object to be copied.
  134.       */
  135.     DOM_DocumentType(const DOM_DocumentType &other);
  136.     /**
  137.       * Assignment operator.
  138.       *
  139.       * @param other The object to be copied.
  140.       */
  141.     DOM_DocumentType & operator = (const DOM_DocumentType &other);
  142.     /**
  143.       * Assignment operator.  This overloaded variant is provided for
  144.       *   the sole purpose of setting a DOM_Node reference variable to
  145.       *   zero.  Nulling out a reference variable in this way will decrement
  146.       *   the reference count on the underlying Node object that the variable
  147.       *   formerly referenced.  This effect is normally obtained when reference
  148.       *   variable goes out of scope, but zeroing them can be useful for
  149.       *   global instances, or for local instances that will remain in scope
  150.       *   for an extended time,  when the storage belonging to the underlying
  151.       *   node needs to be reclaimed.
  152.       *
  153.       * @param val.  Only a value of 0, or null, is allowed.
  154.       */
  155.     DOM_DocumentType & operator = (const DOM_NullPtr *val);
  156.     //@}
  157.     /** @name Destructor. */
  158.     //@{
  159.  /**
  160.   * Destructor for DOM_DocumentType.  The object being destroyed is the reference
  161.       * object, not the underlying DocumentType node itself.
  162.   *
  163.   */
  164.     ~DOM_DocumentType();
  165.     //@}
  166.     /** @name Getter functions. */
  167.     //@{
  168.   /**
  169.    * The name of DTD; i.e., the name immediately following the 
  170.    * <code>DOCTYPE</code> keyword in an XML source document.
  171.    */
  172.   DOMString       getName() const;
  173.   /**
  174.    * This function returns a  <code>NamedNodeMap</code> containing the general entities, both 
  175.    * external and internal, declared in the DTD. Parameter entities are not contained.
  176.    * Duplicates are discarded. 
  177.    * <p>
  178.    * Note: this functionality is not implemented in the initial release
  179.    * of the parser, and the returned NamedNodeMap will be empty.
  180.    */
  181.   DOM_NamedNodeMap getEntities() const;
  182.   /**
  183.    * This function returns a named node map containing an entry for
  184.    * each notation declared in a document's DTD.  Duplicates are discarded.
  185.    *
  186.    * <p>
  187.    * Note: this functionality is not implemented in the initial release
  188.    * of the parser, and the returned NamedNodeMap will be empty.
  189.    */
  190.   DOM_NamedNodeMap getNotations() const;
  191.   //@}
  192.     /** @name Functions introduced in DOM Level 2. */
  193.     //@{
  194.     /**
  195.      * Get the public identifier of the external subset.
  196.      *
  197.      * <p><b>"Experimental - subject to change"</b></p>
  198.      *
  199.      * @return The public identifier of the external subset.
  200.      */
  201.     DOMString     getPublicId() const;
  202.     /**
  203.      * Get the system identifier of the external subset.
  204.      *
  205.      * <p><b>"Experimental - subject to change"</b></p>
  206.      *
  207.      * @return The system identifier of the external subset.
  208.      */
  209.     DOMString     getSystemId() const;
  210.     /**
  211.      * Get the internal subset as a string.
  212.      *
  213.      * <p><b>"Experimental - subject to change"</b></p>
  214.      *
  215.      * @return The internal subset as a string.
  216.      */
  217.     DOMString     getInternalSubset() const;
  218.     //@}
  219. protected:
  220.     DOM_DocumentType(DocumentTypeImpl *);
  221.     friend class DOM_Document;
  222.     friend class DOM_DOMImplementation;
  223. };
  224. #endif