1 | // |
---|
2 | // SAXParser.h |
---|
3 | // |
---|
4 | // $Id: //poco/1.3/XML/include/Poco/SAX/SAXParser.h#3 $ |
---|
5 | // |
---|
6 | // Library: XML |
---|
7 | // Package: SAX |
---|
8 | // Module: SAX |
---|
9 | // |
---|
10 | // Implementation of the XMLReader interface. |
---|
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 SAX_SAXParser_INCLUDED |
---|
40 | #define SAX_SAXParser_INCLUDED |
---|
41 | |
---|
42 | |
---|
43 | #include "Poco/XML/XML.h" |
---|
44 | #include "Poco/SAX/XMLReader.h" |
---|
45 | #include "Poco/XML/ParserEngine.h" |
---|
46 | |
---|
47 | |
---|
48 | namespace Poco { |
---|
49 | namespace XML { |
---|
50 | |
---|
51 | |
---|
52 | class XML_API SAXParser: public XMLReader |
---|
53 | /// This class provides a SAX2 (Simple API for XML) interface to expat, |
---|
54 | /// the XML parser toolkit. |
---|
55 | /// The following SAX2 features and properties are supported: |
---|
56 | /// * http://xml.org/sax/features/external-general-entities |
---|
57 | /// * http://xml.org/sax/features/external-parameter-entities |
---|
58 | /// * http://xml.org/sax/features/namespaces |
---|
59 | /// * http://xml.org/sax/features/namespace-prefixes |
---|
60 | /// * http://xml.org/sax/properties/lexical-handler |
---|
61 | /// * http://xml.org/sax/properties/declaration-handler |
---|
62 | /// |
---|
63 | /// The following proprietary extensions are supported: |
---|
64 | /// * http://www.appinf.com/features/enable-partial-reads -- |
---|
65 | /// see ParserEngine::setEnablePartialReads() |
---|
66 | { |
---|
67 | public: |
---|
68 | SAXParser(); |
---|
69 | /// Creates an SAXParser. |
---|
70 | |
---|
71 | SAXParser(const XMLString& encoding); |
---|
72 | /// Creates an SAXParser with the given encoding. |
---|
73 | |
---|
74 | ~SAXParser(); |
---|
75 | /// Destroys the SAXParser. |
---|
76 | |
---|
77 | void setEncoding(const XMLString& encoding); |
---|
78 | /// Sets the encoding used by the parser if no |
---|
79 | /// encoding is specified in the XML document. |
---|
80 | |
---|
81 | const XMLString& getEncoding() const; |
---|
82 | /// Returns the name of the encoding used by |
---|
83 | /// the parser if no encoding is specified in |
---|
84 | /// the XML document. |
---|
85 | |
---|
86 | void addEncoding(const XMLString& name, Poco::TextEncoding* pEncoding); |
---|
87 | /// Adds an encoding to the parser. Does not take ownership of the pointer! |
---|
88 | |
---|
89 | /// XMLReader |
---|
90 | void setEntityResolver(EntityResolver* pResolver); |
---|
91 | EntityResolver* getEntityResolver() const; |
---|
92 | void setDTDHandler(DTDHandler* pDTDHandler); |
---|
93 | DTDHandler* getDTDHandler() const; |
---|
94 | void setContentHandler(ContentHandler* pContentHandler); |
---|
95 | ContentHandler* getContentHandler() const; |
---|
96 | void setErrorHandler(ErrorHandler* pErrorHandler); |
---|
97 | ErrorHandler* getErrorHandler() const; |
---|
98 | void setFeature(const XMLString& featureId, bool state); |
---|
99 | bool getFeature(const XMLString& featureId) const; |
---|
100 | void setProperty(const XMLString& propertyId, const XMLString& value); |
---|
101 | void setProperty(const XMLString& propertyId, void* value); |
---|
102 | void* getProperty(const XMLString& propertyId) const; |
---|
103 | void parse(InputSource* pSource); |
---|
104 | void parse(const XMLString& systemId); |
---|
105 | void parseMemoryNP(const char* xml, std::size_t size); |
---|
106 | |
---|
107 | /// Extensions |
---|
108 | void parseString(const std::string& xml); |
---|
109 | |
---|
110 | static const XMLString FEATURE_PARTIAL_READS; |
---|
111 | |
---|
112 | protected: |
---|
113 | void setupParse(); |
---|
114 | |
---|
115 | private: |
---|
116 | ParserEngine _engine; |
---|
117 | bool _namespaces; |
---|
118 | bool _namespacePrefixes; |
---|
119 | }; |
---|
120 | |
---|
121 | |
---|
122 | } } // namespace Poco::XML |
---|
123 | |
---|
124 | |
---|
125 | #endif // SAX_SAXParser_INCLUDED |
---|