http://swpat.ffii.org/
Action against software patents
http://www.gnome.org/
Gnome2 Logo
http://www.w3.org/Status
W3C Logo
http://www.redhat.com/
Red Hat Logo
http://xmlsoft.org/
Made with Libxml2 Logo
Module DOCBparser from libxml2
API Menu
../index.html
Main Menu
../docs.html
Developer Menu
../examples/index.html
Code Examples
index.html
API Menu
libxml-parser.html
Parser API
libxml-tree.html
Tree API
libxml-xmlreader.html
Reader API
../guidelines.html
XML Guidelines
../ChangeLog.html
ChangeLog
API Indexes
../APIchunk0.html
Alphabetic
../APIconstructors.html
Constructors
../APIfunctions.html
Functions/Types
../APIfiles.html
Modules
../APIsymbols.html
Symbols
Related links
http://mail.gnome.org/archives/xml/
Mail archive
http://xmlsoft.org/XSLT/
XSLT libxslt
http://phd.cs.unibo.it/gdome2/
DOM gdome2
http://www.aleksey.com/xmlsec/
XML-DSig xmlsec
ftp://xmlsoft.org/
FTP
http://www.zlatkovic.com/projects/libxml/
Windows binaries
http://www.blastwave.org/packages.php/libxml2
Solaris binaries
http://www.explain.com.au/oss/libxml2xslt.html
MacOsX binaries
http://libxmlplusplus.sourceforge.net/
C++ bindings
http://www.zend.com/php5/articles/php5-xmlphp.php#Heading4
PHP bindings
http://sourceforge.net/projects/libxml2-pas/
Pascal bindings
http://rubyforge.org/projects/xml-tools/
Ruby bindings
http://tclxml.sourceforge.net/
Tcl bindings
http://bugzilla.gnome.org/buglist.cgi?product=libxml2
Bug Tracker
index.html
Up
index.html
API documentation
../index.html
Home
../index.html
The XML C parser and toolkit of Gnome
libxml-HTMLparser.html
HTMLparser
libxml-HTMLparser.html
Next
This module is deprecated
interface for a DocBook SGML non-verifying parser This code is DEPRECATED, and should not be used anymore.
Table of Contents
Typedef
libxml-tree.html#xmlParserInputPtr
xmlParserInputPtr
docbParserInputPtr
Typedef
libxml-tree.html#xmlParserCtxt
xmlParserCtxt
docbParserCtxt
Typedef
libxml-tree.html#xmlParserCtxtPtr
xmlParserCtxtPtr
docbParserCtxtPtr
Typedef
libxml-tree.html#xmlParserInput
xmlParserInput
docbParserInput
Typedef
libxml-tree.html#xmlDocPtr
xmlDocPtr
docbDocPtr
Typedef
libxml-tree.html#xmlSAXHandler
xmlSAXHandler
docbSAXHandler
Typedef
libxml-tree.html#xmlSAXHandlerPtr
xmlSAXHandlerPtr
docbSAXHandlerPtr
void
#docbFreeParserCtxt
docbFreeParserCtxt
(
libxml-DOCBparser.html#docbParserCtxtPtr
docbParserCtxtPtr
ctxt)
libxml-DOCBparser.html#docbDocPtr
docbDocPtr
#docbParseDoc
docbParseDoc
(
libxml-xmlstring.html#xmlChar
xmlChar
* cur,
const char * encoding)
libxml-DOCBparser.html#docbParserCtxtPtr
docbParserCtxtPtr
#docbCreateFileParserCtxt
docbCreateFileParserCtxt
(const char * filename,
const char * encoding)
libxml-DOCBparser.html#docbDocPtr
docbDocPtr
#docbSAXParseFile
docbSAXParseFile
(const char * filename,
const char * encoding,
libxml-DOCBparser.html#docbSAXHandlerPtr
docbSAXHandlerPtr
sax,
void * userData)
libxml-DOCBparser.html#docbDocPtr
docbDocPtr
#docbSAXParseDoc
docbSAXParseDoc
(
libxml-xmlstring.html#xmlChar
xmlChar
* cur,
const char * encoding,
libxml-DOCBparser.html#docbSAXHandlerPtr
docbSAXHandlerPtr
sax,
void * userData)
libxml-DOCBparser.html#docbParserCtxtPtr
docbParserCtxtPtr
#docbCreatePushParserCtxt
docbCreatePushParserCtxt
(
libxml-DOCBparser.html#docbSAXHandlerPtr
docbSAXHandlerPtr
sax,
void * user_data,
const char * chunk,
int size,
const char * filename,
libxml-encoding.html#xmlCharEncoding
xmlCharEncoding
enc)
int
#docbEncodeEntities
docbEncodeEntities
(unsigned char * out,
int * outlen,
const unsigned char * in,
int * inlen,
int quoteChar)
libxml-DOCBparser.html#docbDocPtr
docbDocPtr
#docbParseFile
docbParseFile
(const char * filename,
const char * encoding)
int
#docbParseDocument
docbParseDocument
(
libxml-DOCBparser.html#docbParserCtxtPtr
docbParserCtxtPtr
ctxt)
int
#docbParseChunk
docbParseChunk
(
libxml-DOCBparser.html#docbParserCtxtPtr
docbParserCtxtPtr
ctxt,
const char * chunk,
int size,
int terminate)
Description
Function: docbFreeParserCtxt
void	docbFreeParserCtxt		(
libxml-DOCBparser.html#docbParserCtxtPtr
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
Function: docbParseDoc
libxml-DOCBparser.html#docbDocPtr
docbDocPtr
docbParseDoc		(
libxml-xmlstring.html#xmlChar
xmlChar
* cur,
const char * encoding)
parse an SGML in-memory document and build a tree.
cur
:
a pointer to an array of
libxml-xmlstring.html#xmlChar
xmlChar
encoding
:
a free form C string describing the SGML document encoding, or NULL
Returns
:
the resulting document tree
Function: docbCreateFileParserCtxt
libxml-DOCBparser.html#docbParserCtxtPtr
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
Function: docbSAXParseFile
libxml-DOCBparser.html#docbDocPtr
docbDocPtr
docbSAXParseFile	(const char * filename,
const char * encoding,
libxml-DOCBparser.html#docbSAXHandlerPtr
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
Function: docbSAXParseDoc
libxml-DOCBparser.html#docbDocPtr
docbDocPtr
docbSAXParseDoc		(
libxml-xmlstring.html#xmlChar
xmlChar
* cur,
const char * encoding,
libxml-DOCBparser.html#docbSAXHandlerPtr
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
libxml-xmlstring.html#xmlChar
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
Function: docbCreatePushParserCtxt
libxml-DOCBparser.html#docbParserCtxtPtr
docbParserCtxtPtr
docbCreatePushParserCtxt	(
libxml-DOCBparser.html#docbSAXHandlerPtr
docbSAXHandlerPtr
sax,
void * user_data,
const char * chunk,
int size,
const char * filename,
libxml-encoding.html#xmlCharEncoding
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
Function: docbEncodeEntities
int	docbEncodeEntities		(unsigned char * out,
int * outlen,
const unsigned char * in,
int * inlen,
int quoteChar)
Take a block of UTF-8 chars in and try to convert it to an ASCII plus SGML entities block of chars out.
out
:
a pointer to an array of bytes to store the result
outlen
:
the length of @out
in
:
a pointer to an array of UTF-8 chars
inlen
:
the length of @in
quoteChar
:
the quote character to escape (' or ") or zero.
Returns
:
0 if success, -2 if the transcoding fails, or -1 otherwise The value of @inlen after return is the number of octets consumed as the return value is positive, else unpredictable. The value of @outlen after return is the number of octets consumed.
Function: docbParseFile
libxml-DOCBparser.html#docbDocPtr
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
Function: docbParseDocument
int	docbParseDocument		(
libxml-DOCBparser.html#docbParserCtxtPtr
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.
Function: docbParseChunk
int	docbParseChunk			(
libxml-DOCBparser.html#docbParserCtxtPtr
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
libxml-xmlerror.html#xmlParserErrors
xmlParserErrors
otherwise.
../bugs.html
Daniel Veillard
