1 | // |
---|
2 | // DOMParser.h |
---|
3 | // |
---|
4 | // $Id: //poco/1.3/XML/include/Poco/DOM/DOMParser.h#2 $ |
---|
5 | // |
---|
6 | // Library: XML |
---|
7 | // Package: DOM |
---|
8 | // Module: DOMParser |
---|
9 | // |
---|
10 | // Definition of the DOMParser class. |
---|
11 | // |
---|
12 | // Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. |
---|
13 | // and Contributors. |
---|
14 | // |
---|
15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
20 | // do so, all subject to the following: |
---|
21 | // |
---|
22 | // The copyright notices in the Software and this entire statement, including |
---|
23 | // the above license grant, this restriction and the following disclaimer, |
---|
24 | // must be included in all copies of the Software, in whole or in part, and |
---|
25 | // all derivative works of the Software, unless such copies or derivative |
---|
26 | // works are solely in the form of machine-executable object code generated by |
---|
27 | // a source language processor. |
---|
28 | // |
---|
29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
35 | // DEALINGS IN THE SOFTWARE. |
---|
36 | // |
---|
37 | |
---|
38 | |
---|
39 | #ifndef DOM_DOMParser_INCLUDED |
---|
40 | #define DOM_DOMParser_INCLUDED |
---|
41 | |
---|
42 | |
---|
43 | #include "Poco/XML/XML.h" |
---|
44 | #include "Poco/SAX/SAXParser.h" |
---|
45 | |
---|
46 | |
---|
47 | namespace Poco { |
---|
48 | namespace XML { |
---|
49 | |
---|
50 | |
---|
51 | class NamePool; |
---|
52 | class Document; |
---|
53 | class InputSource; |
---|
54 | class EntityResolver; |
---|
55 | |
---|
56 | |
---|
57 | class XML_API DOMParser |
---|
58 | /// This is a convenience class that combines a |
---|
59 | /// DOMBuilder with a SAXParser, with the optional |
---|
60 | /// support of a WhitespaceFilter. |
---|
61 | { |
---|
62 | public: |
---|
63 | DOMParser(NamePool* pNamePool = 0); |
---|
64 | /// Creates a new DOMParser. |
---|
65 | /// If a NamePool is given, it becomes the Document's NamePool. |
---|
66 | |
---|
67 | ~DOMParser(); |
---|
68 | /// Destroys the DOMParser. |
---|
69 | |
---|
70 | void setEncoding(const XMLString& encoding); |
---|
71 | /// Sets the encoding used by the parser if no |
---|
72 | /// encoding is specified in the XML document. |
---|
73 | |
---|
74 | const XMLString& getEncoding() const; |
---|
75 | /// Returns the name of the encoding used by |
---|
76 | /// the parser if no encoding is specified in |
---|
77 | /// the XML document. |
---|
78 | |
---|
79 | void addEncoding(const XMLString& name, Poco::TextEncoding* pEncoding); |
---|
80 | /// Adds an encoding to the parser. |
---|
81 | |
---|
82 | void setFeature(const XMLString& name, bool state); |
---|
83 | /// Set the state of a feature. |
---|
84 | /// |
---|
85 | /// If a feature is not recognized by the DOMParser, it is |
---|
86 | /// passed on to the underlying XMLReader. |
---|
87 | /// |
---|
88 | /// The only currently supported feature is |
---|
89 | /// http://www.appinf.com/features/no-whitespace-in-element-content |
---|
90 | /// which, when activated, causes the WhitespaceFilter to |
---|
91 | /// be used. |
---|
92 | |
---|
93 | bool getFeature(const XMLString& name) const; |
---|
94 | /// Look up the value of a feature. |
---|
95 | /// |
---|
96 | /// If a feature is not recognized by the DOMParser, the |
---|
97 | /// DOMParser queries the underlying SAXParser for the feature. |
---|
98 | |
---|
99 | Document* parse(const XMLString& uri); |
---|
100 | /// Parse an XML document from a location identified by an URI. |
---|
101 | |
---|
102 | Document* parse(InputSource* pInputSource); |
---|
103 | /// Parse an XML document from a location identified by an InputSource. |
---|
104 | |
---|
105 | Document* parseString(const std::string& xml); |
---|
106 | /// Parse an XML document from a string. |
---|
107 | |
---|
108 | Document* parseMemory(const char* xml, std::size_t size); |
---|
109 | /// Parse an XML document from memory. |
---|
110 | |
---|
111 | EntityResolver* getEntityResolver() const; |
---|
112 | /// Returns the entity resolver used by the underlying SAXParser. |
---|
113 | |
---|
114 | void setEntityResolver(EntityResolver* pEntityResolver); |
---|
115 | /// Sets the entity resolver on the underlying SAXParser. |
---|
116 | |
---|
117 | static const XMLString FEATURE_WHITESPACE; |
---|
118 | |
---|
119 | private: |
---|
120 | SAXParser _saxParser; |
---|
121 | NamePool* _pNamePool; |
---|
122 | bool _whitespace; |
---|
123 | }; |
---|
124 | |
---|
125 | |
---|
126 | } } // namespace Poco::XML |
---|
127 | |
---|
128 | |
---|
129 | #endif // DOM_DOMParser_INCLUDED |
---|