Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

parser

Name

parser —

Synopsis



#define     XML_DEFAULT_VERSION
void        (*xmlParserInputDeallocate)     (CHAR*);
typedef     xmlParserInputPtr;
typedef     xmlParserNodeInfo;
typedef     xmlParserNodeInfoSeq;
typedef     xmlParserNodeInfoSeqPtr;
enum        xmlParserInputState;
typedef     xmlParserCtxt;
typedef     xmlParserCtxtPtr;
typedef     xmlSAXLocator;
typedef     xmlSAXLocatorPtr;
xmlParserInputPtr (*resolveEntitySAXFunc)   (void *ctx,
                                             const CHAR *publicId,
                                             const CHAR *systemId);
void        (*internalSubsetSAXFunc)        (void *ctx,
                                             const CHAR *name,
                                             const CHAR *ExternalID,
                                             const CHAR *SystemID);
xmlEntityPtr (*getEntitySAXFunc)            (void *ctx,
                                             const CHAR *name);
xmlEntityPtr (*getParameterEntitySAXFunc)   (void *ctx,
                                             const CHAR *name);
void        (*entityDeclSAXFunc)            (void *ctx,
                                             const CHAR *name,
                                             int type,
                                             const CHAR *publicId,
                                             const CHAR *systemId,
                                             CHAR *content);
void        (*notationDeclSAXFunc)          (void *ctx,
                                             const CHAR *name,
                                             const CHAR *publicId,
                                             const CHAR *systemId);
void        (*attributeDeclSAXFunc)         (void *ctx,
                                             const CHAR *elem,
                                             const CHAR *name,
                                             int type,
                                             int def,
                                             const CHAR *defaultValue,
                                             xmlEnumerationPtr tree);
void        (*elementDeclSAXFunc)           (void *ctx,
                                             const CHAR *name,
                                             int type,
                                             xmlElementContentPtr content);
void        (*unparsedEntityDeclSAXFunc)    (void *ctx,
                                             const CHAR *name,
                                             const CHAR *publicId,
                                             const CHAR *systemId,
                                             const CHAR *notationName);
void        (*setDocumentLocatorSAXFunc)    (void *ctx,
                                             xmlSAXLocatorPtr loc);
void        (*startDocumentSAXFunc)         (void *ctx);
void        (*endDocumentSAXFunc)           (void *ctx);
void        (*startElementSAXFunc)          (void *ctx,
                                             const CHAR *name,
                                             const CHAR **atts);
void        (*endElementSAXFunc)            (void *ctx,
                                             const CHAR *name);
void        (*attributeSAXFunc)             (void *ctx,
                                             const CHAR *name,
                                             const CHAR *value);
void        (*referenceSAXFunc)             (void *ctx,
                                             const CHAR *name);
void        (*charactersSAXFunc)            (void *ctx,
                                             const CHAR *ch,
                                             int len);
void        (*ignorableWhitespaceSAXFunc)   (void *ctx,
                                             const CHAR *ch,
                                             int len);
void        (*processingInstructionSAXFunc) (void *ctx,
                                             const CHAR *target,
                                             const CHAR *data);
void        (*commentSAXFunc)               (void *ctx,
                                             const CHAR *value);
void        (*cdataBlockSAXFunc)            (void *ctx,
                                             const CHAR *value,
                                             int len);
void        (*warningSAXFunc)               (void *ctx,
                                             const char *msg,
                                             ...);
void        (*errorSAXFunc)                 (void *ctx,
                                             const char *msg,
                                             ...);
void        (*fatalErrorSAXFunc)            (void *ctx,
                                             const char *msg,
                                             ...);
int         (*isStandaloneSAXFunc)          (void *ctx);
int         (*hasInternalSubsetSAXFunc)     (void *ctx);
int         (*hasExternalSubsetSAXFunc)     (void *ctx);
typedef     xmlSAXHandlerPtr;
extern      const char *xmlParserVersion;
extern      xmlSAXLocator xmlDefaultSAXLocator;
extern      xmlSAXHandler xmlDefaultSAXHandler;
extern      xmlSAXHandler htmlDefaultSAXHandler;
int         xmlParserInputRead              (xmlParserInputPtr in,
                                             int len);
int         xmlParserInputGrow              (xmlParserInputPtr in,
                                             int len);
CHAR*       xmlStrdup                       (const CHAR *cur);
CHAR*       xmlStrndup                      (const CHAR *cur,
                                             int len);
CHAR*       xmlStrsub                       (const CHAR *str,
                                             int start,
                                             int len);
