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> |
Daniel Veillard | 33300b4 | 2003-04-17 09:09:19 +0000 | [diff] [blame] | 14 | #ifdef LIBXML_SCHEMAS_ENABLED |
| 15 | #include <libxml/relaxng.h> |
| 16 | #endif |
Daniel Veillard | e1ca503 | 2002-12-09 14:13:43 +0000 | [diff] [blame] | 17 | |
| 18 | #ifdef __cplusplus |
| 19 | extern "C" { |
| 20 | #endif |
| 21 | |
Daniel Veillard | beb70bd | 2002-12-18 14:53:54 +0000 | [diff] [blame] | 22 | typedef enum { |
| 23 | XML_PARSER_LOADDTD = 1, |
Daniel Veillard | e18fc18 | 2002-12-28 22:56:33 +0000 | [diff] [blame] | 24 | XML_PARSER_DEFAULTATTRS = 2, |
| 25 | XML_PARSER_VALIDATE = 3, |
| 26 | XML_PARSER_SUBST_ENTITIES = 4 |
Daniel Veillard | beb70bd | 2002-12-18 14:53:54 +0000 | [diff] [blame] | 27 | } xmlParserProperties; |
| 28 | |
Daniel Veillard | 26f7026 | 2003-01-16 22:45:08 +0000 | [diff] [blame] | 29 | typedef enum { |
Daniel Veillard | 417be3a | 2003-01-20 21:26:34 +0000 | [diff] [blame] | 30 | XML_PARSER_SEVERITY_VALIDITY_WARNING = 1, |
| 31 | XML_PARSER_SEVERITY_VALIDITY_ERROR = 2, |
| 32 | XML_PARSER_SEVERITY_WARNING = 3, |
| 33 | XML_PARSER_SEVERITY_ERROR = 4 |
| 34 | } xmlParserSeverities; |
Daniel Veillard | 26f7026 | 2003-01-16 22:45:08 +0000 | [diff] [blame] | 35 | |
Daniel Veillard | d6038e0 | 2003-07-30 16:37:18 +0000 | [diff] [blame^] | 36 | enum { |
| 37 | XML_READER_TYPE_NONE = 0, |
| 38 | XML_READER_TYPE_ELEMENT = 1, |
| 39 | XML_READER_TYPE_ATTRIBUTE = 2, |
| 40 | XML_READER_TYPE_TEXT = 3, |
| 41 | XML_READER_TYPE_CDATA = 4, |
| 42 | XML_READER_TYPE_ENTITY_REFERENCE = 5, |
| 43 | XML_READER_TYPE_ENTITY = 6, |
| 44 | XML_READER_TYPE_PROCESSING_INSTRUCTION = 7, |
| 45 | XML_READER_TYPE_COMMENT = 8, |
| 46 | XML_READER_TYPE_DOCUMENT = 9, |
| 47 | XML_READER_TYPE_DOCUMENT_TYPE = 10, |
| 48 | XML_READER_TYPE_DOCUMENT_FRAGMENT = 11, |
| 49 | XML_READER_TYPE_NOTATION = 12, |
| 50 | XML_READER_TYPE_WHITESPACE = 13, |
| 51 | XML_READER_TYPE_SIGNIFICANT_WHITESPACE = 14, |
| 52 | XML_READER_TYPE_END_ELEMENT = 15, |
| 53 | XML_READER_TYPE_END_ENTITY = 16, |
| 54 | XML_READER_TYPE_XML_DECLARATION = 17 |
| 55 | }; |
| 56 | |
Daniel Veillard | e1ca503 | 2002-12-09 14:13:43 +0000 | [diff] [blame] | 57 | typedef struct _xmlTextReader xmlTextReader; |
| 58 | typedef xmlTextReader *xmlTextReaderPtr; |
| 59 | |
| 60 | /* |
| 61 | * Constructors & Destructor |
| 62 | */ |
Daniel Veillard | ea7751d | 2002-12-20 00:16:24 +0000 | [diff] [blame] | 63 | xmlTextReaderPtr xmlNewTextReader (xmlParserInputBufferPtr input, |
| 64 | const char *URI); |
Daniel Veillard | e1ca503 | 2002-12-09 14:13:43 +0000 | [diff] [blame] | 65 | xmlTextReaderPtr xmlNewTextReaderFilename(const char *URI); |
| 66 | void xmlFreeTextReader (xmlTextReaderPtr reader); |
| 67 | |
| 68 | /* |
| 69 | * Iterators |
| 70 | */ |
| 71 | int xmlTextReaderRead (xmlTextReaderPtr reader); |
Daniel Veillard | 67df809 | 2002-12-16 22:04:11 +0000 | [diff] [blame] | 72 | xmlChar * xmlTextReaderReadInnerXml (xmlTextReaderPtr reader); |
| 73 | xmlChar * xmlTextReaderReadOuterXml (xmlTextReaderPtr reader); |
| 74 | xmlChar * xmlTextReaderReadString (xmlTextReaderPtr reader); |
Daniel Veillard | beb70bd | 2002-12-18 14:53:54 +0000 | [diff] [blame] | 75 | int xmlTextReaderReadAttributeValue (xmlTextReaderPtr reader); |
Daniel Veillard | e1ca503 | 2002-12-09 14:13:43 +0000 | [diff] [blame] | 76 | |
| 77 | /* |
| 78 | * Attributes of the node |
| 79 | */ |
| 80 | int xmlTextReaderAttributeCount(xmlTextReaderPtr reader); |
| 81 | xmlChar * xmlTextReaderBaseUri (xmlTextReaderPtr reader); |
| 82 | int xmlTextReaderDepth (xmlTextReaderPtr reader); |
| 83 | int xmlTextReaderHasAttributes(xmlTextReaderPtr reader); |
| 84 | int xmlTextReaderHasValue(xmlTextReaderPtr reader); |
| 85 | int xmlTextReaderIsDefault (xmlTextReaderPtr reader); |
| 86 | int xmlTextReaderIsEmptyElement(xmlTextReaderPtr reader); |
| 87 | xmlChar * xmlTextReaderLocalName (xmlTextReaderPtr reader); |
| 88 | xmlChar * xmlTextReaderName (xmlTextReaderPtr reader); |
| 89 | xmlChar * xmlTextReaderNamespaceUri(xmlTextReaderPtr reader); |
| 90 | int xmlTextReaderNodeType (xmlTextReaderPtr reader); |
| 91 | xmlChar * xmlTextReaderPrefix (xmlTextReaderPtr reader); |
| 92 | int xmlTextReaderQuoteChar (xmlTextReaderPtr reader); |
| 93 | xmlChar * xmlTextReaderValue (xmlTextReaderPtr reader); |
| 94 | xmlChar * xmlTextReaderXmlLang (xmlTextReaderPtr reader); |
Daniel Veillard | 67df809 | 2002-12-16 22:04:11 +0000 | [diff] [blame] | 95 | int xmlTextReaderReadState (xmlTextReaderPtr reader); |
Daniel Veillard | 0eb38c7 | 2002-12-14 23:00:35 +0000 | [diff] [blame] | 96 | |
| 97 | /* |
| 98 | * Methods of the XmlTextReader |
| 99 | */ |
| 100 | int xmlTextReaderClose (xmlTextReaderPtr reader); |
| 101 | xmlChar * xmlTextReaderGetAttributeNo (xmlTextReaderPtr reader, |
| 102 | int no); |
| 103 | xmlChar * xmlTextReaderGetAttribute (xmlTextReaderPtr reader, |
| 104 | const xmlChar *name); |
| 105 | xmlChar * xmlTextReaderGetAttributeNs (xmlTextReaderPtr reader, |
| 106 | const xmlChar *localName, |
| 107 | const xmlChar *namespaceURI); |
Daniel Veillard | da46d2d | 2002-12-15 23:36:49 +0000 | [diff] [blame] | 108 | xmlParserInputBufferPtr xmlTextReaderGetRemainder(xmlTextReaderPtr reader); |
| 109 | xmlChar * xmlTextReaderLookupNamespace (xmlTextReaderPtr reader, |
| 110 | const xmlChar *prefix); |
| 111 | int xmlTextReaderMoveToAttributeNo (xmlTextReaderPtr reader, |
| 112 | int no); |
| 113 | int xmlTextReaderMoveToAttribute (xmlTextReaderPtr reader, |
| 114 | const xmlChar *name); |
| 115 | int xmlTextReaderMoveToAttributeNs (xmlTextReaderPtr reader, |
| 116 | const xmlChar *localName, |
| 117 | const xmlChar *namespaceURI); |
| 118 | int xmlTextReaderMoveToFirstAttribute(xmlTextReaderPtr reader); |
| 119 | int xmlTextReaderMoveToNextAttribute(xmlTextReaderPtr reader); |
| 120 | int xmlTextReaderMoveToElement (xmlTextReaderPtr reader); |
Daniel Veillard | 67df809 | 2002-12-16 22:04:11 +0000 | [diff] [blame] | 121 | int xmlTextReaderNormalization (xmlTextReaderPtr reader); |
Daniel Veillard | da46d2d | 2002-12-15 23:36:49 +0000 | [diff] [blame] | 122 | |
Daniel Veillard | beb70bd | 2002-12-18 14:53:54 +0000 | [diff] [blame] | 123 | /* |
| 124 | * Extensions |
| 125 | */ |
| 126 | int xmlTextReaderSetParserProp (xmlTextReaderPtr reader, |
| 127 | int prop, |
| 128 | int value); |
| 129 | int xmlTextReaderGetParserProp (xmlTextReaderPtr reader, |
| 130 | int prop); |
Daniel Veillard | e18fc18 | 2002-12-28 22:56:33 +0000 | [diff] [blame] | 131 | xmlNodePtr xmlTextReaderCurrentNode (xmlTextReaderPtr reader); |
| 132 | xmlDocPtr xmlTextReaderCurrentDoc (xmlTextReaderPtr reader); |
Daniel Veillard | c6cae7b | 2003-04-11 09:02:11 +0000 | [diff] [blame] | 133 | xmlNodePtr xmlTextReaderExpand (xmlTextReaderPtr reader); |
| 134 | int xmlTextReaderNext (xmlTextReaderPtr reader); |
Daniel Veillard | f6bad79 | 2003-04-11 19:38:54 +0000 | [diff] [blame] | 135 | int xmlTextReaderIsValid (xmlTextReaderPtr reader); |
Daniel Veillard | f4e5576 | 2003-04-15 23:32:22 +0000 | [diff] [blame] | 136 | #ifdef LIBXML_SCHEMAS_ENABLED |
| 137 | int xmlTextReaderRelaxNGValidate (xmlTextReaderPtr reader, |
| 138 | const char *rng); |
Daniel Veillard | 33300b4 | 2003-04-17 09:09:19 +0000 | [diff] [blame] | 139 | int xmlTextReaderRelaxNGSetSchema (xmlTextReaderPtr reader, |
| 140 | xmlRelaxNGPtr schema); |
Daniel Veillard | f4e5576 | 2003-04-15 23:32:22 +0000 | [diff] [blame] | 141 | #endif |
Daniel Veillard | 26f7026 | 2003-01-16 22:45:08 +0000 | [diff] [blame] | 142 | |
| 143 | /* |
| 144 | * Error handling extensions |
| 145 | */ |
Daniel Veillard | 417be3a | 2003-01-20 21:26:34 +0000 | [diff] [blame] | 146 | typedef void * xmlTextReaderLocatorPtr; |
| 147 | typedef void (*xmlTextReaderErrorFunc) (void *arg, |
Daniel Veillard | 26f7026 | 2003-01-16 22:45:08 +0000 | [diff] [blame] | 148 | const char *msg, |
Daniel Veillard | 417be3a | 2003-01-20 21:26:34 +0000 | [diff] [blame] | 149 | xmlParserSeverities severity, |
| 150 | xmlTextReaderLocatorPtr locator); |
| 151 | int xmlTextReaderLocatorLineNumber (xmlTextReaderLocatorPtr locator); |
| 152 | /*int xmlTextReaderLocatorLinePosition(xmlTextReaderLocatorPtr locator);*/ |
| 153 | xmlChar * xmlTextReaderLocatorBaseURI (xmlTextReaderLocatorPtr locator); |
Daniel Veillard | 26f7026 | 2003-01-16 22:45:08 +0000 | [diff] [blame] | 154 | void xmlTextReaderSetErrorHandler (xmlTextReaderPtr reader, |
| 155 | xmlTextReaderErrorFunc f, |
| 156 | void *arg); |
| 157 | void xmlTextReaderGetErrorHandler (xmlTextReaderPtr reader, |
| 158 | xmlTextReaderErrorFunc *f, |
| 159 | void **arg); |
| 160 | |
Daniel Veillard | e1ca503 | 2002-12-09 14:13:43 +0000 | [diff] [blame] | 161 | #ifdef __cplusplus |
| 162 | } |
| 163 | #endif |
| 164 | #endif /* __XML_XMLREADER_H__ */ |
| 165 | |