Daniel Veillard | e1ca503 | 2002-12-09 14:13:43 +0000 | [diff] [blame] | 1 | /* |
| 2 | * xmlreader.h : Interfaces, constants and types of the XML streaming API. |
| 3 | * |
| 4 | * See Copyright for the status of this software. |
| 5 | * |
| 6 | * daniel@veillard.com |
| 7 | */ |
| 8 | |
| 9 | #ifndef __XML_XMLREADER_H__ |
| 10 | #define __XML_XMLREADER_H__ |
| 11 | |
| 12 | #include <libxml/tree.h> |
| 13 | #include <libxml/xmlIO.h> |
| 14 | |
| 15 | #ifdef __cplusplus |
| 16 | extern "C" { |
| 17 | #endif |
| 18 | |
Daniel Veillard | beb70bd | 2002-12-18 14:53:54 +0000 | [diff] [blame] | 19 | typedef enum { |
| 20 | XML_PARSER_LOADDTD = 1, |
Daniel Veillard | e18fc18 | 2002-12-28 22:56:33 +0000 | [diff] [blame^] | 21 | XML_PARSER_DEFAULTATTRS = 2, |
| 22 | XML_PARSER_VALIDATE = 3, |
| 23 | XML_PARSER_SUBST_ENTITIES = 4 |
Daniel Veillard | beb70bd | 2002-12-18 14:53:54 +0000 | [diff] [blame] | 24 | } xmlParserProperties; |
| 25 | |
Daniel Veillard | e1ca503 | 2002-12-09 14:13:43 +0000 | [diff] [blame] | 26 | typedef struct _xmlTextReader xmlTextReader; |
| 27 | typedef xmlTextReader *xmlTextReaderPtr; |
| 28 | |
| 29 | /* |
| 30 | * Constructors & Destructor |
| 31 | */ |
Daniel Veillard | ea7751d | 2002-12-20 00:16:24 +0000 | [diff] [blame] | 32 | xmlTextReaderPtr xmlNewTextReader (xmlParserInputBufferPtr input, |
| 33 | const char *URI); |
Daniel Veillard | e1ca503 | 2002-12-09 14:13:43 +0000 | [diff] [blame] | 34 | xmlTextReaderPtr xmlNewTextReaderFilename(const char *URI); |
| 35 | void xmlFreeTextReader (xmlTextReaderPtr reader); |
| 36 | |
| 37 | /* |
| 38 | * Iterators |
| 39 | */ |
| 40 | int xmlTextReaderRead (xmlTextReaderPtr reader); |
Daniel Veillard | 67df809 | 2002-12-16 22:04:11 +0000 | [diff] [blame] | 41 | xmlChar * xmlTextReaderReadInnerXml (xmlTextReaderPtr reader); |
| 42 | xmlChar * xmlTextReaderReadOuterXml (xmlTextReaderPtr reader); |
| 43 | xmlChar * xmlTextReaderReadString (xmlTextReaderPtr reader); |
Daniel Veillard | beb70bd | 2002-12-18 14:53:54 +0000 | [diff] [blame] | 44 | int xmlTextReaderReadAttributeValue (xmlTextReaderPtr reader); |
Daniel Veillard | e1ca503 | 2002-12-09 14:13:43 +0000 | [diff] [blame] | 45 | |
| 46 | /* |
| 47 | * Attributes of the node |
| 48 | */ |
| 49 | int xmlTextReaderAttributeCount(xmlTextReaderPtr reader); |
| 50 | xmlChar * xmlTextReaderBaseUri (xmlTextReaderPtr reader); |
| 51 | int xmlTextReaderDepth (xmlTextReaderPtr reader); |
| 52 | int xmlTextReaderHasAttributes(xmlTextReaderPtr reader); |
| 53 | int xmlTextReaderHasValue(xmlTextReaderPtr reader); |
| 54 | int xmlTextReaderIsDefault (xmlTextReaderPtr reader); |
| 55 | int xmlTextReaderIsEmptyElement(xmlTextReaderPtr reader); |
| 56 | xmlChar * xmlTextReaderLocalName (xmlTextReaderPtr reader); |
| 57 | xmlChar * xmlTextReaderName (xmlTextReaderPtr reader); |
| 58 | xmlChar * xmlTextReaderNamespaceUri(xmlTextReaderPtr reader); |
| 59 | int xmlTextReaderNodeType (xmlTextReaderPtr reader); |
| 60 | xmlChar * xmlTextReaderPrefix (xmlTextReaderPtr reader); |
| 61 | int xmlTextReaderQuoteChar (xmlTextReaderPtr reader); |
| 62 | xmlChar * xmlTextReaderValue (xmlTextReaderPtr reader); |
| 63 | xmlChar * xmlTextReaderXmlLang (xmlTextReaderPtr reader); |
Daniel Veillard | 67df809 | 2002-12-16 22:04:11 +0000 | [diff] [blame] | 64 | int xmlTextReaderReadState (xmlTextReaderPtr reader); |
Daniel Veillard | 0eb38c7 | 2002-12-14 23:00:35 +0000 | [diff] [blame] | 65 | |
| 66 | /* |
| 67 | * Methods of the XmlTextReader |
| 68 | */ |
| 69 | int xmlTextReaderClose (xmlTextReaderPtr reader); |
| 70 | xmlChar * xmlTextReaderGetAttributeNo (xmlTextReaderPtr reader, |
| 71 | int no); |
| 72 | xmlChar * xmlTextReaderGetAttribute (xmlTextReaderPtr reader, |
| 73 | const xmlChar *name); |
| 74 | xmlChar * xmlTextReaderGetAttributeNs (xmlTextReaderPtr reader, |
| 75 | const xmlChar *localName, |
| 76 | const xmlChar *namespaceURI); |
Daniel Veillard | da46d2d | 2002-12-15 23:36:49 +0000 | [diff] [blame] | 77 | xmlParserInputBufferPtr xmlTextReaderGetRemainder(xmlTextReaderPtr reader); |
| 78 | xmlChar * xmlTextReaderLookupNamespace (xmlTextReaderPtr reader, |
| 79 | const xmlChar *prefix); |
| 80 | int xmlTextReaderMoveToAttributeNo (xmlTextReaderPtr reader, |
| 81 | int no); |
| 82 | int xmlTextReaderMoveToAttribute (xmlTextReaderPtr reader, |
| 83 | const xmlChar *name); |
| 84 | int xmlTextReaderMoveToAttributeNs (xmlTextReaderPtr reader, |
| 85 | const xmlChar *localName, |
| 86 | const xmlChar *namespaceURI); |
| 87 | int xmlTextReaderMoveToFirstAttribute(xmlTextReaderPtr reader); |
| 88 | int xmlTextReaderMoveToNextAttribute(xmlTextReaderPtr reader); |
| 89 | int xmlTextReaderMoveToElement (xmlTextReaderPtr reader); |
Daniel Veillard | 67df809 | 2002-12-16 22:04:11 +0000 | [diff] [blame] | 90 | int xmlTextReaderNormalization (xmlTextReaderPtr reader); |
Daniel Veillard | da46d2d | 2002-12-15 23:36:49 +0000 | [diff] [blame] | 91 | |
Daniel Veillard | beb70bd | 2002-12-18 14:53:54 +0000 | [diff] [blame] | 92 | /* |
| 93 | * Extensions |
| 94 | */ |
| 95 | int xmlTextReaderSetParserProp (xmlTextReaderPtr reader, |
| 96 | int prop, |
| 97 | int value); |
| 98 | int xmlTextReaderGetParserProp (xmlTextReaderPtr reader, |
| 99 | int prop); |
Daniel Veillard | e18fc18 | 2002-12-28 22:56:33 +0000 | [diff] [blame^] | 100 | xmlNodePtr xmlTextReaderCurrentNode (xmlTextReaderPtr reader); |
| 101 | xmlDocPtr xmlTextReaderCurrentDoc (xmlTextReaderPtr reader); |
Daniel Veillard | e1ca503 | 2002-12-09 14:13:43 +0000 | [diff] [blame] | 102 | #ifdef __cplusplus |
| 103 | } |
| 104 | #endif |
| 105 | #endif /* __XML_XMLREADER_H__ */ |
| 106 | |