const CHAR* xmlStrchr                       (const CHAR *str,
                                             CHAR val);
const CHAR* xmlStrstr                       (const CHAR *str,
                                             CHAR *val);
int         xmlStrcmp                       (const CHAR *str1,
                                             const CHAR *str2);
int         xmlStrncmp                      (const CHAR *str1,
                                             const CHAR *str2,
                                             int len);
int         xmlStrlen                       (const CHAR *str);
CHAR*       xmlStrcat                       (CHAR *cur,
                                             const CHAR *add);
CHAR*       xmlStrncat                      (CHAR *cur,
                                             const CHAR *add,
                                             int len);
xmlDocPtr   xmlParseDoc                     (CHAR *cur);
xmlDocPtr   xmlParseMemory                  (char *buffer,
                                             int size);
xmlDocPtr   xmlParseFile                    (const char *filename);
int         xmlSubstituteEntitiesDefault    (int val);
xmlDocPtr   xmlRecoverDoc                   (CHAR *cur);
xmlDocPtr   xmlRecoverMemory                (char *buffer,
                                             int size);
xmlDocPtr   xmlRecoverFile                  (const char *filename);
int         xmlParseDocument                (xmlParserCtxtPtr ctxt);
xmlDocPtr   xmlSAXParseDoc                  (xmlSAXHandlerPtr sax,
                                             CHAR *cur,
                                             int recovery);
xmlDocPtr   xmlSAXParseMemory               (xmlSAXHandlerPtr sax,
                                             char *buffer,
                                             int size,
                                             int recovery);
xmlDocPtr   xmlSAXParseFile                 (xmlSAXHandlerPtr sax,
                                             const char *filename,
                                             int recovery);
xmlDtdPtr   xmlParseDTD                     (const CHAR *ExternalID,
                                             const CHAR *SystemID);
xmlDtdPtr   xmlSAXParseDTD                  (xmlSAXHandlerPtr sax,
                                             const CHAR *ExternalID,
                                             const CHAR *SystemID);
void        xmlInitParserCtxt               (xmlParserCtxtPtr ctxt);
void        xmlClearParserCtxt              (xmlParserCtxtPtr ctxt);
void        xmlSetupParserForBuffer         (xmlParserCtxtPtr ctxt,
                                             const CHAR *buffer,
                                             const char *filename);
const xmlParserNodeInfo* xmlParserFindNodeInfo
                                            (const xmlParserCtxt *ctxt,
                                             const xmlNode *node);
void        xmlInitNodeInfoSeq              (xmlParserNodeInfoSeqPtr seq);
void        xmlClearNodeInfoSeq             (xmlParserNodeInfoSeqPtr seq);
unsigned long xmlParserFindNodeInfoIndex    (const xmlParserNodeInfoSeq *seq,
                                             const xmlNode *node);
void        xmlParserAddNodeInfo            (xmlParserCtxtPtr ctxt,
                                             const xmlParserNodeInfo *info);
void        xmlDefaultSAXHandlerInit        (void);
void        htmlDefaultSAXHandlerInit       (void);

Description

Details

XML_DEFAULT_VERSION

#define     XML_DEFAULT_VERSION

xmlParserInputDeallocate ()

void        (*xmlParserInputDeallocate)     (CHAR*);

Param1 : 

xmlParserInputPtr

xmlParserNodeInfo

xmlParserNodeInfoSeq

xmlParserNodeInfoSeqPtr

enum xmlParserInputState

typedef enum xmlParserInputState {
    XML_PARSER_EOF = 0,
    XML_PARSER_PROLOG,
    XML_PARSER_CONTENT,
    XML_PARSER_ENTITY_DECL,
    XML_PARSER_ENTITY_VALUE,
    XML_PARSER_ATTRIBUTE_VALUE,
    XML_PARSER_DTD,
    XML_PARSER_EPILOG,
    XML_PARSER_COMMENT,
    XML_PARSER_CDATA_SECTION,
} xmlParserInputState;

xmlParserCtxt

xmlParserCtxtPtr

xmlSAXLocator

xmlSAXLocatorPtr

resolveEntitySAXFunc ()

xmlParserInputPtr (*resolveEntitySAXFunc)   (void *ctx,
                                             const CHAR *publicId,
                                             const CHAR *systemId);

ctx : 
publicId : 
systemId : 
Returns : 

internalSubsetSAXFunc ()

void        (*internalSubsetSAXFunc)        (void *ctx,
                                             const CHAR *name,
                                             const CHAR *ExternalID,
                                             const CHAR *SystemID);

