HTMLparser		API documentation		The XML C parser and toolkit of Gnome	SAX

this module implements a few function needed to process tree in an HTML specific way.

Table of Contents

#define HTML_COMMENT_NODE

#define HTML_ENTITY_REF_NODE

#define HTML_PI_NODE

#define HTML_PRESERVE_NODE

#define HTML_TEXT_NODE

void	htmlDocContentDumpFormatOutput	(xmlOutputBufferPtr buf, 
					 xmlDocPtr cur, 
					 const char * encoding, 
					 int format)

void	htmlDocContentDumpOutput	(xmlOutputBufferPtr buf, 
					 xmlDocPtr cur, 
					 const char * encoding)

int	htmlDocDump			(FILE * f, 
					 xmlDocPtr cur)

void	htmlDocDumpMemory		(xmlDocPtr cur, 
					 xmlChar ** mem, 
					 int * size)

const xmlChar *	htmlGetMetaEncoding	(htmlDocPtr doc)

int	htmlIsBooleanAttr		(const xmlChar * name)

htmlDocPtr	htmlNewDoc		(const xmlChar * URI, 
					 const xmlChar * ExternalID)

htmlDocPtr	htmlNewDocNoDtD		(const xmlChar * URI, 
					 const xmlChar * ExternalID)

int	htmlNodeDump			(xmlBufferPtr buf, 
					 xmlDocPtr doc, 
					 xmlNodePtr cur)

void	htmlNodeDumpFile		(FILE * out, 
					 xmlDocPtr doc, 
					 xmlNodePtr cur)

int	htmlNodeDumpFileFormat		(FILE * out, 
					 xmlDocPtr doc, 
					 xmlNodePtr cur, 
					 const char * encoding, 
					 int format)

void	htmlNodeDumpFormatOutput	(xmlOutputBufferPtr buf, 
					 xmlDocPtr doc, 
					 xmlNodePtr cur, 
					 const char * encoding, 
					 int format)

void	htmlNodeDumpOutput		(xmlOutputBufferPtr buf, 
					 xmlDocPtr doc, 
					 xmlNodePtr cur, 
					 const char * encoding)

int	htmlSaveFile			(const char * filename, 
					 xmlDocPtr cur)

int	htmlSaveFileEnc			(const char * filename, 
					 xmlDocPtr cur, 
					 const char * encoding)

int	htmlSaveFileFormat		(const char * filename, 
					 xmlDocPtr cur, 
					 const char * encoding, 
					 int format)

int	htmlSetMetaEncoding		(htmlDocPtr doc, 
					 const xmlChar * encoding)

Description

Macro: HTML_COMMENT_NODE

#define HTML_COMMENT_NODE

Macro. A comment in a HTML document is really implemented the same way as a comment in an XML document.

Macro: HTML_ENTITY_REF_NODE

#define HTML_ENTITY_REF_NODE

Macro. An entity reference in a HTML document is really implemented the same way as an entity reference in an XML document.

Macro: HTML_PI_NODE

#define HTML_PI_NODE

Macro. A processing instruction in a HTML document is really implemented the same way as a processing instruction in an XML document.

Macro: HTML_PRESERVE_NODE

#define HTML_PRESERVE_NODE

Macro. A preserved node in a HTML document is really implemented the same way as a CDATA section in an XML document.

Macro: HTML_TEXT_NODE

#define HTML_TEXT_NODE

Macro. A text node in a HTML document is really implemented the same way as a text node in an XML document.

Function: htmlDocContentDumpFormatOutput

void	htmlDocContentDumpFormatOutput	(xmlOutputBufferPtr buf, 
					 xmlDocPtr cur, 
					 const char * encoding, 
					 int format)

Dump an HTML document.

Function: htmlDocContentDumpOutput

void	htmlDocContentDumpOutput	(xmlOutputBufferPtr buf, 
					 xmlDocPtr cur, 
					 const char * encoding)

Dump an HTML document. Formating return/spaces are added.

Function: htmlDocDump

int	htmlDocDump			(FILE * f, 
					 xmlDocPtr cur)

Dump an HTML document to an open FILE.

Function: htmlDocDumpMemory

void	htmlDocDumpMemory		(xmlDocPtr cur, 
					 xmlChar ** mem, 
					 int * size)

Dump an HTML document in memory and return the xmlChar * and it's size. It's up to the caller to free the memory.

Function: htmlGetMetaEncoding

const xmlChar *	htmlGetMetaEncoding	(htmlDocPtr doc)

Encoding definition lookup in the Meta tags

Function: htmlIsBooleanAttr

int	htmlIsBooleanAttr		(const xmlChar * name)

Determine if a given attribute is a boolean attribute.

Function: htmlNewDoc

htmlDocPtr	htmlNewDoc		(const xmlChar * URI, 
					 const xmlChar * ExternalID)

Creates a new HTML document

Function: htmlNewDocNoDtD

htmlDocPtr	htmlNewDocNoDtD		(const xmlChar * URI, 
					 const xmlChar * ExternalID)

Creates a new HTML document without a DTD node if @URI and @ExternalID are NULL

Function: htmlNodeDump

int	htmlNodeDump			(xmlBufferPtr buf, 
					 xmlDocPtr doc, 
					 xmlNodePtr cur)

Dump an HTML node, recursive behaviour,children are printed too, and formatting returns are added.

Function: htmlNodeDumpFile

void	htmlNodeDumpFile		(FILE * out, 
					 xmlDocPtr doc, 
					 xmlNodePtr cur)

Dump an HTML node, recursive behaviour,children are printed too, and formatting returns are added.

Function: htmlNodeDumpFileFormat

int	htmlNodeDumpFileFormat		(FILE * out, 
					 xmlDocPtr doc, 
					 xmlNodePtr cur, 
					 const char * encoding, 
					 int format)

Dump an HTML node, recursive behaviour,children are printed too. TODO: if encoding == NULL try to save in the doc encoding

Function: htmlNodeDumpFormatOutput

void	htmlNodeDumpFormatOutput	(xmlOutputBufferPtr buf, 
					 xmlDocPtr doc, 
					 xmlNodePtr cur, 
					 const char * encoding, 
					 int format)

Dump an HTML node, recursive behaviour,children are printed too.

Function: htmlNodeDumpOutput

void	htmlNodeDumpOutput		(xmlOutputBufferPtr buf, 
					 xmlDocPtr doc, 
					 xmlNodePtr cur, 
					 const char * encoding)

Dump an HTML node, recursive behaviour,children are printed too, and formatting returns/spaces are added.

Function: htmlSaveFile

int	htmlSaveFile			(const char * filename, 
					 xmlDocPtr cur)

Dump an HTML document to a file. If @filename is "-" the stdout file is used.

Function: htmlSaveFileEnc

int	htmlSaveFileEnc			(const char * filename, 
					 xmlDocPtr cur, 
					 const char * encoding)

Dump an HTML document to a file using a given encoding and formatting returns/spaces are added.

Function: htmlSaveFileFormat

int	htmlSaveFileFormat		(const char * filename, 
					 xmlDocPtr cur, 
					 const char * encoding, 
					 int format)

Dump an HTML document to a file using a given encoding.

Function: htmlSetMetaEncoding

int	htmlSetMetaEncoding		(htmlDocPtr doc, 
					 const xmlChar * encoding)

Sets the current encoding in the Meta tags NOTE: this will not change the document content encoding, just the META flag associated.

Daniel Veillard