  
    
    
    
    
    
    
    
  
  
    
      
        
          
general.html            
Up          
        
        
          
index.html            
Home          
        
        
          
libxml2-HTMLparser.html            
Next          
        
        
libxml2 Reference Manual      
    
    
      
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 libxml2-tree.html#xmlParserInputPtrxmlParserInputPtr  #docbParserInputPtrdocbParserInputPtr ;
typedef 
libxml2-tree.html#xmlParserCtxtxmlParserCtxt  #docbParserCtxtdocbParserCtxt ;
typedef 
libxml2-tree.html#xmlParserCtxtPtrxmlParserCtxtPtr  #docbParserCtxtPtrdocbParserCtxtPtr ;
typedef 
libxml2-tree.html#xmlParserInputxmlParserInput  #docbParserInputdocbParserInput ;
typedef 
libxml2-tree.html#xmlDocPtrxmlDocPtr  #docbDocPtrdocbDocPtr ;
typedef 
libxml2-tree.html#xmlSAXHandlerxmlSAXHandler  #docbSAXHandlerdocbSAXHandler ;
typedef 
libxml2-tree.html#xmlSAXHandlerPtrxmlSAXHandlerPtr  #docbSAXHandlerPtrdocbSAXHandlerPtr ;
void	
#docbFreeParserCtxtdocbFreeParserCtxt 		( libxml2-DOCBparser.html#docbParserCtxtPtrdocbParserCtxtPtr  ctxt);
libxml2-DOCBparser.html#docbDocPtrdocbDocPtr 	#docbParseDocdocbParseDoc 		( libxml2-xmlstring.html#xmlCharxmlChar  * cur, 					 const char * encoding);
libxml2-DOCBparser.html#docbParserCtxtPtrdocbParserCtxtPtr 	#docbCreateFileParserCtxtdocbCreateFileParserCtxt 	(const char * filename, 							 const char * encoding);
libxml2-DOCBparser.html#docbDocPtrdocbDocPtr 	#docbSAXParseFiledocbSAXParseFile 	(const char * filename, 					 const char * encoding, 					 libxml2-DOCBparser.html#docbSAXHandlerPtrdocbSAXHandlerPtr  sax, 					 void * userData);
libxml2-DOCBparser.html#docbDocPtrdocbDocPtr 	#docbSAXParseDocdocbSAXParseDoc 		( libxml2-xmlstring.html#xmlCharxmlChar  * cur, 					 const char * encoding, 					 libxml2-DOCBparser.html#docbSAXHandlerPtrdocbSAXHandlerPtr  sax, 					 void * userData);
libxml2-DOCBparser.html#docbParserCtxtPtrdocbParserCtxtPtr 	#docbCreatePushParserCtxtdocbCreatePushParserCtxt 	( libxml2-DOCBparser.html#docbSAXHandlerPtrdocbSAXHandlerPtr  sax, 							 void * user_data, 							 const char * chunk, 							 int size, 							 const char * filename, 							 libxml2-encoding.html#xmlCharEncodingxmlCharEncoding  enc);
int	
#docbEncodeEntitiesdocbEncodeEntities 		(unsigned char * out, 					 int * outlen, 					 const unsigned char * in, 					 int * inlen, 					 int quoteChar);
libxml2-DOCBparser.html#docbDocPtrdocbDocPtr 	#docbParseFiledocbParseFile 		(const char * filename, 					 const char * encoding);
int	
#docbParseDocumentdocbParseDocument 		( libxml2-DOCBparser.html#docbParserCtxtPtrdocbParserCtxtPtr  ctxt);
int	
#docbParseChunkdocbParseChunk 			( libxml2-DOCBparser.html#docbParserCtxtPtrdocbParserCtxtPtr  ctxt, 					 const char * chunk, 					 int size, 					 int terminate);
    
    
      
Description
    
    
      
Details
      
        
Typedef docbDocPtr
libxml2-tree.html#xmlDocPtrxmlDocPtr  docbDocPtr;
        
        
Typedef docbParserCtxt
libxml2-tree.html#xmlParserCtxtxmlParserCtxt  docbParserCtxt;
        
        
Typedef docbParserCtxtPtr
libxml2-tree.html#xmlParserCtxtPtrxmlParserCtxtPtr  docbParserCtxtPtr;
        
        
Typedef docbParserInput
libxml2-tree.html#xmlParserInputxmlParserInput  docbParserInput;
        
        
Typedef docbParserInputPtr
libxml2-tree.html#xmlParserInputPtrxmlParserInputPtr  docbParserInputPtr;
        
        
Typedef docbSAXHandler
libxml2-tree.html#xmlSAXHandlerxmlSAXHandler  docbSAXHandler;
        
        
Typedef docbSAXHandlerPtr
libxml2-tree.html#xmlSAXHandlerPtrxmlSAXHandlerPtr  docbSAXHandlerPtr;
        
        
docbCreateFileParserCtxt ()
libxml2-DOCBparser.html#docbParserCtxtPtrdocbParserCtxtPtr 	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 ()
libxml2-DOCBparser.html#docbParserCtxtPtrdocbParserCtxtPtr 	docbCreatePushParserCtxt	( libxml2-DOCBparser.html#docbSAXHandlerPtrdocbSAXHandlerPtr  sax, 							 void * user_data, 							 const char * chunk, 							 int size, 							 const char * filename, 							 libxml2-encoding.html#xmlCharEncodingxmlCharEncoding  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         
        
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.         
        
docbFreeParserCtxt ()
void	docbFreeParserCtxt		( libxml2-DOCBparser.html#docbParserCtxtPtrdocbParserCtxtPtr  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			( libxml2-DOCBparser.html#docbParserCtxtPtrdocbParserCtxtPtr  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 libxml2-xmlerror.html#xmlParserErrorsxmlParserErrors  otherwise.         
        
docbParseDoc ()
libxml2-DOCBparser.html#docbDocPtrdocbDocPtr 	docbParseDoc		( libxml2-xmlstring.html#xmlCharxmlChar  * cur, 					 const char * encoding)parse an SGML in-memory document and build a tree.
cur: a pointer to an array of libxml2-xmlstring.html#xmlCharxmlChar encoding: a free form C string describing the SGML document encoding, or NULL Returns: the resulting document tree         
        
docbParseDocument ()
int	docbParseDocument		( libxml2-DOCBparser.html#docbParserCtxtPtrdocbParserCtxtPtr  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 ()
libxml2-DOCBparser.html#docbDocPtrdocbDocPtr 	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 ()
libxml2-DOCBparser.html#docbDocPtrdocbDocPtr 	docbSAXParseDoc		( libxml2-xmlstring.html#xmlCharxmlChar  * cur, 					 const char * encoding, 					 libxml2-DOCBparser.html#docbSAXHandlerPtrdocbSAXHandlerPtr  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 libxml2-xmlstring.html#xmlCharxmlChar 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 ()
libxml2-DOCBparser.html#docbDocPtrdocbDocPtr 	docbSAXParseFile	(const char * filename, 					 const char * encoding, 					 libxml2-DOCBparser.html#docbSAXHandlerPtrdocbSAXHandlerPtr  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         
      
    
  
