| Gnome XML Library Reference Manual | |||
|---|---|---|---|
| <<< Previous Page | Home | Up | Next Page >>> |
xmlParserInputPtr (*xmlExternalEntityLoader) (const char *URL, const char *ID, xmlParserCtxtPtr context); |
| URL : | |
| ID : | |
| context : | |
| Returns : |
struct xmlParserNodeInfo {
const struct _xmlNode* node;
/* Position & line # that text that created the node begins & ends on */
unsigned long begin_pos;
unsigned long begin_line;
unsigned long end_pos;
unsigned long end_line;
}; |
struct xmlParserNodeInfoSeq {
unsigned long maximum;
unsigned long length;
xmlParserNodeInfo* buffer;
}; |
typedef enum {
XML_PARSER_EOF = -1, /* nothing is to be parsed */
XML_PARSER_START = 0, /* nothing has been parsed */
XML_PARSER_MISC, /* Misc* before int subset */
XML_PARSER_PI, /* Whithin a processing instruction */
XML_PARSER_DTD, /* within some DTD content */
XML_PARSER_PROLOG, /* Misc* after internal subset */
XML_PARSER_COMMENT, /* within a comment */
XML_PARSER_START_TAG, /* within a start tag */
XML_PARSER_CONTENT, /* within the content */
XML_PARSER_CDATA_SECTION, /* within a CDATA section */
XML_PARSER_END_TAG, /* within a closing tag */
XML_PARSER_ENTITY_DECL, /* within an entity declaration */
XML_PARSER_ENTITY_VALUE, /* within an entity value in a decl */
XML_PARSER_ATTRIBUTE_VALUE, /* within an attribute value */
XML_PARSER_SYSTEM_LITERAL, /* within a SYSTEM value */
XML_PARSER_EPILOG /* the Misc* after the last end tag */
} xmlParserInputState; |
struct xmlParserCtxt {
struct _xmlSAXHandler *sax; /* The SAX handler */
void *userData; /* the document being built */
xmlDocPtr myDoc; /* the document being built */
int wellFormed; /* is the document well formed */
int replaceEntities; /* shall we replace entities ? */
const xmlChar *version; /* the XML version string */
const xmlChar *encoding; /* encoding, if any */
int standalone; /* standalone document */
int html; /* are we parsing an HTML document */
/* Input stream stack */
xmlParserInputPtr input; /* Current input stream */
int inputNr; /* Number of current input streams */
int inputMax; /* Max number of input streams */
xmlParserInputPtr *inputTab; /* stack of inputs */
/* Node analysis stack only used for DOM building */
xmlNodePtr node; /* Current parsed Node */
int nodeNr; /* Depth of the parsing stack */
int nodeMax; /* Max depth of the parsing stack */
xmlNodePtr *nodeTab; /* array of nodes */
int record_info; /* Whether node info should be kept */
xmlParserNodeInfoSeq node_seq; /* info about each node parsed */
int errNo; /* error code */
int hasExternalSubset; /* reference and external subset */
int hasPErefs; /* the internal subset has PE refs */
int external; /* are we parsing an external entity */
int valid; /* is the document valid */
int validate; /* shall we try to validate ? */
xmlValidCtxt vctxt; /* The validity context */
xmlParserInputState instate; /* current type of input */
int token; /* next char look-ahead */
char *directory; /* the data directory */
/* Node name stack */
xmlChar *name; /* Current parsed Node */
int nameNr; /* Depth of the parsing stack */
int nameMax; /* Max depth of the parsing stack */
xmlChar * *nameTab; /* array of nodes */
long nbChars; /* number of xmlChar processed */
long checkIndex; /* used by progressive parsing lookup */
int keepBlanks; /* ugly but ... */
int disableSAX; /* SAX callbacks are disabled */
int inSubset; /* Parsing is in int 1/ext 2 subset */
xmlChar * intSubName; /* name of subset */
xmlChar * extSubURI; /* URI of external subset */
xmlChar * extSubSystem; /* SYSTEM ID of external subset */
/* xml:space values */
int * space; /* Should the parser preserve spaces */
int spaceNr; /* Depth of the parsing stack */
int spaceMax; /* Max depth of the parsing stack */
int * spaceTab; /* array of space infos */
int depth; /* to prevent entity substitution loops */
xmlParserInputPtr entity; /* used to check entities boundaries */
}; |
struct xmlSAXLocator {
const xmlChar *(*getPublicId)(void *ctx);
const xmlChar *(*getSystemId)(void *ctx);
int (*getLineNumber)(void *ctx);
int (*getColumnNumber)(void *ctx);
}; |
xmlParserInputPtr (*resolveEntitySAXFunc) (void *ctx, const xmlChar *publicId, const xmlChar *systemId); |
| ctx : | |
| publicId : | |
| systemId : | |
| Returns : |
void (*internalSubsetSAXFunc) (void *ctx,
const xmlChar *name,
const xmlChar *ExternalID,
const xmlChar *SystemID); |
| ctx : | |
| name : | |
| ExternalID : | |
| SystemID : |
xmlEntityPtr (*getEntitySAXFunc) (void *ctx, const xmlChar *name); |
| ctx : | |
| name : | |
| Returns : |
xmlEntityPtr (*getParameterEntitySAXFunc) (void *ctx, const xmlChar *name); |
| ctx : | |
| name : | |
| Returns : |
void (*entityDeclSAXFunc) (void *ctx,
const xmlChar *name,
int type,
const xmlChar *publicId,
const xmlChar *systemId,
xmlChar *content); |
| ctx : | |
| name : | |
| type : | |
| publicId : | |
| systemId : | |
| content : |
void (*notationDeclSAXFunc) (void *ctx,
const xmlChar *name,
const xmlChar *publicId,
const xmlChar *systemId); |
| ctx : | |
| name : | |
| publicId : | |
| systemId : |
void (*attributeDeclSAXFunc) (void *ctx,
const xmlChar *elem,
const xmlChar *name,
int type,
int def,
const xmlChar *defaultValue,
xmlEnumerationPtr tree); |
| ctx : | |
| elem : | |
| name : | |
| type : | |
| def : | |
| defaultValue : | |
| tree : |
void (*elementDeclSAXFunc) (void *ctx,
const xmlChar *name,
int type,
xmlElementContentPtr content); |
| ctx : | |
| name : | |
| type : | |
| content : |
void (*unparsedEntityDeclSAXFunc) (void *ctx,
const xmlChar *name,
const xmlChar *publicId,
const xmlChar *systemId,
const xmlChar *notationName); |
| ctx : | |
| name : | |
| publicId : | |
| systemId : | |
| notationName : |
void (*setDocumentLocatorSAXFunc) (void *ctx,
xmlSAXLocatorPtr loc); |
| ctx : | |
| loc : |
void (*startElementSAXFunc) (void *ctx,
const xmlChar *name,
const xmlChar **atts); |
| ctx : | |
| name : | |
| atts : |
void (*attributeSAXFunc) (void *ctx,
const xmlChar *name,
const xmlChar *value); |
| ctx : | |
| name : | |
| value : |
void (*charactersSAXFunc) (void *ctx,
const xmlChar *ch,
int len); |
| ctx : | |
| ch : | |
| len : |
void (*ignorableWhitespaceSAXFunc) (void *ctx,
const xmlChar *ch,
int len); |
| ctx : | |
| ch : | |
| len : |
void (*processingInstructionSAXFunc) (void *ctx,
const xmlChar *target,
const xmlChar *data); |
| ctx : | |
| target : | |
| data : |
void (*cdataBlockSAXFunc) (void *ctx,
const xmlChar *value,
int len); |
| ctx : | |
| value : | |
| len : |
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 : |
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 : |
xmlChar* xmlStrndup (const xmlChar *cur, int len); |
a strndup for array of xmlChar's
| cur : | |
| len : | |
| Returns : |
xmlChar* xmlStrsub (const xmlChar *str, int start, int len); |
Extract a substring of a given string
| str : | |
| start : | |
| len : | |
| Returns : |
const xmlChar* xmlStrchr (const xmlChar *str, xmlChar val); |
a strchr for xmlChar's
| str : | |
| val : | |
| Returns : |
const xmlChar* xmlStrstr (const xmlChar *str, xmlChar *val); |
a strstr for xmlChar's
| str : | |
| val : | |
| Returns : |
int xmlStrcmp (const xmlChar *str1, const xmlChar *str2); |
a strcmp for xmlChar's
| str1 : | |
| str2 : | |
| Returns : |
int xmlStrncmp (const xmlChar *str1, const xmlChar *str2, int len); |
a strncmp for xmlChar's
| str1 : | |
| str2 : | |
| len : | |
| Returns : |
xmlChar* xmlStrcat (xmlChar *cur, const xmlChar *add); |
a strcat for array of xmlChar's
| cur : | |
| add : | |
| Returns : |
xmlChar* xmlStrncat (xmlChar *cur, const xmlChar *add, int len); |
a strncat for array of xmlChar's
| cur : | |
| add : | |
| len : | |
| Returns : |
xmlDocPtr xmlParseDoc (xmlChar *cur); |
parse an XML in-memory document and build a tree.
| cur : | |
| Returns : |
xmlDocPtr xmlParseMemory (char *buffer, int size); |
parse an XML in-memory block and build a tree.
| buffer : | |
| size : | |
| Returns : |
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 : |
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::
| val : | |
| Returns : |
xmlDocPtr xmlRecoverDoc (xmlChar *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 : |
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 : |
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 : |
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 : |
xmlDocPtr xmlSAXParseDoc (xmlSAXHandlerPtr sax, xmlChar *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 : |
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 : |
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 : |
xmlDtdPtr xmlParseDTD (const xmlChar *ExternalID, const xmlChar *SystemID); |
Load and parse an external subset.
| ExternalID : | |
| SystemID : | |
| Returns : |
xmlDtdPtr xmlSAXParseDTD (xmlSAXHandlerPtr sax, const xmlChar *ExternalID, const xmlChar *SystemID); |
Load and parse an external subset.
| sax : | |
| ExternalID : | |
| SystemID : | |
| Returns : |
void xmlInitParserCtxt (xmlParserCtxtPtr ctxt); |
Initialize a parser context
| ctxt : |
void xmlClearParserCtxt (xmlParserCtxtPtr ctxt); |
Clear (release owned resources) and reinitialize a parser context
| ctxt : |
void xmlSetupParserForBuffer (xmlParserCtxtPtr ctxt, const xmlChar *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 : |
void htmlDefaultSAXHandlerInit (void); |
Initialize the default SAX handler
const xmlParserNodeInfo* xmlParserFindNodeInfo (const xmlParserCtxt *ctxt, const xmlNode *node); |
Find the parser node info struct for a given node
| ctxt : | |
| node : | |
| Returns : |
void xmlInitNodeInfoSeq (xmlParserNodeInfoSeqPtr seq); |
-- Initialize (set to initial state) node info sequence
| seq : |
void xmlClearNodeInfoSeq (xmlParserNodeInfoSeqPtr seq); |
-- Clear (release memory and reinitialize) node info sequence
| seq : |
unsigned |
xmlParserFindNodeInfoIndex : Find the index that the info record for the given node is or should be at in a sorted sequence
| seq : | |
| node : | |
| Returns : |
void xmlParserAddNodeInfo (xmlParserCtxtPtr ctxt, const xmlParserNodeInfo *info); |
Insert node info record into the sorted sequence
| ctxt : | |
| info : |
xmlParserInputPtr xmlLoadExternalEntity (const char *URL, const char *ID, xmlParserCtxtPtr context); |
| URL : | |
| ID : | |
| context : | |
| Returns : |