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
|
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
|
-
+
+
-
+
+
-
+
-
+
-
+
-
+
-
+
+
+
|
#else
@protocol OFXMLParserDelegate
#endif
#ifdef OF_HAVE_OPTIONAL_PROTOCOLS
@optional
#endif
/**
* This callback is called when the XML parser found processing instructions.
* \brief This callback is called when the XML parser found processing
* instructions.
*
* \param parser The parser which found processing instructions
* \param pi The processing instructions
*/
- (void)parser: (OFXMLParser*)parser
foundProcessingInstructions: (OFString*)pi;
/**
* This callback is called when the XML parser found the start of a new tag.
* \brief This callback is called when the XML parser found the start of a new
* tag.
*
* \param parser The parser which found a new tag
* \param name The name of the tag which just started
* \param prefix The prefix of the tag which just started or nil
* \param ns The namespace of the tag which just started or nil
* \param attributes The attributes included in the tag which just started or
* nil
*/
- (void)parser: (OFXMLParser*)parser
didStartElement: (OFString*)name
withPrefix: (OFString*)prefix
namespace: (OFString*)ns
attributes: (OFArray*)attributes;
/**
* This callback is called when the XML parser found the end of a tag.
* \brief This callback is called when the XML parser found the end of a tag.
*
* \param parser The parser which found the end of a tag
* \param name The name of the tag which just ended
* \param prefix The prefix of the tag which just ended or nil
* \param ns The namespace of the tag which just ended or nil
*/
- (void)parser: (OFXMLParser*)parser
didEndElement: (OFString*)name
withPrefix: (OFString*)prefix
namespace: (OFString*)ns;
/**
* This callback is called when the XML parser found characters.
* \brief This callback is called when the XML parser found characters.
*
* In case there are comments or CDATA, it is possible that this callback is
* called multiple times in a row.
*
* \param parser The parser which found a string
* \param characters The characters the XML parser found
*/
- (void)parser: (OFXMLParser*)parser
foundCharacters: (OFString*)characters;
/**
* This callback is called when the XML parser found CDATA.
* \brief This callback is called when the XML parser found CDATA.
*
* \param parser The parser which found a string
* \param CDATA The CDATA the XML parser found
*/
- (void)parser: (OFXMLParser*)parser
foundCDATA: (OFString*)CDATA;
/**
* This callback is called when the XML parser found a comment.
* \brief This callback is called when the XML parser found a comment.
*
* \param parser The parser which found a comment
* \param comment The comment the XML parser found
*/
- (void)parser: (OFXMLParser*)parser
foundComment: (OFString*)comment;
/**
* This callback is called when the XML parser found an entity it doesn't know.
* \brief This callback is called when the XML parser found an entity it
* doesn't know.
*
* The callback is supposed to return a substitution for the entity or nil if
* it is not known to the callback as well, in which case an exception will be
* risen.
*
* \param parser The parser which found an unknown entity
* \param entity The name of the entity the XML parser didn't know
* \return A substitution for the entity or nil
|
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
+
+
+
+
-
+
-
+
-
+
-
+
-
+
+
+
+
+
|
}
#ifdef OF_HAVE_PROPERTIES
@property (retain) id <OFXMLParserDelegate> delegate;
#endif
/**
* \brief Creates a new XML parser.
*
* \return A new, autoreleased OFXMLParser
*/
+ parser;
/**
* \brief Returns the delegate that is used by the XML parser.
*
* \return The delegate that is used by the XML parser
*/
- (id <OFXMLParserDelegate>)delegate;
/**
* Sets the delegate the OFXMLParser should use.
* \brief Sets the delegate the OFXMLParser should use.
*
* \param delegate The delegate to use
*/
- (void)setDelegate: (id <OFXMLParserDelegate>)delegate;
/**
* Parses a buffer with the specified size.
* \brief Parses the specified buffer with the specified size.
*
* \param buffer The buffer to parse
* \param length The length of the buffer
*/
- (void)parseBuffer: (const char*)buffer
withLength: (size_t)length;
/**
* Parses the specified string.
* \brief Parses the specified string.
*
* \param string The string to parse
*/
- (void)parseString: (OFString*)string;
/**
* Parses the specified stream.
* \brief Parses the specified stream.
*
* \param stream The stream to parse
*/
- (void)parseStream: (OFStream*)stream;
/**
* Parses the specified file.
* \brief Parses the specified file.
*
* \param path The path to the file to parse
*/
- (void)parseFile: (OFString*)path;
/**
* \brief Returns the current line number.
*
* \return The current line number
*/
- (size_t)lineNumber;
/**
* \brief Returns whether the XML parser has finished parsing.
*
* \return Whether the XML parser has finished parsing
*/
- (BOOL)finishedParsing;
@end
@interface OFObject (OFXMLParserDelegate) <OFXMLParserDelegate>
@end
|