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