ctx : 
name : 
ExternalID : 
SystemID : 

getEntitySAXFunc ()

xmlEntityPtr (*getEntitySAXFunc)            (void *ctx,
                                             const CHAR *name);

ctx : 
name : 
Returns : 

getParameterEntitySAXFunc ()

xmlEntityPtr (*getParameterEntitySAXFunc)   (void *ctx,
                                             const CHAR *name);

ctx : 
name : 
Returns : 

entityDeclSAXFunc ()

void        (*entityDeclSAXFunc)            (void *ctx,
                                             const CHAR *name,
                                             int type,
                                             const CHAR *publicId,
                                             const CHAR *systemId,
                                             CHAR *content);

ctx : 
name : 
type : 
publicId : 
systemId : 
content : 

notationDeclSAXFunc ()

void        (*notationDeclSAXFunc)          (void *ctx,
                                             const CHAR *name,
                                             const CHAR *publicId,
                                             const CHAR *systemId);

ctx : 
name : 
publicId : 
systemId : 

attributeDeclSAXFunc ()

void        (*attributeDeclSAXFunc)         (void *ctx,
                                             const CHAR *elem,
                                             const CHAR *name,
                                             int type,
                                             int def,
                                             const CHAR *defaultValue,
                                             xmlEnumerationPtr tree);

ctx : 
elem : 
name : 
type : 
def : 
defaultValue : 
tree : 

elementDeclSAXFunc ()

void        (*elementDeclSAXFunc)           (void *ctx,
                                             const CHAR *name,
                                             int type,
                                             xmlElementContentPtr content);

ctx : 
name : 
type : 
content : 

unparsedEntityDeclSAXFunc ()

void        (*unparsedEntityDeclSAXFunc)    (void *ctx,
                                             const CHAR *name,
                                             const CHAR *publicId,
                                             const CHAR *systemId,
                                             const CHAR *notationName);

ctx : 
name : 
publicId : 
systemId : 
notationName : 

setDocumentLocatorSAXFunc ()

void        (*setDocumentLocatorSAXFunc)    (void *ctx,
                                             xmlSAXLocatorPtr loc);

ctx : 
loc : 

startDocumentSAXFunc ()

void        (*startDocumentSAXFunc)         (void *ctx);

ctx : 

endDocumentSAXFunc ()

void        (*endDocumentSAXFunc)           (void *ctx);

ctx : 

startElementSAXFunc ()

void        (*startElementSAXFunc)          (void *ctx,
                                             const CHAR *name,
                                             const CHAR **atts);

ctx : 
name : 
atts : 

endElementSAXFunc ()

void        (*endElementSAXFunc)            (void *ctx,
                                             const CHAR *name);

ctx : 
name : 

attributeSAXFunc ()

void        (*attributeSAXFunc)             (void *ctx,
                                             const CHAR *name,
                                             const CHAR *value);

ctx : 
name : 
value : 

referenceSAXFunc ()

void        (*referenceSAXFunc)             (void *ctx,
                                             const CHAR *name);

ctx : 
name : 

charactersSAXFunc ()

void        (*charactersSAXFunc)            (void *ctx,
                                             const CHAR *ch,
                                             int len);

ctx : 
ch : 
len : 

ignorableWhitespaceSAXFunc ()

void        (*ignorableWhitespaceSAXFunc)   (void *ctx,
                                             const CHAR *ch,
                                             int len);

ctx : 
ch : 
len : 

processingInstructionSAXFunc ()

void        (*processingInstructionSAXFunc) (void *ctx,
                                             const CHAR *target,
                                             const CHAR *data);

ctx : 
target : 
data : 

commentSAXFunc ()

void        (*commentSAXFunc)               (void *ctx,
                                             const CHAR *value);

ctx : 
value : 

cdataBlockSAXFunc ()

void        (*cdataBlockSAXFunc)            (void *ctx,
                                             const CHAR *value,
                                             int len);

ctx : 
value : 
len : 

warningSAXFunc ()

void        (*warningSAXFunc)               (void *ctx,
                                             const char *msg,
                                             ...);

ctx : 
msg : 
... : 

errorSAXFunc ()

void        (*errorSAXFunc)                 (void *ctx,
                                             const char *msg,
                                             ...);

ctx : 
msg : 
... : 

fatalErrorSAXFunc ()

void        (*fatalErrorSAXFunc)            (void *ctx,
                                             const char *msg,
                                             ...);

ctx : 
msg : 
... : 

isStandaloneSAXFunc ()

