1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
/* ------------------------------------------------------------------------
* $Id: DocumentHandler.hh,v 1.1 2001/08/16 11:32:21 elm Exp $
*
* This file is part of 3Dwm: The Three-Dimensional User Environment.
*
* 3Dwm: The Three-Dimensional User Environment:
* <http://www.3dwm.org>
*
* Chalmers Medialab
* <http://www.medialab.chalmers.se>
*
* This C++ SAX implementation (Simple API for XML) is derived from
* David Megginson's original Java SAX that can be found on
* http://www.megginson.com/SAX/.
* ------------------------------------------------------------------------
* File created 2001-08-13 by Niklas Elmqvist.
*
* Copyright (c) 2001 Niklas Elmqvist <elm@3dwm.org>.
* ------------------------------------------------------------------------
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
* ------------------------------------------------------------------------
*/
#ifndef _SAXDocumentHandler_hh_
#define _SAXDocumentHandler_hh_
// -- System Includes
#include <string>
// -- Local Includes
//#include "Celsius/SAX/AttributeList.hh"
namespace SAX {
// -- Forward Declarations
class Locator;
class AttributeList;
// -- Class Declarations
/**
* Receive notification of general document events.
**/
class DocumentHandler {
public:
/**
* Constructor.
**/
DocumentHandler() { }
/**
* Destructor.
**/
virtual ~DocumentHandler() { }
/**
* Receive an object for locating the origin of SAX document
* events.
*
* @param object that can return the location of any SAX
* document event.
**/
virtual void setDocumentLocator(const Locator &locator) = 0;
/**
* Receive notification of the beginning of a document. The
* SAX parser will invoke this method only once, before any
* other methods in this interface or in DTDHandler (except
* for setDocumentLocator).
**/
virtual void startDocument() = 0;
/**
* Receive notification of the end of a document. The SAX
* parser will invoke this method only once, and it will be
* the last method invoked during the parse. The parser shall
* not invoke this method until it has either abandoned
* parsing (because of an unrecoverable error) or reached the
* end of input.
**/
virtual void endDocument() = 0;
/**
* Receive notification of the beginning of an element. The
* parser will invoke this method at the beginning of every
* element in the XML document; there will be a corresponding
* endElement() event for every startElement() event (even
* when the element is empty). All of the element's content
* will be reported, in order, before the corresponding
* endElement() event.
*
* @param name element type name.
* @param atts attributes attached to the element, if any.
**/
virtual void startElement(const std::string &name,
const AttributeList &atts) = 0;
/**
* Receive notification of the end of an element. The SAX
* parser will invoke this method at the end of every element
* in the XML document; there will be a corresponding
* startElement() event for every endElement() event (even
* when the element is empty).
*
* @param name element type name.
**/
virtual void endElement(const std::string &name) = 0;
/**
* Receive notification of character data. The parser will
* call this method to report each chunk of character
* data. SAX parsers may return all contiguous character data
* in a single chunk, or they may split it into several
* chunks; however, all of the characters in any single event
* must come from the same external entity, so that the
* Locator provides useful information. Note that some parsers
* will report whitespace using the ignorableWhitespace()
* method rather than this one (validating parsers must do
* so).
*
* @param ch characters from the XML document.
**/
virtual void characters(const std::string &ch) = 0;
/**
* Receive notification of ignorable whitespace in element
* content. Validating parsers must use this method to report
* each chunk of ignorable whitespace (see the W3C XML 1.0
* recommendation, section 2.10): non-validating parsers may
* also use this method if they are capable of parsing and
* using content models.
*
* @param ch characters from the XML document.
**/
virtual void ignorableWhitespace(const std::string &ch) = 0;
/**
* Receive notification of a processing instruction. The
* parser will invoke this method once for each processing
* instruction found: note that processing instructions may
* occur before or after the main document element.
*
* @param target processing instruction target.
* @param data processing instruction data, or null if
* none was supplied.
**/
virtual void processingInstruction(const std::string &target,
const std::string &data) = 0;
};
};
#endif /* DocumentHandler.hh */
|
