parserInternals.h

Go to the documentation of this file.

/*
 * Summary: internals routines and limits exported by the parser.
 * Description: this module exports a number of internal parsing routines
 *              they are not really all intended for applications but
 *              can prove useful doing low level processing.
 *
 * Copy: See Copyright for the status of this software.
 *
 * Author: Daniel Veillard
 */
 
#ifndef __XML_PARSER_INTERNALS_H__
#define __XML_PARSER_INTERNALS_H__
 
#include <libxml/xmlversion.h>
#include <libxml/parser.h>
#include <libxml/HTMLparser.h>
#include <libxml/chvalid.h>
#include <libxml/SAX2.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
XMLPUBVAR unsigned int xmlParserMaxDepth;
 
#define XML_MAX_TEXT_LENGTH 10000000
 
#define XML_MAX_HUGE_LENGTH 1000000000
 
#define XML_MAX_NAME_LENGTH 50000
 
#define XML_MAX_DICTIONARY_LIMIT 10000000
 
#define XML_MAX_LOOKUP_LIMIT 10000000
 
#define XML_MAX_NAMELEN 100
 
#define INPUT_CHUNK 250
 
/************************************************************************
 *                                  *
 * UNICODE version of the macros.                   *
 *                                  *
 ************************************************************************/
#define IS_BYTE_CHAR(c)  xmlIsChar_ch(c)
 
#define IS_CHAR(c)   xmlIsCharQ(c)
 
#define IS_CHAR_CH(c)  xmlIsChar_ch(c)
 
#define IS_BLANK(c)  xmlIsBlankQ(c)
 
#define IS_BLANK_CH(c)  xmlIsBlank_ch(c)
 
#define IS_BASECHAR(c) xmlIsBaseCharQ(c)
 
#define IS_DIGIT(c) xmlIsDigitQ(c)
 
#define IS_DIGIT_CH(c)  xmlIsDigit_ch(c)
 
#define IS_COMBINING(c) xmlIsCombiningQ(c)
 
#define IS_COMBINING_CH(c) 0
 
#define IS_EXTENDER(c) xmlIsExtenderQ(c)
 
#define IS_EXTENDER_CH(c)  xmlIsExtender_ch(c)
 
#define IS_IDEOGRAPHIC(c) xmlIsIdeographicQ(c)
 
#define IS_LETTER(c) (IS_BASECHAR(c) || IS_IDEOGRAPHIC(c))
 
#define IS_LETTER_CH(c) xmlIsBaseChar_ch(c)
 
#define IS_ASCII_LETTER(c)  (((0x41 <= (c)) && ((c) <= 0x5a)) || \
                 ((0x61 <= (c)) && ((c) <= 0x7a)))
 
#define IS_ASCII_DIGIT(c)   ((0x30 <= (c)) && ((c) <= 0x39))
 
#define IS_PUBIDCHAR(c) xmlIsPubidCharQ(c)
 
#define IS_PUBIDCHAR_CH(c) xmlIsPubidChar_ch(c)
 
XMLPUBVAR const xmlChar xmlStringText[];
XMLPUBVAR const xmlChar xmlStringTextNoenc[];
XMLPUBVAR const xmlChar xmlStringComment[];
 
/*
 * Function to finish the work of the macros where needed.
 */
XMLPUBFUN int                   xmlIsLetter     (int c);
 
XMLPUBFUN xmlParserCtxtPtr
            xmlCreateFileParserCtxt (const char *filename);
XMLPUBFUN xmlParserCtxtPtr
            xmlCreateURLParserCtxt  (const char *filename,
                         int options);
XMLPUBFUN xmlParserCtxtPtr
            xmlCreateMemoryParserCtxt(const char *buffer,
                         int size);
XMLPUBFUN xmlParserCtxtPtr
            xmlCreateEntityParserCtxt(const xmlChar *URL,
                         const xmlChar *ID,
                         const xmlChar *base);
XMLPUBFUN int
            xmlSwitchEncoding   (xmlParserCtxtPtr ctxt,
                         xmlCharEncoding enc);
XMLPUBFUN int
            xmlSwitchToEncoding (xmlParserCtxtPtr ctxt,
                     xmlCharEncodingHandlerPtr handler);
XML_DEPRECATED
XMLPUBFUN int
            xmlSwitchInputEncoding  (xmlParserCtxtPtr ctxt,
                         xmlParserInputPtr input,
                     xmlCharEncodingHandlerPtr handler);
 
XMLPUBFUN xmlParserInputPtr
            xmlNewStringInputStream (xmlParserCtxtPtr ctxt,
                         const xmlChar *buffer);
