From aec635690a8aefbe632cccd177eb9157d4b18793 Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Sun, 23 Mar 2003 20:42:17 +0000 Subject: [PATCH] Rebuilt the docs, Daniel --- doc/Makefile.am | 2 +- doc/gnome-xml.sgml | 4 + doc/html/book1.html | 22 +- doc/html/index.sgml | 100 + doc/html/libxml-c14n.html | 104 +- doc/html/libxml-catalog.html | 256 +- doc/html/libxml-debugxml.html | 186 +- doc/html/libxml-docbparser.html | 96 +- doc/html/libxml-encoding.html | 332 +- doc/html/libxml-entities.html | 111 +- doc/html/libxml-globals.html | 503 ++- doc/html/libxml-hash.html | 162 +- doc/html/libxml-htmlparser.html | 197 +- doc/html/libxml-htmltree.html | 289 +- doc/html/libxml-lib.html | 17 +- doc/html/libxml-nanoftp.html | 268 +- doc/html/libxml-nanohttp.html | 94 +- doc/html/libxml-notes.html | 4 +- doc/html/libxml-parser.html | 1225 ++++-- doc/html/libxml-parserinternals.html | 915 +++-- doc/html/libxml-relaxng.html | 2202 +++++++++++ doc/html/libxml-sax.html | 266 +- doc/html/libxml-schemasinternals.html | 115 +- doc/html/libxml-threads.html | 128 +- doc/html/libxml-tree.html | 1905 ++++++--- doc/html/libxml-uri.html | 202 +- doc/html/libxml-valid.html | 995 ++++- doc/html/libxml-xinclude.html | 22 +- doc/html/libxml-xmlautomata.html | 161 +- doc/html/libxml-xmlerror.html | 73 +- doc/html/libxml-xmlio.html | 464 ++- doc/html/libxml-xmlmemory.html | 465 ++- doc/html/libxml-xmlreader.html | 5264 +++++++++++++++++++++++++ doc/html/libxml-xmlregexp.html | 91 +- doc/html/libxml-xmlschemas.html | 245 +- doc/html/libxml-xmlschemastypes.html | 544 ++- doc/html/libxml-xmlunicode.html | 1358 ++++--- doc/html/libxml-xpath.html | 334 +- doc/html/libxml-xpathinternals.html | 1090 +++-- doc/html/libxml-xpointer.html | 152 +- doc/libxml2-api.xml | 4 + 41 files changed, 17010 insertions(+), 3957 deletions(-) create mode 100644 doc/html/libxml-relaxng.html create mode 100644 doc/html/libxml-xmlreader.html diff --git a/doc/Makefile.am b/doc/Makefile.am index 5eb30d40..cab64bc0 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -48,7 +48,7 @@ $(APIPAGES): libxml2-refs.xml site.xsl api.xsl $(bindir)/xsltproc --html $(top_srcdir)/doc/api.xsl $(top_srcdir)/doc/xml.html ; fi ); scan: - -gtkdoc-scan --module=libxml --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="acconfig.h config.h win32config.h trio.h triostr.h triop.h config-mac.h XMLTestPrefix2.h XMLTestPrefix.h triodef.h trionan.h xlink.h libxml.h libxml2-py.h libxml_wrap.h xmlschemas.h xmlschemastypes.h" + -gtkdoc-scan --module=libxml --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="acconfig.h config.h win32config.h trio.h triostr.h triop.h config-mac.h XMLTestPrefix2.h XMLTestPrefix.h triodef.h trionan.h xlink.h libxml.h libxml2-py.h libxml_wrap.h" templates: scan -gtkdoc-mktmpl --module=libxml diff --git a/doc/gnome-xml.sgml b/doc/gnome-xml.sgml index d8fa1ca3..48ac5c9b 100644 --- a/doc/gnome-xml.sgml +++ b/doc/gnome-xml.sgml @@ -31,6 +31,8 @@ + + ]> @@ -90,10 +92,12 @@ build by extracting comments from the code sources. &parser; + &xmlreader; &SAX; &tree; &entities; &valid; + &relaxng; &uri; &error; &HTMLparser; diff --git a/doc/html/book1.html b/doc/html/book1.html index 43b3367e..117b3ee7 100644 --- a/doc/html/book1.html +++ b/doc/html/book1.html @@ -46,7 +46,9 @@ NAME="AEN2" >

Daniel Veillard

Daniel Veillard

This manual documents the interfaces of the libxml @@ -77,7 +81,9 @@ NAME="AEN18">

Permission is granted to make and distribute verbatim @@ -123,6 +129,11 @@ HREF="libxml-parser.html" > -- 

xmlreader -- 
SAX -- 
 -- 
relaxng -- 
uri -- 
+ @@ -110,6 +111,58 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -209,6 +262,10 @@ + + + + @@ -296,6 +353,7 @@ + @@ -337,6 +395,7 @@ + @@ -436,6 +495,33 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -450,6 +536,7 @@ + @@ -517,6 +604,7 @@ + @@ -785,6 +873,7 @@ + @@ -915,9 +1004,13 @@ + + + + @@ -943,6 +1036,8 @@ + + @@ -1372,6 +1467,7 @@ + @@ -1387,8 +1483,12 @@ + + + + diff --git a/doc/html/libxml-c14n.html b/doc/html/libxml-c14n.html index 22421085..a56c516f 100644 --- a/doc/html/libxml-c14n.html +++ b/doc/html/libxml-c14n.html @@ -117,11 +117,13 @@ SIZE="3" >

c14n

c14n

Name

Synopsis

Description

Details

the nodes set to be included in the canonized image -or NULL if all document nodes should be included
the exclusive flag (0 - non-exclusive canonicalization; -otherwise - exclusive canonicalization)
the list of inclusive namespace prefixes -ended with a NULL or NULL if there is no -inclusive namespaces (only for exclusive -canonicalization, ignored otherwise)
the output buffer to store canonical XML; this -buffer MUST have encoder==NULL because C14N requires -UTF-8 output

the nodes set to be included in the canonized image -or NULL if all document nodes should be included

the exclusive flag (0 - non-exclusive canonicalization; -otherwise - exclusive canonicalization)
the list of inclusive namespace prefixes -ended with a NULL or NULL if there is no -inclusive namespaces (only for exclusive -canonicalization, ignored otherwise)
the memory pointer for allocated canonical XML text; -the caller of this functions is responsible for calling -xmlFree() to free allocated memory
the nodes set to be included in the canonized image -or NULL if all document nodes should be included
the exclusive flag (0 - non-exclusive canonicalization; -otherwise - exclusive canonicalization)
the list of inclusive namespace prefixes -ended with a NULL or NULL if there is no -inclusive namespaces (only for exclusive -canonicalization, ignored otherwise)
the compression level (zlib requred): --1 - libxml default, -0 - uncompressed, ->0 - compression level

the function to use to determine is node visible -or not
is_visible_callback function -(in most cases, it is nodes set)
the exclusive flag (0 - non-exclusive canonicalization; -otherwise - exclusive canonicalization)
the list of inclusive namespace prefixes -ended with a NULL or NULL if there is no -inclusive namespaces (only for exclusive -canonicalization, ignored otherwise)
the output buffer to store canonical XML; this -buffer MUST have encoder==NULL because C14N requires -UTF-8 output

catalog

catalog

Name

Synopsis

Description

Details

the URI of the resource or NULL if not found, it must be freed -by the caller.

the system ID if found or NULL otherwise, the value returned -must be freed by the caller.

the system ID if found or NULL otherwise, the value returned -must be freed by the caller.

the URI of the resource or NULL if not found, it must be freed -by the caller.

a space-separated list of catalog files. 

the URI of the resource or NULL if not found, it must be freed -by the caller.

the system ID if found or NULL otherwise, the value returned -must be freed by the caller.

the system ID if found or NULL otherwise, the value returned -must be freed by the caller.

the URI of the resource or NULL if not found, it must be freed -by the caller.

the URI of the resource or NULL if not found, it must be freed -by the caller.

the URI of the resource or NULL if not found, it must be freed -by the caller.

debugXML

debugXML

Name

Synopsis

Description

Details

DOCBparser

DOCBparser

Name

Synopsis

Description

Details

inlen after return is the number of octets consumed -as the return value is positive, else unpredictable. + as the return value is positive, else unpredictable. The value of

0, -1 in case of error. the parser context is augmented -as a result of the parsing.

encoding

encoding

Name

Synopsis

xmlGetUTF8Char (unsigned char *utf, + int *len); +int xmlCheckUTF8 (unsigned char *utf); @@ -394,7 +403,7 @@ HREF="libxml-tree.html#XMLCHAR" >

Description

Details

the number of byte written, or -1 by lack of space, or -2 -if the transcoding failed. + if the transcoding failed. The value of inlen after return is the number of octets consumed -as the return value is positive, else unpredictiable. + as the return value is positive, else unpredictiable. The value of

the number of byte written, or -1 by lack of space, or -2 -if the transcoding failed. + if the transcoding failed. The value of inlen after return is the number of octets consumed -as the return value is positive, else unpredictiable. + as the return value is positive, else unpredictiable. The value of

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

a pointer to the first bytes of the XML entity, must be at least -4 bytes long.