int         (*isStandaloneSAXFunc)          (void *ctx);

ctx : 
Returns : 

hasInternalSubsetSAXFunc ()

int         (*hasInternalSubsetSAXFunc)     (void *ctx);

ctx : 
Returns : 

hasExternalSubsetSAXFunc ()

int         (*hasExternalSubsetSAXFunc)     (void *ctx);

ctx : 
Returns : 

xmlSAXHandlerPtr

xmlParserVersion

extern const char *xmlParserVersion;

xmlDefaultSAXLocator

extern xmlSAXLocator xmlDefaultSAXLocator;

xmlDefaultSAXHandler

extern xmlSAXHandler xmlDefaultSAXHandler;

htmlDefaultSAXHandler

extern xmlSAXHandler htmlDefaultSAXHandler;

xmlParserInputRead ()

int         xmlParserInputRead              (xmlParserInputPtr in,
                                             int len);

This function refresh the input for the parser. It doesn't try to preserve pointers to the input buffer, and discard already read data

in : 
len : 
Returns : 

xmlParserInputGrow ()

int         xmlParserInputGrow              (xmlParserInputPtr in,
                                             int len);

This function increase the input for the parser. It tries to preserve pointers to the input buffer, and keep already read data

in : 
len : 
Returns : 

xmlStrdup ()

CHAR*       xmlStrdup                       (const CHAR *cur);

a strdup for array of CHAR's

cur : 
Returns : 

xmlStrndup ()

CHAR*       xmlStrndup                      (const CHAR *cur,
                                             int len);

a strndup for array of CHAR's

cur : 
len : 
Returns : 

xmlStrsub ()

CHAR*       xmlStrsub                       (const CHAR *str,
                                             int start,
                                             int len);

Extract a substring of a given string

str : 
start : 
len : 
Returns : 

xmlStrchr ()

const CHAR* xmlStrchr                       (const CHAR *str,
                                             CHAR val);

a strchr for CHAR's

str : 
val : 
Returns : 

xmlStrstr ()

const CHAR* xmlStrstr                       (const CHAR *str,
                                             CHAR *val);

a strstr for CHAR's

str : 
val : 
Returns : 

xmlStrcmp ()

int         xmlStrcmp                       (const CHAR *str1,
                                             const CHAR *str2);

a strcmp for CHAR's

str1 : 
str2 : 
Returns : 

xmlStrncmp ()

int         xmlStrncmp                      (const CHAR *str1,
                                             const CHAR *str2,
                                             int len);

a strncmp for CHAR's

str1 : 
str2 : 
len : 
Returns : 

xmlStrlen ()

int         xmlStrlen                       (const CHAR *str);

lenght of a CHAR's string

str : 
Returns : 

xmlStrcat ()

CHAR*       xmlStrcat                       (CHAR *cur,
                                             const CHAR *add);

a strcat for array of CHAR's

cur : 
add : 
Returns : 

xmlStrncat ()

CHAR*       xmlStrncat                      (CHAR *cur,
                                             const CHAR *add,
                                             int len);

a strncat for array of CHAR's

cur : 
add : 
len : 
Returns : 

xmlParseDoc ()

xmlDocPtr   xmlParseDoc                     (CHAR *cur);

parse an XML in-memory document and build a tree.

cur : 
Returns : 

xmlParseMemory ()

xmlDocPtr   xmlParseMemory                  (char *buffer,
                                             int size);

parse an XML in-memory block and build a tree.

buffer : 
size : 
Returns : 

xmlParseFile ()

xmlDocPtr   xmlParseFile                    (const char *filename);

parse an XML file and build a tree. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time.

filename : 
Returns : 

xmlSubstituteEntitiesDefault ()

int         xmlSubstituteEntitiesDefault    (int val);

Set and return the previous value for default entity support. Initially the parser always keep entity references instead of substituting entity values in the output. This function has to be used to change the default parser behaviour SAX::subtituteEntities() has to be used for changing that on a file by file basis.

val : 
Returns : 

xmlRecoverDoc ()

xmlDocPtr   xmlRecoverDoc                   (CHAR *cur);

parse an XML in-memory document and build a tree. In the case the document is not Well Formed, a tree is built anyway

cur : 
Returns : 

xmlRecoverMemory ()

xmlDocPtr   xmlRecoverMemory                (char *buffer,
                                             int size);

parse an XML in-memory block and build a tree. In the case the document is not Well Formed, a tree is built anyway

buffer : 
size : 
Returns : 

xmlRecoverFile ()

