libxml2

registerErrorHandler(f, ctx)

htmlParseFile(filename, encoding)

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

SAXDefaultVersion(version)

source code

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.

catalogAdd(type, orig, replace)

source code

Add an entry in the catalog, it may overwrite existing but different entries. If called before any other catalog routine, allows to override the default shared catalog put in place by xmlInitializeCatalog();

initializeCatalog()

source code

Do the catalog initialization. this function is not thread safe, catalog initialization should preferably be done once at startup

loadACatalog(filename)

source code

Load the catalog and build the associated data structures. This can be either an XML Catalog or an SGML Catalog It will recurse in SGML CATALOG entries. On the other hand XML Catalogs are not handled recursively.

loadCatalog(filename)

source code

Load the catalog and makes its definitions effective for the default external entity loader. It will recurse in SGML CATALOG entries. this function is not thread safe, catalog initialization should preferably be done once at startup

loadCatalogs(pathss)

source code

Load the catalogs and makes their definitions effective for the default external entity loader. this function is not thread safe, catalog initialization should preferably be done once at startup

loadSGMLSuperCatalog(filename)

source code

Load an SGML super catalog. It won't expand CATALOG or DELEGATE references. This is only needed for manipulating SGML Super Catalogs like adding and removing CATALOG or DELEGATE entries.

parseCatalogFile(filename)

source code

parse an XML file and build a tree. It's like xmlParseFile() except it bypass all catalog lookups.

isBaseChar(ch)

source code

This function is DEPRECATED. Use xmlIsBaseChar_ch or xmlIsBaseCharQ instead

isBlank(ch)

source code

This function is DEPRECATED. Use xmlIsBlank_ch or xmlIsBlankQ instead

isChar(ch)

source code

This function is DEPRECATED. Use xmlIsChar_ch or xmlIsCharQ instead

isCombining(ch)

source code

This function is DEPRECATED. Use xmlIsCombiningQ instead

isDigit(ch)

source code

This function is DEPRECATED. Use xmlIsDigit_ch or xmlIsDigitQ instead

isExtender(ch)

source code

This function is DEPRECATED. Use xmlIsExtender_ch or xmlIsExtenderQ instead

isIdeographic(ch)

source code

This function is DEPRECATED. Use xmlIsIdeographicQ instead

isPubidChar(ch)

source code

This function is DEPRECATED. Use xmlIsPubidChar_ch or xmlIsPubidCharQ instead

addEncodingAlias(name, alias)

source code

Registers an alias @alias for an encoding named @name. Existing alias will be overwritten.

initCharEncodingHandlers()

source code

Initialize the char encoding support, it registers the default encoding supported. NOTE: while public, this function usually doesn't need to be called in normal processing.

cleanupPredefinedEntities()

source code

Cleanup up the predefined entities table. Deprecated call

initializePredefinedEntities()

source code

Set up the predefined entities. Deprecated call

nanoFTPCleanup()

source code

Cleanup the FTP protocol layer. This cleanup proxy informations.

nanoFTPInit()

source code

Initialize the FTP protocol layer. Currently it just checks for proxy informations, and get the hostname

nanoFTPProxy(host, port, user, passwd, type)

source code

Setup the FTP proxy informations. This can also be done by using ftp_proxy ftp_proxy_user and ftp_proxy_password environment variables.

nanoFTPScanProxy(URL)

source code

(Re)Initialize the FTP Proxy context by parsing the URL and finding the protocol host port it indicates. Should be like ftp://myproxy/ or ftp://myproxy:3128/ A None URL cleans up proxy informations.

nanoHTTPInit()

source code

Initialize the HTTP protocol layer. Currently it just checks for proxy informations

nanoHTTPScanProxy(URL)

source code

(Re)Initialize the HTTP Proxy context by parsing the URL and finding the protocol host port it indicates. Should be like http://myproxy/ or http://myproxy:3128/ A None URL cleans up proxy informations.

initParser()

source code

Initialization function for the XML parser. This is not reentrant. Call once before processing in case of use in multithreaded programs.

keepBlanksDefault(val)

source code

Set and return the previous value for default blanks text nodes support. The 1.x version of the parser used an heuristic to try to detect ignorable white spaces. As a result the SAX callback was generating xmlSAX2IgnorableWhitespace() callbacks instead of characters() one, and when using the DOM output text nodes containing those blanks were not generated. The 2.x and later version will switch to the XML standard way and ignorableWhitespace() are only generated when running the parser in validating mode and when the current element doesn't allow CDATA or mixed content. This function is provided as a way to force the standard behavior on 1.X libs and to switch back to the old mode for compatibility when running 1.X client code on 2.X . Upgrade of 1.X code should be done by using xmlIsBlankNode() commodity function to detect the "empty" nodes generated. This value also affect autogeneration of indentation when saving code if blanks sections are kept, indentation is not generated.

