deps/src/libxml2-2.9.1/doc/devhelp/libxml2-SAX2.html
| | | | | libxml2 Reference Manual |
SAX2 - SAX2 parser interface used to build the DOM tree
those are the default SAX2 interfaces used by the library when building DOM tree.
Author(s): Daniel Veillard
void[xmlSAX2EndElementNs](#xmlSAX2EndElementNs)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* localname,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* prefix,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* URI);
void[xmlSAX2Reference](#xmlSAX2Reference)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name);
void[xmlSAX2ElementDecl](#xmlSAX2ElementDecl)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name,
int type,
[xmlElementContentPtr](libxml2-tree.html#xmlElementContentPtr)content);
void[xmlSAX2AttributeDecl](#xmlSAX2AttributeDecl)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* elem,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* fullname,
int type,
int def,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* defaultValue,
[xmlEnumerationPtr](libxml2-tree.html#xmlEnumerationPtr)tree);
void[xmlSAX2Comment](#xmlSAX2Comment)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* value);
int[xmlSAX2GetColumnNumber](#xmlSAX2GetColumnNumber)(void * ctx);[xmlEntityPtr](libxml2-tree.html#xmlEntityPtr)[xmlSAX2GetEntity](#xmlSAX2GetEntity)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name);
void[xmlSAX2UnparsedEntityDecl](#xmlSAX2UnparsedEntityDecl)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* publicId,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* systemId,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* notationName);
void[xmlSAX2InitDocbDefaultSAXHandler](#xmlSAX2InitDocbDefaultSAXHandler)([xmlSAXHandler](libxml2-tree.html#xmlSAXHandler)* hdlr);
int[xmlSAXVersion](#xmlSAXVersion)([xmlSAXHandler](libxml2-tree.html#xmlSAXHandler)* hdlr,
int version);
void[xmlSAX2IgnorableWhitespace](#xmlSAX2IgnorableWhitespace)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* ch,
int len);
void[xmlSAX2NotationDecl](#xmlSAX2NotationDecl)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* publicId,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* systemId);
void[xmlSAX2StartDocument](#xmlSAX2StartDocument)(void * ctx);
void[xmlSAX2EndElement](#xmlSAX2EndElement)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name);[xmlParserInputPtr](libxml2-tree.html#xmlParserInputPtr)[xmlSAX2ResolveEntity](#xmlSAX2ResolveEntity)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* publicId,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* systemId);
void[xmlSAX2ExternalSubset](#xmlSAX2ExternalSubset)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* ExternalID,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* SystemID);
const[xmlChar](libxml2-xmlstring.html#xmlChar)*[xmlSAX2GetPublicId](#xmlSAX2GetPublicId)(void * ctx);
int[xmlSAX2IsStandalone](#xmlSAX2IsStandalone)(void * ctx);
void[xmlSAX2EndDocument](#xmlSAX2EndDocument)(void * ctx);
void[xmlSAX2ProcessingInstruction](#xmlSAX2ProcessingInstruction)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* target,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* data);
void[xmlSAX2InternalSubset](#xmlSAX2InternalSubset)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* ExternalID,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* SystemID);
void[xmlSAX2Characters](#xmlSAX2Characters)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* ch,
int len);
int[xmlSAXDefaultVersion](#xmlSAXDefaultVersion)(int version);
void[xmlSAX2StartElement](#xmlSAX2StartElement)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* fullname,
const[xmlChar](libxml2-xmlstring.html#xmlChar)** atts);
void[xmlSAX2SetDocumentLocator](#xmlSAX2SetDocumentLocator)(void * ctx,
[xmlSAXLocatorPtr](libxml2-tree.html#xmlSAXLocatorPtr)loc);
void[xmlSAX2CDataBlock](#xmlSAX2CDataBlock)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* value,
int len);
void[xmlSAX2StartElementNs](#xmlSAX2StartElementNs)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* localname,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* prefix,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* URI,
int nb_namespaces,
const[xmlChar](libxml2-xmlstring.html#xmlChar)** namespaces,
int nb_attributes,
int nb_defaulted,
const[xmlChar](libxml2-xmlstring.html#xmlChar)** attributes);
int[xmlSAX2HasExternalSubset](#xmlSAX2HasExternalSubset)(void * ctx);
void[htmlDefaultSAXHandlerInit](#htmlDefaultSAXHandlerInit)(void);
int[xmlSAX2GetLineNumber](#xmlSAX2GetLineNumber)(void * ctx);
int[xmlSAX2HasInternalSubset](#xmlSAX2HasInternalSubset)(void * ctx);
void[xmlSAX2InitHtmlDefaultSAXHandler](#xmlSAX2InitHtmlDefaultSAXHandler)([xmlSAXHandler](libxml2-tree.html#xmlSAXHandler)* hdlr);
void[docbDefaultSAXHandlerInit](#docbDefaultSAXHandlerInit)(void);
void[xmlDefaultSAXHandlerInit](#xmlDefaultSAXHandlerInit)(void);
void[xmlSAX2InitDefaultSAXHandler](#xmlSAX2InitDefaultSAXHandler)([xmlSAXHandler](libxml2-tree.html#xmlSAXHandler)* hdlr,
int warning);[xmlEntityPtr](libxml2-tree.html#xmlEntityPtr)[xmlSAX2GetParameterEntity](#xmlSAX2GetParameterEntity)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name);
const[xmlChar](libxml2-xmlstring.html#xmlChar)*[xmlSAX2GetSystemId](#xmlSAX2GetSystemId)(void * ctx);
void[xmlSAX2EntityDecl](#xmlSAX2EntityDecl)(void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name,
int type,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* publicId,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* systemId,
[xmlChar](libxml2-xmlstring.html#xmlChar)* content);
void docbDefaultSAXHandlerInit (void)
Initialize the default SAX handler
void htmlDefaultSAXHandlerInit (void)
Initialize the default SAX handler
void xmlDefaultSAXHandlerInit (void)
Initialize the default SAX2 handler
void xmlSAX2AttributeDecl (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* elem,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* fullname,
int type,
int def,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* defaultValue,
[xmlEnumerationPtr](libxml2-tree.html#xmlEnumerationPtr)tree)
An attribute definition has been parsed
| ctx: | the user data (XML parser context) | | elem: | the name of the element | | fullname: | the attribute name | | type: | the attribute type | | def: | the type of default value | | defaultValue: | the attribute default value | | tree: | the tree of enumerated value set |
void xmlSAX2CDataBlock (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* value,
int len)
called when a pcdata block has been parsed
| ctx: | the user data (XML parser context) | | value: | The pcdata content | | len: | the block length |
void xmlSAX2Characters (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* ch,
int len)
receiving some chars from the parser.
| ctx: | the user data (XML parser context) | | ch: | a xmlChar string | | len: | the number of xmlChar |
void xmlSAX2Comment (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* value)
A xmlSAX2Comment has been parsed.
| ctx: | the user data (XML parser context) | | value: | the xmlSAX2Comment content |
void xmlSAX2ElementDecl (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name,
int type,
[xmlElementContentPtr](libxml2-tree.html#xmlElementContentPtr)content)
An element definition has been parsed
| ctx: | the user data (XML parser context) | | name: | the element name | | type: | the element type | | content: | the element value tree |
void xmlSAX2EndDocument (void * ctx)
called when the document end has been detected.
| ctx: | the user data (XML parser context) |
void xmlSAX2EndElement (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name)
called when the end of an element has been detected.
| ctx: | the user data (XML parser context) | | name: | The element name |
void xmlSAX2EndElementNs (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* localname,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* prefix,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* URI)
SAX2 callback when an element end has been detected by the parser. It provides the namespace informations for the element.
| ctx: | the user data (XML parser context) | | localname: | the local name of the element | | prefix: | the element namespace prefix if available | | URI: | the element namespace name if available |
void xmlSAX2EntityDecl (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name,
int type,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* publicId,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* systemId,
[xmlChar](libxml2-xmlstring.html#xmlChar)* content)
An entity definition has been parsed
| ctx: | the user data (XML parser context) | | name: | the entity name | | type: | the entity type | | publicId: | The public ID of the entity | | systemId: | The system ID of the entity | | content: | the entity value (without processing). |
void xmlSAX2ExternalSubset (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* ExternalID,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* SystemID)
Callback on external subset declaration.
| ctx: | the user data (XML parser context) | | name: | the root element name | | ExternalID: | the external ID | | SystemID: | the SYSTEM ID (e.g. filename or URL) |
int xmlSAX2GetColumnNumber (void * ctx)
Provide the column number of the current parsing point.
| ctx: | the user data (XML parser context) | | Returns: | an int |
[xmlEntityPtr](libxml2-tree.html#xmlEntityPtr)xmlSAX2GetEntity (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name)
Get an entity by name
| ctx: | the user data (XML parser context) | | name: | The entity name | | Returns: | the xmlEntityPtr if found. |
int xmlSAX2GetLineNumber (void * ctx)
Provide the line number of the current parsing point.
| ctx: | the user data (XML parser context) | | Returns: | an int |
[xmlEntityPtr](libxml2-tree.html#xmlEntityPtr)xmlSAX2GetParameterEntity (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name)
Get a parameter entity by name
| ctx: | the user data (XML parser context) | | name: | The entity name | | Returns: | the xmlEntityPtr if found. |
const[xmlChar](libxml2-xmlstring.html#xmlChar)* xmlSAX2GetPublicId (void * ctx)
Provides the public ID e.g. "-//SGMLSOURCE//DTD DEMO//EN"
| ctx: | the user data (XML parser context) | | Returns: | a xmlChar * |
const[xmlChar](libxml2-xmlstring.html#xmlChar)* xmlSAX2GetSystemId (void * ctx)
Provides the system ID, basically URL or filename e.g. http://www.sgmlsource.com/dtds/memo.dtd
| ctx: | the user data (XML parser context) | | Returns: | a xmlChar * |
int xmlSAX2HasExternalSubset (void * ctx)
Does this document has an external subset
| ctx: | the user data (XML parser context) | | Returns: | 1 if true |
int xmlSAX2HasInternalSubset (void * ctx)
Does this document has an internal subset
| ctx: | the user data (XML parser context) | | Returns: | 1 if true |
void xmlSAX2IgnorableWhitespace (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* ch,
int len)
receiving some ignorable whitespaces from the parser. UNUSED: by default the DOM building will use xmlSAX2Characters
| ctx: | the user data (XML parser context) | | ch: | a xmlChar string | | len: | the number of xmlChar |
void xmlSAX2InitDefaultSAXHandler ([xmlSAXHandler](libxml2-tree.html#xmlSAXHandler)* hdlr,
int warning)
Initialize the default XML SAX2 handler
| hdlr: | the SAX handler | | warning: | flag if non-zero sets the handler warning procedure |
void xmlSAX2InitDocbDefaultSAXHandler ([xmlSAXHandler](libxml2-tree.html#xmlSAXHandler)* hdlr)
Initialize the default DocBook SAX2 handler
| hdlr: | the SAX handler |
void xmlSAX2InitHtmlDefaultSAXHandler ([xmlSAXHandler](libxml2-tree.html#xmlSAXHandler)* hdlr)
Initialize the default HTML SAX2 handler
| hdlr: | the SAX handler |
void xmlSAX2InternalSubset (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* ExternalID,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* SystemID)
Callback on internal subset declaration.
| ctx: | the user data (XML parser context) | | name: | the root element name | | ExternalID: | the external ID | | SystemID: | the SYSTEM ID (e.g. filename or URL) |
int xmlSAX2IsStandalone (void * ctx)
Is this document tagged standalone ?
| ctx: | the user data (XML parser context) | | Returns: | 1 if true |
void xmlSAX2NotationDecl (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* publicId,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* systemId)
What to do when a notation declaration has been parsed.
| ctx: | the user data (XML parser context) | | name: | The name of the notation | | publicId: | The public ID of the entity | | systemId: | The system ID of the entity |
void xmlSAX2ProcessingInstruction (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* target,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* data)
A processing instruction has been parsed.
| ctx: | the user data (XML parser context) | | target: | the target name | | data: | the PI data's |
void xmlSAX2Reference (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name)
called when an entity xmlSAX2Reference is detected.
| ctx: | the user data (XML parser context) | | name: | The entity name |
[xmlParserInputPtr](libxml2-tree.html#xmlParserInputPtr)xmlSAX2ResolveEntity (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* publicId,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* systemId)
The entity loader, to control the loading of external entities, the application can either: - override this xmlSAX2ResolveEntity() callback in the SAX block - or better use the xmlSetExternalEntityLoader() function to set up it's own entity resolution routine
| ctx: | the user data (XML parser context) | | publicId: | The public ID of the entity | | systemId: | The system ID of the entity | | Returns: | the xmlParserInputPtr if inlined or NULL for DOM behaviour. |
void xmlSAX2SetDocumentLocator (void * ctx,
[xmlSAXLocatorPtr](libxml2-tree.html#xmlSAXLocatorPtr)loc)
Receive the document locator at startup, actually xmlDefaultSAXLocator Everything is available on the context, so this is useless in our case.
| ctx: | the user data (XML parser context) | | loc: | A SAX Locator |
void xmlSAX2StartDocument (void * ctx)
called when the document start being processed.
| ctx: | the user data (XML parser context) |
void xmlSAX2StartElement (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* fullname,
const[xmlChar](libxml2-xmlstring.html#xmlChar)** atts)
called when an opening tag has been processed.
| ctx: | the user data (XML parser context) | | fullname: | The element name, including namespace prefix | | atts: | An array of name/value attributes pairs, NULL terminated |
void xmlSAX2StartElementNs (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* localname,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* prefix,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* URI,
int nb_namespaces,
const[xmlChar](libxml2-xmlstring.html#xmlChar)** namespaces,
int nb_attributes,
int nb_defaulted,
const[xmlChar](libxml2-xmlstring.html#xmlChar)** attributes)
SAX2 callback when an element start has been detected by the parser. It provides the namespace informations for the element, as well as the new namespace declarations on the element.
| ctx: | the user data (XML parser context) | | localname: | the local name of the element | | prefix: | the element namespace prefix if available | | URI: | the element namespace name if available | | nb_namespaces: | number of namespace definitions on that node | | namespaces: | pointer to the array of prefix/URI pairs namespace definitions | | nb_attributes: | the number of attributes on that node | | nb_defaulted: | the number of defaulted attributes. | | attributes: | pointer to the array of (localname/prefix/URI/value/end) attribute values. |
void xmlSAX2UnparsedEntityDecl (void * ctx,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* publicId,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* systemId,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* notationName)
What to do when an unparsed entity declaration is parsed
| ctx: | the user data (XML parser context) | | name: | The name of the entity | | publicId: | The public ID of the entity | | systemId: | The system ID of the entity | | notationName: | the name of the notation |
int xmlSAXDefaultVersion (int version)
Set the default version of SAX used globally by the library. By default, during initialization the default is set to 2. Note that it is generally a better coding style to use xmlSAXVersion() to set up the version explicitly for a given parsing context.
| version: | the version, 1 or 2 | | Returns: | the previous value in case of success and -1 in case of error. |
int xmlSAXVersion ([xmlSAXHandler](libxml2-tree.html#xmlSAXHandler)* hdlr,
int version)
Initialize the default XML SAX handler according to the version
| hdlr: | the SAX handler | | version: | the version, 1 or 2 | | Returns: | 0 in case of success and -1 in case of error. |