/opt/xml2/share/gtk-doc/html/libxml2
NameSizeModeActions
general.html54700644editdlrm
home.png6540644editdlrm
index.html43210644editdlrm
left.png4590644editdlrm
libxml2-c14n.html135460644editdlrm
libxml2-catalog.html365490644editdlrm
libxml2-chvalid.html198350644editdlrm
libxml2-debugXML.html333170644editdlrm
libxml2-dict.html135820644editdlrm
libxml2-DOCBparser.html173610644editdlrm
libxml2-encoding.html295150644editdlrm
libxml2-entities.html231260644editdlrm
libxml2-globals.html356420644editdlrm
libxml2-hash.html420550644editdlrm
libxml2-HTMLparser.html580950644editdlrm
libxml2-HTMLtree.html244160644editdlrm
libxml2-list.html255680644editdlrm
libxml2-nanoftp.html224030644editdlrm
libxml2-nanohttp.html166140644editdlrm
libxml2-parser.html1374950644editdlrm
libxml2-parserInternals.html1253570644editdlrm
libxml2-pattern.html193620644editdlrm
libxml2-relaxng.html352300644editdlrm
libxml2-SAX.html388750644editdlrm
libxml2-SAX2.html396590644editdlrm
libxml2-schemasInternals.html651190644editdlrm
libxml2-schematron.html171050644editdlrm
libxml2-threads.html128960644editdlrm
libxml2-tree.html2344020644editdlrm
libxml2-uri.html184340644editdlrm
libxml2-valid.html985040644editdlrm
libxml2-xinclude.html159200644editdlrm
libxml2-xlink.html173290644editdlrm
libxml2-xmlautomata.html351790644editdlrm
libxml2-xmlerror.html847130644editdlrm
libxml2-xmlexports.html35850644editdlrm
libxml2-xmlIO.html574960644editdlrm
libxml2-xmlmemory.html240120644editdlrm
libxml2-xmlmodule.html73700644editdlrm
libxml2-xmlreader.html1080930644editdlrm
libxml2-xmlregexp.html420130644editdlrm
libxml2-xmlsave.html148420644editdlrm
libxml2-xmlschemas.html425210644editdlrm
libxml2-xmlschemastypes.html444510644editdlrm
libxml2-xmlstring.html351130644editdlrm
libxml2-xmlunicode.html1065960644editdlrm
libxml2-xmlversion.html190260644editdlrm
libxml2-xmlwriter.html1120770644editdlrm
libxml2-xpath.html622850644editdlrm
libxml2-xpathInternals.html1449130644editdlrm
libxml2-xpointer.html254530644editdlrm
libxml2.devhelp3431850644editdlrm
right.png4720644editdlrm
style.css8200644editdlrm
up.png4060644editdlrm
Edit: /opt/xml2/share/gtk-doc/html/libxml2/libxml2-DOCBparser.html (17361B)
DOCBparser: old DocBook SGML parser

DOCBparser

DOCBparser - old DocBook SGML parser

interface for a DocBook SGML non-verifying parser This code is DEPRECATED, and should not be used anymore.

WARNING: this module is deprecated !

Author(s): Daniel Veillard

Synopsis

typedef xmlParserInputPtr docbParserInputPtr;
typedef xmlParserCtxt docbParserCtxt;
typedef xmlParserCtxtPtr docbParserCtxtPtr;
typedef xmlParserInput docbParserInput;
typedef xmlDocPtr docbDocPtr;
typedef xmlSAXHandler docbSAXHandler;
typedef xmlSAXHandlerPtr docbSAXHandlerPtr;
void	docbFreeParserCtxt		(docbParserCtxtPtr ctxt);
docbDocPtr	docbParseDoc		(xmlChar * cur, 
const char * encoding); docbParserCtxtPtr docbCreateFileParserCtxt (const char * filename,
const char * encoding); docbDocPtr docbSAXParseFile (const char * filename,
const char * encoding,
docbSAXHandlerPtr sax,
void * userData); docbDocPtr docbSAXParseDoc (xmlChar * cur,
const char * encoding,
docbSAXHandlerPtr sax,
void * userData); docbParserCtxtPtr docbCreatePushParserCtxt (docbSAXHandlerPtr sax,
void * user_data,
const char * chunk,
int size,
const char * filename,
xmlCharEncoding enc); int docbEncodeEntities (unsigned char * out,
int * outlen,
const unsigned char * in,
int * inlen,
int quoteChar); docbDocPtr docbParseFile (const char * filename,
const char * encoding); int docbParseDocument (docbParserCtxtPtr ctxt); int docbParseChunk (docbParserCtxtPtr ctxt,
const char * chunk,
int size,
int terminate);

