Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 1 | /* |
| 2 | * parser.h : constants and stuff related to the XML parser. |
| 3 | * |
| 4 | * See Copyright for the status of this software. |
| 5 | * |
Daniel Veillard | 39a1f9a | 1999-01-17 19:11:59 +0000 | [diff] [blame] | 6 | * Daniel.Veillard@w3.org |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 7 | */ |
| 8 | |
| 9 | #ifndef __XML_PARSER_H__ |
| 10 | #define __XML_PARSER_H__ |
| 11 | |
| 12 | #include "tree.h" |
| 13 | |
| 14 | #ifdef __cplusplus |
| 15 | extern "C" { |
| 16 | #endif |
| 17 | |
| 18 | /* |
| 19 | * Constants. |
| 20 | */ |
| 21 | #define XML_DEFAULT_VERSION "1.0" |
| 22 | |
Daniel Veillard | d692aa4 | 1999-02-28 21:54:31 +0000 | [diff] [blame^] | 23 | typedef void (* xmlParserInputDeallocate)(CHAR *); |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 24 | typedef struct xmlParserInput { |
| 25 | const char *filename; /* The file analyzed, if any */ |
| 26 | const CHAR *base; /* Base of the array to parse */ |
| 27 | const CHAR *cur; /* Current char being parsed */ |
| 28 | int line; /* Current line */ |
| 29 | int col; /* Current column */ |
Daniel Veillard | d692aa4 | 1999-02-28 21:54:31 +0000 | [diff] [blame^] | 30 | xmlParserInputDeallocate free; /* function to deallocate the base */ |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 31 | } xmlParserInput; |
| 32 | typedef xmlParserInput *xmlParserInputPtr; |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 33 | |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 34 | typedef struct _xmlParserNodeInfo { |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 35 | const struct xmlNode* node; |
| 36 | /* Position & line # that text that created the node begins & ends on */ |
| 37 | unsigned long begin_pos; |
| 38 | unsigned long begin_line; |
| 39 | unsigned long end_pos; |
| 40 | unsigned long end_line; |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 41 | } _xmlParserNodeInfo; |
| 42 | typedef _xmlParserNodeInfo xmlParserNodeInfo; |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 43 | |
| 44 | typedef struct xmlParserNodeInfoSeq { |
| 45 | unsigned long maximum; |
| 46 | unsigned long length; |
| 47 | xmlParserNodeInfo* buffer; |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 48 | } _xmlParserNodeInfoSeq; |
| 49 | typedef _xmlParserNodeInfoSeq xmlParserNodeInfoSeq; |
| 50 | typedef xmlParserNodeInfoSeq *xmlParserNodeInfoSeqPtr; |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 51 | |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 52 | typedef struct _xmlParserCtxt { |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 53 | struct xmlSAXHandler *sax; /* The SAX handler */ |
| 54 | xmlDocPtr doc; /* the document being built */ |
Daniel Veillard | 39a1f9a | 1999-01-17 19:11:59 +0000 | [diff] [blame] | 55 | int wellFormed; /* is the document well formed */ |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 56 | |
| 57 | /* Input stream stack */ |
| 58 | xmlParserInputPtr input; /* Current input stream */ |
| 59 | int inputNr; /* Number of current input streams */ |
| 60 | int inputMax; /* Max number of input streams */ |
| 61 | xmlParserInputPtr *inputTab; /* stack of inputs */ |
| 62 | |
| 63 | /* Node analysis stack */ |
| 64 | xmlNodePtr node; /* Current parsed Node */ |
| 65 | int nodeNr; /* Depth of the parsing stack */ |
| 66 | int nodeMax; /* Max depth of the parsing stack */ |
| 67 | xmlNodePtr *nodeTab; /* array of nodes */ |
| 68 | |
| 69 | int record_info; /* Whether node info should be kept */ |
| 70 | xmlParserNodeInfoSeq node_seq; /* info about each node parsed */ |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 71 | } _xmlParserCtxt; |
| 72 | typedef _xmlParserCtxt xmlParserCtxt; |
| 73 | typedef xmlParserCtxt *xmlParserCtxtPtr; |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 74 | |
| 75 | /* |
| 76 | * a SAX Locator. |
| 77 | */ |
| 78 | |
| 79 | typedef struct xmlSAXLocator { |
| 80 | const CHAR *(*getPublicId)(xmlParserCtxtPtr ctxt); |
| 81 | const CHAR *(*getSystemId)(xmlParserCtxtPtr ctxt); |
| 82 | int (*getLineNumber)(xmlParserCtxtPtr ctxt); |
| 83 | int (*getColumnNumber)(xmlParserCtxtPtr ctxt); |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 84 | } _xmlSAXLocator; |
| 85 | typedef _xmlSAXLocator xmlSAXLocator; |
| 86 | typedef xmlSAXLocator *xmlSAXLocatorPtr; |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 87 | |
| 88 | /* |
| 89 | * a SAX Exception. |
| 90 | */ |
| 91 | |
| 92 | typedef xmlParserInputPtr (*resolveEntitySAXFunc) (xmlParserCtxtPtr ctxt, |
| 93 | const CHAR *publicId, const CHAR *systemId); |
| 94 | typedef void (*notationDeclSAXFunc)(xmlParserCtxtPtr ctxt, const CHAR *name, |
| 95 | const CHAR *publicId, const CHAR *systemId); |
| 96 | typedef void (*unparsedEntityDeclSAXFunc)(xmlParserCtxtPtr ctxt, |
| 97 | const CHAR *name, const CHAR *publicId, |
| 98 | const CHAR *systemId, const CHAR *notationName); |
| 99 | typedef void (*setDocumentLocatorSAXFunc) (xmlParserCtxtPtr ctxt, |
| 100 | xmlSAXLocatorPtr loc); |
| 101 | typedef void (*startDocumentSAXFunc) (xmlParserCtxtPtr ctxt); |
| 102 | typedef void (*endDocumentSAXFunc) (xmlParserCtxtPtr ctxt); |
| 103 | typedef void (*startElementSAXFunc) (xmlParserCtxtPtr ctxt, const CHAR *name); |
| 104 | typedef void (*endElementSAXFunc) (xmlParserCtxtPtr ctxt, const CHAR *name); |
Daniel Veillard | 11e0058 | 1998-10-24 18:27:49 +0000 | [diff] [blame] | 105 | typedef void (*attributeSAXFunc) (xmlParserCtxtPtr ctxt, const CHAR *name, |
| 106 | const CHAR *value); |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 107 | typedef void (*charactersSAXFunc) (xmlParserCtxtPtr ctxt, const CHAR *ch, |
| 108 | int start, int len); |
| 109 | typedef void (*ignorableWhitespaceSAXFunc) (xmlParserCtxtPtr ctxt, |
| 110 | const CHAR *ch, int start, int len); |
| 111 | typedef void (*processingInstructionSAXFunc) (xmlParserCtxtPtr ctxt, |
| 112 | const CHAR *target, const CHAR *data); |
| 113 | typedef void (*warningSAXFunc) (xmlParserCtxtPtr ctxt, const char *msg, ...); |
| 114 | typedef void (*errorSAXFunc) (xmlParserCtxtPtr ctxt, const char *msg, ...); |
| 115 | typedef void (*fatalErrorSAXFunc) (xmlParserCtxtPtr ctxt, const char *msg, ...); |
| 116 | |
| 117 | typedef struct xmlSAXHandler { |
| 118 | resolveEntitySAXFunc resolveEntity; |
| 119 | notationDeclSAXFunc notationDecl; |
| 120 | unparsedEntityDeclSAXFunc unparsedEntityDecl; |
| 121 | setDocumentLocatorSAXFunc setDocumentLocator; |
| 122 | startDocumentSAXFunc startDocument; |
| 123 | endDocumentSAXFunc endDocument; |
| 124 | startElementSAXFunc startElement; |
| 125 | endElementSAXFunc endElement; |
Daniel Veillard | 11e0058 | 1998-10-24 18:27:49 +0000 | [diff] [blame] | 126 | attributeSAXFunc attribute; |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 127 | charactersSAXFunc characters; |
| 128 | ignorableWhitespaceSAXFunc ignorableWhitespace; |
| 129 | processingInstructionSAXFunc processingInstruction; |
| 130 | warningSAXFunc warning; |
| 131 | errorSAXFunc error; |
| 132 | fatalErrorSAXFunc fatalError; |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 133 | } xmlSAXHandler; |
| 134 | typedef xmlSAXHandler *xmlSAXHandlerPtr; |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 135 | |
| 136 | /* |
| 137 | * Global variables: just the SAX interface tables we are looking for full |
| 138 | * reentrancy of the code ! |
| 139 | */ |
Daniel Veillard | 151b1b0 | 1998-09-23 00:49:46 +0000 | [diff] [blame] | 140 | extern xmlSAXLocator xmlDefaultSAXLocator; |
| 141 | extern xmlSAXHandler xmlDefaultSAXHandler; |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 142 | |
Daniel Veillard | ccb0963 | 1998-10-27 06:21:04 +0000 | [diff] [blame] | 143 | #include "entities.h" |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 144 | #include "error.h" |
Daniel Veillard | ccb0963 | 1998-10-27 06:21:04 +0000 | [diff] [blame] | 145 | |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 146 | /* |
Daniel Veillard | 39a1f9a | 1999-01-17 19:11:59 +0000 | [diff] [blame] | 147 | * CHAR handling |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 148 | */ |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 149 | CHAR *xmlStrdup(const CHAR *cur); |
| 150 | CHAR *xmlStrndup(const CHAR *cur, int len); |
| 151 | CHAR *xmlStrchr(const CHAR *str, CHAR val); |
| 152 | int xmlStrcmp(const CHAR *str1, const CHAR *str2); |
| 153 | int xmlStrncmp(const CHAR *str1, const CHAR *str2, int len); |
| 154 | int xmlStrlen(const CHAR *str); |
| 155 | CHAR *xmlStrcat(CHAR *cur, const CHAR *add); |
| 156 | CHAR *xmlStrncat(CHAR *cur, const CHAR *add, int len); |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 157 | |
Daniel Veillard | 39a1f9a | 1999-01-17 19:11:59 +0000 | [diff] [blame] | 158 | /* |
| 159 | * Interfaces |
| 160 | */ |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 161 | xmlDocPtr xmlParseDoc(CHAR *cur); |
| 162 | xmlDocPtr xmlParseMemory(char *buffer, int size); |
| 163 | xmlDocPtr xmlParseFile(const char *filename); |
Daniel Veillard | 39a1f9a | 1999-01-17 19:11:59 +0000 | [diff] [blame] | 164 | |
| 165 | /* |
| 166 | * Recovery mode |
| 167 | */ |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 168 | xmlDocPtr xmlRecoverDoc(CHAR *cur); |
| 169 | xmlDocPtr xmlRecoverMemory(char *buffer, int size); |
| 170 | xmlDocPtr xmlRecoverFile(const char *filename); |
Daniel Veillard | 39a1f9a | 1999-01-17 19:11:59 +0000 | [diff] [blame] | 171 | |
| 172 | /* |
| 173 | * Internal routines |
| 174 | */ |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 175 | int xmlParseDocument(xmlParserCtxtPtr ctxt); |
| 176 | xmlDocPtr xmlSAXParseDoc(xmlSAXHandlerPtr sax, CHAR *cur, int recovery); |
| 177 | xmlDocPtr xmlSAXParseMemory(xmlSAXHandlerPtr sax, char *buffer, |
Daniel Veillard | 39a1f9a | 1999-01-17 19:11:59 +0000 | [diff] [blame] | 178 | int size, int recovery); |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 179 | xmlDocPtr xmlSAXParseFile(xmlSAXHandlerPtr sax, const char *filename, |
Daniel Veillard | 39a1f9a | 1999-01-17 19:11:59 +0000 | [diff] [blame] | 180 | int recovery); |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 181 | void xmlInitParserCtxt(xmlParserCtxtPtr ctxt); |
| 182 | void xmlClearParserCtxt(xmlParserCtxtPtr ctxt); |
| 183 | void xmlSetupParserForBuffer(xmlParserCtxtPtr ctxt, const CHAR* buffer, |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 184 | const char* filename); |
| 185 | |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 186 | const xmlParserNodeInfo* xmlParserFindNodeInfo(const xmlParserCtxt* ctxt, |
| 187 | const xmlNode* node); |
| 188 | void xmlInitNodeInfoSeq(xmlParserNodeInfoSeqPtr seq); |
| 189 | void xmlClearNodeInfoSeq(xmlParserNodeInfoSeqPtr seq); |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 190 | unsigned long xmlParserFindNodeInfoIndex(const xmlParserNodeInfoSeq* seq, |
| 191 | const xmlNode* node); |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 192 | void xmlParserAddNodeInfo(xmlParserCtxtPtr ctxt, |
| 193 | const xmlParserNodeInfo* info); |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 194 | |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 195 | void xmlDefaultSAXHandlerInit(void); |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 196 | #ifdef __cplusplus |
| 197 | } |
| 198 | #endif |
| 199 | |
| 200 | #endif /* __XML_PARSER_H__ */ |
| 201 | |