XML_DEPRECATED
XMLPUBFUN xmlParserInputPtr
            xmlNewEntityInputStream (xmlParserCtxtPtr ctxt,
                         xmlEntityPtr entity);
XMLPUBFUN int
            xmlPushInput        (xmlParserCtxtPtr ctxt,
                         xmlParserInputPtr input);
XMLPUBFUN xmlChar
            xmlPopInput     (xmlParserCtxtPtr ctxt);
XMLPUBFUN void
            xmlFreeInputStream  (xmlParserInputPtr input);
XMLPUBFUN xmlParserInputPtr
            xmlNewInputFromFile (xmlParserCtxtPtr ctxt,
                         const char *filename);
XMLPUBFUN xmlParserInputPtr
            xmlNewInputStream   (xmlParserCtxtPtr ctxt);
 
XMLPUBFUN xmlChar *
            xmlSplitQName       (xmlParserCtxtPtr ctxt,
                         const xmlChar *name,
                         xmlChar **prefix);
 
XML_DEPRECATED
XMLPUBFUN const xmlChar *
            xmlParseName        (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN xmlChar *
            xmlParseNmtoken     (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN xmlChar *
            xmlParseEntityValue (xmlParserCtxtPtr ctxt,
                         xmlChar **orig);
XML_DEPRECATED
XMLPUBFUN xmlChar *
            xmlParseAttValue    (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN xmlChar *
            xmlParseSystemLiteral   (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN xmlChar *
            xmlParsePubidLiteral    (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN void
            xmlParseCharData    (xmlParserCtxtPtr ctxt,
                         int cdata);
XML_DEPRECATED
XMLPUBFUN xmlChar *
            xmlParseExternalID  (xmlParserCtxtPtr ctxt,
                         xmlChar **publicID,
                         int strict);
XML_DEPRECATED
XMLPUBFUN void
            xmlParseComment     (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN const xmlChar *
            xmlParsePITarget    (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN void
            xmlParsePI      (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN void
            xmlParseNotationDecl    (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN void
            xmlParseEntityDecl  (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN int
            xmlParseDefaultDecl (xmlParserCtxtPtr ctxt,
                         xmlChar **value);
XML_DEPRECATED
XMLPUBFUN xmlEnumerationPtr
            xmlParseNotationType    (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN xmlEnumerationPtr
            xmlParseEnumerationType (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN int
            xmlParseEnumeratedType  (xmlParserCtxtPtr ctxt,
                         xmlEnumerationPtr *tree);
XML_DEPRECATED
XMLPUBFUN int
            xmlParseAttributeType   (xmlParserCtxtPtr ctxt,
                         xmlEnumerationPtr *tree);
XML_DEPRECATED
XMLPUBFUN void
            xmlParseAttributeListDecl(xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN xmlElementContentPtr
            xmlParseElementMixedContentDecl
                        (xmlParserCtxtPtr ctxt,
                         int inputchk);
XML_DEPRECATED
XMLPUBFUN xmlElementContentPtr
            xmlParseElementChildrenContentDecl
                        (xmlParserCtxtPtr ctxt,
                         int inputchk);
XML_DEPRECATED
XMLPUBFUN int
            xmlParseElementContentDecl(xmlParserCtxtPtr ctxt,
                         const xmlChar *name,
                         xmlElementContentPtr *result);
XML_DEPRECATED
XMLPUBFUN int
            xmlParseElementDecl (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN void
            xmlParseMarkupDecl  (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN int
            xmlParseCharRef     (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN xmlEntityPtr
            xmlParseEntityRef   (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN void
            xmlParseReference   (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN void
            xmlParsePEReference (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN void
            xmlParseDocTypeDecl (xmlParserCtxtPtr ctxt);
#ifdef LIBXML_SAX1_ENABLED
XML_DEPRECATED
XMLPUBFUN const xmlChar *
            xmlParseAttribute   (xmlParserCtxtPtr ctxt,
                         xmlChar **value);
XML_DEPRECATED
XMLPUBFUN const xmlChar *
            xmlParseStartTag    (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN void
            xmlParseEndTag      (xmlParserCtxtPtr ctxt);
#endif /* LIBXML_SAX1_ENABLED */
XML_DEPRECATED
XMLPUBFUN void
            xmlParseCDSect      (xmlParserCtxtPtr ctxt);
XMLPUBFUN void
            xmlParseContent     (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN void
            xmlParseElement     (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN xmlChar *
            xmlParseVersionNum  (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN xmlChar *
            xmlParseVersionInfo (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN xmlChar *
            xmlParseEncName     (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN const xmlChar *
            xmlParseEncodingDecl    (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN int
            xmlParseSDDecl      (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN void
            xmlParseXMLDecl     (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN void
            xmlParseTextDecl    (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN void
            xmlParseMisc        (xmlParserCtxtPtr ctxt);
XMLPUBFUN void
            xmlParseExternalSubset  (xmlParserCtxtPtr ctxt,
                         const xmlChar *ExternalID,
                         const xmlChar *SystemID);
#define XML_SUBSTITUTE_NONE 0
#define XML_SUBSTITUTE_REF  1
#define XML_SUBSTITUTE_PEREF    2
#define XML_SUBSTITUTE_BOTH 3
 
XML_DEPRECATED
XMLPUBFUN xmlChar *
        xmlStringDecodeEntities     (xmlParserCtxtPtr ctxt,
                         const xmlChar *str,
                         int what,
                         xmlChar end,
                         xmlChar  end2,
                         xmlChar end3);
XML_DEPRECATED
XMLPUBFUN xmlChar *
        xmlStringLenDecodeEntities  (xmlParserCtxtPtr ctxt,
                         const xmlChar *str,
                         int len,
                         int what,
                         xmlChar end,
                         xmlChar  end2,
                         xmlChar end3);
 
/*
 * Generated by MACROS on top of parser.c c.f. PUSH_AND_POP.
 */
XML_DEPRECATED
XMLPUBFUN int           nodePush        (xmlParserCtxtPtr ctxt,
                         xmlNodePtr value);
XML_DEPRECATED
XMLPUBFUN xmlNodePtr        nodePop         (xmlParserCtxtPtr ctxt);
XMLPUBFUN int           inputPush       (xmlParserCtxtPtr ctxt,
                         xmlParserInputPtr value);
XMLPUBFUN xmlParserInputPtr inputPop        (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN const xmlChar *   namePop         (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN int           namePush        (xmlParserCtxtPtr ctxt,
                         const xmlChar *value);
 
/*
 * other commodities shared between parser.c and parserInternals.
 */
XML_DEPRECATED
XMLPUBFUN int           xmlSkipBlankChars   (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN int           xmlStringCurrentChar    (xmlParserCtxtPtr ctxt,
                         const xmlChar *cur,
                         int *len);
XML_DEPRECATED
XMLPUBFUN void          xmlParserHandlePEReference(xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN int           xmlCheckLanguageID  (const xmlChar *lang);
 
/*
 * Really core function shared with HTML parser.
 */
XML_DEPRECATED
XMLPUBFUN int           xmlCurrentChar      (xmlParserCtxtPtr ctxt,
                         int *len);
XMLPUBFUN int       xmlCopyCharMultiByte    (xmlChar *out,
                         int val);
XMLPUBFUN int           xmlCopyChar     (int len,
                         xmlChar *out,
                         int val);
XML_DEPRECATED
XMLPUBFUN void          xmlNextChar     (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN void          xmlParserInputShrink    (xmlParserInputPtr in);
 
/*
 * Specific function to keep track of entities references
 * and used by the XSLT debugger.
 */
#ifdef LIBXML_LEGACY_ENABLED
typedef void    (*xmlEntityReferenceFunc)   (xmlEntityPtr ent,
                         xmlNodePtr firstNode,
                         xmlNodePtr lastNode);
 
XML_DEPRECATED
XMLPUBFUN void      xmlSetEntityReferenceFunc   (xmlEntityReferenceFunc func);
 
XML_DEPRECATED
XMLPUBFUN xmlChar *
            xmlParseQuotedString    (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN void
                        xmlParseNamespace       (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN xmlChar *
            xmlNamespaceParseNSDef  (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN xmlChar *
            xmlScanName     (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN xmlChar *
            xmlNamespaceParseNCName (xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN void  xmlParserHandleReference(xmlParserCtxtPtr ctxt);
XML_DEPRECATED
XMLPUBFUN xmlChar *
            xmlNamespaceParseQName  (xmlParserCtxtPtr ctxt,
                         xmlChar **prefix);
XML_DEPRECATED
XMLPUBFUN xmlChar *
        xmlDecodeEntities       (xmlParserCtxtPtr ctxt,
                         int len,
                         int what,
                         xmlChar end,
                         xmlChar  end2,
                         xmlChar end3);
XML_DEPRECATED
XMLPUBFUN void
            xmlHandleEntity     (xmlParserCtxtPtr ctxt,
                         xmlEntityPtr entity);
 
#endif /* LIBXML_LEGACY_ENABLED */
 
#ifdef __cplusplus
}
#endif
#endif /* __XML_PARSER_INTERNALS_H__ */