Description

Details

Typedef docbDocPtr

xmlDocPtr docbDocPtr;


Typedef docbParserCtxt

xmlParserCtxt docbParserCtxt;


Typedef docbParserCtxtPtr

xmlParserCtxtPtr docbParserCtxtPtr;


Typedef docbParserInput

xmlParserInput docbParserInput;


Typedef docbParserInputPtr

xmlParserInputPtr docbParserInputPtr;


Typedef docbSAXHandler

xmlSAXHandler docbSAXHandler;


Typedef docbSAXHandlerPtr

xmlSAXHandlerPtr docbSAXHandlerPtr;


docbCreateFileParserCtxt ()

docbParserCtxtPtr	docbCreateFileParserCtxt	(const char * filename, 
const char * encoding)

Create a parser context for a file content. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time.

filename:the filename
encoding:the SGML document encoding, or NULL
Returns:the new parser context or NULL

docbCreatePushParserCtxt ()

docbParserCtxtPtr	docbCreatePushParserCtxt	(docbSAXHandlerPtr sax, 
void * user_data,
const char * chunk,
int size,
const char * filename,
xmlCharEncoding enc)

Create a parser context for using the DocBook SGML parser in push mode To allow content encoding detection, @size should be >= 4 The value of @filename is used for fetching external entities and error/warning reports.

sax:a SAX handler
user_data:The user data returned on SAX callbacks
chunk:a pointer to an array of chars
size:number of chars in the array
filename:an optional file name or URI
enc:an optional encoding
Returns:the new parser context or NULL


docbFreeParserCtxt ()

void	docbFreeParserCtxt		(docbParserCtxtPtr ctxt)

Free all the memory used by a parser context. However the parsed document in ctxt->myDoc is not freed.

ctxt:an SGML parser context

docbParseChunk ()

int	docbParseChunk			(docbParserCtxtPtr ctxt, 
const char * chunk,
int size,
int terminate)

Parse a Chunk of memory

ctxt:an XML parser context
chunk:an char array
size:the size in byte of the chunk
terminate:last chunk indicator
Returns:zero if no error, the xmlParserErrors otherwise.

docbParseDoc ()

docbDocPtr	docbParseDoc		(xmlChar * cur, 
const char * encoding)

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

cur:a pointer to an array of xmlChar
encoding:a free form C string describing the SGML document encoding, or NULL
Returns:the resulting document tree

docbParseDocument ()

int	docbParseDocument		(docbParserCtxtPtr ctxt)

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

ctxt:an SGML parser context
Returns:0, -1 in case of error. the parser context is augmented as a result of the parsing.

docbParseFile ()

docbDocPtr	docbParseFile		(const char * filename, 
const char * encoding)

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

filename:the filename
encoding:a free form C string describing document encoding, or NULL
Returns:the resulting document tree

docbSAXParseDoc ()

docbDocPtr	docbSAXParseDoc		(xmlChar * cur, 
const char * encoding,
docbSAXHandlerPtr sax,
void * userData)

parse an SGML 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.

cur:a pointer to an array of xmlChar
encoding:a free form C string describing the SGML document encoding, or NULL
sax:the SAX handler block
userData:if using SAX, this pointer will be provided on callbacks.
Returns:the resulting document tree

docbSAXParseFile ()

docbDocPtr	docbSAXParseFile	(const char * filename, 
const char * encoding,
docbSAXHandlerPtr sax,
void * userData)

parse an SGML 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.

filename:the filename
encoding:a free form C string describing the SGML document encoding, or NULL
sax:the SAX handler block
userData:if using SAX, this pointer will be provided on callbacks.
Returns:the resulting document tree