parserInternals.h

Introduction

Constants

extern  const xmlChar xmlStringText[];  

Discussion

Global variables used for predefined strings.

Typedefs

typedef void (*xmlEntityReferenceFunc) (
    xmlEntityPtr ent, 
    xmlNodePtr firstNode, 
    xmlNodePtr lastNode);  

Discussion

xmlEntityReferenceFunc: @ent: the entity @firstNode: the fist node in the chunk @lastNode: the last nod in the chunk

Callback function used when one needs to be able to track back the provenance of a chunk of nodes inherited from an entity replacement.

Globals

extern  unsigned int xmlParserMaxDepth;  

Discussion

xmlParserMaxDepth:

arbitrary depth limit for the XML documents that we allow to process. This is not a limitation of the parser but a safety boundary feature.

 Macros which declare an exportable function */
#define XMLPUBFUN  ;  

Discussion

Parser context.

 Macros which declare an exportable function */
#define XMLPUBFUN  ;  

Discussion

Entities

 Macros which declare an exportable function */
#define XMLPUBFUN  ;  

Discussion

Input Streams.

 Macros which declare an exportable function */
#define XMLPUBFUN  ;  

Discussion

Namespaces.

 Macros which declare an exportable function */
#define XMLPUBFUN  ;  

Discussion

Generic production rules.

#defines

#define INPUT_CHUNK 250 

Discussion

INPUT_CHUNK:

The parser tries to always have that amount of input ready. One of the point is providing context when reporting errors.

#define IS_ASCII_DIGIT(
    c)  

Discussion

IS_ASCII_DIGIT(c) @c: an xmlChar value

Macro to check [0-9]

#define IS_ASCII_LETTER(
    c)   

Discussion

IS_ASCII_LETTER(c) @c: an xmlChar value

Macro to check [a-zA-Z]

#define IS_BASECHAR(
    c) xmlIsBaseCharQ(
    c) 

Discussion

IS_BASECHAR: @c: an UNICODE value (int)

Macro to check the following production in the XML spec:

[85] BaseChar ::= ... long list see REC ...

#define IS_BLANK(
    c) xmlIsBlankQ(
    c) 

Discussion

IS_BLANK: @c: an UNICODE value (int)

Macro to check the following production in the XML spec:

[3] S ::= (#x20 | #x9 | #xD | #xA)+

#define IS_BLANK_CH(
    c) xmlIsBlank_ch(
    c) 

Discussion

IS_BLANK_CH: @c: an xmlChar value (normally unsigned char)

Behaviour same as IS_BLANK

#define IS_BYTE_CHAR(
    c) xmlIsChar_ch(
    c) 

Discussion

IS_BYTE_CHAR: @c: an byte value (int)

Macro to check the following production in the XML spec:

[2] Char ::= #x9 | #xA | #xD | [#x20...] any byte character in the accepted range

#define IS_CHAR(
    c) xmlIsCharQ(
    c) 

Discussion

IS_CHAR: @c: an UNICODE value (int)

Macro to check the following production in the XML spec:

[2] Char ::= #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF] any Unicode character, excluding the surrogate blocks, FFFE, and FFFF.

#define IS_CHAR_CH(
    c) xmlIsChar_ch(
    c) 

Discussion

IS_CHAR_CH: @c: an xmlChar (usually an unsigned char)

Behaves like IS_CHAR on single-byte value

#define IS_COMBINING(
    c) xmlIsCombiningQ(
    c) 

Discussion

IS_COMBINING: @c: an UNICODE value (int)

Macro to check the following production in the XML spec:

[87] CombiningChar ::= ... long list see REC ...

#define IS_COMBINING_CH(
    c) 0 

Discussion

IS_COMBINING_CH: @c: an xmlChar (usually an unsigned char)

Always false (all combining chars > 0xff)

#define IS_DIGIT(
    c) xmlIsDigitQ(
    c) 

Discussion

IS_DIGIT: @c: an UNICODE value (int)

Macro to check the following production in the XML spec:

[88] Digit ::= ... long list see REC ...

#define IS_DIGIT_CH(
    c) xmlIsDigit_ch(
    c) 

Discussion

IS_DIGIT_CH: @c: an xmlChar value (usually an unsigned char)

Behaves like IS_DIGIT but with a single byte argument

#define IS_EXTENDER(
    c) xmlIsExtenderQ(
    c) 

Discussion

IS_EXTENDER: @c: an UNICODE value (int)

Macro to check the following production in the XML spec:


[89] Extender ::= #x00B7 | #x02D0 | #x02D1 | #x0387 | #x0640 | #x0E46 | #x0EC6 | #x3005 | [#x3031-#x3035] | [#x309D-#x309E] | [#x30FC-#x30FE]

#define IS_EXTENDER_CH(
    c) xmlIsExtender_ch(
    c) 

Discussion

IS_EXTENDER_CH: @c: an xmlChar value (usually an unsigned char)

Behaves like IS_EXTENDER but with a single-byte argument

#define IS_IDEOGRAPHIC(
    c) xmlIsIdeographicQ(
    c) 

Discussion

IS_IDEOGRAPHIC: @c: an UNICODE value (int)

Macro to check the following production in the XML spec:


[86] Ideographic ::= [#x4E00-#x9FA5] | #x3007 | [#x3021-#x3029]

#define IS_LETTER(
    c)  

Discussion

IS_LETTER: @c: an UNICODE value (int)

Macro to check the following production in the XML spec:


[84] Letter ::= BaseChar | Ideographic

#define IS_LETTER_CH(
    c) xmlIsBaseChar_ch(
    c) 

Discussion

IS_LETTER_CH: @c: an xmlChar value (normally unsigned char)

Macro behaves like IS_LETTER, but only check base chars

#define IS_PUBIDCHAR(
    c) xmlIsPubidCharQ(
    c) 

Discussion

IS_PUBIDCHAR: @c: an UNICODE value (int)

Macro to check the following production in the XML spec:


[13] PubidChar ::= #x20 | #xD | #xA | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%]

#define IS_PUBIDCHAR_CH(
    c) xmlIsPubidChar_ch(
    c) 

Discussion

IS_PUBIDCHAR_CH: @c: an xmlChar value (normally unsigned char)

Same as IS_PUBIDCHAR but for single-byte value

#define MOVETO_ENDTAG(
    p) \ while ((
    *p) && (
    *(
    p) != '>')) (
    p)++ 

Discussion

MOVETO_ENDTAG: @p: and UTF8 string pointer

Skips to the next '>' char.

#define MOVETO_STARTTAG(
    p) \ while ((
    *p) && (
    *(
    p) != '<')) (
    p)++ 

Discussion

MOVETO_STARTTAG: @p: and UTF8 string pointer

Skips to the next '<' char.

#define SKIP_EOL(
    p) \ if (
    *(
    p) == 0x13) {
    p++; if (
    *(
    p) == 0x10) p++; 
} \ if (
    *(
    p) == 0x10) {
    p++; if (
    *(
    p) == 0x13) p++; 
} 

Discussion

SKIP_EOL: @p: and UTF8 string pointer

Skips the end of line chars.

#define XML_MAX_NAMELEN 100 

Discussion

XML_MAX_NAMELEN:

Identifiers can be longer, but this will be more costly at runtime.

#define XML_SUBSTITUTE_BOTH 3 

Discussion

XML_SUBSTITUTE_BOTH:

Both general and parameter entities need to be substituted.

#define XML_SUBSTITUTE_NONE 0 

Discussion

XML_SUBSTITUTE_NONE:

If no entities need to be substituted.

#define XML_SUBSTITUTE_PEREF 2 

Discussion

XML_SUBSTITUTE_PEREF:

Whether parameter entities need to be substituted.

#define XML_SUBSTITUTE_REF 1 

Discussion

XML_SUBSTITUTE_REF:

Whether general entities need to be substituted.

Did this document help you? Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.

Last Updated: 2006-06-20