xmlDocPtr   xmlRecoverFile                  (const char *filename);

parse an XML file and build a tree. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. In the case the document is not Well Formed, a tree is built anyway

filename : 
Returns : 

xmlParseDocument ()

int         xmlParseDocument                (xmlParserCtxtPtr ctxt);

parse an XML document (and build a tree if using the standard SAX interface).

[1] document ::= prolog element Misc*

[22] prolog ::= XMLDecl? Misc* (doctypedecl Misc*)?

ctxt : 
Returns : 

xmlSAXParseDoc ()

xmlDocPtr   xmlSAXParseDoc                  (xmlSAXHandlerPtr sax,
                                             CHAR *cur,
                                             int recovery);

parse an XML in-memory document and build a tree. It use the given SAX function block to handle the parsing callback. If sax is NULL, fallback to the default DOM tree building routines.

sax : 
cur : 
recovery : 
Returns : 

xmlSAXParseMemory ()

xmlDocPtr   xmlSAXParseMemory               (xmlSAXHandlerPtr sax,
                                             char *buffer,
                                             int size,
                                             int recovery);

parse an XML in-memory block and use the given SAX function block to handle the parsing callback. If sax is NULL, fallback to the default DOM tree building routines.

sax : 
buffer : 
size : 
recovery : 
Returns : 

xmlSAXParseFile ()

xmlDocPtr   xmlSAXParseFile                 (xmlSAXHandlerPtr sax,
                                             const char *filename,
                                             int recovery);

parse an XML file and build a tree. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. It use the given SAX function block to handle the parsing callback. If sax is NULL, fallback to the default DOM tree building routines.

sax : 
filename : 
recovery : 
Returns : 

xmlParseDTD ()

xmlDtdPtr   xmlParseDTD                     (const CHAR *ExternalID,
                                             const CHAR *SystemID);

Load and parse an external subset.

ExternalID : 
SystemID : 
Returns : 

xmlSAXParseDTD ()

xmlDtdPtr   xmlSAXParseDTD                  (xmlSAXHandlerPtr sax,
                                             const CHAR *ExternalID,
                                             const CHAR *SystemID);

Load and parse an external subset.

sax : 
ExternalID : 
SystemID : 
Returns : 

xmlInitParserCtxt ()

void        xmlInitParserCtxt               (xmlParserCtxtPtr ctxt);

Initialize a parser context

ctxt : 

xmlClearParserCtxt ()

void        xmlClearParserCtxt              (xmlParserCtxtPtr ctxt);

Clear (release owned resources) and reinitialize a parser context

ctxt : 

xmlSetupParserForBuffer ()

void        xmlSetupParserForBuffer         (xmlParserCtxtPtr ctxt,
                                             const CHAR *buffer,
                                             const char *filename);

Setup the parser context to parse a new buffer; Clears any prior contents from the parser context. The buffer parameter must not be NULL, but the filename parameter can be

ctxt : 
buffer : 
filename : 

xmlParserFindNodeInfo ()

const xmlParserNodeInfo* xmlParserFindNodeInfo
                                            (const xmlParserCtxt *ctxt,
                                             const xmlNode *node);

Find the parser node info struct for a given node

ctxt : 
node : 
Returns : 

xmlInitNodeInfoSeq ()

void        xmlInitNodeInfoSeq              (xmlParserNodeInfoSeqPtr seq);

-- Initialize (set to initial state) node info sequence

seq : 

xmlClearNodeInfoSeq ()

void        xmlClearNodeInfoSeq             (xmlParserNodeInfoSeqPtr seq);

-- Clear (release memory and reinitialize) node info sequence

seq : 

xmlParserFindNodeInfoIndex ()

unsigned long xmlParserFindNodeInfoIndex    (const xmlParserNodeInfoSeq *seq,
                                             const xmlNode *node);

xmlParserFindNodeInfoIndex : Find the index that the info record for the given node is or should be at in a sorted sequence

seq : 
node : 
Returns : 

xmlParserAddNodeInfo ()

void        xmlParserAddNodeInfo            (xmlParserCtxtPtr ctxt,
                                             const xmlParserNodeInfo *info);

Insert node info record into the sorted sequence

ctxt : 
info : 

xmlDefaultSAXHandlerInit ()

void        xmlDefaultSAXHandlerInit        (void);

Initialize the default SAX handler

htmlDefaultSAXHandlerInit ()

void        htmlDefaultSAXHandlerInit       (void);

Initialize the default SAX handler



<<< Previous PageHomeUpNext Page >>>
Gnome XML Librarytree