lineNumbersDefault(val)

source code

Set and return the previous value for enabling line numbers in elements contents. This may break on old application and is turned off by default.

parseEntity(filename)

source code

parse an XML external entity out of context and build a tree. [78] extParsedEnt ::= TextDecl? content This correspond to a "Well Balanced" chunk

parseFile(filename)

source code

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

readFd(fd, URL, encoding, options)

source code

parse an XML from a file descriptor and build a tree. NOTE that the file descriptor will not be closed when the reader is closed or reset.

recoverDoc(cur)

source code

parse an XML in-memory document and build a tree. In the case the document is not Well Formed, a tree is built anyway

recoverFile(filename)

source code

parse an XML file and build a tree. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. In the case the document is not Well Formed, a tree is built anyway

recoverMemory(buffer, size)

source code

parse an XML in-memory block and build a tree. In the case the document is not Well Formed, a tree is built anyway

substituteEntitiesDefault(val)

source code

Set and return the previous value for default entity support. Initially the parser always keep entity references instead of substituting entity values in the output. This function has to be used to change the default parser behavior SAX::substituteEntities() has to be used for changing that on a file by file basis.

checkLanguageID(lang)

source code

Checks that the value conforms to the LanguageID production: NOTE: this is somewhat deprecated, those productions were removed from the XML Second edition. [33] LanguageID ::= Langcode ('-' Subcode)* [34] Langcode ::= ISO639Code | IanaCode | UserCode [35] ISO639Code ::= ([a-z] | [A-Z]) ([a-z] | [A-Z]) [36] IanaCode ::= ('i' | 'I') '-' ([a-z] | [A-Z])+ [37] UserCode ::= ('x' | 'X') '-' ([a-z] | [A-Z])+ [38] Subcode ::= ([a-z] | [A-Z])+

createFileParserCtxt(filename)

source code

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

createURLParserCtxt(filename, options)

source code

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

htmlCreateFileParserCtxt(filename, encoding)

source code

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

htmlInitAutoClose()

source code

Initialize the htmlStartCloseIndex for fast lookup of closing tags names. This is not reentrant. Call xmlInitParser() once before processing in case of use in multithreaded programs.

debugMemory(activate)

source code

Switch on the generation of line number for elements nodes. Also returns the number of bytes allocated and not freed by libxml2 since memory debugging was switched on.

pythonCleanupParser()

source code

Cleanup function for the XML library. It tries to reclaim all parsing related global memory allocated for the library processing. It doesn't deallocate any document related memory. Calling this function should not prevent reusing the library but one should call xmlCleanupParser() only when the process has finished using the library or XML document built with it.

buildQName(ncname, prefix, memory, len)

source code

Builds the QName @prefix:@ncname in @memory if there is enough space and prefix is not None nor empty, otherwise allocate a new string. If prefix is None or empty it returns ncname.

newPI(name, content)

source code

Creation of a processing instruction element. Use xmlDocNewPI preferably to get string interning

URIUnescapeString(str, len, target)

source code

Unescaping routine, but does not check that the string is an URI. The output is a direct unsigned char translation of %XX values (no encoding) Note that the length of the result can only be smaller or same size as the input string.

buildRelativeURI(URI, base)

source code

Expresses the URI of the reference in terms relative to the
base.  Some examples of this operation include: base =
"http://site1.com/docs/book1.html" URI input              
         URI returned docs/pic1.gif                   
pic1.gif docs/img/pic1.gif                img/pic1.gif
img/pic1.gif                     ../img/pic1.gif
http://site1.com/docs/pic1.gif   pic1.gif
http://site2.com/docs/pic1.gif  
http://site2.com/docs/pic1.gif  base = "docs/book1.html"
URI input                        URI returned
docs/pic1.gif                    pic1.gif
docs/img/pic1.gif                img/pic1.gif img/pic1.gif
                    ../img/pic1.gif
http://site1.com/docs/pic1.gif  
http://site1.com/docs/pic1.gif   Note: if the URI
reference is really wierd or complicated, it may be
worthwhile to first convert it into a "nice" one by
calling xmlBuildURI (using 'base') before calling this
routine, since this routine (for reasonable efficiency)
assumes URI has already been through some validation.

buildURI(URI, base)

source code

Computes he final URI of the reference done by checking that the given URI is valid, and building the final URI using the base URI. This is processed according to section 5.2 of the RFC 2396 5.2. Resolving Relative References to Absolute Form