the number of byte written if success, or --1 general error --2 if the transcoding fails (for *in is not valid utf8 string or -the result of transformation can't fit into the encoding we want), or

the number of byte written if success, or --1 general error --2 if the transcoding fails (for *in is not valid utf8 string or -the result of transformation can't fit into the encoding we want), or

the number of byte written if success, or --1 general error --2 if the transcoding fails (for *in is not valid utf8 string or -the result of transformation can't fit into the encoding we want), or

inlen after return is the number of octets consumed -as the return value is positive, else unpredictable. + as the return value is positive, else unpredictable. The value of

inlen after return is the number of octets consumed -as the return value is positive, else unpredictable. + as the return value is positive, else unpredictable. The value of

xmlGetUTF8Char ()

int         xmlGetUTF8Char                  (unsigned char *utf,
+                                             int *len);

Read one UTF8 Char from utf

utf : a sequence of UTF-8 encoded bytes
len : a pointer to bytes len
Returns :the char value or -1 in case of error and update len with the + number of bytes used

entities

entities

Name

Synopsis

Description

Details

TODO: remove xmlEncodeEntities, once we are not afraid of breaking binary -compatibility

People must migrate their code to xmlEncodeEntitiesReentrant ! This routine will issue a warning when encountered.

globals

globals

Name

Synopsis

+void (*xmlRegisterNodeFunc) (xmlNodePtr node); +void (*xmlDeregisterNodeFunc) (xmlNodePtr node); struct xmlGlobalStatexmlGlobalStatePtr gs); +xmlRegisterNodeFuncxmlRegisterNodeDefault (xmlRegisterNodeFunc func); +xmlDeregisterNodeFuncxmlDeregisterNodeDefault + (xmlDeregisterNodeFunc func); #define xmlMallocxmlSaveNoEmptyTags #define xmlSubstituteEntitiesDefaultValue +#define xmlRegisterNodeDefaultValue +#define xmlDeregisterNodeDefaultValue

Description

Details

xmlRegisterNodeFunc ()

void        (*xmlRegisterNodeFunc)          (xmlNodePtr node);

node : 

xmlDeregisterNodeFunc ()

void        (*xmlDeregisterNodeFunc)        (xmlNodePtr node);

node : 

xmlRegisterNodeDefault ()

xmlRegisterNodeFunc xmlRegisterNodeDefault  (xmlRegisterNodeFunc func);

Registers a callback for node creation

func : function pointer to the new RegisterNodeFunc
Returns :the old value of the registration function

xmlDeregisterNodeDefault ()

xmlDeregisterNodeFunc xmlDeregisterNodeDefault
+                                            (xmlDeregisterNodeFunc func);

Registers a callback for node destruction

func : function pointer to the new DeregisterNodeFunc
Returns :the previous value of the deregistration function

hash

hash

Name

Synopsis

Description

Details

HTMLparser

HTMLparser

Name

Synopsis

Description

Details

the associated htmlEntityDescPtr if found, or NULL otherwise, -if non-NULL *str will have to be freed by the caller.

parse Reference declarations

[66] CharRef ::= '&#' [0-9]+ ';' | -'&x' [0-9a-fA-F]+ ';'

0, -1 in case of error. the parser context is augmented -as a result of the parsing.

the resulting document tree unless SAX is NULL or the document is -not well formed.

the resulting document tree unless SAX is NULL or the document is -not well formed.

inlen after return is the number of octets consumed -as the return value is positive, else unpredictable. + as the return value is positive, else unpredictable. The value of

inlen after return is the number of octets consumed -as the return value is positive, else unpredictable. + as the return value is positive, else unpredictable. The value of

Create a parser context for using the HTML parser in push mode -To allow content encoding detection, size should be >= 4 The value of

HTMLtree

HTMLtree

Name

Synopsis

xmlDocPtr cur); -void htmlNodeDump ( (const xmlChar *name); *name); +void htmlNodeDumpOutput (xmlOutputBufferPtr buf, + xmlDocPtr doc, + xmlNodePtr cur, + const char *encoding);

Description

Details

void        htmlNodeDump                    (int         htmlNodeDump                    (xmlBufferPtr buf,
@@ -1305,7 +1339,9 @@ and formatting returns are added.
  the current node
Returns :the number of byte written or -1 in case of error
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
Libxml Library Reference
Libxml Library Reference
 -- 
xmlreader -- 
SAX -- 
 -- 
relaxng -- 
uri -- 
This section contains the API reference for libxml. All
     the public interfaces are documented here. This reference guide is
     build by extracting comments from the code sources. 
_functions;
-    

nanoftp
nanoftp
Name
Synopsis
long size,
+HREF="LONG-SIZE"
+>long size,
                                              int links,
                                              int year,
                                              const char *month,
@@ -234,6 +238,11 @@ HREF="libxml-nanoftp.html#XMLNANOFTPCWD"
 >                   (void *ctx,
                                              char *directory);
 int         xmlNanoFTPDele                  (void *ctx,
+                                             char *file);
+int         xmlNanoFTPGetConnection         (void *ctx);
@@ -279,7 +288,7 @@ HREF="libxml-nanoftp.html#XMLNANOFTPREAD"
 >
Description
Details
long size,
+HREF="LONG-SIZE"
+>long size,
                                              int links,
                                              int year,
                                              const char *month,
@@ -338,7 +347,9 @@ Note that only one of year and day:minute are specified.
sizeParam6 : 
  the file size
xmlNanoFTPDele ()
int         xmlNanoFTPDele                  (void *ctx,
+                                             char *file);
Tries to delete an item (file or directory) from server
ctx :  an FTP context
file :  a file or directory on the server
Returns :-1 incase of error, 1 if DELE worked, 0 if it failed
the number of byte read. 0 is an indication of an end of connection.
--1 indicates a parameter error.
nanohttp
nanohttp
Name
Synopsis
Description
Details
  if available the Content-Type information will be
-returned at that location
-1 in case of failure, 0 incase of success. The contentType,
-if provided must be freed by the caller
  if available the Content-Type information will be
-returned at that location
  if available the Content-Type information will be
-returned at that location
The parser context.
 NOTE This doesn't completely define the parser state, the (current ?)
-design of the parser uses recursive function calls since this allow
-and easy mapping from the production rules of the specification
-to the actual code. The drawback is that the actual function call
-also reflect the parser state. However most of the parsing routines
-takes as the only argument the parser context pointer, so migrating
-to a state based parser for progressive parsing shouldn't be too hard.
Callback:
 The entity loader, to control the loading of external entities,
 the application can either:
-- override this resolveEntity() callback in the SAX block
-- or better use the xmlSetExternalEntityLoader() function to
-set up it's own entity resolution routine
the number of byte read. 0 is an indication of an end of connection.
--1 indicates a parameter error.
Libxml Programming Notes
Libxml Programming Notes
Libxml is an XML toolkit library, it allows to parse, edit
      search and write XML documents. There is also an HTML parser front-end
diff --git a/doc/html/libxml-parser.html b/doc/html/libxml-parser.html
index f5782a4b..02cb492c 100644
--- a/doc/html/libxml-parser.html
+++ b/doc/html/libxml-parser.html
@@ -16,8 +16,8 @@ REL="PREVIOUS"
 TITLE="Libxml Library Reference"
 HREF="libxml-lib.html">
parser
parser
Synopsis
XML_COMPLETE_ATTRS
+#define     XML_SKIP_IDS
 struct      xmlParserCtxtxmlParserCtxtPtr context);
-#define     xmlSubstituteEntitiesDefaultValue
 void        xmlInitParserxmlDocPtr   xmlSAXParseMemoryWithData       (xmlSAXHandlerPtr sax,
+                                             const char *buffer,
+                                             int size,
+                                             int recovery,
+                                             void *data);
+xmlDocPtr   xmlSAXParseFile                 (
Description
Details
XML_SKIP_IDS
#define XML_SKIP_IDS		8
Bit in the loadsubset context field to tell to not do ID/REFs registration.
+Used to initialize xmlLoadExtDtdDefaultValue in some special cases.
Display and format fatal error messages, callback.
Display and format fatal error messages, callback.
+Note: so far fatalError() SAX callbacks are not used, error()
+      get all the callbacks for errors.
xmlSubstituteEntitiesDefaultValue
#define     xmlSubstituteEntitiesDefaultValue
Global variable controlling the entity substitution default behavior.
Cleanup function for the XML parser. It tries to reclaim all
 parsing related global memory allocated for the parser processing.
 It doesn't deallocate any document related memory. Calling this
-function should not prevent reusing the parser.
xmlCleanupParser() only when the process has
+finished using the library or XML document built with it.
0, -1 in case of error. the parser context is augmented
-as a result of the parsing.
0, -1 in case of error. the parser context is augmented
-as a result of the parsing.
  work in recovery mode, i.e. tries to read no Well Formed
-documents
  work in recovery mode, i.e. tries to read not Well Formed
-documents
xmlSAXParseFile ()
xmlSAXParseMemoryWithData ()xmlDocPtr   xmlSAXParseFile                 (   xmlSAXParseMemoryWithData       (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.
xmlSAXParseFileWithData ()
xmlDocPtr   xmlSAXParseFileWithData         (xmlSAXHandlerPtr sax,
-                                             const char *filename,
+                                             const char *buffer,
+                                             int size,
                                              int recovery,
                                              void *data);
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.
parse an XML in-memory block and use the given SAX function block
+to handle the parsing callback. If sax is NULL, fallback to the default
+DOM tree building routines.
User data (void *) is stored within the parser context in the
 context's _private member, so it is available nearly everywhere in libxml
filenamebuffer :  an pointer to a char array
  the filename
size :  the size of the array
  work in recovery mode, i.e. tries to read no Well Formed
-documents
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
xmlSAXParseFileWithData ()
xmlDocPtr   xmlSAXParseFileWithData         (xmlSAXHandlerPtr sax,
+                                             const char *filename,
+                                             int recovery,
+                                             void *data);
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.
User data (void *) is stored within the parser context in the
+context's _private member, so it is available nearly everywhere in libxml
sax :  the SAX handler block
filename :  the filename
recovery :  work in recovery mode, i.e. tries to read no Well Formed
+            documents
data :  the userdata
Returns :the resulting document tree
0 if the chunk is well balanced, -1 in case of args problem and
-the parser error code otherwise
0 if the chunk is well balanced, -1 in case of args problem and
-the parser error code otherwise
-
+   the parser error code otherwise
+   
 In case recover is set to 1, the nodelist will not be empty even if
 the parsed chunk is not well balanced. 
0 if the entity is well formed, -1 in case of args problem and
-the parser error code otherwise
0 if the entity is well formed, -1 in case of args problem and
-the parser error code otherwise
-1 in case or error, or the total number of features,
-len is updated with the number of strings copied,
-strings must not be deallocated
Create a parser context for using the XML parser in push mode
+>Create a parser context for using the XML parser in push mode.
+If buffer and size are non-NULL, the data is used to detect
+the encoding.  The remaining characters will be parsed so they
+don't need to be fed in again through xmlParseChunk.
 To allow content encoding detection, 
  an XML parser context 
-- Clear (release memory and reinitialize) node
-info sequence
xmlParserFindNodeInfoIndex : Find the index that the info record for
-the given node is or should be at in a sorted sequence
SAXxmlreader
parserInternals
parserInternals
Name
Synopsis
xmlElementContentPtrxmlParseElementChildrenContentD
-                                            (xmlParserCtxtPtr ctxt);
-xmlElementContentPtrxmlParseElementChildrenContentDecl
@@ -1141,7 +1134,7 @@ HREF="libxml-parserinternals.html#XMLENTITYREFERENCEFUNC"
 >
Description
Details
xFFFD]
-| [x10000-
  
x0640 |
-x0E46 | x3035] |
-[x309D-
x0640 |
-x0E46 | x3035] |
-[x309D-
xFFFD]
-| [x10000-
xmlPushInput: switch to a new input stream which is stacked on top
-of the previous one(s).
xmlPopInput: the current input pointed by ctxt->input came to an end
-pop it and return the next char.
the local part, and prefix is updated
-to get the Prefix if any.
parse an XML namespace name.
TODO: this seems not in use anymore, the namespace handling is done on
-top of the SAX interfaces, i.e. not on raw input.
[NS 3] NCName ::= (Letter | '_') (NCNameChar)*
[NS 4] NCNameChar ::= Letter | Digit | '.' | '-' | '_' |
-CombiningChar | Extender
TODO: this seems not in use anymore, the namespace handling is done on
-top of the SAX interfaces, i.e. not on raw input.
parse an XML qualified name
the local part, and prefix is updated
-to get the Prefix if any.
parse a namespace prefix declaration
TODO: this seems not in use anymore, the namespace handling is done on
-top of the SAX interfaces, i.e. not on raw input.
[NS 1] NSDef ::= PrefixDef Eq SystemLiteral
TODO: seems deprecated now, only used in the default part of
-xmlParserHandleReference
[4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' |
-CombiningChar | Extender
[5] Name ::= (Letter | '_' | ':') (NameChar)*
parse an XML name.
[4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' |
-CombiningChar | Extender
[5] Name ::= (Letter | '_' | ':') (NameChar)*
parse a value for ENTITY declarations
[9] EntityValue ::= '"' ([^%&"] | PEReference | Reference)* '"' |
-"'" ([^%&'] | PEReference | Reference)* "'"
[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
+  character to the attribute value
 - an entity reference is processed by recursively processing the
-replacement text of the entity 
+  replacement text of the entity 
 - a whitespace character (x20x9) is processed by
-appending x20 to the normalized value, except that only a single
-x20 is appended for a "xA" sequence that is part of an external
-parsed entity or the literal entity value of an internal parsed entity 
+  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
@@ -5396,7 +5479,9 @@ by a non-validating parser as if declared CDATA.
Parse an External ID or a Public ID
NOTE: Productions [75] and [83] interact badly since [75] can generate
-'PUBLIC' S PubidLiteral S SystemLiteral
[75] ExternalID ::= 'SYSTEM' S SystemLiteral
-| 'PUBLIC' S PubidLiteral S SystemLiteral
[83] PublicID ::= 'PUBLIC' S PubidLiteral
 indicate whether we should restrict parsing to only
-production [75], see NOTE below
the function returns SystemLiteral and in the second
-case publicID receives PubidLiteral, is strict is off
-it is possible to return NULL and have publicID set.
Skip an XML (SGML) comment <!-- .... -->
-The spec says that "For compatibility, the string "--" (double-hyphen)
-must not occur within comments. "
[15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'
[82] NotationDecl ::= '<!NOTATION' S Name S (ExternalID |  PublicID) S? '>'
Hence there is actually 3 choices:
-'PUBLIC' S PubidLiteral
-'PUBLIC' S PubidLiteral S SystemLiteral
+    'PUBLIC' S PubidLiteral
+    'PUBLIC' S PubidLiteral S SystemLiteral
 and 'SYSTEM' S SystemLiteral
See the NOTE on 
 XML_ATTRIBUTE_NONE, XML_ATTRIBUTE_REQUIRED, XML_ATTRIBUTE_IMPLIED
-or XML_ATTRIBUTE_FIXED. 
[55] StringType ::= 'CDATA'
[56] TokenizedType ::= 'ID' | 'IDREF' | 'IDREFS' | 'ENTITY' |
-'ENTITIES' | 'NMTOKEN' | 'NMTOKENS'
Validity constraints for attribute values syntax are checked in
 
PCDATA' (S? '|' S? Name)* S? ')*' |
-'(' S? 'PCDATA' S? ')'
   the input used for the current entity, needed for boundary checks
xmlParseElementChildrenContentD ()
xmlElementContentPtr xmlParseElementChildrenContentD
-                                            (xmlParserCtxtPtr ctxt);
VMS version of xmlParseElementChildrenContentDecl()
   the input used for the current entity, needed for boundary checks
the tree of xmlElementContentPtr describing the element 
-hierarchy.
parse Markup declarations
[29] markupdecl ::= elementdecl | AttlistDecl | EntityDecl |
-NotationDecl | PI | Comment
[ VC: Proper Declaration/PE Nesting ]
 Parameter-entity replacement text must be properly nested with
@@ -7518,7 +7549,9 @@ entities or to the external subset.)
parse Reference declarations
[66] CharRef ::= '&#' [0-9]+ ';' |
-'&x' [0-9a-fA-F]+ ';'
parse a DOCTYPE declaration
[28] doctypedecl ::= '<!DOCTYPE' S Name (S ExternalID)? S? 
-('[' (markupdecl | PEReference | S)* ']' S?)? '>'
[ VC: Root Element Type ]
 The Name in the document type declaration must match the element
@@ -7958,7 +7999,9 @@ type of the root element.
[ VC: Element Valid ]
 An element is valid if there is a declaration matching elementdecl
 where the Name matches the element type and one of the following holds:
-- The declaration matches EMPTY and the element has no content.
-- The declaration matches children and the sequence of child elements
-belongs to the language generated by the regular expression in the
-content model, with optional white space (characters matching the
-nonterminal S) between each pair of child elements. 
-- The declaration matches Mixed and the content consists of character
-data and child elements whose types match names in the content model. 
-- The declaration matches ANY, and the types of any child elements have
-been declared.
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.
A newly allocated string with the substitution done. The caller
-must deallocate it !
A newly allocated string with the substitution done. The caller
-must deallocate it !
A PEReference may have been detected in the current input stream
 the handling is done accordingly to 
-http://www.w3.org/TR/REC-xmlentproc
 i.e. 
-- Included in literal in entity values
-- Included as Parameter Entity reference within DTDs
TODO: Remove, now deprecated ... the test is done directly in the
-content parsing
+      content parsing
 routines.
[67] Reference ::= EntityRef | CharRef
[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-xmlentproc
Checks that the value conforms to the LanguageID production:
NOTE: this is somewhat deprecated, those productions were removed from
-the XML Second edition.
[33] LanguageID ::= Langcode ('-' Subcode)*
 [34] Langcode ::= ISO639Code |  IanaCode |  UserCode
@@ -10822,7 +10919,9 @@ the XML Second edition.
relaxng
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>
relaxng
Name
relaxng -- 
Synopsis

+
+struct      xmlRelaxNG;
+typedef     xmlRelaxNGPtr;
+void        (*xmlRelaxNGValidityErrorFunc)  (void *ctx,
+                                             const char *msg,
+                                             ...);
+void        (*xmlRelaxNGValidityWarningFunc)
+                                            (void *ctx,
+                                             const char *msg,
+                                             ...);
+struct      xmlRelaxNGParserCtxt;
+typedef     xmlRelaxNGParserCtxtPtr;
+struct      xmlRelaxNGValidCtxt;
+typedef     xmlRelaxNGValidCtxtPtr;
+enum        xmlRelaxNGValidErr;
+xmlRelaxNGParserCtxtPtr xmlRelaxNGNewParserCtxt
+                                            (const char *URL);
+xmlRelaxNGParserCtxtPtr xmlRelaxNGNewMemParserCtxt
+                                            (const char *buffer,
+                                             int size);
+void        xmlRelaxNGFreeParserCtxt        (xmlRelaxNGParserCtxtPtr ctxt);
+void        xmlRelaxNGSetParserErrors       (xmlRelaxNGParserCtxtPtr ctxt,
+                                             xmlRelaxNGValidityErrorFunc err,
+                                             xmlRelaxNGValidityWarningFunc warn,
+                                             void *ctx);
+xmlRelaxNGPtr xmlRelaxNGParse               (xmlRelaxNGParserCtxtPtr ctxt);
+void        xmlRelaxNGFree                  (xmlRelaxNGPtr schema);
+void        xmlRelaxNGDump                  (FILE *output,
+                                             xmlRelaxNGPtr schema);
+void        xmlRelaxNGDumpTree              (FILE *output,
+                                             xmlRelaxNGPtr schema);
+void        xmlRelaxNGSetValidErrors        (xmlRelaxNGValidCtxtPtr ctxt,
+                                             xmlRelaxNGValidityErrorFunc err,
+                                             xmlRelaxNGValidityWarningFunc warn,
+                                             void *ctx);
+xmlRelaxNGValidCtxtPtr xmlRelaxNGNewValidCtxt
+                                            (xmlRelaxNGPtr schema);
+void        xmlRelaxNGFreeValidCtxt         (xmlRelaxNGValidCtxtPtr ctxt);
+int         xmlRelaxNGValidateDoc           (xmlRelaxNGValidCtxtPtr ctxt,
+                                             xmlDocPtr instance);
+int         xmlRelaxNGValidateStream        (xmlRelaxNGValidCtxtPtr ctxt,
+                                             xmlParserInputBufferPtr input,
+                                             xmlCharEncoding enc,
+                                             xmlSAXHandlerPtr sax,
+                                             void *user_data);
+void        xmlRelaxNGCleanupTypes          (void);
Description
Details
struct xmlRelaxNG
struct xmlRelaxNG;
xmlRelaxNGPtr
typedef xmlRelaxNG *xmlRelaxNGPtr;
xmlRelaxNGValidityErrorFunc ()
void        (*xmlRelaxNGValidityErrorFunc)  (void *ctx,
+                                             const char *msg,
+                                             ...);
ctx : 
msg : 
... : 
xmlRelaxNGValidityWarningFunc ()
void        (*xmlRelaxNGValidityWarningFunc)
+                                            (void *ctx,
+                                             const char *msg,
+                                             ...);
ctx : 
msg : 
... : 
struct xmlRelaxNGParserCtxt
struct xmlRelaxNGParserCtxt;
xmlRelaxNGParserCtxtPtr
typedef xmlRelaxNGParserCtxt *xmlRelaxNGParserCtxtPtr;
struct xmlRelaxNGValidCtxt
struct xmlRelaxNGValidCtxt;
A RelaxNGs validation context
xmlRelaxNGValidCtxtPtr
typedef xmlRelaxNGValidCtxt *xmlRelaxNGValidCtxtPtr;
enum xmlRelaxNGValidErr
typedef enum {
+    XML_RELAXNG_OK = 0,
+    XML_RELAXNG_ERR_MEMORY,
+    XML_RELAXNG_ERR_TYPE,
+    XML_RELAXNG_ERR_TYPEVAL,
+    XML_RELAXNG_ERR_DUPID,
+    XML_RELAXNG_ERR_TYPECMP,
+    XML_RELAXNG_ERR_NOSTATE,
+    XML_RELAXNG_ERR_NODEFINE,
+    XML_RELAXNG_ERR_LISTEXTRA,
+    XML_RELAXNG_ERR_LISTEMPTY,
+    XML_RELAXNG_ERR_INTERNODATA,
+    XML_RELAXNG_ERR_INTERSEQ,
+    XML_RELAXNG_ERR_INTEREXTRA,
+    XML_RELAXNG_ERR_ELEMNAME,
+    XML_RELAXNG_ERR_ATTRNAME,
+    XML_RELAXNG_ERR_ELEMNONS,
+    XML_RELAXNG_ERR_ATTRNONS,
+    XML_RELAXNG_ERR_ELEMWRONGNS,
+    XML_RELAXNG_ERR_ATTRWRONGNS,
+    XML_RELAXNG_ERR_ELEMEXTRANS,
+    XML_RELAXNG_ERR_ATTREXTRANS,
+    XML_RELAXNG_ERR_ELEMNOTEMPTY,
+    XML_RELAXNG_ERR_NOELEM,
+    XML_RELAXNG_ERR_NOTELEM,
+    XML_RELAXNG_ERR_ATTRVALID,
+    XML_RELAXNG_ERR_CONTENTVALID,
+    XML_RELAXNG_ERR_EXTRACONTENT,
+    XML_RELAXNG_ERR_INVALIDATTR,
+    XML_RELAXNG_ERR_DATAELEM,
+    XML_RELAXNG_ERR_VALELEM,
+    XML_RELAXNG_ERR_LISTELEM,
+    XML_RELAXNG_ERR_DATATYPE,
+    XML_RELAXNG_ERR_VALUE,
+    XML_RELAXNG_ERR_LIST,
+    XML_RELAXNG_ERR_NOGRAMMAR,
+    XML_RELAXNG_ERR_EXTRADATA,
+    XML_RELAXNG_ERR_LACKDATA,
+    XML_RELAXNG_ERR_INTERNAL
+} xmlRelaxNGValidErr;
xmlRelaxNGNewParserCtxt ()
xmlRelaxNGParserCtxtPtr xmlRelaxNGNewParserCtxt
+                                            (const char *URL);
Create an XML RelaxNGs parse context for that file/resource expected
+to contain an XML RelaxNGs file.
URL :  the location of the schema
Returns :the parser context or NULL in case of error
xmlRelaxNGNewMemParserCtxt ()
xmlRelaxNGParserCtxtPtr xmlRelaxNGNewMemParserCtxt
+                                            (const char *buffer,
+                                             int size);
Create an XML RelaxNGs parse context for that memory buffer expected
+to contain an XML RelaxNGs file.
buffer :  a pointer to a char array containing the schemas
size :  the size of the array
Returns :the parser context or NULL in case of error
xmlRelaxNGFreeParserCtxt ()
void        xmlRelaxNGFreeParserCtxt        (xmlRelaxNGParserCtxtPtr ctxt);
Free the resources associated to the schema parser context
ctxt :  the schema parser context
xmlRelaxNGSetParserErrors ()
void        xmlRelaxNGSetParserErrors       (xmlRelaxNGParserCtxtPtr ctxt,
+                                             xmlRelaxNGValidityErrorFunc err,
+                                             xmlRelaxNGValidityWarningFunc warn,
+                                             void *ctx);
Set the callback functions used to handle errors for a validation context
ctxt :  a Relax-NG validation context
err :  the error callback
warn :  the warning callback
ctx :  contextual data for the callbacks
xmlRelaxNGParse ()
xmlRelaxNGPtr xmlRelaxNGParse               (xmlRelaxNGParserCtxtPtr ctxt);
parse a schema definition resource and build an internal
+XML Shema struture which can be used to validate instances.
+*WARNING* this interface is highly subject to change
ctxt :  a Relax-NG parser context
Returns :the internal XML RelaxNG structure built from the resource or
+        NULL in case of error
xmlRelaxNGFree ()
void        xmlRelaxNGFree                  (xmlRelaxNGPtr schema);
Deallocate a RelaxNG structure.
schema :  a schema structure
xmlRelaxNGDump ()
void        xmlRelaxNGDump                  (FILE *output,
+                                             xmlRelaxNGPtr schema);
Dump a RelaxNG structure back
output :  the file output
schema :  a schema structure
xmlRelaxNGDumpTree ()
void        xmlRelaxNGDumpTree              (FILE *output,
+                                             xmlRelaxNGPtr schema);
Dump the transformed RelaxNG tree.
output :  the file output
schema :  a schema structure
xmlRelaxNGSetValidErrors ()
void        xmlRelaxNGSetValidErrors        (xmlRelaxNGValidCtxtPtr ctxt,
+                                             xmlRelaxNGValidityErrorFunc err,
+                                             xmlRelaxNGValidityWarningFunc warn,
+                                             void *ctx);
Set the error and warning callback informations
ctxt :  a Relax-NG validation context
err :  the error function
warn : the warning function
ctx : the functions context
xmlRelaxNGNewValidCtxt ()
xmlRelaxNGValidCtxtPtr xmlRelaxNGNewValidCtxt
+                                            (xmlRelaxNGPtr schema);
Create an XML RelaxNGs validation context based on the given schema
schema :  a precompiled XML RelaxNGs
Returns :the validation context or NULL in case of error
xmlRelaxNGFreeValidCtxt ()
void        xmlRelaxNGFreeValidCtxt         (xmlRelaxNGValidCtxtPtr ctxt);
Free the resources associated to the schema validation context
ctxt :  the schema validation context
xmlRelaxNGValidateDoc ()
int         xmlRelaxNGValidateDoc           (xmlRelaxNGValidCtxtPtr ctxt,
+                                             xmlDocPtr instance);
Validate a document tree in memory.
ctxt :  a Relax-NG validation context
instance : 
Returns :0 if the document is valid, a positive error code
+    number otherwise and -1 in case of internal or API error.
xmlRelaxNGValidateStream ()
int         xmlRelaxNGValidateStream        (xmlRelaxNGValidCtxtPtr ctxt,
+                                             xmlParserInputBufferPtr input,
+                                             xmlCharEncoding enc,
+                                             xmlSAXHandlerPtr sax,
+                                             void *user_data);
ctxt : 
input : 
enc : 
sax : 
user_data : 
Returns : 
xmlRelaxNGCleanupTypes ()
void        xmlRelaxNGCleanupTypes          (void);
Cleanup the default Schemas type library associated to RelaxNG

\ No newline at end of file
diff --git a/doc/html/libxml-sax.html b/doc/html/libxml-sax.html
index 6c6a9ce5..69c56ef1 100644
--- a/doc/html/libxml-sax.html
+++ b/doc/html/libxml-sax.html
@@ -13,8 +13,8 @@ REL="UP"
 TITLE="Libxml Library Reference"
 HREF="libxml-lib.html">
SAX
SAX
Name
Synopsis
Description
Details
Return the public ID e.g. "-//SGMLSOURCE//DTD DEMO//EN"
Provides the public ID e.g. "-//SGMLSOURCE//DTD DEMO//EN"
Return the system ID, basically URL or filename e.g.
+>Provides the system ID, basically URL or filename e.g.
 http://www.sgmlsource.com/dtds/memo.dtd
Return the line number of the current parsing point.
Provide the line number of the current parsing point.
Return the column number of the current parsing point.
Provide the column number of the current parsing point.
The entity loader, to control the loading of external entities,
 the application can either:
-- override this resolveEntity() callback in the SAX block
-- or better use the xmlSetExternalEntityLoader() function to
-set up it's own entity resolution routine
parserxmlreader
schemasInternals
schemasInternals
Name
Synopsis
Description
Details
the element content type is mixed
the element is nillable
the element is global
the element has a default value
the element has a fixed value
the element is abstract
the element is top level

the element is a reference to a type

xmlSchemaType, xmlSchemaFacet and xmlSchemaElement start of +structures must be kept similar

the shemas requires qualified elements

the shemas requires qualified attributes

threads

threads

Name

Synopsis

Description

Details

xmlNewMutex() is used to allocate a libxml2 token struct for use in -synchronizing access to data.

xmlNewMutex() is used to allocate a libxml2 token struct for use in +synchronizing access to data.

 a new simple mutex pointer or NULL in case of error

xmlRNewMutex() is used to allocate a reentrant mutex for use in +synchronizing access to data. token_r is a re-entrant lock and thus useful +for synchronizing access to data structures that may be manipulated in a +recursive fashion.

 the new reentrant mutex pointer or NULL in case of error

xmlRFreeMutex() is used to reclaim resources associated with a +reentrant mutex.

  the reentrant mutex

tree

tree

Name

Synopsis

xmlRootNode +int xmlValidateNCName (const xmlChar *value, + int space); +int xmlValidateQName (const xmlChar *value, + int space); +int xmlValidateName (const xmlChar *value, + int space); +int xmlValidateNMToken (const xmlChar *value, + int space); void xmlSetBufferAllocationSchemexmlChar *name); xmlChar* xmlGetNoNsProp (xmlNodePtr node, + const xmlChar *name); +xmlAttrPtrxmlChar *name); void xmlBufferWriteXmlCHAR (xmlBufferPtr buf, - const xmlChar *string); -void xmlBufferWriteCHAR (xmlDocPtr cur, int format); -void xmlNodeDump ( cur, const char *encoding); int xmlIsXHTML (const xmlChar *systemID, + const xmlChar *publicID); +int xmlGetDocCompressMode (

Description

Details

The parser context. NOTE This doesn't completely define the parser state, the (current ?) -design of the parser uses recursive function calls since this allow -and easy mapping from the production rules of the specification -to the actual code. The drawback is that the actual function call -also reflect the parser state. However most of the parsing routines -takes as the only argument the parser context pointer, so migrating -to a state based parser for progressive parsing shouldn't be too hard.

xmlValidateNCName ()

int         xmlValidateNCName               (const xmlChar *value,
+                                             int space);

Check that a value conforms to the lexical space of NCName

value : the value to check
space : allow spaces in front and end of the string
Returns :0 if this validates, a positive error code number otherwise + and -1 in case of internal or API error.

xmlValidateQName ()

int         xmlValidateQName                (const xmlChar *value,
+                                             int space);

Check that a value conforms to the lexical space of QName

value : the value to check
space : allow spaces in front and end of the string
Returns :0 if this validates, a positive error code number otherwise + and -1 in case of internal or API error.

xmlValidateName ()

int         xmlValidateName                 (const xmlChar *value,
+                                             int space);

Check that a value conforms to the lexical space of Name

value : the value to check
space : allow spaces in front and end of the string
Returns :0 if this validates, a positive error code number otherwise + and -1 in case of internal or API error.

xmlValidateNMToken ()

int         xmlValidateNMToken              (const xmlChar *value,
+                                             int space);

Check that a value conforms to the lexical space of NMToken

value : the value to check
space : allow spaces in front and end of the string
Returns :0 if this validates, a positive error code number otherwise + and -1 in case of internal or API error.

Set the buffer allocation method. Types are XML_BUFFER_ALLOC_EXACT - use exact sizes, keeps memory usage down XML_BUFFER_ALLOC_DOUBLEIT - double buffer when extra needed, -improves performance

Types are XML_BUFFER_ALLOC_EXACT - use exact sizes, keeps memory usage down XML_BUFFER_ALLOC_DOUBLEIT - double buffer when extra needed, -improves performance

Creation of a Namespace, the old way using PI and without scoping -DEPRECATED !!! + DEPRECATED !!! It now create a namespace on the root element of the document if found.

content is supposed to be a piece of XML CDATA, so it allow entities -references, but XML special chars need to be escaped first by using -xmlEncodeEntitiesReentrant(). Use xmlNewDocRawNode() if you don't -need entities support.

content is supposed to be a piece of XML CDATA, so it allow entities -references, but XML special chars need to be escaped first by using -xmlEncodeEntitiesReentrant(). Use xmlNewDocRawNode() if you don't -need entities support.

content is supposed to be a piece of XML CDATA, so it allow entities -references, but XML special chars need to be escaped first by using -xmlEncodeEntitiesReentrant(). Use xmlNewTextChild() if entities -support is not needed.

the new path or NULL in case of error. The caller must free -the returned string

cur is freed) -If the new node was already inserted in a document it is -first unlinked from its existing context. If the new node is ATTRIBUTE, it is added into properties instead of children. If there is an attribute with equal name, it is first destroyed.

xmlNsPtr found -that need to be freed by the caller or NULL if no -namespace if defined

FIXED or -default declaration values unless DTD use has been turned off.

xmlGetNsProp() or xmlGetNoNsProp() + for namespace aware processing.

the attribute value or NULL if not found. -It's up to the caller to free the memory with xmlFree().

xmlGetNoNsProp ()

xmlChar*    xmlGetNoNsProp                  (xmlNodePtr node,
+                                             const xmlChar *name);

Search and get the value of an attribute associated to a node +This does the entity substitution. +This function looks in DTD attribute declaration for FIXED or +default declaration values unless DTD use has been turned off. +This function is similar to xmlGetProp except it will accept only +an attribute in no namespace.

node : the node
name : the attribute name
Returns :the attribute value or NULL if not found. + It's up to the caller to free the memory with xmlFree().

the attribute or the attribute declaration or NULL if -neither was found.

the attribute or the attribute declaration or NULL -if neither was found.

the attribute value or NULL if not found. -It's up to the caller to free the memory with xmlFree().

Returns the string equivalent to the text contained in the Node list +>Build the string equivalent to the text contained in the Node list made of TEXTs and ENTITY_REFs

Returns the string equivalent to the text contained in the Node list +>Builds the string equivalent to the text contained in the Node list made of TEXTs and ENTITY_REFs, contrary to xmlNodeListGetString

xmlChar * or NULL if no content is available. -It's up to the caller to free the memory with xmlFree().

a pointer to the lang value, or NULL if not found -It's up to the caller to free the memory with xmlFree().

a pointer to the base URL, or NULL if not found -It's up to the caller to free the memory with xmlFree().

xmlBufferWriteXmlCHAR ()

void        xmlBufferWriteXmlCHAR           (xmlBufferPtr buf,
-                                             const xmlChar *string);

For VMS only. -routine which manages and grows an output buffer. This one adds -xmlChars at the end of the buffer.

xmlFree(). -Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1 +Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

xmlFree(). -Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1 +Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

the number of bytes written or -1 in case of failure. the number of bytes written or -1 in case of failure. +Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1 +or xmlKeepBlanksDefault(0) was called

format is set then the document will be indented on output.

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

void        xmlNodeDump                     (int         xmlNodeDump                     (xmlBufferPtr buf,
@@ -17189,14 +17977,21 @@ HREF="libxml-tree.html#XMLNODEPTR"
 >

Dump an XML node, recursive behaviour,children are printed too. -Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1 +Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

is formatting allowed
Returns :the number of bytes written to the buffer or -1 in case of error

the number of bytes written or -1 in case of failure. the number of bytes written or -1 in case of failure. +Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1 +or xmlKeepBlanksDefault(0) was called

Dump an XML node, recursive behaviour, children are printed too. -Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1 +Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

Dump an XML document to a file or an URL.

the number of bytes written or -1 in case of error.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

xmlIsXHTML ()

int         xmlIsXHTML                      (const xmlChar *systemID,
+                                             const xmlChar *publicID);

Try to find if the document correspond to an XHTML DTD

systemID : the system identifier
publicID : the public identifier
Returns :1 if true, 0 if not and -1 in case of error

uri

uri

Name

Synopsis

(xmlURIPtr uri); uri); +xmlChar* xmlCanonicPath (const xmlChar *path);

Description

Details

a new URI string (to be freed by the caller) or NULL in case -of error.

xmlCanonicPath ()

xmlChar*    xmlCanonicPath                  (const xmlChar *path);

Constructs a canonic path from the specified path.

path : the resource locator in a filesystem notation
Returns :a new canonic path, or a duplicate of the path parameter if the +construction fails. The caller is responsible for freeing the memory occupied +by the returned string. If there is insufficient memory available, or the +argument is NULL, the function returns NULL.

validrelaxng

valid

valid

Name

Synopsis

xmlElementPtr elem); elem); +int xmlValidatePushElement (xmlValidCtxtPtr ctxt, + xmlDocPtr doc, + xmlNodePtr elem, + const xmlChar *qname); +int xmlValidatePushCData (xmlValidCtxtPtr ctxt, + const xmlChar *data, + int len); +int xmlValidatePopElement (xmlValidCtxtPtr ctxt, + xmlDocPtr doc, + xmlNodePtr elem, + const xmlChar *qname);

Description

Details

NULL if not a QName, otherwise the local part, and prefix -is updated to get the Prefix if any.

An element content pointer. 

the xmlEnumerationPtr just created or NULL in case -of error.

the xmlEnumerationPtr just created or NULL in case -of error.

Try to validate a the root element basically it does the following check as described by the XML-1.0 recommendation: -- [ VC: Root Element Type ] + - [ VC: Root Element Type ] it doesn't try to recurse or apply other check to the element

Try to validate a single element definition basically it does the following checks as described by the XML-1.0 recommendation: -- [ VC: One ID per Element Type ] -- [ VC: No Duplicate Types ] -- [ VC: Unique Element Type Declaration ]

a new normalized string if normalization is needed, NULL otherwise -the caller must free the returned value.

) character.

Also check VC: Standalone Document Declaration in P32, and update -ctxt->valid accordingly

a new normalized string if normalization is needed, NULL otherwise -the caller must free the returned value.

Try to validate a single attribute definition basically it does the following checks as described by the XML-1.0 recommendation: -- [ VC: Attribute Default Legal ] -- [ VC: Enumeration ] -- [ VC: ID Attribute Default ]

The ID/IDREF uniqueness and matching are done separately

Try to validate a single notation definition basically it does the following checks as described by the XML-1.0 recommendation: -- it seems that no validity constraint exists on notation declarations + - it seems that no validity constraint exists on notation declarations But this function get called anyway ...

basically it does the following checks described by the XML Rec - check that ENTITY and ENTITIES type attributes default or -possible values matches one of the defined entities. + possible values matches one of the defined entities. - check that NOTATION type attributes default or -possible values matches one of the defined notations.

Try to validate a single element and it's attributes, basically it does the following checks as described by the XML-1.0 recommendation: -- [ VC: Element Valid ] -- [ VC: Required Attribute ] + - [ VC: Element Valid ] + - [ VC: Required Attribute ] Then call xmlValidateOneAttribute

Try to validate a single attribute for an element basically it does the following checks as described by the XML-1.0 recommendation: -- [ VC: Attribute Value Type ] -- [ VC: Fixed Attribute Default ] -- [ VC: Entity Name ] -- [ VC: Name Token ] -- [ VC: ID ] -- [ VC: IDREF ] -- [ VC: Entity Name ] -- [ VC: Notation Attributes ]

The ID/IDREF uniqueness and matching are done separately

Try to validate a single namespace declaration for an element basically it does the following checks as described by the XML-1.0 recommendation: -- [ VC: Attribute Value Type ] -- [ VC: Fixed Attribute Default ] -- [ VC: Entity Name ] -- [ VC: Name Token ] -- [ VC: ID ] -- [ VC: IDREF ] -- [ VC: Entity Name ] -- [ VC: Notation Attributes ]

The ID/IDREF uniqueness and matching are done separately

  the namespace prefix

xinclude

xinclude

Name

Synopsis

basically it does the following checks described by the XML Rec

Check all the IDREF/IDREFS attributes definition for validity

next in the following ways: -to insert before 'node': xmlValidGetValidElements(node->prev, node, ... -to insert next 'node': xmlValidGetValidElements(node, node->next, ... -to replace 'node': xmlValidGetValidElements(node->prev, node->next, ... -to prepend a child to 'node': xmlValidGetValidElements(NULL, node->childs, -to append a child to 'node': xmlValidGetValidElements(node->last, NULL, ...

pointers to the element names are inserted at the beginning of the array and do not need to be freed.

the number of element in the list, or -1 in case of error. If -the function returns the value max the caller is invited to grow the -receiving array and retry.

xmlValidatePushElement ()

int         xmlValidatePushElement          (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem,
+                                             const xmlChar *qname);

Push a new element start on the validation stack.

ctxt : the validation context
doc : a document instance
elem : an element instance
qname : the qualified name as appearing in the serialization
Returns :1 if no validation problem was found or 0 otherwise

xmlValidatePushCData ()

int         xmlValidatePushCData            (xmlValidCtxtPtr ctxt,
+                                             const xmlChar *data,
+                                             int len);

check the CData parsed for validation in the current stack

ctxt : the validation context
data : some character data read
len : the lenght of the data
Returns :1 if no validation problem was found or 0 otherwise

xmlValidatePopElement ()

int         xmlValidatePopElement           (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem,
+                                             const xmlChar *qname);

Pop the element end from the validation stack.

ctxt : the validation context
doc : a document instance
elem : an element instance
qname : the qualified name as appearing in the serialization
Returns :1 if no validation problem was found or 0 otherwise

urirelaxng

Description

Details

0 if no substitution were done, -1 if some processing failed -or the number of substitutions done.

xmlautomata

xmlautomata

Name

Synopsis

Description

Details

Initial state lookup

to is NULL, this create first a new target state in the automata -and then adds a an epsilon transition from the from state to the -target state

state to the target state +activated by the value of token

  the input string associated to that transition data passed to the callback function if the transition is activated
 

  the maximum successive occurences of token data associated to the transition
 

  the maximum successive occurences of token data associated to the transition
 

  allow to transition if not all all transitions have been activated

If to is NULL, this create first a new target state in the automata +and then adds a an epsilon transition from the from state to the +target state

  an automata the starting point of the transition the target point of the transition or NULLthe target state or NULL in case of error
 
 
 

xmlerror

xmlerror

Name

Synopsis

Description

Details

Set or reset (if NULL) the default handler for generic errors

Set or reset (if NULL) the default handler for generic errors +to the builtin error function.

xmlIO

xmlIO

Name

Synopsis

xmlParserInputBufferPtrxmlParserInputBufferCreateFname - (const char *URI, - xmlCharEncoding enc); -xmlParserInputBufferPtrxmlParserInputBufferCreateFilename @@ -569,7 +561,7 @@ HREF="libxml-xmlio.html#XMLIOFTPCLOSE" >

Description

Details

xmlParserInputBufferCreateFname ()

xmlParserInputBufferPtr xmlParserInputBufferCreateFname
-                                            (const char *URI,
-                                             xmlCharEncoding enc);

VMS version of xmlParserInputBufferCreateFilename()

the number of chars read and stored in the buffer, or -1 -in case of error.

TODO: one should be able to remove one extra copy by copying directly -onto in->buffer or in->raw

the number of chars read and stored in the buffer, or -1 -in case of error.

the number of chars read and stored in the buffer, or -1 -in case of error.

the number of chars immediately written, or -1 -in case of error.

the number of chars immediately written, or -1 -in case of error.

Normalize a Windows path to make an URL from it

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

a windows path like "C:/foo/bar"  
a new URI which must be freed by the caller or NULL -in case of error

input from FILE *, supports compressed input -if Wrapper around xmlFileOpen_real that try it with an unescaped +version of filename is " " then the standard input is used

, if this fails fallback to filename

 0 or -1 in case of error

 0

 0

xmlmemory

xmlmemory

Name

Synopsis

xmlMemoryDump (void); +void* xmlMemMalloc (size_t size); +void* xmlMemRealloc (void *ptr, + size_t size); +void xmlMemFree (void *ptr); +char* xmlMemoryStrdup (const char *str); #define xmlMalloc

Description

Details

Return the memory access functions set currently in use

Provides the memory access functions set currently in use

the place to save the free() function in use the place to save the malloc() function in use the place to save the realloc() function in use the place to save the strdup() function in use

returns the amount of memory currently allocated

Provides the amount of memory currently allocated

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

xmlMemMalloc ()

void*       xmlMemMalloc                    (size_t size);

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

size : an int specifying the size in byte to allocate.

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.

xmlMemFree ()

void        xmlMemFree                      (void *ptr);

a free() equivalent, with error checking.

ptr : the memory block pointer

xmlMemoryStrdup ()

char*       xmlMemoryStrdup                 (const char *str);

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.

xmlreader
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

xmlreader

Name

xmlreader -- 

Synopsis


+
+enum        xmlParserProperties;
+enum        xmlParserSeverities;
+struct      xmlTextReader;
+typedef     xmlTextReaderPtr;
+xmlTextReaderPtr xmlNewTextReader           (xmlParserInputBufferPtr input,
+                                             const char *URI);
+xmlTextReaderPtr xmlNewTextReaderFilename   (const char *URI);
+void        xmlFreeTextReader               (xmlTextReaderPtr reader);
+int         xmlTextReaderRead               (xmlTextReaderPtr reader);
+xmlChar*    xmlTextReaderReadInnerXml       (xmlTextReaderPtr reader);
+xmlChar*    xmlTextReaderReadOuterXml       (xmlTextReaderPtr reader);
+xmlChar*    xmlTextReaderReadString         (xmlTextReaderPtr reader);
+int         xmlTextReaderReadAttributeValue (xmlTextReaderPtr reader);
+int         xmlTextReaderAttributeCount     (xmlTextReaderPtr reader);
+xmlChar*    xmlTextReaderBaseUri            (xmlTextReaderPtr reader);
+int         xmlTextReaderDepth              (xmlTextReaderPtr reader);
+int         xmlTextReaderHasAttributes      (xmlTextReaderPtr reader);
+int         xmlTextReaderHasValue           (xmlTextReaderPtr reader);
+int         xmlTextReaderIsDefault          (xmlTextReaderPtr reader);
+int         xmlTextReaderIsEmptyElement     (xmlTextReaderPtr reader);
+xmlChar*    xmlTextReaderLocalName          (xmlTextReaderPtr reader);
+xmlChar*    xmlTextReaderName               (xmlTextReaderPtr reader);
+xmlChar*    xmlTextReaderNamespaceUri       (xmlTextReaderPtr reader);
+int         xmlTextReaderNodeType           (xmlTextReaderPtr reader);
+xmlChar*    xmlTextReaderPrefix             (xmlTextReaderPtr reader);
+int         xmlTextReaderQuoteChar          (xmlTextReaderPtr reader);
+xmlChar*    xmlTextReaderValue              (xmlTextReaderPtr reader);
+xmlChar*    xmlTextReaderXmlLang            (xmlTextReaderPtr reader);
+int         xmlTextReaderReadState          (xmlTextReaderPtr reader);
+int         xmlTextReaderClose              (xmlTextReaderPtr reader);
+xmlChar*    xmlTextReaderGetAttributeNo     (xmlTextReaderPtr reader,
+                                             int no);
+xmlChar*    xmlTextReaderGetAttribute       (xmlTextReaderPtr reader,
+                                             const xmlChar *name);
+xmlChar*    xmlTextReaderGetAttributeNs     (xmlTextReaderPtr reader,
+                                             const xmlChar *localName,
+                                             const xmlChar *namespaceURI);
+xmlParserInputBufferPtr xmlTextReaderGetRemainder
+                                            (xmlTextReaderPtr reader);
+xmlChar*    xmlTextReaderLookupNamespace    (xmlTextReaderPtr reader,
+                                             const xmlChar *prefix);
+int         xmlTextReaderMoveToAttributeNo  (xmlTextReaderPtr reader,
+                                             int no);
+int         xmlTextReaderMoveToAttribute    (xmlTextReaderPtr reader,
+                                             const xmlChar *name);
+int         xmlTextReaderMoveToAttributeNs  (xmlTextReaderPtr reader,
+                                             const xmlChar *localName,
+                                             const xmlChar *namespaceURI);
+int         xmlTextReaderMoveToFirstAttribute
+                                            (xmlTextReaderPtr reader);
+int         xmlTextReaderMoveToNextAttribute
+                                            (xmlTextReaderPtr reader);
+int         xmlTextReaderMoveToElement      (xmlTextReaderPtr reader);
+int         xmlTextReaderNormalization      (xmlTextReaderPtr reader);
+int         xmlTextReaderSetParserProp      (xmlTextReaderPtr reader,
+                                             int prop,
+                                             int value);
+int         xmlTextReaderGetParserProp      (xmlTextReaderPtr reader,
+                                             int prop);
+xmlNodePtr  xmlTextReaderCurrentNode        (xmlTextReaderPtr reader);
+xmlDocPtr   xmlTextReaderCurrentDoc         (xmlTextReaderPtr reader);
+typedef     xmlTextReaderLocatorPtr;
+void        (*xmlTextReaderErrorFunc)       (void *arg,
+                                             const char *msg,
+                                             xmlParserSeverities severity,
+                                             xmlTextReaderLocatorPtr locator);
+int         xmlTextReaderLocatorLineNumber  (xmlTextReaderLocatorPtr locator);
+xmlChar*    xmlTextReaderLocatorBaseURI     (xmlTextReaderLocatorPtr locator);
+void        xmlTextReaderSetErrorHandler    (xmlTextReaderPtr reader,
+                                             xmlTextReaderErrorFunc f,
+                                             void *arg);
+void        xmlTextReaderGetErrorHandler    (xmlTextReaderPtr reader,
+                                             xmlTextReaderErrorFunc *f,
+                                             void **arg);

Description

Details

enum xmlParserProperties

typedef enum {
+    XML_PARSER_LOADDTD = 1,
+    XML_PARSER_DEFAULTATTRS = 2,
+    XML_PARSER_VALIDATE = 3,
+    XML_PARSER_SUBST_ENTITIES = 4
+} xmlParserProperties;

enum xmlParserSeverities

typedef enum {
+    XML_PARSER_SEVERITY_VALIDITY_WARNING = 1,
+    XML_PARSER_SEVERITY_VALIDITY_ERROR = 2,
+    XML_PARSER_SEVERITY_WARNING = 3,
+    XML_PARSER_SEVERITY_ERROR = 4
+} xmlParserSeverities;

struct xmlTextReader

struct xmlTextReader;

xmlTextReaderPtr

typedef xmlTextReader *xmlTextReaderPtr;

xmlNewTextReader ()

xmlTextReaderPtr xmlNewTextReader           (xmlParserInputBufferPtr input,
+                                             const char *URI);

Create an xmlTextReader structure fed with input

input : the xmlParserInputBufferPtr used to read data
URI : the URI information for the source if available
Returns :the new xmlTextReaderPtr or NULL in case of error

xmlNewTextReaderFilename ()

xmlTextReaderPtr xmlNewTextReaderFilename   (const char *URI);

Create an xmlTextReader structure fed with the resource at URI

URI : the URI of the resource to process
Returns :the new xmlTextReaderPtr or NULL in case of error

xmlFreeTextReader ()

void        xmlFreeTextReader               (xmlTextReaderPtr reader);

Deallocate all the resources associated to the reader

reader : the xmlTextReaderPtr

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

xmlTextReaderReadInnerXml ()

xmlChar*    xmlTextReaderReadInnerXml       (xmlTextReaderPtr reader);

Reads the contents of the current node, including child nodes and markup.

reader : the xmlTextReaderPtr used
Returns :a string containing the XML content, or NULL if the current node + is neither an element nor attribute, or has no child nodes. The + string must be deallocated by the caller.

xmlTextReaderReadOuterXml ()

xmlChar*    xmlTextReaderReadOuterXml       (xmlTextReaderPtr reader);

Reads the contents of the current node, including child nodes and markup.

reader : the xmlTextReaderPtr used
Returns :a string containing the XML content, or NULL if the current node + is neither an element nor attribute, or has no child nodes. The + string must be deallocated by the caller.

xmlTextReaderReadString ()

xmlChar*    xmlTextReaderReadString         (xmlTextReaderPtr reader);

Reads the contents of an element or a text node as a string.

reader : the xmlTextReaderPtr used
Returns :a string containing the contents of the Element or Text node, + or NULL if the reader is positioned on any other type of node. + The string must be deallocated by the caller.

xmlTextReaderReadAttributeValue ()

int         xmlTextReaderReadAttributeValue (xmlTextReaderPtr reader);

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

reader : the xmlTextReaderPtr used
Returns :1 in case of success, 0 if the reader was not positionned on an + ttribute node or all the attribute values have been read, or -1 + in case of error.

xmlTextReaderAttributeCount ()

int         xmlTextReaderAttributeCount     (xmlTextReaderPtr reader);

Provides the number of attributes of the current node

reader : the xmlTextReaderPtr used
Returns :0 i no attributes, -1 in case of error or the attribute count

xmlTextReaderBaseUri ()

xmlChar*    xmlTextReaderBaseUri            (xmlTextReaderPtr reader);

The base URI of the node.

reader : the xmlTextReaderPtr used
Returns :the base URI or NULL if not available

xmlTextReaderDepth ()

int         xmlTextReaderDepth              (xmlTextReaderPtr reader);

The depth of the node in the tree.

reader : the xmlTextReaderPtr used
Returns :the depth or -1 in case of error

xmlTextReaderHasAttributes ()

int         xmlTextReaderHasAttributes      (xmlTextReaderPtr reader);

Whether the node has attributes.

reader : the xmlTextReaderPtr used
Returns :1 if true, 0 if false, and -1 in case or error

xmlTextReaderHasValue ()

int         xmlTextReaderHasValue           (xmlTextReaderPtr reader);

Whether the node can have a text value.

reader : the xmlTextReaderPtr used
Returns :1 if true, 0 if false, and -1 in case or error

xmlTextReaderIsDefault ()

int         xmlTextReaderIsDefault          (xmlTextReaderPtr reader);

Whether an Attribute node was generated from the default value +defined in the DTD or schema.

reader : the xmlTextReaderPtr used
Returns :0 if not defaulted, 1 if defaulted, and -1 in case of error

xmlTextReaderIsEmptyElement ()

int         xmlTextReaderIsEmptyElement     (xmlTextReaderPtr reader);

Check if the current node is empty

reader : the xmlTextReaderPtr used
Returns :1 if empty, 0 if not and -1 in case of error

xmlTextReaderLocalName ()

xmlChar*    xmlTextReaderLocalName          (xmlTextReaderPtr reader);

The local name of the node.

reader : the xmlTextReaderPtr used
Returns :the local name or NULL if not available

xmlTextReaderName ()

xmlChar*    xmlTextReaderName               (xmlTextReaderPtr reader);

The qualified name of the node, equal to Prefix :LocalName.

reader : the xmlTextReaderPtr used
Returns :the local name or NULL if not available

xmlTextReaderNamespaceUri ()

xmlChar*    xmlTextReaderNamespaceUri       (xmlTextReaderPtr reader);

The URI defining the namespace associated with the node.

reader : the xmlTextReaderPtr used
Returns :the namespace URI or NULL if not available

xmlTextReaderNodeType ()

int         xmlTextReaderNodeType           (xmlTextReaderPtr reader);

Get the node type of the current node +Reference: +http://dotgnu.org/pnetlib-doc/System/Xml/XmlNodeType.html

reader : the xmlTextReaderPtr used
Returns :the xmlNodeType of the current node or -1 in case of error

xmlTextReaderPrefix ()

xmlChar*    xmlTextReaderPrefix             (xmlTextReaderPtr reader);

A shorthand reference to the namespace associated with the node.

reader : the xmlTextReaderPtr used
Returns :the prefix or NULL if not available

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

xmlTextReaderValue ()

xmlChar*    xmlTextReaderValue              (xmlTextReaderPtr reader);

Provides the text value of the node if present

reader : the xmlTextReaderPtr used
Returns :the string or NULL if not available. The retsult must be deallocated + with xmlFree()

xmlTextReaderXmlLang ()

xmlChar*    xmlTextReaderXmlLang            (xmlTextReaderPtr reader);

The xml:lang scope within which the node resides.

reader : the xmlTextReaderPtr used
Returns :the xml:lang value or NULL if none exists.

xmlTextReaderReadState ()

int         xmlTextReaderReadState          (xmlTextReaderPtr reader);

Gets the read state of the reader.

reader : the xmlTextReaderPtr used
Returns :the state value, or -1 in case of error

xmlTextReaderClose ()

int         xmlTextReaderClose              (xmlTextReaderPtr reader);

This method releases any resources allocated by the current instance +changes the state to Closed and close any underlying input.

reader : the xmlTextReaderPtr used
Returns :0 or -1 in case of error

xmlTextReaderGetAttributeNo ()

xmlChar*    xmlTextReaderGetAttributeNo     (xmlTextReaderPtr reader,
+                                             int no);

Provides the value of the attribute with the specified index relative +to the containing element.

reader : the xmlTextReaderPtr used
no : the zero-based index of the attribute relative to the containing element
Returns :a string containing the value of the specified attribute, or NULL + in case of error. The string must be deallocated by the caller.

xmlTextReaderGetAttribute ()

xmlChar*    xmlTextReaderGetAttribute       (xmlTextReaderPtr reader,
+                                             const xmlChar *name);

Provides the value of the attribute with the specified qualified name.

reader : the xmlTextReaderPtr used
name : the qualified name of the attribute.
Returns :a string containing the value of the specified attribute, or NULL + in case of error. The string must be deallocated by the caller.

xmlTextReaderGetAttributeNs ()

xmlChar*    xmlTextReaderGetAttributeNs     (xmlTextReaderPtr reader,
+                                             const xmlChar *localName,
+                                             const xmlChar *namespaceURI);

Provides the value of the specified attribute

reader : the xmlTextReaderPtr used
localName : the local name of the attribute.
namespaceURI : the namespace URI of the attribute.
Returns :a string containing the value of the specified attribute, or NULL + in case of error. The string must be deallocated by the caller.

xmlTextReaderGetRemainder ()

xmlParserInputBufferPtr xmlTextReaderGetRemainder
+                                            (xmlTextReaderPtr reader);

Method to get the remainder of the buffered XML. this method stops the +parser, set its state to End Of File and return the input stream with +what is left that the parser did not use.

reader : the xmlTextReaderPtr used
Returns :the xmlParserInputBufferPtr attached to the XML or NULL + in case of error.

xmlTextReaderLookupNamespace ()

xmlChar*    xmlTextReaderLookupNamespace    (xmlTextReaderPtr reader,
+                                             const xmlChar *prefix);

Resolves a namespace prefix in the scope of the current element.

reader : the xmlTextReaderPtr used
prefix : the prefix whose namespace URI is to be resolved. To return + the default namespace, specify NULL
Returns :a string containing the namespace URI to which the prefix maps + or NULL in case of error. The string must be deallocated by the caller.

xmlTextReaderMoveToAttributeNo ()

int         xmlTextReaderMoveToAttributeNo  (xmlTextReaderPtr reader,
+                                             int no);

Moves the position of the current instance to the attribute with +the specified index relative to the containing element.

reader : the xmlTextReaderPtr used
no : the zero-based index of the attribute relative to the containing + element.
Returns :1 in case of success, -1 in case of error, 0 if not found

xmlTextReaderMoveToAttribute ()

int         xmlTextReaderMoveToAttribute    (xmlTextReaderPtr reader,
+                                             const xmlChar *name);

Moves the position of the current instance to the attribute with +the specified qualified name.

reader : the xmlTextReaderPtr used
name : the qualified name of the attribute.
Returns :1 in case of success, -1 in case of error, 0 if not found

xmlTextReaderMoveToAttributeNs ()

int         xmlTextReaderMoveToAttributeNs  (xmlTextReaderPtr reader,
+                                             const xmlChar *localName,
+                                             const xmlChar *namespaceURI);

Moves the position of the current instance to the attribute with the +specified local name and namespace URI.

reader : the xmlTextReaderPtr used
localName : the local name of the attribute.
namespaceURI : the namespace URI of the attribute.
Returns :1 in case of success, -1 in case of error, 0 if not found

xmlTextReaderMoveToFirstAttribute ()

int         xmlTextReaderMoveToFirstAttribute
+                                            (xmlTextReaderPtr reader);

Moves the position of the current instance to the first attribute +associated with the current node.

reader : the xmlTextReaderPtr used
Returns :1 in case of success, -1 in case of error, 0 if not found

xmlTextReaderMoveToNextAttribute ()

int         xmlTextReaderMoveToNextAttribute
+                                            (xmlTextReaderPtr reader);

Moves the position of the current instance to the next attribute +associated with the current node.

reader : the xmlTextReaderPtr used
Returns :1 in case of success, -1 in case of error, 0 if not found

xmlTextReaderMoveToElement ()

int         xmlTextReaderMoveToElement      (xmlTextReaderPtr reader);

Moves the position of the current instance to the node that +contains the current Attribute node.

reader : the xmlTextReaderPtr used
Returns :1 in case of success, -1 in case of error, 0 if not moved

xmlTextReaderNormalization ()

int         xmlTextReaderNormalization      (xmlTextReaderPtr reader);

The value indicating whether to normalize white space and attribute values. +Since attribute value and end of line normalizations are a MUST in the XML +specification only the value true is accepted. The broken bahaviour of +accepting out of range character entities like &0; is of course not +supported either.

reader : the xmlTextReaderPtr used
Returns :1 or -1 in case of error.

xmlTextReaderSetParserProp ()

int         xmlTextReaderSetParserProp      (xmlTextReaderPtr reader,
+                                             int prop,
+                                             int value);

Change the parser processing behaviour by changing some of its internal +properties. Note that some properties can only be changed before any +read has been done.

reader : the xmlTextReaderPtr used
prop : the xmlParserProperties to set
value : usually 0 or 1 to (de)activate it
Returns :0 if the call was successful, or -1 in case of error

xmlTextReaderGetParserProp ()

int         xmlTextReaderGetParserProp      (xmlTextReaderPtr reader,
+                                             int prop);

Read the parser internal property.

reader : the xmlTextReaderPtr used
prop : the xmlParserProperties to get
Returns :the value, usually 0 or 1, or -1 in case of error.

xmlTextReaderCurrentNode ()

xmlNodePtr  xmlTextReaderCurrentNode        (xmlTextReaderPtr reader);

Hacking interface allowing to get the xmlNodePtr correponding to the +current node being accessed by the xmlTextReader. This is dangerous +because the underlying node may be destroyed on the next Reads.

reader : the xmlTextReaderPtr used
Returns :the xmlNodePtr or NULL in case of error.

xmlTextReaderCurrentDoc ()

xmlDocPtr   xmlTextReaderCurrentDoc         (xmlTextReaderPtr reader);

Hacking interface allowing to get the xmlDocPtr correponding to the +current document being accessed by the xmlTextReader. This is dangerous +because the associated node may be destroyed on the next Reads.

reader : the xmlTextReaderPtr used
Returns :the xmlDocPtr or NULL in case of error.

xmlTextReaderLocatorPtr

typedef void *  xmlTextReaderLocatorPtr;

xmlTextReaderErrorFunc ()

void        (*xmlTextReaderErrorFunc)       (void *arg,
+                                             const char *msg,
+                                             xmlParserSeverities severity,
+                                             xmlTextReaderLocatorPtr locator);

arg : 
msg : 
severity : 
locator : 

xmlTextReaderLocatorLineNumber ()

int         xmlTextReaderLocatorLineNumber  (xmlTextReaderLocatorPtr locator);

Obtain the line number for the given locator.

locator : the xmlTextReaderLocatorPtr used
Returns :the line number or -1 in case of error.

xmlTextReaderLocatorBaseURI ()

xmlChar*    xmlTextReaderLocatorBaseURI     (xmlTextReaderLocatorPtr locator);

Obtain the base URI for the given locator.

locator : the xmlTextReaderLocatorPtr used
Returns :the base URI or NULL in case of error.

xmlTextReaderSetErrorHandler ()

void        xmlTextReaderSetErrorHandler    (xmlTextReaderPtr reader,
+                                             xmlTextReaderErrorFunc f,
+                                             void *arg);

Register a callback function that will be called on error and warnings.

If f is NULL, the default error and warning handlers are restored.

reader : the xmlTextReaderPtr used
f : the callback function to call on error and warnings
arg : a user argument to pass to the callback function

xmlTextReaderGetErrorHandler ()

void        xmlTextReaderGetErrorHandler    (xmlTextReaderPtr reader,
+                                             xmlTextReaderErrorFunc *f,
+                                             void **arg);

Retrieve the error callback function and user argument.

reader : the xmlTextReaderPtr used
f : the callback function or NULL is no callback has been registered
arg : a user argument

\ No newline at end of file diff --git a/doc/html/libxml-xmlregexp.html b/doc/html/libxml-xmlregexp.html index bba5a606..736aca75 100644 --- a/doc/html/libxml-xmlregexp.html +++ b/doc/html/libxml-xmlregexp.html @@ -117,11 +117,13 @@ SIZE="3" >

xmlregexp

xmlregexp

Name

Synopsis

Description

Details

Build a context used for progressive evaluation of a regexp.

  a precompiled regular expression a callback function used for handling progresses in the + automata matching phase the context data associated to the callback in this contextthe new context
 
 
 

a regexp execution context a regexp execution context or NULL to indicate the end
1 if the regexp reached a final state, 0 if non-final, and -a negative value in case of error.

xmlschemas

xmlschemas

Name

Synopsis

xmlSchemaNewParserCtxt (const char *URL); +xmlSchemaParserCtxtPtrxmlSchemaNewMemParserCtxt + (const char *buffer, + int size); void xmlSchemaFreeParserCtxt

Description

Details

xmlSchemaNewMemParserCtxt ()

xmlSchemaParserCtxtPtr xmlSchemaNewMemParserCtxt
+                                            (const char *buffer,
+                                             int size);

Create an XML Schemas parse context for that memory buffer expected +to contain an XML Schemas file.

buffer : a pointer to a char array containing the schemas
size : the size of the array
Returns :the parser context or NULL in case of error

Set the callback functions used to handle errors for a validation context

  a schema validation context the error callback the warning callback contextual data for the callbacks
 
 
 

Load, XML parse a schema definition resource and build an internal +>parse a schema definition resource and build an internal XML Shema struture which can be used to validate instances. *WARNING* this interface is highly subject to change

the internal XML Schema structure built from the resource or -NULL in case of error

  the functions context

0 if the document is schemas valid, a positive error code -number otherwise and -1 in case of internal or API error.

0 if the document is schemas valid, a positive error code -number otherwise and -1 in case of internal or API error.

xmlschemastypes

xmlschemastypes

Name

Synopsis

xmlSchemaValPtr *val); int xmlSchemaValPredefTypeNode (xmlSchemaTypePtr type, + const xmlChar *value, + xmlSchemaValPtr *val, + xmlNodePtr node); +int xmlSchemaValidateFacet ( (xmlSchemaValPtr val); val); +xmlSchemaFacetPtrxmlSchemaNewFacet (void); +int xmlSchemaCheckFacet (xmlSchemaFacetPtr facet, + xmlSchemaTypePtr typeDecl, + xmlSchemaParserCtxtPtr ctxt, + const xmlChar *name); +void xmlSchemaFreeFacet (xmlSchemaFacetPtr facet);

Description

Details

0 if this validates, a positive error code number otherwise -and -1 in case of internal or API error.

xmlSchemaValPredefTypeNode ()

int         xmlSchemaValPredefTypeNode      (xmlSchemaTypePtr type,
+                                             const xmlChar *value,
+                                             xmlSchemaValPtr *val,
+                                             xmlNodePtr node);

Check that a value conforms to the lexical space of the predefined type. +if true a value is computed and returned in val.

type : the predefined type
value : the value to check
val : the return computed value
node : the node containing the value
Returns :0 if this validates, a positive error code number otherwise + and -1 in case of internal or API error.

  the base type
0 if the element is schemas valid, a positive error code -number otherwise and -1 in case of internal or API error.

xmlSchemaNewFacet ()

xmlSchemaFacetPtr xmlSchemaNewFacet         (void);

Allocate a new Facet structure.

Returns :the newly allocated structure or NULL in case or error

xmlSchemaCheckFacet ()

int         xmlSchemaCheckFacet             (xmlSchemaFacetPtr facet,
+                                             xmlSchemaTypePtr typeDecl,
+                                             xmlSchemaParserCtxtPtr ctxt,
+                                             const xmlChar *name);

Checks the default values types, especially for facets

facet : the facet
typeDecl : the schema type definition
ctxt : the schema parser context or NULL
name : name of the type
Returns :0 if okay or -1 in cae of error

xmlSchemaFreeFacet ()

void        xmlSchemaFreeFacet              (xmlSchemaFacetPtr facet);

Deallocate a Schema Facet structure.

facet : a schema facet structure

xmlunicode

xmlunicode

Name

Synopsis

Description

Details

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point UCS block name1 if true, 0 if false and -1 on unknown block
 
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point1 if true 0 otherwise
 

  UCS code point UCS Category name1 if true, 0 if false and -1 on unknown category
 
 

xpath

xpath

Name

Synopsis

Description

Details

Expression evaluation occurs with respect to a context. he context consists of: -- a node (the context node) -- a node list (the context node list) -- a set of variable bindings -- a function library -- the set of namespace declarations in scope for the expression + - a node (the context node) + - a node list (the context node list) + - a set of variable bindings + - a function library + - the set of namespace declarations in scope for the expression Following the switch to hash tables, this need to be trimmed up at the next binary incompatible release.

[14] Expr ::= OrExpr -[21] OrExpr ::= AndExpr -| OrExpr 'or' AndExpr

Parse and compile an expression

-2 in case of error 1 if first point < second point, 0 if -that's the same node, -1 otherwise

the string value of the object, NULL in case of error. -A new string is allocated only if needed (val isn't a -string object).

the new object, the old one is freed (or the operation -is done directly on val

the new object, the old one is freed (or the operation -is done directly on val

the new object, the old one is freed (or the operation -is done directly on val

the xmlXPathObjectPtr resulting from the evaluation or NULL. -the caller has to free the object.

the xmlXPathObjectPtr resulting from the evaluation or NULL. -the caller has to free the object.

the xmlXPathObjectPtr resulting from the evaluation or NULL. -the caller has to free the object.the xmlXPathCompExprPtr resulting from the compilation or NULL. + the caller has to free the object.

the xmlXPathObjectPtr resulting from the evaluation or NULL. -the caller has to free the object.

xpathInternals

xpathInternals

Name

Synopsis

Description

Details

difference() function: -node-set set:difference (node-set, node-set)

the difference between the two node sets, or nodes1 if -nodes2 is empty

intersection() function: -node-set set:intersection (node-set, node-set)

a node set comprising the nodes that are within both the -node sets passed as arguments

distinct() function: -node-set set:distinct (node-set)

nodes if -it is empty

distinct() function: -node-set set:distinct (node-set) + node-set set:distinct (node-set)

nodes if -it is empty

Implements the EXSLT - Sets has-same-nodes function: -boolean set:has-same-node(node-set, node-set)

nodes2, false (0) -otherwise

leading() function: -node-set set:leading (node-set, node-set)

node in document order, -nodesnodes -doesn't contain node

leading() function: -node-set set:leading (node-set, node-set)

nodes2 -in document order, nodes1nodes2 is NULL or empty or -an empty node-set if nodes1

leading() function: -node-set set:leading (node-set, node-set) + node-set set:leading (node-set, node-set)

node in document order, -nodesnodes -doesn't contain node

leading() function: -node-set set:leading (node-set, node-set) + node-set set:leading (node-set, node-set)

nodes2 -in document order, nodes1nodes2 is NULL or empty or -an empty node-set if nodes1

trailing() function: -node-set set:trailing (node-set, node-set)

node in document order, -nodesnodes -doesn't contain node

trailing() function: -node-set set:trailing (node-set, node-set)

nodes2 -in document order, nodes1nodes2 is NULL or empty or -an empty node-set if nodes1

trailing() function: -node-set set:trailing (node-set, node-set) + node-set set:trailing (node-set, node-set)

node in document order, -nodesnodes -doesn't contain node

trailing() function: -node-set set:trailing (node-set, node-set) + node-set set:trailing (node-set, node-set)

nodes2 -in document order, nodes1nodes2 is NULL or empty or -an empty node-set if nodes1

parse an XML name

[4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' | -CombiningChar | Extender

[5] Name ::= (Letter | '_' | ':') (NameChar)*

[NS 3] NCName ::= (Letter | '_') (NCNameChar)*

[NS 4] NCNameChar ::= Letter | Digit | '.' | '-' | '_' | -CombiningChar | Extender

[30a] Float ::= Number ('e' Digits?)?

[30] Number ::= Digits ('.' Digits?)? -| '.' Digits -[31] Digits ::= [0-9]+

[30] Number ::= Digits ('.' Digits?)? + | '.' Digits + [31] Digits ::= [0-9]+

Compile a Number in the string In complement of the Number expression, this function also handles @@ -9701,7 +9871,9 @@ negative values : '-' Number.

Implement the compare operation on XPath objects: -arg1arg2 (1, 1, ... -arg1arg2 (1, 0, ... -arg1arg2 (0, 1, ... -arg1

Is the name given a NodeType one.

[38] NodeType ::= 'comment' -| 'text' -| 'processing-instruction' -| 'node'

[38] NodeType ::= 'comment' + | 'text' + | 'processing-instruction' + | 'node'

last() XPath function -number last() @@ -12871,7 +13105,9 @@ The last function returns the number of nodes in the context node list.

position() XPath function -number position() @@ -12968,7 +13204,9 @@ HREF="LAST" >

count() XPath function -number count(node-set)

id() XPath function -node-set id(object) + node-set id(object) The id function selects elements by their unique ID (see [5.2.1 Unique IDs]). When the argument to id is of type node-set, then the result is the union of the result of applying id to the @@ -13154,7 +13394,9 @@ have a unique ID equal to any of the tokens in the list.

name() XPath function -string local-name(node-set?) + string local-name(node-set?) The local-name function returns a string containing the local part of the name of the node in the argument node-set that is first in document order. If the node-set is empty or the first node has no @@ -13247,7 +13489,9 @@ defaults to the context node.

uri() XPath function -string namespace-uri(node-set?) + string namespace-uri(node-set?) The namespace-uri function returns a string containing the namespace URI of the expanded name of the node in the argument node-set that is first in document order. If the node-set is empty, @@ -13341,7 +13585,9 @@ defaults to the context node.

string() XPath function -string string(object?) + string string(object?) he string function converts an object to a string as follows: -- A node-set is converted to a string by returning the value of -the node in the node-set that is first in document order. -If the node-set is empty, an empty string is returned. -- A number is converted to a string as follows -+ NaN is converted to the string NaN -+ positive zero is converted to the string 0 -+ negative zero is converted to the string 0 -+ positive infinity is converted to the string Infinity -+ negative infinity is converted to the string -Infinity -+ if the number is an integer, the number is represented in -decimal form as a Number with no decimal point and no leading -zeros, preceded by a minus sign (-) if the number is negative -+ otherwise, the number is represented in decimal form as a -Number including a decimal point with at least one digit -before the decimal point and at least one digit after the -decimal point, preceded by a minus sign (-) if the number -is negative; there must be no leading zeros before the decimal -point apart possibly from the one required digit immediately -before the decimal point; beyond the one required digit -after the decimal point there must be as many, but only as -many, more digits as are needed to uniquely distinguish the -number from all other IEEE 754 numeric values. -- The boolean false value is converted to the string false. -The boolean true value is converted to the string true.

If the argument is omitted, it defaults to a node-set with the context node as its only member.

length() XPath function -number string-length(string?) + number string-length(string?) The string-length returns the number of characters in the string (see [3.6 Strings]). If the argument is omitted, it defaults to the context node converted to a string, in other words the value @@ -13549,7 +13797,9 @@ of the context node.

concat() XPath function -string concat(string, string, string*) + string concat(string, string, string*) The concat function returns the concatenation of its arguments.

contains() XPath function -boolean contains(string, string) + boolean contains(string, string) The contains function returns true if the first argument string contains the second argument string, and otherwise returns false.

with() XPath function -boolean starts-with(string, string) + boolean starts-with(string, string) The starts-with function returns true if the first argument string starts with the second argument string, and otherwise returns false.

substring() XPath function -string substring(string, number, number?) + 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, @@ -13915,18 +14171,20 @@ 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 ""

before() XPath function -string substring-before(string, string) + 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 @@ -14019,7 +14277,9 @@ string. For example, substring-before("1999/04/01","/") returns 1999.

after() XPath function -string substring-after(string, string) + 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 @@ -14113,7 +14373,9 @@ and substring-after("1999/04/01","19") returns 99/04/01.

space() XPath function -string normalize-space(string?) + string normalize-space(string?) The normalize-space function returns the argument string with white space normalized by stripping leading and trailing whitespace and replacing sequences of whitespace characters by a single @@ -14207,7 +14469,9 @@ node converted to a string, in other words the value of the context node.

translate() XPath function -string translate(string, string, string) + 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 @@ -14304,7 +14568,9 @@ string are removed. For example, translate("--aaa--","abc-","ABC")

not() XPath function -boolean not(boolean) + boolean not(boolean) The not function returns true if its argument is false, and false otherwise.

true() XPath function -boolean true()

false() XPath function -boolean false()

lang() XPath function -boolean lang(string) + boolean lang(string) The lang function returns true or false depending on whether the language of the context node as specified by xml:lang attributes is the same as or is a sublanguage of the language specified by @@ -14672,7 +14944,9 @@ has an xml:lang attribute. If there is no such attribute, then lang

number() XPath function -number number(object?)

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

floor() XPath function -number floor(number) + number floor(number) The floor function returns the largest (closest to positive infinity) number that is not greater than the argument and that is an integer.

ceiling() XPath function -number ceiling(number) + number ceiling(number) The ceiling function returns the smallest (closest to negative infinity) number that is not less than the argument and that is an integer.

round() XPath function -number round(number) + number round(number) The round function returns the number that is closest to the argument and that is an integer. If there are two such numbers, then the one that is even is returned.

boolean() XPath function -boolean boolean(object) + boolean boolean(object) he boolean function converts its argument to a boolean as follows: -- a number is true if and only if it is neither positive or -negative zero nor NaN -- a node-set is true if and only if it is non-empty -- a string is true if and only if its length is non-zero

xpointer

xpointer

Name

Synopsis

Description

Details

the element from which a user or program initiated traversal of -the link, or NULL.

the xmlXPathObjectPtr resulting from the evaluation or NULL. -the caller has to free the object.

an xmlNodePtr list or NULL. -the caller has to free the node tree.

[8] Predicate ::= '[' PredicateExpr ']' -[9] PredicateExpr ::= Expr

Evaluate a predicate as in

+ @@ -2155,6 +2156,9 @@ Identifiers can be longer, but this will be more costly at runtime. + + Bit in the loadsubset context field to tell to not do ID/REFs registration. Used to initialize xmlLoadExtDtdDefaultValue in some special cases. + Both general and parameter entities need to be substituted.