expat.h
上传用户:hmc_gdtv
上传日期:2013-08-04
资源大小:798k
文件大小:37k
源码类别:

Windows Mobile

开发平台:

Visual C++

  1. /* Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center Ltd
  2.    See the file COPYING for copying permission.
  3. */
  4. #ifndef XmlParse_INCLUDED
  5. #define XmlParse_INCLUDED 1
  6. #ifdef __VMS
  7. /*      0        1         2         3      0        1         2         3
  8.         1234567890123456789012345678901     1234567890123456789012345678901 */
  9. #define XML_SetProcessingInstructionHandler XML_SetProcessingInstrHandler
  10. #define XML_SetUnparsedEntityDeclHandler    XML_SetUnparsedEntDeclHandler
  11. #define XML_SetStartNamespaceDeclHandler    XML_SetStartNamespcDeclHandler
  12. #define XML_SetExternalEntityRefHandlerArg  XML_SetExternalEntRefHandlerArg
  13. #endif
  14. #include <stdlib.h>
  15. #include "winconfig.h"
  16. #define XMLPARSEAPI(type) type
  17. #ifdef __cplusplus
  18. extern "C" {
  19. #endif
  20. #ifdef XML_UNICODE_WCHAR_T
  21. #define XML_UNICODE
  22. #endif
  23. struct XML_ParserStruct;
  24. typedef struct XML_ParserStruct *XML_Parser;
  25. #ifdef XML_UNICODE     /* Information is UTF-16 encoded. */
  26. #ifdef XML_UNICODE_WCHAR_T
  27. typedef wchar_t XML_Char;
  28. typedef wchar_t XML_LChar;
  29. #else
  30. typedef unsigned short XML_Char;
  31. typedef char XML_LChar;
  32. #endif /* XML_UNICODE_WCHAR_T */
  33. #else                  /* Information is UTF-8 encoded. */
  34. typedef char XML_Char;
  35. typedef char XML_LChar;
  36. #endif /* XML_UNICODE */
  37. /* Should this be defined using stdbool.h when C99 is available? */
  38. typedef unsigned char XML_Bool;
  39. #define XML_TRUE   ((XML_Bool) 1)
  40. #define XML_FALSE  ((XML_Bool) 0)
  41. enum XML_Error {
  42.   XML_ERROR_NONE,
  43.   XML_ERROR_NO_MEMORY,
  44.   XML_ERROR_SYNTAX,
  45.   XML_ERROR_NO_ELEMENTS,
  46.   XML_ERROR_INVALID_TOKEN,
  47.   XML_ERROR_UNCLOSED_TOKEN,
  48.   XML_ERROR_PARTIAL_CHAR,
  49.   XML_ERROR_TAG_MISMATCH,
  50.   XML_ERROR_DUPLICATE_ATTRIBUTE,
  51.   XML_ERROR_JUNK_AFTER_DOC_ELEMENT,
  52.   XML_ERROR_PARAM_ENTITY_REF,
  53.   XML_ERROR_UNDEFINED_ENTITY,
  54.   XML_ERROR_RECURSIVE_ENTITY_REF,
  55.   XML_ERROR_ASYNC_ENTITY,
  56.   XML_ERROR_BAD_CHAR_REF,
  57.   XML_ERROR_BINARY_ENTITY_REF,
  58.   XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF,
  59.   XML_ERROR_MISPLACED_XML_PI,
  60.   XML_ERROR_UNKNOWN_ENCODING,
  61.   XML_ERROR_INCORRECT_ENCODING,
  62.   XML_ERROR_UNCLOSED_CDATA_SECTION,
  63.   XML_ERROR_EXTERNAL_ENTITY_HANDLING,
  64.   XML_ERROR_NOT_STANDALONE,
  65.   XML_ERROR_UNEXPECTED_STATE,
  66.   XML_ERROR_ENTITY_DECLARED_IN_PE,
  67.   XML_ERROR_FEATURE_REQUIRES_XML_DTD,
  68.   XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING
  69. };
  70. enum XML_Content_Type {
  71.   XML_CTYPE_EMPTY = 1,
  72.   XML_CTYPE_ANY,
  73.   XML_CTYPE_MIXED,
  74.   XML_CTYPE_NAME,
  75.   XML_CTYPE_CHOICE,
  76.   XML_CTYPE_SEQ
  77. };
  78. enum XML_Content_Quant {
  79.   XML_CQUANT_NONE,
  80.   XML_CQUANT_OPT,
  81.   XML_CQUANT_REP,
  82.   XML_CQUANT_PLUS
  83. };
  84. /* If type == XML_CTYPE_EMPTY or XML_CTYPE_ANY, then quant will be
  85.    XML_CQUANT_NONE, and the other fields will be zero or NULL.
  86.    If type == XML_CTYPE_MIXED, then quant will be NONE or REP and
  87.    numchildren will contain number of elements that may be mixed in
  88.    and children point to an array of XML_Content cells that will be
  89.    all of XML_CTYPE_NAME type with no quantification.
  90.    If type == XML_CTYPE_NAME, then the name points to the name, and
  91.    the numchildren field will be zero and children will be NULL. The
  92.    quant fields indicates any quantifiers placed on the name.
  93.    CHOICE and SEQ will have name NULL, the number of children in
  94.    numchildren and children will point, recursively, to an array
  95.    of XML_Content cells.
  96.    The EMPTY, ANY, and MIXED types will only occur at top level.
  97. */
  98. typedef struct XML_cp XML_Content;
  99. struct XML_cp {
  100.   enum XML_Content_Type         type;
  101.   enum XML_Content_Quant        quant;
  102.   XML_Char *                    name;
  103.   unsigned int                  numchildren;
  104.   XML_Content *                 children;
  105. };
  106. /* This is called for an element declaration. See above for
  107.    description of the model argument. It's the caller's responsibility
  108.    to free model when finished with it.
  109. */
  110. typedef void (*XML_ElementDeclHandler) (void *userData,
  111.                                         const XML_Char *name,
  112.                                         XML_Content *model);
  113. XMLPARSEAPI(void)
  114. XML_SetElementDeclHandler(XML_Parser parser,
  115.                           XML_ElementDeclHandler eldecl);
  116. /* The Attlist declaration handler is called for *each* attribute. So
  117.    a single Attlist declaration with multiple attributes declared will
  118.    generate multiple calls to this handler. The "default" parameter
  119.    may be NULL in the case of the "#IMPLIED" or "#REQUIRED"
  120.    keyword. The "isrequired" parameter will be true and the default
  121.    value will be NULL in the case of "#REQUIRED". If "isrequired" is
  122.    true and default is non-NULL, then this is a "#FIXED" default.
  123. */
  124. typedef void (*XML_AttlistDeclHandler) (void           *userData,
  125.                                         const XML_Char *elname,
  126.                                         const XML_Char *attname,
  127.                                         const XML_Char *att_type,
  128.                                         const XML_Char *dflt,
  129.                                         int             isrequired);
  130. XMLPARSEAPI(void)
  131. XML_SetAttlistDeclHandler(XML_Parser parser,
  132.                           XML_AttlistDeclHandler attdecl);
  133. /* The XML declaration handler is called for *both* XML declarations
  134.    and text declarations. The way to distinguish is that the version
  135.    parameter will be NULL for text declarations. The encoding
  136.    parameter may be NULL for XML declarations. The standalone
  137.    parameter will be -1, 0, or 1 indicating respectively that there
  138.    was no standalone parameter in the declaration, that it was given
  139.    as no, or that it was given as yes.
  140. */
  141. typedef void (*XML_XmlDeclHandler) (void                *userData,
  142.                                     const XML_Char      *version,
  143.                                     const XML_Char      *encoding,
  144.                                     int                  standalone);
  145. XMLPARSEAPI(void)
  146. XML_SetXmlDeclHandler(XML_Parser parser,
  147.                       XML_XmlDeclHandler xmldecl);
  148. typedef struct {
  149.   void *(*malloc_fcn)(void *priv,size_t size);
  150.   void *(*realloc_fcn)(void *priv,void *ptr, size_t size);
  151.   void (*free_fcn)(void *priv,void *ptr);
  152.   void *priv;
  153. } XML_Memory_Handling_Suite;
  154. /* Constructs a new parser; encoding is the encoding specified by the
  155.    external protocol or NULL if there is none specified.
  156. */
  157. XMLPARSEAPI(XML_Parser)
  158. XML_ParserCreate(const XML_Char *encoding);
  159. /* Constructs a new parser and namespace processor.  Element type
  160.    names and attribute names that belong to a namespace will be
  161.    expanded; unprefixed attribute names are never expanded; unprefixed
  162.    element type names are expanded only if there is a default
  163.    namespace. The expanded name is the concatenation of the namespace
  164.    URI, the namespace separator character, and the local part of the
  165.    name.  If the namespace separator is '' then the namespace URI
  166.    and the local part will be concatenated without any separator.
  167.    When a namespace is not declared, the name and prefix will be
  168.    passed through without expansion.
  169. */
  170. XMLPARSEAPI(XML_Parser)
  171. XML_ParserCreateNS(const XML_Char *encoding, XML_Char namespaceSeparator);
  172. /* Constructs a new parser using the memory management suite referred to
  173.    by memsuite. If memsuite is NULL, then use the standard library memory
  174.    suite. If namespaceSeparator is non-NULL it creates a parser with
  175.    namespace processing as described above. The character pointed at
  176.    will serve as the namespace separator.
  177.    All further memory operations used for the created parser will come from
  178.    the given suite.
  179. */
  180. XMLPARSEAPI(XML_Parser)
  181. XML_ParserCreate_MM(const XML_Char *encoding,
  182.                     const XML_Memory_Handling_Suite *memsuite,
  183.                     const XML_Char *namespaceSeparator);
  184. /* Prepare a parser object to be re-used.  This is particularly
  185.    valuable when memory allocation overhead is disproportionatly high,
  186.    such as when a large number of small documnents need to be parsed.
  187.    All handlers are cleared from the parser, except for the
  188.    unknownEncodingHandler. The parser's external state is re-initialized
  189.    except for the values of ns and ns_triplets.
  190.    Added in Expat 1.95.3.
  191. */
  192. XMLPARSEAPI(XML_Bool)
  193. XML_ParserReset(XML_Parser parser, const XML_Char *encoding);
  194. /* atts is array of name/value pairs, terminated by 0;
  195.    names and values are 0 terminated.
  196. */
  197. typedef void (*XML_StartElementHandler)(void *userData,
  198.                                         const XML_Char *name,
  199.                                         const XML_Char **atts);
  200. typedef void (*XML_EndElementHandler)(void *userData,
  201.                                       const XML_Char *name);
  202. /* s is not 0 terminated. */
  203. typedef void (*XML_CharacterDataHandler)(void *userData,
  204.                                          const XML_Char *s,
  205.                                          int len);
  206. /* target and data are 0 terminated */
  207. typedef void (*XML_ProcessingInstructionHandler)(void *userData,
  208.                                                  const XML_Char *target,
  209.                                                  const XML_Char *data);
  210. /* data is 0 terminated */
  211. typedef void (*XML_CommentHandler)(void *userData, const XML_Char *data);
  212. typedef void (*XML_StartCdataSectionHandler)(void *userData);
  213. typedef void (*XML_EndCdataSectionHandler)(void *userData);
  214. /* This is called for any characters in the XML document for which
  215.    there is no applicable handler.  This includes both characters that
  216.    are part of markup which is of a kind that is not reported
  217.    (comments, markup declarations), or characters that are part of a
  218.    construct which could be reported but for which no handler has been
  219.    supplied. The characters are passed exactly as they were in the XML
  220.    document except that they will be encoded in UTF-8 or UTF-16.
  221.    Line boundaries are not normalized. Note that a byte order mark
  222.    character is not passed to the default handler. There are no
  223.    guarantees about how characters are divided between calls to the
  224.    default handler: for example, a comment might be split between
  225.    multiple calls.
  226. */
  227. typedef void (*XML_DefaultHandler)(void *userData,
  228.                                    const XML_Char *s,
  229.                                    int len);
  230. /* This is called for the start of the DOCTYPE declaration, before
  231.    any DTD or internal subset is parsed.
  232. */
  233. typedef void (*XML_StartDoctypeDeclHandler)(void *userData,
  234.                                             const XML_Char *doctypeName,
  235.                                             const XML_Char *sysid,
  236.                                             const XML_Char *pubid,
  237.                                             int has_internal_subset);
  238. /* This is called for the start of the DOCTYPE declaration when the
  239.    closing > is encountered, but after processing any external
  240.    subset.
  241. */
  242. typedef void (*XML_EndDoctypeDeclHandler)(void *userData);
  243. /* This is called for entity declarations. The is_parameter_entity
  244.    argument will be non-zero if the entity is a parameter entity, zero
  245.    otherwise.
  246.    For internal entities (<!ENTITY foo "bar">), value will
  247.    be non-NULL and systemId, publicID, and notationName will be NULL.
  248.    The value string is NOT nul-terminated; the length is provided in
  249.    the value_length argument. Since it is legal to have zero-length
  250.    values, do not use this argument to test for internal entities.
  251.    For external entities, value will be NULL and systemId will be
  252.    non-NULL. The publicId argument will be NULL unless a public
  253.    identifier was provided. The notationName argument will have a
  254.    non-NULL value only for unparsed entity declarations.
  255.    Note that is_parameter_entity can't be changed to XML_Bool, since
  256.    that would break binary compatibility.
  257. */
  258. typedef void (*XML_EntityDeclHandler) (void *userData,
  259.                                        const XML_Char *entityName,
  260.                                        int is_parameter_entity,
  261.                                        const XML_Char *value,
  262.                                        int value_length,
  263.                                        const XML_Char *base,
  264.                                        const XML_Char *systemId,
  265.                                        const XML_Char *publicId,
  266.                                        const XML_Char *notationName);
  267. XMLPARSEAPI(void)
  268. XML_SetEntityDeclHandler(XML_Parser parser,
  269.                          XML_EntityDeclHandler handler);
  270. /* OBSOLETE -- OBSOLETE -- OBSOLETE
  271.    This handler has been superceded by the EntityDeclHandler above.
  272.    It is provided here for backward compatibility.
  273.    This is called for a declaration of an unparsed (NDATA) entity.
  274.    The base argument is whatever was set by XML_SetBase. The
  275.    entityName, systemId and notationName arguments will never be
  276.    NULL. The other arguments may be.
  277. */
  278. typedef void (*XML_UnparsedEntityDeclHandler)(void *userData,
  279.                                               const XML_Char *entityName,
  280.                                               const XML_Char *base,
  281.                                               const XML_Char *systemId,
  282.                                               const XML_Char *publicId,
  283.                                               const XML_Char *notationName);
  284. /* This is called for a declaration of notation.  The base argument is
  285.    whatever was set by XML_SetBase. The notationName will never be
  286.    NULL.  The other arguments can be.
  287. */
  288. typedef void (*XML_NotationDeclHandler)(void *userData,
  289.                                         const XML_Char *notationName,
  290.                                         const XML_Char *base,
  291.                                         const XML_Char *systemId,
  292.                                         const XML_Char *publicId);
  293. /* When namespace processing is enabled, these are called once for
  294.    each namespace declaration. The call to the start and end element
  295.    handlers occur between the calls to the start and end namespace
  296.    declaration handlers. For an xmlns attribute, prefix will be
  297.    NULL.  For an xmlns="" attribute, uri will be NULL.
  298. */
  299. typedef void (*XML_StartNamespaceDeclHandler)(void *userData,
  300.                                               const XML_Char *prefix,
  301.                                               const XML_Char *uri);
  302. typedef void (*XML_EndNamespaceDeclHandler)(void *userData,
  303.                                             const XML_Char *prefix);
  304. /* This is called if the document is not standalone, that is, it has an
  305.    external subset or a reference to a parameter entity, but does not
  306.    have standalone="yes". If this handler returns XML_STATUS_ERROR,
  307.    then processing will not continue, and the parser will return a
  308.    XML_ERROR_NOT_STANDALONE error.
  309.    If parameter entity parsing is enabled, then in addition to the
  310.    conditions above this handler will only be called if the referenced
  311.    entity was actually read.
  312. */
  313. typedef int (*XML_NotStandaloneHandler)(void *userData);
  314. /* This is called for a reference to an external parsed general
  315.    entity.  The referenced entity is not automatically parsed.  The
  316.    application can parse it immediately or later using
  317.    XML_ExternalEntityParserCreate.
  318.    The parser argument is the parser parsing the entity containing the
  319.    reference; it can be passed as the parser argument to
  320.    XML_ExternalEntityParserCreate.  The systemId argument is the
  321.    system identifier as specified in the entity declaration; it will
  322.    not be NULL.
  323.    The base argument is the system identifier that should be used as
  324.    the base for resolving systemId if systemId was relative; this is
  325.    set by XML_SetBase; it may be NULL.
  326.    The publicId argument is the public identifier as specified in the
  327.    entity declaration, or NULL if none was specified; the whitespace
  328.    in the public identifier will have been normalized as required by
  329.    the XML spec.
  330.    The context argument specifies the parsing context in the format
  331.    expected by the context argument to XML_ExternalEntityParserCreate;
  332.    context is valid only until the handler returns, so if the
  333.    referenced entity is to be parsed later, it must be copied.
  334.    context is NULL only when the entity is a parameter entity.
  335.    The handler should return XML_STATUS_ERROR if processing should not
  336.    continue because of a fatal error in the handling of the external
  337.    entity.  In this case the calling parser will return an
  338.    XML_ERROR_EXTERNAL_ENTITY_HANDLING error.
  339.    Note that unlike other handlers the first argument is the parser,
  340.    not userData.
  341. */
  342. typedef int (*XML_ExternalEntityRefHandler)(XML_Parser parser,
  343.                                             const XML_Char *context,
  344.                                             const XML_Char *base,
  345.                                             const XML_Char *systemId,
  346.                                             const XML_Char *publicId);
  347. /* This is called in two situations:
  348.    1) An entity reference is encountered for which no declaration
  349.       has been read *and* this is not an error.
  350.    2) An internal entity reference is read, but not expanded, because
  351.       XML_SetDefaultHandler has been called.
  352.    Note: skipped parameter entities in declarations and skipped general
  353.          entities in attribute values cannot be reported, because
  354.          the event would be out of sync with the reporting of the
  355.          declarations or attribute values
  356. */
  357. typedef void (*XML_SkippedEntityHandler)(void *userData,
  358.                                          const XML_Char *entityName,
  359.                                          int is_parameter_entity);
  360. /* This structure is filled in by the XML_UnknownEncodingHandler to
  361.    provide information to the parser about encodings that are unknown
  362.    to the parser.
  363.    The map[b] member gives information about byte sequences whose
  364.    first byte is b.
  365.    If map[b] is c where c is >= 0, then b by itself encodes the
  366.    Unicode scalar value c.
  367.    If map[b] is -1, then the byte sequence is malformed.
  368.    If map[b] is -n, where n >= 2, then b is the first byte of an
  369.    n-byte sequence that encodes a single Unicode scalar value.
  370.    The data member will be passed as the first argument to the convert
  371.    function.
  372.    The convert function is used to convert multibyte sequences; s will
  373.    point to a n-byte sequence where map[(unsigned char)*s] == -n.  The
  374.    convert function must return the Unicode scalar value represented
  375.    by this byte sequence or -1 if the byte sequence is malformed.
  376.    The convert function may be NULL if the encoding is a single-byte
  377.    encoding, that is if map[b] >= -1 for all bytes b.
  378.    When the parser is finished with the encoding, then if release is
  379.    not NULL, it will call release passing it the data member; once
  380.    release has been called, the convert function will not be called
  381.    again.
  382.    Expat places certain restrictions on the encodings that are supported
  383.    using this mechanism.
  384.    1. Every ASCII character that can appear in a well-formed XML document,
  385.       other than the characters
  386.       $@^`{}~
  387.       must be represented by a single byte, and that byte must be the
  388.       same byte that represents that character in ASCII.
  389.    2. No character may require more than 4 bytes to encode.
  390.    3. All characters encoded must have Unicode scalar values <=
  391.       0xFFFF, (i.e., characters that would be encoded by surrogates in
  392.       UTF-16 are  not allowed).  Note that this restriction doesn't
  393.       apply to the built-in support for UTF-8 and UTF-16.
  394.    4. No Unicode character may be encoded by more than one distinct
  395.       sequence of bytes.
  396. */
  397. typedef struct {
  398.   int map[256];
  399.   void *data;
  400.   int (*convert)(void *data, const char *s);
  401.   void (*release)(void *data);
  402. } XML_Encoding;
  403. /* This is called for an encoding that is unknown to the parser.
  404.    The encodingHandlerData argument is that which was passed as the
  405.    second argument to XML_SetUnknownEncodingHandler.
  406.    The name argument gives the name of the encoding as specified in
  407.    the encoding declaration.
  408.    If the callback can provide information about the encoding, it must
  409.    fill in the XML_Encoding structure, and return XML_STATUS_OK.
  410.    Otherwise it must return XML_STATUS_ERROR.
  411.    If info does not describe a suitable encoding, then the parser will
  412.    return an XML_UNKNOWN_ENCODING error.
  413. */
  414. typedef int (*XML_UnknownEncodingHandler)(void *encodingHandlerData,
  415.                                           const XML_Char *name,
  416.                                           XML_Encoding *info);
  417. XMLPARSEAPI(void)
  418. XML_SetElementHandler(XML_Parser parser,
  419.                       XML_StartElementHandler start,
  420.                       XML_EndElementHandler end);
  421. XMLPARSEAPI(void)
  422. XML_SetStartElementHandler(XML_Parser, XML_StartElementHandler);
  423. XMLPARSEAPI(void)
  424. XML_SetEndElementHandler(XML_Parser, XML_EndElementHandler);
  425. XMLPARSEAPI(void)
  426. XML_SetCharacterDataHandler(XML_Parser parser,
  427.                             XML_CharacterDataHandler handler);
  428. XMLPARSEAPI(void)
  429. XML_SetProcessingInstructionHandler(XML_Parser parser,
  430.                                     XML_ProcessingInstructionHandler handler);
  431. XMLPARSEAPI(void)
  432. XML_SetCommentHandler(XML_Parser parser,
  433.                       XML_CommentHandler handler);
  434. XMLPARSEAPI(void)
  435. XML_SetCdataSectionHandler(XML_Parser parser,
  436.                            XML_StartCdataSectionHandler start,
  437.                            XML_EndCdataSectionHandler end);
  438. XMLPARSEAPI(void)
  439. XML_SetStartCdataSectionHandler(XML_Parser parser,
  440.                                 XML_StartCdataSectionHandler start);
  441. XMLPARSEAPI(void)
  442. XML_SetEndCdataSectionHandler(XML_Parser parser,
  443.                               XML_EndCdataSectionHandler end);
  444. /* This sets the default handler and also inhibits expansion of
  445.    internal entities. These entity references will be passed to the
  446.    default handler, or to the skipped entity handler, if one is set.
  447. */
  448. XMLPARSEAPI(void)
  449. XML_SetDefaultHandler(XML_Parser parser,
  450.                       XML_DefaultHandler handler);
  451. /* This sets the default handler but does not inhibit expansion of
  452.    internal entities.  The entity reference will not be passed to the
  453.    default handler.
  454. */
  455. XMLPARSEAPI(void)
  456. XML_SetDefaultHandlerExpand(XML_Parser parser,
  457.                             XML_DefaultHandler handler);
  458. XMLPARSEAPI(void)
  459. XML_SetDoctypeDeclHandler(XML_Parser parser,
  460.                           XML_StartDoctypeDeclHandler start,
  461.                           XML_EndDoctypeDeclHandler end);
  462. XMLPARSEAPI(void)
  463. XML_SetStartDoctypeDeclHandler(XML_Parser parser,
  464.                                XML_StartDoctypeDeclHandler start);
  465. XMLPARSEAPI(void)
  466. XML_SetEndDoctypeDeclHandler(XML_Parser parser,
  467.                              XML_EndDoctypeDeclHandler end);
  468. XMLPARSEAPI(void)
  469. XML_SetUnparsedEntityDeclHandler(XML_Parser parser,
  470.                                  XML_UnparsedEntityDeclHandler handler);
  471. XMLPARSEAPI(void)
  472. XML_SetNotationDeclHandler(XML_Parser parser,
  473.                            XML_NotationDeclHandler handler);
  474. XMLPARSEAPI(void)
  475. XML_SetNamespaceDeclHandler(XML_Parser parser,
  476.                             XML_StartNamespaceDeclHandler start,
  477.                             XML_EndNamespaceDeclHandler end);
  478. XMLPARSEAPI(void)
  479. XML_SetStartNamespaceDeclHandler(XML_Parser parser,
  480.                                  XML_StartNamespaceDeclHandler start);
  481. XMLPARSEAPI(void)
  482. XML_SetEndNamespaceDeclHandler(XML_Parser parser,
  483.                                XML_EndNamespaceDeclHandler end);
  484. XMLPARSEAPI(void)
  485. XML_SetNotStandaloneHandler(XML_Parser parser,
  486.                             XML_NotStandaloneHandler handler);
  487. XMLPARSEAPI(void)
  488. XML_SetExternalEntityRefHandler(XML_Parser parser,
  489.                                 XML_ExternalEntityRefHandler handler);
  490. /* If a non-NULL value for arg is specified here, then it will be
  491.    passed as the first argument to the external entity ref handler
  492.    instead of the parser object.
  493. */
  494. XMLPARSEAPI(void)
  495. XML_SetExternalEntityRefHandlerArg(XML_Parser, void *arg);
  496. XMLPARSEAPI(void)
  497. XML_SetSkippedEntityHandler(XML_Parser parser,
  498.                             XML_SkippedEntityHandler handler);
  499. XMLPARSEAPI(void)
  500. XML_SetUnknownEncodingHandler(XML_Parser parser,
  501.                               XML_UnknownEncodingHandler handler,
  502.                               void *encodingHandlerData);
  503. /* This can be called within a handler for a start element, end
  504.    element, processing instruction or character data.  It causes the
  505.    corresponding markup to be passed to the default handler.
  506. */
  507. XMLPARSEAPI(void)
  508. XML_DefaultCurrent(XML_Parser parser);
  509. /* If do_nst is non-zero, and namespace processing is in effect, and
  510.    a name has a prefix (i.e. an explicit namespace qualifier) then
  511.    that name is returned as a triplet in a single string separated by
  512.    the separator character specified when the parser was created: URI
  513.    + sep + local_name + sep + prefix.
  514.    If do_nst is zero, then namespace information is returned in the
  515.    default manner (URI + sep + local_name) whether or not the name
  516.    has a prefix.
  517.    Note: Calling XML_SetReturnNSTriplet after XML_Parse or
  518.      XML_ParseBuffer has no effect.
  519. */
  520. XMLPARSEAPI(void)
  521. XML_SetReturnNSTriplet(XML_Parser parser, int do_nst);
  522. /* This value is passed as the userData argument to callbacks. */
  523. XMLPARSEAPI(void)
  524. XML_SetUserData(XML_Parser parser, void *userData);
  525. /* Returns the last value set by XML_SetUserData or NULL. */
  526. #define XML_GetUserData(parser) (*(void **)(parser))
  527. /* This is equivalent to supplying an encoding argument to
  528.    XML_ParserCreate. On success XML_SetEncoding returns non-zero,
  529.    zero otherwise.
  530.    Note: Calling XML_SetEncoding after XML_Parse or XML_ParseBuffer
  531.      has no effect and returns XML_STATUS_ERROR.
  532. */
  533. XMLPARSEAPI(enum XML_Status)
  534. XML_SetEncoding(XML_Parser parser, const XML_Char *encoding);
  535. /* If this function is called, then the parser will be passed as the
  536.    first argument to callbacks instead of userData.  The userData will
  537.    still be accessible using XML_GetUserData.
  538. */
  539. XMLPARSEAPI(void)
  540. XML_UseParserAsHandlerArg(XML_Parser parser);
  541. /* If useDTD == XML_TRUE is passed to this function, then the parser
  542.    will assume that there is an external subset, even if none is
  543.    specified in the document. In such a case the parser will call the
  544.    externalEntityRefHandler with a value of NULL for the systemId
  545.    argument (the publicId and context arguments will be NULL as well).
  546.    Note: If this function is called, then this must be done before
  547.      the first call to XML_Parse or XML_ParseBuffer, since it will
  548.      have no effect after that.  Returns
  549.      XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING.
  550.    Note: If the document does not have a DOCTYPE declaration at all,
  551.      then startDoctypeDeclHandler and endDoctypeDeclHandler will not
  552.      be called, despite an external subset being parsed.
  553.    Note: If XML_DTD is not defined when Expat is compiled, returns
  554.      XML_ERROR_FEATURE_REQUIRES_XML_DTD.
  555. */
  556. XMLPARSEAPI(enum XML_Error)
  557. XML_UseForeignDTD(XML_Parser parser, XML_Bool useDTD);
  558. /* Sets the base to be used for resolving relative URIs in system
  559.    identifiers in declarations.  Resolving relative identifiers is
  560.    left to the application: this value will be passed through as the
  561.    base argument to the XML_ExternalEntityRefHandler,
  562.    XML_NotationDeclHandler and XML_UnparsedEntityDeclHandler. The base
  563.    argument will be copied.  Returns XML_STATUS_ERROR if out of memory,
  564.    XML_STATUS_OK otherwise.
  565. */
  566. XMLPARSEAPI(enum XML_Status)
  567. XML_SetBase(XML_Parser parser, const XML_Char *base);
  568. XMLPARSEAPI(const XML_Char *)
  569. XML_GetBase(XML_Parser parser);
  570. /* Returns the number of the attribute/value pairs passed in last call
  571.    to the XML_StartElementHandler that were specified in the start-tag
  572.    rather than defaulted. Each attribute/value pair counts as 2; thus
  573.    this correspondds to an index into the atts array passed to the
  574.    XML_StartElementHandler.
  575. */
  576. XMLPARSEAPI(int)
  577. XML_GetSpecifiedAttributeCount(XML_Parser parser);
  578. /* Returns the index of the ID attribute passed in the last call to
  579.    XML_StartElementHandler, or -1 if there is no ID attribute.  Each
  580.    attribute/value pair counts as 2; thus this correspondds to an
  581.    index into the atts array passed to the XML_StartElementHandler.
  582. */
  583. XMLPARSEAPI(int)
  584. XML_GetIdAttributeIndex(XML_Parser parser);
  585. /* Parses some input. Returns XML_STATUS_ERROR if a fatal error is
  586.    detected.  The last call to XML_Parse must have isFinal true; len
  587.    may be zero for this call (or any other).
  588.    The XML_Status enum gives the possible return values for the
  589.    XML_Parse and XML_ParseBuffer functions.  Though the return values
  590.    for these functions has always been described as a Boolean value,
  591.    the implementation, at least for the 1.95.x series, has always
  592.    returned exactly one of these values.  The preprocessor #defines
  593.    are included so this stanza can be added to code that still needs
  594.    to support older versions of Expat 1.95.x:
  595.    #ifndef XML_STATUS_OK
  596.    #define XML_STATUS_OK    1
  597.    #define XML_STATUS_ERROR 0
  598.    #endif
  599.    Otherwise, the #define hackery is quite ugly and would have been dropped.
  600. */
  601. enum XML_Status {
  602.   XML_STATUS_ERROR = 0,
  603. #define XML_STATUS_ERROR XML_STATUS_ERROR
  604.   XML_STATUS_OK = 1
  605. #define XML_STATUS_OK XML_STATUS_OK
  606. };
  607. XMLPARSEAPI(enum XML_Status)
  608. XML_Parse(XML_Parser parser, const char *s, int len, int isFinal);
  609. XMLPARSEAPI(void *)
  610. XML_GetBuffer(XML_Parser parser, int len);
  611. XMLPARSEAPI(enum XML_Status)
  612. XML_ParseBuffer(XML_Parser parser, int len, int isFinal);
  613. /* Creates an XML_Parser object that can parse an external general
  614.    entity; context is a ''-terminated string specifying the parse
  615.    context; encoding is a ''-terminated string giving the name of
  616.    the externally specified encoding, or NULL if there is no
  617.    externally specified encoding.  The context string consists of a
  618.    sequence of tokens separated by formfeeds (f); a token consisting
  619.    of a name specifies that the general entity of the name is open; a
  620.    token of the form prefix=uri specifies the namespace for a
  621.    particular prefix; a token of the form =uri specifies the default
  622.    namespace.  This can be called at any point after the first call to
  623.    an ExternalEntityRefHandler so longer as the parser has not yet
  624.    been freed.  The new parser is completely independent and may
  625.    safely be used in a separate thread.  The handlers and userData are
  626.    initialized from the parser argument.  Returns NULL if out of memory.
  627.    Otherwise returns a new XML_Parser object.
  628. */
  629. XMLPARSEAPI(XML_Parser)
  630. XML_ExternalEntityParserCreate(XML_Parser parser,
  631.                                const XML_Char *context,
  632.                                const XML_Char *encoding);
  633. enum XML_ParamEntityParsing {
  634.   XML_PARAM_ENTITY_PARSING_NEVER,
  635.   XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE,
  636.   XML_PARAM_ENTITY_PARSING_ALWAYS
  637. };
  638. /* Controls parsing of parameter entities (including the external DTD
  639.    subset). If parsing of parameter entities is enabled, then
  640.    references to external parameter entities (including the external
  641.    DTD subset) will be passed to the handler set with
  642.    XML_SetExternalEntityRefHandler.  The context passed will be 0.
  643.    Unlike external general entities, external parameter entities can
  644.    only be parsed synchronously.  If the external parameter entity is
  645.    to be parsed, it must be parsed during the call to the external
  646.    entity ref handler: the complete sequence of
  647.    XML_ExternalEntityParserCreate, XML_Parse/XML_ParseBuffer and
  648.    XML_ParserFree calls must be made during this call.  After
  649.    XML_ExternalEntityParserCreate has been called to create the parser
  650.    for the external parameter entity (context must be 0 for this
  651.    call), it is illegal to make any calls on the old parser until
  652.    XML_ParserFree has been called on the newly created parser.
  653.    If the library has been compiled without support for parameter
  654.    entity parsing (ie without XML_DTD being defined), then
  655.    XML_SetParamEntityParsing will return 0 if parsing of parameter
  656.    entities is requested; otherwise it will return non-zero.
  657.    Note: If XML_SetParamEntityParsing is called after XML_Parse or
  658.       XML_ParseBuffer, then it has no effect and will always return 0.
  659. */
  660. XMLPARSEAPI(int)
  661. XML_SetParamEntityParsing(XML_Parser parser,
  662.                           enum XML_ParamEntityParsing parsing);
  663. /* If XML_Parse or XML_ParseBuffer have returned XML_STATUS_ERROR, then
  664.    XML_GetErrorCode returns information about the error.
  665. */
  666. XMLPARSEAPI(enum XML_Error)
  667. XML_GetErrorCode(XML_Parser parser);
  668. /* These functions return information about the current parse
  669.    location.  They may be called from any callback called to report
  670.    some parse event; in this case the location is the location of
  671.    the first of the sequence of characters that generated the event. 
  672.    
  673.    They may also be called after returning from a call to XML_Parse
  674.    or XML_ParseBuffer.  If the return value is XML_STATUS_ERROR then
  675.    the location is the location of the character at which the error
  676.    was detected; otherwise the location is the location of the last
  677.    parse event, as described above.
  678. */
  679. XMLPARSEAPI(int) XML_GetCurrentLineNumber(XML_Parser parser);
  680. XMLPARSEAPI(int) XML_GetCurrentColumnNumber(XML_Parser parser);
  681. XMLPARSEAPI(long) XML_GetCurrentByteIndex(XML_Parser parser);
  682. /* Return the number of bytes in the current event.
  683.    Returns 0 if the event is in an internal entity.
  684. */
  685. XMLPARSEAPI(int)
  686. XML_GetCurrentByteCount(XML_Parser parser);
  687. /* If XML_CONTEXT_BYTES is defined, returns the input buffer, sets
  688.    the integer pointed to by offset to the offset within this buffer
  689.    of the current parse position, and sets the integer pointed to by size
  690.    to the size of this buffer (the number of input bytes). Otherwise
  691.    returns a NULL pointer. Also returns a NULL pointer if a parse isn't
  692.    active.
  693.    NOTE: The character pointer returned should not be used outside
  694.    the handler that makes the call.
  695. */
  696. XMLPARSEAPI(const char *)
  697. XML_GetInputContext(XML_Parser parser,
  698.                     int *offset,
  699.                     int *size);
  700. /* For backwards compatibility with previous versions. */
  701. #define XML_GetErrorLineNumber   XML_GetCurrentLineNumber
  702. #define XML_GetErrorColumnNumber XML_GetCurrentColumnNumber
  703. #define XML_GetErrorByteIndex    XML_GetCurrentByteIndex
  704. /* Frees the content model passed to the element declaration handler */
  705. XMLPARSEAPI(void)
  706. XML_FreeContentModel(XML_Parser parser, XML_Content *model);
  707. /* Exposing the memory handling functions used in Expat */
  708. XMLPARSEAPI(void *)
  709. XML_MemMalloc(XML_Parser parser, size_t size);
  710. XMLPARSEAPI(void *)
  711. XML_MemRealloc(XML_Parser parser, void *ptr, size_t size);
  712. XMLPARSEAPI(void)
  713. XML_MemFree(XML_Parser parser, void *ptr);
  714. /* Frees memory used by the parser. */
  715. XMLPARSEAPI(void)
  716. XML_ParserFree(XML_Parser parser);
  717. /* Returns a string describing the error. */
  718. XMLPARSEAPI(const XML_LChar *)
  719. XML_ErrorString(enum XML_Error code);
  720. /* Return a string containing the version number of this expat */
  721. XMLPARSEAPI(const XML_LChar *)
  722. XML_ExpatVersion(void);
  723. typedef struct {
  724.   int major;
  725.   int minor;
  726.   int micro;
  727. } XML_Expat_Version;
  728. /* Return an XML_Expat_Version structure containing numeric version
  729.    number information for this version of expat.
  730. */
  731. XMLPARSEAPI(XML_Expat_Version)
  732. XML_ExpatVersionInfo(void);
  733. /* Added in Expat 1.95.5. */
  734. enum XML_FeatureEnum {
  735.   XML_FEATURE_END = 0,
  736.   XML_FEATURE_UNICODE,
  737.   XML_FEATURE_UNICODE_WCHAR_T,
  738.   XML_FEATURE_DTD,
  739.   XML_FEATURE_CONTEXT_BYTES,
  740.   XML_FEATURE_MIN_SIZE,
  741.   XML_FEATURE_SIZEOF_XML_CHAR,
  742.   XML_FEATURE_SIZEOF_XML_LCHAR
  743.   /* Additional features must be added to the end of this enum. */
  744. };
  745. typedef struct {
  746.   enum XML_FeatureEnum  feature;
  747.   const XML_LChar       *name;
  748.   long int              value;
  749. } XML_Feature;
  750. XMLPARSEAPI(const XML_Feature *)
  751. XML_GetFeatureList(void);
  752. /* Expat follows the GNU/Linux convention of odd number minor version for
  753.    beta/development releases and even number minor version for stable
  754.    releases. Micro is bumped with each release, and set to 0 with each
  755.    change to major or minor version.
  756. */
  757. #define XML_MAJOR_VERSION 1
  758. #define XML_MINOR_VERSION 95
  759. #define XML_MICRO_VERSION 6
  760. /* local additions
  761.                 - Mike */
  762. /* (re)Parses character data (handles char refs and predefined entities)*/
  763. XMLPARSEAPI(int)
  764. XML_ParseCharacterData(XML_Parser parser,char **source,int len,
  765. wchar_t *dest,int destlen);
  766. /* see if we are expanding any entities now */
  767. XMLPARSEAPI(int)
  768. XML_IsExpanding(XML_Parser parser);
  769. /* simpy convert encoding for cdata sections */
  770. XMLPARSEAPI(int)
  771. XML_ConvertCharacterData(XML_Parser parser,char **source,int len,
  772.  wchar_t *dest,int destlen);
  773. #ifdef __cplusplus
  774. }
  775. #endif
  776. #endif /* not XmlParse_INCLUDED */