diff --git a/ChangeLog b/ChangeLog index 087e598c..97081045 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Tue Jan 6 15:15:23 CET 2004 Daniel Veillard + + * include/libxml/xmlstring.h: fixed the comment in the header + * doc/*: rebuilt the docs + Tue Jan 6 19:40:04 HKT 2004 William Brack * encoding.c, parser.c, xmlstring.c, Makefile.am, diff --git a/doc/APIchunk10.html b/doc/APIchunk10.html index 8af93554..40985e7b 100644 --- a/doc/APIchunk10.html +++ b/doc/APIchunk10.html @@ -234,6 +234,7 @@ A:link, A:visited, A:active { text-decoration: underline }
checking
xlinkIsLink
xmlBufferWriteQuotedString
xmlBuildURI
+xmlMemFree
xmlUTF8Strlen
checkings
xmlValidateOneElement
checks
htmlAutoCloseTag
diff --git a/doc/APIchunk12.html b/doc/APIchunk12.html index 18598e71..a52927c7 100644 --- a/doc/APIchunk12.html +++ b/doc/APIchunk12.html @@ -223,7 +223,11 @@ A:link, A:visited, A:active { text-decoration: underline } xmlListDataCompare
equivalent
xmlMallocAtomicLoc
xmlMallocLoc
+xmlMemFree
+xmlMemMalloc
+xmlMemRealloc
xmlMemStrdupLoc
+xmlMemoryStrdup
xmlNodeListGetRawString
xmlNodeListGetString
xmlReallocLoc
diff --git a/doc/APIchunk15.html b/doc/APIchunk15.html index b27c3ec8..82af4ce2 100644 --- a/doc/APIchunk15.html +++ b/doc/APIchunk15.html @@ -232,7 +232,10 @@ A:link, A:visited, A:active { text-decoration: underline } xmlInitNodeInfoSeq
xmlMallocAtomicLoc
xmlMallocLoc
+xmlMemMalloc
+xmlMemRealloc
xmlMemStrdupLoc
+xmlMemoryStrdup
xmlNanoFTPList
xmlParserAddNodeInfo
xmlParserFindNodeInfo
@@ -292,7 +295,9 @@ A:link, A:visited, A:active { text-decoration: underline } xmlAutomataGetInitState
xmlBufferCreateSize
xmlInitNodeInfoSeq
+xmlMemRealloc
xmlMemStrdupLoc
+xmlMemoryStrdup
xmlReallocLoc
xmlShell
xmlXPathNodeSetAdd
@@ -372,27 +377,6 @@ A:link, A:visited, A:active { text-decoration: underline } xmlNewPI
xmlSAX2ProcessingInstruction
insufficient
xmlCanonicPath
-
int
_xmlParserCtxt
-c
-getColumnNumber
-getLineNumber
-htmlHandleOmittedElem
-htmlParseCharRef
-xmlIsLetter
-xmlKeepBlanksDefault
-xmlLineNumbersDefault
-xmlMallocAtomicLoc
-xmlMallocLoc
-xmlMemUsed
-xmlParseCharData
-xmlParseCharRef
-xmlPedanticParserDefault
-xmlReallocLoc
-xmlSAX2GetColumnNumber
-xmlSAX2GetLineNumber
-xmlShellCmd
-xmlSplitQName3
-xmlSubstituteEntitiesDefault
integer
xmlStrcasecmp
xmlStrcmp
xmlStrncasecmp
diff --git a/doc/APIchunk16.html b/doc/APIchunk16.html index fac04dbb..b28ed02e 100644 --- a/doc/APIchunk16.html +++ b/doc/APIchunk16.html @@ -92,6 +92,8 @@ A:link, A:visited, A:active { text-decoration: underline } xmlCharEncodingOutputFunc
xmlMallocAtomicLoc
xmlMallocLoc
+xmlMemMalloc
+xmlMemRealloc
xmlReallocLoc
lang
xmlNodeGetLang
xmlXPathLangFunction
@@ -338,7 +340,10 @@ A:link, A:visited, A:active { text-decoration: underline } xmlUnlockLibrary
logging
xmlMallocAtomicLoc
xmlMallocLoc
+xmlMemMalloc
+xmlMemRealloc
xmlMemStrdupLoc
+xmlMemoryStrdup
xmlReallocLoc
long
IS_BASECHAR
IS_COMBINING
diff --git a/doc/APIchunk17.html b/doc/APIchunk17.html index 28a1e9e3..9e1b43b1 100644 --- a/doc/APIchunk17.html +++ b/doc/APIchunk17.html @@ -60,6 +60,7 @@ A:link, A:visited, A:active { text-decoration: underline } xmlMallocFunc
xmlMallocLoc
xmlMemGet
+xmlMemMalloc
xmlMemSetup
mallocAtomicFunc
xmlGcMemGet
xmlGcMemSetup
diff --git a/doc/APIchunk19.html b/doc/APIchunk19.html index b6263ede..f533644d 100644 --- a/doc/APIchunk19.html +++ b/doc/APIchunk19.html @@ -60,6 +60,7 @@ A:link, A:visited, A:active { text-decoration: underline }
occurences
xmlAutomataNewCountTrans
xmlAutomataNewOnceTrans
occurred
xmlMemStrdupLoc
+xmlMemoryStrdup
occurrence
xmlStrcasestr
xmlStrchr
xmlStrstr
diff --git a/doc/APIchunk21.html b/doc/APIchunk21.html index 2e7420d2..e974f05b 100644 --- a/doc/APIchunk21.html +++ b/doc/APIchunk21.html @@ -141,6 +141,7 @@ A:link, A:visited, A:active { text-decoration: underline } xmlGcMemGet
xmlGcMemSetup
xmlMemGet
+xmlMemRealloc
xmlMemSetup
xmlReallocFunc
xmlReallocLoc
diff --git a/doc/APIchunk22.html b/doc/APIchunk22.html index 050b0b11..b689d437 100644 --- a/doc/APIchunk22.html +++ b/doc/APIchunk22.html @@ -443,6 +443,8 @@ A:link, A:visited, A:active { text-decoration: underline }
specify
xmlTextReaderLookupNamespace
specifying
xmlMallocAtomicLoc
xmlMallocLoc
+xmlMemMalloc
+xmlMemRealloc
xmlReallocLoc
speed
xmlXPathOrderDocElems
speedup
xmlTextReaderConstString
@@ -569,6 +571,7 @@ A:link, A:visited, A:active { text-decoration: underline } xmlMemGet
xmlMemSetup
xmlMemStrdupLoc
+xmlMemoryStrdup
xmlStrdup
xmlStrdupFunc
stream
_xmlParserCtxt
diff --git a/doc/APIchunk8.html b/doc/APIchunk8.html index 4896feb0..d2993e44 100644 --- a/doc/APIchunk8.html +++ b/doc/APIchunk8.html @@ -403,6 +403,8 @@ A:link, A:visited, A:active { text-decoration: underline } xmlBuildQName
xmlMallocAtomicLoc
xmlMallocLoc
+xmlMemMalloc
+xmlMemRealloc
xmlNewMutex
xmlNewRMutex
xmlReallocLoc
@@ -411,7 +413,10 @@ A:link, A:visited, A:active { text-decoration: underline } xmlGetBufferAllocationScheme
xmlMallocAtomicLoc
xmlMallocLoc
+xmlMemMalloc
+xmlMemRealloc
xmlMemStrdupLoc
+xmlMemoryStrdup
xmlNormalizeURIPath
xmlReallocLoc
xmlSetBufferAllocationScheme
@@ -593,6 +598,8 @@ A:link, A:visited, A:active { text-decoration: underline }
area
xmlBufferCreateStatic
xmlMallocAtomicLoc
xmlMallocLoc
+xmlMemMalloc
+xmlMemRealloc
xmlParserInputBufferCreateMem
xmlParserInputBufferCreateStatic
xmlReallocLoc
diff --git a/doc/APIchunk9.html b/doc/APIchunk9.html index 57c4bc35..a29af07f 100644 --- a/doc/APIchunk9.html +++ b/doc/APIchunk9.html @@ -270,6 +270,8 @@ A:link, A:visited, A:active { text-decoration: underline } xmlCharEncOutFunc
xmlMallocAtomicLoc
xmlMallocLoc
+xmlMemMalloc
+xmlMemRealloc
xmlNanoFTPRead
xmlNanoHTTPRead
xmlOutputBufferClose
diff --git a/doc/html/book1.html b/doc/html/book1.html index b17821c6..27a45486 100644 --- a/doc/html/book1.html +++ b/doc/html/book1.html @@ -10,4 +10,4 @@ A:link, A:visited, A:active { text-decoration: underline } Reference Manual for libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Reference Manual for libxml2

API Menu
API Indexes
Related links

Table of Contents

  • DOCBparser: old DocBook SGML parser
  • HTMLparser: interface for an HTML 4.0 non-verifying parser
  • HTMLtree: specific APIs to process HTML tree, especially serialization
  • SAX: Old SAX version 1 handler, deprecated
  • SAX2: SAX2 parser interface used to build the DOM tree
  • c14n: Provide Canonical XML and Exclusive XML Canonicalization
  • catalog: interfaces to the Catalog handling system
  • chvalid: Unicode character range checking
  • debugXML: Tree debugging APIs
  • dict: string dictionnary
  • encoding: interface for the encoding conversion functions
  • entities: interface for the XML entities handling
  • globals: interface for all global variables of the library
  • hash: chained hash tables
  • list: lists interfaces
  • nanoftp: minimal FTP implementation
  • nanohttp: minimal HTTP implementation
  • parser: the core parser module
  • parserInternals: internals routines exported by the parser.
  • pattern: pattern expression handling
  • relaxng: implementation of the Relax-NG validation
  • schemasInternals: internal interfaces for XML Schemas
  • threads: interfaces for thread handling
  • tree: interfaces for tree manipulation
  • uri: library of generic URI related routines
  • valid: The DTD validation
  • xinclude: implementation of XInclude
  • xlink: unfinished XLink detection module
  • xmlIO: interface for the I/O interfaces used by the parser
  • xmlautomata: API to build regexp automata
  • xmlerror: error handling
  • xmlexports: macros for marking symbols as exportable/importable.
  • xmlmemory: interface for the memory allocator
  • xmlreader: the XMLReader implementation
  • xmlregexp: regular expressions handling
  • xmlschemas: incomplete XML Schemas structure implementation
  • xmlschemastypes: implementation of XML Schema Datatypes
  • xmlstring: the core parser module
  • xmlunicode: Unicode character APIs
  • xmlversion: compile-time version informations
  • xmlwriter: text writing API for XML
  • xpath: XML Path Language implementation
  • xpathInternals: internal interfaces for XML Path Language implementation
  • xpointer: API to handle XML Pointers

Daniel Veillard

+ Reference Manual for libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Reference Manual for libxml2

API Menu
API Indexes
Related links

Table of Contents

  • DOCBparser: old DocBook SGML parser
  • HTMLparser: interface for an HTML 4.0 non-verifying parser
  • HTMLtree: specific APIs to process HTML tree, especially serialization
  • SAX: Old SAX version 1 handler, deprecated
  • SAX2: SAX2 parser interface used to build the DOM tree
  • c14n: Provide Canonical XML and Exclusive XML Canonicalization
  • catalog: interfaces to the Catalog handling system
  • chvalid: Unicode character range checking
  • debugXML: Tree debugging APIs
  • dict: string dictionnary
  • encoding: interface for the encoding conversion functions
  • entities: interface for the XML entities handling
  • globals: interface for all global variables of the library
  • hash: chained hash tables
  • list: lists interfaces
  • nanoftp: minimal FTP implementation
  • nanohttp: minimal HTTP implementation
  • parser: the core parser module
  • parserInternals: internals routines exported by the parser.
  • pattern: pattern expression handling
  • relaxng: implementation of the Relax-NG validation
  • schemasInternals: internal interfaces for XML Schemas
  • threads: interfaces for thread handling
  • tree: interfaces for tree manipulation
  • uri: library of generic URI related routines
  • valid: The DTD validation
  • xinclude: implementation of XInclude
  • xlink: unfinished XLink detection module
  • xmlIO: interface for the I/O interfaces used by the parser
  • xmlautomata: API to build regexp automata
  • xmlerror: error handling
  • xmlexports: macros for marking symbols as exportable/importable.
  • xmlmemory: interface for the memory allocator
  • xmlreader: the XMLReader implementation
  • xmlregexp: regular expressions handling
  • xmlschemas: incomplete XML Schemas structure implementation
  • xmlschemastypes: implementation of XML Schema Datatypes
  • xmlstring: set of routines to process strings
  • xmlunicode: Unicode character APIs
  • xmlversion: compile-time version informations
  • xmlwriter: text writing API for XML
  • xpath: XML Path Language implementation
  • xpathInternals: internal interfaces for XML Path Language implementation
  • xpointer: API to handle XML Pointers

Daniel Veillard

diff --git a/doc/html/index.html b/doc/html/index.html index b17821c6..27a45486 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -10,4 +10,4 @@ A:link, A:visited, A:active { text-decoration: underline } Reference Manual for libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Reference Manual for libxml2

API Menu
API Indexes
Related links

Table of Contents

  • DOCBparser: old DocBook SGML parser
  • HTMLparser: interface for an HTML 4.0 non-verifying parser
  • HTMLtree: specific APIs to process HTML tree, especially serialization
  • SAX: Old SAX version 1 handler, deprecated
  • SAX2: SAX2 parser interface used to build the DOM tree
  • c14n: Provide Canonical XML and Exclusive XML Canonicalization
  • catalog: interfaces to the Catalog handling system
  • chvalid: Unicode character range checking
  • debugXML: Tree debugging APIs
  • dict: string dictionnary
  • encoding: interface for the encoding conversion functions
  • entities: interface for the XML entities handling
  • globals: interface for all global variables of the library
  • hash: chained hash tables
  • list: lists interfaces
  • nanoftp: minimal FTP implementation
  • nanohttp: minimal HTTP implementation
  • parser: the core parser module
  • parserInternals: internals routines exported by the parser.
  • pattern: pattern expression handling
  • relaxng: implementation of the Relax-NG validation
  • schemasInternals: internal interfaces for XML Schemas
  • threads: interfaces for thread handling
  • tree: interfaces for tree manipulation
  • uri: library of generic URI related routines
  • valid: The DTD validation
  • xinclude: implementation of XInclude
  • xlink: unfinished XLink detection module
  • xmlIO: interface for the I/O interfaces used by the parser
  • xmlautomata: API to build regexp automata
  • xmlerror: error handling
  • xmlexports: macros for marking symbols as exportable/importable.
  • xmlmemory: interface for the memory allocator
  • xmlreader: the XMLReader implementation
  • xmlregexp: regular expressions handling
  • xmlschemas: incomplete XML Schemas structure implementation
  • xmlschemastypes: implementation of XML Schema Datatypes
  • xmlstring: the core parser module
  • xmlunicode: Unicode character APIs
  • xmlversion: compile-time version informations
  • xmlwriter: text writing API for XML
  • xpath: XML Path Language implementation
  • xpathInternals: internal interfaces for XML Path Language implementation
  • xpointer: API to handle XML Pointers

Daniel Veillard

+ Reference Manual for libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Reference Manual for libxml2

API Menu
API Indexes
Related links

Table of Contents

  • DOCBparser: old DocBook SGML parser
  • HTMLparser: interface for an HTML 4.0 non-verifying parser
  • HTMLtree: specific APIs to process HTML tree, especially serialization
  • SAX: Old SAX version 1 handler, deprecated
  • SAX2: SAX2 parser interface used to build the DOM tree
  • c14n: Provide Canonical XML and Exclusive XML Canonicalization
  • catalog: interfaces to the Catalog handling system
  • chvalid: Unicode character range checking
  • debugXML: Tree debugging APIs
  • dict: string dictionnary
  • encoding: interface for the encoding conversion functions
  • entities: interface for the XML entities handling
  • globals: interface for all global variables of the library
  • hash: chained hash tables
  • list: lists interfaces
  • nanoftp: minimal FTP implementation
  • nanohttp: minimal HTTP implementation
  • parser: the core parser module
  • parserInternals: internals routines exported by the parser.
  • pattern: pattern expression handling
  • relaxng: implementation of the Relax-NG validation
  • schemasInternals: internal interfaces for XML Schemas
  • threads: interfaces for thread handling
  • tree: interfaces for tree manipulation
  • uri: library of generic URI related routines
  • valid: The DTD validation
  • xinclude: implementation of XInclude
  • xlink: unfinished XLink detection module
  • xmlIO: interface for the I/O interfaces used by the parser
  • xmlautomata: API to build regexp automata
  • xmlerror: error handling
  • xmlexports: macros for marking symbols as exportable/importable.
  • xmlmemory: interface for the memory allocator
  • xmlreader: the XMLReader implementation
  • xmlregexp: regular expressions handling
  • xmlschemas: incomplete XML Schemas structure implementation
  • xmlschemastypes: implementation of XML Schema Datatypes
  • xmlstring: set of routines to process strings
  • xmlunicode: Unicode character APIs
  • xmlversion: compile-time version informations
  • xmlwriter: text writing API for XML
  • xpath: XML Path Language implementation
  • xpathInternals: internal interfaces for XML Path Language implementation
  • xpointer: API to handle XML Pointers

Daniel Veillard

diff --git a/doc/html/libxml-DOCBparser.html b/doc/html/libxml-DOCBparser.html index b54595c8..3df83f57 100644 --- a/doc/html/libxml-DOCBparser.html +++ b/doc/html/libxml-DOCBparser.html @@ -32,7 +32,7 @@ A:link, A:visited, A:active { text-decoration: underline }

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

docbDocPtr	docbParseFile		(const char * filename, 
const char * encoding)
+
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

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		(docbParserCtxtPtr ctxt)

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

diff --git a/doc/html/libxml-HTMLparser.html b/doc/html/libxml-HTMLparser.html index 81f65066..fc3b1267 100644 --- a/doc/html/libxml-HTMLparser.html +++ b/doc/html/libxml-HTMLparser.html @@ -10,7 +10,7 @@ A:link, A:visited, A:active { text-decoration: underline } Module HTMLparser from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Module HTMLparser from libxml2

API Menu
API Indexes
Related links

this module implements an HTML 4.0 non-verifying parser with API compatible with the XML parser ones. It should be able to parse "real world" HTML, even if severely broken from a specification point of view.

Table of Contents

#define htmlDefaultSubelement
#define htmlElementAllowedHereDesc
#define htmlRequiredAttrs
Typedef xmlDocPtr htmlDocPtr
+    Module HTMLparser from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Module HTMLparser from libxml2

API Menu
API Indexes
Related links

this module implements an HTML 4.0 non-verifying parser with API compatible with the XML parser ones. It should be able to parse "real world" HTML, even if severely broken from a specification point of view.

Table of Contents

#define htmlDefaultSubelement
#define htmlElementAllowedHereDesc
#define htmlRequiredAttrs
Typedef xmlDocPtr htmlDocPtr
 
Structure htmlElemDesc
struct _htmlElemDesc
Typedef htmlElemDesc * htmlElemDescPtr
 
Structure htmlEntityDesc
struct _htmlEntityDesc @@ -129,7 +129,7 @@ A:link, A:visited, A:active { text-decoration: underline }

Checks whether an HTML element may be a direct child of a parent element. and if so whether it is valid or deprecated.

parent:HTML parent element
elt:HTML element
Returns:one of HTML_VALID, HTML_DEPRECATED, HTML_INVALID

Function: htmlEncodeEntities

int	htmlEncodeEntities		(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 HTML 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: htmlEntityLookup

const htmlEntityDesc *	htmlEntityLookup	(const xmlChar * name)
+
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: htmlEntityLookup

const htmlEntityDesc *	htmlEntityLookup	(const xmlChar * name)

Lookup the given entity in EntitiesTable TODO: the linear scan is really ugly, an hash table is really needed.

name:the entity name
Returns:the associated htmlEntityDescPtr if found, NULL otherwise.

Function: htmlEntityValueLookup

const htmlEntityDesc *	htmlEntityValueLookup	(unsigned int value)

Lookup the given entity in EntitiesTable TODO: the linear scan is really ugly, an hash table is really needed.

diff --git a/doc/html/libxml-HTMLtree.html b/doc/html/libxml-HTMLtree.html index 36e2be6c..19ca9751 100644 --- a/doc/html/libxml-HTMLtree.html +++ b/doc/html/libxml-HTMLtree.html @@ -60,7 +60,7 @@ A:link, A:visited, A:active { text-decoration: underline }
buf:the HTML buffer output
doc:the document
cur:the current node
encoding:the encoding string
format:should formatting spaces been added

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.

buf:the HTML buffer output
doc:the document
cur:the current node
encoding:the encoding string

Function: htmlSaveFile

int	htmlSaveFile			(const char * filename, 
xmlDocPtr cur)
-

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

+

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

filename:the filename (or URL)
cur:the document
Returns:the number of byte written or -1 in case of failure.

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.

filename:the filename
cur:the document
encoding:the document encoding
Returns:the number of byte written or -1 in case of failure.

Function: htmlSaveFileFormat

int	htmlSaveFileFormat		(const char * filename, 
xmlDocPtr cur,
const char * encoding,
int format)
diff --git a/doc/html/libxml-SAX.html b/doc/html/libxml-SAX.html index 43fcd8dd..60646f86 100644 --- a/doc/html/libxml-SAX.html +++ b/doc/html/libxml-SAX.html @@ -73,7 +73,7 @@ A:link, A:visited, A:active { text-decoration: underline }
hdlr:the SAX handler

Function: setDocumentLocator

void	setDocumentLocator		(void * ctx, 
xmlSAXLocatorPtr loc)

Receive the document locator at startup, actually xmlDefaultSAXLocator Everything is available on the context, so this is useless in our case. DEPRECATED

ctx:the user data (XML parser context)
loc:A SAX Locator

Function: getPublicId

const xmlChar *	getPublicId		(void * ctx)
-

Provides the public ID e.g. "-//SGMLSOURCE//DTD DEMO//EN" DEPRECATED: use xmlSAX2GetPublicId()

+

Provides the public ID e.g. "-//SGMLSOURCE//DTD DEMO//EN" DEPRECATED: use xmlSAX2GetPublicId()

ctx:the user data (XML parser context)
Returns:a xmlChar *

Function: getEntity

xmlEntityPtr	getEntity		(void * ctx, 
const xmlChar * name)

Get an entity by name DEPRECATED: use xmlSAX2GetEntity()

ctx:the user data (XML parser context)
name:The entity name
Returns:the xmlEntityPtr if found.

Function: characters

void	characters			(void * ctx, 
const xmlChar * ch,
int len)
diff --git a/doc/html/libxml-SAX2.html b/doc/html/libxml-SAX2.html index 79e240b3..2b9055e8 100644 --- a/doc/html/libxml-SAX2.html +++ b/doc/html/libxml-SAX2.html @@ -93,7 +93,7 @@ A:link, A:visited, A:active { text-decoration: underline }
ctx:
Returns:

Function: xmlSAX2GetParameterEntity

xmlEntityPtr	xmlSAX2GetParameterEntity	(void * ctx, 
const xmlChar * name)

Get a parameter entity by name

ctx:the user data (XML parser context)
name:The entity name
Returns:the xmlEntityPtr if found.

Function: xmlSAX2GetPublicId

const xmlChar *	xmlSAX2GetPublicId	(void * ctx)
-

Provides the public ID e.g. "-//SGMLSOURCE//DTD DEMO//EN"

+

Provides the public ID e.g. "-//SGMLSOURCE//DTD DEMO//EN"

ctx:the user data (XML parser context)
Returns:a xmlChar *

Function: xmlSAX2GetSystemId

const xmlChar *	xmlSAX2GetSystemId	(void * ctx)

Provides the system ID, basically URL or filename e.g. http://www.sgmlsource.com/dtds/memo.dtd

ctx:the user data (XML parser context)
Returns:a xmlChar *

Function: xmlSAX2GlobalNamespace

void	xmlSAX2GlobalNamespace		(void * ctx, 
const xmlChar * href,
const xmlChar * prefix)
diff --git a/doc/html/libxml-c14n.html b/doc/html/libxml-c14n.html index 6008763c..ea440c5c 100644 --- a/doc/html/libxml-c14n.html +++ b/doc/html/libxml-c14n.html @@ -10,7 +10,7 @@ A:link, A:visited, A:active { text-decoration: underline } Module c14n from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Module c14n from libxml2

API Menu
API Indexes
Related links

the c14n modules provides a "Canonical XML" implementation

Table of Contents

int	xmlC14NDocDumpMemory		(xmlDocPtr doc, 
xmlNodeSetPtr nodes,
int exclusive,
xmlChar ** inclusive_ns_prefixes,
int with_comments,
xmlChar ** doc_txt_ptr)
+ Module c14n from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Module c14n from libxml2

API Menu
API Indexes
Related links

the c14n modules provides a "Canonical XML" implementation

Table of Contents

int	xmlC14NDocDumpMemory		(xmlDocPtr doc, 
xmlNodeSetPtr nodes,
int exclusive,
xmlChar ** inclusive_ns_prefixes,
int with_comments,
xmlChar ** doc_txt_ptr)
int	xmlC14NDocSave			(xmlDocPtr doc, 
xmlNodeSetPtr nodes,
int exclusive,
xmlChar ** inclusive_ns_prefixes,
int with_comments,
const char * filename,
int compression)
int	xmlC14NDocSaveTo		(xmlDocPtr doc, 
xmlNodeSetPtr nodes,
int exclusive,
xmlChar ** inclusive_ns_prefixes,
int with_comments,
xmlOutputBufferPtr buf)
int	xmlC14NExecute			(xmlDocPtr doc, 
xmlC14NIsVisibleCallback is_visible_callback,
void * user_data,
int exclusive,
xmlChar ** inclusive_ns_prefixes,
int with_comments,
xmlOutputBufferPtr buf)
@@ -19,13 +19,13 @@ int xmlC14NIsVisibleCallback (void * use

Description

Function: xmlC14NDocDumpMemory

int	xmlC14NDocDumpMemory		(xmlDocPtr doc, 
xmlNodeSetPtr nodes,
int exclusive,
xmlChar ** inclusive_ns_prefixes,
int with_comments,
xmlChar ** doc_txt_ptr)
-

Dumps the canonized image of given XML document into memory. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)

+

Dumps the canonized image of given XML document into memory. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)

doc:the XML document for canonization
nodes:the nodes set to be included in the canonized image or NULL if all document nodes should be included
exclusive:the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization)
inclusive_ns_prefixes:the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise)
with_comments:include comments in the result (!=0) or not (==0)
doc_txt_ptr:the memory pointer for allocated canonical XML text; the caller of this functions is responsible for calling xmlFree() to free allocated memory
Returns:the number of bytes written on success or a negative value on fail

Function: xmlC14NDocSave

int	xmlC14NDocSave			(xmlDocPtr doc, 
xmlNodeSetPtr nodes,
int exclusive,
xmlChar ** inclusive_ns_prefixes,
int with_comments,
const char * filename,
int compression)
-

Dumps the canonized image of given XML document into the file. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)

+

Dumps the canonized image of given XML document into the file. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)

doc:the XML document for canonization
nodes:the nodes set to be included in the canonized image or NULL if all document nodes should be included
exclusive:the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization)
inclusive_ns_prefixes:the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise)
with_comments:include comments in the result (!=0) or not (==0)
filename:the filename to store canonical XML image
compression:the compression level (zlib requred): -1 - libxml default, 0 - uncompressed, >0 - compression level
Returns:the number of bytes written success or a negative value on fail

Function: xmlC14NDocSaveTo

int	xmlC14NDocSaveTo		(xmlDocPtr doc, 
xmlNodeSetPtr nodes,
int exclusive,
xmlChar ** inclusive_ns_prefixes,
int with_comments,
xmlOutputBufferPtr buf)
-

Dumps the canonized image of given XML document into the provided buffer. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)

+

Dumps the canonized image of given XML document into the provided buffer. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)

doc:the XML document for canonization
nodes:the nodes set to be included in the canonized image or NULL if all document nodes should be included
exclusive:the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization)
inclusive_ns_prefixes:the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise)
with_comments:include comments in the result (!=0) or not (==0)
buf:the output buffer to store canonical XML; this buffer MUST have encoder==NULL because C14N requires UTF-8 output
Returns:non-negative value on success or a negative value on fail

Function: xmlC14NExecute

int	xmlC14NExecute			(xmlDocPtr doc, 
xmlC14NIsVisibleCallback is_visible_callback,
void * user_data,
int exclusive,
xmlChar ** inclusive_ns_prefixes,
int with_comments,
xmlOutputBufferPtr buf)
-

Dumps the canonized image of given XML document into the provided buffer. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)

+

Dumps the canonized image of given XML document into the provided buffer. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)

doc:the XML document for canonization
is_visible_callback:the function to use to determine is node visible or not
user_data:the first parameter for @is_visible_callback function (in most cases, it is nodes set)
exclusive:the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization)
inclusive_ns_prefixes:the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise)
with_comments:include comments in the result (!=0) or not (==0)
buf:the output buffer to store canonical XML; this buffer MUST have encoder==NULL because C14N requires UTF-8 output
Returns:non-negative value on success or a negative value on fail

Function type: xmlC14NIsVisibleCallback

Function type: xmlC14NIsVisibleCallback
 int	xmlC14NIsVisibleCallback	(void * user_data, 
xmlNodePtr node,
xmlNodePtr parent)

user_data:
node:
parent:
Returns:

diff --git a/doc/html/libxml-debugXML.html b/doc/html/libxml-debugXML.html index 6e782f72..6695a891 100644 --- a/doc/html/libxml-debugXML.html +++ b/doc/html/libxml-debugXML.html @@ -56,7 +56,7 @@ char * xmlShellReadlineFunc (char * prompt) xmlShellReadlineFunc input }

Function: xmlBoolToText

const char *	xmlBoolToText		(int boolval)

Convenient way to turn bool into text

-
boolval:a bool to turn into text
Returns:a pointer to either "True" or "False"

Function: xmlDebugDumpAttr

void	xmlDebugDumpAttr		(FILE * output, 
xmlAttrPtr attr,
int depth)
+
boolval:a bool to turn into text
Returns:a pointer to either "True" or "False"

Function: xmlDebugDumpAttr

void	xmlDebugDumpAttr		(FILE * output, 
xmlAttrPtr attr,
int depth)

Dumps debug information for the attribute

output:the FILE * for the output
attr:the attribute
depth:the indentation level.

Function: xmlDebugDumpAttrList

void	xmlDebugDumpAttrList		(FILE * output, 
xmlAttrPtr attr,
int depth)

Dumps debug information for the attribute list

@@ -83,20 +83,20 @@ char * xmlShellReadlineFunc (char * prompt)
output:the FILE * for the output
node:the node to dump

Function: xmlShell

void	xmlShell			(xmlDocPtr doc, 
char * filename,
xmlShellReadlineFunc input,
FILE * output)

Implements the XML shell This allow to load, validate, view, modify and save a document using a environment similar to a UNIX commandline.

doc:the initial document
filename:the output buffer
input:the line reading function
output:the output FILE*, defaults to stdout if NULL

Function: xmlShellBase

int	xmlShellBase			(xmlShellCtxtPtr ctxt, 
char * arg,
xmlNodePtr node,
xmlNodePtr node2)
-

Implements the XML shell function "base" dumps the current XML base of the node

+

Implements the XML shell function "base" dumps the current XML base of the node

ctxt:the shell context
arg:unused
node:a node
node2:unused
Returns:0

Function: xmlShellCat

int	xmlShellCat			(xmlShellCtxtPtr ctxt, 
char * arg,
xmlNodePtr node,
xmlNodePtr node2)
-

Implements the XML shell function "cat" dumps the serialization node content (XML or HTML).

+

Implements the XML shell function "cat" dumps the serialization node content (XML or HTML).

ctxt:the shell context
arg:unused
node:a node
node2:unused
Returns:0

Function type: xmlShellCmd

Function type: xmlShellCmd
 int	xmlShellCmd			(xmlShellCtxtPtr ctxt, 
char * arg,
xmlNodePtr node,
xmlNodePtr node2)

This is a generic signature for the XML shell functions.

ctxt:a shell context
arg:a string argument
node:a first node
node2:a second node
Returns:an int, negative returns indicating errors.

Function: xmlShellDir

int	xmlShellDir			(xmlShellCtxtPtr ctxt, 
char * arg,
xmlNodePtr node,
xmlNodePtr node2)
-

Implements the XML shell function "dir" dumps informations about the node (namespace, attributes, content).

+

Implements the XML shell function "dir" dumps informations about the node (namespace, attributes, content).

ctxt:the shell context
arg:unused
node:a node
node2:unused
Returns:0

Function: xmlShellDu

int	xmlShellDu			(xmlShellCtxtPtr ctxt, 
char * arg,
xmlNodePtr tree,
xmlNodePtr node2)
-

Implements the XML shell function "du" show the structure of the subtree under node @tree If @tree is null, the command works on the current node.

+

Implements the XML shell function "du" show the structure of the subtree under node @tree If @tree is null, the command works on the current node.

ctxt:the shell context
arg:unused
tree:a node defining a subtree
node2:unused
Returns:0 or -1 in case of error

Function: xmlShellList

int	xmlShellList			(xmlShellCtxtPtr ctxt, 
char * arg,
xmlNodePtr node,
xmlNodePtr node2)
-

Implements the XML shell function "ls" Does an Unix like listing of the given node (like a directory)

+

Implements the XML shell function "ls" Does an Unix like listing of the given node (like a directory)

ctxt:the shell context
arg:unused
node:a node
node2:unused
Returns:0

Function: xmlShellLoad

int	xmlShellLoad			(xmlShellCtxtPtr ctxt, 
char * filename,
xmlNodePtr node,
xmlNodePtr node2)
-

Implements the XML shell function "load" loads a new document specified by the filename

+

Implements the XML shell function "load" loads a new document specified by the filename

ctxt:the shell context
filename:the file name
node:unused
node2:unused
Returns:0 or -1 if loading failed

Function: xmlShellPrintNode

void	xmlShellPrintNode		(xmlNodePtr node)

Print node to the output FILE

node:a non-null node to print to the output FILE

Function: xmlShellPrintXPathError

void	xmlShellPrintXPathError		(int errorType, 
const char * arg)
@@ -104,14 +104,14 @@ int xmlShellCmd (xmlShellCtxtPt
errorType:valid xpath error id
arg:the argument that cause xpath to fail

Function: xmlShellPrintXPathResult

void	xmlShellPrintXPathResult	(xmlXPathObjectPtr list)

Prints result to the output FILE

list:a valid result generated by an xpath evaluation

Function: xmlShellPwd

int	xmlShellPwd			(xmlShellCtxtPtr ctxt, 
char * buffer,
xmlNodePtr node,
xmlNodePtr node2)
-

Implements the XML shell function "pwd" Show the full path from the root to the node, if needed building thumblers when similar elements exists at a given ancestor level. The output is compatible with XPath commands.

+

Implements the XML shell function "pwd" Show the full path from the root to the node, if needed building thumblers when similar elements exists at a given ancestor level. The output is compatible with XPath commands.

ctxt:the shell context
buffer:the output buffer
node:a node
node2:unused
Returns:0 or -1 in case of error

Function type: xmlShellReadlineFunc

Function type: xmlShellReadlineFunc
 char *	xmlShellReadlineFunc		(char * prompt)
 

This is a generic signature for the XML shell input function.

prompt:a string prompt
Returns:a string which will be freed by the Shell.

Function: xmlShellSave

int	xmlShellSave			(xmlShellCtxtPtr ctxt, 
char * filename,
xmlNodePtr node,
xmlNodePtr node2)
-

Implements the XML shell function "save" Write the current document to the filename, or it's original name

+

Implements the XML shell function "save" Write the current document to the filename, or it's original name

ctxt:the shell context
filename:the file name (optional)
node:unused
node2:unused
Returns:0 or -1 in case of error

Function: xmlShellValidate

int	xmlShellValidate		(xmlShellCtxtPtr ctxt, 
char * dtd,
xmlNodePtr node,
xmlNodePtr node2)
-

Implements the XML shell function "validate" Validate the document, if a DTD path is provided, then the validation is done against the given DTD.

+

Implements the XML shell function "validate" Validate the document, if a DTD path is provided, then the validation is done against the given DTD.

ctxt:the shell context
dtd:the DTD URI (optional)
node:unused
node2:unused
Returns:0 or -1 in case of error

Function: xmlShellWrite

int	xmlShellWrite			(xmlShellCtxtPtr ctxt, 
char * filename,
xmlNodePtr node,
xmlNodePtr node2)
-

Implements the XML shell function "write" Write the current node to the filename, it saves the serialization of the subtree under the @node specified

+

Implements the XML shell function "write" Write the current node to the filename, it saves the serialization of the subtree under the @node specified

ctxt:the shell context
filename:the file name
node:a node in the tree
node2:unused
Returns:0 or -1 in case of error

Daniel Veillard

diff --git a/doc/html/libxml-encoding.html b/doc/html/libxml-encoding.html index 17516d48..e41ac845 100644 --- a/doc/html/libxml-encoding.html +++ b/doc/html/libxml-encoding.html @@ -10,7 +10,7 @@ A:link, A:visited, A:active { text-decoration: underline } Module encoding from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Module encoding from libxml2

API Menu
API Indexes
Related links

interface for the encoding conversion functions needed for XML basic encoding and iconv() support. Related specs are rfc2044 (UTF-8 and UTF-16) F. Yergeau Alis Technologies [ISO-10646] UTF-8 and UTF-16 in Annexes [ISO-8859-1] ISO Latin-1 characters codes. [UNICODE] The Unicode Consortium, "The Unicode Standard -- Worldwide Character Encoding -- Version 1.0", Addison- Wesley, Volume 1, 1991, Volume 2, 1992. UTF-8 is described in Unicode Technical Report #4. [US-ASCII] Coded Character Set--7-bit American Standard Code for Information Interchange, ANSI X3.4-1986.

Table of Contents

Enum xmlCharEncoding
+    Module encoding from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Module encoding from libxml2

API Menu
API Indexes
Related links

interface for the encoding conversion functions needed for XML basic encoding and iconv() support. Related specs are rfc2044 (UTF-8 and UTF-16) F. Yergeau Alis Technologies [ISO-10646] UTF-8 and UTF-16 in Annexes [ISO-8859-1] ISO Latin-1 characters codes. [UNICODE] The Unicode Consortium, "The Unicode Standard -- Worldwide Character Encoding -- Version 1.0", Addison- Wesley, Volume 1, 1991, Volume 2, 1992. UTF-8 is described in Unicode Technical Report #4. [US-ASCII] Coded Character Set--7-bit American Standard Code for Information Interchange, ANSI X3.4-1986.

Table of Contents

Enum xmlCharEncoding
 
Structure xmlCharEncodingHandler
struct _xmlCharEncodingHandler
Typedef xmlCharEncodingHandler * xmlCharEncodingHandlerPtr
 
int	UTF8Toisolat1			(unsigned char * out, 
int * outlen,
const unsigned char * in,
int * inlen)
@@ -104,7 +104,7 @@ int xmlCharEncodingOutputFunc (unsigned char * out,
int * outlen,
name:a string describing the char encoding.
Returns:the handler or NULL if not found

Function: xmlGetCharEncodingHandler

xmlCharEncodingHandlerPtr	xmlGetCharEncodingHandler	(xmlCharEncoding enc)

Search in the registered set the handler able to read/write that encoding.

enc:an xmlCharEncoding value.
Returns:the handler or NULL if not found

Function: xmlGetCharEncodingName

const char *	xmlGetCharEncodingName	(xmlCharEncoding enc)
-

The "canonical" name for XML encoding. C.f. http://www.w3.org/TR/REC-xml#charencoding Section 4.3.3 Character Encoding in Entities

+

The "canonical" name for XML encoding. C.f. http://www.w3.org/TR/REC-xml#charencoding Section 4.3.3 Character Encoding in Entities

enc:the encoding
Returns:the canonical name for the given encoding

Function: xmlGetEncodingAlias

const char *	xmlGetEncodingAlias	(const char * alias)

Lookup an encoding name for the given alias.

alias:the alias name as parsed, in UTF-8 format (ASCII actually)
Returns:NULL if not found, otherwise the original name

Function: xmlInitCharEncodingHandlers

void	xmlInitCharEncodingHandlers	(void)
diff --git a/doc/html/libxml-lib.html b/doc/html/libxml-lib.html index b17821c6..27a45486 100644 --- a/doc/html/libxml-lib.html +++ b/doc/html/libxml-lib.html @@ -10,4 +10,4 @@ A:link, A:visited, A:active { text-decoration: underline } Reference Manual for libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Reference Manual for libxml2

API Menu
API Indexes
Related links

Table of Contents

  • DOCBparser: old DocBook SGML parser
  • HTMLparser: interface for an HTML 4.0 non-verifying parser
  • HTMLtree: specific APIs to process HTML tree, especially serialization
  • SAX: Old SAX version 1 handler, deprecated
  • SAX2: SAX2 parser interface used to build the DOM tree
  • c14n: Provide Canonical XML and Exclusive XML Canonicalization
  • catalog: interfaces to the Catalog handling system
  • chvalid: Unicode character range checking
  • debugXML: Tree debugging APIs
  • dict: string dictionnary
  • encoding: interface for the encoding conversion functions
  • entities: interface for the XML entities handling
  • globals: interface for all global variables of the library
  • hash: chained hash tables
  • list: lists interfaces
  • nanoftp: minimal FTP implementation
  • nanohttp: minimal HTTP implementation
  • parser: the core parser module
  • parserInternals: internals routines exported by the parser.
  • pattern: pattern expression handling
  • relaxng: implementation of the Relax-NG validation
  • schemasInternals: internal interfaces for XML Schemas
  • threads: interfaces for thread handling
  • tree: interfaces for tree manipulation
  • uri: library of generic URI related routines
  • valid: The DTD validation
  • xinclude: implementation of XInclude
  • xlink: unfinished XLink detection module
  • xmlIO: interface for the I/O interfaces used by the parser
  • xmlautomata: API to build regexp automata
  • xmlerror: error handling
  • xmlexports: macros for marking symbols as exportable/importable.
  • xmlmemory: interface for the memory allocator
  • xmlreader: the XMLReader implementation
  • xmlregexp: regular expressions handling
  • xmlschemas: incomplete XML Schemas structure implementation
  • xmlschemastypes: implementation of XML Schema Datatypes
  • xmlstring: the core parser module
  • xmlunicode: Unicode character APIs
  • xmlversion: compile-time version informations
  • xmlwriter: text writing API for XML
  • xpath: XML Path Language implementation
  • xpathInternals: internal interfaces for XML Path Language implementation
  • xpointer: API to handle XML Pointers

Daniel Veillard

+ Reference Manual for libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Reference Manual for libxml2

API Menu
API Indexes
Related links

Table of Contents

  • DOCBparser: old DocBook SGML parser
  • HTMLparser: interface for an HTML 4.0 non-verifying parser
  • HTMLtree: specific APIs to process HTML tree, especially serialization
  • SAX: Old SAX version 1 handler, deprecated
  • SAX2: SAX2 parser interface used to build the DOM tree
  • c14n: Provide Canonical XML and Exclusive XML Canonicalization
  • catalog: interfaces to the Catalog handling system
  • chvalid: Unicode character range checking
  • debugXML: Tree debugging APIs
  • dict: string dictionnary
  • encoding: interface for the encoding conversion functions
  • entities: interface for the XML entities handling
  • globals: interface for all global variables of the library
  • hash: chained hash tables
  • list: lists interfaces
  • nanoftp: minimal FTP implementation
  • nanohttp: minimal HTTP implementation
  • parser: the core parser module
  • parserInternals: internals routines exported by the parser.
  • pattern: pattern expression handling
  • relaxng: implementation of the Relax-NG validation
  • schemasInternals: internal interfaces for XML Schemas
  • threads: interfaces for thread handling
  • tree: interfaces for tree manipulation
  • uri: library of generic URI related routines
  • valid: The DTD validation
  • xinclude: implementation of XInclude
  • xlink: unfinished XLink detection module
  • xmlIO: interface for the I/O interfaces used by the parser
  • xmlautomata: API to build regexp automata
  • xmlerror: error handling
  • xmlexports: macros for marking symbols as exportable/importable.
  • xmlmemory: interface for the memory allocator
  • xmlreader: the XMLReader implementation
  • xmlregexp: regular expressions handling
  • xmlschemas: incomplete XML Schemas structure implementation
  • xmlschemastypes: implementation of XML Schema Datatypes
  • xmlstring: set of routines to process strings
  • xmlunicode: Unicode character APIs
  • xmlversion: compile-time version informations
  • xmlwriter: text writing API for XML
  • xpath: XML Path Language implementation
  • xpathInternals: internal interfaces for XML Path Language implementation
  • xpointer: API to handle XML Pointers

Daniel Veillard

diff --git a/doc/html/libxml-nanoftp.html b/doc/html/libxml-nanoftp.html index 55980c07..afcd4d51 100644 --- a/doc/html/libxml-nanoftp.html +++ b/doc/html/libxml-nanoftp.html @@ -44,7 +44,7 @@ void ftpDataCallback (void * userData,
const char * data,

A callback for the xmlNanoFTPGet command.

userData:the user provided context
data:the data received
len:its size in bytes

Function type: ftpListCallback

Function type: ftpListCallback
 void	ftpListCallback			(void * userData, 
const char * filename,
const char * attrib,
const char * owner,
const char * group,
unsigned long size,
int links,
int year,
const char * month,
int day,
int hour,
int minute) -

A callback for the xmlNanoFTPList command. Note that only one of year and day:minute are specified.

userData:user provided data for the callback
filename:the file name (including "->" when links are shown)
attrib:the attribute string
owner:the owner string
group:the group string
size:the file size
links:the link count
year:the year
month:the month
day:the day
hour:the hour
minute:the minute

+

A callback for the xmlNanoFTPList command. Note that only one of year and day:minute are specified.

userData:user provided data for the callback
filename:the file name (including "->" when links are shown)
attrib:the attribute string
owner:the owner string
group:the group string
size:the file size
links:the link count
year:the year
month:the month
day:the day
hour:the hour
minute:the minute

Function: xmlNanoFTPCheckResponse

int	xmlNanoFTPCheckResponse		(void * ctx)

Check if there is a response from the FTP server after a command.

ctx:an FTP context
Returns:the code number, or 0

Function: xmlNanoFTPCleanup

void	xmlNanoFTPCleanup		(void)
diff --git a/doc/html/libxml-parser.html b/doc/html/libxml-parser.html index 92b80bc5..ec5f724a 100644 --- a/doc/html/libxml-parser.html +++ b/doc/html/libxml-parser.html @@ -401,7 +401,7 @@ void warningSAXFunc (void * ctx,
const char * msg,
...

Function: xmlInitParserCtxt

int	xmlInitParserCtxt		(xmlParserCtxtPtr ctxt)

Initialize a parser context

ctxt:an XML parser context
Returns:0 in case of success and -1 in case of error

Function: xmlKeepBlanksDefault

int	xmlKeepBlanksDefault		(int val)
-

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.

+

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.

val:int 0 or 1
Returns:the last value for 0 for no substitution, 1 for substitution.

Function: xmlLineNumbersDefault

int	xmlLineNumbersDefault		(int val)

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.

val:int 0 or 1
Returns:the last value for 0 for no substitution, 1 for substitution.

Function: xmlLoadExternalEntity

xmlParserInputPtr	xmlLoadExternalEntity	(const char * URL, 
const char * ID,
xmlParserCtxtPtr ctxt)
@@ -425,7 +425,7 @@ void warningSAXFunc (void * ctx,
const char * msg,
...
cur:a pointer to an array of xmlChar
Returns:the resulting document tree

Function: xmlParseDocument

int	xmlParseDocument		(xmlParserCtxtPtr ctxt)

parse an XML document (and build a tree if using the standard SAX interface). [1] document ::= prolog element Misc* [22] prolog ::= XMLDecl? Misc* (doctypedecl Misc*)?

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

Function: xmlParseEntity

xmlDocPtr	xmlParseEntity		(const char * filename)
-

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

+

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

filename:the filename
Returns:the resulting document tree

Function: xmlParseExtParsedEnt

int	xmlParseExtParsedEnt		(xmlParserCtxtPtr ctxt)

parse a general parsed entity An external general parsed entity is well-formed if it matches the production labeled extParsedEnt. [78] extParsedEnt ::= TextDecl? content

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

Function: xmlParseExternalEntity

int	xmlParseExternalEntity		(xmlDocPtr doc, 
xmlSAXHandlerPtr sax,
void * user_data,
int depth,
const xmlChar * URL,
const xmlChar * ID,
xmlNodePtr * lst)
@@ -470,7 +470,7 @@ void xmlParserInputDeallocate (xmlChar
sax:the SAX handler block
ExternalID:a NAME* containing the External ID of the DTD
SystemID:a NAME* containing the URL to the DTD
Returns:the resulting xmlDtdPtr or NULL in case of error.

Function: xmlSAXParseDoc

xmlDocPtr	xmlSAXParseDoc		(xmlSAXHandlerPtr sax, 
xmlChar * cur,
int recovery)

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

sax:the SAX handler block
cur:a pointer to an array of xmlChar
recovery:work in recovery mode, i.e. tries to read no Well Formed documents
Returns:the resulting document tree

Function: xmlSAXParseEntity

xmlDocPtr	xmlSAXParseEntity	(xmlSAXHandlerPtr sax, 
const char * filename)
-

parse an XML external entity out of context 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. [78] extParsedEnt ::= TextDecl? content This correspond to a "Well Balanced" chunk

+

parse an XML external entity out of context 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. [78] extParsedEnt ::= TextDecl? content This correspond to a "Well Balanced" chunk

sax:the SAX handler block
filename:the filename
Returns:the resulting document tree

Function: xmlSAXParseFile

xmlDocPtr	xmlSAXParseFile		(xmlSAXHandlerPtr sax, 
const char * filename,
int recovery)

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

sax:the SAX handler block
filename:the filename
recovery:work in recovery mode, i.e. tries to read no Well Formed documents
Returns:the resulting document tree

Function: xmlSAXParseFileWithData

xmlDocPtr	xmlSAXParseFileWithData	(xmlSAXHandlerPtr sax, 
const char * filename,
int recovery,
void * data)
diff --git a/doc/html/libxml-parserInternals.html b/doc/html/libxml-parserInternals.html index 55a7c202..2af6f2a9 100644 --- a/doc/html/libxml-parserInternals.html +++ b/doc/html/libxml-parserInternals.html @@ -161,7 +161,7 @@ void xmlEntityReferenceFunc (
buffer:a pointer to a char array
size:the size of the array
Returns:the new parser context or NULL

Function: xmlCreateURLParserCtxt

xmlParserCtxtPtr	xmlCreateURLParserCtxt	(const char * filename, 
int options)

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

filename:the filename or URL
options:a combination of xmlParserOption
Returns:the new parser context or NULL

Function: xmlCurrentChar

int	xmlCurrentChar			(xmlParserCtxtPtr ctxt, 
int * len)
-

The current char value, if using UTF-8 this may actually span multiple bytes in the input buffer. Implement the end of line normalization: 2.11 End-of-Line Handling Wherever an external parsed entity or the literal entity value of an internal parsed entity contains either the literal two-character sequence "#xD#xA" or a standalone literal #xD, an XML processor must pass to the application the single character #xA. This behavior can conveniently be produced by normalizing all line breaks to #xA on input, before parsing.)

+

The current char value, if using UTF-8 this may actually span multiple bytes in the input buffer. Implement the end of line normalization: 2.11 End-of-Line Handling Wherever an external parsed entity or the literal entity value of an internal parsed entity contains either the literal two-character sequence "#xD#xA" or a standalone literal #xD, an XML processor must pass to the application the single character #xA. This behavior can conveniently be produced by normalizing all line breaks to #xA on input, before parsing.)

ctxt:the XML parser context
len:pointer to the length of the char read
Returns:the current char value and its length

Function: xmlDecodeEntities

xmlChar *	xmlDecodeEntities	(xmlParserCtxtPtr ctxt, 
int len,
int what,
xmlChar end,
xmlChar end2,
xmlChar end3)

This function is deprecated, we now always process entities content through xmlStringDecodeEntities TODO: remove it in next major release. [67] Reference ::= EntityRef | CharRef [69] PEReference ::= '%' Name ';'

ctxt:the parser context
len:the len to decode (in bytes !), -1 for no size limit
what:combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF
end:an end marker xmlChar, 0 if none
end2:an end marker xmlChar, 0 if none
end3:an end marker xmlChar, 0 if none
Returns:A newly allocated string with the substitution done. The caller must deallocate it !

Function type: xmlEntityReferenceFunc

Function type: xmlEntityReferenceFunc
@@ -192,9 +192,9 @@ void	xmlEntityReferenceFunc		(xmlEntityP
 
ctxt:an XML parser context
buffer:an memory buffer
Returns:the new input stream

Function: xmlNextChar

void	xmlNextChar			(xmlParserCtxtPtr ctxt)

Skip to the next char input char.

ctxt:the XML parser context

Function: xmlParseAttValue

xmlChar *	xmlParseAttValue	(xmlParserCtxtPtr ctxt)
-

parse a value for an attribute Note: the parser won't do substitution of entities here, this will be handled later in xmlStringGetNodeList [10] AttValue ::= '"' ([^<&"] | Reference)* '"' | "'" ([^<&'] | Reference)* "'" 3.3.3 Attribute-Value Normalization: Before the value of an attribute is passed to the application or checked for validity, the XML processor must normalize it as follows: - a character reference is processed by appending the referenced character to the attribute value - an entity reference is processed by recursively processing the replacement text of the entity - a whitespace character (#x20, #xD, #xA, #x9) is processed by appending #x20 to the normalized value, except that only a single #x20 is appended for a "#xD#xA" sequence that is part of an external parsed entity or the literal entity value of an internal parsed entity - other characters are processed by appending them to the normalized value If the declared value is not CDATA, then the XML processor must further process the normalized attribute value by discarding any leading and trailing space (#x20) characters, and by replacing sequences of space (#x20) characters by a single space (#x20) character. All attributes for which no declaration has been read should be treated by a non-validating parser as if declared CDATA.

+

parse a value for an attribute Note: the parser won't do substitution of entities here, this will be handled later in xmlStringGetNodeList [10] AttValue ::= '"' ([^<&"] | Reference)* '"' | "'" ([^<&'] | Reference)* "'" 3.3.3 Attribute-Value Normalization: Before the value of an attribute is passed to the application or checked for validity, the XML processor must normalize it as follows: - a character reference is processed by appending the referenced character to the attribute value - an entity reference is processed by recursively processing the replacement text of the entity - a whitespace character (#x20, #xD, #xA, #x9) is processed by appending #x20 to the normalized value, except that only a single #x20 is appended for a "#xD#xA" sequence that is part of an external parsed entity or the literal entity value of an internal parsed entity - other characters are processed by appending them to the normalized value If the declared value is not CDATA, then the XML processor must further process the normalized attribute value by discarding any leading and trailing space (#x20) characters, and by replacing sequences of space (#x20) characters by a single space (#x20) character. All attributes for which no declaration has been read should be treated by a non-validating parser as if declared CDATA.

ctxt:an XML parser context
Returns:the AttValue parsed or NULL. The value has to be freed by the caller.

Function: xmlParseAttribute

const xmlChar *	xmlParseAttribute	(xmlParserCtxtPtr ctxt, 
xmlChar ** value)
-

parse an attribute [41] Attribute ::= Name Eq AttValue [ WFC: No External Entity References ] Attribute values cannot contain direct or indirect entity references to external entities. [ WFC: No < in Attribute Values ] The replacement text of any entity referred to directly or indirectly in an attribute value (other than "&lt;") must not contain a <. [ VC: Attribute Value Type ] The attribute must have been declared; the value must be of the type declared for it. [25] Eq ::= S? '=' S? With namespace: [NS 11] Attribute ::= QName Eq AttValue Also the case QName == xmlns:??? is handled independently as a namespace definition.

+

parse an attribute [41] Attribute ::= Name Eq AttValue [ WFC: No External Entity References ] Attribute values cannot contain direct or indirect entity references to external entities. [ WFC: No < in Attribute Values ] The replacement text of any entity referred to directly or indirectly in an attribute value (other than "&lt;") must not contain a <. [ VC: Attribute Value Type ] The attribute must have been declared; the value must be of the type declared for it. [25] Eq ::= S? '=' S? With namespace: [NS 11] Attribute ::= QName Eq AttValue Also the case QName == xmlns:??? is handled independently as a namespace definition.

ctxt:an XML parser context
value:a xmlChar ** used to store the value of the attribute
Returns:the attribute name, and the value in *value.

Function: xmlParseAttributeListDecl

void	xmlParseAttributeListDecl	(xmlParserCtxtPtr ctxt)

: parse the Attribute list def for an element [52] AttlistDecl ::= '<!ATTLIST' S Name AttDef* S? '>' [53] AttDef ::= S Name S AttType S DefaultDecl

ctxt:an XML parser context

Function: xmlParseAttributeType

int	xmlParseAttributeType		(xmlParserCtxtPtr ctxt, 
xmlEnumerationPtr * tree)
@@ -202,11 +202,11 @@ void xmlEntityReferenceFunc (xmlEntityP
ctxt:an XML parser context
tree:the enumeration tree built while parsing
Returns:the attribute type

Function: xmlParseCDSect

void	xmlParseCDSect			(xmlParserCtxtPtr ctxt)

Parse escaped pure raw content. [18] CDSect ::= CDStart CData CDEnd [19] CDStart ::= '<![CDATA[' [20] Data ::= (Char* - (Char* ']]>' Char*)) [21] CDEnd ::= ']]>'

ctxt:an XML parser context

Function: xmlParseCharData

void	xmlParseCharData		(xmlParserCtxtPtr ctxt, 
int cdata)
-

parse a CharData section. if we are within a CDATA section ']]>' marks an end of section. The right angle bracket (>) may be represented using the string "&gt;", and must, for compatibility, be escaped using "&gt;" or a character reference when it appears in the string "]]>" in content, when that string is not marking the end of a CDATA section. [14] CharData ::= [^<&]* - ([^<&]* ']]>' [^<

+

parse a CharData section. if we are within a CDATA section ']]>' marks an end of section. The right angle bracket (>) may be represented using the string "&gt;", and must, for compatibility, be escaped using "&gt;" or a character reference when it appears in the string "]]>" in content, when that string is not marking the end of a CDATA section. [14] CharData ::= [^<&]* - ([^<&]* ']]>' [^<&]*)

ctxt:an XML parser context
cdata:int indicating whether we are within a CDATA section

Function: xmlParseCharRef

int	xmlParseCharRef			(xmlParserCtxtPtr ctxt)

parse Reference declarations [66] CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';' [ WFC: Legal Character ] Characters referred to using character references must match the production for Char.

ctxt:an XML parser context
Returns:the value parsed (as an int), 0 in case of error

Function: xmlParseComment

void	xmlParseComment			(xmlParserCtxtPtr ctxt)
-

Skip an XML (SGML) comment <!-- .... --> The spec says that "For compatibility, the string "--" (double-hyphen) must not occur within comments. " [15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'

+

Skip an XML (SGML) comment <!-- .... --> The spec says that "For compatibility, the string "--" (double-hyphen) must not occur within comments. " [15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'

ctxt:an XML parser context

Function: xmlParseContent

void	xmlParseContent			(xmlParserCtxtPtr ctxt)

Parse a content: [43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*

ctxt:an XML parser context

Function: xmlParseDefaultDecl

int	xmlParseDefaultDecl		(xmlParserCtxtPtr ctxt, 
xmlChar ** value)
@@ -226,15 +226,15 @@ void xmlEntityReferenceFunc (xmlEntityP
ctxt:an XML parser context
inputchk:the input used for the current entity, needed for boundary checks
Returns:the list of the xmlElementContentPtr describing the element choices

Function: xmlParseEncName

xmlChar *	xmlParseEncName		(xmlParserCtxtPtr ctxt)

parse the XML encoding name [81] EncName ::= [A-Za-z] ([A-Za-z0-9._] | '-')*

ctxt:an XML parser context
Returns:the encoding name value or NULL

Function: xmlParseEncodingDecl

const xmlChar *	xmlParseEncodingDecl	(xmlParserCtxtPtr ctxt)
-

parse the XML encoding declaration [80] EncodingDecl ::= S 'encoding' Eq ('"' EncName '"' | "'" EncName "'") this setups the conversion filters.

+

parse the XML encoding declaration [80] EncodingDecl ::= S 'encoding' Eq ('"' EncName '"' | "'" EncName "'") this setups the conversion filters.

ctxt:an XML parser context
Returns:the encoding value or NULL

Function: xmlParseEndTag

void	xmlParseEndTag			(xmlParserCtxtPtr ctxt)

parse an end of tag [42] ETag ::= '</' Name S? '>' With namespace [NS 9] ETag ::= '</' QName S? '>'

ctxt:an XML parser context

Function: xmlParseEntityDecl

void	xmlParseEntityDecl		(xmlParserCtxtPtr ctxt)

parse <!ENTITY declarations [70] EntityDecl ::= GEDecl | PEDecl [71] GEDecl ::= '<!ENTITY' S Name S EntityDef S? '>' [72] PEDecl ::= '<!ENTITY' S '%' S Name S PEDef S? '>' [73] EntityDef ::= EntityValue | (ExternalID NDataDecl?) [74] PEDef ::= EntityValue | ExternalID [76] NDataDecl ::= S 'NDATA' S Name [ VC: Notation Declared ] The Name must match the declared name of a notation.

ctxt:an XML parser context

Function: xmlParseEntityRef

xmlEntityPtr	xmlParseEntityRef	(xmlParserCtxtPtr ctxt)
-

parse ENTITY references declarations [68] EntityRef ::= '&' Name ';' [ WFC: Entity Declared ] In a document without any DTD, a document with only an internal DTD subset which contains no parameter entity references, or a document with "standalone='yes'", the Name given in the entity reference must match that in an entity declaration, except that well-formed documents need not declare any of the following entities: amp, lt, gt, apos, quot. The declaration of a parameter entity must precede any reference to it. Similarly, the declaration of a general entity must precede any reference to it which appears in a default value in an attribute-list declaration. Note that if entities are declared in the external subset or in external parameter entities, a non-validating processor is not obligated to read and process their declarations; for such documents, the rule that an entity must be declared is a well-formedness constraint only if standalone='yes'. [ WFC: Parsed Entity ] An entity reference must not contain the name of an unparsed entity

+

parse ENTITY references declarations [68] EntityRef ::= '&' Name ';' [ WFC: Entity Declared ] In a document without any DTD, a document with only an internal DTD subset which contains no parameter entity references, or a document with "standalone='yes'", the Name given in the entity reference must match that in an entity declaration, except that well-formed documents need not declare any of the following entities: amp, lt, gt, apos, quot. The declaration of a parameter entity must precede any reference to it. Similarly, the declaration of a general entity must precede any reference to it which appears in a default value in an attribute-list declaration. Note that if entities are declared in the external subset or in external parameter entities, a non-validating processor is not obligated to read and process their declarations; for such documents, the rule that an entity must be declared is a well-formedness constraint only if standalone='yes'. [ WFC: Parsed Entity ] An entity reference must not contain the name of an unparsed entity

ctxt:an XML parser context
Returns:the xmlEntityPtr if found, or NULL otherwise.

Function: xmlParseEntityValue

xmlChar *	xmlParseEntityValue	(xmlParserCtxtPtr ctxt, 
xmlChar ** orig)
-

parse a value for ENTITY declarations [9] EntityValue ::= '"' ([^%&"] | PEReference | Reference)* '"' | "'" ([^%&'] | PEReference | Reference)* "'"

+

parse a value for ENTITY declarations [9] EntityValue ::= '"' ([^%&"] | PEReference | Reference)* '"' | "'" ([^%&'] | PEReference | Reference)* "'"

ctxt:an XML parser context
orig:if non-NULL store a copy of the original entity value
Returns:the EntityValue parsed with reference substituted or NULL

Function: xmlParseEnumeratedType

int	xmlParseEnumeratedType		(xmlParserCtxtPtr ctxt, 
xmlEnumerationPtr * tree)

parse an Enumerated attribute type. [57] EnumeratedType ::= NotationType | Enumeration [58] NotationType ::= 'NOTATION' S '(' S? Name (S? '|' S? Name)* S? ')'

ctxt:an XML parser context
tree:the enumeration tree built while parsing
Returns:XML_ATTRIBUTE_ENUMERATION or XML_ATTRIBUTE_NOTATION

Function: xmlParseEnumerationType

xmlEnumerationPtr	xmlParseEnumerationType	(xmlParserCtxtPtr ctxt)
@@ -258,33 +258,33 @@ void xmlEntityReferenceFunc (xmlEntityP
ctxt:an XML parser context

Function: xmlParseNotationType

xmlEnumerationPtr	xmlParseNotationType	(xmlParserCtxtPtr ctxt)

parse an Notation attribute type. Note: the leading 'NOTATION' S part has already being parsed... [58] NotationType ::= 'NOTATION' S '(' S? Name (S? '|' S? Name)* S? ')' [ VC: Notation Attributes ] Values of this type must match one of the notation names included in the declaration; all notation names in the declaration must be declared.

ctxt:an XML parser context
Returns:the notation attribute tree built while parsing

Function: xmlParsePEReference

void	xmlParsePEReference		(xmlParserCtxtPtr ctxt)
-

parse PEReference declarations The entity content is handled directly by pushing it's content as a new input stream. [69] PEReference ::= '%' Name ';' [ WFC: No Recursion ] A parsed entity must not contain a recursive reference to itself, either directly or indirectly. [ WFC: Entity Declared ] In a document without any DTD, a document with only an internal DTD subset which contains no parameter entity references, or a document with "standalone='yes'", ... ... The declaration of a parameter entity must precede any reference to it... [ VC: Entity Declared ] In a document with an external subset or external parameter entities with "standalone='no'", ... ... The declaration of a parameter entity must precede any reference to it... [ WFC: In DTD ] Parameter-entity references may only appear in the DTD. NOTE: misleading but this is handled.

+

parse PEReference declarations The entity content is handled directly by pushing it's content as a new input stream. [69] PEReference ::= '%' Name ';' [ WFC: No Recursion ] A parsed entity must not contain a recursive reference to itself, either directly or indirectly. [ WFC: Entity Declared ] In a document without any DTD, a document with only an internal DTD subset which contains no parameter entity references, or a document with "standalone='yes'", ... ... The declaration of a parameter entity must precede any reference to it... [ VC: Entity Declared ] In a document with an external subset or external parameter entities with "standalone='no'", ... ... The declaration of a parameter entity must precede any reference to it... [ WFC: In DTD ] Parameter-entity references may only appear in the DTD. NOTE: misleading but this is handled.

ctxt:an XML parser context

Function: xmlParsePI

void	xmlParsePI			(xmlParserCtxtPtr ctxt)

parse an XML Processing Instruction. [16] PI ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>' The processing is transfered to SAX once parsed.

ctxt:an XML parser context

Function: xmlParsePITarget

const xmlChar *	xmlParsePITarget	(xmlParserCtxtPtr ctxt)

parse the name of a PI [17] PITarget ::= Name - (('X' | 'x') ('M' | 'm') ('L' | 'l'))

ctxt:an XML parser context
Returns:the PITarget name or NULL

Function: xmlParsePubidLiteral

xmlChar *	xmlParsePubidLiteral	(xmlParserCtxtPtr ctxt)
-

parse an XML public literal [12] PubidLiteral ::= '"' PubidChar* '"' | "'" (PubidChar - "'")* "'"

+

parse an XML public literal [12] PubidLiteral ::= '"' PubidChar* '"' | "'" (PubidChar - "'")* "'"

ctxt:an XML parser context
Returns:the PubidLiteral parsed or NULL.

Function: xmlParseQuotedString

xmlChar *	xmlParseQuotedString	(xmlParserCtxtPtr ctxt)

Parse and return a string between quotes or doublequotes TODO: Deprecated, to be removed at next drop of binary compatibility

ctxt:an XML parser context
Returns:the string parser or NULL.

Function: xmlParseReference

void	xmlParseReference		(xmlParserCtxtPtr ctxt)

parse and handle entity references in content, depending on the SAX interface, this may end-up in a call to character() if this is a CharRef, a predefined entity, if there is no reference() callback. or if the parser was asked to switch to that mode. [67] Reference ::= EntityRef | CharRef

ctxt:an XML parser context

Function: xmlParseSDDecl

int	xmlParseSDDecl			(xmlParserCtxtPtr ctxt)
-

parse the XML standalone declaration [32] SDDecl ::= S 'standalone' Eq (("'" ('yes' | 'no') "'") | ('"' ('yes' | 'no')'"')) [ VC: Standalone Document Declaration ] TODO The standalone document declaration must have the value "no" if any external markup declarations contain declarations of: - attributes with default values, if elements to which these attributes apply appear in the document without specifications of values for these attributes, or - entities (other than amp, lt, gt, apos, quot), if references to those entities appear in the document, or - attributes with values subject to normalization, where the attribute appears in the document with a value which will change as a result of normalization, or - element types with element content, if white space occurs directly within any instance of those types.

+

parse the XML standalone declaration [32] SDDecl ::= S 'standalone' Eq (("'" ('yes' | 'no') "'") | ('"' ('yes' | 'no')'"')) [ VC: Standalone Document Declaration ] TODO The standalone document declaration must have the value "no" if any external markup declarations contain declarations of: - attributes with default values, if elements to which these attributes apply appear in the document without specifications of values for these attributes, or - entities (other than amp, lt, gt, apos, quot), if references to those entities appear in the document, or - attributes with values subject to normalization, where the attribute appears in the document with a value which will change as a result of normalization, or - element types with element content, if white space occurs directly within any instance of those types.

ctxt:an XML parser context
Returns:1 if standalone, 0 otherwise

Function: xmlParseStartTag

const xmlChar *	xmlParseStartTag	(xmlParserCtxtPtr ctxt)

parse a start of tag either for rule element or EmptyElement. In both case we don't parse the tag closing chars. [40] STag ::= '<' Name (S Attribute)* S? '>' [ WFC: Unique Att Spec ] No attribute name may appear more than once in the same start-tag or empty-element tag. [44] EmptyElemTag ::= '<' Name (S Attribute)* S? '/>' [ WFC: Unique Att Spec ] No attribute name may appear more than once in the same start-tag or empty-element tag. With namespace: [NS 8] STag ::= '<' QName (S Attribute)* S? '>' [NS 10] EmptyElement ::= '<' QName (S Attribute)* S? '/>'

ctxt:an XML parser context
Returns:the element name parsed

Function: xmlParseSystemLiteral

xmlChar *	xmlParseSystemLiteral	(xmlParserCtxtPtr ctxt)
-

parse an XML Literal [11] SystemLiteral ::= ('"' [^"]* '"') | ("'" [^']* "'")

+

parse an XML Literal [11] SystemLiteral ::= ('"' [^"]* '"') | ("'" [^']* "'")

ctxt:an XML parser context
Returns:the SystemLiteral parsed or NULL

Function: xmlParseTextDecl

void	xmlParseTextDecl		(xmlParserCtxtPtr ctxt)

parse an XML declaration header for external entities [77] TextDecl ::= '<?xml' VersionInfo? EncodingDecl S? '?>' Question: Seems that EncodingDecl is mandatory ? Is that a typo ?

ctxt:an XML parser context

Function: xmlParseVersionInfo

xmlChar *	xmlParseVersionInfo	(xmlParserCtxtPtr ctxt)
-

parse the XML version. [24] VersionInfo ::= S 'version' Eq (' VersionNum ' | " VersionNum ") [25] Eq ::= S? '=' S?

-
ctxt:an XML parser context
Returns:the version string, e.g. "1.0"

Function: xmlParseVersionNum

xmlChar *	xmlParseVersionNum	(xmlParserCtxtPtr ctxt)
+

parse the XML version. [24] VersionInfo ::= S 'version' Eq (' VersionNum ' | " VersionNum ") [25] Eq ::= S? '=' S?

+
ctxt:an XML parser context
Returns:the version string, e.g. "1.0"

Function: xmlParseVersionNum

xmlChar *	xmlParseVersionNum	(xmlParserCtxtPtr ctxt)

parse the XML version value. [26] VersionNum ::= ([a-zA-Z0-9_.:] | '-')+

ctxt:an XML parser context
Returns:the string giving the XML version number, or NULL

Function: xmlParseXMLDecl

void	xmlParseXMLDecl			(xmlParserCtxtPtr ctxt)

parse an XML declaration header [23] XMLDecl ::= '<?xml' VersionInfo EncodingDecl? SDDecl? S? '?>'

ctxt:an XML parser context

Function: xmlParserHandlePEReference

void	xmlParserHandlePEReference	(xmlParserCtxtPtr ctxt)
-

[69] PEReference ::= '%' Name ';' [ WFC: No Recursion ] A parsed entity must not contain a recursive reference to itself, either directly or indirectly. [ WFC: Entity Declared ] In a document without any DTD, a document with only an internal DTD subset which contains no parameter entity references, or a document with "standalone='yes'", ... ... The declaration of a parameter entity must precede any reference to it... [ VC: Entity Declared ] In a document with an external subset or external parameter entities with "standalone='no'", ... ... The declaration of a parameter entity must precede any reference to it... [ WFC: In DTD ] Parameter-entity references may only appear in the DTD. NOTE: misleading but this is handled. A PEReference may have been detected in the current input stream the handling is done accordingly to http://www.w3.org/TR/REC-xml#entproc i.e. - Included in literal in entity values - Included as Parameter Entity reference within DTDs

+

[69] PEReference ::= '%' Name ';' [ WFC: No Recursion ] A parsed entity must not contain a recursive reference to itself, either directly or indirectly. [ WFC: Entity Declared ] In a document without any DTD, a document with only an internal DTD subset which contains no parameter entity references, or a document with "standalone='yes'", ... ... The declaration of a parameter entity must precede any reference to it... [ VC: Entity Declared ] In a document with an external subset or external parameter entities with "standalone='no'", ... ... The declaration of a parameter entity must precede any reference to it... [ WFC: In DTD ] Parameter-entity references may only appear in the DTD. NOTE: misleading but this is handled. A PEReference may have been detected in the current input stream the handling is done accordingly to http://www.w3.org/TR/REC-xml#entproc i.e. - Included in literal in entity values - Included as Parameter Entity reference within DTDs

ctxt:the parser context

Function: xmlParserHandleReference

void	xmlParserHandleReference	(xmlParserCtxtPtr ctxt)

TODO: Remove, now deprecated ... the test is done directly in the content parsing routines. [67] Reference ::= EntityRef | CharRef [68] EntityRef ::= '&' Name ';' [ WFC: Entity Declared ] the Name given in the entity reference must match that in an entity declaration, except that well-formed documents need not declare any of the following entities: amp, lt, gt, apos, quot. [ WFC: Parsed Entity ] An entity reference must not contain the name of an unparsed entity [66] CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';' A PEReference may have been detected in the current input stream the handling is done accordingly to http://www.w3.org/TR/REC-xml#entproc

ctxt:the parser context

Function: xmlParserInputShrink

void	xmlParserInputShrink		(xmlParserInputPtr in)
diff --git a/doc/html/libxml-tree.html b/doc/html/libxml-tree.html index 77372974..c2109493 100644 --- a/doc/html/libxml-tree.html +++ b/doc/html/libxml-tree.html @@ -207,8 +207,8 @@ A:link, A:visited, A:active { text-decoration: underline }

Macro: XML_GET_LINE

#define XML_GET_LINE

Macro to extract the line number of an element node.

Macro: XML_LOCAL_NAMESPACE

#define XML_LOCAL_NAMESPACE

A namespace declaration node.

Macro: XML_XML_NAMESPACE

#define XML_XML_NAMESPACE

This is the namespace for the special xml: prefix predefined in the XML Namespace specification.

-

Macro: xmlChildrenNode

#define xmlChildrenNode

Macro for compatibility naming layer with libxml1. Maps to "children."

-

Macro: xmlRootNode

#define xmlRootNode

Macro for compatibility naming layer with libxml1. Maps to "children".

+

Macro: xmlChildrenNode

#define xmlChildrenNode

Macro for compatibility naming layer with libxml1. Maps to "children."

+

Macro: xmlRootNode

#define xmlRootNode

Macro for compatibility naming layer with libxml1. Maps to "children".

Structure xmlAttr

Structure xmlAttr
struct _xmlAttr { void * _private : application data xmlElementType type : XML_ATTRIBUTE_NODE, must be second ! @@ -726,13 +726,13 @@ A:link, A:visited, A:active { text-decoration: underline }

Creation of a new node containing a CDATA block.

doc:the document
content:the CDATA block content content
len:the length of the block
Returns:a pointer to the new node object.

Function: xmlNewCharRef

xmlNodePtr	xmlNewCharRef		(xmlDocPtr doc, 
const xmlChar * name)

Creation of a new character reference node.

-
doc:the document
name:the char ref string, starting with # or "&# ... ;"
Returns:a pointer to the new node object.

Function: xmlNewChild

xmlNodePtr	xmlNewChild		(xmlNodePtr parent, 
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * content)
+
doc:the document
name:the char ref string, starting with # or "&# ... ;"
Returns:a pointer to the new node object.

Function: xmlNewChild

xmlNodePtr	xmlNewChild		(xmlNodePtr parent, 
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * content)

Creation of a new child element, added at the end of @parent children list. @ns and @content parameters are optional (NULL). If @ns is NULL, the newly created element inherits the namespace of @parent. If @content is non NULL, a child list containing the TEXTs and ENTITY_REFs node will be created. NOTE: @content is supposed to be a piece of XML CDATA, so it allows entity references. XML special chars must be escaped first by using xmlEncodeEntitiesReentrant(), or xmlNewTextChild() should be used.

parent:the parent node
ns:a namespace if any
name:the name of the child
content:the XML content of the child if any.
Returns:a pointer to the new node object.

Function: xmlNewComment

xmlNodePtr	xmlNewComment		(const xmlChar * content)

Creation of a new node containing a comment.

content:the comment content
Returns:a pointer to the new node object.

Function: xmlNewDoc

xmlDocPtr	xmlNewDoc		(const xmlChar * version)

Creates a new XML document

-
version:xmlChar string giving the version of XML "1.0"
Returns:a new document

Function: xmlNewDocComment

xmlNodePtr	xmlNewDocComment	(xmlDocPtr doc, 
const xmlChar * content)
+
version:xmlChar string giving the version of XML "1.0"
Returns:a new document

Function: xmlNewDocComment

xmlNodePtr	xmlNewDocComment	(xmlDocPtr doc, 
const xmlChar * content)

Creation of a new node containing a comment within a document.

doc:the document
content:the comment content
Returns:a pointer to the new node object.

Function: xmlNewDocFragment

xmlNodePtr	xmlNewDocFragment	(xmlDocPtr doc)

Creation of a new Fragment node.

@@ -792,7 +792,7 @@ A:link, A:visited, A:active { text-decoration: underline }

Searches the language of a node, i.e. the values of the xml:lang attribute or the one carried by the nearest ancestor.

cur:the node being checked
Returns:a pointer to the lang value, or NULL if not found It's up to the caller to free the memory with xmlFree().

Function: xmlNodeGetSpacePreserve

int	xmlNodeGetSpacePreserve		(xmlNodePtr cur)

Searches the space preserving behaviour of a node, i.e. the values of the xml:space attribute or the one carried by the nearest ancestor.

-
cur:the node being checked
Returns:-1 if xml:space is not inherited, 0 if "default", 1 if "preserve"

Function: xmlNodeIsText

int	xmlNodeIsText			(xmlNodePtr node)
+
cur:the node being checked
Returns:-1 if xml:space is not inherited, 0 if "default", 1 if "preserve"

Function: xmlNodeIsText

int	xmlNodeIsText			(xmlNodePtr node)

Is this node a Text node ?

node:the node
Returns:1 yes, 0 no

Function: xmlNodeListGetRawString

xmlChar *	xmlNodeListGetRawString	(xmlDocPtr doc, 
xmlNodePtr list,
int inLine)

Builds the string equivalent to the text contained in the Node list made of TEXTs and ENTITY_REFs, contrary to xmlNodeListGetString() this function doesn't do any character encoding handling.

@@ -810,20 +810,20 @@ A:link, A:visited, A:active { text-decoration: underline }

Set (or reset) the name of a node.

cur:the node being changed
name:the new tag name

Function: xmlNodeSetSpacePreserve

void	xmlNodeSetSpacePreserve		(xmlNodePtr cur, 
int val)

Set (or reset) the space preserving behaviour of a node, i.e. the value of the xml:space attribute.

-
cur:the node being changed
val:the xml:space value ("0": default, 1: "preserve")

Function: xmlReconciliateNs

int	xmlReconciliateNs		(xmlDocPtr doc, 
xmlNodePtr tree)
+
cur:the node being changed
val:the xml:space value ("0": default, 1: "preserve")

Function: xmlReconciliateNs

int	xmlReconciliateNs		(xmlDocPtr doc, 
xmlNodePtr tree)

This function checks that all the namespaces declared within the given tree are properly declared. This is needed for example after Copy or Cut and then paste operations. The subtree may still hold pointers to namespace declarations outside the subtree or invalid/masked. As much as possible the function try to reuse the existing namespaces found in the new environment. If not possible the new namespaces are redeclared on @tree at the top of the given subtree.

doc:the document
tree:a node defining the subtree to reconciliate
Returns:the number of namespace declarations created or -1 in case of error.

Function: xmlRemoveProp

int	xmlRemoveProp			(xmlAttrPtr cur)

Unlink and free one attribute, all the content is freed too Note this doesn't work for namespace definition attributes

cur:an attribute
Returns:0 if success and -1 in case of error.

Function: xmlReplaceNode

xmlNodePtr	xmlReplaceNode		(xmlNodePtr old, 
xmlNodePtr cur)

Unlink the old node from its current context, prune the new one at the same place. If @cur was already inserted in a document it is first unlinked from its existing context.

old:the old node
cur:the node
Returns:the @old node

Function: xmlSaveFile

int	xmlSaveFile			(const char * filename, 
xmlDocPtr cur)
-

Dump an XML document to a file. Will use compression if compiled in and enabled. If @filename is "-" the stdout file is used.

+

Dump an XML document to a file. Will use compression if compiled in and enabled. If @filename is "-" the stdout file is used.

filename:the filename (or URL)
cur:the document
Returns:the number of bytes written or -1 in case of failure.

Function: xmlSaveFileEnc

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

Dump an XML document, converting it to the given encoding

filename:the filename (or URL)
cur:the document
encoding:the name of an encoding (or NULL)
Returns:the number of bytes written or -1 in case of failure.

Function: xmlSaveFileTo

int	xmlSaveFileTo			(xmlOutputBufferPtr buf, 
xmlDocPtr cur,
const char * encoding)

Dump an XML document to an I/O buffer.

buf:an output I/O buffer
cur:the document
encoding:the encoding if any assuming the I/O layer handles the trancoding
Returns:the number of bytes written or -1 in case of failure.

Function: xmlSaveFormatFile

int	xmlSaveFormatFile		(const char * filename, 
xmlDocPtr cur,
int format)
-

Dump an XML document to a file. Will use compression if compiled in and enabled. If @filename is "-" the stdout file is used. If @format is set then the document will be indented on output. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

+

Dump an XML document to a file. Will use compression if compiled in and enabled. If @filename is "-" the stdout file is used. If @format is set then the document will be indented on output. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

filename:the filename (or URL)
cur:the document
format:should formatting spaces been added
Returns:the number of bytes written or -1 in case of failure.

Function: xmlSaveFormatFileEnc

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

Dump an XML document to a file or an URL.

filename:the filename or URL to output
cur:the document being saved
encoding:the name of the encoding to use or NULL.
format:should formatting spaces be added.
Returns:the number of bytes written or -1 in case of error. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

Function: xmlSaveFormatFileTo

int	xmlSaveFormatFileTo		(xmlOutputBufferPtr buf, 
xmlDocPtr cur,
const char * encoding,
int format)
diff --git a/doc/html/libxml-uri.html b/doc/html/libxml-uri.html index f2a9fb5a..6d909d6e 100644 --- a/doc/html/libxml-uri.html +++ b/doc/html/libxml-uri.html @@ -47,9 +47,9 @@ A:link, A:visited, A:active { text-decoration: underline }
uri:pointer to an xmlURI

Function: xmlNormalizeURIPath

int	xmlNormalizeURIPath		(char * path)

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

path:pointer to the path string
Returns:0 or an error code

Function: xmlParseURI

xmlURIPtr	xmlParseURI		(const char * str)
-

Parse an URI URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]

+

Parse an URI URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]

str:the URI string to analyze
Returns:a newly build xmlURIPtr or NULL in case of error

Function: xmlParseURIReference

int	xmlParseURIReference		(xmlURIPtr uri, 
const char * str)
-

Parse an URI reference string and fills in the appropriate fields of the @uri structure URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]

+

Parse an URI reference string and fills in the appropriate fields of the @uri structure URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]

uri:pointer to an URI structure
str:the string to analyze
Returns:0 or the error code

Function: xmlPrintURI

void	xmlPrintURI			(FILE * stream, 
xmlURIPtr uri)

Prints the URI in the stream @steam.

stream:a FILE* for the output
uri:pointer to an xmlURI

Function: xmlSaveUri

xmlChar *	xmlSaveUri		(xmlURIPtr uri)
diff --git a/doc/html/libxml-xinclude.html b/doc/html/libxml-xinclude.html index 2ece0249..4690e6ec 100644 --- a/doc/html/libxml-xinclude.html +++ b/doc/html/libxml-xinclude.html @@ -22,16 +22,16 @@ The content of this structure is not made public by the API.
int	xmlXIncludeProcessTreeFlags	(xmlNodePtr tree, 
int flags)
int	xmlXIncludeSetFlags		(xmlXIncludeCtxtPtr ctxt, 
int flags)

Description

-

Macro: XINCLUDE_FALLBACK

#define XINCLUDE_FALLBACK

Macro defining "fallback"

-

Macro: XINCLUDE_HREF

#define XINCLUDE_HREF

Macro defining "href"

-

Macro: XINCLUDE_NODE

#define XINCLUDE_NODE

Macro defining "include"

+

Macro: XINCLUDE_FALLBACK

#define XINCLUDE_FALLBACK

Macro defining "fallback"

+

Macro: XINCLUDE_HREF

#define XINCLUDE_HREF

Macro defining "href"

+

Macro: XINCLUDE_NODE

#define XINCLUDE_NODE

Macro defining "include"

Macro: XINCLUDE_NS

#define XINCLUDE_NS

Macro defining the Xinclude namespace: http://www.w3.org/2003/XInclude

Macro: XINCLUDE_OLD_NS

#define XINCLUDE_OLD_NS

Macro defining the draft Xinclude namespace: http://www.w3.org/2001/XInclude

-

Macro: XINCLUDE_PARSE

#define XINCLUDE_PARSE

Macro defining "parse"

-

Macro: XINCLUDE_PARSE_ENCODING

#define XINCLUDE_PARSE_ENCODING

Macro defining "encoding"

-

Macro: XINCLUDE_PARSE_TEXT

#define XINCLUDE_PARSE_TEXT

Macro defining "text"

-

Macro: XINCLUDE_PARSE_XML

#define XINCLUDE_PARSE_XML

Macro defining "xml"

-

Macro: XINCLUDE_PARSE_XPOINTER

#define XINCLUDE_PARSE_XPOINTER

Macro defining "xpointer"

+

Macro: XINCLUDE_PARSE

#define XINCLUDE_PARSE

Macro defining "parse"

+

Macro: XINCLUDE_PARSE_ENCODING

#define XINCLUDE_PARSE_ENCODING

Macro defining "encoding"

+

Macro: XINCLUDE_PARSE_TEXT

#define XINCLUDE_PARSE_TEXT

Macro defining "text"

+

Macro: XINCLUDE_PARSE_XML

#define XINCLUDE_PARSE_XML

Macro defining "xml"

+

Macro: XINCLUDE_PARSE_XPOINTER

#define XINCLUDE_PARSE_XPOINTER

Macro defining "xpointer"

Structure xmlXIncludeCtxt

Structure xmlXIncludeCtxt
struct _xmlXIncludeCtxt { The content of this structure is not made public by the API. }

Function: xmlXIncludeFreeContext

void	xmlXIncludeFreeContext		(xmlXIncludeCtxtPtr ctxt)
diff --git a/doc/html/libxml-xmlIO.html b/doc/html/libxml-xmlIO.html index d7d48eba..e9f84d92 100644 --- a/doc/html/libxml-xmlIO.html +++ b/doc/html/libxml-xmlIO.html @@ -143,7 +143,7 @@ int xmlInputReadCallback (void * context,
char * buffer,
fd:a file descriptor number
encoder:the encoding converter or NULL
Returns:the new parser output or NULL

Function: xmlOutputBufferCreateFile

xmlOutputBufferPtr	xmlOutputBufferCreateFile	(FILE * file, 
xmlCharEncodingHandlerPtr encoder)

Create a buffered output for the progressive saving to a FILE * buffered C I/O

file:a FILE*
encoder:the encoding converter or NULL
Returns:the new parser output or NULL

Function: xmlOutputBufferCreateFilename

xmlOutputBufferPtr	xmlOutputBufferCreateFilename	(const char * URI, 
xmlCharEncodingHandlerPtr encoder,
int compression)
-

Create a buffered output for the progressive saving of a file If filename is "-' then we use stdout as the output. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. TODO: currently if compression is set, the library only support writing to a local file.

+

Create a buffered output for the progressive saving of a file If filename is "-' then we use stdout as the output. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. TODO: currently if compression is set, the library only support writing to a local file.

URI:a C string containing the URI or filename
encoder:the encoding converter or NULL
compression:the compression ration (0 none, 9 max).
Returns:the new output or NULL

Function: xmlOutputBufferCreateIO

xmlOutputBufferPtr	xmlOutputBufferCreateIO	(xmlOutputWriteCallback iowrite, 
xmlOutputCloseCallback ioclose,
void * ioctx,
xmlCharEncodingHandlerPtr encoder)

Create a buffered output for the progressive saving to an I/O handler

iowrite:an I/O write function
ioclose:an I/O close function
ioctx:an I/O handler
encoder:the charset encoding if known
Returns:the new parser output or NULL

Function: xmlOutputBufferFlush

int	xmlOutputBufferFlush		(xmlOutputBufferPtr out)
@@ -171,7 +171,7 @@ int xmlOutputWriteCallback (void * context,
const char * buffer,
fd:a file descriptor number
enc:the charset encoding if known
Returns:the new parser input or NULL

Function: xmlParserInputBufferCreateFile

xmlParserInputBufferPtr	xmlParserInputBufferCreateFile	(FILE * file, 
xmlCharEncoding enc)

Create a buffered parser input for the progressive parsing of a FILE * buffered C I/O

file:a FILE*
enc:the charset encoding if known
Returns:the new parser input or NULL

Function: xmlParserInputBufferCreateFilename

xmlParserInputBufferPtr	xmlParserInputBufferCreateFilename	(const char * URI, 
xmlCharEncoding enc)
-

Create a buffered parser input for the progressive parsing of a file If filename is "-' then we use stdin as the input. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. Do an encoding check if enc == XML_CHAR_ENCODING_NONE

+

Create a buffered parser input for the progressive parsing of a file If filename is "-' then we use stdin as the input. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. Do an encoding check if enc == XML_CHAR_ENCODING_NONE

URI:a C string containing the URI or filename
enc:the charset encoding if known
Returns:the new parser input or NULL

Function: xmlParserInputBufferCreateIO

xmlParserInputBufferPtr	xmlParserInputBufferCreateIO	(xmlInputReadCallback ioread, 
xmlInputCloseCallback ioclose,
void * ioctx,
xmlCharEncoding enc)

Create a buffered parser input for the progressive parsing for the input from an I/O handler

ioread:an I/O read function
ioclose:an I/O close function
ioctx:an I/O handler
enc:the charset encoding if known
Returns:the new parser input or NULL

Function: xmlParserInputBufferCreateMem

xmlParserInputBufferPtr	xmlParserInputBufferCreateMem	(const char * mem, 
int size,
xmlCharEncoding enc)
@@ -189,7 +189,7 @@ int xmlOutputWriteCallback (void * context,
const char * buffer, Function: xmlRegisterDefaultOutputCallbacks
void	xmlRegisterDefaultOutputCallbacks	(void)

Registers the default compiled-in I/O handlers.

Function: xmlRegisterHTTPPostCallbacks

void	xmlRegisterHTTPPostCallbacks	(void)
-

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.

+

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.

Function: xmlRegisterInputCallbacks

int	xmlRegisterInputCallbacks	(xmlInputMatchCallback matchFunc, 
xmlInputOpenCallback openFunc,
xmlInputReadCallback readFunc,
xmlInputCloseCallback closeFunc)

Register a new set of I/O callback for handling parser input.

matchFunc:the xmlInputMatchCallback
openFunc:the xmlInputOpenCallback
readFunc:the xmlInputReadCallback
closeFunc:the xmlInputCloseCallback
Returns:the registered handler number or -1 in case of error

Function: xmlRegisterOutputCallbacks

int	xmlRegisterOutputCallbacks	(xmlOutputMatchCallback matchFunc, 
xmlOutputOpenCallback openFunc,
xmlOutputWriteCallback writeFunc,
xmlOutputCloseCallback closeFunc)
diff --git a/doc/html/libxml-xmlmemory.html b/doc/html/libxml-xmlmemory.html index 8beea769..22f0956e 100644 --- a/doc/html/libxml-xmlmemory.html +++ b/doc/html/libxml-xmlmemory.html @@ -71,14 +71,14 @@ void * xmlMallocFunc (size_t size)
size:an int specifying the size in byte to allocate.
file:the file name or NULL
line:the line number
Returns:a pointer to the allocated area or NULL in case of lack of memory.

Function: xmlMemDisplay

void	xmlMemDisplay			(FILE * fp)

show in-extenso the memory blocks allocated

fp:a FILE descriptor used as the output file, if NULL, the result is written to the file .memorylist

Function: xmlMemFree

void	xmlMemFree			(void * ptr)
-

-
ptr:

Function: xmlMemGet

int	xmlMemGet			(xmlFreeFunc * freeFunc, 
xmlMallocFunc * mallocFunc,
xmlReallocFunc * reallocFunc,
xmlStrdupFunc * strdupFunc)
+

a free() equivalent, with error checking.

+
ptr:the memory block pointer

Function: xmlMemGet

int	xmlMemGet			(xmlFreeFunc * freeFunc, 
xmlMallocFunc * mallocFunc,
xmlReallocFunc * reallocFunc,
xmlStrdupFunc * strdupFunc)

Provides the memory access functions set currently in use

freeFunc:place to save the free() function in use
mallocFunc:place to save the malloc() function in use
reallocFunc:place to save the realloc() function in use
strdupFunc:place to save the strdup() function in use
Returns:0 on success

Function: xmlMemMalloc

void *	xmlMemMalloc			(size_t size)
-

-
size:
Returns:

Function: xmlMemRealloc

void *	xmlMemRealloc			(void * ptr, 
size_t size)
-

-
ptr:
size:
Returns:

Function: xmlMemSetup

int	xmlMemSetup			(xmlFreeFunc freeFunc, 
xmlMallocFunc mallocFunc,
xmlReallocFunc reallocFunc,
xmlStrdupFunc strdupFunc)
+

a malloc() equivalent, with logging of the allocation info.

+
size:an int specifying the size in byte to allocate.
Returns:a pointer to the allocated area or NULL in case of lack of memory.

Function: xmlMemRealloc

void *	xmlMemRealloc			(void * ptr, 
size_t size)
+

a realloc() equivalent, with logging of the allocation info.

+
ptr:the initial memory block pointer
size:an int specifying the size in byte to allocate.
Returns:a pointer to the allocated area or NULL in case of lack of memory.

Function: xmlMemSetup

int	xmlMemSetup			(xmlFreeFunc freeFunc, 
xmlMallocFunc mallocFunc,
xmlReallocFunc reallocFunc,
xmlStrdupFunc strdupFunc)

Override the default memory access functions with a new set This has to be called before any other libxml routines ! Should this be blocked if there was already some allocations done ?

freeFunc:the free() function to use
mallocFunc:the malloc() function to use
reallocFunc:the realloc() function to use
strdupFunc:the strdup() function to use
Returns:0 on success

Function: xmlMemShow

void	xmlMemShow			(FILE * fp, 
int nr)

show a show display of the memory allocated, and dump the @nr last allocated areas which were not freed

@@ -89,8 +89,8 @@ void * xmlMallocFunc (size_t size)
Returns:an int representing the amount of memory allocated.

Function: xmlMemoryDump

void	xmlMemoryDump			(void)

Dump in-extenso the memory blocks allocated to the file .memorylist

Function: xmlMemoryStrdup

char *	xmlMemoryStrdup			(const char * str)
-

-
str:
Returns:

Function type: xmlReallocFunc

Function type: xmlReallocFunc
+

a strdup() equivalent, with logging of the allocation info.

+
str:the initial string pointer
Returns:a pointer to the new string or NULL if allocation error occurred.

Function type: xmlReallocFunc

Function type: xmlReallocFunc
 void *	xmlReallocFunc			(void * mem, 
size_t size)

Signature for a realloc() implementation.

mem:an already allocated block of memory
size:the new size requested in bytes
Returns:a pointer to the newly reallocated block or NULL in case of error.

Function: xmlReallocLoc

void *	xmlReallocLoc			(void * ptr, 
size_t size,
const char * file,
int line)
diff --git a/doc/html/libxml-xmlreader.html b/doc/html/libxml-xmlreader.html index e6395e34..1086e53f 100644 --- a/doc/html/libxml-xmlreader.html +++ b/doc/html/libxml-xmlreader.html @@ -253,7 +253,7 @@ void xmlTextReaderErrorFunc (void * arg,
const char * msg,

This tells the XML Reader to preserve all nodes matched by the pattern. The caller must also use xmlTextReaderCurrentDoc() to keep an handle on the resulting document once parsing has finished

reader:the xmlTextReaderPtr used
pattern:an XPath subset pattern
namespaces:the prefix definitions, array of [URI, prefix] or NULL
Returns:a positive number in case of success and -1 in case of error

Function: xmlTextReaderQuoteChar

int	xmlTextReaderQuoteChar		(xmlTextReaderPtr reader)

The quotation mark character used to enclose the value of an attribute.

-
reader:the xmlTextReaderPtr used
Returns:" or ' and -1 in case of error

Function: xmlTextReaderRead

int	xmlTextReaderRead		(xmlTextReaderPtr reader)
+
reader:the xmlTextReaderPtr used
Returns:" or ' and -1 in case of error

Function: xmlTextReaderRead

int	xmlTextReaderRead		(xmlTextReaderPtr reader)

Moves the position of the current instance to the next node in the stream, exposing its properties.

reader:the xmlTextReaderPtr used
Returns:1 if the node was read successfully, 0 if there is no more nodes to read, or -1 in case of error

Function: xmlTextReaderReadAttributeValue

int	xmlTextReaderReadAttributeValue	(xmlTextReaderPtr reader)

Parses an attribute value into one or more Text and EntityReference nodes.

diff --git a/doc/html/libxml-xmlschemastypes.html b/doc/html/libxml-xmlschemastypes.html index 052c9686..0e54b2d2 100644 --- a/doc/html/libxml-xmlschemastypes.html +++ b/doc/html/libxml-xmlschemastypes.html @@ -34,7 +34,7 @@ A:link, A:visited, A:active { text-decoration: underline }

Cleanup the default XML Schemas type library

value:the value to free

Function: xmlSchemaGetPredefinedType

xmlSchemaTypePtr	xmlSchemaGetPredefinedType	(const xmlChar * name, 
const xmlChar * ns)

Lookup a type in the default XML Schemas type library

-
name:the type name
ns:the URI of the namespace usually "http://www.w3.org/2001/XMLSchema"
Returns:the type if found, NULL otherwise

Function: xmlSchemaInitTypes

void	xmlSchemaInitTypes		(void)
+
name:the type name
ns:the URI of the namespace usually "http://www.w3.org/2001/XMLSchema"
Returns:the type if found, NULL otherwise

Function: xmlSchemaInitTypes

void	xmlSchemaInitTypes		(void)

Initialize the default XML Schemas type library

Function: xmlSchemaNewFacet

xmlSchemaFacetPtr	xmlSchemaNewFacet	(void)

Allocate a new Facet structure.

diff --git a/doc/html/libxml-xmlstring.html b/doc/html/libxml-xmlstring.html index 811dc7f3..4b6acd81 100644 --- a/doc/html/libxml-xmlstring.html +++ b/doc/html/libxml-xmlstring.html @@ -10,7 +10,7 @@ A:link, A:visited, A:active { text-decoration: underline } Module xmlstring from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Module xmlstring from libxml2

API Menu
API Indexes
Related links

Interfaces, constants and types related to the XML parser

Table of Contents

#define BAD_CAST
Typedef unsigned char xmlChar
+    Module xmlstring from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Module xmlstring from libxml2

API Menu
API Indexes
Related links

type and interfaces needed for the internal string handling of the library, especially UTF8 processing.

Table of Contents

#define BAD_CAST
Typedef unsigned char xmlChar
 
xmlChar *	xmlCharStrdup		(const char * cur)
xmlChar *	xmlCharStrndup		(const char * cur, 
int len)
int	xmlCheckUTF8			(const unsigned char * utf)
diff --git a/doc/html/libxml-xmlversion.html b/doc/html/libxml-xmlversion.html index 87cb6c2e..8b5c554e 100644 --- a/doc/html/libxml-xmlversion.html +++ b/doc/html/libxml-xmlversion.html @@ -19,7 +19,7 @@ A:link, A:visited, A:active { text-decoration: underline }

Macro: LIBXML_CATALOG_ENABLED

#define LIBXML_CATALOG_ENABLED

Whether the Catalog support is configured in

Macro: LIBXML_DEBUG_ENABLED

#define LIBXML_DEBUG_ENABLED

Whether Debugging module is configured in

Macro: LIBXML_DOCB_ENABLED

#define LIBXML_DOCB_ENABLED

Whether the SGML Docbook support is configured in

-

Macro: LIBXML_DOTTED_VERSION

#define LIBXML_DOTTED_VERSION

the version string like "1.2.3"

+

Macro: LIBXML_DOTTED_VERSION

#define LIBXML_DOTTED_VERSION

the version string like "1.2.3"

Macro: LIBXML_FTP_ENABLED

#define LIBXML_FTP_ENABLED

Whether the FTP support is configured in

Macro: LIBXML_HTML_ENABLED

#define LIBXML_HTML_ENABLED

Whether the HTML support is configured in

Macro: LIBXML_HTTP_ENABLED

#define LIBXML_HTTP_ENABLED

Whether the HTTP support is configured in

@@ -39,7 +39,7 @@ A:link, A:visited, A:active { text-decoration: underline }

Macro: LIBXML_UNICODE_ENABLED

#define LIBXML_UNICODE_ENABLED

Whether the Unicode related interfaces are compiled in

Macro: LIBXML_VALID_ENABLED

#define LIBXML_VALID_ENABLED

Whether the DTD validation support is configured in

Macro: LIBXML_VERSION

#define LIBXML_VERSION

the version number: 1.2.3 value is 1002003

-

Macro: LIBXML_VERSION_STRING

#define LIBXML_VERSION_STRING

the version number string, 1.2.3 value is "1002003"

+

Macro: LIBXML_VERSION_STRING

#define LIBXML_VERSION_STRING

the version number string, 1.2.3 value is "1002003"

Macro: LIBXML_WRITER_ENABLED

#define LIBXML_WRITER_ENABLED

Whether the xmlWriter saving interface is configured in

Macro: LIBXML_XINCLUDE_ENABLED

#define LIBXML_XINCLUDE_ENABLED

Whether XInclude is configured in

Macro: LIBXML_XPATH_ENABLED

#define LIBXML_XPATH_ENABLED

Whether XPath is configured in

diff --git a/doc/html/libxml-xmlwriter.html b/doc/html/libxml-xmlwriter.html index 66fa7184..bdc17b41 100644 --- a/doc/html/libxml-xmlwriter.html +++ b/doc/html/libxml-xmlwriter.html @@ -144,7 +144,7 @@ The content of this structure is not made public by the API.

Start an xml DTD ATTLIST.

writer:the xmlTextWriterPtr
pe:TRUE if this is a parameter entity, FALSE if not
name:the name of the DTD ATTLIST
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error

Function: xmlTextWriterStartDocument

int	xmlTextWriterStartDocument	(xmlTextWriterPtr writer, 
const char * version,
const char * encoding,
const char * standalone)

Start a new xml document

-
writer:the xmlTextWriterPtr
version:the xml version ("1.0") or NULL for default ("1.0")
encoding:the encoding or NULL for default
standalone:"yes" or "no" or NULL for default
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error

Function: xmlTextWriterStartElement

int	xmlTextWriterStartElement	(xmlTextWriterPtr writer, 
const xmlChar * name)
+
writer:the xmlTextWriterPtr
version:the xml version ("1.0") or NULL for default ("1.0")
encoding:the encoding or NULL for default
standalone:"yes" or "no" or NULL for default
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error

Function: xmlTextWriterStartElement

int	xmlTextWriterStartElement	(xmlTextWriterPtr writer, 
const xmlChar * name)

Start an xml element.

writer:the xmlTextWriterPtr
name:element name
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error

Function: xmlTextWriterStartElementNS

int	xmlTextWriterStartElementNS	(xmlTextWriterPtr writer, 
const xmlChar * prefix,
const xmlChar * name,
const xmlChar * namespaceURI)

Start an xml element with namespace support.

diff --git a/doc/html/libxml-xpathInternals.html b/doc/html/libxml-xpathInternals.html index 2cc3178a..8168ad4a 100644 --- a/doc/html/libxml-xpathInternals.html +++ b/doc/html/libxml-xpathInternals.html @@ -255,31 +255,31 @@ A:link, A:visited, A:active { text-decoration: underline }
val:the xmlChar * value
Returns:the newly created object.

Function: xmlXPathNewValueTree

xmlXPathObjectPtr	xmlXPathNewValueTree	(xmlNodePtr val)

Create a new xmlXPathObjectPtr of type Value Tree (XSLT) and initialize it with the tree root @val

val:the NodePtr value
Returns:the newly created object.

Function: xmlXPathNextAncestor

xmlNodePtr	xmlXPathNextAncestor	(xmlXPathParserContextPtr ctxt, 
xmlNodePtr cur)
-

Traversal function for the "ancestor" direction the ancestor axis contains the ancestors of the context node; the ancestors of the context node consist of the parent of context node and the parent's parent and so on; the nodes are ordered in reverse document order; thus the parent is the first node on the axis, and the parent's parent is the second node on the axis

+

Traversal function for the "ancestor" direction the ancestor axis contains the ancestors of the context node; the ancestors of the context node consist of the parent of context node and the parent's parent and so on; the nodes are ordered in reverse document order; thus the parent is the first node on the axis, and the parent's parent is the second node on the axis

ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis

Function: xmlXPathNextAncestorOrSelf

xmlNodePtr	xmlXPathNextAncestorOrSelf	(xmlXPathParserContextPtr ctxt, 
xmlNodePtr cur)
-

Traversal function for the "ancestor-or-self" direction he ancestor-or-self axis contains the context node and ancestors of the context node in reverse document order; thus the context node is the first node on the axis, and the context node's parent the second; parent here is defined the same as with the parent axis.

+

Traversal function for the "ancestor-or-self" direction he ancestor-or-self axis contains the context node and ancestors of the context node in reverse document order; thus the context node is the first node on the axis, and the context node's parent the second; parent here is defined the same as with the parent axis.

ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis

Function: xmlXPathNextAttribute

xmlNodePtr	xmlXPathNextAttribute	(xmlXPathParserContextPtr ctxt, 
xmlNodePtr cur)
-

Traversal function for the "attribute" direction TODO: support DTD inherited default attributes

+

Traversal function for the "attribute" direction TODO: support DTD inherited default attributes

ctxt:the XPath Parser context
cur:the current attribute in the traversal
Returns:the next element following that axis

Function: xmlXPathNextChild

xmlNodePtr	xmlXPathNextChild	(xmlXPathParserContextPtr ctxt, 
xmlNodePtr cur)
-

Traversal function for the "child" direction The child axis contains the children of the context node in document order.

+

Traversal function for the "child" direction The child axis contains the children of the context node in document order.

ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis

Function: xmlXPathNextDescendant

xmlNodePtr	xmlXPathNextDescendant	(xmlXPathParserContextPtr ctxt, 
xmlNodePtr cur)
-

Traversal function for the "descendant" direction the descendant axis contains the descendants of the context node in document order; a descendant is a child or a child of a child and so on.

+

Traversal function for the "descendant" direction the descendant axis contains the descendants of the context node in document order; a descendant is a child or a child of a child and so on.

ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis

Function: xmlXPathNextDescendantOrSelf

xmlNodePtr	xmlXPathNextDescendantOrSelf	(xmlXPathParserContextPtr ctxt, 
xmlNodePtr cur)
-

Traversal function for the "descendant-or-self" direction the descendant-or-self axis contains the context node and the descendants of the context node in document order; thus the context node is the first node on the axis, and the first child of the context node is the second node on the axis

+

Traversal function for the "descendant-or-self" direction the descendant-or-self axis contains the context node and the descendants of the context node in document order; thus the context node is the first node on the axis, and the first child of the context node is the second node on the axis

ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis

Function: xmlXPathNextFollowing

xmlNodePtr	xmlXPathNextFollowing	(xmlXPathParserContextPtr ctxt, 
xmlNodePtr cur)
-

Traversal function for the "following" direction The following axis contains all nodes in the same document as the context node that are after the context node in document order, excluding any descendants and excluding attribute nodes and namespace nodes; the nodes are ordered in document order

+

Traversal function for the "following" direction The following axis contains all nodes in the same document as the context node that are after the context node in document order, excluding any descendants and excluding attribute nodes and namespace nodes; the nodes are ordered in document order

ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis

Function: xmlXPathNextFollowingSibling

xmlNodePtr	xmlXPathNextFollowingSibling	(xmlXPathParserContextPtr ctxt, 
xmlNodePtr cur)
-

Traversal function for the "following-sibling" direction The following-sibling axis contains the following siblings of the context node in document order.

+

Traversal function for the "following-sibling" direction The following-sibling axis contains the following siblings of the context node in document order.

ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis

Function: xmlXPathNextNamespace

xmlNodePtr	xmlXPathNextNamespace	(xmlXPathParserContextPtr ctxt, 
xmlNodePtr cur)
-

Traversal function for the "namespace" direction the namespace axis contains the namespace nodes of the context node; the order of nodes on this axis is implementation-defined; the axis will be empty unless the context node is an element We keep the XML namespace node at the end of the list.

+

Traversal function for the "namespace" direction the namespace axis contains the namespace nodes of the context node; the order of nodes on this axis is implementation-defined; the axis will be empty unless the context node is an element We keep the XML namespace node at the end of the list.

ctxt:the XPath Parser context
cur:the current attribute in the traversal
Returns:the next element following that axis

Function: xmlXPathNextParent

xmlNodePtr	xmlXPathNextParent	(xmlXPathParserContextPtr ctxt, 
xmlNodePtr cur)
-

Traversal function for the "parent" direction The parent axis contains the parent of the context node, if there is one.

+

Traversal function for the "parent" direction The parent axis contains the parent of the context node, if there is one.

ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis

Function: xmlXPathNextPreceding

xmlNodePtr	xmlXPathNextPreceding	(xmlXPathParserContextPtr ctxt, 
xmlNodePtr cur)
-

Traversal function for the "preceding" direction the preceding axis contains all nodes in the same document as the context node that are before the context node in document order, excluding any ancestors and excluding attribute nodes and namespace nodes; the nodes are ordered in reverse document order

+

Traversal function for the "preceding" direction the preceding axis contains all nodes in the same document as the context node that are before the context node in document order, excluding any ancestors and excluding attribute nodes and namespace nodes; the nodes are ordered in reverse document order

ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis

Function: xmlXPathNextPrecedingSibling

xmlNodePtr	xmlXPathNextPrecedingSibling	(xmlXPathParserContextPtr ctxt, 
xmlNodePtr cur)
-

Traversal function for the "preceding-sibling" direction The preceding-sibling axis contains the preceding siblings of the context node in reverse document order; the first preceding sibling is first on the axis; the sibling preceding that node is the second on the axis and so on.

+

Traversal function for the "preceding-sibling" direction The preceding-sibling axis contains the preceding siblings of the context node in reverse document order; the first preceding sibling is first on the axis; the sibling preceding that node is the second on the axis and so on.

ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis

Function: xmlXPathNextSelf

xmlNodePtr	xmlXPathNextSelf	(xmlXPathParserContextPtr ctxt, 
xmlNodePtr cur)
-

Traversal function for the "self" direction The self axis contains just the context node itself

+

Traversal function for the "self" direction The self axis contains just the context node itself

ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis

Function: xmlXPathNodeLeading

xmlNodeSetPtr	xmlXPathNodeLeading	(xmlNodeSetPtr nodes, 
xmlNodePtr node)

Implements the EXSLT - Sets leading() function: node-set set:leading (node-set, node-set) @nodes is sorted by document order, then #exslSetsNodeLeadingSorted is called.

nodes:a node-set
node:a node
Returns:the nodes in @nodes that precede @node in document order, @nodes if @node is NULL or an empty node-set if @nodes doesn't contain @node

Function: xmlXPathNodeLeadingSorted

xmlNodeSetPtr	xmlXPathNodeLeadingSorted	(xmlNodeSetPtr nodes, 
xmlNodePtr node)
@@ -369,11 +369,11 @@ A:link, A:visited, A:active { text-decoration: underline }
ctxt:the XPath Parser context
nargs:the number of arguments

Function: xmlXPathSubValues

void	xmlXPathSubValues		(xmlXPathParserContextPtr ctxt)

Implement the subtraction operation on XPath objects: The numeric operators convert their operands to numbers as if by calling the number function.

ctxt:the XPath Parser context

Function: xmlXPathSubstringAfterFunction

void	xmlXPathSubstringAfterFunction	(xmlXPathParserContextPtr ctxt, 
int nargs)
-

Implement the substring-after() XPath function string substring-after(string, string) The substring-after function returns the substring of the first argument string that follows the first occurrence of the second argument string in the first argument string, or the empty stringi if the first argument string does not contain the second argument string. For example, substring-after("1999/04/01","/") returns 04/01, and substring-after("1999/04/01","19") returns 99/04/01.

+

Implement the substring-after() XPath function string substring-after(string, string) The substring-after function returns the substring of the first argument string that follows the first occurrence of the second argument string in the first argument string, or the empty stringi if the first argument string does not contain the second argument string. For example, substring-after("1999/04/01","/") returns 04/01, and substring-after("1999/04/01","19") returns 99/04/01.

ctxt:the XPath Parser context
nargs:the number of arguments

Function: xmlXPathSubstringBeforeFunction

void	xmlXPathSubstringBeforeFunction	(xmlXPathParserContextPtr ctxt, 
int nargs)
-

Implement the substring-before() XPath function string substring-before(string, string) The substring-before function returns the substring of the first argument string that precedes the first occurrence of the second argument string in the first argument string, or the empty string if the first argument string does not contain the second argument string. For example, substring-before("1999/04/01","/") returns 1999.

+

Implement the substring-before() XPath function string substring-before(string, string) The substring-before function returns the substring of the first argument string that precedes the first occurrence of the second argument string in the first argument string, or the empty string if the first argument string does not contain the second argument string. For example, substring-before("1999/04/01","/") returns 1999.

ctxt:the XPath Parser context
nargs:the number of arguments

Function: xmlXPathSubstringFunction

void	xmlXPathSubstringFunction	(xmlXPathParserContextPtr ctxt, 
int nargs)
-

Implement the substring() XPath function string substring(string, number, number?) The substring function returns the substring of the first argument starting at the position specified in the second argument with length specified in the third argument. For example, substring("12345",2,3) returns "234". If the third argument is not specified, it returns the substring starting at the position specified in the second argument and continuing to the end of the string. For example, substring("12345",2) returns "2345". More precisely, each character in the string (see [3.6 Strings]) is considered to have a numeric position: the position of the first character is 1, the position of the second character is 2 and so on. The returned substring contains those characters for which the position of the character is greater than or equal to the second argument and, if the third argument is specified, less than the sum of the second and third arguments; the comparisons and addition used for the above follow the standard IEEE 754 rules. Thus: - substring("12345", 1.5, 2.6) returns "234" - substring("12345", 0, 3) returns "12" - substring("12345", 0 div 0, 3) returns "" - substring("12345", 1, 0 div 0) returns "" - substring("12345", -42, 1 div 0) returns "12345" - substring("12345", -1 div 0, 1 div 0) returns ""

+

Implement the substring() XPath function string substring(string, number, number?) The substring function returns the substring of the first argument starting at the position specified in the second argument with length specified in the third argument. For example, substring("12345",2,3) returns "234". If the third argument is not specified, it returns the substring starting at the position specified in the second argument and continuing to the end of the string. For example, substring("12345",2) returns "2345". More precisely, each character in the string (see [3.6 Strings]) is considered to have a numeric position: the position of the first character is 1, the position of the second character is 2 and so on. The returned substring contains those characters for which the position of the character is greater than or equal to the second argument and, if the third argument is specified, less than the sum of the second and third arguments; the comparisons and addition used for the above follow the standard IEEE 754 rules. Thus: - substring("12345", 1.5, 2.6) returns "234" - substring("12345", 0, 3) returns "12" - substring("12345", 0 div 0, 3) returns "" - substring("12345", 1, 0 div 0) returns "" - substring("12345", -42, 1 div 0) returns "12345" - substring("12345", -1 div 0, 1 div 0) returns ""

ctxt:the XPath Parser context
nargs:the number of arguments

Function: xmlXPathSumFunction

void	xmlXPathSumFunction		(xmlXPathParserContextPtr ctxt, 
int nargs)

Implement the sum() XPath function number sum(node-set) The sum function returns the sum of the values of the nodes in the argument node-set.

ctxt:the XPath Parser context
nargs:the number of arguments

Function: xmlXPathTrailing

xmlNodeSetPtr	xmlXPathTrailing	(xmlNodeSetPtr nodes1, 
xmlNodeSetPtr nodes2)
@@ -381,7 +381,7 @@ A:link, A:visited, A:active { text-decoration: underline }
nodes1:a node-set
nodes2:a node-set
Returns:the nodes in @nodes1 that follow the first node in @nodes2 in document order, @nodes1 if @nodes2 is NULL or empty or an empty node-set if @nodes1 doesn't contain @nodes2

Function: xmlXPathTrailingSorted

xmlNodeSetPtr	xmlXPathTrailingSorted	(xmlNodeSetPtr nodes1, 
xmlNodeSetPtr nodes2)

Implements the EXSLT - Sets trailing() function: node-set set:trailing (node-set, node-set)

nodes1:a node-set, sorted by document order
nodes2:a node-set, sorted by document order
Returns:the nodes in @nodes1 that follow the first node in @nodes2 in document order, @nodes1 if @nodes2 is NULL or empty or an empty node-set if @nodes1 doesn't contain @nodes2

Function: xmlXPathTranslateFunction

void	xmlXPathTranslateFunction	(xmlXPathParserContextPtr ctxt, 
int nargs)
-

Implement the translate() XPath function string translate(string, string, string) The translate function returns the first argument string with occurrences of characters in the second argument string replaced by the character at the corresponding position in the third argument string. For example, translate("bar","abc","ABC") returns the string BAr. If there is a character in the second argument string with no character at a corresponding position in the third argument string (because the second argument string is longer than the third argument string), then occurrences of that character in the first argument string are removed. For example, translate("--aaa--","abc-","ABC")

+

Implement the translate() XPath function string translate(string, string, string) The translate function returns the first argument string with occurrences of characters in the second argument string replaced by the character at the corresponding position in the third argument string. For example, translate("bar","abc","ABC") returns the string BAr. If there is a character in the second argument string with no character at a corresponding position in the third argument string (because the second argument string is longer than the third argument string), then occurrences of that character in the first argument string are removed. For example, translate("--aaa--","abc-","ABC")

ctxt:the XPath Parser context
nargs:the number of arguments

Function: xmlXPathTrueFunction

void	xmlXPathTrueFunction		(xmlXPathParserContextPtr ctxt, 
int nargs)

Implement the true() XPath function boolean true()

ctxt:the XPath Parser context
nargs:the number of arguments

Function: xmlXPathValueFlipSign

void	xmlXPathValueFlipSign		(xmlXPathParserContextPtr ctxt)
diff --git a/doc/libxml2-api.xml b/doc/libxml2-api.xml index 749dc759..21d0d037 100644 --- a/doc/libxml2-api.xml +++ b/doc/libxml2-api.xml @@ -2433,8 +2433,8 @@ - the core parser module - Interfaces, constants and types related to the XML parser + set of routines to process strings + type and interfaces needed for the internal string handling of the library, especially UTF8 processing. Daniel Veillard @@ -8743,9 +8743,9 @@ actually an xmlCharEncoding'/> - + a free() equivalent, with error checking. - + Provides the memory access functions set currently in use @@ -8756,15 +8756,15 @@ actually an xmlCharEncoding'/> - - - + a malloc() equivalent, with logging of the allocation info. + + - - - - + a realloc() equivalent, with logging of the allocation info. + + + Override the default memory access functions with a new set This has to be called before any other libxml routines ! Should this be blocked if there was already some allocations done ? @@ -8796,9 +8796,9 @@ actually an xmlCharEncoding'/> - - - + a strdup() equivalent, with logging of the allocation info. + + xmlMutexLock() is used to lock a libxml2 token. diff --git a/doc/libxml2-refs.xml b/doc/libxml2-refs.xml index b3c5595c..5fb5c454 100644 --- a/doc/libxml2-refs.xml +++ b/doc/libxml2-refs.xml @@ -15998,6 +15998,8 @@ + + @@ -16008,7 +16010,10 @@ + + + @@ -16280,6 +16285,8 @@ + + @@ -16715,6 +16722,8 @@ + + @@ -17004,6 +17013,7 @@ + @@ -18826,7 +18836,11 @@ + + + + @@ -20265,7 +20279,10 @@ + + + @@ -20339,7 +20356,9 @@ + + @@ -20458,29 +20477,6 @@ - - - - - - - - - - - - - - - - - - - - - - - @@ -20716,6 +20712,8 @@ + + @@ -21064,7 +21062,10 @@ + + + @@ -21163,6 +21164,7 @@ + @@ -21925,6 +21927,7 @@ + @@ -23113,6 +23116,7 @@ + @@ -24352,6 +24356,8 @@ + + @@ -24554,6 +24560,7 @@ + diff --git a/include/libxml/xmlstring.h b/include/libxml/xmlstring.h index 620c0e3b..74ae4050 100644 --- a/include/libxml/xmlstring.h +++ b/include/libxml/xmlstring.h @@ -1,6 +1,7 @@ /* - * Summary: the core parser module - * Description: Interfaces, constants and types related to the XML parser + * Summary: set of routines to process strings + * Description: type and interfaces needed for the internal string handling + * of the library, especially UTF8 processing. * * Copy: See Copyright for the status of this software. *