normalizeURIPath(path)

source code

Applies the 5 normalization steps to a path string--that is, RFC 2396 Section 5.2, steps 6.c through 6.g. Normalization occurs directly on the string, no new allocation is done

parseURIRaw(str, raw)

source code

Parse an URI but allows to keep intact the original fragments. URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]

checkFilename(path)

source code

function checks to see if @path is a valid source (file, socket...) for XML. if stat is not available on the target machine,

cleanupInputCallbacks()

source code

clears the entire input callback table. this includes the compiled-in I/O.

cleanupOutputCallbacks()

source code

clears the entire output callback table. this includes the compiled-in I/O callbacks.

normalizeWindowsPath(path)

source code

This function is obsolete. Please see xmlURIFromPath in uri.c for a better solution.

popInputCallbacks()

source code

Clear the top input callback from the input stack. this includes the compiled-in I/O.

registerHTTPPostCallbacks()

source code

By default, libxml submits HTTP output requests using the "PUT" method. Calling this method changes the HTTP output method to use the "POST" method instead.

lastError()

source code

Get the last global error registered. This is per thread if compiled with thread support.

resetLastError()

source code

Cleanup the last global error registered. For parsing error this does not change the well-formedness result.

readerForDoc(cur, URL, encoding, options)

source code

Create an xmltextReader for an XML in-memory document. The parsing flags @options are a combination of xmlParserOption.

readerForFd(fd, URL, encoding, options)

source code

Create an xmltextReader for an XML from a file descriptor. The parsing flags @options are a combination of xmlParserOption. NOTE that the file descriptor will not be closed when the reader is closed or reset.

readerForFile(filename, encoding, options)

source code

parse an XML file from the filesystem or the network. The parsing flags @options are a combination of xmlParserOption.

readerForMemory(buffer, size, URL, encoding, options)

source code

Create an xmltextReader for an XML in-memory document. The parsing flags @options are a combination of xmlParserOption.

checkUTF8(utf)

source code

Checks @utf for being valid UTF-8. @utf is assumed to be null-terminated. This function is not super-strict, as it will allow longer UTF-8 sequences than necessary. Note that Java is capable of producing these sequences if provoked. Also note, this routine checks for the 4-byte maximum size, but does not check for 0x10ffff maximum value.

checkVersion(version)

source code

check the compiled lib version against the include one. This can warn or immediately kill the application

Module libxml2

registerErrorHandler(f, ctx)

htmlParseFile(filename, encoding)

SAXDefaultVersion(version)

catalogAdd(type, orig, replace)

initializeCatalog()

loadACatalog(filename)

loadCatalog(filename)

loadCatalogs(pathss)

loadSGMLSuperCatalog(filename)

parseCatalogFile(filename)

isBaseChar(ch)

isBlank(ch)

isChar(ch)

isCombining(ch)

isDigit(ch)

isExtender(ch)

isIdeographic(ch)

isPubidChar(ch)

addEncodingAlias(name, alias)

initCharEncodingHandlers()

cleanupPredefinedEntities()

initializePredefinedEntities()

nanoFTPCleanup()

nanoFTPInit()

nanoFTPProxy(host, port, user, passwd, type)

nanoFTPScanProxy(URL)

nanoHTTPInit()

nanoHTTPScanProxy(URL)

initParser()

keepBlanksDefault(val)

lineNumbersDefault(val)

parseEntity(filename)

parseFile(filename)

readFd(fd, URL, encoding, options)

recoverDoc(cur)

recoverFile(filename)

recoverMemory(buffer, size)

substituteEntitiesDefault(val)

checkLanguageID(lang)

createFileParserCtxt(filename)

createURLParserCtxt(filename, options)

htmlCreateFileParserCtxt(filename, encoding)

htmlInitAutoClose()

debugMemory(activate)

pythonCleanupParser()

buildQName(ncname, prefix, memory, len)

newPI(name, content)

URIUnescapeString(str, len, target)

buildRelativeURI(URI, base)

buildURI(URI, base)

normalizeURIPath(path)

parseURIRaw(str, raw)

checkFilename(path)

cleanupInputCallbacks()

cleanupOutputCallbacks()

normalizeWindowsPath(path)

popInputCallbacks()

registerHTTPPostCallbacks()

lastError()

resetLastError()

readerForDoc(cur, URL, encoding, options)

readerForFd(fd, URL, encoding, options)

readerForFile(filename, encoding, options)

readerForMemory(buffer, size, URL, encoding, options)

checkUTF8(utf)

checkVersion(version)