blob: 7c04a0e97d66d5d2cc500a71806adcb288b997fe [file] [log] [blame]
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001/*
2 * xmlreader.c: implements the xmlTextReader streaming node API
3 *
Daniel Veillard67df8092002-12-16 22:04:11 +00004 * NOTE:
5 * XmlTextReader.Normalization Property won't be supported, since
6 * it makes the parser non compliant to the XML recommendation
7 *
Daniel Veillarde1ca5032002-12-09 14:13:43 +00008 * See Copyright for the status of this software.
9 *
10 * daniel@veillard.com
11 */
12
13#define IN_LIBXML
14#include "libxml.h"
15
16#include <string.h> /* for memset() only ! */
17
18#ifdef HAVE_CTYPE_H
19#include <ctype.h>
20#endif
21#ifdef HAVE_STDLIB_H
22#include <stdlib.h>
23#endif
24
25#include <libxml/xmlmemory.h>
26#include <libxml/xmlIO.h>
27#include <libxml/xmlreader.h>
28
29/* #define DEBUG_CALLBACKS */
30/* #define DEBUG_READER */
31
32/**
33 * TODO:
34 *
35 * macro to flag unimplemented blocks
36 */
37#define TODO \
38 xmlGenericError(xmlGenericErrorContext, \
39 "Unimplemented block at %s:%d\n", \
40 __FILE__, __LINE__);
41
42#ifdef DEBUG_READER
43#define DUMP_READER xmlTextReaderDebug(reader);
44#else
45#define DUMP_READER
46#endif
47
48/************************************************************************
49 * *
50 * The parser: maps the Text Reader API on top of the existing *
51 * parsing routines building a tree *
52 * *
53 ************************************************************************/
54
55#define XML_TEXTREADER_INPUT 1
56#define XML_TEXTREADER_CTXT 2
57
58typedef enum {
Daniel Veillard67df8092002-12-16 22:04:11 +000059 XML_TEXTREADER_MODE_INITIAL = 0,
60 XML_TEXTREADER_MODE_INTERACTIVE = 1,
61 XML_TEXTREADER_MODE_ERROR = 2,
62 XML_TEXTREADER_MODE_EOF =3,
63 XML_TEXTREADER_MODE_CLOSED = 4,
64 XML_TEXTREADER_MODE_READING = 5
Daniel Veillarde1ca5032002-12-09 14:13:43 +000065} xmlTextReaderMode;
66
67typedef enum {
68 XML_TEXTREADER_NONE = -1,
69 XML_TEXTREADER_START= 0,
70 XML_TEXTREADER_ELEMENT= 1,
71 XML_TEXTREADER_END= 2,
72 XML_TEXTREADER_EMPTY= 3,
Daniel Veillardea7751d2002-12-20 00:16:24 +000073 XML_TEXTREADER_BACKTRACK= 4,
74 XML_TEXTREADER_DONE= 5
Daniel Veillarde1ca5032002-12-09 14:13:43 +000075} xmlTextReaderState;
76
77struct _xmlTextReader {
78 int mode; /* the parsing mode */
79 int allocs; /* what structure were deallocated */
80 xmlTextReaderState state;
81 xmlParserCtxtPtr ctxt; /* the parser context */
82 xmlSAXHandlerPtr sax; /* the parser SAX callbacks */
83 xmlParserInputBufferPtr input; /* the input */
84 startElementSAXFunc startElement;/* initial SAX callbacks */
85 endElementSAXFunc endElement; /* idem */
Daniel Veillardea7751d2002-12-20 00:16:24 +000086 charactersSAXFunc characters;
87 cdataBlockSAXFunc cdataBlock;
Daniel Veillarde1ca5032002-12-09 14:13:43 +000088 unsigned int base; /* base of the segment in the input */
89 unsigned int cur; /* current position in the input */
90 xmlNodePtr node; /* current node */
Daniel Veillardda46d2d2002-12-15 23:36:49 +000091 xmlNodePtr curnode;/* current attribute node */
Daniel Veillarde1ca5032002-12-09 14:13:43 +000092 int depth; /* depth of the current node */
Daniel Veillardbeb70bd2002-12-18 14:53:54 +000093 xmlNodePtr faketext;/* fake xmlNs chld */
Daniel Veillarddf512f42002-12-23 15:56:21 +000094 int wasempty;/* was the last node empty */
Daniel Veillarde1ca5032002-12-09 14:13:43 +000095};
96
97#ifdef DEBUG_READER
98static void
99xmlTextReaderDebug(xmlTextReaderPtr reader) {
100 if ((reader == NULL) || (reader->ctxt == NULL)) {
101 fprintf(stderr, "xmlTextReader NULL\n");
102 return;
103 }
104 fprintf(stderr, "xmlTextReader: state %d depth %d ",
105 reader->state, reader->depth);
106 if (reader->node == NULL) {
107 fprintf(stderr, "node = NULL\n");
108 } else {
109 fprintf(stderr, "node %s\n", reader->node->name);
110 }
111 fprintf(stderr, " input: base %d, cur %d, depth %d: ",
112 reader->base, reader->cur, reader->ctxt->nodeNr);
113 if (reader->input->buffer == NULL) {
114 fprintf(stderr, "buffer is NULL\n");
115 } else {
116#ifdef LIBXML_DEBUG_ENABLED
117 xmlDebugDumpString(stderr,
118 &reader->input->buffer->content[reader->cur]);
119#endif
120 fprintf(stderr, "\n");
121 }
122}
123#endif
124
125/**
126 * xmlTextReaderStartElement:
127 * @ctx: the user data (XML parser context)
128 * @fullname: The element name, including namespace prefix
129 * @atts: An array of name/value attributes pairs, NULL terminated
130 *
131 * called when an opening tag has been processed.
132 */
133static void
134xmlTextReaderStartElement(void *ctx, const xmlChar *fullname,
135 const xmlChar **atts) {
136 xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr) ctx;
Daniel Veillardd5896142002-12-31 14:45:26 +0000137 xmlParserCtxtPtr origctxt;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000138 xmlTextReaderPtr reader = ctxt->_private;
139
140#ifdef DEBUG_CALLBACKS
141 printf("xmlTextReaderStartElement(%s)\n", fullname);
142#endif
Daniel Veillardea7751d2002-12-20 00:16:24 +0000143 if ((reader != NULL) && (reader->startElement != NULL)) {
Daniel Veillardd5896142002-12-31 14:45:26 +0000144 /*
145 * when processing an entity, the context may have been changed
146 */
147 origctxt = reader->ctxt;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000148 reader->startElement(ctx, fullname, atts);
Daniel Veillardd5896142002-12-31 14:45:26 +0000149 if (origctxt->validate) {
150 ctxt->valid &= xmlValidatePushElement(&origctxt->vctxt,
151 ctxt->myDoc, ctxt->node, fullname);
Daniel Veillardea7751d2002-12-20 00:16:24 +0000152 }
153 }
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000154 reader->state = XML_TEXTREADER_ELEMENT;
155}
156
157/**
158 * xmlTextReaderEndElement:
159 * @ctx: the user data (XML parser context)
160 * @fullname: The element name, including namespace prefix
161 *
162 * called when an ending tag has been processed.
163 */
164static void
165xmlTextReaderEndElement(void *ctx, const xmlChar *fullname) {
166 xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr) ctx;
Daniel Veillardd5896142002-12-31 14:45:26 +0000167 xmlParserCtxtPtr origctxt;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000168 xmlTextReaderPtr reader = ctxt->_private;
169
170#ifdef DEBUG_CALLBACKS
171 printf("xmlTextReaderEndElement(%s)\n", fullname);
172#endif
Daniel Veillardea7751d2002-12-20 00:16:24 +0000173 if ((reader != NULL) && (reader->endElement != NULL)) {
174 xmlNodePtr node = ctxt->node;
Daniel Veillardd5896142002-12-31 14:45:26 +0000175 /*
176 * when processing an entity, the context may have been changed
177 */
178 origctxt = reader->ctxt;
Daniel Veillardea7751d2002-12-20 00:16:24 +0000179
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000180 reader->endElement(ctx, fullname);
Daniel Veillardea7751d2002-12-20 00:16:24 +0000181
Daniel Veillardd5896142002-12-31 14:45:26 +0000182 if (origctxt->validate) {
183 ctxt->valid &= xmlValidatePopElement(&origctxt->vctxt,
184 ctxt->myDoc, node, fullname);
Daniel Veillardea7751d2002-12-20 00:16:24 +0000185 }
186 }
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000187 if (reader->state == XML_TEXTREADER_ELEMENT)
Daniel Veillarddf512f42002-12-23 15:56:21 +0000188 reader->wasempty = 1;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000189 else
Daniel Veillarddf512f42002-12-23 15:56:21 +0000190 reader->wasempty = 0;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000191}
192
193/**
Daniel Veillardea7751d2002-12-20 00:16:24 +0000194 * xmlTextReaderCharacters:
195 * @ctx: the user data (XML parser context)
196 * @ch: a xmlChar string
197 * @len: the number of xmlChar
198 *
199 * receiving some chars from the parser.
200 */
201static void
202xmlTextReaderCharacters(void *ctx, const xmlChar *ch, int len)
203{
204 xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr) ctx;
Daniel Veillardd5896142002-12-31 14:45:26 +0000205 xmlParserCtxtPtr origctxt;
Daniel Veillardea7751d2002-12-20 00:16:24 +0000206 xmlTextReaderPtr reader = ctxt->_private;
207
208#ifdef DEBUG_CALLBACKS
209 printf("xmlTextReaderCharacters()\n");
210#endif
211 if ((reader != NULL) && (reader->characters != NULL)) {
212 reader->characters(ctx, ch, len);
Daniel Veillardd5896142002-12-31 14:45:26 +0000213 /*
214 * when processing an entity, the context may have been changed
215 */
216 origctxt = reader->ctxt;
Daniel Veillardea7751d2002-12-20 00:16:24 +0000217
Daniel Veillardd5896142002-12-31 14:45:26 +0000218 if (origctxt->validate) {
219 ctxt->valid &= xmlValidatePushCData(&origctxt->vctxt, ch, len);
Daniel Veillardea7751d2002-12-20 00:16:24 +0000220 }
221 }
222}
223
224/**
225 * xmlTextReaderCDataBlock:
226 * @ctx: the user data (XML parser context)
227 * @value: The pcdata content
228 * @len: the block length
229 *
230 * called when a pcdata block has been parsed
231 */
232static void
233xmlTextReaderCDataBlock(void *ctx, const xmlChar *ch, int len)
234{
235 xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr) ctx;
236 xmlTextReaderPtr reader = ctxt->_private;
237
238#ifdef DEBUG_CALLBACKS
239 printf("xmlTextReaderCDataBlock()\n");
240#endif
241 if ((reader != NULL) && (reader->cdataBlock != NULL)) {
242 reader->cdataBlock(ctx, ch, len);
243
244 if (ctxt->validate) {
245 ctxt->valid &= xmlValidatePushCData(&ctxt->vctxt, ch, len);
246 }
247 }
248}
249
250/**
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000251 * xmlTextReaderPushData:
252 * @reader: the xmlTextReaderPtr used
253 *
254 * Push data down the progressive parser until a significant callback
255 * got raised.
256 *
257 * Returns -1 in case of failure, 0 otherwise
258 */
259static int
260xmlTextReaderPushData(xmlTextReaderPtr reader) {
261 unsigned int cur = reader->cur;
262 xmlBufferPtr inbuf;
263 int val;
Daniel Veillardea7751d2002-12-20 00:16:24 +0000264 int oldstate;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000265
266 if ((reader->input == NULL) || (reader->input->buffer == NULL))
267 return(-1);
268
Daniel Veillardea7751d2002-12-20 00:16:24 +0000269 oldstate = reader->state;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000270 reader->state = XML_TEXTREADER_NONE;
271 inbuf = reader->input->buffer;
272 while (reader->state == XML_TEXTREADER_NONE) {
273 if (cur >= inbuf->use) {
274 /*
275 * Refill the buffer unless we are at the end of the stream
276 */
277 if (reader->mode != XML_TEXTREADER_MODE_EOF) {
278 val = xmlParserInputBufferRead(reader->input, 4096);
279 if (val <= 0) {
280 reader->mode = XML_TEXTREADER_MODE_EOF;
Daniel Veillardea7751d2002-12-20 00:16:24 +0000281 reader->state = oldstate;
Daniel Veillardaaa105b2002-12-30 11:42:17 +0000282 if ((oldstate != XML_TEXTREADER_START) ||
283 (reader->ctxt->myDoc != NULL))
284 return(val);
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000285 }
286 } else
287 break;
288 }
289 if ((inbuf->content[cur] == '>') || (inbuf->content[cur] == '&')) {
290 cur = cur + 1;
291 val = xmlParseChunk(reader->ctxt,
292 (const char *) &inbuf->content[reader->cur],
293 cur - reader->cur, 0);
294 if (val != 0)
295 return(-1);
296 reader->cur = cur;
297 break;
298 } else {
299 cur = cur + 1;
300
301 /*
302 * One may have to force a flush at some point when parsing really
303 * large CDATA sections
304 */
305 if ((cur - reader->cur > 4096) && (reader->base == 0) &&
Daniel Veillard67df8092002-12-16 22:04:11 +0000306 (reader->mode == XML_TEXTREADER_MODE_INTERACTIVE)) {
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000307 cur = cur + 1;
308 val = xmlParseChunk(reader->ctxt,
309 (const char *) &inbuf->content[reader->cur],
310 cur - reader->cur, 0);
311 if (val != 0)
312 return(-1);
313 reader->cur = cur;
314 }
315 }
316 }
317 /*
318 * Discard the consumed input when needed and possible
319 */
Daniel Veillard67df8092002-12-16 22:04:11 +0000320 if (reader->mode == XML_TEXTREADER_MODE_INTERACTIVE) {
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000321 if ((reader->cur >= 4096) && (reader->base == 0)) {
322 val = xmlBufferShrink(inbuf, cur);
323 if (val >= 0) {
324 reader->cur -= val;
325 }
326 }
327 }
328
329 /*
330 * At the end of the stream signal that the work is done to the Push
331 * parser.
332 */
Daniel Veillardea7751d2002-12-20 00:16:24 +0000333 if (reader->mode == XML_TEXTREADER_MODE_EOF) {
334 if (reader->mode != XML_TEXTREADER_DONE) {
335 val = xmlParseChunk(reader->ctxt,
336 (const char *) &inbuf->content[reader->cur], 0, 1);
337 reader->mode = XML_TEXTREADER_DONE;
338 }
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000339 }
Daniel Veillardea7751d2002-12-20 00:16:24 +0000340 reader->state = oldstate;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000341 return(0);
342}
343
344/**
345 * xmlTextReaderRead:
346 * @reader: the xmlTextReaderPtr used
347 *
348 * Moves the position of the current instance to the next node in
349 * the stream, exposing its properties.
350 *
351 * Returns 1 if the node was read successfully, 0 if there is no more
352 * nodes to read, or -1 in case of error
353 */
354int
355xmlTextReaderRead(xmlTextReaderPtr reader) {
Daniel Veillarddf512f42002-12-23 15:56:21 +0000356 int val, olddepth, wasempty;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000357 xmlTextReaderState oldstate;
358 xmlNodePtr oldnode;
359
360 if ((reader == NULL) || (reader->ctxt == NULL))
361 return(-1);
362 if (reader->ctxt->wellFormed != 1)
363 return(-1);
364
365#ifdef DEBUG_READER
366 fprintf(stderr, "\nREAD ");
367 DUMP_READER
368#endif
Daniel Veillard29b3e282002-12-29 11:14:41 +0000369 reader->curnode = NULL;
Daniel Veillard67df8092002-12-16 22:04:11 +0000370 if (reader->mode == XML_TEXTREADER_MODE_INITIAL) {
371 reader->mode = XML_TEXTREADER_MODE_INTERACTIVE;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000372 /*
373 * Initial state
374 */
375 do {
376 val = xmlTextReaderPushData(reader);
377 if (val < 0)
378 return(-1);
379 } while ((reader->ctxt->node == NULL) &&
380 (reader->mode != XML_TEXTREADER_MODE_EOF));
381 if (reader->ctxt->node == NULL) {
382 if (reader->ctxt->myDoc != NULL)
383 reader->node = reader->ctxt->myDoc->children;
384 if (reader->node == NULL)
385 return(-1);
386 } else {
Daniel Veillard4d8db8a2002-12-30 18:40:42 +0000387 reader->node = reader->ctxt->nodeTab[0];
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000388 }
Daniel Veillard4d8db8a2002-12-30 18:40:42 +0000389 reader->depth = 0;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000390 return(1);
391 }
392 oldstate = reader->state;
393 olddepth = reader->ctxt->nodeNr;
394 oldnode = reader->node;
Daniel Veillarddf512f42002-12-23 15:56:21 +0000395 wasempty = ((reader->wasempty == 1) && (reader->ctxt->node != NULL) &&
396 (reader->ctxt->node->last == reader->node));
397
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000398 /*
399 * If we are not backtracking on ancestors or examined nodes,
400 * that the parser didn't finished or that we arent at the end
401 * of stream, continue processing.
402 */
Daniel Veillardea7751d2002-12-20 00:16:24 +0000403 while (((oldstate == XML_TEXTREADER_BACKTRACK) ||
404 (reader->node->children == NULL) ||
405 (reader->node->type == XML_ENTITY_REF_NODE) ||
406 (reader->node->type == XML_DTD_NODE)) &&
407 (reader->node->next == NULL) &&
408 (reader->ctxt->nodeNr == olddepth) &&
409 (reader->ctxt->instate != XML_PARSER_EOF)) {
410 val = xmlTextReaderPushData(reader);
411 if (val < 0)
412 return(-1);
413 if (reader->node == NULL)
414 return(0);
415 }
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000416 if (oldstate != XML_TEXTREADER_BACKTRACK) {
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000417 if ((reader->node->children != NULL) &&
418 (reader->node->type != XML_ENTITY_REF_NODE) &&
419 (reader->node->type != XML_DTD_NODE)) {
420 reader->node = reader->node->children;
421 reader->depth++;
Daniel Veillarddf512f42002-12-23 15:56:21 +0000422 reader->state = XML_TEXTREADER_ELEMENT;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000423 DUMP_READER
424 return(1);
425 }
426 }
427 if (reader->node->next != NULL) {
428 if ((oldstate == XML_TEXTREADER_ELEMENT) &&
Daniel Veillarddf512f42002-12-23 15:56:21 +0000429 (reader->node->type == XML_ELEMENT_NODE) &&
430 (wasempty == 0)) {
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000431 reader->state = XML_TEXTREADER_END;
432 DUMP_READER
433 return(1);
434 }
435 reader->node = reader->node->next;
436 reader->state = XML_TEXTREADER_ELEMENT;
437 DUMP_READER
438 /*
439 * Cleanup of the old node
440 */
441 if (oldnode->type != XML_DTD_NODE) {
442 xmlUnlinkNode(oldnode);
443 xmlFreeNode(oldnode);
444 }
445
446 return(1);
447 }
Daniel Veillardea7751d2002-12-20 00:16:24 +0000448 if ((oldstate == XML_TEXTREADER_ELEMENT) &&
Daniel Veillard571b8892002-12-30 12:37:59 +0000449 (reader->node->type == XML_ELEMENT_NODE) &&
450 (wasempty == 0)) {
Daniel Veillardea7751d2002-12-20 00:16:24 +0000451 reader->state = XML_TEXTREADER_END;
452 DUMP_READER
453 return(1);
454 }
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000455 reader->node = reader->node->parent;
456 if ((reader->node == NULL) ||
457 (reader->node->type == XML_DOCUMENT_NODE) ||
458#ifdef LIBXML_DOCB_ENABLED
459 (reader->node->type == XML_DOCB_DOCUMENT_NODE) ||
460#endif
461 (reader->node->type == XML_HTML_DOCUMENT_NODE)) {
Daniel Veillardea7751d2002-12-20 00:16:24 +0000462 if (reader->mode != XML_TEXTREADER_DONE) {
463 val = xmlParseChunk(reader->ctxt, "", 0, 1);
464 reader->mode = XML_TEXTREADER_DONE;
465 }
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000466 reader->node = NULL;
Daniel Veillard4d8db8a2002-12-30 18:40:42 +0000467 reader->depth = -1;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000468
469 /*
470 * Cleanup of the old node
471 */
472 if (oldnode->type != XML_DTD_NODE) {
473 xmlUnlinkNode(oldnode);
474 xmlFreeNode(oldnode);
475 }
476
477 return(0);
478 }
479 reader->depth--;
480 reader->state = XML_TEXTREADER_BACKTRACK;
481 DUMP_READER
482 return(1);
483}
484
Daniel Veillard67df8092002-12-16 22:04:11 +0000485/**
486 * xmlTextReaderReadState:
487 * @reader: the xmlTextReaderPtr used
488 *
489 * Gets the read state of the reader.
490 *
491 * Returns the state value, or -1 in case of error
492 */
493int
494xmlTextReaderReadState(xmlTextReaderPtr reader) {
495 if (reader == NULL)
496 return(-1);
497 return(reader->mode);
498}
499
500/**
501 * xmlTextReaderReadInnerXml:
502 * @reader: the xmlTextReaderPtr used
503 *
504 * Reads the contents of the current node, including child nodes and markup.
505 *
506 * Returns a string containing the XML content, or NULL if the current node
507 * is neither an element nor attribute, or has no child nodes. The
508 * string must be deallocated by the caller.
509 */
510xmlChar *
511xmlTextReaderReadInnerXml(xmlTextReaderPtr reader) {
512 TODO
513 return(NULL);
514}
515
516/**
517 * xmlTextReaderReadOuterXml:
518 * @reader: the xmlTextReaderPtr used
519 *
520 * Reads the contents of the current node, including child nodes and markup.
521 *
522 * Returns a string containing the XML content, or NULL if the current node
523 * is neither an element nor attribute, or has no child nodes. The
524 * string must be deallocated by the caller.
525 */
526xmlChar *
527xmlTextReaderReadOuterXml(xmlTextReaderPtr reader) {
528 TODO
529 return(NULL);
530}
531
532/**
533 * xmlTextReaderReadString:
534 * @reader: the xmlTextReaderPtr used
535 *
536 * Reads the contents of an element or a text node as a string.
537 *
538 * Returns a string containing the contents of the Element or Text node,
539 * or NULL if the reader is positioned on any other type of node.
540 * The string must be deallocated by the caller.
541 */
542xmlChar *
543xmlTextReaderReadString(xmlTextReaderPtr reader) {
544 TODO
545 return(NULL);
546}
547
Daniel Veillardbeb70bd2002-12-18 14:53:54 +0000548/**
549 * xmlTextReaderReadBase64:
550 * @reader: the xmlTextReaderPtr used
551 * @array: a byte array to store the content.
552 * @offset: the zero-based index into array where the method should
553 * begin to write.
554 * @len: the number of bytes to write.
555 *
556 * Reads and decodes the Base64 encoded contents of an element and
557 * stores the result in a byte buffer.
558 *
559 * Returns the number of bytes written to array, or zero if the current
560 * instance is not positioned on an element or -1 in case of error.
561 */
562int
563xmlTextReaderReadBase64(xmlTextReaderPtr reader, unsigned char *array,
564 int offset, int len) {
565 if ((reader == NULL) || (reader->ctxt == NULL))
566 return(-1);
567 if (reader->ctxt->wellFormed != 1)
568 return(-1);
569
570 if ((reader->node == NULL) || (reader->node->type == XML_ELEMENT_NODE))
571 return(0);
572 TODO
573 return(0);
574}
575
576/**
577 * xmlTextReaderReadBinHex:
578 * @reader: the xmlTextReaderPtr used
579 * @array: a byte array to store the content.
580 * @offset: the zero-based index into array where the method should
581 * begin to write.
582 * @len: the number of bytes to write.
583 *
584 * Reads and decodes the BinHex encoded contents of an element and
585 * stores the result in a byte buffer.
586 *
587 * Returns the number of bytes written to array, or zero if the current
588 * instance is not positioned on an element or -1 in case of error.
589 */
590int
591xmlTextReaderReadBinHex(xmlTextReaderPtr reader, unsigned char *array,
592 int offset, int len) {
593 if ((reader == NULL) || (reader->ctxt == NULL))
594 return(-1);
595 if (reader->ctxt->wellFormed != 1)
596 return(-1);
597
598 if ((reader->node == NULL) || (reader->node->type == XML_ELEMENT_NODE))
599 return(0);
600 TODO
601 return(0);
602}
603
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000604/************************************************************************
605 * *
606 * Constructor and destructors *
607 * *
608 ************************************************************************/
609/**
610 * xmlNewTextReader:
611 * @input: the xmlParserInputBufferPtr used to read data
Daniel Veillardea7751d2002-12-20 00:16:24 +0000612 * @URI: the URI information for the source if available
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000613 *
614 * Create an xmlTextReader structure fed with @input
615 *
616 * Returns the new xmlTextReaderPtr or NULL in case of error
617 */
618xmlTextReaderPtr
Daniel Veillardea7751d2002-12-20 00:16:24 +0000619xmlNewTextReader(xmlParserInputBufferPtr input, const char *URI) {
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000620 xmlTextReaderPtr ret;
621 int val;
622
623 if (input == NULL)
624 return(NULL);
625 ret = xmlMalloc(sizeof(xmlTextReader));
626 if (ret == NULL) {
627 xmlGenericError(xmlGenericErrorContext,
628 "xmlNewTextReader : malloc failed\n");
629 return(NULL);
630 }
631 memset(ret, 0, sizeof(xmlTextReader));
632 ret->input = input;
633 ret->sax = (xmlSAXHandler *) xmlMalloc(sizeof(xmlSAXHandler));
634 if (ret->sax == NULL) {
635 xmlFree(ret);
636 xmlGenericError(xmlGenericErrorContext,
637 "xmlNewTextReader : malloc failed\n");
638 return(NULL);
639 }
640 memcpy(ret->sax, &xmlDefaultSAXHandler, sizeof(xmlSAXHandler));
641 ret->startElement = ret->sax->startElement;
642 ret->sax->startElement = xmlTextReaderStartElement;
643 ret->endElement = ret->sax->endElement;
644 ret->sax->endElement = xmlTextReaderEndElement;
Daniel Veillardea7751d2002-12-20 00:16:24 +0000645 ret->characters = ret->sax->characters;
646 ret->sax->characters = xmlTextReaderCharacters;
647 ret->cdataBlock = ret->sax->cdataBlock;
648 ret->sax->cdataBlock = xmlTextReaderCDataBlock;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000649
Daniel Veillard67df8092002-12-16 22:04:11 +0000650 ret->mode = XML_TEXTREADER_MODE_INITIAL;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000651 ret->node = NULL;
Daniel Veillardda46d2d2002-12-15 23:36:49 +0000652 ret->curnode = NULL;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000653 val = xmlParserInputBufferRead(input, 4);
654 if (val >= 4) {
655 ret->ctxt = xmlCreatePushParserCtxt(ret->sax, NULL,
Daniel Veillardea7751d2002-12-20 00:16:24 +0000656 (const char *) ret->input->buffer->content, 4, URI);
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000657 ret->base = 0;
658 ret->cur = 4;
659 } else {
Daniel Veillardea7751d2002-12-20 00:16:24 +0000660 ret->ctxt = xmlCreatePushParserCtxt(ret->sax, NULL, NULL, 0, URI);
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000661 ret->base = 0;
662 ret->cur = 0;
663 }
664 ret->ctxt->_private = ret;
Daniel Veillardea7751d2002-12-20 00:16:24 +0000665 ret->ctxt->linenumbers = 1;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000666 ret->allocs = XML_TEXTREADER_CTXT;
667 return(ret);
668
669}
670
671/**
672 * xmlNewTextReaderFilename:
673 * @URI: the URI of the resource to process
674 *
675 * Create an xmlTextReader structure fed with the resource at @URI
676 *
677 * Returns the new xmlTextReaderPtr or NULL in case of error
678 */
679xmlTextReaderPtr
680xmlNewTextReaderFilename(const char *URI) {
681 xmlParserInputBufferPtr input;
682 xmlTextReaderPtr ret;
Daniel Veillardea7751d2002-12-20 00:16:24 +0000683 char *directory = NULL;
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000684
685 input = xmlParserInputBufferCreateFilename(URI, XML_CHAR_ENCODING_NONE);
686 if (input == NULL)
687 return(NULL);
Daniel Veillardea7751d2002-12-20 00:16:24 +0000688 ret = xmlNewTextReader(input, URI);
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000689 if (ret == NULL) {
690 xmlFreeParserInputBuffer(input);
691 return(NULL);
692 }
693 ret->allocs |= XML_TEXTREADER_INPUT;
Daniel Veillardea7751d2002-12-20 00:16:24 +0000694 if (ret->ctxt->directory == NULL)
695 directory = xmlParserGetDirectory(URI);
696 if ((ret->ctxt->directory == NULL) && (directory != NULL))
697 ret->ctxt->directory = (char *) xmlStrdup((xmlChar *) directory);
698 if (directory != NULL)
699 xmlFree(directory);
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000700 return(ret);
701}
702
703/**
704 * xmlFreeTextReader:
705 * @reader: the xmlTextReaderPtr
706 *
707 * Deallocate all the resources associated to the reader
708 */
709void
710xmlFreeTextReader(xmlTextReaderPtr reader) {
711 if (reader == NULL)
712 return;
713 if (reader->ctxt != NULL) {
714 if (reader->ctxt->myDoc != NULL) {
715 xmlFreeDoc(reader->ctxt->myDoc);
716 reader->ctxt->myDoc = NULL;
717 }
Daniel Veillard336fc7d2002-12-27 19:37:04 +0000718 if ((reader->ctxt->vctxt.vstateTab != NULL) &&
719 (reader->ctxt->vctxt.vstateMax > 0)){
720 xmlFree(reader->ctxt->vctxt.vstateTab);
721 reader->ctxt->vctxt.vstateTab = 0;
722 reader->ctxt->vctxt.vstateMax = 0;
723 }
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000724 if (reader->allocs & XML_TEXTREADER_CTXT)
725 xmlFreeParserCtxt(reader->ctxt);
726 }
727 if (reader->sax != NULL)
728 xmlFree(reader->sax);
729 if ((reader->input != NULL) && (reader->allocs & XML_TEXTREADER_INPUT))
730 xmlFreeParserInputBuffer(reader->input);
Daniel Veillardbeb70bd2002-12-18 14:53:54 +0000731 if (reader->faketext != NULL) {
732 xmlFreeNode(reader->faketext);
733 }
Daniel Veillarde1ca5032002-12-09 14:13:43 +0000734 xmlFree(reader);
735}
736
737/************************************************************************
738 * *
Daniel Veillard0eb38c72002-12-14 23:00:35 +0000739 * Methods for XmlTextReader *
740 * *
741 ************************************************************************/
742/**
743 * xmlTextReaderClose:
744 * @reader: the xmlTextReaderPtr used
745 *
746 * This method releases any resources allocated by the current instance
747 * changes the state to Closed and close any underlying input.
748 *
749 * Returns 0 or -1 in case of error
750 */
751int
752xmlTextReaderClose(xmlTextReaderPtr reader) {
753 if (reader == NULL)
754 return(-1);
755 reader->node = NULL;
Daniel Veillardda46d2d2002-12-15 23:36:49 +0000756 reader->curnode = NULL;
Daniel Veillard0eb38c72002-12-14 23:00:35 +0000757 reader->mode = XML_TEXTREADER_MODE_CLOSED;
758 if (reader->ctxt != NULL) {
759 if (reader->ctxt->myDoc != NULL) {
760 xmlFreeDoc(reader->ctxt->myDoc);
761 reader->ctxt->myDoc = NULL;
762 }
763 if (reader->allocs & XML_TEXTREADER_CTXT) {
764 xmlFreeParserCtxt(reader->ctxt);
765 reader->allocs -= XML_TEXTREADER_CTXT;
766 }
767 }
768 if (reader->sax != NULL) {
769 xmlFree(reader->sax);
770 reader->sax = NULL;
771 }
772 if ((reader->input != NULL) && (reader->allocs & XML_TEXTREADER_INPUT)) {
773 xmlFreeParserInputBuffer(reader->input);
774 reader->allocs -= XML_TEXTREADER_INPUT;
775 }
776 return(0);
777}
778
779/**
780 * xmlTextReaderGetAttributeNo:
781 * @reader: the xmlTextReaderPtr used
782 * @no: the zero-based index of the attribute relative to the containing element
783 *
784 * Provides the value of the attribute with the specified index relative
785 * to the containing element.
786 *
787 * Returns a string containing the value of the specified attribute, or NULL
788 * in case of error. The string must be deallocated by the caller.
789 */
790xmlChar *
791xmlTextReaderGetAttributeNo(xmlTextReaderPtr reader, int no) {
792 xmlChar *ret;
793 int i;
794 xmlAttrPtr cur;
795 xmlNsPtr ns;
796
797 if (reader == NULL)
798 return(NULL);
799 if (reader->node == NULL)
800 return(NULL);
Daniel Veillardda46d2d2002-12-15 23:36:49 +0000801 if (reader->curnode != NULL)
802 return(NULL);
Daniel Veillard0eb38c72002-12-14 23:00:35 +0000803 /* TODO: handle the xmlDecl */
804 if (reader->node->type != XML_ELEMENT_NODE)
805 return(NULL);
806
807 ns = reader->node->nsDef;
808 for (i = 0;(i < no) && (ns != NULL);i++) {
809 ns = ns->next;
810 }
811 if (ns != NULL)
812 return(xmlStrdup(ns->href));
813
814 cur = reader->node->properties;
815 if (cur == NULL)
816 return(NULL);
817 for (;i < no;i++) {
818 cur = cur->next;
819 if (cur == NULL)
820 return(NULL);
821 }
822 /* TODO walk the DTD if present */
823
824 ret = xmlNodeListGetString(reader->node->doc, cur->children, 1);
825 if (ret == NULL) return(xmlStrdup((xmlChar *)""));
826 return(ret);
827}
828
829/**
830 * xmlTextReaderGetAttribute:
831 * @reader: the xmlTextReaderPtr used
832 * @name: the qualified name of the attribute.
833 *
834 * Provides the value of the attribute with the specified qualified name.
835 *
836 * Returns a string containing the value of the specified attribute, or NULL
837 * in case of error. The string must be deallocated by the caller.
838 */
839xmlChar *
840xmlTextReaderGetAttribute(xmlTextReaderPtr reader, const xmlChar *name) {
841 xmlChar *prefix = NULL;
842 xmlChar *localname;
843 xmlNsPtr ns;
844 xmlChar *ret = NULL;
845
846 if ((reader == NULL) || (name == NULL))
847 return(NULL);
848 if (reader->node == NULL)
849 return(NULL);
Daniel Veillardda46d2d2002-12-15 23:36:49 +0000850 if (reader->curnode != NULL)
851 return(NULL);
Daniel Veillard0eb38c72002-12-14 23:00:35 +0000852
853 /* TODO: handle the xmlDecl */
854 if (reader->node->type != XML_ELEMENT_NODE)
855 return(NULL);
856
857 localname = xmlSplitQName2(name, &prefix);
858 if (localname == NULL)
859 return(xmlGetProp(reader->node, name));
860
861 ns = xmlSearchNs(reader->node->doc, reader->node, prefix);
862 if (ns != NULL)
863 ret = xmlGetNsProp(reader->node, localname, ns->href);
864
865 if (localname != NULL)
866 xmlFree(localname);
867 if (prefix != NULL)
868 xmlFree(prefix);
869 return(ret);
870}
871
872
873/**
874 * xmlTextReaderGetAttributeNs:
875 * @reader: the xmlTextReaderPtr used
876 * @localName: the local name of the attribute.
877 * @namespaceURI: the namespace URI of the attribute.
878 *
879 * Provides the value of the specified attribute
880 *
881 * Returns a string containing the value of the specified attribute, or NULL
882 * in case of error. The string must be deallocated by the caller.
883 */
884xmlChar *
885xmlTextReaderGetAttributeNs(xmlTextReaderPtr reader, const xmlChar *localName,
886 const xmlChar *namespaceURI) {
887 if ((reader == NULL) || (localName == NULL))
888 return(NULL);
889 if (reader->node == NULL)
890 return(NULL);
Daniel Veillardda46d2d2002-12-15 23:36:49 +0000891 if (reader->curnode != NULL)
892 return(NULL);
Daniel Veillard0eb38c72002-12-14 23:00:35 +0000893
894 /* TODO: handle the xmlDecl */
895 if (reader->node->type != XML_ELEMENT_NODE)
896 return(NULL);
897
898 return(xmlGetNsProp(reader->node, localName, namespaceURI));
899}
900
Daniel Veillardda46d2d2002-12-15 23:36:49 +0000901/**
902 * xmlTextReaderGetRemainder:
903 * @reader: the xmlTextReaderPtr used
904 *
905 * Method to get the remainder of the buffered XML. this method stops the
906 * parser, set its state to End Of File and return the input stream with
907 * what is left that the parser did not use.
908 *
909 * Returns the xmlParserInputBufferPtr attached to the XML or NULL
910 * in case of error.
911 */
912xmlParserInputBufferPtr
913xmlTextReaderGetRemainder(xmlTextReaderPtr reader) {
914 xmlParserInputBufferPtr ret = NULL;
915
916 if (reader == NULL)
917 return(NULL);
918 if (reader->node == NULL)
919 return(NULL);
920
921 reader->node = NULL;
922 reader->curnode = NULL;
923 reader->mode = XML_TEXTREADER_MODE_EOF;
924 if (reader->ctxt != NULL) {
925 if (reader->ctxt->myDoc != NULL) {
926 xmlFreeDoc(reader->ctxt->myDoc);
927 reader->ctxt->myDoc = NULL;
928 }
929 if (reader->allocs & XML_TEXTREADER_CTXT) {
930 xmlFreeParserCtxt(reader->ctxt);
931 reader->allocs -= XML_TEXTREADER_CTXT;
932 }
933 }
934 if (reader->sax != NULL) {
935 xmlFree(reader->sax);
936 reader->sax = NULL;
937 }
938 if (reader->allocs & XML_TEXTREADER_INPUT) {
939 ret = reader->input;
940 reader->allocs -= XML_TEXTREADER_INPUT;
941 } else {
942 /*
943 * Hum, one may need to duplicate the data structure because
944 * without reference counting the input may be freed twice:
945 * - by the layer which allocated it.
946 * - by the layer to which would have been returned to.
947 */
948 TODO
949 return(NULL);
950 }
951 return(ret);
952}
953
954/**
955 * xmlTextReaderLookupNamespace:
956 * @reader: the xmlTextReaderPtr used
957 * @prefix: the prefix whose namespace URI is to be resolved. To return
958 * the default namespace, specify NULL
959 *
960 * Resolves a namespace prefix in the scope of the current element.
961 *
962 * Returns a string containing the namespace URI to which the prefix maps
963 * or NULL in case of error. The string must be deallocated by the caller.
964 */
965xmlChar *
966xmlTextReaderLookupNamespace(xmlTextReaderPtr reader, const xmlChar *prefix) {
967 xmlNsPtr ns;
968
969 if (reader == NULL)
970 return(NULL);
971 if (reader->node == NULL)
972 return(NULL);
973
974 ns = xmlSearchNs(reader->node->doc, reader->node, prefix);
975 if (ns == NULL)
976 return(NULL);
977 return(xmlStrdup(ns->href));
978}
979
980/**
981 * xmlTextReaderMoveToAttributeNo:
982 * @reader: the xmlTextReaderPtr used
983 * @no: the zero-based index of the attribute relative to the containing
984 * element.
985 *
986 * Moves the position of the current instance to the attribute with
987 * the specified index relative to the containing element.
988 *
989 * Returns 1 in case of success, -1 in case of error, 0 if not found
990 */
991int
992xmlTextReaderMoveToAttributeNo(xmlTextReaderPtr reader, int no) {
993 int i;
994 xmlAttrPtr cur;
995 xmlNsPtr ns;
996
997 if (reader == NULL)
998 return(-1);
999 if (reader->node == NULL)
1000 return(-1);
1001 /* TODO: handle the xmlDecl */
1002 if (reader->node->type != XML_ELEMENT_NODE)
1003 return(-1);
1004
1005 reader->curnode = NULL;
1006
1007 ns = reader->node->nsDef;
1008 for (i = 0;(i < no) && (ns != NULL);i++) {
1009 ns = ns->next;
1010 }
1011 if (ns != NULL) {
1012 reader->curnode = (xmlNodePtr) ns;
1013 return(1);
1014 }
1015
1016 cur = reader->node->properties;
1017 if (cur == NULL)
1018 return(0);
1019 for (;i < no;i++) {
1020 cur = cur->next;
1021 if (cur == NULL)
1022 return(0);
1023 }
1024 /* TODO walk the DTD if present */
1025
1026 reader->curnode = (xmlNodePtr) cur;
1027 return(1);
1028}
1029
1030/**
1031 * xmlTextReaderMoveToAttribute:
1032 * @reader: the xmlTextReaderPtr used
1033 * @name: the qualified name of the attribute.
1034 *
1035 * Moves the position of the current instance to the attribute with
1036 * the specified qualified name.
1037 *
1038 * Returns 1 in case of success, -1 in case of error, 0 if not found
1039 */
1040int
1041xmlTextReaderMoveToAttribute(xmlTextReaderPtr reader, const xmlChar *name) {
1042 xmlChar *prefix = NULL;
1043 xmlChar *localname;
1044 xmlNsPtr ns;
1045 xmlAttrPtr prop;
1046
1047 if ((reader == NULL) || (name == NULL))
1048 return(-1);
1049 if (reader->node == NULL)
1050 return(-1);
1051
1052 /* TODO: handle the xmlDecl */
1053 if (reader->node->type != XML_ELEMENT_NODE)
1054 return(0);
1055
1056 localname = xmlSplitQName2(name, &prefix);
1057 if (localname == NULL) {
1058 /*
1059 * Namespace default decl
1060 */
1061 if (xmlStrEqual(name, BAD_CAST "xmlns")) {
1062 ns = reader->node->nsDef;
1063 while (ns != NULL) {
1064 if (ns->prefix == NULL) {
1065 reader->curnode = (xmlNodePtr) ns;
1066 return(1);
1067 }
1068 ns = ns->next;
1069 }
1070 return(0);
1071 }
1072
1073 prop = reader->node->properties;
1074 while (prop != NULL) {
1075 /*
1076 * One need to have
1077 * - same attribute names
1078 * - and the attribute carrying that namespace
1079 */
1080 if ((xmlStrEqual(prop->name, name)) &&
1081 ((prop->ns == NULL) || (prop->ns->prefix == NULL))) {
1082 reader->curnode = (xmlNodePtr) prop;
1083 return(1);
1084 }
1085 prop = prop->next;
1086 }
1087 return(0);
1088 }
1089
1090 /*
1091 * Namespace default decl
1092 */
1093 if (xmlStrEqual(prefix, BAD_CAST "xmlns")) {
1094 ns = reader->node->nsDef;
1095 while (ns != NULL) {
1096 if ((ns->prefix != NULL) && (xmlStrEqual(ns->prefix, localname))) {
1097 reader->curnode = (xmlNodePtr) ns;
1098 goto found;
1099 }
1100 ns = ns->next;
1101 }
1102 goto not_found;
1103 }
1104 prop = reader->node->properties;
1105 while (prop != NULL) {
1106 /*
1107 * One need to have
1108 * - same attribute names
1109 * - and the attribute carrying that namespace
1110 */
1111 if ((xmlStrEqual(prop->name, localname)) &&
1112 (prop->ns != NULL) && (xmlStrEqual(prop->ns->prefix, prefix))) {
1113 reader->curnode = (xmlNodePtr) prop;
1114 goto found;
1115 }
1116 prop = prop->next;
1117 }
1118not_found:
1119 if (localname != NULL)
1120 xmlFree(localname);
1121 if (prefix != NULL)
1122 xmlFree(prefix);
1123 return(0);
1124
1125found:
1126 if (localname != NULL)
1127 xmlFree(localname);
1128 if (prefix != NULL)
1129 xmlFree(prefix);
1130 return(1);
1131}
1132
1133/**
1134 * xmlTextReaderMoveToAttributeNs:
1135 * @reader: the xmlTextReaderPtr used
1136 * @localName: the local name of the attribute.
1137 * @namespaceURI: the namespace URI of the attribute.
1138 *
1139 * Moves the position of the current instance to the attribute with the
1140 * specified local name and namespace URI.
1141 *
1142 * Returns 1 in case of success, -1 in case of error, 0 if not found
1143 */
1144int
1145xmlTextReaderMoveToAttributeNs(xmlTextReaderPtr reader,
1146 const xmlChar *localName, const xmlChar *namespaceURI) {
1147 xmlAttrPtr prop;
1148 xmlNodePtr node;
1149
1150 if ((reader == NULL) || (localName == NULL) || (namespaceURI == NULL))
1151 return(-1);
1152 if (reader->node == NULL)
1153 return(-1);
1154 if (reader->node->type != XML_ELEMENT_NODE)
1155 return(0);
1156 node = reader->node;
1157
1158 /*
1159 * A priori reading http://www.w3.org/TR/REC-xml-names/ there is no
1160 * namespace name associated to "xmlns"
1161 */
1162 prop = node->properties;
1163 while (prop != NULL) {
1164 /*
1165 * One need to have
1166 * - same attribute names
1167 * - and the attribute carrying that namespace
1168 */
1169 if (xmlStrEqual(prop->name, localName) &&
1170 ((prop->ns != NULL) &&
1171 (xmlStrEqual(prop->ns->href, namespaceURI)))) {
1172 reader->curnode = (xmlNodePtr) prop;
1173 return(1);
1174 }
1175 prop = prop->next;
1176 }
1177 return(0);
1178}
1179
1180/**
1181 * xmlTextReaderMoveToFirstAttribute:
1182 * @reader: the xmlTextReaderPtr used
1183 *
1184 * Moves the position of the current instance to the first attribute
1185 * associated with the current node.
1186 *
1187 * Returns 1 in case of success, -1 in case of error, 0 if not found
1188 */
1189int
1190xmlTextReaderMoveToFirstAttribute(xmlTextReaderPtr reader) {
1191 if (reader == NULL)
1192 return(-1);
1193 if (reader->node == NULL)
1194 return(-1);
1195 if (reader->node->type != XML_ELEMENT_NODE)
1196 return(0);
1197
1198 if (reader->node->nsDef != NULL) {
1199 reader->curnode = (xmlNodePtr) reader->node->nsDef;
1200 return(1);
1201 }
1202 if (reader->node->properties != NULL) {
1203 reader->curnode = (xmlNodePtr) reader->node->properties;
1204 return(1);
1205 }
1206 return(0);
1207}
1208
1209/**
1210 * xmlTextReaderMoveToNextAttribute:
1211 * @reader: the xmlTextReaderPtr used
1212 *
1213 * Moves the position of the current instance to the next attribute
1214 * associated with the current node.
1215 *
1216 * Returns 1 in case of success, -1 in case of error, 0 if not found
1217 */
1218int
1219xmlTextReaderMoveToNextAttribute(xmlTextReaderPtr reader) {
1220 if (reader == NULL)
1221 return(-1);
1222 if (reader->node == NULL)
1223 return(-1);
1224 if (reader->node->type != XML_ELEMENT_NODE)
1225 return(0);
1226 if (reader->curnode == NULL)
1227 return(xmlTextReaderMoveToFirstAttribute(reader));
1228
1229 if (reader->curnode->type == XML_NAMESPACE_DECL) {
1230 xmlNsPtr ns = (xmlNsPtr) reader->curnode;
1231 if (ns->next != NULL) {
1232 reader->curnode = (xmlNodePtr) ns->next;
1233 return(1);
1234 }
1235 if (reader->node->properties != NULL) {
1236 reader->curnode = (xmlNodePtr) reader->node->properties;
1237 return(1);
1238 }
1239 return(0);
1240 } else if ((reader->curnode->type == XML_ATTRIBUTE_NODE) &&
1241 (reader->curnode->next != NULL)) {
1242 reader->curnode = reader->curnode->next;
1243 return(1);
1244 }
1245 return(0);
1246}
1247
1248/**
1249 * xmlTextReaderMoveToElement:
1250 * @reader: the xmlTextReaderPtr used
1251 *
1252 * Moves the position of the current instance to the node that
1253 * contains the current Attribute node.
1254 *
1255 * Returns 1 in case of success, -1 in case of error, 0 if not moved
1256 */
1257int
1258xmlTextReaderMoveToElement(xmlTextReaderPtr reader) {
1259 if (reader == NULL)
1260 return(-1);
1261 if (reader->node == NULL)
1262 return(-1);
1263 if (reader->node->type != XML_ELEMENT_NODE)
1264 return(0);
1265 if (reader->curnode != NULL) {
1266 reader->curnode = NULL;
1267 return(1);
1268 }
1269 return(0);
1270}
1271
Daniel Veillardbeb70bd2002-12-18 14:53:54 +00001272/**
1273 * xmlTextReaderReadAttributeValue:
1274 * @reader: the xmlTextReaderPtr used
1275 *
1276 * Parses an attribute value into one or more Text and EntityReference nodes.
1277 *
1278 * Returns 1 in case of success, 0 if the reader was not positionned on an
1279 * ttribute node or all the attribute values have been read, or -1
1280 * in case of error.
1281 */
1282int
1283xmlTextReaderReadAttributeValue(xmlTextReaderPtr reader) {
1284 if (reader == NULL)
1285 return(-1);
1286 if (reader->node == NULL)
1287 return(-1);
1288 if (reader->curnode == NULL)
1289 return(0);
1290 if (reader->curnode->type == XML_ATTRIBUTE_NODE) {
1291 if (reader->curnode->children == NULL)
1292 return(0);
1293 reader->curnode = reader->curnode->children;
1294 } else if (reader->curnode->type == XML_NAMESPACE_DECL) {
1295 xmlNsPtr ns = (xmlNsPtr) reader->curnode;
1296
1297 if (reader->faketext == NULL) {
1298 reader->faketext = xmlNewDocText(reader->node->doc,
1299 ns->href);
1300 } else {
1301 if (reader->faketext->content != NULL)
1302 xmlFree(reader->faketext->content);
1303 reader->faketext->content = xmlStrdup(ns->href);
1304 }
1305 reader->curnode = reader->faketext;
1306 } else {
1307 if (reader->curnode->next == NULL)
1308 return(0);
1309 reader->curnode = reader->curnode->next;
1310 }
1311 return(1);
1312}
1313
Daniel Veillard0eb38c72002-12-14 23:00:35 +00001314/************************************************************************
1315 * *
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001316 * Acces API to the current node *
1317 * *
1318 ************************************************************************/
1319/**
1320 * xmlTextReaderAttributeCount:
1321 * @reader: the xmlTextReaderPtr used
1322 *
Daniel Veillarda9b66d02002-12-11 14:23:49 +00001323 * Provides the number of attributes of the current node
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001324 *
1325 * Returns 0 i no attributes, -1 in case of error or the attribute count
1326 */
1327int
1328xmlTextReaderAttributeCount(xmlTextReaderPtr reader) {
1329 int ret;
1330 xmlAttrPtr attr;
Daniel Veillard67df8092002-12-16 22:04:11 +00001331 xmlNsPtr ns;
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001332 xmlNodePtr node;
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001333
1334 if (reader == NULL)
1335 return(-1);
1336 if (reader->node == NULL)
1337 return(0);
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001338
1339 if (reader->curnode != NULL)
1340 node = reader->curnode;
1341 else
1342 node = reader->node;
1343
1344 if (node->type != XML_ELEMENT_NODE)
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001345 return(0);
1346 if ((reader->state == XML_TEXTREADER_END) ||
1347 (reader->state == XML_TEXTREADER_BACKTRACK))
1348 return(0);
1349 ret = 0;
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001350 attr = node->properties;
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001351 while (attr != NULL) {
1352 ret++;
1353 attr = attr->next;
1354 }
Daniel Veillard67df8092002-12-16 22:04:11 +00001355 ns = node->nsDef;
1356 while (ns != NULL) {
1357 ret++;
1358 ns = ns->next;
1359 }
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001360 return(ret);
1361}
1362
1363/**
1364 * xmlTextReaderNodeType:
1365 * @reader: the xmlTextReaderPtr used
1366 *
1367 * Get the node type of the current node
1368 * Reference:
1369 * http://dotgnu.org/pnetlib-doc/System/Xml/XmlNodeType.html
1370 *
1371 * Returns the xmlNodeType of the current node or -1 in case of error
1372 */
1373int
1374xmlTextReaderNodeType(xmlTextReaderPtr reader) {
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001375 xmlNodePtr node;
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001376 if (reader == NULL)
1377 return(-1);
1378 if (reader->node == NULL)
1379 return(0);
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001380 if (reader->curnode != NULL)
1381 node = reader->curnode;
1382 else
1383 node = reader->node;
1384 switch (node->type) {
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001385 case XML_ELEMENT_NODE:
1386 if ((reader->state == XML_TEXTREADER_END) ||
1387 (reader->state == XML_TEXTREADER_BACKTRACK))
1388 return(15);
1389 return(1);
Daniel Veillardecaba492002-12-30 10:55:29 +00001390 case XML_NAMESPACE_DECL:
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001391 case XML_ATTRIBUTE_NODE:
1392 return(2);
1393 case XML_TEXT_NODE:
1394 return(3); /* TODO: SignificantWhitespace == 14 Whitespace == 13 */
1395 case XML_CDATA_SECTION_NODE:
1396 return(4);
1397 case XML_ENTITY_REF_NODE:
1398 return(5);
1399 case XML_ENTITY_NODE:
1400 return(6);
1401 case XML_PI_NODE:
1402 return(7);
1403 case XML_COMMENT_NODE:
1404 return(8);
1405 case XML_DOCUMENT_NODE:
1406 case XML_HTML_DOCUMENT_NODE:
1407#ifdef LIBXML_DOCB_ENABLED
1408 case XML_DOCB_DOCUMENT_NODE:
1409#endif
1410 return(9);
1411 case XML_DOCUMENT_FRAG_NODE:
1412 return(11);
1413 case XML_NOTATION_NODE:
1414 return(12);
1415 case XML_DOCUMENT_TYPE_NODE:
1416 case XML_DTD_NODE:
1417 return(10);
1418
1419 case XML_ELEMENT_DECL:
1420 case XML_ATTRIBUTE_DECL:
1421 case XML_ENTITY_DECL:
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001422 case XML_XINCLUDE_START:
1423 case XML_XINCLUDE_END:
1424 return(0);
1425 }
1426 return(-1);
1427}
1428
1429/**
Daniel Veillard01c13b52002-12-10 15:19:08 +00001430 * xmlTextReaderIsEmptyElement:
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001431 * @reader: the xmlTextReaderPtr used
1432 *
1433 * Check if the current node is empty
1434 *
1435 * Returns 1 if empty, 0 if not and -1 in case of error
1436 */
1437int
1438xmlTextReaderIsEmptyElement(xmlTextReaderPtr reader) {
1439 if ((reader == NULL) || (reader->node == NULL))
1440 return(-1);
Daniel Veillarddf512f42002-12-23 15:56:21 +00001441 if (reader->node->type != XML_ELEMENT_NODE)
1442 return(0);
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001443 if (reader->node->children != NULL)
1444 return(0);
Daniel Veillarddf512f42002-12-23 15:56:21 +00001445 if (reader->node != reader->ctxt->node)
1446 return(1);
1447 if ((reader->ctxt->node != NULL) &&
1448 (reader->node == reader->ctxt->node->last) &&
1449 (reader->wasempty == 1))
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001450 return(1);
1451 return(0);
1452}
1453
1454/**
1455 * xmlTextReaderLocalName:
1456 * @reader: the xmlTextReaderPtr used
1457 *
1458 * The local name of the node.
1459 *
1460 * Returns the local name or NULL if not available
1461 */
1462xmlChar *
1463xmlTextReaderLocalName(xmlTextReaderPtr reader) {
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001464 xmlNodePtr node;
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001465 if ((reader == NULL) || (reader->node == NULL))
1466 return(NULL);
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001467 if (reader->curnode != NULL)
1468 node = reader->curnode;
1469 else
1470 node = reader->node;
1471 if (node->type == XML_NAMESPACE_DECL) {
1472 xmlNsPtr ns = (xmlNsPtr) node;
1473 if (ns->prefix == NULL)
1474 return(xmlStrdup(BAD_CAST "xmlns"));
1475 else
1476 return(xmlStrdup(ns->prefix));
1477 }
1478 if ((node->type != XML_ELEMENT_NODE) &&
1479 (node->type != XML_ATTRIBUTE_NODE))
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001480 return(xmlTextReaderName(reader));
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001481 return(xmlStrdup(node->name));
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001482}
1483
1484/**
1485 * xmlTextReaderName:
1486 * @reader: the xmlTextReaderPtr used
1487 *
1488 * The qualified name of the node, equal to Prefix :LocalName.
1489 *
1490 * Returns the local name or NULL if not available
1491 */
1492xmlChar *
1493xmlTextReaderName(xmlTextReaderPtr reader) {
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001494 xmlNodePtr node;
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001495 xmlChar *ret;
1496
1497 if ((reader == NULL) || (reader->node == NULL))
1498 return(NULL);
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001499 if (reader->curnode != NULL)
1500 node = reader->curnode;
1501 else
1502 node = reader->node;
1503 switch (node->type) {
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001504 case XML_ELEMENT_NODE:
1505 case XML_ATTRIBUTE_NODE:
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001506 if ((node->ns == NULL) ||
1507 (node->ns->prefix == NULL))
1508 return(xmlStrdup(node->name));
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001509
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001510 ret = xmlStrdup(node->ns->prefix);
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001511 ret = xmlStrcat(ret, BAD_CAST ":");
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001512 ret = xmlStrcat(ret, node->name);
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001513 return(ret);
1514 case XML_TEXT_NODE:
1515 return(xmlStrdup(BAD_CAST "#text"));
1516 case XML_CDATA_SECTION_NODE:
1517 return(xmlStrdup(BAD_CAST "#cdata-section"));
1518 case XML_ENTITY_NODE:
1519 case XML_ENTITY_REF_NODE:
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001520 return(xmlStrdup(node->name));
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001521 case XML_PI_NODE:
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001522 return(xmlStrdup(node->name));
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001523 case XML_COMMENT_NODE:
1524 return(xmlStrdup(BAD_CAST "#comment"));
1525 case XML_DOCUMENT_NODE:
1526 case XML_HTML_DOCUMENT_NODE:
1527#ifdef LIBXML_DOCB_ENABLED
1528 case XML_DOCB_DOCUMENT_NODE:
1529#endif
1530 return(xmlStrdup(BAD_CAST "#document"));
1531 case XML_DOCUMENT_FRAG_NODE:
1532 return(xmlStrdup(BAD_CAST "#document-fragment"));
1533 case XML_NOTATION_NODE:
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001534 return(xmlStrdup(node->name));
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001535 case XML_DOCUMENT_TYPE_NODE:
1536 case XML_DTD_NODE:
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001537 return(xmlStrdup(node->name));
1538 case XML_NAMESPACE_DECL: {
1539 xmlNsPtr ns = (xmlNsPtr) node;
1540
1541 ret = xmlStrdup(BAD_CAST "xmlns");
1542 if (ns->prefix == NULL)
1543 return(ret);
1544 ret = xmlStrcat(ret, BAD_CAST ":");
1545 ret = xmlStrcat(ret, ns->prefix);
1546 return(ret);
1547 }
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001548
1549 case XML_ELEMENT_DECL:
1550 case XML_ATTRIBUTE_DECL:
1551 case XML_ENTITY_DECL:
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001552 case XML_XINCLUDE_START:
1553 case XML_XINCLUDE_END:
1554 return(NULL);
1555 }
1556 return(NULL);
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001557}
1558
1559/**
1560 * xmlTextReaderPrefix:
1561 * @reader: the xmlTextReaderPtr used
1562 *
1563 * A shorthand reference to the namespace associated with the node.
1564 *
1565 * Returns the prefix or NULL if not available
1566 */
1567xmlChar *
1568xmlTextReaderPrefix(xmlTextReaderPtr reader) {
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001569 xmlNodePtr node;
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001570 if ((reader == NULL) || (reader->node == NULL))
1571 return(NULL);
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001572 if (reader->curnode != NULL)
1573 node = reader->curnode;
1574 else
1575 node = reader->node;
1576 if (node->type == XML_NAMESPACE_DECL) {
1577 xmlNsPtr ns = (xmlNsPtr) node;
1578 if (ns->prefix == NULL)
1579 return(NULL);
1580 return(xmlStrdup(BAD_CAST "xmlns"));
1581 }
1582 if ((node->type != XML_ELEMENT_NODE) &&
1583 (node->type != XML_ATTRIBUTE_NODE))
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001584 return(NULL);
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001585 if ((node->ns != NULL) || (node->ns->prefix != NULL))
1586 return(xmlStrdup(node->ns->prefix));
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001587 return(NULL);
1588}
1589
1590/**
1591 * xmlTextReaderNamespaceUri:
1592 * @reader: the xmlTextReaderPtr used
1593 *
1594 * The URI defining the namespace associated with the node.
1595 *
1596 * Returns the namespace URI or NULL if not available
1597 */
1598xmlChar *
1599xmlTextReaderNamespaceUri(xmlTextReaderPtr reader) {
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001600 xmlNodePtr node;
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001601 if ((reader == NULL) || (reader->node == NULL))
1602 return(NULL);
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001603 if (reader->curnode != NULL)
1604 node = reader->curnode;
1605 else
1606 node = reader->node;
Daniel Veillardecaba492002-12-30 10:55:29 +00001607 if (node->type == XML_NAMESPACE_DECL)
1608 return(xmlStrdup(BAD_CAST "http://www.w3.org/2000/xmlns/"));
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001609 if ((node->type != XML_ELEMENT_NODE) &&
1610 (node->type != XML_ATTRIBUTE_NODE))
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001611 return(NULL);
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001612 if (node->ns != NULL)
1613 return(xmlStrdup(node->ns->href));
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001614 return(NULL);
1615}
1616
1617/**
1618 * xmlTextReaderBaseUri:
1619 * @reader: the xmlTextReaderPtr used
1620 *
1621 * The base URI of the node.
1622 *
1623 * Returns the base URI or NULL if not available
1624 */
1625xmlChar *
1626xmlTextReaderBaseUri(xmlTextReaderPtr reader) {
1627 if ((reader == NULL) || (reader->node == NULL))
1628 return(NULL);
1629 return(xmlNodeGetBase(NULL, reader->node));
1630}
1631
1632/**
1633 * xmlTextReaderDepth:
1634 * @reader: the xmlTextReaderPtr used
1635 *
1636 * The depth of the node in the tree.
1637 *
1638 * Returns the depth or -1 in case of error
1639 */
1640int
1641xmlTextReaderDepth(xmlTextReaderPtr reader) {
1642 if (reader == NULL)
1643 return(-1);
1644 if (reader->node == NULL)
1645 return(0);
1646
Daniel Veillardbeb70bd2002-12-18 14:53:54 +00001647 if (reader->curnode != NULL) {
1648 if ((reader->curnode->type == XML_ATTRIBUTE_NODE) ||
1649 (reader->curnode->type == XML_NAMESPACE_DECL))
1650 return(reader->depth + 1);
1651 return(reader->depth + 2);
1652 }
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001653 return(reader->depth);
1654}
1655
1656/**
1657 * xmlTextReaderHasAttributes:
1658 * @reader: the xmlTextReaderPtr used
1659 *
1660 * Whether the node has attributes.
1661 *
1662 * Returns 1 if true, 0 if false, and -1 in case or error
1663 */
1664int
1665xmlTextReaderHasAttributes(xmlTextReaderPtr reader) {
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001666 xmlNodePtr node;
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001667 if (reader == NULL)
1668 return(-1);
1669 if (reader->node == NULL)
1670 return(0);
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001671 if (reader->curnode != NULL)
1672 node = reader->curnode;
1673 else
1674 node = reader->node;
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001675
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001676 if ((node->type == XML_ELEMENT_NODE) &&
1677 (node->properties != NULL))
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001678 return(1);
1679 /* TODO: handle the xmlDecl */
1680 return(0);
1681}
1682
1683/**
1684 * xmlTextReaderHasValue:
1685 * @reader: the xmlTextReaderPtr used
1686 *
1687 * Whether the node can have a text value.
1688 *
1689 * Returns 1 if true, 0 if false, and -1 in case or error
1690 */
1691int
1692xmlTextReaderHasValue(xmlTextReaderPtr reader) {
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001693 xmlNodePtr node;
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001694 if (reader == NULL)
1695 return(-1);
1696 if (reader->node == NULL)
1697 return(0);
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001698 if (reader->curnode != NULL)
1699 node = reader->curnode;
1700 else
1701 node = reader->node;
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001702
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001703 switch (node->type) {
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001704 case XML_ATTRIBUTE_NODE:
1705 case XML_TEXT_NODE:
1706 case XML_CDATA_SECTION_NODE:
1707 case XML_PI_NODE:
1708 case XML_COMMENT_NODE:
1709 return(1);
1710 default:
1711 return(0);
1712 }
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001713 return(0);
1714}
1715
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001716/**
1717 * xmlTextReaderValue:
1718 * @reader: the xmlTextReaderPtr used
1719 *
1720 * Provides the text value of the node if present
1721 *
1722 * Returns the string or NULL if not available. The retsult must be deallocated
1723 * with xmlFree()
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001724 */
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001725xmlChar *
1726xmlTextReaderValue(xmlTextReaderPtr reader) {
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001727 xmlNodePtr node;
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001728 if (reader == NULL)
1729 return(NULL);
1730 if (reader->node == NULL)
1731 return(NULL);
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001732 if (reader->curnode != NULL)
1733 node = reader->curnode;
1734 else
1735 node = reader->node;
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001736
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001737 switch (node->type) {
1738 case XML_NAMESPACE_DECL:
1739 return(xmlStrdup(((xmlNsPtr) node)->href));
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001740 case XML_ATTRIBUTE_NODE:{
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001741 xmlAttrPtr attr = (xmlAttrPtr) node;
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001742
1743 if (attr->parent != NULL)
1744 return (xmlNodeListGetString
1745 (attr->parent->doc, attr->children, 1));
1746 else
1747 return (xmlNodeListGetString(NULL, attr->children, 1));
1748 break;
1749 }
1750 case XML_TEXT_NODE:
1751 case XML_CDATA_SECTION_NODE:
1752 case XML_PI_NODE:
1753 case XML_COMMENT_NODE:
Daniel Veillardda46d2d2002-12-15 23:36:49 +00001754 if (node->content != NULL)
1755 return (xmlStrdup(node->content));
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00001756 default:
1757 return(NULL);
1758 }
1759 return(NULL);
1760}
1761
1762/**
1763 * xmlTextReaderIsDefault:
1764 * @reader: the xmlTextReaderPtr used
1765 *
1766 * Whether an Attribute node was generated from the default value
1767 * defined in the DTD or schema.
1768 *
1769 * Returns 0 if not defaulted, 1 if defaulted, and -1 in case of error
1770 */
1771int
1772xmlTextReaderIsDefault(xmlTextReaderPtr reader) {
1773 if (reader == NULL)
1774 return(-1);
1775 return(0);
1776}
1777
1778/**
1779 * xmlTextReaderQuoteChar:
1780 * @reader: the xmlTextReaderPtr used
1781 *
1782 * The quotation mark character used to enclose the value of an attribute.
1783 *
1784 * Returns " or ' and -1 in case of error
1785 */
1786int
1787xmlTextReaderQuoteChar(xmlTextReaderPtr reader) {
1788 if (reader == NULL)
1789 return(-1);
1790 /* TODO maybe lookup the attribute value for " first */
1791 return((int) '"');
1792}
Daniel Veillarde1ca5032002-12-09 14:13:43 +00001793
1794/**
1795 * xmlTextReaderXmlLang:
1796 * @reader: the xmlTextReaderPtr used
1797 *
1798 * The xml:lang scope within which the node resides.
1799 *
1800 * Returns the xml:lang value or NULL if none exists.
1801 */
1802xmlChar *
1803xmlTextReaderXmlLang(xmlTextReaderPtr reader) {
1804 if (reader == NULL)
1805 return(NULL);
1806 if (reader->node == NULL)
1807 return(NULL);
1808 return(xmlNodeGetLang(reader->node));
1809}
1810
Daniel Veillard67df8092002-12-16 22:04:11 +00001811/**
1812 * xmlTextReaderNormalization:
1813 * @reader: the xmlTextReaderPtr used
1814 *
1815 * The value indicating whether to normalize white space and attribute values.
1816 * Since attribute value and end of line normalizations are a MUST in the XML
1817 * specification only the value true is accepted. The broken bahaviour of
1818 * accepting out of range character entities like &#0; is of course not
1819 * supported either.
1820 *
1821 * Returns 1 or -1 in case of error.
1822 */
1823int
1824xmlTextReaderNormalization(xmlTextReaderPtr reader) {
1825 if (reader == NULL)
1826 return(-1);
1827 return(1);
1828}
1829
Daniel Veillardbeb70bd2002-12-18 14:53:54 +00001830/************************************************************************
1831 * *
1832 * Extensions to the base APIs *
1833 * *
1834 ************************************************************************/
1835
1836/**
1837 * xmlTextReaderSetParserProp:
1838 * @reader: the xmlTextReaderPtr used
1839 * @prop: the xmlParserProperties to set
1840 * @value: usually 0 or 1 to (de)activate it
1841 *
1842 * Change the parser processing behaviour by changing some of its internal
1843 * properties. Note that some properties can only be changed before any
1844 * read has been done.
1845 *
1846 * Returns 0 if the call was successful, or -1 in case of error
1847 */
1848int
1849xmlTextReaderSetParserProp(xmlTextReaderPtr reader, int prop, int value) {
1850 xmlParserProperties p = (xmlParserProperties) prop;
1851 xmlParserCtxtPtr ctxt;
1852
1853 if ((reader == NULL) || (reader->ctxt == NULL))
1854 return(-1);
1855 ctxt = reader->ctxt;
1856
1857 switch (p) {
1858 case XML_PARSER_LOADDTD:
1859 if (value != 0) {
1860 if (ctxt->loadsubset == 0) {
1861 if (reader->mode != XML_TEXTREADER_MODE_INITIAL)
1862 return(-1);
1863 ctxt->loadsubset = XML_DETECT_IDS;
1864 }
1865 } else {
1866 ctxt->loadsubset = 0;
1867 }
1868 return(0);
1869 case XML_PARSER_DEFAULTATTRS:
1870 if (value != 0) {
1871 ctxt->loadsubset |= XML_COMPLETE_ATTRS;
1872 } else {
1873 if (ctxt->loadsubset & XML_COMPLETE_ATTRS)
1874 ctxt->loadsubset -= XML_COMPLETE_ATTRS;
1875 }
1876 return(0);
1877 case XML_PARSER_VALIDATE:
1878 if (value != 0) {
1879 ctxt->validate = 1;
1880 } else {
1881 ctxt->validate = 0;
1882 }
1883 return(0);
Daniel Veillarde18fc182002-12-28 22:56:33 +00001884 case XML_PARSER_SUBST_ENTITIES:
1885 if (value != 0) {
1886 ctxt->replaceEntities = 1;
1887 } else {
1888 ctxt->replaceEntities = 0;
1889 }
1890 return(0);
Daniel Veillardbeb70bd2002-12-18 14:53:54 +00001891 }
1892 return(-1);
1893}
1894
1895/**
1896 * xmlTextReaderGetParserProp:
1897 * @reader: the xmlTextReaderPtr used
1898 * @prop: the xmlParserProperties to get
1899 *
1900 * Read the parser internal property.
1901 *
1902 * Returns the value, usually 0 or 1, or -1 in case of error.
1903 */
1904int
1905xmlTextReaderGetParserProp(xmlTextReaderPtr reader, int prop) {
1906 xmlParserProperties p = (xmlParserProperties) prop;
1907 xmlParserCtxtPtr ctxt;
1908
1909 if ((reader == NULL) || (reader->ctxt == NULL))
1910 return(-1);
1911 ctxt = reader->ctxt;
1912
1913 switch (p) {
1914 case XML_PARSER_LOADDTD:
1915 if ((ctxt->loadsubset != 0) || (ctxt->validate != 0))
1916 return(1);
1917 return(0);
1918 case XML_PARSER_DEFAULTATTRS:
1919 if (ctxt->loadsubset & XML_COMPLETE_ATTRS)
1920 return(1);
1921 return(0);
1922 case XML_PARSER_VALIDATE:
1923 return(ctxt->validate);
Daniel Veillarde18fc182002-12-28 22:56:33 +00001924 case XML_PARSER_SUBST_ENTITIES:
1925 return(ctxt->replaceEntities);
Daniel Veillardbeb70bd2002-12-18 14:53:54 +00001926 }
1927 return(-1);
1928}
1929
Daniel Veillarde18fc182002-12-28 22:56:33 +00001930/**
1931 * xmlTextReaderCurrentNode:
1932 * @reader: the xmlTextReaderPtr used
1933 *
1934 * Hacking interface allowing to get the xmlNodePtr correponding to the
1935 * current node being accessed by the xmlTextReader. This is dangerous
1936 * because the underlying node may be destroyed on the next Reads.
1937 *
1938 * Returns the xmlNodePtr or NULL in case of error.
1939 */
1940xmlNodePtr
1941xmlTextReaderCurrentNode(xmlTextReaderPtr reader) {
1942 if (reader == NULL)
1943 return(NULL);
1944
1945 if (reader->curnode != NULL)
1946 return(reader->curnode);
1947 return(reader->node);
1948}
1949
1950/**
1951 * xmlTextReaderCurrentDoc:
1952 * @reader: the xmlTextReaderPtr used
1953 *
1954 * Hacking interface allowing to get the xmlDocPtr correponding to the
1955 * current document being accessed by the xmlTextReader. This is dangerous
1956 * because the associated node may be destroyed on the next Reads.
1957 *
1958 * Returns the xmlDocPtr or NULL in case of error.
1959 */
1960xmlDocPtr
1961xmlTextReaderCurrentDoc(xmlTextReaderPtr reader) {
1962 if ((reader == NULL) || (reader->ctxt == NULL))
1963 return(NULL);
1964
1965 return(reader->ctxt->myDoc);
1966}
1967
Daniel Veillardbeb70bd2002-12-18 14:53:54 +00001968/************************************************************************
1969 * *
1970 * Utilities *
1971 * *
1972 ************************************************************************/
1973/**
1974 * xmlBase64Decode:
1975 * @in: the input buffer
1976 * @inlen: the size of the input (in), the size read from it (out)
1977 * @to: the output buffer
1978 * @tolen: the size of the output (in), the size written to (out)
1979 *
1980 * Base64 decoder, reads from @in and save in @to
1981 *
1982 * Returns 0 if all the input was consumer, 1 if the Base64 end was reached,
1983 * 2 if there wasn't enough space on the output or -1 in case of error.
1984 */
1985static int
1986xmlBase64Decode(const unsigned char *in, unsigned long *inlen,
1987 unsigned char *to, unsigned long *tolen) {
1988 unsigned long incur; /* current index in in[] */
1989 unsigned long inblk; /* last block index in in[] */
1990 unsigned long outcur; /* current index in out[] */
1991 unsigned long inmax; /* size of in[] */
1992 unsigned long outmax; /* size of out[] */
1993 unsigned char cur; /* the current value read from in[] */
1994 unsigned char intmp[3], outtmp[4]; /* temporary buffers for the convert */
1995 int nbintmp; /* number of byte in intmp[] */
1996 int is_ignore; /* cur should be ignored */
1997 int is_end = 0; /* the end of the base64 was found */
1998 int retval = 1;
1999 int i;
2000
2001 if ((in == NULL) || (inlen == NULL) || (to == NULL) || (tolen == NULL))
2002 return(-1);
2003
2004 incur = 0;
2005 inblk = 0;
2006 outcur = 0;
2007 inmax = *inlen;
2008 outmax = *tolen;
2009 nbintmp = 0;
2010
2011 while (1) {
2012 if (incur >= inmax)
2013 break;
2014 cur = in[incur++];
2015 is_ignore = 0;
2016 if ((cur >= 'A') && (cur <= 'Z'))
2017 cur = cur - 'A';
2018 else if ((cur >= 'a') && (cur <= 'z'))
2019 cur = cur - 'a' + 26;
2020 else if ((cur >= '0') && (cur <= '9'))
2021 cur = cur - '0' + 52;
2022 else if (cur == '+')
2023 cur = 62;
2024 else if (cur == '/')
2025 cur = 63;
2026 else if (cur == '.')
2027 cur = 0;
2028 else if (cur == '=') /*no op , end of the base64 stream */
2029 is_end = 1;
2030 else {
2031 is_ignore = 1;
2032 if (nbintmp == 0)
2033 inblk = incur;
2034 }
2035
2036 if (!is_ignore) {
2037 int nbouttmp = 3;
2038 int is_break = 0;
2039
2040 if (is_end) {
2041 if (nbintmp == 0)
2042 break;
2043 if ((nbintmp == 1) || (nbintmp == 2))
2044 nbouttmp = 1;
2045 else
2046 nbouttmp = 2;
2047 nbintmp = 3;
2048 is_break = 1;
2049 }
2050 intmp[nbintmp++] = cur;
2051 /*
2052 * if intmp is full, push the 4byte sequence as a 3 byte
2053 * sequence out
2054 */
2055 if (nbintmp == 4) {
2056 nbintmp = 0;
2057 outtmp[0] = (intmp[0] << 2) | ((intmp[1] & 0x30) >> 4);
2058 outtmp[1] =
2059 ((intmp[1] & 0x0F) << 4) | ((intmp[2] & 0x3C) >> 2);
2060 outtmp[2] = ((intmp[2] & 0x03) << 6) | (intmp[3] & 0x3F);
2061 if (outcur + 3 >= outmax) {
2062 retval = 2;
2063 break;
2064 }
2065
2066 for (i = 0; i < nbouttmp; i++)
2067 to[outcur++] = outtmp[i];
2068 inblk = incur;
2069 }
2070
2071 if (is_break) {
2072 retval = 0;
2073 break;
2074 }
2075 }
2076 }
2077
2078 *tolen = outcur;
2079 *inlen = inblk;
2080 return (retval);
2081}
2082
2083/*
2084 * Test routine for the xmlBase64Decode function
2085 */
2086#if 0
2087int main(int argc, char **argv) {
2088 char *input = " VW4 gcGV0 \n aXQgdGVzdCAuCg== ";
2089 char output[100];
2090 char output2[100];
2091 char output3[100];
2092 unsigned long inlen = strlen(input);
2093 unsigned long outlen = 100;
2094 int ret;
2095 unsigned long cons, tmp, tmp2, prod;
2096
2097 /*
2098 * Direct
2099 */
2100 ret = xmlBase64Decode(input, &inlen, output, &outlen);
2101
2102 output[outlen] = 0;
2103 printf("ret: %d, inlen: %ld , outlen: %ld, output: '%s'\n", ret, inlen, outlen, output);
2104
2105 /*
2106 * output chunking
2107 */
2108 cons = 0;
2109 prod = 0;
2110 while (cons < inlen) {
2111 tmp = 5;
2112 tmp2 = inlen - cons;
2113
2114 printf("%ld %ld\n", cons, prod);
2115 ret = xmlBase64Decode(&input[cons], &tmp2, &output2[prod], &tmp);
2116 cons += tmp2;
2117 prod += tmp;
2118 printf("%ld %ld\n", cons, prod);
2119 }
2120 output2[outlen] = 0;
2121 printf("ret: %d, cons: %ld , prod: %ld, output: '%s'\n", ret, cons, prod, output2);
2122
2123 /*
2124 * input chunking
2125 */
2126 cons = 0;
2127 prod = 0;
2128 while (cons < inlen) {
2129 tmp = 100 - prod;
2130 tmp2 = inlen - cons;
2131 if (tmp2 > 5)
2132 tmp2 = 5;
2133
2134 printf("%ld %ld\n", cons, prod);
2135 ret = xmlBase64Decode(&input[cons], &tmp2, &output3[prod], &tmp);
2136 cons += tmp2;
2137 prod += tmp;
2138 printf("%ld %ld\n", cons, prod);
2139 }
2140 output3[outlen] = 0;
2141 printf("ret: %d, cons: %ld , prod: %ld, output: '%s'\n", ret, cons, prod, output3);
2142 return(0);
2143
2144}
2145#endif