From d433046ae52b0488a9fad77d2045c0139b8cada8 Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Tue, 29 Apr 2003 12:40:16 +0000 Subject: [PATCH] fixing a function comment switching to the XML/XSLT doc generation closing * xmlschemas.c doc/libxml2-api.xml: fixing a function comment * doc/Makefile.am doc/apibuild.py doc/gnome-xml.sgml: switching to the XML/XSLT doc generation closing #111799 * doc/html/*: complete update of the HTML results Daniel --- ChangeLog | 7 + doc/Makefile.am | 8 +- doc/apibuild.py | 3 +- doc/gnome-xml.sgml | 131 - doc/html/home.png | Bin 0 -> 654 bytes doc/html/index.html | 46 + doc/html/index.sgml | 1530 -- doc/html/left.png | Bin 0 -> 459 bytes doc/html/libxml-DOCBparser.html | 215 + doc/html/libxml-HTMLparser.html | 371 + doc/html/libxml-HTMLtree.html | 271 + doc/html/libxml-SAX.html | 420 + doc/html/libxml-c14n.html | 1410 +- doc/html/libxml-catalog.html | 4341 +---- doc/html/libxml-debugXML.html | 385 + doc/html/libxml-encoding.html | 3791 +---- doc/html/libxml-entities.html | 2356 +-- doc/html/libxml-globals.html | 1979 +-- doc/html/libxml-hash.html | 4440 +----- doc/html/libxml-lib.html | 425 +- doc/html/libxml-nanoftp.html | 2901 +--- doc/html/libxml-nanohttp.html | 1699 +- doc/html/libxml-notes.html | 246 +- doc/html/libxml-parser.html | 13595 ++-------------- doc/html/libxml-parserInternals.html | 1431 ++ doc/html/libxml-relaxng.html | 2172 +-- doc/html/libxml-schemasInternals.html | 347 + doc/html/libxml-threads.html | 1498 +- doc/html/libxml-tree.html | 20175 ++---------------------- doc/html/libxml-uri.html | 1716 +- doc/html/libxml-valid.html | 10145 +----------- doc/html/libxml-xinclude.html | 417 +- doc/html/libxml-xmlIO.html | 552 + doc/html/libxml-xmlautomata.html | 2855 +--- doc/html/libxml-xmlerror.html | 1295 +- doc/html/libxml-xmlmemory.html | 2523 +-- doc/html/libxml-xmlreader.html | 5663 +------ doc/html/libxml-xmlregexp.html | 1494 +- doc/html/libxml-xmlschemas.html | 2170 +-- doc/html/libxml-xmlschemastypes.html | 1606 +- doc/html/libxml-xmlunicode.html | 12852 +-------------- doc/html/libxml-xpath.html | 5229 +----- doc/html/libxml-xpathInternals.html | 1465 ++ doc/html/libxml-xpointer.html | 2939 +--- doc/html/right.png | Bin 0 -> 472 bytes doc/html/up.png | Bin 0 -> 406 bytes doc/libxml2-api.xml | 544 + xmlschemas.c | 1 - 48 files changed, 15465 insertions(+), 104194 deletions(-) delete mode 100644 doc/gnome-xml.sgml create mode 100644 doc/html/home.png create mode 100644 doc/html/index.html delete mode 100644 doc/html/index.sgml create mode 100644 doc/html/left.png create mode 100644 doc/html/libxml-DOCBparser.html create mode 100644 doc/html/libxml-HTMLparser.html create mode 100644 doc/html/libxml-HTMLtree.html create mode 100644 doc/html/libxml-SAX.html create mode 100644 doc/html/libxml-debugXML.html create mode 100644 doc/html/libxml-parserInternals.html create mode 100644 doc/html/libxml-schemasInternals.html create mode 100644 doc/html/libxml-xmlIO.html create mode 100644 doc/html/libxml-xpathInternals.html create mode 100644 doc/html/right.png create mode 100644 doc/html/up.png diff --git a/ChangeLog b/ChangeLog index 0daed52b..c1c0eaed 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +Tue Apr 29 14:36:49 CEST 2003 Daniel Veillard + + * xmlschemas.c doc/libxml2-api.xml: fixing a function comment + * doc/Makefile.am doc/apibuild.py doc/gnome-xml.sgml: switching + to the XML/XSLT doc generation closing #111799 + * doc/html/*: complete update of the HTML results + Mon Apr 28 14:51:41 CEST 2003 Igor Zlatkovic * win32/defgen.xsl: fixed the conditional for unicode map, diff --git a/doc/Makefile.am b/doc/Makefile.am index 96fa471c..6260e3df 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -4,7 +4,7 @@ DOC_MODULE=libxml2-$(VERSION) # The top-level SGML file. -DOC_MAIN_SGML_FILE=gnome-xml.sgml +DOC_MAIN_XML_FILE=gnome-xml.xml # The directory containing the source code (if it contains documentation). DOC_SOURCE_DIR=.. @@ -62,12 +62,10 @@ templates: scan -gtkdoc-mktmpl --module=libxml sgml: templates - -gtkdoc-mkdb --module=libxml --source-dir=$(DOC_SOURCE_DIR) + -gtkdoc-mkdb --module=libxml --source-dir=$(DOC_SOURCE_DIR) --output-format=xml --main-sgml-file=$(DOC_MAIN_XML_FILE) xml: sgml if test -d xml ; then rm xml/* ; else mkdir xml ; fi - -@(for s in sgml/*.sgml ; do name=`basename $$s .sgml` ; \ - xmllint --sgml $$s > xml/"$$name".xml ; done) libxml2-api.xml: apibuild.py ../include/libxml/*.h -(./apibuild.py) @@ -76,7 +74,7 @@ api: libxml2-api.xml libxml2-refs.xml html: if test -n -d html ; then mkdir html ; fi - -cd html && gtkdoc-mkhtml libxml ../$(DOC_MAIN_SGML_FILE) + -cd html && gtkdoc-mkhtml libxml ../$(DOC_MAIN_XML_FILE) clean-local: rm -f *~ *.bak *.hierarchy *.signals *-unused.txt diff --git a/doc/apibuild.py b/doc/apibuild.py index b80809bc..4e56f536 100755 --- a/doc/apibuild.py +++ b/doc/apibuild.py @@ -1464,8 +1464,7 @@ def rebuild(): if glob.glob("../parser.c") != [] : print "Rebuilding API description for libxml2" builder = docBuilder("libxml2", ["..", "../include/libxml"], - ["xmlwin32version.h", "tst.c", - "schemasInternals.h", "xmlschemas" ]) + ["xmlwin32version.h", "tst.c"]) elif glob.glob("../libxslt/transform.c") != [] : print "Rebuilding API description for libxslt" builder = docBuilder("libxslt", ["../libxslt"], diff --git a/doc/gnome-xml.sgml b/doc/gnome-xml.sgml deleted file mode 100644 index 48ac5c9b..00000000 --- a/doc/gnome-xml.sgml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -]> - - - - Gnome XML Library Reference Manual - - - Daniel - Veillard - -
- daniel@veillard.com -
- - - - - 1999 - Daniel Veillard - - - - Permission is granted to make and distribute verbatim - copies of this manual provided the copyright notice and this - permission notice are preserved on all copies. - - Permission is granted to copy and distribute modified - versions of this manual under the conditions for verbatim - copying, provided also that the entire resulting derived work is - distributed under the terms of a permission notice identical to - this one. - - Permission is granted to copy and distribute translations - of this manual into another language, under the above conditions - for modified versions. - - - - This manual documents the interfaces of the libxml - library and has some short notes to help get you up to speed - with using the library. - - - - - 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 - so the same range of tools can be used with HTML input. - - - Libxml Library Reference - - 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. - - &parser; - &xmlreader; - &SAX; - &tree; - &entities; - &valid; - &relaxng; - &uri; - &error; - &HTMLparser; - &HTMLtree; - &xpath; - &xpathInternals; - &xpointer; - &xinclude; - &nanohttp; - &nanoftp; - &xmlIO; - &catalog; - &c14n; - &threads; - &globals; - &global_functions; - &DOCBparser; - &parserInternals; - &encoding; - &hash; - &debugXML; - &xmlmemory; - &xmlregexp; - &xmlautomata; - &xmlunicode; - &xmlschemas; - &xmlschemastypes; - &schemasInternals; - - - diff --git a/doc/html/home.png b/doc/html/home.png new file mode 100644 index 0000000000000000000000000000000000000000..17003611d9df2b066afc682cbde962f3a575002d GIT binary patch literal 654 zcmV;90&)F`P)~yY zO1cF+0vxb!W?!x?K+*#62Jq)nA4q`)5S6sgX4ao{=)(Mgq+YMr)7sjak|a^9)zS!j zlk{-n29mabXYF=7SYBQx&vO8xC}MYams+hxqtO7sImhPaCf@rq;I^3!#u*2aUP)55 zT2&N90xmEJ0s&fGT~(T<3d2xYmK9C>IP*x-M@ib*+0pFm>>uW37N2Wzaq-fCnIZE9 zpb8}0+uN+KuQM2oZVHfP8U6kQdo3?>Wo2dT)WeM9So8DqhLi#T0 z-i(>mfjhvbsYV`;4sgfJ-p>G-SqJ!fjR6BQYs1h*y9xaN0l{VB;o%`08yiy@)$8@~ z2PD1gcDuiy;j1tR0v#V8OH%W)25-YKyx(j#IXO9*YWf0mb8}QG6@b@;cHxh9{t7+@ o!Yd`f8L$sLH?yBt^q3C6015TtIu@BS5dZ)H07*qoM6N<$f*igdr~m)} literal 0 HcmV?d00001 diff --git a/doc/html/index.html b/doc/html/index.html new file mode 100644 index 00000000..4fb535a7 --- /dev/null +++ b/doc/html/index.html @@ -0,0 +1,46 @@ + +Gnome XML Library Reference Manual

Gnome XML Library Reference Manual

Daniel Veillard


+     <daniel@veillard.com>
+   

Copyright © 1999 Daniel Veillard

Permission is granted to make and distribute verbatim + copies of this manual provided the copyright notice and this + permission notice are preserved on all copies.

Permission is granted to copy and distribute modified + versions of this manual under the conditions for verbatim + copying, provided also that the entire resulting derived work is + distributed under the terms of a permission notice identical to + this one.

Permission is granted to copy and distribute translations + of this manual into another language, under the above conditions + for modified versions.

Abstract

This manual documents the interfaces of the libxml + library and has some short notes to help get you up to speed + with using the library.

Table of Contents

Libxml Programming Notes
Libxml Library Reference
Libxml Programming Notes >>
diff --git a/doc/html/index.sgml b/doc/html/index.sgml deleted file mode 100644 index 4d5afc08..00000000 --- a/doc/html/index.sgml +++ /dev/null @@ -1,1530 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/html/left.png b/doc/html/left.png new file mode 100644 index 0000000000000000000000000000000000000000..2d05b3d5b4aeec9384bbfe404bfc4ed0897051c4 GIT binary patch literal 459 zcmV;+0W|)JP)40xL?wO*>WZ(J#ML5j2<9jD6A%Q&kC}jOeEc;X{s;`zcnxLeZR6?6h#^ihmNF6NpGdilO$m<82oD9WQ|6nVv1`? z>KufRi{?QPXg;4;wroQu4?mN1Ydd@|kaQ|ZyWLK!)yi7Wb%=0{}lD)tfliHAUyWRQ+fD_;aV6j->y6!O_8bENg +DOCBparser
PrevUpHomeGnome XML Library Reference ManualNext

DOCBparser

DOCBparser —

Synopsis

+
+
+
+typedef     docbParserCtxt;
+typedef     docbParserCtxtPtr;
+typedef     docbParserNodeInfo;
+typedef     docbSAXHandler;
+typedef     docbSAXHandlerPtr;
+typedef     docbParserInput;
+typedef     docbParserInputPtr;
+typedef     docbDocPtr;
+typedef     docbNodePtr;
+int         docbEncodeEntities              (unsigned char *out,
+                                             int *outlen,
+                                             unsigned char *in,
+                                             int *inlen,
+                                             int quoteChar);
+docbDocPtr  docbSAXParseDoc                 (xmlChar *cur,
+                                             const char *encoding,
+                                             docbSAXHandlerPtr sax,
+                                             void *userData);
+docbDocPtr  docbParseDoc                    (xmlChar *cur,
+                                             const char *encoding);
+docbDocPtr  docbSAXParseFile                (const char *filename,
+                                             const char *encoding,
+                                             docbSAXHandlerPtr sax,
+                                             void *userData);
+docbDocPtr  docbParseFile                   (const char *filename,
+                                             const char *encoding);
+void        docbFreeParserCtxt              (docbParserCtxtPtr ctxt);
+docbParserCtxtPtr docbCreatePushParserCtxt  (docbSAXHandlerPtr sax,
+                                             void *user_data,
+                                             const char *chunk,
+                                             int size,
+                                             const char *filename,
+                                             xmlCharEncoding enc);
+int         docbParseChunk                  (docbParserCtxtPtr ctxt,
+                                             const char *chunk,
+                                             int size,
+                                             int terminate);
+docbParserCtxtPtr docbCreateFileParserCtxt  (const char *filename,
+                                             const char *encoding);
+int         docbParseDocument               (docbParserCtxtPtr ctxt);
+

Description

+ +

Details

docbParserCtxt

typedef xmlParserCtxt docbParserCtxt;
+

+ +

docbParserCtxtPtr

typedef xmlParserCtxtPtr docbParserCtxtPtr;
+

+ +

docbParserNodeInfo

typedef xmlParserNodeInfo docbParserNodeInfo;
+

+ +

docbSAXHandler

typedef xmlSAXHandler docbSAXHandler;
+

+ +

docbSAXHandlerPtr

typedef xmlSAXHandlerPtr docbSAXHandlerPtr;
+

+ +

docbParserInput

typedef xmlParserInput docbParserInput;
+

+ +

docbParserInputPtr

typedef xmlParserInputPtr docbParserInputPtr;
+

+ +

docbDocPtr

typedef xmlDocPtr docbDocPtr;
+

+ +

docbNodePtr

typedef xmlNodePtr docbNodePtr;
+

+ +

docbEncodeEntities ()

int         docbEncodeEntities              (unsigned char *out,
+                                             int *outlen,
+                                             unsigned char *in,
+                                             int *inlen,
+                                             int quoteChar);

+Take a block of UTF-8 chars in and try to convert it to an ASCII +plus SGML entities block of chars out.

+ +

out : a pointer to an array of bytes to store the result +
outlen : the length of out +
in : a pointer to an array of UTF-8 chars +
inlen : the length of in +
quoteChar : the quote character to escape (' or ") or zero. +
Returns :0 if success, -2 if the transcoding fails, or -1 otherwise +The value of inlen after return is the number of octets consumed + as the return value is positive, else unpredictable. +The value of outlen after return is the number of octets consumed. +

docbSAXParseDoc ()

docbDocPtr  docbSAXParseDoc                 (xmlChar *cur,
+                                             const char *encoding,
+                                             docbSAXHandlerPtr sax,
+                                             void *userData);

+parse an SGML in-memory document and build a tree. +It use the given SAX function block to handle the parsing callback. +If sax is NULL, fallback to the default DOM tree building routines.

+ +

cur : a pointer to an array of xmlChar +
encoding : a free form C string describing the SGML document encoding, or NULL +
sax : the SAX handler block +
userData : if using SAX, this pointer will be provided on callbacks. +
Returns :the resulting document tree +

docbParseDoc ()

docbDocPtr  docbParseDoc                    (xmlChar *cur,
+                                             const char *encoding);

+parse an SGML in-memory document and build a tree.

+ +

cur : a pointer to an array of xmlChar +
encoding : a free form C string describing the SGML document encoding, or NULL +
Returns :the resulting document tree +

docbSAXParseFile ()

docbDocPtr  docbSAXParseFile                (const char *filename,
+                                             const char *encoding,
+                                             docbSAXHandlerPtr sax,
+                                             void *userData);

+parse an SGML file and build a tree. Automatic support for ZLIB/Compress +compressed document is provided by default if found at compile-time. +It use the given SAX function block to handle the parsing callback. +If sax is NULL, fallback to the default DOM tree building routines.

+ +

filename : the filename +
encoding : a free form C string describing the SGML document encoding, or NULL +
sax : the SAX handler block +
userData : if using SAX, this pointer will be provided on callbacks. +
Returns :the resulting document tree +

docbParseFile ()

docbDocPtr  docbParseFile                   (const char *filename,
+                                             const char *encoding);

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

+ +

filename : the filename +
encoding : a free form C string describing document encoding, or NULL +
Returns :the resulting document tree +

docbFreeParserCtxt ()

void        docbFreeParserCtxt              (docbParserCtxtPtr ctxt);

+Free all the memory used by a parser context. However the parsed +document in ctxt->myDoc is not freed.

+ +

ctxt : an SGML parser context +

docbCreatePushParserCtxt ()

docbParserCtxtPtr docbCreatePushParserCtxt  (docbSAXHandlerPtr sax,
+                                             void *user_data,
+                                             const char *chunk,
+                                             int size,
+                                             const char *filename,
+                                             xmlCharEncoding enc);

+Create a parser context for using the DocBook SGML parser in push mode +To allow content encoding detection, size should be >= 4 +The value of filename is used for fetching external entities +and error/warning reports.

+ +

sax : a SAX handler +
user_data : The user data returned on SAX callbacks +
chunk : a pointer to an array of chars +
size : number of chars in the array +
filename : an optional file name or URI +
enc : an optional encoding +
Returns :the new parser context or NULL +

docbParseChunk ()

int         docbParseChunk                  (docbParserCtxtPtr ctxt,
+                                             const char *chunk,
+                                             int size,
+                                             int terminate);

+Parse a Chunk of memory

+ +

ctxt : an XML parser context +
chunk : an char array +
size : the size in byte of the chunk +
terminate : last chunk indicator +
Returns :zero if no error, the xmlParserErrors otherwise. +

docbCreateFileParserCtxt ()

docbParserCtxtPtr docbCreateFileParserCtxt  (const char *filename,
+                                             const char *encoding);

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

+ +

filename : the filename +
encoding : the SGML document encoding, or NULL +
Returns :the new parser context or NULL +

docbParseDocument ()

int         docbParseDocument               (docbParserCtxtPtr ctxt);

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

+ +

ctxt : an SGML parser context +
Returns :0, -1 in case of error. the parser context is augmented + as a result of the parsing. +
<< globalsparserInternals >>
diff --git a/doc/html/libxml-HTMLparser.html b/doc/html/libxml-HTMLparser.html new file mode 100644 index 00000000..cf22ca1b --- /dev/null +++ b/doc/html/libxml-HTMLparser.html @@ -0,0 +1,371 @@ + +HTMLparser
PrevUpHomeGnome XML Library Reference ManualNext

HTMLparser

HTMLparser —

Synopsis

+
+
+
+typedef     htmlParserCtxt;
+typedef     htmlParserCtxtPtr;
+typedef     htmlParserNodeInfo;
+typedef     htmlSAXHandler;
+typedef     htmlSAXHandlerPtr;
+typedef     htmlParserInput;
+typedef     htmlParserInputPtr;
+typedef     htmlDocPtr;
+typedef     htmlNodePtr;
+struct      htmlElemDesc;
+typedef     htmlElemDescPtr;
+struct      htmlEntityDesc;
+typedef     htmlEntityDescPtr;
+const htmlElemDesc* htmlTagLookup           (const xmlChar *tag);
+const htmlEntityDesc* htmlEntityLookup      (const xmlChar *name);
+const htmlEntityDesc* htmlEntityValueLookup (unsigned int value);
+int         htmlIsAutoClosed                (htmlDocPtr doc,
+                                             htmlNodePtr elem);
+int         htmlAutoCloseTag                (htmlDocPtr doc,
+                                             const xmlChar *name,
+                                             htmlNodePtr elem);
+const htmlEntityDesc* htmlParseEntityRef    (htmlParserCtxtPtr ctxt,
+                                             xmlChar **str);
+int         htmlParseCharRef                (htmlParserCtxtPtr ctxt);
+void        htmlParseElement                (htmlParserCtxtPtr ctxt);
+htmlParserCtxtPtr htmlCreateMemoryParserCtxt
+                                            (const char *buffer,
+                                             int size);
+int         htmlParseDocument               (htmlParserCtxtPtr ctxt);
+htmlDocPtr  htmlSAXParseDoc                 (xmlChar *cur,
+                                             const char *encoding,
+                                             htmlSAXHandlerPtr sax,
+                                             void *userData);
+htmlDocPtr  htmlParseDoc                    (xmlChar *cur,
+                                             const char *encoding);
+htmlDocPtr  htmlSAXParseFile                (const char *filename,
+                                             const char *encoding,
+                                             htmlSAXHandlerPtr sax,
+                                             void *userData);
+htmlDocPtr  htmlParseFile                   (const char *filename,
+                                             const char *encoding);
+int         UTF8ToHtml                      (unsigned char *out,
+                                             int *outlen,
+                                             unsigned char *in,
+                                             int *inlen);
+int         htmlEncodeEntities              (unsigned char *out,
+                                             int *outlen,
+                                             unsigned char *in,
+                                             int *inlen,
+                                             int quoteChar);
+int         htmlIsScriptAttribute           (const xmlChar *name);
+int         htmlHandleOmittedElem           (int val);
+void        htmlFreeParserCtxt              (htmlParserCtxtPtr ctxt);
+htmlParserCtxtPtr htmlCreatePushParserCtxt  (htmlSAXHandlerPtr sax,
+                                             void *user_data,
+                                             const char *chunk,
+                                             int size,
+                                             const char *filename,
+                                             xmlCharEncoding enc);
+int         htmlParseChunk                  (htmlParserCtxtPtr ctxt,
+                                             const char *chunk,
+                                             int size,
+                                             int terminate);
+

Description

+ +

Details

htmlParserCtxt

typedef xmlParserCtxt htmlParserCtxt;
+

+ +

htmlParserCtxtPtr

typedef xmlParserCtxtPtr htmlParserCtxtPtr;
+

+ +

htmlParserNodeInfo

typedef xmlParserNodeInfo htmlParserNodeInfo;
+

+ +

htmlSAXHandler

typedef xmlSAXHandler htmlSAXHandler;
+

+ +

htmlSAXHandlerPtr

typedef xmlSAXHandlerPtr htmlSAXHandlerPtr;
+

+ +

htmlParserInput

typedef xmlParserInput htmlParserInput;
+

+ +

htmlParserInputPtr

typedef xmlParserInputPtr htmlParserInputPtr;
+

+ +

htmlDocPtr

typedef xmlDocPtr htmlDocPtr;
+

+ +

htmlNodePtr

typedef xmlNodePtr htmlNodePtr;
+

+ +

struct htmlElemDesc

struct htmlElemDesc {
+    const char *name;	/* The tag name */
+    char startTag;      /* Whether the start tag can be implied */
+    char endTag;        /* Whether the end tag can be implied */
+    char saveEndTag;    /* Whether the end tag should be saved */
+    char empty;         /* Is this an empty element ? */
+    char depr;          /* Is this a deprecated element ? */
+    char dtd;           /* 1: only in Loose DTD, 2: only Frameset one */
+    char isinline;      /* is this a block 0 or inline 1 element */
+    const char *desc;   /* the description */
+
+/* NRK Jan.2003
+ * New fields encapsulating HTML structure
+ *
+ * Bugs:
+ *	This is a very limited representation.  It fails to tell us when
+ *	an element *requires* subelements (we only have whether they're
+ *	allowed or not), and it doesn't tell us where CDATA and PCDATA
+ *	are allowed.  Some element relationships are not fully represented:
+ *	these are flagged with the word MODIFIER
+ */
+    const char** subelts;		/* allowed sub-elements of this element */
+    const char* defaultsubelt;	/* subelement for suggested auto-repair
+					   if necessary or NULL */
+    const char** attrs_opt;		/* Optional Attributes */
+    const char** attrs_depr;		/* Additional deprecated attributes */
+    const char** attrs_req;		/* Required attributes */
+};
+

+ +

htmlElemDescPtr

typedef htmlElemDesc *htmlElemDescPtr;
+

+ +

struct htmlEntityDesc

struct htmlEntityDesc {
+    unsigned int value;	/* the UNICODE value for the character */
+    const char *name;	/* The entity name */
+    const char *desc;   /* the description */
+};
+

+ +

htmlEntityDescPtr

typedef htmlEntityDesc *htmlEntityDescPtr;
+

+ +

htmlTagLookup ()

const htmlElemDesc* htmlTagLookup           (const xmlChar *tag);

+Lookup the HTML tag in the ElementTable

+ +

tag : The tag name in lowercase +
Returns :the related htmlElemDescPtr or NULL if not found. +

htmlEntityLookup ()

const htmlEntityDesc* htmlEntityLookup      (const xmlChar *name);

+Lookup the given entity in EntitiesTable +

+TODO: the linear scan is really ugly, an hash table is really needed.

+ +

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

htmlEntityValueLookup ()

const htmlEntityDesc* htmlEntityValueLookup (unsigned int value);

+Lookup the given entity in EntitiesTable +

+TODO: the linear scan is really ugly, an hash table is really needed.

+ +

value : the entity's unicode value +
Returns :the associated htmlEntityDescPtr if found, NULL otherwise. +

htmlIsAutoClosed ()

int         htmlIsAutoClosed                (htmlDocPtr doc,
+                                             htmlNodePtr elem);

+The HTML DTD allows a tag to implicitly close other tags. +The list is kept in htmlStartClose array. This function checks +if a tag is autoclosed by one of it's child

+ +

doc : the HTML document +
elem : the HTML element +
Returns :1 if autoclosed, 0 otherwise +

htmlAutoCloseTag ()

int         htmlAutoCloseTag                (htmlDocPtr doc,
+                                             const xmlChar *name,
+                                             htmlNodePtr elem);

+The HTML DTD allows a tag to implicitly close other tags. +The list is kept in htmlStartClose array. This function checks +if the element or one of it's children would autoclose the +given tag.

+ +

doc : the HTML document +
name : The tag name +
elem : the HTML element +
Returns :1 if autoclose, 0 otherwise +

htmlParseEntityRef ()

const htmlEntityDesc* htmlParseEntityRef    (htmlParserCtxtPtr ctxt,
+                                             xmlChar **str);

+parse an HTML ENTITY references +

+[68] EntityRef ::= '&' Name ';'

+ +

ctxt : an HTML parser context +
str : location to store the entity name +
Returns :the associated htmlEntityDescPtr if found, or NULL otherwise, + if non-NULL *str will have to be freed by the caller. +

htmlParseCharRef ()

int         htmlParseCharRef                (htmlParserCtxtPtr ctxt);

+parse Reference declarations +

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

+ +

ctxt : an HTML parser context +
Returns :the value parsed (as an int) +

htmlParseElement ()

void        htmlParseElement                (htmlParserCtxtPtr ctxt);

+parse an HTML element, this is highly recursive +

+[39] element ::= EmptyElemTag | STag content ETag +

+[41] Attribute ::= Name Eq AttValue

+ +

ctxt : an HTML parser context +

htmlCreateMemoryParserCtxt ()

htmlParserCtxtPtr htmlCreateMemoryParserCtxt
+                                            (const char *buffer,
+                                             int size);

+Create a parser context for an HTML in-memory document.

+ +

buffer : a pointer to a char array +
size : the size of the array +
Returns :the new parser context or NULL +

htmlParseDocument ()

int         htmlParseDocument               (htmlParserCtxtPtr ctxt);

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

+ +

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

htmlSAXParseDoc ()

htmlDocPtr  htmlSAXParseDoc                 (xmlChar *cur,
+                                             const char *encoding,
+                                             htmlSAXHandlerPtr sax,
+                                             void *userData);

+Parse an HTML in-memory document. If sax is not NULL, use the SAX callbacks +to handle parse events. If sax is NULL, fallback to the default DOM +behavior and return a tree.

+ +

cur : a pointer to an array of xmlChar +
encoding : a free form C string describing the HTML document encoding, or NULL +
sax : the SAX handler block +
userData : if using SAX, this pointer will be provided on callbacks. +
Returns :the resulting document tree unless SAX is NULL or the document is + not well formed. +

htmlParseDoc ()

htmlDocPtr  htmlParseDoc                    (xmlChar *cur,
+                                             const char *encoding);

+parse an HTML in-memory document and build a tree.

+ +

cur : a pointer to an array of xmlChar +
encoding : a free form C string describing the HTML document encoding, or NULL +
Returns :the resulting document tree +

htmlSAXParseFile ()

htmlDocPtr  htmlSAXParseFile                (const char *filename,
+                                             const char *encoding,
+                                             htmlSAXHandlerPtr sax,
+                                             void *userData);

+parse an HTML file and build a tree. Automatic support for ZLIB/Compress +compressed document is provided by default if found at compile-time. +It use the given SAX function block to handle the parsing callback. +If sax is NULL, fallback to the default DOM tree building routines.

+ +

filename : the filename +
encoding : a free form C string describing the HTML document encoding, or NULL +
sax : the SAX handler block +
userData : if using SAX, this pointer will be provided on callbacks. +
Returns :the resulting document tree unless SAX is NULL or the document is + not well formed. +

htmlParseFile ()

htmlDocPtr  htmlParseFile                   (const char *filename,
+                                             const char *encoding);

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

+ +

filename : the filename +
encoding : a free form C string describing the HTML document encoding, or NULL +
Returns :the resulting document tree +

UTF8ToHtml ()

int         UTF8ToHtml                      (unsigned char *out,
+                                             int *outlen,
+                                             unsigned char *in,
+                                             int *inlen);

+Take a block of UTF-8 chars in and try to convert it to an ASCII +plus HTML entities block of chars out.

+ +

out : a pointer to an array of bytes to store the result +
outlen : the length of out +
in : a pointer to an array of UTF-8 chars +
inlen : the length of in +
Returns :0 if success, -2 if the transcoding fails, or -1 otherwise +The value of inlen after return is the number of octets consumed + as the return value is positive, else unpredictable. +The value of outlen after return is the number of octets consumed. +

htmlEncodeEntities ()

int         htmlEncodeEntities              (unsigned char *out,
+                                             int *outlen,
+                                             unsigned char *in,
+                                             int *inlen,
+                                             int quoteChar);

+Take a block of UTF-8 chars in and try to convert it to an ASCII +plus HTML entities block of chars out.

+ +

out : a pointer to an array of bytes to store the result +
outlen : the length of out +
in : a pointer to an array of UTF-8 chars +
inlen : the length of in +
quoteChar : the quote character to escape (' or ") or zero. +
Returns :0 if success, -2 if the transcoding fails, or -1 otherwise +The value of inlen after return is the number of octets consumed + as the return value is positive, else unpredictable. +The value of outlen after return is the number of octets consumed. +

htmlIsScriptAttribute ()

int         htmlIsScriptAttribute           (const xmlChar *name);

+Check if an attribute is of content type Script

+ +

name : an attribute name +
Returns :1 is the attribute is a script 0 otherwise +

htmlHandleOmittedElem ()

int         htmlHandleOmittedElem           (int val);

+Set and return the previous value for handling HTML omitted tags.

+ +

val : int 0 or 1 +
Returns :the last value for 0 for no handling, 1 for auto insertion. +

htmlFreeParserCtxt ()

void        htmlFreeParserCtxt              (htmlParserCtxtPtr ctxt);

+Free all the memory used by a parser context. However the parsed +document in ctxt->myDoc is not freed.

+ +

ctxt : an HTML parser context +

htmlCreatePushParserCtxt ()

htmlParserCtxtPtr htmlCreatePushParserCtxt  (htmlSAXHandlerPtr sax,
+                                             void *user_data,
+                                             const char *chunk,
+                                             int size,
+                                             const char *filename,
+                                             xmlCharEncoding enc);

+Create a parser context for using the HTML parser in push mode +The value of filename is used for fetching external entities +and error/warning reports.

+ +

sax : a SAX handler +
user_data : The user data returned on SAX callbacks +
chunk : a pointer to an array of chars +
size : number of chars in the array +
filename : an optional file name or URI +
enc : an optional encoding +
Returns :the new parser context or NULL +

htmlParseChunk ()

int         htmlParseChunk                  (htmlParserCtxtPtr ctxt,
+                                             const char *chunk,
+                                             int size,
+                                             int terminate);

+Parse a Chunk of memory

+ +

ctxt : an XML parser context +
chunk : an char array +
size : the size in byte of the chunk +
terminate : last chunk indicator +
Returns :zero if no error, the xmlParserErrors otherwise. +
<< xmlerrorHTMLtree >>
diff --git a/doc/html/libxml-HTMLtree.html b/doc/html/libxml-HTMLtree.html new file mode 100644 index 00000000..d57da2c1 --- /dev/null +++ b/doc/html/libxml-HTMLtree.html @@ -0,0 +1,271 @@ + +HTMLtree
PrevUpHomeGnome XML Library Reference ManualNext

HTMLtree

HTMLtree —

Synopsis

+
+
+
+#define     HTML_TEXT_NODE
+#define     HTML_ENTITY_REF_NODE
+#define     HTML_COMMENT_NODE
+#define     HTML_PRESERVE_NODE
+#define     HTML_PI_NODE
+htmlDocPtr  htmlNewDoc                      (const xmlChar *URI,
+                                             const xmlChar *ExternalID);
+htmlDocPtr  htmlNewDocNoDtD                 (const xmlChar *URI,
+                                             const xmlChar *ExternalID);
+const xmlChar* htmlGetMetaEncoding          (htmlDocPtr doc);
+int         htmlSetMetaEncoding             (htmlDocPtr doc,
+                                             const xmlChar *encoding);
+void        htmlDocDumpMemory               (xmlDocPtr cur,
+                                             xmlChar **mem,
+                                             int *size);
+int         htmlDocDump                     (FILE *f,
+                                             xmlDocPtr cur);
+int         htmlSaveFile                    (const char *filename,
+                                             xmlDocPtr cur);
+int         htmlNodeDump                    (xmlBufferPtr buf,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr cur);
+void        htmlNodeDumpFile                (FILE *out,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr cur);
+int         htmlNodeDumpFileFormat          (FILE *out,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr cur,
+                                             const char *encoding,
+                                             int format);
+int         htmlSaveFileEnc                 (const char *filename,
+                                             xmlDocPtr cur,
+                                             const char *encoding);
+int         htmlSaveFileFormat              (const char *filename,
+                                             xmlDocPtr cur,
+                                             const char *encoding,
+                                             int format);
+void        htmlNodeDumpFormatOutput        (xmlOutputBufferPtr buf,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr cur,
+                                             const char *encoding,
+                                             int format);
+void        htmlDocContentDumpOutput        (xmlOutputBufferPtr buf,
+                                             xmlDocPtr cur,
+                                             const char *encoding);
+void        htmlDocContentDumpFormatOutput  (xmlOutputBufferPtr buf,
+                                             xmlDocPtr cur,
+                                             const char *encoding,
+                                             int format);
+int         htmlIsBooleanAttr               (const xmlChar *name);
+void        htmlNodeDumpOutput              (xmlOutputBufferPtr buf,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr cur,
+                                             const char *encoding);
+

Description

+ +

Details

HTML_TEXT_NODE

#define HTML_TEXT_NODE		XML_TEXT_NODE
+

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

+ +

HTML_ENTITY_REF_NODE

#define HTML_ENTITY_REF_NODE	XML_ENTITY_REF_NODE
+

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

+ +

HTML_COMMENT_NODE

#define HTML_COMMENT_NODE	XML_COMMENT_NODE
+

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

+ +

HTML_PRESERVE_NODE

#define HTML_PRESERVE_NODE	XML_CDATA_SECTION_NODE
+

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

+ +

HTML_PI_NODE

#define HTML_PI_NODE		XML_PI_NODE
+

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

+ +

htmlNewDoc ()

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

+Creates a new HTML document

+ +

URI : URI for the dtd, or NULL +
ExternalID : the external ID of the DTD, or NULL +
Returns :a new document +

htmlNewDocNoDtD ()

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

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

+ +

URI : URI for the dtd, or NULL +
ExternalID : the external ID of the DTD, or NULL +
Returns :a new document, do not initialize the DTD if not provided +

htmlGetMetaEncoding ()

const xmlChar* htmlGetMetaEncoding          (htmlDocPtr doc);

+Encoding definition lookup in the Meta tags

+ +

doc : the document +
Returns :the current encoding as flagged in the HTML source +

htmlSetMetaEncoding ()

int         htmlSetMetaEncoding             (htmlDocPtr doc,
+                                             const xmlChar *encoding);

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

+ +

doc : the document +
encoding : the encoding string +
Returns :0 in case of success and -1 in case of error +

htmlDocDumpMemory ()

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

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

+ +

cur : the document +
mem : OUT: the memory pointer +
size : OUT: the memory length +

htmlDocDump ()

int         htmlDocDump                     (FILE *f,
+                                             xmlDocPtr cur);

+Dump an HTML document to an open FILE.

+ +

f : the FILE* +
cur : the document +
Returns : the number of byte written or -1 in case of failure. +

htmlSaveFile ()

int         htmlSaveFile                    (const char *filename,
+                                             xmlDocPtr cur);

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

+ +

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

htmlNodeDump ()

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

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

+ +

buf : the HTML buffer output +
doc : the document +
cur : the current node +
Returns :the number of byte written or -1 in case of error +

htmlNodeDumpFile ()

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

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

+ +

out : the FILE pointer +
doc : the document +
cur : the current node +

htmlNodeDumpFileFormat ()

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

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

+TODO: if encoding == NULL try to save in the doc encoding

+ +

out : the FILE pointer +
doc : the document +
cur : the current node +
encoding : the document encoding +
format : should formatting spaces been added +
Returns : the number of byte written or -1 in case of failure. +

htmlSaveFileEnc ()

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

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

+ +

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

htmlSaveFileFormat ()

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

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

+ +

filename : the filename +
cur : the document +
encoding : the document encoding +
format : should formatting spaces been added +
Returns : the number of byte written or -1 in case of failure. +

htmlNodeDumpFormatOutput ()

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

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

+ +

buf : the HTML buffer output +
doc : the document +
cur : the current node +
encoding : the encoding string +
format : should formatting spaces been added +

htmlDocContentDumpOutput ()

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

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

+ +

buf : the HTML buffer output +
cur : the document +
encoding : the encoding string +

htmlDocContentDumpFormatOutput ()

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

+Dump an HTML document.

+ +

buf : the HTML buffer output +
cur : the document +
encoding : the encoding string +
format : should formatting spaces been added +

htmlIsBooleanAttr ()

int         htmlIsBooleanAttr               (const xmlChar *name);

+Determine if a given attribute is a boolean attribute.

+ +

name : the name of the attribute to check +
Returns : false if the attribute is not boolean, true otherwise. +

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 +
<< HTMLparserxpath >>
diff --git a/doc/html/libxml-SAX.html b/doc/html/libxml-SAX.html new file mode 100644 index 00000000..cb14f52c --- /dev/null +++ b/doc/html/libxml-SAX.html @@ -0,0 +1,420 @@ + +SAX
PrevUpHomeGnome XML Library Reference ManualNext

SAX

SAX —

Synopsis

+
+
+
+const xmlChar* getPublicId                  (void *ctx);
+const xmlChar* getSystemId                  (void *ctx);
+void        setDocumentLocator              (void *ctx,
+                                             xmlSAXLocatorPtr loc);
+int         getLineNumber                   (void *ctx);
+int         getColumnNumber                 (void *ctx);
+int         isStandalone                    (void *ctx);
+int         hasInternalSubset               (void *ctx);
+int         hasExternalSubset               (void *ctx);
+void        internalSubset                  (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);
+void        externalSubset                  (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);
+xmlEntityPtr getEntity                      (void *ctx,
+                                             const xmlChar *name);
+xmlEntityPtr getParameterEntity             (void *ctx,
+                                             const xmlChar *name);
+xmlParserInputPtr resolveEntity             (void *ctx,
+                                             const xmlChar *publicId,
+                                             const xmlChar *systemId);
+void        entityDecl                      (void *ctx,
+                                             const xmlChar *name,
+                                             int type,
+                                             const xmlChar *publicId,
+                                             const xmlChar *systemId,
+                                             xmlChar *content);
+void        attributeDecl                   (void *ctx,
+                                             const xmlChar *elem,
+                                             const xmlChar *fullname,
+                                             int type,
+                                             int def,
+                                             const xmlChar *defaultValue,
+                                             xmlEnumerationPtr tree);
+void        elementDecl                     (void *ctx,
+                                             const xmlChar *name,
+                                             int type,
+                                             xmlElementContentPtr content);
+void        notationDecl                    (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *publicId,
+                                             const xmlChar *systemId);
+void        unparsedEntityDecl              (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *publicId,
+                                             const xmlChar *systemId,
+                                             const xmlChar *notationName);
+void        startDocument                   (void *ctx);
+void        endDocument                     (void *ctx);
+void        attribute                       (void *ctx,
+                                             const xmlChar *fullname,
+                                             const xmlChar *value);
+void        startElement                    (void *ctx,
+                                             const xmlChar *fullname,
+                                             const xmlChar **atts);
+void        endElement                      (void *ctx,
+                                             const xmlChar *name);
+void        reference                       (void *ctx,
+                                             const xmlChar *name);
+void        characters                      (void *ctx,
+                                             const xmlChar *ch,
+                                             int len);
+void        ignorableWhitespace             (void *ctx,
+                                             const xmlChar *ch,
+                                             int len);
+void        processingInstruction           (void *ctx,
+                                             const xmlChar *target,
+                                             const xmlChar *data);
+void        globalNamespace                 (void *ctx,
+                                             const xmlChar *href,
+                                             const xmlChar *prefix);
+void        setNamespace                    (void *ctx,
+                                             const xmlChar *name);
+xmlNsPtr    getNamespace                    (void *ctx);
+int         checkNamespace                  (void *ctx,
+                                             xmlChar *nameSpace);
+void        namespaceDecl                   (void *ctx,
+                                             const xmlChar *href,
+                                             const xmlChar *prefix);
+void        comment                         (void *ctx,
+                                             const xmlChar *value);
+void        cdataBlock                      (void *ctx,
+                                             const xmlChar *value,
+                                             int len);
+void        initxmlDefaultSAXHandler        (xmlSAXHandler *hdlr,
+                                             int warning);
+void        inithtmlDefaultSAXHandler       (xmlSAXHandler *hdlr);
+void        initdocbDefaultSAXHandler       (xmlSAXHandler *hdlr);
+void        xmlDefaultSAXHandlerInit        (void);
+void        htmlDefaultSAXHandlerInit       (void);
+void        docbDefaultSAXHandlerInit       (void);
+

Description

+ +

Details

getPublicId ()

const xmlChar* getPublicId                  (void *ctx);

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

+ +

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

getSystemId ()

const xmlChar* getSystemId                  (void *ctx);

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

+ +

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

setDocumentLocator ()

void        setDocumentLocator              (void *ctx,
+                                             xmlSAXLocatorPtr loc);

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

+ +

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

getLineNumber ()

int         getLineNumber                   (void *ctx);

+Provide the line number of the current parsing point.

+ +

ctx : the user data (XML parser context) +
Returns :an int +

getColumnNumber ()

int         getColumnNumber                 (void *ctx);

+Provide the column number of the current parsing point.

+ +

ctx : the user data (XML parser context) +
Returns :an int +

isStandalone ()

int         isStandalone                    (void *ctx);

+Is this document tagged standalone ?

+ +

ctx : the user data (XML parser context) +
Returns :1 if true +

hasInternalSubset ()

int         hasInternalSubset               (void *ctx);

+Does this document has an internal subset

+ +

ctx : the user data (XML parser context) +
Returns :1 if true +

hasExternalSubset ()

int         hasExternalSubset               (void *ctx);

+Does this document has an external subset

+ +

ctx : the user data (XML parser context) +
Returns :1 if true +

internalSubset ()

void        internalSubset                  (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);

+Callback on internal subset declaration.

+ +

ctx : the user data (XML parser context) +
name : the root element name +
ExternalID : the external ID +
SystemID : the SYSTEM ID (e.g. filename or URL) +

externalSubset ()

void        externalSubset                  (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);

+Callback on external subset declaration.

+ +

ctx : the user data (XML parser context) +
name : the root element name +
ExternalID : the external ID +
SystemID : the SYSTEM ID (e.g. filename or URL) +

getEntity ()

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

+Get an entity by name

+ +

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

getParameterEntity ()

xmlEntityPtr getParameterEntity             (void *ctx,
+                                             const xmlChar *name);

+Get a parameter entity by name

+ +

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

resolveEntity ()

xmlParserInputPtr resolveEntity             (void *ctx,
+                                             const xmlChar *publicId,
+                                             const xmlChar *systemId);

+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

+ +

ctx : the user data (XML parser context) +
publicId : The public ID of the entity +
systemId : The system ID of the entity +
Returns :the xmlParserInputPtr if inlined or NULL for DOM behaviour. +

entityDecl ()

void        entityDecl                      (void *ctx,
+                                             const xmlChar *name,
+                                             int type,
+                                             const xmlChar *publicId,
+                                             const xmlChar *systemId,
+                                             xmlChar *content);

+An entity definition has been parsed

+ +

ctx : the user data (XML parser context) +
name : the entity name +
type : the entity type +
publicId : The public ID of the entity +
systemId : The system ID of the entity +
content : the entity value (without processing). +

attributeDecl ()

void        attributeDecl                   (void *ctx,
+                                             const xmlChar *elem,
+                                             const xmlChar *fullname,
+                                             int type,
+                                             int def,
+                                             const xmlChar *defaultValue,
+                                             xmlEnumerationPtr tree);

+An attribute definition has been parsed

+ +

ctx : the user data (XML parser context) +
elem : the name of the element +
fullname : the attribute name +
type : the attribute type +
def : the type of default value +
defaultValue : the attribute default value +
tree : the tree of enumerated value set +

elementDecl ()

void        elementDecl                     (void *ctx,
+                                             const xmlChar *name,
+                                             int type,
+                                             xmlElementContentPtr content);

+An element definition has been parsed

+ +

ctx : the user data (XML parser context) +
name : the element name +
type : the element type +
content : the element value tree +

notationDecl ()

void        notationDecl                    (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *publicId,
+                                             const xmlChar *systemId);

+What to do when a notation declaration has been parsed.

+ +

ctx : the user data (XML parser context) +
name : The name of the notation +
publicId : The public ID of the entity +
systemId : The system ID of the entity +

unparsedEntityDecl ()

void        unparsedEntityDecl              (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *publicId,
+                                             const xmlChar *systemId,
+                                             const xmlChar *notationName);

+What to do when an unparsed entity declaration is parsed

+ +

ctx : the user data (XML parser context) +
name : The name of the entity +
publicId : The public ID of the entity +
systemId : The system ID of the entity +
notationName : the name of the notation +

startDocument ()

void        startDocument                   (void *ctx);

+called when the document start being processed.

+ +

ctx : the user data (XML parser context) +

endDocument ()

void        endDocument                     (void *ctx);

+called when the document end has been detected.

+ +

ctx : the user data (XML parser context) +

attribute ()

void        attribute                       (void *ctx,
+                                             const xmlChar *fullname,
+                                             const xmlChar *value);

+Handle an attribute that has been read by the parser. +The default handling is to convert the attribute into an +DOM subtree and past it in a new xmlAttr element added to +the element.

+ +

ctx : the user data (XML parser context) +
fullname : The attribute name, including namespace prefix +
value : The attribute value +

startElement ()

void        startElement                    (void *ctx,
+                                             const xmlChar *fullname,
+                                             const xmlChar **atts);

+called when an opening tag has been processed.

+ +

ctx : the user data (XML parser context) +
fullname : The element name, including namespace prefix +
atts : An array of name/value attributes pairs, NULL terminated +

endElement ()

void        endElement                      (void *ctx,
+                                             const xmlChar *name);

+called when the end of an element has been detected.

+ +

ctx : the user data (XML parser context) +
name : The element name +

reference ()

void        reference                       (void *ctx,
+                                             const xmlChar *name);

+called when an entity reference is detected.

+ +

ctx : the user data (XML parser context) +
name : The entity name +

characters ()

void        characters                      (void *ctx,
+                                             const xmlChar *ch,
+                                             int len);

+receiving some chars from the parser.

+ +

ctx : the user data (XML parser context) +
ch : a xmlChar string +
len : the number of xmlChar +

ignorableWhitespace ()

void        ignorableWhitespace             (void *ctx,
+                                             const xmlChar *ch,
+                                             int len);

+receiving some ignorable whitespaces from the parser. +UNUSED: by default the DOM building will use characters

+ +

ctx : the user data (XML parser context) +
ch : a xmlChar string +
len : the number of xmlChar +

processingInstruction ()

void        processingInstruction           (void *ctx,
+                                             const xmlChar *target,
+                                             const xmlChar *data);

+A processing instruction has been parsed.

+ +

ctx : the user data (XML parser context) +
target : the target name +
data : the PI data's +

globalNamespace ()

void        globalNamespace                 (void *ctx,
+                                             const xmlChar *href,
+                                             const xmlChar *prefix);

+An old global namespace has been parsed.

+ +

ctx : the user data (XML parser context) +
href : the namespace associated URN +
prefix : the namespace prefix +

setNamespace ()

void        setNamespace                    (void *ctx,
+                                             const xmlChar *name);

+Set the current element namespace.

+ +

ctx : the user data (XML parser context) +
name : the namespace prefix +

getNamespace ()

xmlNsPtr    getNamespace                    (void *ctx);

+Get the current element namespace.

+ +

ctx : the user data (XML parser context) +
Returns :the xmlNsPtr or NULL if none +

checkNamespace ()

int         checkNamespace                  (void *ctx,
+                                             xmlChar *nameSpace);

+Check that the current element namespace is the same as the +one read upon parsing.

+ +

ctx : the user data (XML parser context) +
nameSpace : the namespace to check against +
Returns :1 if true 0 otherwise +

namespaceDecl ()

void        namespaceDecl                   (void *ctx,
+                                             const xmlChar *href,
+                                             const xmlChar *prefix);

+A namespace has been parsed.

+ +

ctx : the user data (XML parser context) +
href : the namespace associated URN +
prefix : the namespace prefix +

comment ()

void        comment                         (void *ctx,
+                                             const xmlChar *value);

+A comment has been parsed.

+ +

ctx : the user data (XML parser context) +
value : the comment content +

cdataBlock ()

void        cdataBlock                      (void *ctx,
+                                             const xmlChar *value,
+                                             int len);

+called when a pcdata block has been parsed

+ +

ctx : the user data (XML parser context) +
value : The pcdata content +
len : the block length +

initxmlDefaultSAXHandler ()

void        initxmlDefaultSAXHandler        (xmlSAXHandler *hdlr,
+                                             int warning);

+Initialize the default XML SAX handler

+ +

hdlr : the SAX handler +
warning : flag if non-zero sets the handler warning procedure +

inithtmlDefaultSAXHandler ()

void        inithtmlDefaultSAXHandler       (xmlSAXHandler *hdlr);

+Initialize the default HTML SAX handler

+ +

hdlr : the SAX handler +

initdocbDefaultSAXHandler ()

void        initdocbDefaultSAXHandler       (xmlSAXHandler *hdlr);

+Initialize the default DocBook SAX handler

+ +

hdlr : the SAX handler +

xmlDefaultSAXHandlerInit ()

void        xmlDefaultSAXHandlerInit        (void);

+Initialize the default SAX handler

+ +

htmlDefaultSAXHandlerInit ()

void        htmlDefaultSAXHandlerInit       (void);

+Initialize the default SAX handler

+ +

docbDefaultSAXHandlerInit ()

void        docbDefaultSAXHandlerInit       (void);

+Initialize the default SAX handler

+ +

<< xmlreadertree >>
diff --git a/doc/html/libxml-c14n.html b/doc/html/libxml-c14n.html index ea88a4b9..4cf9669e 100644 --- a/doc/html/libxml-c14n.html +++ b/doc/html/libxml-c14n.html @@ -1,1275 +1,179 @@ -c14n
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

c14n

Name

c14n -- 

Synopsis


+
+c14n
PrevUpHomeGnome XML Library Reference ManualNext
c14n
c14n — 
Synopsis
 
-int         xmlC14NDocSaveTo                (xmlDocPtr doc,
-                                             xmlNodeSetPtr nodes,
+
+
+int         xmlC14NDocSaveTo                (xmlDocPtr doc,
+                                             xmlNodeSetPtr nodes,
                                              int exclusive,
-                                             xmlChar **inclusive_ns_prefixes,
+                                             xmlChar **inclusive_ns_prefixes,
                                              int with_comments,
-                                             xmlOutputBufferPtr buf);
-int         xmlC14NDocDumpMemory            (xmlDocPtr doc,
-                                             xmlNodeSetPtr nodes,
+                                             xmlOutputBufferPtr buf);
+int         xmlC14NDocDumpMemory            (xmlDocPtr doc,
+                                             xmlNodeSetPtr nodes,
                                              int exclusive,
-                                             xmlChar **inclusive_ns_prefixes,
+                                             xmlChar **inclusive_ns_prefixes,
                                              int with_comments,
-                                             xmlChar **doc_txt_ptr);
-int         xmlC14NDocSave                  (xmlDocPtr doc,
-                                             xmlNodeSetPtr nodes,
+                                             xmlChar **doc_txt_ptr);
+int         xmlC14NDocSave                  (xmlDocPtr doc,
+                                             xmlNodeSetPtr nodes,
                                              int exclusive,
-                                             xmlChar **inclusive_ns_prefixes,
+                                             xmlChar **inclusive_ns_prefixes,
                                              int with_comments,
                                              const char *filename,
                                              int compression);
-int         (*xmlC14NIsVisibleCallback)     (void *user_data,
-                                             xmlNodePtr node,
-                                             xmlNodePtr parent);
-int         xmlC14NExecute                  (xmlDocPtr doc,
-                                             xmlC14NIsVisibleCallback is_visible_callback,
+int         (*xmlC14NIsVisibleCallback)     (void *user_data,
+                                             xmlNodePtr node,
+                                             xmlNodePtr parent);
+int         xmlC14NExecute                  (xmlDocPtr doc,
+                                             xmlC14NIsVisibleCallback is_visible_callback,
                                              void *user_data,
                                              int exclusive,
-                                             xmlChar **inclusive_ns_prefixes,
+                                             xmlChar **inclusive_ns_prefixes,
                                              int with_comments,
-                                             xmlOutputBufferPtr buf);

Description

Details

xmlC14NDocSaveTo ()

int         xmlC14NDocSaveTo                (xmlDocPtr doc,
-                                             xmlNodeSetPtr nodes,
+                                             xmlOutputBufferPtr buf);
+

Description

+ +

Details

xmlC14NDocSaveTo ()

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

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

doc : 
nodes : 
exclusive : 
inclusive_ns_prefixes : 
with_comments : 
buf : 
Returns : 

xmlC14NDocDumpMemory ()

int         xmlC14NDocDumpMemory            (xmlDocPtr doc,
-                                             xmlNodeSetPtr nodes,
+                                             xmlOutputBufferPtr buf);

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

+ +

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

xmlC14NDocDumpMemory ()

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

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

doc : 
nodes : 
exclusive : 
inclusive_ns_prefixes : 
with_comments : 
doc_txt_ptr : 
Returns : 

xmlC14NDocSave ()

int         xmlC14NDocSave                  (xmlDocPtr doc,
-                                             xmlNodeSetPtr nodes,
+                                             xmlChar **doc_txt_ptr);

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

+ +

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

xmlC14NDocSave ()

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

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

doc : 
nodes : 
exclusive : 
inclusive_ns_prefixes : 
with_comments : 
filename : 
compression : 
Returns : 

xmlC14NIsVisibleCallback ()

int         (*xmlC14NIsVisibleCallback)     (void *user_data,
-                                             xmlNodePtr node,
-                                             xmlNodePtr parent);

user_data : 
node : 
parent : 
Returns : 

xmlC14NExecute ()

int         xmlC14NExecute                  (xmlDocPtr doc,
-                                             xmlC14NIsVisibleCallback is_visible_callback,
+                                             int compression);

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

+ +

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

xmlC14NIsVisibleCallback ()

int         (*xmlC14NIsVisibleCallback)     (void *user_data,
+                                             xmlNodePtr node,
+                                             xmlNodePtr parent);

+ +

user_data : +
node : +
parent : +
Returns : + + +

xmlC14NExecute ()

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

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

doc : 
is_visible_callback : 
user_data : 
exclusive : 
inclusive_ns_prefixes : 
with_comments : 
buf : 
Returns : 

\ No newline at end of file + xmlOutputBufferPtr buf);

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

+ +

doc : the XML document for canonization +
is_visible_callback :the function to use to determine is node visible + or not +
user_data : the first parameter for is_visible_callback function + (in most cases, it is nodes set) +
exclusive : the exclusive flag (0 - non-exclusive canonicalization; + otherwise - exclusive canonicalization) +
inclusive_ns_prefixes : the list of inclusive namespace prefixes + ended with a NULL or NULL if there is no + inclusive namespaces (only for exclusive + canonicalization, ignored otherwise) +
with_comments : include comments in the result (!=0) or not (==0) +
buf : the output buffer to store canonical XML; this + buffer MUST have encoder==NULL because C14N requires + UTF-8 output +
Returns :non-negative value on success or a negative value on fail +
<< catalogthreads >>
diff --git a/doc/html/libxml-catalog.html b/doc/html/libxml-catalog.html index 98c739c2..589f1518 100644 --- a/doc/html/libxml-catalog.html +++ b/doc/html/libxml-catalog.html @@ -1,4016 +1,363 @@ -catalog
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

catalog

Name

catalog -- 

Synopsis


+
+catalog
PrevUpHomeGnome XML Library Reference ManualNext
catalog
catalog — 
Synopsis
 
-#define     XML_CATALOGS_NAMESPACE
-#define     XML_CATALOG_PI
-enum        xmlCatalogPrefer;
-enum        xmlCatalogAllow;
-struct      xmlCatalog;
-typedef     xmlCatalogPtr;
-xmlCatalogPtr xmlNewCatalog                 (int sgml);
-xmlCatalogPtr xmlLoadACatalog               (const char *filename);
-xmlCatalogPtr xmlLoadSGMLSuperCatalog       (const char *filename);
-int         xmlConvertSGMLCatalog           (xmlCatalogPtr catal);
-int         xmlACatalogAdd                  (xmlCatalogPtr catal,
-                                             const xmlChar *type,
-                                             const xmlChar *orig,
-                                             const xmlChar *replace);
-int         xmlACatalogRemove               (xmlCatalogPtr catal,
-                                             const xmlChar *value);
-xmlChar*    xmlACatalogResolve              (xmlCatalogPtr catal,
-                                             const xmlChar *pubID,
-                                             const xmlChar *sysID);
-xmlChar*    xmlACatalogResolveSystem        (xmlCatalogPtr catal,
-                                             const xmlChar *sysID);
-xmlChar*    xmlACatalogResolvePublic        (xmlCatalogPtr catal,
-                                             const xmlChar *pubID);
-xmlChar*    xmlACatalogResolveURI           (xmlCatalogPtr catal,
-                                             const xmlChar *URI);
-void        xmlACatalogDump                 (xmlCatalogPtr catal,
-                                             FILE *out);
-void        xmlFreeCatalog                  (xmlCatalogPtr catal);
-int         xmlCatalogIsEmpty               (xmlCatalogPtr catal);
-void        xmlInitializeCatalog            (void);
-int         xmlLoadCatalog                  (const char *filename);
-void        xmlLoadCatalogs                 (const char *paths);
-void        xmlCatalogCleanup               (void);
-void        xmlCatalogDump                  (FILE *out);
-xmlChar*    xmlCatalogResolve               (const xmlChar *pubID,
-                                             const xmlChar *sysID);
-xmlChar*    xmlCatalogResolveSystem         (const xmlChar *sysID);
-xmlChar*    xmlCatalogResolvePublic         (const xmlChar *pubID);
-xmlChar*    xmlCatalogResolveURI            (const xmlChar *URI);
-int         xmlCatalogAdd                   (const xmlChar *type,
-                                             const xmlChar *orig,
-                                             const xmlChar *replace);
-int         xmlCatalogRemove                (const xmlChar *value);
-xmlDocPtr   xmlParseCatalogFile             (const char *filename);
-int         xmlCatalogConvert               (void);
-void        xmlCatalogFreeLocal             (void *catalogs);
-void*       xmlCatalogAddLocal              (void *catalogs,
-                                             const xmlChar *URL);
-xmlChar*    xmlCatalogLocalResolve          (void *catalogs,
-                                             const xmlChar *pubID,
-                                             const xmlChar *sysID);
-xmlChar*    xmlCatalogLocalResolveURI       (void *catalogs,
-                                             const xmlChar *URI);
-int         xmlCatalogSetDebug              (int level);
-xmlCatalogPrefer xmlCatalogSetDefaultPrefer (xmlCatalogPrefer prefer);
-void        xmlCatalogSetDefaults           (xmlCatalogAllow allow);
-xmlCatalogAllow xmlCatalogGetDefaults       (void);
-const xmlChar* xmlCatalogGetSystem          (const xmlChar *sysID);
-const xmlChar* xmlCatalogGetPublic          (const xmlChar *pubID);

Description

Details

XML_CATALOGS_NAMESPACE

#define     XML_CATALOGS_NAMESPACE

The namespace for the XML Catalogs elements.

XML_CATALOG_PI

#define     XML_CATALOG_PI

The specific XML Catalog Processing Instuction name.

enum xmlCatalogPrefer

typedef enum {
+
+
+#define     XML_CATALOGS_NAMESPACE
+#define     XML_CATALOG_PI
+enum        xmlCatalogPrefer;
+enum        xmlCatalogAllow;
+struct      xmlCatalog;
+typedef     xmlCatalogPtr;
+xmlCatalogPtr xmlNewCatalog                 (int sgml);
+xmlCatalogPtr xmlLoadACatalog               (const char *filename);
+xmlCatalogPtr xmlLoadSGMLSuperCatalog       (const char *filename);
+int         xmlConvertSGMLCatalog           (xmlCatalogPtr catal);
+int         xmlACatalogAdd                  (xmlCatalogPtr catal,
+                                             const xmlChar *type,
+                                             const xmlChar *orig,
+                                             const xmlChar *replace);
+int         xmlACatalogRemove               (xmlCatalogPtr catal,
+                                             const xmlChar *value);
+xmlChar*    xmlACatalogResolve              (xmlCatalogPtr catal,
+                                             const xmlChar *pubID,
+                                             const xmlChar *sysID);
+xmlChar*    xmlACatalogResolveSystem        (xmlCatalogPtr catal,
+                                             const xmlChar *sysID);
+xmlChar*    xmlACatalogResolvePublic        (xmlCatalogPtr catal,
+                                             const xmlChar *pubID);
+xmlChar*    xmlACatalogResolveURI           (xmlCatalogPtr catal,
+                                             const xmlChar *URI);
+void        xmlACatalogDump                 (xmlCatalogPtr catal,
+                                             FILE *out);
+void        xmlFreeCatalog                  (xmlCatalogPtr catal);
+int         xmlCatalogIsEmpty               (xmlCatalogPtr catal);
+void        xmlInitializeCatalog            (void);
+int         xmlLoadCatalog                  (const char *filename);
+void        xmlLoadCatalogs                 (const char *paths);
+void        xmlCatalogCleanup               (void);
+void        xmlCatalogDump                  (FILE *out);
+xmlChar*    xmlCatalogResolve               (const xmlChar *pubID,
+                                             const xmlChar *sysID);
+xmlChar*    xmlCatalogResolveSystem         (const xmlChar *sysID);
+xmlChar*    xmlCatalogResolvePublic         (const xmlChar *pubID);
+xmlChar*    xmlCatalogResolveURI            (const xmlChar *URI);
+int         xmlCatalogAdd                   (const xmlChar *type,
+                                             const xmlChar *orig,
+                                             const xmlChar *replace);
+int         xmlCatalogRemove                (const xmlChar *value);
+xmlDocPtr   xmlParseCatalogFile             (const char *filename);
+int         xmlCatalogConvert               (void);
+void        xmlCatalogFreeLocal             (void *catalogs);
+void*       xmlCatalogAddLocal              (void *catalogs,
+                                             const xmlChar *URL);
+xmlChar*    xmlCatalogLocalResolve          (void *catalogs,
+                                             const xmlChar *pubID,
+                                             const xmlChar *sysID);
+xmlChar*    xmlCatalogLocalResolveURI       (void *catalogs,
+                                             const xmlChar *URI);
+int         xmlCatalogSetDebug              (int level);
+xmlCatalogPrefer xmlCatalogSetDefaultPrefer (xmlCatalogPrefer prefer);
+void        xmlCatalogSetDefaults           (xmlCatalogAllow allow);
+xmlCatalogAllow xmlCatalogGetDefaults       (void);
+const xmlChar* xmlCatalogGetSystem          (const xmlChar *sysID);
+const xmlChar* xmlCatalogGetPublic          (const xmlChar *pubID);
+

Description

+ +

Details

XML_CATALOGS_NAMESPACE

#define     XML_CATALOGS_NAMESPACE

+The namespace for the XML Catalogs elements.

+ +

XML_CATALOG_PI

#define     XML_CATALOG_PI

+The specific XML Catalog Processing Instuction name.

+ +

enum xmlCatalogPrefer

typedef enum {
     XML_CATA_PREFER_NONE = 0,
     XML_CATA_PREFER_PUBLIC = 1,
     XML_CATA_PREFER_SYSTEM
-} xmlCatalogPrefer;

enum xmlCatalogAllow

typedef enum {
+} xmlCatalogPrefer;
+

+ +

enum xmlCatalogAllow

typedef enum {
     XML_CATA_ALLOW_NONE = 0,
     XML_CATA_ALLOW_GLOBAL = 1,
     XML_CATA_ALLOW_DOCUMENT = 2,
     XML_CATA_ALLOW_ALL = 3
-} xmlCatalogAllow;

struct xmlCatalog

struct xmlCatalog;

xmlCatalogPtr

xmlNewCatalog ()

xmlCatalogPtr xmlNewCatalog                 (int sgml);

create a new Catalog.

sgml : 
Returns : 

xmlLoadACatalog ()

xmlCatalogPtr xmlLoadACatalog               (const char *filename);

Load the catalog and build the associated data structures. +} xmlCatalogAllow; +

+ +

struct xmlCatalog

struct xmlCatalog;

+ +

xmlCatalogPtr

typedef xmlCatalog *xmlCatalogPtr;
+

+ +

xmlNewCatalog ()

xmlCatalogPtr xmlNewCatalog                 (int sgml);

+create a new Catalog.

+ +

sgml : should this create an SGML catalog +
Returns :the xmlCatalogPtr or NULL in case of error +

xmlLoadACatalog ()

xmlCatalogPtr xmlLoadACatalog               (const char *filename);

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

filename : 
Returns : 

xmlLoadSGMLSuperCatalog ()

xmlCatalogPtr xmlLoadSGMLSuperCatalog       (const char *filename);

Load an SGML super catalog. It won't expand CATALOG or DELEGATE +Catalogs are not handled recursively.

+ +

filename : a file path +
Returns :the catalog parsed or NULL in case of error +

xmlLoadSGMLSuperCatalog ()

xmlCatalogPtr xmlLoadSGMLSuperCatalog       (const char *filename);

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

filename : 
Returns : 

xmlConvertSGMLCatalog ()

int         xmlConvertSGMLCatalog           (xmlCatalogPtr catal);

Convert all the SGML catalog entries as XML ones

catal : 
Returns : 

xmlACatalogAdd ()

int         xmlACatalogAdd                  (xmlCatalogPtr catal,
-                                             const xmlChar *type,
-                                             const xmlChar *orig,
-                                             const xmlChar *replace);

Add an entry in the catalog, it may overwrite existing but -different entries.

catal : 
type : 
orig : 
replace : 
Returns : 

xmlACatalogRemove ()

int         xmlACatalogRemove               (xmlCatalogPtr catal,
-                                             const xmlChar *value);

Remove an entry from the catalog

catal : 
value : 
Returns : 

xmlACatalogResolve ()

xmlChar*    xmlACatalogResolve              (xmlCatalogPtr catal,
-                                             const xmlChar *pubID,
-                                             const xmlChar *sysID);

Do a complete resolution lookup of an External Identifier

catal : 
pubID : 
sysID : 
Returns : 

xmlACatalogResolveSystem ()

xmlChar*    xmlACatalogResolveSystem        (xmlCatalogPtr catal,
-                                             const xmlChar *sysID);

Try to lookup the catalog resource for a system ID

catal : 
sysID : 
Returns : 

xmlACatalogResolvePublic ()

xmlChar*    xmlACatalogResolvePublic        (xmlCatalogPtr catal,
-                                             const xmlChar *pubID);

Try to lookup the system ID associated to a public ID in that catalog

catal : 
pubID : 
Returns : 

xmlACatalogResolveURI ()

xmlChar*    xmlACatalogResolveURI           (xmlCatalogPtr catal,
-                                             const xmlChar *URI);

Do a complete resolution lookup of an URI

catal : 
URI : 
Returns : 

xmlACatalogDump ()

void        xmlACatalogDump                 (xmlCatalogPtr catal,
-                                             FILE *out);

Free up all the memory associated with catalogs

catal : 
out : 

xmlFreeCatalog ()

void        xmlFreeCatalog                  (xmlCatalogPtr catal);

Free the memory allocated to a Catalog

catal : 

xmlCatalogIsEmpty ()

int         xmlCatalogIsEmpty               (xmlCatalogPtr catal);

Check is a catalog is empty

catal : 
Returns : 

xmlInitializeCatalog ()

void        xmlInitializeCatalog            (void);

Do the catalog initialization. +like adding and removing CATALOG or DELEGATE entries.

+ +

filename : a file path +
Returns :the catalog parsed or NULL in case of error +

xmlConvertSGMLCatalog ()

int         xmlConvertSGMLCatalog           (xmlCatalogPtr catal);

+Convert all the SGML catalog entries as XML ones

+ +

catal : the catalog +
Returns :the number of entries converted if successful, -1 otherwise +

xmlACatalogAdd ()

int         xmlACatalogAdd                  (xmlCatalogPtr catal,
+                                             const xmlChar *type,
+                                             const xmlChar *orig,
+                                             const xmlChar *replace);

+Add an entry in the catalog, it may overwrite existing but +different entries.

+ +

catal : a Catalog +
type : the type of record to add to the catalog +
orig : the system, public or prefix to match +
replace : the replacement value for the match +
Returns :0 if successful, -1 otherwise +

xmlACatalogRemove ()

int         xmlACatalogRemove               (xmlCatalogPtr catal,
+                                             const xmlChar *value);

+Remove an entry from the catalog

+ +

catal : a Catalog +
value : the value to remove +
Returns :the number of entries removed if successful, -1 otherwise +

xmlACatalogResolve ()

xmlChar*    xmlACatalogResolve              (xmlCatalogPtr catal,
+                                             const xmlChar *pubID,
+                                             const xmlChar *sysID);

+Do a complete resolution lookup of an External Identifier

+ +

catal : a Catalog +
pubID : the public ID string +
sysID : the system ID string +
Returns :the URI of the resource or NULL if not found, it must be freed + by the caller. +

xmlACatalogResolveSystem ()

xmlChar*    xmlACatalogResolveSystem        (xmlCatalogPtr catal,
+                                             const xmlChar *sysID);

+Try to lookup the catalog resource for a system ID

+ +

catal : a Catalog +
sysID : the public ID string +
Returns :the system ID if found or NULL otherwise, the value returned + must be freed by the caller. +

xmlACatalogResolvePublic ()

xmlChar*    xmlACatalogResolvePublic        (xmlCatalogPtr catal,
+                                             const xmlChar *pubID);

+Try to lookup the system ID associated to a public ID in that catalog

+ +

catal : a Catalog +
pubID : the public ID string +
Returns :the system ID if found or NULL otherwise, the value returned + must be freed by the caller. +

xmlACatalogResolveURI ()

xmlChar*    xmlACatalogResolveURI           (xmlCatalogPtr catal,
+                                             const xmlChar *URI);

+Do a complete resolution lookup of an URI

+ +

catal : a Catalog +
URI : the URI +
Returns :the URI of the resource or NULL if not found, it must be freed + by the caller. +

xmlACatalogDump ()

void        xmlACatalogDump                 (xmlCatalogPtr catal,
+                                             FILE *out);

+Free up all the memory associated with catalogs

+ +

catal : a Catalog +
out : the file. +

xmlFreeCatalog ()

void        xmlFreeCatalog                  (xmlCatalogPtr catal);

+Free the memory allocated to a Catalog

+ +

catal : a Catalog entry +

xmlCatalogIsEmpty ()

int         xmlCatalogIsEmpty               (xmlCatalogPtr catal);

+Check is a catalog is empty

+ +

catal : should this create an SGML catalog +
Returns :1 if the catalog is empty, 0 if not, amd -1 in case of error. +

xmlInitializeCatalog ()

void        xmlInitializeCatalog            (void);

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

xmlLoadCatalog ()

int         xmlLoadCatalog                  (const char *filename);

Load the catalog and makes its definitions effective for the default +preferably be done once at startup

+ +

xmlLoadCatalog ()

int         xmlLoadCatalog                  (const char *filename);

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

filename : 
Returns : 

xmlLoadCatalogs ()

void        xmlLoadCatalogs                 (const char *paths);

Load the catalogs and makes their definitions effective for the default +preferably be done once at startup

+ +

filename : a file path +
Returns :0 in case of success -1 in case of error +

xmlLoadCatalogs ()

void        xmlLoadCatalogs                 (const char *paths);

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

paths : 

xmlCatalogCleanup ()

void        xmlCatalogCleanup               (void);

Free up all the memory associated with catalogs

xmlCatalogDump ()

void        xmlCatalogDump                  (FILE *out);

Free up all the memory associated with catalogs

out : 

xmlCatalogResolve ()

xmlChar*    xmlCatalogResolve               (const xmlChar *pubID,
-                                             const xmlChar *sysID);

Do a complete resolution lookup of an External Identifier

pubID : 
sysID : 
Returns : 

xmlCatalogResolveSystem ()

xmlChar*    xmlCatalogResolveSystem         (const xmlChar *sysID);

Try to lookup the catalog resource for a system ID

sysID : 
Returns : 

xmlCatalogResolvePublic ()

xmlChar*    xmlCatalogResolvePublic         (const xmlChar *pubID);

Try to lookup the system ID associated to a public ID

pubID : 
Returns : 

xmlCatalogResolveURI ()

xmlChar*    xmlCatalogResolveURI            (const xmlChar *URI);

Do a complete resolution lookup of an URI

URI : 
Returns : 

xmlCatalogAdd ()

int         xmlCatalogAdd                   (const xmlChar *type,
-                                             const xmlChar *orig,
-                                             const xmlChar *replace);

Add an entry in the catalog, it may overwrite existing but +preferably be done once at startup

+ +

paths : + + +

xmlCatalogCleanup ()

void        xmlCatalogCleanup               (void);

+Free up all the memory associated with catalogs

+ +

xmlCatalogDump ()

void        xmlCatalogDump                  (FILE *out);

+Free up all the memory associated with catalogs

+ +

out : the file. +

xmlCatalogResolve ()

xmlChar*    xmlCatalogResolve               (const xmlChar *pubID,
+                                             const xmlChar *sysID);

+Do a complete resolution lookup of an External Identifier

+ +

pubID : the public ID string +
sysID : the system ID string +
Returns :the URI of the resource or NULL if not found, it must be freed + by the caller. +

xmlCatalogResolveSystem ()

xmlChar*    xmlCatalogResolveSystem         (const xmlChar *sysID);

+Try to lookup the catalog resource for a system ID

+ +

sysID : the public ID string +
Returns :the system ID if found or NULL otherwise, the value returned + must be freed by the caller. +

xmlCatalogResolvePublic ()

xmlChar*    xmlCatalogResolvePublic         (const xmlChar *pubID);

+Try to lookup the system ID associated to a public ID

+ +

pubID : the public ID string +
Returns :the system ID if found or NULL otherwise, the value returned + must be freed by the caller. +

xmlCatalogResolveURI ()

xmlChar*    xmlCatalogResolveURI            (const xmlChar *URI);

+Do a complete resolution lookup of an URI

+ +

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

xmlCatalogAdd ()

int         xmlCatalogAdd                   (const xmlChar *type,
+                                             const xmlChar *orig,
+                                             const xmlChar *replace);

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

type : 
orig : 
replace : 
Returns : 

xmlCatalogRemove ()

int         xmlCatalogRemove                (const xmlChar *value);

Remove an entry from the catalog

value : 
Returns : 

xmlParseCatalogFile ()

xmlDocPtr   xmlParseCatalogFile             (const char *filename);

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

filename : 
Returns : 

xmlCatalogConvert ()

int         xmlCatalogConvert               (void);

Convert all the SGML catalog entries as XML ones

Returns : 

xmlCatalogFreeLocal ()

void        xmlCatalogFreeLocal             (void *catalogs);

Free up the memory associated to the catalog list

catalogs : 

xmlCatalogAddLocal ()

void*       xmlCatalogAddLocal              (void *catalogs,
-                                             const xmlChar *URL);

Add the new entry to the catalog list

catalogs : 
URL : 

xmlCatalogLocalResolve ()

xmlChar*    xmlCatalogLocalResolve          (void *catalogs,
-                                             const xmlChar *pubID,
-                                             const xmlChar *sysID);

Do a complete resolution lookup of an External Identifier using a -document's private catalog list

catalogs : 
pubID : 
sysID : 
Returns : 

xmlCatalogLocalResolveURI ()

xmlChar*    xmlCatalogLocalResolveURI       (void *catalogs,
-                                             const xmlChar *URI);

Do a complete resolution lookup of an URI using a -document's private catalog list

catalogs : 
URI : 
Returns : 

xmlCatalogSetDebug ()

int         xmlCatalogSetDebug              (int level);

Used to set the debug level for catalog operation, 0 disable -debugging, 1 enable it

level : 
Returns : 

xmlCatalogSetDefaultPrefer ()

xmlCatalogPrefer xmlCatalogSetDefaultPrefer (xmlCatalogPrefer prefer);

Allows to set the preference between public and system for deletion +default shared catalog put in place by xmlInitializeCatalog();

+ +

type : the type of record to add to the catalog +
orig : the system, public or prefix to match +
replace : the replacement value for the match +
Returns :0 if successful, -1 otherwise +

xmlCatalogRemove ()

int         xmlCatalogRemove                (const xmlChar *value);

+Remove an entry from the catalog

+ +

value : the value to remove +
Returns :the number of entries removed if successful, -1 otherwise +

xmlParseCatalogFile ()

xmlDocPtr   xmlParseCatalogFile             (const char *filename);

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

+ +

filename : the filename +
Returns :the resulting document tree or NULL in case of error +

xmlCatalogConvert ()

int         xmlCatalogConvert               (void);

+Convert all the SGML catalog entries as XML ones

+ +

Returns :the number of entries converted if successful, -1 otherwise +

xmlCatalogFreeLocal ()

void        xmlCatalogFreeLocal             (void *catalogs);

+Free up the memory associated to the catalog list

+ +

catalogs : a document's list of catalogs +

xmlCatalogAddLocal ()

void*       xmlCatalogAddLocal              (void *catalogs,
+                                             const xmlChar *URL);

+Add the new entry to the catalog list

+ +

catalogs : a document's list of catalogs +
URL : the URL to a new local catalog +

xmlCatalogLocalResolve ()

xmlChar*    xmlCatalogLocalResolve          (void *catalogs,
+                                             const xmlChar *pubID,
+                                             const xmlChar *sysID);

+Do a complete resolution lookup of an External Identifier using a +document's private catalog list

+ +

catalogs : a document's list of catalogs +
pubID : the public ID string +
sysID : the system ID string +
Returns :the URI of the resource or NULL if not found, it must be freed + by the caller. +

xmlCatalogLocalResolveURI ()

xmlChar*    xmlCatalogLocalResolveURI       (void *catalogs,
+                                             const xmlChar *URI);

+Do a complete resolution lookup of an URI using a +document's private catalog list

+ +

catalogs : a document's list of catalogs +
URI : the URI +
Returns :the URI of the resource or NULL if not found, it must be freed + by the caller. +

xmlCatalogSetDebug ()

int         xmlCatalogSetDebug              (int level);

+Used to set the debug level for catalog operation, 0 disable +debugging, 1 enable it

+ +

level : the debug level of catalogs required +
Returns :the previous value of the catalog debugging level +

xmlCatalogSetDefaultPrefer ()

xmlCatalogPrefer xmlCatalogSetDefaultPrefer (xmlCatalogPrefer prefer);

+Allows to set the preference between public and system for deletion in XML Catalog resolution. C.f. section 4.1.1 of the spec -Values accepted are XML_CATA_PREFER_PUBLIC or XML_CATA_PREFER_SYSTEM

prefer : 
Returns : 

xmlCatalogSetDefaults ()

void        xmlCatalogSetDefaults           (xmlCatalogAllow allow);

Used to set the user preference w.r.t. to what catalogs should -be accepted

allow : 

xmlCatalogGetDefaults ()

xmlCatalogAllow xmlCatalogGetDefaults       (void);

Used to get the user preference w.r.t. to what catalogs should -be accepted

Returns : 

xmlCatalogGetSystem ()

const xmlChar* xmlCatalogGetSystem          (const xmlChar *sysID);

Try to lookup the system ID associated to a public ID -DEPRECATED, use xmlCatalogResolveSystem()

sysID : 
Returns : 

xmlCatalogGetPublic ()

const xmlChar* xmlCatalogGetPublic          (const xmlChar *pubID);

Try to lookup the system ID associated to a public ID -DEPRECATED, use xmlCatalogResolvePublic()

pubID : 
Returns : 

\ No newline at end of file +Values accepted are XML_CATA_PREFER_PUBLIC or XML_CATA_PREFER_SYSTEM

+ +

prefer : the default preference for delegation +
Returns :the previous value of the default preference for delegation +

xmlCatalogSetDefaults ()

void        xmlCatalogSetDefaults           (xmlCatalogAllow allow);

+Used to set the user preference w.r.t. to what catalogs should +be accepted

+ +

allow : what catalogs should be accepted +

xmlCatalogGetDefaults ()

xmlCatalogAllow xmlCatalogGetDefaults       (void);

+Used to get the user preference w.r.t. to what catalogs should +be accepted

+ +

Returns :the current xmlCatalogAllow value +

xmlCatalogGetSystem ()

const xmlChar* xmlCatalogGetSystem          (const xmlChar *sysID);

+Try to lookup the system ID associated to a public ID +DEPRECATED, use xmlCatalogResolveSystem()

+ +

sysID : the system ID string +
Returns :the system ID if found or NULL otherwise. +

xmlCatalogGetPublic ()

const xmlChar* xmlCatalogGetPublic          (const xmlChar *pubID);

+Try to lookup the system ID associated to a public ID +DEPRECATED, use xmlCatalogResolvePublic()

+ +

pubID : the public ID string +
Returns :the system ID if found or NULL otherwise. +
<< xmlIOc14n >>
diff --git a/doc/html/libxml-debugXML.html b/doc/html/libxml-debugXML.html new file mode 100644 index 00000000..8d9f6406 --- /dev/null +++ b/doc/html/libxml-debugXML.html @@ -0,0 +1,385 @@ + +debugXML
PrevUpHomeGnome XML Library Reference ManualNext

debugXML

debugXML —

Synopsis

+
+
+
+void        xmlDebugDumpString              (FILE *output,
+                                             const xmlChar *str);
+void        xmlDebugDumpAttr                (FILE *output,
+                                             xmlAttrPtr attr,
+                                             int depth);
+void        xmlDebugDumpAttrList            (FILE *output,
+                                             xmlAttrPtr attr,
+                                             int depth);
+void        xmlDebugDumpOneNode             (FILE *output,
+                                             xmlNodePtr node,
+                                             int depth);
+void        xmlDebugDumpNode                (FILE *output,
+                                             xmlNodePtr node,
+                                             int depth);
+void        xmlDebugDumpNodeList            (FILE *output,
+                                             xmlNodePtr node,
+                                             int depth);
+void        xmlDebugDumpDocumentHead        (FILE *output,
+                                             xmlDocPtr doc);
+void        xmlDebugDumpDocument            (FILE *output,
+                                             xmlDocPtr doc);
+void        xmlDebugDumpDTD                 (FILE *output,
+                                             xmlDtdPtr dtd);
+void        xmlDebugDumpEntities            (FILE *output,
+                                             xmlDocPtr doc);
+void        xmlLsOneNode                    (FILE *output,
+                                             xmlNodePtr node);
+int         xmlLsCountNode                  (xmlNodePtr node);
+char*       (*xmlShellReadlineFunc)         (char *prompt);
+struct      xmlShellCtxt;
+typedef     xmlShellCtxtPtr;
+int         (*xmlShellCmd)                  (xmlShellCtxtPtr ctxt,
+                                             char *arg,
+                                             xmlNodePtr node,
+                                             xmlNodePtr node2);
+void        xmlShellPrintXPathError         (int errorType,
+                                             const char *arg);
+void        xmlShellPrintNode               (xmlNodePtr node);
+void        xmlShellPrintXPathResult        (xmlXPathObjectPtr list);
+int         xmlShellList                    (xmlShellCtxtPtr ctxt,
+                                             char *arg,
+                                             xmlNodePtr node,
+                                             xmlNodePtr node2);
+int         xmlShellBase                    (xmlShellCtxtPtr ctxt,
+                                             char *arg,
+                                             xmlNodePtr node,
+                                             xmlNodePtr node2);
+int         xmlShellDir                     (xmlShellCtxtPtr ctxt,
+                                             char *arg,
+                                             xmlNodePtr node,
+                                             xmlNodePtr node2);
+int         xmlShellCat                     (xmlShellCtxtPtr ctxt,
+                                             char *arg,
+                                             xmlNodePtr node,
+                                             xmlNodePtr node2);
+int         xmlShellLoad                    (xmlShellCtxtPtr ctxt,
+                                             char *filename,
+                                             xmlNodePtr node,
+                                             xmlNodePtr node2);
+int         xmlShellWrite                   (xmlShellCtxtPtr ctxt,
+                                             char *filename,
+                                             xmlNodePtr node,
+                                             xmlNodePtr node2);
+int         xmlShellSave                    (xmlShellCtxtPtr ctxt,
+                                             char *filename,
+                                             xmlNodePtr node,
+                                             xmlNodePtr node2);
+int         xmlShellValidate                (xmlShellCtxtPtr ctxt,
+                                             char *dtd,
+                                             xmlNodePtr node,
+                                             xmlNodePtr node2);
+int         xmlShellDu                      (xmlShellCtxtPtr ctxt,
+                                             char *arg,
+                                             xmlNodePtr tree,
+                                             xmlNodePtr node2);
+int         xmlShellPwd                     (xmlShellCtxtPtr ctxt,
+                                             char *buffer,
+                                             xmlNodePtr node,
+                                             xmlNodePtr node2);
+void        xmlShell                        (xmlDocPtr doc,
+                                             char *filename,
+                                             xmlShellReadlineFunc input,
+                                             FILE *output);
+

Description

+ +

Details

xmlDebugDumpString ()

void        xmlDebugDumpString              (FILE *output,
+                                             const xmlChar *str);

+Dumps informations about the string, shorten it if necessary

+ +

output : the FILE * for the output +
str : the string +

xmlDebugDumpAttr ()

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

+Dumps debug information for the attribute

+ +

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

xmlDebugDumpAttrList ()

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

+Dumps debug information for the attribute list

+ +

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

xmlDebugDumpOneNode ()

void        xmlDebugDumpOneNode             (FILE *output,
+                                             xmlNodePtr node,
+                                             int depth);

+Dumps debug information for the element node, it is not recursive

+ +

output : the FILE * for the output +
node : the node +
depth : the indentation level. +

xmlDebugDumpNode ()

void        xmlDebugDumpNode                (FILE *output,
+                                             xmlNodePtr node,
+                                             int depth);

+Dumps debug information for the element node, it is recursive

+ +

output : the FILE * for the output +
node : the node +
depth : the indentation level. +

xmlDebugDumpNodeList ()

void        xmlDebugDumpNodeList            (FILE *output,
+                                             xmlNodePtr node,
+                                             int depth);

+Dumps debug information for the list of element node, it is recursive

+ +

output : the FILE * for the output +
node : the node list +
depth : the indentation level. +

xmlDebugDumpDocumentHead ()

void        xmlDebugDumpDocumentHead        (FILE *output,
+                                             xmlDocPtr doc);

+Dumps debug information cncerning the document, not recursive

+ +

output : the FILE * for the output +
doc : the document +

xmlDebugDumpDocument ()

void        xmlDebugDumpDocument            (FILE *output,
+                                             xmlDocPtr doc);

+Dumps debug information for the document, it's recursive

+ +

output : the FILE * for the output +
doc : the document +

xmlDebugDumpDTD ()

void        xmlDebugDumpDTD                 (FILE *output,
+                                             xmlDtdPtr dtd);

+Dumps debug information for the DTD

+ +

output : the FILE * for the output +
dtd : the DTD +

xmlDebugDumpEntities ()

void        xmlDebugDumpEntities            (FILE *output,
+                                             xmlDocPtr doc);

+Dumps debug information for all the entities in use by the document

+ +

output : the FILE * for the output +
doc : the document +

xmlLsOneNode ()

void        xmlLsOneNode                    (FILE *output,
+                                             xmlNodePtr node);

+Dump to output the type and name of node.

+ +

output : the FILE * for the output +
node : the node to dump +

xmlLsCountNode ()

int         xmlLsCountNode                  (xmlNodePtr node);

+Count the children of node.

+ +

node : the node to count +
Returns :the number of children of node. +

xmlShellReadlineFunc ()

char*       (*xmlShellReadlineFunc)         (char *prompt);

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

+ +

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

struct xmlShellCtxt

struct xmlShellCtxt {
+    char *filename;
+    xmlDocPtr doc;
+    xmlNodePtr node;
+    xmlXPathContextPtr pctxt;
+    int loaded;
+    FILE *output;
+    xmlShellReadlineFunc input;
+};
+

+A debugging shell context. +TODO: add the defined function tables.

+ +

xmlShellCtxtPtr

typedef xmlShellCtxt *xmlShellCtxtPtr;
+

+ +

xmlShellCmd ()

int         (*xmlShellCmd)                  (xmlShellCtxtPtr ctxt,
+                                             char *arg,
+                                             xmlNodePtr node,
+                                             xmlNodePtr node2);

+This is a generic signature for the XML shell functions.

+ +

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

xmlShellPrintXPathError ()

void        xmlShellPrintXPathError         (int errorType,
+                                             const char *arg);

+Print the xpath error to libxml default error channel

+ +

errorType : valid xpath error id +
arg : the argument that cause xpath to fail +

xmlShellPrintNode ()

void        xmlShellPrintNode               (xmlNodePtr node);

+Print node to the output FILE

+ +

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

xmlShellPrintXPathResult ()

void        xmlShellPrintXPathResult        (xmlXPathObjectPtr list);

+Prints result to the output FILE

+ +

list : a valid result generated by an xpath evaluation +

xmlShellList ()

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

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

+ +

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

xmlShellBase ()

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

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

+ +

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

xmlShellDir ()

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

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

+ +

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

xmlShellCat ()

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

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

+ +

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

xmlShellLoad ()

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

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

+ +

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

xmlShellWrite ()

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

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

+ +

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

xmlShellSave ()

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

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

+ +

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

xmlShellValidate ()

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

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

+ +

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

xmlShellDu ()

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

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

+ +

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

xmlShellPwd ()

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

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

+ +

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

xmlShell ()

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

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

+ +

doc : the initial document +
filename : the output buffer +
input : the line reading function +
output : the output FILE*, defaults to stdout if NULL +
<< hashxmlmemory >>
diff --git a/doc/html/libxml-encoding.html b/doc/html/libxml-encoding.html index e3ab8066..f40de133 100644 --- a/doc/html/libxml-encoding.html +++ b/doc/html/libxml-encoding.html @@ -1,442 +1,105 @@ -encoding
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

encoding

Name

encoding -- 

Synopsis


+
+encoding
PrevUpHomeGnome XML Library Reference ManualNext
encoding
encoding — 
Synopsis
 
-enum        xmlCharEncoding;
-int         (*xmlCharEncodingInputFunc)     (unsigned char *out,
+
+
+enum        xmlCharEncoding;
+int         (*xmlCharEncodingInputFunc)     (unsigned char *out,
                                              int *outlen,
                                              unsigned char *in,
                                              int *inlen);
-int         (*xmlCharEncodingOutputFunc)    (unsigned char *out,
+int         (*xmlCharEncodingOutputFunc)    (unsigned char *out,
                                              int *outlen,
                                              unsigned char *in,
                                              int *inlen);
-struct      xmlCharEncodingHandler;
-typedef     xmlCharEncodingHandlerPtr;
-void        xmlInitCharEncodingHandlers     (void);
-void        xmlCleanupCharEncodingHandlers  (void);
-void        xmlRegisterCharEncodingHandler  (xmlCharEncodingHandlerPtr handler);
-xmlCharEncodingHandlerPtr xmlGetCharEncodingHandler
-                                            (xmlCharEncoding enc);
-xmlCharEncodingHandlerPtr xmlFindCharEncodingHandler
+struct      xmlCharEncodingHandler;
+typedef     xmlCharEncodingHandlerPtr;
+void        xmlInitCharEncodingHandlers     (void);
+void        xmlCleanupCharEncodingHandlers  (void);
+void        xmlRegisterCharEncodingHandler  (xmlCharEncodingHandlerPtr handler);
+xmlCharEncodingHandlerPtr xmlGetCharEncodingHandler
+                                            (xmlCharEncoding enc);
+xmlCharEncodingHandlerPtr xmlFindCharEncodingHandler
                                             (const char *name);
-xmlCharEncodingHandlerPtr xmlNewCharEncodingHandler
+xmlCharEncodingHandlerPtr xmlNewCharEncodingHandler
                                             (const char *name,
-                                             xmlCharEncodingInputFunc input,
-                                             xmlCharEncodingOutputFunc output);
-int         xmlAddEncodingAlias             (const char *name,
+                                             xmlCharEncodingInputFunc input,
+                                             xmlCharEncodingOutputFunc output);
+int         xmlAddEncodingAlias             (const char *name,
                                              const char *alias);
-int         xmlDelEncodingAlias             (const char *alias);
-const char* xmlGetEncodingAlias             (const char *alias);
-void        xmlCleanupEncodingAliases       (void);
-xmlCharEncoding xmlParseCharEncoding        (const char *name);
-const char* xmlGetCharEncodingName          (xmlCharEncoding enc);
-xmlCharEncoding xmlDetectCharEncoding       (unsigned char *in,
+int         xmlDelEncodingAlias             (const char *alias);
+const char* xmlGetEncodingAlias             (const char *alias);
+void        xmlCleanupEncodingAliases       (void);
+xmlCharEncoding xmlParseCharEncoding        (const char *name);
+const char* xmlGetCharEncodingName          (xmlCharEncoding enc);
+xmlCharEncoding xmlDetectCharEncoding       (unsigned char *in,
                                              int len);
-int         xmlCharEncOutFunc               (xmlCharEncodingHandler *handler,
-                                             xmlBufferPtr out,
-                                             xmlBufferPtr in);
-int         xmlCharEncInFunc                (xmlCharEncodingHandler *handler,
-                                             xmlBufferPtr out,
-                                             xmlBufferPtr in);
-int         xmlCharEncFirstLine             (xmlCharEncodingHandler *handler,
-                                             xmlBufferPtr out,
-                                             xmlBufferPtr in);
-int         xmlCharEncCloseFunc             (xmlCharEncodingHandler *handler);
-int         UTF8Toisolat1                   (unsigned char *out,
+int         xmlCharEncOutFunc               (xmlCharEncodingHandler *handler,
+                                             xmlBufferPtr out,
+                                             xmlBufferPtr in);
+int         xmlCharEncInFunc                (xmlCharEncodingHandler *handler,
+                                             xmlBufferPtr out,
+                                             xmlBufferPtr in);
+int         xmlCharEncFirstLine             (xmlCharEncodingHandler *handler,
+                                             xmlBufferPtr out,
+                                             xmlBufferPtr in);
+int         xmlCharEncCloseFunc             (xmlCharEncodingHandler *handler);
+int         UTF8Toisolat1                   (unsigned char *out,
                                              int *outlen,
                                              unsigned char *in,
                                              int *inlen);
-int         isolat1ToUTF8                   (unsigned char *out,
+int         isolat1ToUTF8                   (unsigned char *out,
                                              int *outlen,
                                              unsigned char *in,
                                              int *inlen);
-int         xmlGetUTF8Char                  (unsigned char *utf,
+int         xmlGetUTF8Char                  (unsigned char *utf,
                                              int *len);
-int         xmlCheckUTF8                    (unsigned char *utf);
-int         xmlUTF8Strsize                  (const xmlChar *utf,
+int         xmlCheckUTF8                    (unsigned char *utf);
+int         xmlUTF8Strsize                  (const xmlChar *utf,
                                              int len);
-xmlChar*    xmlUTF8Strndup                  (const xmlChar *utf,
+xmlChar*    xmlUTF8Strndup                  (const xmlChar *utf,
                                              int len);
-xmlChar*    xmlUTF8Strpos                   (const xmlChar *utf,
+xmlChar*    xmlUTF8Strpos                   (const xmlChar *utf,
                                              int pos);
-int         xmlUTF8Strloc                   (const xmlChar *utf,
-                                             const xmlChar *utfchar);
-xmlChar*    xmlUTF8Strsub                   (const xmlChar *utf,
+int         xmlUTF8Strloc                   (const xmlChar *utf,
+                                             const xmlChar *utfchar);
+xmlChar*    xmlUTF8Strsub                   (const xmlChar *utf,
                                              int start,
                                              int len);
-int         xmlUTF8Strlen                   (const xmlChar *utf);

Description

Details

enum xmlCharEncoding

typedef enum {
+int         xmlUTF8Strlen                   (const xmlChar *utf);
+

Description

+ +

Details

enum xmlCharEncoding

typedef enum {
     XML_CHAR_ENCODING_ERROR=   -1, /* No char encoding detected */
     XML_CHAR_ENCODING_NONE=	0, /* No char encoding detected */
     XML_CHAR_ENCODING_UTF8=	1, /* UTF-8 */
@@ -461,16 +124,13 @@ CLASS="PROGRAMLISTING"
     XML_CHAR_ENCODING_SHIFT_JIS=20,/* Shift_JIS */
     XML_CHAR_ENCODING_EUC_JP=   21,/* EUC-JP */
     XML_CHAR_ENCODING_ASCII=    22 /* pure ASCII */
-} xmlCharEncoding;

Predefined values for some standard encodings. +} xmlCharEncoding; +

+Predefined values for some standard encodings. Libxml don't do beforehand translation on UTF8, ISOLatinX. -It also support UTF16 (LE and BE) by default.

Anything else would have to be translated to UTF8 before being +It also support UTF16 (LE and BE) by default. +

+Anything else would have to be translated to UTF8 before being given to the parser itself. The BOM for UTF16 and the encoding declaration are looked at and a converter is looked for at that point. If not found the parser stops here as asked by the XML REC @@ -479,308 +139,43 @@ but the current form doesn't allow stateful transcoding (a serious problem agreed !). If iconv has been found it will be used automatically and allow stateful transcoding, the simplest is then to be sure to enable icon and to provide iconv libs for the encoding -support needed.

xmlCharEncodingInputFunc ()

int         (*xmlCharEncodingInputFunc)     (unsigned char *out,
+support needed.

+
+
xmlCharEncodingInputFunc ()
int         (*xmlCharEncodingInputFunc)     (unsigned char *out,
                                              int *outlen,
                                              unsigned char *in,
-                                             int *inlen);

Take a block of chars in the original encoding and try to convert -it to an UTF-8 block of chars out.

out : 
outlen : 
in : 
inlen : 
Returns : 

xmlCharEncodingOutputFunc ()

int         (*xmlCharEncodingOutputFunc)    (unsigned char *out,
+                                             int *inlen);

+Take a block of chars in the original encoding and try to convert +it to an UTF-8 block of chars out.

+ +

out : a pointer to an array of bytes to store the UTF-8 result +
outlen : the length of out +
in : a pointer to an array of chars in the original encoding +
inlen : the length of in +
Returns :the number of byte written, or -1 by lack of space, or -2 + if the transcoding failed. +The value of inlen after return is the number of octets consumed + as the return value is positive, else unpredictiable. +The value of outlen after return is the number of octets consumed. +

xmlCharEncodingOutputFunc ()

int         (*xmlCharEncodingOutputFunc)    (unsigned char *out,
                                              int *outlen,
                                              unsigned char *in,
-                                             int *inlen);

Take a block of UTF-8 chars in and try to convert it to an other + int *inlen);

+Take a block of UTF-8 chars in and try to convert it to an other encoding. Note: a first call designed to produce heading info is called with -in = NULL. If stateful this should also initialize the encoder state.

out : 
outlen : 
in : 
inlen : 
Returns : 

struct xmlCharEncodingHandler

struct xmlCharEncodingHandler {
+in = NULL. If stateful this should also initialize the encoder state.

+
+
out :  a pointer to an array of bytes to store the result
+
outlen :  the length of out
+
in :  a pointer to an array of UTF-8 chars
+
inlen :  the length of in
+
Returns :the number of byte written, or -1 by lack of space, or -2
+    if the transcoding failed.
+The value of inlen after return is the number of octets consumed
+    as the return value is positive, else unpredictiable.
+The value of outlen after return is the number of ocetes consumed.
+
struct xmlCharEncodingHandler
struct xmlCharEncodingHandler {
     char                       *name;
     xmlCharEncodingInputFunc   input;
     xmlCharEncodingOutputFunc  output;
@@ -788,2758 +183,234 @@ CLASS="PROGRAMLISTING"
     iconv_t                    iconv_in;
     iconv_t                    iconv_out;
 #endif /* LIBXML_ICONV_ENABLED */
-};

xmlCharEncodingHandlerPtr

xmlInitCharEncodingHandlers ()

void        xmlInitCharEncodingHandlers     (void);

Initialize the char encoding support, it registers the default +}; +

+ +

xmlCharEncodingHandlerPtr

typedef xmlCharEncodingHandler *xmlCharEncodingHandlerPtr;
+

+ +

xmlInitCharEncodingHandlers ()

void        xmlInitCharEncodingHandlers     (void);

+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.

xmlCleanupCharEncodingHandlers ()

void        xmlCleanupCharEncodingHandlers  (void);

Cleanup the memory allocated for the char encoding support, it -unregisters all the encoding handlers and the aliases.

xmlRegisterCharEncodingHandler ()

void        xmlRegisterCharEncodingHandler  (xmlCharEncodingHandlerPtr handler);

Register the char encoding handler, surprising, isn't it ?

handler : 

xmlGetCharEncodingHandler ()

xmlCharEncodingHandlerPtr xmlGetCharEncodingHandler
-                                            (xmlCharEncoding enc);

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

enc : 
Returns : 

xmlFindCharEncodingHandler ()

xmlCharEncodingHandlerPtr xmlFindCharEncodingHandler
-                                            (const char *name);

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

name : 
Returns : 

xmlNewCharEncodingHandler ()

xmlCharEncodingHandlerPtr xmlNewCharEncodingHandler
+      in normal processing.

+
+
xmlCleanupCharEncodingHandlers ()
void        xmlCleanupCharEncodingHandlers  (void);

+Cleanup the memory allocated for the char encoding support, it
+unregisters all the encoding handlers and the aliases.

+
+
xmlRegisterCharEncodingHandler ()
void        xmlRegisterCharEncodingHandler  (xmlCharEncodingHandlerPtr handler);

+Register the char encoding handler, surprising, isn't it ?

+
+
handler :  the xmlCharEncodingHandlerPtr handler block
+
xmlGetCharEncodingHandler ()
xmlCharEncodingHandlerPtr xmlGetCharEncodingHandler
+                                            (xmlCharEncoding enc);

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

+
+
enc :  an xmlCharEncoding value.
+
Returns :the handler or NULL if not found
+
xmlFindCharEncodingHandler ()
xmlCharEncodingHandlerPtr xmlFindCharEncodingHandler
+                                            (const char *name);

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

+
+
name :  a string describing the char encoding.
+
Returns :the handler or NULL if not found
+
xmlNewCharEncodingHandler ()
xmlCharEncodingHandlerPtr xmlNewCharEncodingHandler
                                             (const char *name,
-                                             xmlCharEncodingInputFunc input,
-                                             xmlCharEncodingOutputFunc output);

Create and registers an xmlCharEncodingHandler.

name : 
input : 
output : 
Returns : 

xmlAddEncodingAlias ()

int         xmlAddEncodingAlias             (const char *name,
-                                             const char *alias);

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

name : 
alias : 
Returns : 

xmlDelEncodingAlias ()

int         xmlDelEncodingAlias             (const char *alias);

Unregisters an encoding alias alias

alias : 
Returns : 

xmlGetEncodingAlias ()

const char* xmlGetEncodingAlias             (const char *alias);

Lookup an encoding name for the given alias.

alias : 
Returns : 

xmlCleanupEncodingAliases ()

void        xmlCleanupEncodingAliases       (void);

Unregisters all aliases

xmlParseCharEncoding ()

xmlCharEncoding xmlParseCharEncoding        (const char *name);

Compare the string to the known encoding schemes already known. Note + xmlCharEncodingInputFunc input, + xmlCharEncodingOutputFunc output);

+Create and registers an xmlCharEncodingHandler.

+ +

name : the encoding name, in UTF-8 format (ASCII actually) +
input : the xmlCharEncodingInputFunc to read that encoding +
output : the xmlCharEncodingOutputFunc to write that encoding +
Returns :the xmlCharEncodingHandlerPtr created (or NULL in case of error). +

xmlAddEncodingAlias ()

int         xmlAddEncodingAlias             (const char *name,
+                                             const char *alias);

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

+ +

name : the encoding name as parsed, in UTF-8 format (ASCII actually) +
alias : the alias name as parsed, in UTF-8 format (ASCII actually) +
Returns :0 in case of success, -1 in case of error +

xmlDelEncodingAlias ()

int         xmlDelEncodingAlias             (const char *alias);

+Unregisters an encoding alias alias

+ +

alias : the alias name as parsed, in UTF-8 format (ASCII actually) +
Returns :0 in case of success, -1 in case of error +

xmlGetEncodingAlias ()

const char* xmlGetEncodingAlias             (const char *alias);

+Lookup an encoding name for the given alias.

+ +

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

xmlCleanupEncodingAliases ()

void        xmlCleanupEncodingAliases       (void);

+Unregisters all aliases

+ +

xmlParseCharEncoding ()

xmlCharEncoding xmlParseCharEncoding        (const char *name);

+Compare the string to the known encoding schemes already known. Note that the comparison is case insensitive accordingly to the section -[XML] 4.3.3 Character Encoding in Entities.

name : 
Returns : 

xmlGetCharEncodingName ()

const char* xmlGetCharEncodingName          (xmlCharEncoding enc);

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

enc : 
Returns : 

xmlDetectCharEncoding ()

xmlCharEncoding xmlDetectCharEncoding       (unsigned char *in,
-                                             int len);

Guess the encoding of the entity using the first bytes of the entity content -accordingly of the non-normative appendix F of the XML-1.0 recommendation.

in : 
len : 
Returns : 

xmlCharEncOutFunc ()

int         xmlCharEncOutFunc               (xmlCharEncodingHandler *handler,
-                                             xmlBufferPtr out,
-                                             xmlBufferPtr in);

Generic front-end for the encoding handler output function -a first call with in == NULL has to be made firs to initiate the +[XML] 4.3.3 Character Encoding in Entities.

+ +

name : the encoding name as parsed, in UTF-8 format (ASCII actually) +
Returns :one of the XML_CHAR_ENCODING_... values or XML_CHAR_ENCODING_NONE +if not recognized. +

xmlGetCharEncodingName ()

const char* xmlGetCharEncodingName          (xmlCharEncoding enc);

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

+ +

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

xmlDetectCharEncoding ()

xmlCharEncoding xmlDetectCharEncoding       (unsigned char *in,
+                                             int len);

+Guess the encoding of the entity using the first bytes of the entity content +accordingly of the non-normative appendix F of the XML-1.0 recommendation.

+ +

in : a pointer to the first bytes of the XML entity, must be at least + 4 bytes long. +
len : pointer to the length of the buffer +
Returns :one of the XML_CHAR_ENCODING_... values. +

xmlCharEncOutFunc ()

int         xmlCharEncOutFunc               (xmlCharEncodingHandler *handler,
+                                             xmlBufferPtr out,
+                                             xmlBufferPtr in);

+Generic front-end for the encoding handler output function +a first call with in == NULL has to be made firs to initiate the output in case of non-stateless encoding needing to initiate their state or the output (like the BOM in UTF16). In case of UTF8 sequence conversion errors for the given encoder, -the content will be automatically remapped to a CharRef sequence.

handler : 
out : 
in : 
Returns : 

xmlCharEncInFunc ()

int         xmlCharEncInFunc                (xmlCharEncodingHandler *handler,
-                                             xmlBufferPtr out,
-                                             xmlBufferPtr in);

Generic front-end for the encoding handler input function

handler : 
out : 
in : 
Returns : 

xmlCharEncFirstLine ()

int         xmlCharEncFirstLine             (xmlCharEncodingHandler *handler,
-                                             xmlBufferPtr out,
-                                             xmlBufferPtr in);

Front-end for the encoding handler input function, but handle only -the very first line, i.e. limit itself to 45 chars.

handler : 
out : 
in : 
Returns : 

xmlCharEncCloseFunc ()

int         xmlCharEncCloseFunc             (xmlCharEncodingHandler *handler);

Generic front-end for encoding handler close function

handler : 
Returns : 

UTF8Toisolat1 ()

int         UTF8Toisolat1                   (unsigned char *out,
+the content will be automatically remapped to a CharRef sequence.

+
+
handler :	char enconding transformation data structure
+
out :  an xmlBuffer for the output.
+
in :  an xmlBuffer for the input
+
Returns :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
+
xmlCharEncInFunc ()
int         xmlCharEncInFunc                (xmlCharEncodingHandler *handler,
+                                             xmlBufferPtr out,
+                                             xmlBufferPtr in);

+Generic front-end for the encoding handler input function

+
+
handler :	char encoding transformation data structure
+
out :  an xmlBuffer for the output.
+
in :  an xmlBuffer for the input
+
Returns :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
+
xmlCharEncFirstLine ()
int         xmlCharEncFirstLine             (xmlCharEncodingHandler *handler,
+                                             xmlBufferPtr out,
+                                             xmlBufferPtr in);

+Front-end for the encoding handler input function, but handle only
+the very first line, i.e. limit itself to 45 chars.

+
+
handler :	char enconding transformation data structure
+
out :  an xmlBuffer for the output.
+
in :  an xmlBuffer for the input
+
Returns :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
+
xmlCharEncCloseFunc ()
int         xmlCharEncCloseFunc             (xmlCharEncodingHandler *handler);

+Generic front-end for encoding handler close function

+
+
handler :	char enconding transformation data structure
+
Returns :0 if success, or -1 in case of error
+
UTF8Toisolat1 ()
int         UTF8Toisolat1                   (unsigned char *out,
                                              int *outlen,
                                              unsigned char *in,
-                                             int *inlen);

Take a block of UTF-8 chars in and try to convert it to an ISO Latin 1 -block of chars out.

out : 
outlen : 
in : 
inlen : 
Returns : 

isolat1ToUTF8 ()

int         isolat1ToUTF8                   (unsigned char *out,
+                                             int *inlen);

+Take a block of UTF-8 chars in and try to convert it to an ISO Latin 1 +block of chars out.

+ +

out : a pointer to an array of bytes to store the result +
outlen : the length of out +
in : a pointer to an array of UTF-8 chars +
inlen : the length of in +
Returns :0 if success, -2 if the transcoding fails, or -1 otherwise +The value of inlen after return is the number of octets consumed + as the return value is positive, else unpredictable. +The value of outlen after return is the number of ocetes consumed. +

isolat1ToUTF8 ()

int         isolat1ToUTF8                   (unsigned char *out,
                                              int *outlen,
                                              unsigned char *in,
-                                             int *inlen);

Take a block of ISO Latin 1 chars in and try to convert it to an UTF-8 -block of chars out.

out : 
outlen : 
in : 
inlen : 
Returns : 

xmlGetUTF8Char ()

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

Read one UTF8 Char from utf

utf : 
len : 
Returns : 

xmlCheckUTF8 ()

int         xmlCheckUTF8                    (unsigned char *utf);

Checks utf for being valid utf-8. utf is assumed to be + int *inlen);

+Take a block of ISO Latin 1 chars in and try to convert it to an UTF-8 +block of chars out.

+ +

out : a pointer to an array of bytes to store the result +
outlen : the length of out +
in : a pointer to an array of ISO Latin 1 chars +
inlen : the length of in +
Returns :0 if success, or -1 otherwise +The value of inlen after return is the number of octets consumed + as the return value is positive, else unpredictable. +The value of outlen after return is the number of ocetes consumed. +

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 +

xmlCheckUTF8 ()

int         xmlCheckUTF8                    (unsigned char *utf);

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

utf : 
Returns : 

xmlUTF8Strsize ()

int         xmlUTF8Strsize                  (const xmlChar *utf,
-                                             int len);

storage size of an UTF8 string

utf : 
len : 
Returns : 

xmlUTF8Strndup ()

xmlChar*    xmlUTF8Strndup                  (const xmlChar *utf,
-                                             int len);

a strndup for array of UTF8's

utf : 
len : 
Returns : 

xmlUTF8Strpos ()

xmlChar*    xmlUTF8Strpos                   (const xmlChar *utf,
-                                             int pos);

a function to provide the equivalent of fetching a -character from a string array

utf : 
pos : 
Returns : 

xmlUTF8Strloc ()

int         xmlUTF8Strloc                   (const xmlChar *utf,
-                                             const xmlChar *utfchar);

a function to provide relative location of a UTF8 char

utf : 
utfchar : 
Returns : 

xmlUTF8Strsub ()

xmlChar*    xmlUTF8Strsub                   (const xmlChar *utf,
+0x10ffff maximum value.

+
+
utf : Pointer to putative utf-8 encoded string.
+
Returns : true if utf is valid.
+
xmlUTF8Strsize ()
int         xmlUTF8Strsize                  (const xmlChar *utf,
+                                             int len);

+storage size of an UTF8 string

+
+
utf :  a sequence of UTF-8 encoded bytes
+
len :  the number of characters in the array
+
Returns :the storage size of
+the first 'len' characters of ARRAY
+
+
xmlUTF8Strndup ()
xmlChar*    xmlUTF8Strndup                  (const xmlChar *utf,
+                                             int len);

+a strndup for array of UTF8's

+
+
utf :  the input UTF8 *
+
len :  the len of utf (in chars)
+
Returns :a new UTF8 * or NULL
+
xmlUTF8Strpos ()
xmlChar*    xmlUTF8Strpos                   (const xmlChar *utf,
+                                             int pos);

+a function to provide the equivalent of fetching a
+character from a string array

+
+
utf :  the input UTF8 *
+
pos :  the position of the desired UTF8 char (in chars)
+
Returns :a pointer to the UTF8 character or NULL
+
xmlUTF8Strloc ()
int         xmlUTF8Strloc                   (const xmlChar *utf,
+                                             const xmlChar *utfchar);

+a function to provide relative location of a UTF8 char

+
+
utf :  the input UTF8 *
+
utfchar :  the UTF8 character to be found
+
Returns :the relative character position of the desired char
+or -1 if not found
+
xmlUTF8Strsub ()
xmlChar*    xmlUTF8Strsub                   (const xmlChar *utf,
                                              int start,
-                                             int len);

Note: positions are given in units of UTF-8 chars

utf : 
start : 
len : 
Returns : 

xmlUTF8Strlen ()

int         xmlUTF8Strlen                   (const xmlChar *utf);

compute the length of an UTF8 string, it doesn't do a full UTF8 -checking of the content of the string.

utf : 
Returns : 

\ No newline at end of file + int len);

+Note: positions are given in units of UTF-8 chars

+ +

utf : a sequence of UTF-8 encoded bytes +
start : relative pos of first char +
len : total number to copy +
Returns :a pointer to a newly created string +or NULL if any problem +

xmlUTF8Strlen ()

int         xmlUTF8Strlen                   (const xmlChar *utf);

+compute the length of an UTF8 string, it doesn't do a full UTF8 +checking of the content of the string.

+ +

utf : a sequence of UTF-8 encoded bytes +
Returns :the number of characters in the string or -1 in case of error +
<< parserInternalshash >>
diff --git a/doc/html/libxml-entities.html b/doc/html/libxml-entities.html index b6dbfaae..f459c20f 100644 --- a/doc/html/libxml-entities.html +++ b/doc/html/libxml-entities.html @@ -1,439 +1,88 @@ -entities
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

entities

Name

entities -- 

Synopsis


+
+entities
PrevUpHomeGnome XML Library Reference ManualNext
entities
entities — 
Synopsis
 
-enum        xmlEntityType;
-struct      xmlEntity;
-typedef     xmlEntitiesTablePtr;
-void        xmlInitializePredefinedEntities (void);
-xmlEntityPtr xmlAddDocEntity                (xmlDocPtr doc,
-                                             const xmlChar *name,
+
+
+enum        xmlEntityType;
+struct      xmlEntity;
+typedef     xmlEntitiesTablePtr;
+void        xmlInitializePredefinedEntities (void);
+xmlEntityPtr xmlAddDocEntity                (xmlDocPtr doc,
+                                             const xmlChar *name,
                                              int type,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID,
-                                             const xmlChar *content);
-xmlEntityPtr xmlAddDtdEntity                (xmlDocPtr doc,
-                                             const xmlChar *name,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID,
+                                             const xmlChar *content);
+xmlEntityPtr xmlAddDtdEntity                (xmlDocPtr doc,
+                                             const xmlChar *name,
                                              int type,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID,
-                                             const xmlChar *content);
-xmlEntityPtr xmlGetPredefinedEntity         (const xmlChar *name);
-xmlEntityPtr xmlGetDocEntity                (xmlDocPtr doc,
-                                             const xmlChar *name);
-xmlEntityPtr xmlGetDtdEntity                (xmlDocPtr doc,
-                                             const xmlChar *name);
-xmlEntityPtr xmlGetParameterEntity          (xmlDocPtr doc,
-                                             const xmlChar *name);
-const xmlChar* xmlEncodeEntities            (xmlDocPtr doc,
-                                             const xmlChar *input);
-xmlChar*    xmlEncodeEntitiesReentrant      (xmlDocPtr doc,
-                                             const xmlChar *input);
-xmlChar*    xmlEncodeSpecialChars           (xmlDocPtr doc,
-                                             const xmlChar *input);
-xmlEntitiesTablePtr xmlCreateEntitiesTable  (void);
-xmlEntitiesTablePtr xmlCopyEntitiesTable    (xmlEntitiesTablePtr table);
-void        xmlFreeEntitiesTable            (xmlEntitiesTablePtr table);
-void        xmlDumpEntitiesTable            (xmlBufferPtr buf,
-                                             xmlEntitiesTablePtr table);
-void        xmlDumpEntityDecl               (xmlBufferPtr buf,
-                                             xmlEntityPtr ent);
-void        xmlCleanupPredefinedEntities    (void);

Description

Details

enum xmlEntityType

typedef enum {
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID,
+                                             const xmlChar *content);
+xmlEntityPtr xmlGetPredefinedEntity         (const xmlChar *name);
+xmlEntityPtr xmlGetDocEntity                (xmlDocPtr doc,
+                                             const xmlChar *name);
+xmlEntityPtr xmlGetDtdEntity                (xmlDocPtr doc,
+                                             const xmlChar *name);
+xmlEntityPtr xmlGetParameterEntity          (xmlDocPtr doc,
+                                             const xmlChar *name);
+const xmlChar* xmlEncodeEntities            (xmlDocPtr doc,
+                                             const xmlChar *input);
+xmlChar*    xmlEncodeEntitiesReentrant      (xmlDocPtr doc,
+                                             const xmlChar *input);
+xmlChar*    xmlEncodeSpecialChars           (xmlDocPtr doc,
+                                             const xmlChar *input);
+xmlEntitiesTablePtr xmlCreateEntitiesTable  (void);
+xmlEntitiesTablePtr xmlCopyEntitiesTable    (xmlEntitiesTablePtr table);
+void        xmlFreeEntitiesTable            (xmlEntitiesTablePtr table);
+void        xmlDumpEntitiesTable            (xmlBufferPtr buf,
+                                             xmlEntitiesTablePtr table);
+void        xmlDumpEntityDecl               (xmlBufferPtr buf,
+                                             xmlEntityPtr ent);
+void        xmlCleanupPredefinedEntities    (void);
+

Description

+ +

Details

enum xmlEntityType

typedef enum {
     XML_INTERNAL_GENERAL_ENTITY = 1,
     XML_EXTERNAL_GENERAL_PARSED_ENTITY = 2,
     XML_EXTERNAL_GENERAL_UNPARSED_ENTITY = 3,
     XML_INTERNAL_PARAMETER_ENTITY = 4,
     XML_EXTERNAL_PARAMETER_ENTITY = 5,
     XML_INTERNAL_PREDEFINED_ENTITY = 6
-} xmlEntityType;

struct xmlEntity

struct xmlEntity {
+} xmlEntityType;
+

+ +

struct xmlEntity

struct xmlEntity {
     void           *_private;	        /* application data */
     xmlElementType          type;       /* XML_ENTITY_DECL, must be second ! */
     const xmlChar          *name;	/* Entity name */
@@ -454,1737 +103,134 @@ CLASS="PROGRAMLISTING"
     struct _xmlEntity     *nexte;	/* unused */
     const xmlChar           *URI;	/* the full URI as computed */
     int                    owner;	/* does the entity own the childrens */
-};

xmlEntitiesTablePtr

xmlInitializePredefinedEntities ()

void        xmlInitializePredefinedEntities (void);

Set up the predefined entities.

xmlAddDocEntity ()

xmlEntityPtr xmlAddDocEntity                (xmlDocPtr doc,
-                                             const xmlChar *name,
+};
+

+ +

xmlEntitiesTablePtr

typedef xmlEntitiesTable *xmlEntitiesTablePtr;
+

+ +

xmlInitializePredefinedEntities ()

void        xmlInitializePredefinedEntities (void);

+Set up the predefined entities.

+ +

xmlAddDocEntity ()

xmlEntityPtr xmlAddDocEntity                (xmlDocPtr doc,
+                                             const xmlChar *name,
                                              int type,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID,
-                                             const xmlChar *content);

Register a new entity for this document.

doc : 
name : 
type : 
ExternalID : 
SystemID : 
content : 
Returns : 

xmlAddDtdEntity ()

xmlEntityPtr xmlAddDtdEntity                (xmlDocPtr doc,
-                                             const xmlChar *name,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID,
+                                             const xmlChar *content);

+Register a new entity for this document.

+ +

doc : the document +
name : the entity name +
type : the entity type XML_xxx_yyy_ENTITY +
ExternalID : the entity external ID if available +
SystemID : the entity system ID if available +
content : the entity content +
Returns :a pointer to the entity or NULL in case of error +

xmlAddDtdEntity ()

xmlEntityPtr xmlAddDtdEntity                (xmlDocPtr doc,
+                                             const xmlChar *name,
                                              int type,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID,
-                                             const xmlChar *content);

Register a new entity for this document DTD external subset.

doc : 
name : 
type : 
ExternalID : 
SystemID : 
content : 
Returns : 

xmlGetPredefinedEntity ()

xmlEntityPtr xmlGetPredefinedEntity         (const xmlChar *name);

Check whether this name is an predefined entity.

name : 
Returns : 

xmlGetDocEntity ()

xmlEntityPtr xmlGetDocEntity                (xmlDocPtr doc,
-                                             const xmlChar *name);

Do an entity lookup in the document entity hash table and + const xmlChar *ExternalID, + const xmlChar *SystemID, + const xmlChar *content);

+Register a new entity for this document DTD external subset.

+ +

doc : the document +
name : the entity name +
type : the entity type XML_xxx_yyy_ENTITY +
ExternalID : the entity external ID if available +
SystemID : the entity system ID if available +
content : the entity content +
Returns :a pointer to the entity or NULL in case of error +

xmlGetPredefinedEntity ()

xmlEntityPtr xmlGetPredefinedEntity         (const xmlChar *name);

+Check whether this name is an predefined entity.

+ +

name : the entity name +
Returns :NULL if not, otherwise the entity +

xmlGetDocEntity ()

xmlEntityPtr xmlGetDocEntity                (xmlDocPtr doc,
+                                             const xmlChar *name);

+Do an entity lookup in the document entity hash table and returns the corresponding entity, otherwise a lookup is done -in the predefined entities too.

doc : 
name : 
Returns : 

xmlGetDtdEntity ()

xmlEntityPtr xmlGetDtdEntity                (xmlDocPtr doc,
-                                             const xmlChar *name);

Do an entity lookup in the DTD entity hash table and +in the predefined entities too.

+ +

doc : the document referencing the entity +
name : the entity name +
Returns :A pointer to the entity structure or NULL if not found. +

xmlGetDtdEntity ()

xmlEntityPtr xmlGetDtdEntity                (xmlDocPtr doc,
+                                             const xmlChar *name);

+Do an entity lookup in the DTD entity hash table and returns the corresponding entity, if found. -Note: the first argument is the document node, not the DTD node.

doc : 
name : 
Returns : 

xmlGetParameterEntity ()

xmlEntityPtr xmlGetParameterEntity          (xmlDocPtr doc,
-                                             const xmlChar *name);

Do an entity lookup in the internal and external subsets and -returns the corresponding parameter entity, if found.

doc : 
name : 
Returns : 

xmlEncodeEntities ()

const xmlChar* xmlEncodeEntities            (xmlDocPtr doc,
-                                             const xmlChar *input);

Do a global encoding of a string, replacing the predefined entities -and non ASCII values with their entities and CharRef counterparts.

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.

doc : 
input : 
Returns : 

xmlEncodeEntitiesReentrant ()

xmlChar*    xmlEncodeEntitiesReentrant      (xmlDocPtr doc,
-                                             const xmlChar *input);

Do a global encoding of a string, replacing the predefined entities +Note: the first argument is the document node, not the DTD node.

+ +

doc : the document referencing the entity +
name : the entity name +
Returns :A pointer to the entity structure or NULL if not found. +

xmlGetParameterEntity ()

xmlEntityPtr xmlGetParameterEntity          (xmlDocPtr doc,
+                                             const xmlChar *name);

+Do an entity lookup in the internal and external subsets and +returns the corresponding parameter entity, if found.

+ +

doc : the document referencing the entity +
name : the entity name +
Returns :A pointer to the entity structure or NULL if not found. +

xmlEncodeEntities ()

const xmlChar* xmlEncodeEntities            (xmlDocPtr doc,
+                                             const xmlChar *input);

+Do a global encoding of a string, replacing the predefined entities +and non ASCII values with their entities and CharRef counterparts. +

+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.

+ +

doc : the document containing the string +
input : A string to convert to XML. +
Returns :A newly allocated string with the substitution done. +

xmlEncodeEntitiesReentrant ()

xmlChar*    xmlEncodeEntitiesReentrant      (xmlDocPtr doc,
+                                             const xmlChar *input);

+Do a global encoding of a string, replacing the predefined entities and non ASCII values with their entities and CharRef counterparts. Contrary to xmlEncodeEntities, this routine is reentrant, and result -must be deallocated.

doc : 
input : 
Returns : 

xmlEncodeSpecialChars ()

xmlChar*    xmlEncodeSpecialChars           (xmlDocPtr doc,
-                                             const xmlChar *input);

Do a global encoding of a string, replacing the predefined entities -this routine is reentrant, and result must be deallocated.

doc : 
input : 
Returns : 

xmlCreateEntitiesTable ()

xmlEntitiesTablePtr xmlCreateEntitiesTable  (void);

create and initialize an empty entities hash table.

Returns : 

xmlCopyEntitiesTable ()

xmlEntitiesTablePtr xmlCopyEntitiesTable    (xmlEntitiesTablePtr table);

Build a copy of an entity table.

table : 
Returns : 

xmlFreeEntitiesTable ()

void        xmlFreeEntitiesTable            (xmlEntitiesTablePtr table);

Deallocate the memory used by an entities hash table.

table : 

xmlDumpEntitiesTable ()

void        xmlDumpEntitiesTable            (xmlBufferPtr buf,
-                                             xmlEntitiesTablePtr table);

This will dump the content of the entity table as an XML DTD definition

buf : 
table : 

xmlDumpEntityDecl ()

void        xmlDumpEntityDecl               (xmlBufferPtr buf,
-                                             xmlEntityPtr ent);

This will dump the content of the entity table as an XML DTD definition

buf : 
ent : 

xmlCleanupPredefinedEntities ()

void        xmlCleanupPredefinedEntities    (void);

Cleanup up the predefined entities table.

\ No newline at end of file +must be deallocated.

+ +

doc : the document containing the string +
input : A string to convert to XML. +
Returns :A newly allocated string with the substitution done. +

xmlEncodeSpecialChars ()

xmlChar*    xmlEncodeSpecialChars           (xmlDocPtr doc,
+                                             const xmlChar *input);

+Do a global encoding of a string, replacing the predefined entities +this routine is reentrant, and result must be deallocated.

+ +

doc : the document containing the string +
input : A string to convert to XML. +
Returns :A newly allocated string with the substitution done. +

xmlCreateEntitiesTable ()

xmlEntitiesTablePtr xmlCreateEntitiesTable  (void);

+create and initialize an empty entities hash table.

+ +

Returns :the xmlEntitiesTablePtr just created or NULL in case of error. +

xmlCopyEntitiesTable ()

xmlEntitiesTablePtr xmlCopyEntitiesTable    (xmlEntitiesTablePtr table);

+Build a copy of an entity table.

+ +

table : An entity table +
Returns :the new xmlEntitiesTablePtr or NULL in case of error. +

xmlFreeEntitiesTable ()

void        xmlFreeEntitiesTable            (xmlEntitiesTablePtr table);

+Deallocate the memory used by an entities hash table.

+ +

table : An entity table +

xmlDumpEntitiesTable ()

void        xmlDumpEntitiesTable            (xmlBufferPtr buf,
+                                             xmlEntitiesTablePtr table);

+This will dump the content of the entity table as an XML DTD definition

+ +

buf : An XML buffer. +
table : An entity table +

xmlDumpEntityDecl ()

void        xmlDumpEntityDecl               (xmlBufferPtr buf,
+                                             xmlEntityPtr ent);

+This will dump the content of the entity table as an XML DTD definition

+ +

buf : An XML buffer. +
ent : An entity table +

xmlCleanupPredefinedEntities ()

void        xmlCleanupPredefinedEntities    (void);

+Cleanup up the predefined entities table.

+ +

<< treevalid >>
diff --git a/doc/html/libxml-globals.html b/doc/html/libxml-globals.html index dea612da..10d12e0f 100644 --- a/doc/html/libxml-globals.html +++ b/doc/html/libxml-globals.html @@ -1,482 +1,87 @@ -globals
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

globals

Name

globals -- 

Synopsis


+
+globals
PrevUpHomeGnome XML Library Reference ManualNext
globals
globals — 
Synopsis
 
-void        (*xmlRegisterNodeFunc)          (xmlNodePtr node);
-void        (*xmlDeregisterNodeFunc)        (xmlNodePtr node);
-struct      xmlGlobalState;
-typedef     xmlGlobalStatePtr;
-void        xmlInitializeGlobalState        (xmlGlobalStatePtr gs);
-xmlRegisterNodeFunc xmlRegisterNodeDefault  (xmlRegisterNodeFunc func);
-xmlDeregisterNodeFunc xmlDeregisterNodeDefault
-                                            (xmlDeregisterNodeFunc func);
-#define     xmlMalloc                       (size)
-#define     xmlRealloc                      (ptr, size)
-#define     xmlFree
-#define     xmlMemStrdup                    (str)
-#define     docbDefaultSAXHandler
-#define     htmlDefaultSAXHandler
-#define     oldXMLWDcompatibility
-#define     xmlBufferAllocScheme
-#define     xmlDefaultBufferSize
-#define     xmlDefaultSAXHandler
-#define     xmlDefaultSAXLocator
-#define     xmlDoValidityCheckingDefaultValue
-#define     xmlGenericError
-#define     xmlGenericErrorContext
-#define     xmlGetWarningsDefaultValue
-#define     xmlIndentTreeOutput
-#define     xmlTreeIndentString
-#define     xmlKeepBlanksDefaultValue
-#define     xmlLineNumbersDefaultValue
-#define     xmlLoadExtDtdDefaultValue
-#define     xmlParserDebugEntities
-#define     xmlParserVersion
-#define     xmlPedanticParserDefaultValue
-#define     xmlSaveNoEmptyTags
-#define     xmlSubstituteEntitiesDefaultValue
-#define     xmlRegisterNodeDefaultValue
-#define     xmlDeregisterNodeDefaultValue

Description

Details

xmlRegisterNodeFunc ()

void        (*xmlRegisterNodeFunc)          (xmlNodePtr node);

node : 

xmlDeregisterNodeFunc ()

void        (*xmlDeregisterNodeFunc)        (xmlNodePtr node);

node : 

struct xmlGlobalState

struct xmlGlobalState 
+
+
+void        (*xmlRegisterNodeFunc)          (xmlNodePtr node);
+void        (*xmlDeregisterNodeFunc)        (xmlNodePtr node);
+struct      xmlGlobalState;
+typedef     xmlGlobalStatePtr;
+void        xmlInitializeGlobalState        (xmlGlobalStatePtr gs);
+xmlRegisterNodeFunc xmlRegisterNodeDefault  (xmlRegisterNodeFunc func);
+xmlDeregisterNodeFunc xmlDeregisterNodeDefault
+                                            (xmlDeregisterNodeFunc func);
+#define     xmlMalloc                       (size)
+#define     xmlMallocAtomic                 (size)
+#define     xmlRealloc                      (ptr, size)
+#define     xmlFree
+#define     xmlMemStrdup                    (str)
+#define     docbDefaultSAXHandler
+#define     htmlDefaultSAXHandler
+#define     oldXMLWDcompatibility
+#define     xmlBufferAllocScheme
+#define     xmlDefaultBufferSize
+#define     xmlDefaultSAXHandler
+#define     xmlDefaultSAXLocator
+#define     xmlDoValidityCheckingDefaultValue
+#define     xmlGenericError
+#define     xmlGenericErrorContext
+#define     xmlGetWarningsDefaultValue
+#define     xmlIndentTreeOutput
+#define     xmlTreeIndentString
+#define     xmlKeepBlanksDefaultValue
+#define     xmlLineNumbersDefaultValue
+#define     xmlLoadExtDtdDefaultValue
+#define     xmlParserDebugEntities
+#define     xmlParserVersion
+#define     xmlPedanticParserDefaultValue
+#define     xmlSaveNoEmptyTags
+#define     xmlSubstituteEntitiesDefaultValue
+#define     xmlRegisterNodeDefaultValue
+#define     xmlDeregisterNodeDefaultValue
+

Description

+ +

Details

xmlRegisterNodeFunc ()

void        (*xmlRegisterNodeFunc)          (xmlNodePtr node);

+ +

node : + + +

xmlDeregisterNodeFunc ()

void        (*xmlDeregisterNodeFunc)        (xmlNodePtr node);

+ +

node : + + +

struct xmlGlobalState

struct xmlGlobalState 
 {
 	const char *xmlParserVersion;
 
@@ -513,1300 +118,148 @@ CLASS="PROGRAMLISTING"
 
   	xmlRegisterNodeFunc xmlRegisterNodeDefaultValue;
   	xmlDeregisterNodeFunc xmlDeregisterNodeDefaultValue;
-};

xmlGlobalStatePtr

xmlInitializeGlobalState ()

void        xmlInitializeGlobalState        (xmlGlobalStatePtr gs);

xmlInitializeGlobalState() initialize a global state with all the -default values of the library.

gs : 

xmlRegisterNodeDefault ()

xmlRegisterNodeFunc xmlRegisterNodeDefault  (xmlRegisterNodeFunc func);

Registers a callback for node creation

func : 
Returns : 

xmlDeregisterNodeDefault ()

xmlDeregisterNodeFunc xmlDeregisterNodeDefault
-                                            (xmlDeregisterNodeFunc func);

Registers a callback for node destruction

func : 
Returns : 

xmlMalloc()

#define     xmlMalloc(size)

Wrapper for the malloc() function used in the XML library.

size : 

xmlRealloc()

#define     xmlRealloc(ptr, size)

Wrapper for the realloc() function used in the XML library.

ptr : 
size : 

xmlFree

#define     xmlFree

The variable holding the libxml free() implementation

xmlMemStrdup()

#define     xmlMemStrdup(str)

Wrapper for the strdup() function, xmlStrdup() is usually preferred.

str : 

docbDefaultSAXHandler

#define     docbDefaultSAXHandler

Default handler for SGML DocBook, builds the DOM tree

htmlDefaultSAXHandler

#define     htmlDefaultSAXHandler

Default handler for HTML, builds the DOM tree

oldXMLWDcompatibility

#define     oldXMLWDcompatibility

Global setting, DEPRECATED.

xmlBufferAllocScheme

#define     xmlBufferAllocScheme

Global setting, default allocation policy for buffers, default is -XML_BUFFER_ALLOC_EXACT

xmlDefaultBufferSize

#define     xmlDefaultBufferSize

Global setting, default buffer size. Default value is BASE_BUFFER_SIZE

xmlDefaultSAXHandler

#define     xmlDefaultSAXHandler

Default handler for XML, builds the DOM tree

xmlDefaultSAXLocator

#define     xmlDefaultSAXLocator

The default SAX Locator -{ getPublicId, getSystemId, getLineNumber, getColumnNumber}

xmlDoValidityCheckingDefaultValue

#define     xmlDoValidityCheckingDefaultValue

Global setting, indicate that the parser should work in validating mode. -Disabled by default.

xmlGenericError

#define     xmlGenericError

Global setting: function used for generic error callbacks

xmlGenericErrorContext

#define     xmlGenericErrorContext

Global setting passed to generic error callbacks

xmlGetWarningsDefaultValue

#define     xmlGetWarningsDefaultValue

Global setting, indicate that the parser should provide warnings. -Activated by default.

xmlIndentTreeOutput

#define     xmlIndentTreeOutput

Global setting, asking the serializer to indent the output tree by default -Enabled by default

xmlTreeIndentString

#define     xmlTreeIndentString

The string used to do one-level indent. By default is equal to " " (two spaces)

xmlKeepBlanksDefaultValue

#define     xmlKeepBlanksDefaultValue

Global setting, indicate that the parser should keep all blanks + + xmlMallocFunc xmlMallocAtomic; +}; +

+ +

xmlGlobalStatePtr

typedef xmlGlobalState *xmlGlobalStatePtr;
+

+ +

xmlInitializeGlobalState ()

void        xmlInitializeGlobalState        (xmlGlobalStatePtr gs);

+xmlInitializeGlobalState() initialize a global state with all the +default values of the library.

+ +

gs : a pointer to a newly allocated global state +

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 +

xmlMalloc()

#define     xmlMalloc(size)

+Wrapper for the malloc() function used in the XML library.

+ +

size : + + +

xmlMallocAtomic()

#define     xmlMallocAtomic(size)

+Wrapper for the malloc() function used in the XML library for allocation +of block not containing pointers to other areas.

+ +

size : + + +

xmlRealloc()

#define     xmlRealloc(ptr, size)

+Wrapper for the realloc() function used in the XML library.

+ +

ptr : +
size : + + +

xmlFree

#define     xmlFree

+The variable holding the libxml free() implementation

+ +

xmlMemStrdup()

#define     xmlMemStrdup(str)

+Wrapper for the strdup() function, xmlStrdup() is usually preferred.

+ +

str : + + +

docbDefaultSAXHandler

#define     docbDefaultSAXHandler

+Default handler for SGML DocBook, builds the DOM tree

+ +

htmlDefaultSAXHandler

#define     htmlDefaultSAXHandler

+Default handler for HTML, builds the DOM tree

+ +

oldXMLWDcompatibility

#define     oldXMLWDcompatibility

+Global setting, DEPRECATED.

+ +

xmlBufferAllocScheme

#define     xmlBufferAllocScheme

+Global setting, default allocation policy for buffers, default is +XML_BUFFER_ALLOC_EXACT

+ +

xmlDefaultBufferSize

#define     xmlDefaultBufferSize

+Global setting, default buffer size. Default value is BASE_BUFFER_SIZE

+ +

xmlDefaultSAXHandler

#define     xmlDefaultSAXHandler

+Default handler for XML, builds the DOM tree

+ +

xmlDefaultSAXLocator

#define     xmlDefaultSAXLocator

+The default SAX Locator +{ getPublicId, getSystemId, getLineNumber, getColumnNumber}

+ +

xmlDoValidityCheckingDefaultValue

#define     xmlDoValidityCheckingDefaultValue

+Global setting, indicate that the parser should work in validating mode. +Disabled by default.

+ +

xmlGenericError

#define     xmlGenericError

+Global setting: function used for generic error callbacks

+ +

xmlGenericErrorContext

#define     xmlGenericErrorContext

+Global setting passed to generic error callbacks

+ +

xmlGetWarningsDefaultValue

#define     xmlGetWarningsDefaultValue

+Global setting, indicate that the parser should provide warnings. +Activated by default.

+ +

xmlIndentTreeOutput

#define     xmlIndentTreeOutput

+Global setting, asking the serializer to indent the output tree by default +Enabled by default

+ +

xmlTreeIndentString

#define     xmlTreeIndentString

+The string used to do one-level indent. By default is equal to " " (two spaces)

+ +

xmlKeepBlanksDefaultValue

#define     xmlKeepBlanksDefaultValue

+Global setting, indicate that the parser should keep all blanks nodes found in the content Activated by default, this is actually needed to have the parser conformant to the XML Recommendation, however the option is kept -for some applications since this was libxml1 default behaviour.

xmlLineNumbersDefaultValue

#define     xmlLineNumbersDefaultValue

Global setting, indicate that the parser should store the line number +for some applications since this was libxml1 default behaviour.

+ +

xmlLineNumbersDefaultValue

#define     xmlLineNumbersDefaultValue

+Global setting, indicate that the parser should store the line number in the content field of elements in the DOM tree. Disabled by default since this may not be safe for old classes of -applicaton.

xmlLoadExtDtdDefaultValue

#define     xmlLoadExtDtdDefaultValue

Global setting, indicate that the parser should load DTD while not +applicaton.

+ +

xmlLoadExtDtdDefaultValue

#define     xmlLoadExtDtdDefaultValue

+Global setting, indicate that the parser should load DTD while not validating. -Disabled by default.

xmlParserDebugEntities

#define     xmlParserDebugEntities

Global setting, asking the parser to print out debugging informations. +Disabled by default.

+ +

xmlParserDebugEntities

#define     xmlParserDebugEntities

+Global setting, asking the parser to print out debugging informations. while handling entities. -Disabled by default

xmlParserVersion

#define     xmlParserVersion

Constant string describing the internal version of the library

xmlPedanticParserDefaultValue

#define     xmlPedanticParserDefaultValue

Global setting, indicate that the parser be pedantic -Disabled by default.

xmlSaveNoEmptyTags

#define     xmlSaveNoEmptyTags

Global setting, asking the serializer to not output empty tags +Disabled by default

+ +

xmlParserVersion

#define     xmlParserVersion

+Constant string describing the internal version of the library

+ +

xmlPedanticParserDefaultValue

#define     xmlPedanticParserDefaultValue

+Global setting, indicate that the parser be pedantic +Disabled by default.

+ +

xmlSaveNoEmptyTags

#define     xmlSaveNoEmptyTags

+Global setting, asking the serializer to not output empty tags as <empty/> but <empty></empty>. those two forms are undistinguishable once parsed. -Disabled by default

xmlSubstituteEntitiesDefaultValue

#define     xmlSubstituteEntitiesDefaultValue

Global setting, indicate that the parser should not generate entity +Disabled by default

+ +

xmlSubstituteEntitiesDefaultValue

#define     xmlSubstituteEntitiesDefaultValue

+Global setting, indicate that the parser should not generate entity references but replace them with the actual content of the entity Disabled by default, this should be activated when using XPath since the XPath data model requires entities replacement and the XPath -engine does not handle entities references transparently.

xmlRegisterNodeDefaultValue

#define     xmlRegisterNodeDefaultValue

xmlDeregisterNodeDefaultValue

#define     xmlDeregisterNodeDefaultValue

\ No newline at end of file +engine does not handle entities references transparently.

+ +

xmlRegisterNodeDefaultValue

#define     xmlRegisterNodeDefaultValue

+ +

xmlDeregisterNodeDefaultValue

#define     xmlDeregisterNodeDefaultValue

+ +

<< threadsDOCBparser >>
diff --git a/doc/html/libxml-hash.html b/doc/html/libxml-hash.html index 0b080386..1bdaf920 100644 --- a/doc/html/libxml-hash.html +++ b/doc/html/libxml-hash.html @@ -1,4095 +1,379 @@ -hash
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

hash

Name

hash -- 

Synopsis


+
+hash
PrevUpHomeGnome XML Library Reference ManualNext
hash
hash — 
Synopsis
 
-struct      xmlHashTable;
-typedef     xmlHashTablePtr;
-void        (*xmlHashDeallocator)           (void *payload,
-                                             xmlChar *name);
-void*       (*xmlHashCopier)                (void *payload,
-                                             xmlChar *name);
-void        (*xmlHashScanner)               (void *payload,
+
+
+struct      xmlHashTable;
+typedef     xmlHashTablePtr;
+void        (*xmlHashDeallocator)           (void *payload,
+                                             xmlChar *name);
+void*       (*xmlHashCopier)                (void *payload,
+                                             xmlChar *name);
+void        (*xmlHashScanner)               (void *payload,
                                              void *data,
-                                             xmlChar *name);
-void        (*xmlHashScannerFull)           (void *payload,
+                                             xmlChar *name);
+void        (*xmlHashScannerFull)           (void *payload,
                                              void *data,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3);
-xmlHashTablePtr xmlHashCreate               (int size);
-void        xmlHashFree                     (xmlHashTablePtr table,
-                                             xmlHashDeallocator f);
-int         xmlHashAddEntry                 (xmlHashTablePtr table,
-                                             const xmlChar *name,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             const xmlChar *name3);
+xmlHashTablePtr xmlHashCreate               (int size);
+void        xmlHashFree                     (xmlHashTablePtr table,
+                                             xmlHashDeallocator f);
+int         xmlHashAddEntry                 (xmlHashTablePtr table,
+                                             const xmlChar *name,
                                              void *userdata);
-int         xmlHashUpdateEntry              (xmlHashTablePtr table,
-                                             const xmlChar *name,
+int         xmlHashUpdateEntry              (xmlHashTablePtr table,
+                                             const xmlChar *name,
                                              void *userdata,
-                                             xmlHashDeallocator f);
-int         xmlHashAddEntry2                (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
+                                             xmlHashDeallocator f);
+int         xmlHashAddEntry2                (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
                                              void *userdata);
-int         xmlHashUpdateEntry2             (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
+int         xmlHashUpdateEntry2             (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
                                              void *userdata,
-                                             xmlHashDeallocator f);
-int         xmlHashAddEntry3                (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
+                                             xmlHashDeallocator f);
+int         xmlHashAddEntry3                (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             const xmlChar *name3,
                                              void *userdata);
-int         xmlHashUpdateEntry3             (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
+int         xmlHashUpdateEntry3             (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             const xmlChar *name3,
                                              void *userdata,
-                                             xmlHashDeallocator f);
-int         xmlHashRemoveEntry              (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             xmlHashDeallocator f);
-int         xmlHashRemoveEntry2             (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             xmlHashDeallocator f);
-int         xmlHashRemoveEntry3             (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             xmlHashDeallocator f);
-void*       xmlHashLookup                   (xmlHashTablePtr table,
-                                             const xmlChar *name);
-void*       xmlHashLookup2                  (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2);
-void*       xmlHashLookup3                  (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3);
-xmlHashTablePtr xmlHashCopy                 (xmlHashTablePtr table,
-                                             xmlHashCopier f);
-int         xmlHashSize                     (xmlHashTablePtr table);
-void        xmlHashScan                     (xmlHashTablePtr table,
-                                             xmlHashScanner f,
+                                             xmlHashDeallocator f);
+int         xmlHashRemoveEntry              (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             xmlHashDeallocator f);
+int         xmlHashRemoveEntry2             (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             xmlHashDeallocator f);
+int         xmlHashRemoveEntry3             (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             const xmlChar *name3,
+                                             xmlHashDeallocator f);
+void*       xmlHashLookup                   (xmlHashTablePtr table,
+                                             const xmlChar *name);
+void*       xmlHashLookup2                  (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2);
+void*       xmlHashLookup3                  (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             const xmlChar *name3);
+xmlHashTablePtr xmlHashCopy                 (xmlHashTablePtr table,
+                                             xmlHashCopier f);
+int         xmlHashSize                     (xmlHashTablePtr table);
+void        xmlHashScan                     (xmlHashTablePtr table,
+                                             xmlHashScanner f,
                                              void *data);
-void        xmlHashScan3                    (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             xmlHashScanner f,
+void        xmlHashScan3                    (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             const xmlChar *name3,
+                                             xmlHashScanner f,
                                              void *data);
-void        xmlHashScanFull                 (xmlHashTablePtr table,
-                                             xmlHashScannerFull f,
+void        xmlHashScanFull                 (xmlHashTablePtr table,
+                                             xmlHashScannerFull f,
                                              void *data);
-void        xmlHashScanFull3                (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             xmlHashScannerFull f,
-                                             void *data);

Description

Details

struct xmlHashTable

struct xmlHashTable;

xmlHashTablePtr

xmlHashDeallocator ()

void        (*xmlHashDeallocator)           (void *payload,
-                                             xmlChar *name);

Callback to free data from a hash.

payload : 
name : 

xmlHashCopier ()

void*       (*xmlHashCopier)                (void *payload,
-                                             xmlChar *name);

Callback to copy data from a hash.

payload : 
name : 

xmlHashScanner ()

void        (*xmlHashScanner)               (void *payload,
+void        xmlHashScanFull3                (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             const xmlChar *name3,
+                                             xmlHashScannerFull f,
+                                             void *data);
+

Description

+ +

Details

struct xmlHashTable

struct xmlHashTable;

+ +

xmlHashTablePtr

typedef xmlHashTable *xmlHashTablePtr;
+

+ +

xmlHashDeallocator ()

void        (*xmlHashDeallocator)           (void *payload,
+                                             xmlChar *name);

+Callback to free data from a hash.

+ +

payload : the data in the hash +
name : the name associated +

xmlHashCopier ()

void*       (*xmlHashCopier)                (void *payload,
+                                             xmlChar *name);

+Callback to copy data from a hash.

+ +

payload : the data in the hash +
name : the name associated +

xmlHashScanner ()

void        (*xmlHashScanner)               (void *payload,
                                              void *data,
-                                             xmlChar *name);

Callback when scanning data in a hash with the simple scanner.

payload : 
data : 
name : 

xmlHashScannerFull ()

void        (*xmlHashScannerFull)           (void *payload,
+                                             xmlChar *name);

+Callback when scanning data in a hash with the simple scanner.

+ +

payload : the data in the hash +
data : extra scannner data +
name : the name associated +

xmlHashScannerFull ()

void        (*xmlHashScannerFull)           (void *payload,
                                              void *data,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3);

Callback when scanning data in a hash with the full scanner.

payload : 
data : 
name : 
name2 : 
name3 : 

xmlHashCreate ()

xmlHashTablePtr xmlHashCreate               (int size);

Create a new xmlHashTablePtr.

size : 
Returns : 

xmlHashFree ()

void        xmlHashFree                     (xmlHashTablePtr table,
-                                             xmlHashDeallocator f);

Free the hash table and its contents. The userdata is -deallocated with f if provided.

table : 
f : 

xmlHashAddEntry ()

int         xmlHashAddEntry                 (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             void *userdata);

Add the userdata to the hash table. This can later be retrieved -by using the name. Duplicate names generate errors.

table : 
name : 
userdata : 
Returns : 

xmlHashUpdateEntry ()

int         xmlHashUpdateEntry              (xmlHashTablePtr table,
-                                             const xmlChar *name,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             const xmlChar *name3);

+Callback when scanning data in a hash with the full scanner.

+ +

payload : the data in the hash +
data : extra scannner data +
name : the name associated +
name2 : the second name associated +
name3 : the third name associated +

xmlHashCreate ()

xmlHashTablePtr xmlHashCreate               (int size);

+Create a new xmlHashTablePtr.

+ +

size : the size of the hash table +
Returns :the newly created object, or NULL if an error occured. +

xmlHashFree ()

void        xmlHashFree                     (xmlHashTablePtr table,
+                                             xmlHashDeallocator f);

+Free the hash table and its contents. The userdata is +deallocated with f if provided.

+ +

table : the hash table +
f : the deallocator function for items in the hash +

xmlHashAddEntry ()

int         xmlHashAddEntry                 (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             void *userdata);

+Add the userdata to the hash table. This can later be retrieved +by using the name. Duplicate names generate errors.

+ +

table : the hash table +
name : the name of the userdata +
userdata : a pointer to the userdata +
Returns :0 the addition succeeded and -1 in case of error. +

xmlHashUpdateEntry ()

int         xmlHashUpdateEntry              (xmlHashTablePtr table,
+                                             const xmlChar *name,
                                              void *userdata,
-                                             xmlHashDeallocator f);

Add the userdata to the hash table. This can later be retrieved -by using the name. Existing entry for this name will be removed -and freed with f if found.

table : 
name : 
userdata : 
f : 
Returns : 

xmlHashAddEntry2 ()

int         xmlHashAddEntry2                (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             void *userdata);

Add the userdata to the hash table. This can later be retrieved -by using the (name, name2) tuple. Duplicate tuples generate errors.

table : 
name : 
name2 : 
userdata : 
Returns : 

xmlHashUpdateEntry2 ()

int         xmlHashUpdateEntry2             (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
+                                             xmlHashDeallocator f);

+Add the userdata to the hash table. This can later be retrieved +by using the name. Existing entry for this name will be removed +and freed with f if found.

+ +

table : the hash table +
name : the name of the userdata +
userdata : a pointer to the userdata +
f : the deallocator function for replaced item (if any) +
Returns :0 the addition succeeded and -1 in case of error. +

xmlHashAddEntry2 ()

int         xmlHashAddEntry2                (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             void *userdata);

+Add the userdata to the hash table. This can later be retrieved +by using the (name, name2) tuple. Duplicate tuples generate errors.

+ +

table : the hash table +
name : the name of the userdata +
name2 : a second name of the userdata +
userdata : a pointer to the userdata +
Returns :0 the addition succeeded and -1 in case of error. +

xmlHashUpdateEntry2 ()

int         xmlHashUpdateEntry2             (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
                                              void *userdata,
-                                             xmlHashDeallocator f);

Add the userdata to the hash table. This can later be retrieved -by using the (name, name2) tuple. Existing entry for this tuple will -be removed and freed with f if found.

table : 
name : 
name2 : 
userdata : 
f : 
Returns : 

xmlHashAddEntry3 ()

int         xmlHashAddEntry3                (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             void *userdata);

Add the userdata to the hash table. This can later be retrieved -by using the tuple (name, name2, name3). Duplicate entries generate -errors.

table : 
name : 
name2 : 
name3 : 
userdata : 
Returns : 

xmlHashUpdateEntry3 ()

int         xmlHashUpdateEntry3             (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
+                                             xmlHashDeallocator f);

+Add the userdata to the hash table. This can later be retrieved +by using the (name, name2) tuple. Existing entry for this tuple will +be removed and freed with f if found.

+ +

table : the hash table +
name : the name of the userdata +
name2 : a second name of the userdata +
userdata : a pointer to the userdata +
f : the deallocator function for replaced item (if any) +
Returns :0 the addition succeeded and -1 in case of error. +

xmlHashAddEntry3 ()

int         xmlHashAddEntry3                (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             const xmlChar *name3,
+                                             void *userdata);

+Add the userdata to the hash table. This can later be retrieved +by using the tuple (name, name2, name3). Duplicate entries generate +errors.

+ +

table : the hash table +
name : the name of the userdata +
name2 : a second name of the userdata +
name3 : a third name of the userdata +
userdata : a pointer to the userdata +
Returns :0 the addition succeeded and -1 in case of error. +

xmlHashUpdateEntry3 ()

int         xmlHashUpdateEntry3             (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             const xmlChar *name3,
                                              void *userdata,
-                                             xmlHashDeallocator f);

Add the userdata to the hash table. This can later be retrieved -by using the tuple (name, name2, name3). Existing entry for this tuple -will be removed and freed with f if found.

table : 
name : 
name2 : 
name3 : 
userdata : 
f : 
Returns : 

xmlHashRemoveEntry ()

int         xmlHashRemoveEntry              (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             xmlHashDeallocator f);

Find the userdata specified by the name and remove -it from the hash table. Existing userdata for this tuple will be removed -and freed with f.

table : 
name : 
f : 
Returns : 

xmlHashRemoveEntry2 ()

int         xmlHashRemoveEntry2             (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             xmlHashDeallocator f);

Find the userdata specified by the (name, name2) tuple and remove -it from the hash table. Existing userdata for this tuple will be removed -and freed with f.

table : 
name : 
name2 : 
f : 
Returns : 

xmlHashRemoveEntry3 ()

int         xmlHashRemoveEntry3             (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             xmlHashDeallocator f);

Find the userdata specified by the (name, name2, name3) tuple and remove -it from the hash table. Existing userdata for this tuple will be removed -and freed with f.

table : 
name : 
name2 : 
name3 : 
f : 
Returns : 

xmlHashLookup ()

void*       xmlHashLookup                   (xmlHashTablePtr table,
-                                             const xmlChar *name);

Find the userdata specified by the name.

table : 
name : 

xmlHashLookup2 ()

void*       xmlHashLookup2                  (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2);

Find the userdata specified by the (name, name2) tuple.

table : 
name : 
name2 : 

xmlHashLookup3 ()

void*       xmlHashLookup3                  (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3);

Find the userdata specified by the (name, name2, name3) tuple.

table : 
name : 
name2 : 
name3 : 

xmlHashCopy ()

xmlHashTablePtr xmlHashCopy                 (xmlHashTablePtr table,
-                                             xmlHashCopier f);

Scan the hash table and applied f to each value.

table : 
f : 
Returns : 

xmlHashSize ()

int         xmlHashSize                     (xmlHashTablePtr table);

Query the number of elements installed in the hash table.

table : 
Returns : 

xmlHashScan ()

void        xmlHashScan                     (xmlHashTablePtr table,
-                                             xmlHashScanner f,
-                                             void *data);

Scan the hash table and applied f to each value.

table : 
f : 
data : 

xmlHashScan3 ()

void        xmlHashScan3                    (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             xmlHashScanner f,
-                                             void *data);

Scan the hash table and applied f to each value matching -(name, name2, name3) tuple. If one of the names is null, -the comparison is considered to match.

table : 
name : 
name2 : 
name3 : 
f : 
data : 

xmlHashScanFull ()

void        xmlHashScanFull                 (xmlHashTablePtr table,
-                                             xmlHashScannerFull f,
-                                             void *data);

Scan the hash table and applied f to each value.

table : 
f : 
data : 

xmlHashScanFull3 ()

void        xmlHashScanFull3                (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             xmlHashScannerFull f,
-                                             void *data);

Scan the hash table and applied f to each value matching -(name, name2, name3) tuple. If one of the names is null, -the comparison is considered to match.

table : 
name : 
name2 : 
name3 : 
f : 
data : 

\ No newline at end of file + xmlHashDeallocator f);

+Add the userdata to the hash table. This can later be retrieved +by using the tuple (name, name2, name3). Existing entry for this tuple +will be removed and freed with f if found.

+ +

table : the hash table +
name : the name of the userdata +
name2 : a second name of the userdata +
name3 : a third name of the userdata +
userdata : a pointer to the userdata +
f : the deallocator function for replaced item (if any) +
Returns :0 the addition succeeded and -1 in case of error. +

xmlHashRemoveEntry ()

int         xmlHashRemoveEntry              (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             xmlHashDeallocator f);

+Find the userdata specified by the name and remove +it from the hash table. Existing userdata for this tuple will be removed +and freed with f.

+ +

table : the hash table +
name : the name of the userdata +
f : the deallocator function for removed item (if any) +
Returns :0 if the removal succeeded and -1 in case of error or not found. +

xmlHashRemoveEntry2 ()

int         xmlHashRemoveEntry2             (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             xmlHashDeallocator f);

+Find the userdata specified by the (name, name2) tuple and remove +it from the hash table. Existing userdata for this tuple will be removed +and freed with f.

+ +

table : the hash table +
name : the name of the userdata +
name2 : a second name of the userdata +
f : the deallocator function for removed item (if any) +
Returns :0 if the removal succeeded and -1 in case of error or not found. +

xmlHashRemoveEntry3 ()

int         xmlHashRemoveEntry3             (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             const xmlChar *name3,
+                                             xmlHashDeallocator f);

+Find the userdata specified by the (name, name2, name3) tuple and remove +it from the hash table. Existing userdata for this tuple will be removed +and freed with f.

+ +

table : the hash table +
name : the name of the userdata +
name2 : a second name of the userdata +
name3 : a third name of the userdata +
f : the deallocator function for removed item (if any) +
Returns :0 if the removal succeeded and -1 in case of error or not found. +

xmlHashLookup ()

void*       xmlHashLookup                   (xmlHashTablePtr table,
+                                             const xmlChar *name);

+Find the userdata specified by the name.

+ +

table : the hash table +
name : the name of the userdata +

xmlHashLookup2 ()

void*       xmlHashLookup2                  (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2);

+Find the userdata specified by the (name, name2) tuple.

+ +

table : the hash table +
name : the name of the userdata +
name2 : a second name of the userdata +

xmlHashLookup3 ()

void*       xmlHashLookup3                  (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             const xmlChar *name3);

+Find the userdata specified by the (name, name2, name3) tuple.

+ +

table : the hash table +
name : the name of the userdata +
name2 : a second name of the userdata +
name3 : a third name of the userdata +

xmlHashCopy ()

xmlHashTablePtr xmlHashCopy                 (xmlHashTablePtr table,
+                                             xmlHashCopier f);

+Scan the hash table and applied f to each value.

+ +

table : the hash table +
f : the copier function for items in the hash +
Returns :the new table or NULL in case of error. +

xmlHashSize ()

int         xmlHashSize                     (xmlHashTablePtr table);

+Query the number of elements installed in the hash table.

+ +

table : the hash table +
Returns :the number of elements in the hash table or +-1 in case of error +

xmlHashScan ()

void        xmlHashScan                     (xmlHashTablePtr table,
+                                             xmlHashScanner f,
+                                             void *data);

+Scan the hash table and applied f to each value.

+ +

table : the hash table +
f : the scanner function for items in the hash +
data : extra data passed to f +

xmlHashScan3 ()

void        xmlHashScan3                    (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             const xmlChar *name3,
+                                             xmlHashScanner f,
+                                             void *data);

+Scan the hash table and applied f to each value matching +(name, name2, name3) tuple. If one of the names is null, +the comparison is considered to match.

+ +

table : the hash table +
name : the name of the userdata or NULL +
name2 : a second name of the userdata or NULL +
name3 : a third name of the userdata or NULL +
f : the scanner function for items in the hash +
data : extra data passed to f +

xmlHashScanFull ()

void        xmlHashScanFull                 (xmlHashTablePtr table,
+                                             xmlHashScannerFull f,
+                                             void *data);

+Scan the hash table and applied f to each value.

+ +

table : the hash table +
f : the scanner function for items in the hash +
data : extra data passed to f +

xmlHashScanFull3 ()

void        xmlHashScanFull3                (xmlHashTablePtr table,
+                                             const xmlChar *name,
+                                             const xmlChar *name2,
+                                             const xmlChar *name3,
+                                             xmlHashScannerFull f,
+                                             void *data);

+Scan the hash table and applied f to each value matching +(name, name2, name3) tuple. If one of the names is null, +the comparison is considered to match.

+ +

table : the hash table +
name : the name of the userdata or NULL +
name2 : a second name of the userdata or NULL +
name3 : a third name of the userdata or NULL +
f : the scanner function for items in the hash +
data : extra data passed to f +
<< encodingdebugXML >>
diff --git a/doc/html/libxml-lib.html b/doc/html/libxml-lib.html index d1e3c308..cf83ee43 100644 --- a/doc/html/libxml-lib.html +++ b/doc/html/libxml-lib.html @@ -1,393 +1,34 @@ -Libxml Library Reference
Gnome XML Library Reference Manual
<<< Previous PageHome Next Page >>>

Libxml Library Reference

Table of Contents
parser -- 
xmlreader -- 
SAX -- 
tree -- 
entities -- 
valid -- 
relaxng -- 
uri -- 
xmlerror -- 
HTMLparser -- 
HTMLtree -- 
xpath -- 
xpathInternals -- 
xpointer -- 
xinclude -- 
nanohttp -- 
nanoftp -- 
xmlIO -- 
catalog -- 
c14n -- 
threads -- 
globals -- 
DOCBparser -- 
parserInternals -- 
encoding -- 
hash -- 
debugXML -- 
xmlmemory -- 
xmlregexp -- 
xmlautomata -- 
xmlunicode -- 
xmlschemas -- 
xmlschemastypes -- 
schemasInternals -- 

This section contains the API reference for libxml. All + +Libxml Library Reference
PrevHomeGnome XML Library Reference ManualNext

Libxml Library Reference

Table of Contents

parser -
xmlreader -
SAX -
tree -
entities -
valid -
relaxng -
uri -
xmlerror -
HTMLparser -
HTMLtree -
xpath -
xpathInternals -
xpointer -
xinclude -
nanohttp -
nanoftp -
xmlIO -
catalog -
c14n -
threads -
globals -
DOCBparser -
parserInternals -
encoding -
hash -
debugXML -
xmlmemory -
xmlregexp -
xmlautomata -
xmlunicode -
xmlschemas -
xmlschemastypes -
schemasInternals -

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.



<<< Previous PageHome Next Page >>>
Libxml Programming Notesparser
\ No newline at end of file + build by extracting comments from the code sources.

<< Libxml Programming Notesparser >>
diff --git a/doc/html/libxml-nanoftp.html b/doc/html/libxml-nanoftp.html index 9f01cd94..8ff6a0fc 100644 --- a/doc/html/libxml-nanoftp.html +++ b/doc/html/libxml-nanoftp.html @@ -1,2724 +1,277 @@ -nanoftp
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

nanoftp

Name

nanoftp -- 

Synopsis


+
+nanoftp
PrevUpHomeGnome XML Library Reference ManualNext
nanoftp
nanoftp — 
Synopsis
 
-void        (*ftpListCallback)              (void *userData,
+
+
+void        (*ftpListCallback)              (void *userData,
                                              const char *filename,
                                              const char *attrib,
                                              const char *owner,
                                              const char *group,
-                                             unsigned long size,
+                                             unsigned long size,
                                              int links,
                                              int year,
                                              const char *month,
                                              int day,
                                              int hour,
                                              int minute);
-void        (*ftpDataCallback)              (void *userData,
+void        (*ftpDataCallback)              (void *userData,
                                              const char *data,
                                              int len);
-void        xmlNanoFTPInit                  (void);
-void        xmlNanoFTPCleanup               (void);
-void*       xmlNanoFTPNewCtxt               (const char *URL);
-void        xmlNanoFTPFreeCtxt              (void *ctx);
-void*       xmlNanoFTPConnectTo             (const char *server,
+void        xmlNanoFTPInit                  (void);
+void        xmlNanoFTPCleanup               (void);
+void*       xmlNanoFTPNewCtxt               (const char *URL);
+void        xmlNanoFTPFreeCtxt              (void *ctx);
+void*       xmlNanoFTPConnectTo             (const char *server,
                                              int port);
-void*       xmlNanoFTPOpen                  (const char *URL);
-int         xmlNanoFTPConnect               (void *ctx);
-int         xmlNanoFTPClose                 (void *ctx);
-int         xmlNanoFTPQuit                  (void *ctx);
-void        xmlNanoFTPScanProxy             (const char *URL);
-void        xmlNanoFTPProxy                 (const char *host,
+void*       xmlNanoFTPOpen                  (const char *URL);
+int         xmlNanoFTPConnect               (void *ctx);
+int         xmlNanoFTPClose                 (void *ctx);
+int         xmlNanoFTPQuit                  (void *ctx);
+void        xmlNanoFTPScanProxy             (const char *URL);
+void        xmlNanoFTPProxy                 (const char *host,
                                              int port,
                                              const char *user,
                                              const char *passwd,
                                              int type);
-int         xmlNanoFTPUpdateURL             (void *ctx,
+int         xmlNanoFTPUpdateURL             (void *ctx,
                                              const char *URL);
-int         xmlNanoFTPGetResponse           (void *ctx);
-int         xmlNanoFTPCheckResponse         (void *ctx);
-int         xmlNanoFTPCwd                   (void *ctx,
+int         xmlNanoFTPGetResponse           (void *ctx);
+int         xmlNanoFTPCheckResponse         (void *ctx);
+int         xmlNanoFTPCwd                   (void *ctx,
                                              char *directory);
-int         xmlNanoFTPDele                  (void *ctx,
+int         xmlNanoFTPDele                  (void *ctx,
                                              char *file);
-int         xmlNanoFTPGetConnection         (void *ctx);
-int         xmlNanoFTPCloseConnection       (void *ctx);
-int         xmlNanoFTPList                  (void *ctx,
-                                             ftpListCallback callback,
+int         xmlNanoFTPGetConnection         (void *ctx);
+int         xmlNanoFTPCloseConnection       (void *ctx);
+int         xmlNanoFTPList                  (void *ctx,
+                                             ftpListCallback callback,
                                              void *userData,
                                              char *filename);
-int         xmlNanoFTPGetSocket             (void *ctx,
+int         xmlNanoFTPGetSocket             (void *ctx,
                                              const char *filename);
-int         xmlNanoFTPGet                   (void *ctx,
-                                             ftpDataCallback callback,
+int         xmlNanoFTPGet                   (void *ctx,
+                                             ftpDataCallback callback,
                                              void *userData,
                                              const char *filename);
-int         xmlNanoFTPRead                  (void *ctx,
+int         xmlNanoFTPRead                  (void *ctx,
                                              void *dest,
-                                             int len);

Description

Details

ftpListCallback ()

void        (*ftpListCallback)              (void *userData,
+                                             int len);
+

Description

+ +

Details

ftpListCallback ()

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

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

userData : 
filename : 
attrib : 
owner : 
group : 
Param6 : 
links : 
year : 
month : 
day : 
hour : 
minute : 

ftpDataCallback ()

void        (*ftpDataCallback)              (void *userData,
+                                             int minute);

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

+ +

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

ftpDataCallback ()

void        (*ftpDataCallback)              (void *userData,
                                              const char *data,
-                                             int len);

A callback for the xmlNanoFTPGet command.

userData : 
data : 
len : 

xmlNanoFTPInit ()

void        xmlNanoFTPInit                  (void);

Initialize the FTP protocol layer. + int len);

+A callback for the xmlNanoFTPGet command.

+ +

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

xmlNanoFTPInit ()

void        xmlNanoFTPInit                  (void);

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

xmlNanoFTPCleanup ()

void        xmlNanoFTPCleanup               (void);

Cleanup the FTP protocol layer. This cleanup proxy informations.

xmlNanoFTPNewCtxt ()

void*       xmlNanoFTPNewCtxt               (const char *URL);

Allocate and initialize a new FTP context.

URL : 

xmlNanoFTPFreeCtxt ()

void        xmlNanoFTPFreeCtxt              (void *ctx);

Frees the context after closing the connection.

ctx : 

xmlNanoFTPConnectTo ()

void*       xmlNanoFTPConnectTo             (const char *server,
-                                             int port);

Tries to open a control connection to the given server/port

server : 
port : 

xmlNanoFTPOpen ()

void*       xmlNanoFTPOpen                  (const char *URL);

Start to fetch the given ftp:// resource

URL : 

xmlNanoFTPConnect ()

int         xmlNanoFTPConnect               (void *ctx);

Tries to open a control connection

ctx : 
Returns : 

xmlNanoFTPClose ()

int         xmlNanoFTPClose                 (void *ctx);

Close the connection and both control and transport

ctx : 
Returns : 

xmlNanoFTPQuit ()

int         xmlNanoFTPQuit                  (void *ctx);

Send a QUIT command to the server

ctx : 
Returns : 

xmlNanoFTPScanProxy ()

void        xmlNanoFTPScanProxy             (const char *URL);

(Re)Initialize the FTP Proxy context by parsing the URL and finding +and get the hostname

+ +

xmlNanoFTPCleanup ()

void        xmlNanoFTPCleanup               (void);

+Cleanup the FTP protocol layer. This cleanup proxy informations.

+ +

xmlNanoFTPNewCtxt ()

void*       xmlNanoFTPNewCtxt               (const char *URL);

+Allocate and initialize a new FTP context.

+ +

URL : The URL used to initialize the context +

xmlNanoFTPFreeCtxt ()

void        xmlNanoFTPFreeCtxt              (void *ctx);

+Frees the context after closing the connection.

+ +

ctx : an FTP context +

xmlNanoFTPConnectTo ()

void*       xmlNanoFTPConnectTo             (const char *server,
+                                             int port);

+Tries to open a control connection to the given server/port

+ +

server : an FTP server name +
port : the port (use 21 if 0) +

xmlNanoFTPOpen ()

void*       xmlNanoFTPOpen                  (const char *URL);

+Start to fetch the given ftp:// resource

+ +

URL : the URL to the resource +

xmlNanoFTPConnect ()

int         xmlNanoFTPConnect               (void *ctx);

+Tries to open a control connection

+ +

ctx : an FTP context +
Returns :-1 in case of error, 0 otherwise +

xmlNanoFTPClose ()

int         xmlNanoFTPClose                 (void *ctx);

+Close the connection and both control and transport

+ +

ctx : an FTP context +
Returns :-1 incase of error, 0 otherwise +

xmlNanoFTPQuit ()

int         xmlNanoFTPQuit                  (void *ctx);

+Send a QUIT command to the server

+ +

ctx : an FTP context +
Returns :-1 in case of error, 0 otherwise +

xmlNanoFTPScanProxy ()

void        xmlNanoFTPScanProxy             (const char *URL);

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

URL : 

xmlNanoFTPProxy ()

void        xmlNanoFTPProxy                 (const char *host,
+A NULL URL cleans up proxy informations.

+
+
URL :  The proxy URL used to initialize the proxy context
+
xmlNanoFTPProxy ()
void        xmlNanoFTPProxy                 (const char *host,
                                              int port,
                                              const char *user,
                                              const char *passwd,
-                                             int type);

Setup the FTP proxy informations. + int type);

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

host : 
port : 
user : 
passwd : 
type : 

xmlNanoFTPUpdateURL ()

int         xmlNanoFTPUpdateURL             (void *ctx,
-                                             const char *URL);

Update an FTP context by parsing the URL and finding +ftp_proxy_password environment variables.

+ +

host : the proxy host name +
port : the proxy port +
user : the proxy user name +
passwd : the proxy password +
type : the type of proxy 1 for using SITE, 2 for USER ab +

xmlNanoFTPUpdateURL ()

int         xmlNanoFTPUpdateURL             (void *ctx,
+                                             const char *URL);

+Update an FTP context by parsing the URL and finding new path it indicates. If there is an error in the protocol, hostname, port or other information, the error is raised. It indicates a new connection has to -be established.

ctx : 
URL : 
Returns : 

xmlNanoFTPGetResponse ()

int         xmlNanoFTPGetResponse           (void *ctx);

Get the response from the FTP server after a command.

ctx : 
Returns : 

xmlNanoFTPCheckResponse ()

int         xmlNanoFTPCheckResponse         (void *ctx);

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

ctx : 
Returns : 

xmlNanoFTPCwd ()

int         xmlNanoFTPCwd                   (void *ctx,
-                                             char *directory);

Tries to change the remote directory

ctx : 
directory : 
Returns : 

xmlNanoFTPDele ()

int         xmlNanoFTPDele                  (void *ctx,
-                                             char *file);

Tries to delete an item (file or directory) from server

ctx : 
file : 
Returns : 

xmlNanoFTPGetConnection ()

int         xmlNanoFTPGetConnection         (void *ctx);

Try to open a data connection to the server. Currently only -passive mode is supported.

ctx : 
Returns : 

xmlNanoFTPCloseConnection ()

int         xmlNanoFTPCloseConnection       (void *ctx);

Close the data connection from the server

ctx : 
Returns : 

xmlNanoFTPList ()

int         xmlNanoFTPList                  (void *ctx,
-                                             ftpListCallback callback,
+be established.

+
+
ctx :  an FTP context
+
URL :  The URL used to update the context
+
Returns :0 if Ok, -1 in case of error (other host).
+
xmlNanoFTPGetResponse ()
int         xmlNanoFTPGetResponse           (void *ctx);

+Get the response from the FTP server after a command.

+
+
ctx :  an FTP context
+
Returns :the code number
+
xmlNanoFTPCheckResponse ()
int         xmlNanoFTPCheckResponse         (void *ctx);

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

+
+
ctx :  an FTP context
+
Returns :the code number, or 0
+
xmlNanoFTPCwd ()
int         xmlNanoFTPCwd                   (void *ctx,
+                                             char *directory);

+Tries to change the remote directory

+
+
ctx :  an FTP context
+
directory :  a directory on the server
+
Returns :-1 incase of error, 1 if CWD worked, 0 if it failed
+
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
+
xmlNanoFTPGetConnection ()
int         xmlNanoFTPGetConnection         (void *ctx);

+Try to open a data connection to the server. Currently only
+passive mode is supported.

+
+
ctx :  an FTP context
+
Returns :-1 incase of error, 0 otherwise
+
xmlNanoFTPCloseConnection ()
int         xmlNanoFTPCloseConnection       (void *ctx);

+Close the data connection from the server

+
+
ctx :  an FTP context
+
Returns :-1 incase of error, 0 otherwise
+
xmlNanoFTPList ()
int         xmlNanoFTPList                  (void *ctx,
+                                             ftpListCallback callback,
                                              void *userData,
-                                             char *filename);

Do a listing on the server. All files info are passed back -in the callbacks.

ctx : 
callback : 
userData : 
filename : 
Returns : 

xmlNanoFTPGetSocket ()

int         xmlNanoFTPGetSocket             (void *ctx,
-                                             const char *filename);

Initiate fetch of the given file from the server.

ctx : 
filename : 
Returns : 

xmlNanoFTPGet ()

int         xmlNanoFTPGet                   (void *ctx,
-                                             ftpDataCallback callback,
+                                             char *filename);

+Do a listing on the server. All files info are passed back +in the callbacks.

+ +

ctx : an FTP context +
callback : the user callback +
userData : the user callback data +
filename : optional files to list +
Returns :-1 incase of error, 0 otherwise +

xmlNanoFTPGetSocket ()

int         xmlNanoFTPGetSocket             (void *ctx,
+                                             const char *filename);

+Initiate fetch of the given file from the server.

+ +

ctx : an FTP context +
filename : the file to retrieve (or NULL if path is in context). +
Returns :the socket for the data connection, or <0 in case of error +

xmlNanoFTPGet ()

int         xmlNanoFTPGet                   (void *ctx,
+                                             ftpDataCallback callback,
                                              void *userData,
-                                             const char *filename);

Fetch the given file from the server. All data are passed back -in the callbacks. The last callback has a size of 0 block.

ctx : 
callback : 
userData : 
filename : 
Returns : 

xmlNanoFTPRead ()

int         xmlNanoFTPRead                  (void *ctx,
+                                             const char *filename);

+Fetch the given file from the server. All data are passed back +in the callbacks. The last callback has a size of 0 block.

+ +

ctx : an FTP context +
callback : the user callback +
userData : the user callback data +
filename : the file to retrieve +
Returns :-1 incase of error, 0 otherwise +

xmlNanoFTPRead ()

int         xmlNanoFTPRead                  (void *ctx,
                                              void *dest,
-                                             int len);

This function tries to read len bytes from the existing FTP connection -and saves them in dest. This is a blocking call.

ctx : 
dest : 
len : 
Returns : 

\ No newline at end of file + int len);

+This function tries to read len bytes from the existing FTP connection +and saves them in dest. This is a blocking call.

+ +

ctx : the FTP context +
dest : a buffer +
len : the buffer length +
Returns :the number of byte read. 0 is an indication of an end of connection. + -1 indicates a parameter error. +
<< nanohttpxmlIO >>
diff --git a/doc/html/libxml-nanohttp.html b/doc/html/libxml-nanohttp.html index 88bb88cb..7acee2a8 100644 --- a/doc/html/libxml-nanohttp.html +++ b/doc/html/libxml-nanohttp.html @@ -1,1584 +1,183 @@ -nanohttp
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

nanohttp

Name

nanohttp -- 

Synopsis


+
+nanohttp
PrevUpHomeGnome XML Library Reference ManualNext
nanohttp
nanohttp — 
Synopsis
 
-void        xmlNanoHTTPInit                 (void);
-void        xmlNanoHTTPCleanup              (void);
-void        xmlNanoHTTPScanProxy            (const char *URL);
-int         xmlNanoHTTPFetch                (const char *URL,
+
+
+void        xmlNanoHTTPInit                 (void);
+void        xmlNanoHTTPCleanup              (void);
+void        xmlNanoHTTPScanProxy            (const char *URL);
+int         xmlNanoHTTPFetch                (const char *URL,
                                              const char *filename,
                                              char **contentType);
-void*       xmlNanoHTTPMethod               (const char *URL,
+void*       xmlNanoHTTPMethod               (const char *URL,
                                              const char *method,
                                              const char *input,
                                              char **contentType,
                                              const char *headers,
                                              int ilen);
-void*       xmlNanoHTTPMethodRedir          (const char *URL,
+void*       xmlNanoHTTPMethodRedir          (const char *URL,
                                              const char *method,
                                              const char *input,
                                              char **contentType,
                                              char **redir,
                                              const char *headers,
                                              int ilen);
-void*       xmlNanoHTTPOpen                 (const char *URL,
+void*       xmlNanoHTTPOpen                 (const char *URL,
                                              char **contentType);
-void*       xmlNanoHTTPOpenRedir            (const char *URL,
+void*       xmlNanoHTTPOpenRedir            (const char *URL,
                                              char **contentType,
                                              char **redir);
-int         xmlNanoHTTPReturnCode           (void *ctx);
-const char* xmlNanoHTTPAuthHeader           (void *ctx);
-int         xmlNanoHTTPRead                 (void *ctx,
+int         xmlNanoHTTPReturnCode           (void *ctx);
+const char* xmlNanoHTTPAuthHeader           (void *ctx);
+int         xmlNanoHTTPRead                 (void *ctx,
                                              void *dest,
                                              int len);
-int         xmlNanoHTTPSave                 (void *ctxt,
+int         xmlNanoHTTPSave                 (void *ctxt,
                                              const char *filename);
-void        xmlNanoHTTPClose                (void *ctx);

Description

Details

xmlNanoHTTPInit ()

void        xmlNanoHTTPInit                 (void);

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

xmlNanoHTTPCleanup ()

void        xmlNanoHTTPCleanup              (void);

Cleanup the HTTP protocol layer.

xmlNanoHTTPScanProxy ()

void        xmlNanoHTTPScanProxy            (const char *URL);

(Re)Initialize the HTTP Proxy context by parsing the URL and finding +void xmlNanoHTTPClose (void *ctx); +

Description

+ +

Details

xmlNanoHTTPInit ()

void        xmlNanoHTTPInit                 (void);

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

+ +

xmlNanoHTTPCleanup ()

void        xmlNanoHTTPCleanup              (void);

+Cleanup the HTTP protocol layer.

+ +

xmlNanoHTTPScanProxy ()

void        xmlNanoHTTPScanProxy            (const char *URL);

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

URL : 

xmlNanoHTTPFetch ()

int         xmlNanoHTTPFetch                (const char *URL,
+A NULL URL cleans up proxy informations.

+
+
URL :  The proxy URL used to initialize the proxy context
+
xmlNanoHTTPFetch ()
int         xmlNanoHTTPFetch                (const char *URL,
                                              const char *filename,
-                                             char **contentType);

This function try to fetch the indicated resource via HTTP GET -and save it's content in the file.

URL : 
filename : 
contentType : 
Returns : 

xmlNanoHTTPMethod ()

void*       xmlNanoHTTPMethod               (const char *URL,
+                                             char **contentType);

+This function try to fetch the indicated resource via HTTP GET +and save it's content in the file.

+ +

URL : The URL to load +
filename : the filename where the content should be saved +
contentType : if available the Content-Type information will be + returned at that location +
Returns :-1 in case of failure, 0 incase of success. The contentType, + if provided must be freed by the caller +

xmlNanoHTTPMethod ()

void*       xmlNanoHTTPMethod               (const char *URL,
                                              const char *method,
                                              const char *input,
                                              char **contentType,
                                              const char *headers,
-                                             int ilen);

This function try to open a connection to the indicated resource -via HTTP using the given method, adding the given extra headers -and the input buffer for the request content.

URL : 
method : 
input : 
contentType : 
headers : 
ilen : 

xmlNanoHTTPMethodRedir ()

void*       xmlNanoHTTPMethodRedir          (const char *URL,
+                                             int ilen);

+This function try to open a connection to the indicated resource +via HTTP using the given method, adding the given extra headers +and the input buffer for the request content.

+ +

URL : The URL to load +
method : the HTTP method to use +
input : the input string if any +
contentType : the Content-Type information IN and OUT +
headers : the extra headers +
ilen : input length +

xmlNanoHTTPMethodRedir ()

void*       xmlNanoHTTPMethodRedir          (const char *URL,
                                              const char *method,
                                              const char *input,
                                              char **contentType,
                                              char **redir,
                                              const char *headers,
-                                             int ilen);

This function try to open a connection to the indicated resource -via HTTP using the given method, adding the given extra headers -and the input buffer for the request content.

URL : 
method : 
input : 
contentType : 
redir : 
headers : 
ilen : 

xmlNanoHTTPOpen ()

void*       xmlNanoHTTPOpen                 (const char *URL,
-                                             char **contentType);

This function try to open a connection to the indicated resource -via HTTP GET.

URL : 
contentType : 

xmlNanoHTTPOpenRedir ()

void*       xmlNanoHTTPOpenRedir            (const char *URL,
+                                             int ilen);

+This function try to open a connection to the indicated resource +via HTTP using the given method, adding the given extra headers +and the input buffer for the request content.

+ +

URL : The URL to load +
method : the HTTP method to use +
input : the input string if any +
contentType : the Content-Type information IN and OUT +
redir : the redirected URL OUT +
headers : the extra headers +
ilen : input length +

xmlNanoHTTPOpen ()

void*       xmlNanoHTTPOpen                 (const char *URL,
+                                             char **contentType);

+This function try to open a connection to the indicated resource +via HTTP GET.

+ +

URL : The URL to load +
contentType : if available the Content-Type information will be + returned at that location +

xmlNanoHTTPOpenRedir ()

void*       xmlNanoHTTPOpenRedir            (const char *URL,
                                              char **contentType,
-                                             char **redir);

This function try to open a connection to the indicated resource -via HTTP GET.

URL : 
contentType : 
redir : 

xmlNanoHTTPReturnCode ()

int         xmlNanoHTTPReturnCode           (void *ctx);

Get the latest HTTP return code received

ctx : 
Returns : 

xmlNanoHTTPAuthHeader ()

const char* xmlNanoHTTPAuthHeader           (void *ctx);

Get the authentication header of an HTTP context

ctx : 
Returns : 

xmlNanoHTTPRead ()

int         xmlNanoHTTPRead                 (void *ctx,
+                                             char **redir);

+This function try to open a connection to the indicated resource +via HTTP GET.

+ +

URL : The URL to load +
contentType : if available the Content-Type information will be + returned at that location +
redir : if available the redirected URL will be returned +

xmlNanoHTTPReturnCode ()

int         xmlNanoHTTPReturnCode           (void *ctx);

+Get the latest HTTP return code received

+ +

ctx : the HTTP context +
Returns :the HTTP return code for the request. +

xmlNanoHTTPAuthHeader ()

const char* xmlNanoHTTPAuthHeader           (void *ctx);

+Get the authentication header of an HTTP context

+ +

ctx : the HTTP context +
Returns :the stashed value of the WWW-Authenticate or Proxy-Authenticate +header. +

xmlNanoHTTPRead ()

int         xmlNanoHTTPRead                 (void *ctx,
                                              void *dest,
-                                             int len);

This function tries to read len bytes from the existing HTTP connection -and saves them in dest. This is a blocking call.

ctx : 
dest : 
len : 
Returns : 

xmlNanoHTTPSave ()

int         xmlNanoHTTPSave                 (void *ctxt,
-                                             const char *filename);

This function saves the output of the HTTP transaction to a file -It closes and free the context at the end

ctxt : 
filename : 
Returns : 

xmlNanoHTTPClose ()

void        xmlNanoHTTPClose                (void *ctx);

This function closes an HTTP context, it ends up the connection and -free all data related to it.

ctx : 

\ No newline at end of file + int len);

+This function tries to read len bytes from the existing HTTP connection +and saves them in dest. This is a blocking call.

+ +

ctx : the HTTP context +
dest : a buffer +
len : the buffer length +
Returns :the number of byte read. 0 is an indication of an end of connection. + -1 indicates a parameter error. +

xmlNanoHTTPSave ()

int         xmlNanoHTTPSave                 (void *ctxt,
+                                             const char *filename);

+This function saves the output of the HTTP transaction to a file +It closes and free the context at the end

+ +

ctxt : the HTTP context +
filename : the filename where the content should be saved +
Returns :-1 in case of failure, 0 incase of success. +

xmlNanoHTTPClose ()

void        xmlNanoHTTPClose                (void *ctx);

+This function closes an HTTP context, it ends up the connection and +free all data related to it.

+ +

ctx : the HTTP context +
<< xincludenanoftp >>
diff --git a/doc/html/libxml-notes.html b/doc/html/libxml-notes.html index 68773175..ca83d9fa 100644 --- a/doc/html/libxml-notes.html +++ b/doc/html/libxml-notes.html @@ -1,214 +1,34 @@ -Libxml Programming Notes
Gnome XML Library Reference Manual
<<< Previous PageHome Next Page >>>

Libxml Programming Notes

Libxml is an XML toolkit library, it allows to parse, edit + +Libxml Programming Notes
PrevHomeGnome XML Library Reference ManualNext

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 - so the same range of tools can be used with HTML input.



<<< Previous PageHome Next Page >>>
Gnome XML Library Reference ManualLibxml Library Reference
\ No newline at end of file + so the same range of tools can be used with HTML input.

<< Gnome XML Library Reference ManualLibxml Library Reference >>
diff --git a/doc/html/libxml-parser.html b/doc/html/libxml-parser.html index f73e4427..c9ee40df 100644 --- a/doc/html/libxml-parser.html +++ b/doc/html/libxml-parser.html @@ -1,1403 +1,312 @@ -parser
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

parser

Name

parser -- 

Synopsis


+
+parser
PrevUpHomeGnome XML Library Reference ManualNext
parser
parser — 
Synopsis
 
-#define     XML_DEFAULT_VERSION
-void        (*xmlParserInputDeallocate)     (xmlChar *str);
-struct      xmlParserInput;
-struct      xmlParserNodeInfo;
-typedef     xmlParserNodeInfoPtr;
-struct      xmlParserNodeInfoSeq;
-typedef     xmlParserNodeInfoSeqPtr;
-enum        xmlParserInputState;
-#define     XML_DETECT_IDS
-#define     XML_COMPLETE_ATTRS
-#define     XML_SKIP_IDS
-struct      xmlParserCtxt;
-struct      xmlSAXLocator;
-xmlParserInputPtr (*resolveEntitySAXFunc)   (void *ctx,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId);
-void        (*internalSubsetSAXFunc)        (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
-void        (*externalSubsetSAXFunc)        (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
-xmlEntityPtr (*getEntitySAXFunc)            (void *ctx,
-                                             const xmlChar *name);
-xmlEntityPtr (*getParameterEntitySAXFunc)   (void *ctx,
-                                             const xmlChar *name);
-void        (*entityDeclSAXFunc)            (void *ctx,
-                                             const xmlChar *name,
+
+
+#define     XML_DEFAULT_VERSION
+void        (*xmlParserInputDeallocate)     (xmlChar *str);
+struct      xmlParserInput;
+struct      xmlParserNodeInfo;
+typedef     xmlParserNodeInfoPtr;
+struct      xmlParserNodeInfoSeq;
+typedef     xmlParserNodeInfoSeqPtr;
+enum        xmlParserInputState;
+#define     XML_DETECT_IDS
+#define     XML_COMPLETE_ATTRS
+#define     XML_SKIP_IDS
+struct      xmlParserCtxt;
+struct      xmlSAXLocator;
+xmlParserInputPtr (*resolveEntitySAXFunc)   (void *ctx,
+                                             const xmlChar *publicId,
+                                             const xmlChar *systemId);
+void        (*internalSubsetSAXFunc)        (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);
+void        (*externalSubsetSAXFunc)        (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);
+xmlEntityPtr (*getEntitySAXFunc)            (void *ctx,
+                                             const xmlChar *name);
+xmlEntityPtr (*getParameterEntitySAXFunc)   (void *ctx,
+                                             const xmlChar *name);
+void        (*entityDeclSAXFunc)            (void *ctx,
+                                             const xmlChar *name,
                                              int type,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId,
-                                             xmlChar *content);
-void        (*notationDeclSAXFunc)          (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId);
-void        (*attributeDeclSAXFunc)         (void *ctx,
-                                             const xmlChar *elem,
-                                             const xmlChar *fullname,
+                                             const xmlChar *publicId,
+                                             const xmlChar *systemId,
+                                             xmlChar *content);
+void        (*notationDeclSAXFunc)          (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *publicId,
+                                             const xmlChar *systemId);
+void        (*attributeDeclSAXFunc)         (void *ctx,
+                                             const xmlChar *elem,
+                                             const xmlChar *fullname,
                                              int type,
                                              int def,
-                                             const xmlChar *defaultValue,
-                                             xmlEnumerationPtr tree);
-void        (*elementDeclSAXFunc)           (void *ctx,
-                                             const xmlChar *name,
+                                             const xmlChar *defaultValue,
+                                             xmlEnumerationPtr tree);
+void        (*elementDeclSAXFunc)           (void *ctx,
+                                             const xmlChar *name,
                                              int type,
-                                             xmlElementContentPtr content);
-void        (*unparsedEntityDeclSAXFunc)    (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId,
-                                             const xmlChar *notationName);
-void        (*setDocumentLocatorSAXFunc)    (void *ctx,
-                                             xmlSAXLocatorPtr loc);
-void        (*startDocumentSAXFunc)         (void *ctx);
-void        (*endDocumentSAXFunc)           (void *ctx);
-void        (*startElementSAXFunc)          (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar **atts);
-void        (*endElementSAXFunc)            (void *ctx,
-                                             const xmlChar *name);
-void        (*attributeSAXFunc)             (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *value);
-void        (*referenceSAXFunc)             (void *ctx,
-                                             const xmlChar *name);
-void        (*charactersSAXFunc)            (void *ctx,
-                                             const xmlChar *ch,
+                                             xmlElementContentPtr content);
+void        (*unparsedEntityDeclSAXFunc)    (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *publicId,
+                                             const xmlChar *systemId,
+                                             const xmlChar *notationName);
+void        (*setDocumentLocatorSAXFunc)    (void *ctx,
+                                             xmlSAXLocatorPtr loc);
+void        (*startDocumentSAXFunc)         (void *ctx);
+void        (*endDocumentSAXFunc)           (void *ctx);
+void        (*startElementSAXFunc)          (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar **atts);
+void        (*endElementSAXFunc)            (void *ctx,
+                                             const xmlChar *name);
+void        (*attributeSAXFunc)             (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *value);
+void        (*referenceSAXFunc)             (void *ctx,
+                                             const xmlChar *name);
+void        (*charactersSAXFunc)            (void *ctx,
+                                             const xmlChar *ch,
                                              int len);
-void        (*ignorableWhitespaceSAXFunc)   (void *ctx,
-                                             const xmlChar *ch,
+void        (*ignorableWhitespaceSAXFunc)   (void *ctx,
+                                             const xmlChar *ch,
                                              int len);
-void        (*processingInstructionSAXFunc) (void *ctx,
-                                             const xmlChar *target,
-                                             const xmlChar *data);
-void        (*commentSAXFunc)               (void *ctx,
-                                             const xmlChar *value);
-void        (*cdataBlockSAXFunc)            (void *ctx,
-                                             const xmlChar *value,
+void        (*processingInstructionSAXFunc) (void *ctx,
+                                             const xmlChar *target,
+                                             const xmlChar *data);
+void        (*commentSAXFunc)               (void *ctx,
+                                             const xmlChar *value);
+void        (*cdataBlockSAXFunc)            (void *ctx,
+                                             const xmlChar *value,
                                              int len);
-void        (*warningSAXFunc)               (void *ctx,
+void        (*warningSAXFunc)               (void *ctx,
                                              const char *msg,
                                              ...);
-void        (*errorSAXFunc)                 (void *ctx,
+void        (*errorSAXFunc)                 (void *ctx,
                                              const char *msg,
                                              ...);
-void        (*fatalErrorSAXFunc)            (void *ctx,
+void        (*fatalErrorSAXFunc)            (void *ctx,
                                              const char *msg,
                                              ...);
-int         (*isStandaloneSAXFunc)          (void *ctx);
-int         (*hasInternalSubsetSAXFunc)     (void *ctx);
-int         (*hasExternalSubsetSAXFunc)     (void *ctx);
-struct      xmlSAXHandler;
-xmlParserInputPtr (*xmlExternalEntityLoader)
+int         (*isStandaloneSAXFunc)          (void *ctx);
+int         (*hasInternalSubsetSAXFunc)     (void *ctx);
+int         (*hasExternalSubsetSAXFunc)     (void *ctx);
+struct      xmlSAXHandler;
+xmlParserInputPtr (*xmlExternalEntityLoader)
                                             (const char *URL,
                                              const char *ID,
-                                             xmlParserCtxtPtr context);
-void        xmlInitParser                   (void);
-void        xmlCleanupParser                (void);
-int         xmlParserInputRead              (xmlParserInputPtr in,
+                                             xmlParserCtxtPtr context);
+void        xmlInitParser                   (void);
+void        xmlCleanupParser                (void);
+int         xmlParserInputRead              (xmlParserInputPtr in,
                                              int len);
-int         xmlParserInputGrow              (xmlParserInputPtr in,
+int         xmlParserInputGrow              (xmlParserInputPtr in,
                                              int len);
-xmlChar*    xmlStrdup                       (const xmlChar *cur);
-xmlChar*    xmlStrndup                      (const xmlChar *cur,
+xmlChar*    xmlStrdup                       (const xmlChar *cur);
+xmlChar*    xmlStrndup                      (const xmlChar *cur,
                                              int len);
-xmlChar*    xmlCharStrndup                  (const char *cur,
+xmlChar*    xmlCharStrndup                  (const char *cur,
                                              int len);
-xmlChar*    xmlCharStrdup                   (const char *cur);
-xmlChar*    xmlStrsub                       (const xmlChar *str,
+xmlChar*    xmlCharStrdup                   (const char *cur);
+xmlChar*    xmlStrsub                       (const xmlChar *str,
                                              int start,
                                              int len);
-const xmlChar* xmlStrchr                    (const xmlChar *str,
-                                             xmlChar val);
-const xmlChar* xmlStrstr                    (const xmlChar *str,
-                                             const xmlChar *val);
-const xmlChar* xmlStrcasestr                (const xmlChar *str,
-                                             xmlChar *val);
-int         xmlStrcmp                       (const xmlChar *str1,
-                                             const xmlChar *str2);
-int         xmlStrncmp                      (const xmlChar *str1,
-                                             const xmlChar *str2,
+const xmlChar* xmlStrchr                    (const xmlChar *str,
+                                             xmlChar val);
+const xmlChar* xmlStrstr                    (const xmlChar *str,
+                                             const xmlChar *val);
+const xmlChar* xmlStrcasestr                (const xmlChar *str,
+                                             xmlChar *val);
+int         xmlStrcmp                       (const xmlChar *str1,
+                                             const xmlChar *str2);
+int         xmlStrncmp                      (const xmlChar *str1,
+                                             const xmlChar *str2,
                                              int len);
-int         xmlStrcasecmp                   (const xmlChar *str1,
-                                             const xmlChar *str2);
-int         xmlStrncasecmp                  (const xmlChar *str1,
-                                             const xmlChar *str2,
+int         xmlStrcasecmp                   (const xmlChar *str1,
+                                             const xmlChar *str2);
+int         xmlStrncasecmp                  (const xmlChar *str1,
+                                             const xmlChar *str2,
                                              int len);
-int         xmlStrEqual                     (const xmlChar *str1,
-                                             const xmlChar *str2);
-int         xmlStrlen                       (const xmlChar *str);
-xmlChar*    xmlStrcat                       (xmlChar *cur,
-                                             const xmlChar *add);
-xmlChar*    xmlStrncat                      (xmlChar *cur,
-                                             const xmlChar *add,
+int         xmlStrEqual                     (const xmlChar *str1,
+                                             const xmlChar *str2);
+int         xmlStrlen                       (const xmlChar *str);
+xmlChar*    xmlStrcat                       (xmlChar *cur,
+                                             const xmlChar *add);
+xmlChar*    xmlStrncat                      (xmlChar *cur,
+                                             const xmlChar *add,
                                              int len);
-xmlDocPtr   xmlParseDoc                     (xmlChar *cur);
-xmlDocPtr   xmlParseMemory                  (const char *buffer,
+xmlDocPtr   xmlParseDoc                     (xmlChar *cur);
+xmlDocPtr   xmlParseMemory                  (const char *buffer,
                                              int size);
-xmlDocPtr   xmlParseFile                    (const char *filename);
-int         xmlSubstituteEntitiesDefault    (int val);
-int         xmlKeepBlanksDefault            (int val);
-void        xmlStopParser                   (xmlParserCtxtPtr ctxt);
-int         xmlPedanticParserDefault        (int val);
-int         xmlLineNumbersDefault           (int val);
-xmlDocPtr   xmlRecoverDoc                   (xmlChar *cur);
-xmlDocPtr   xmlRecoverMemory                (const char *buffer,
+xmlDocPtr   xmlParseFile                    (const char *filename);
+int         xmlSubstituteEntitiesDefault    (int val);
+int         xmlKeepBlanksDefault            (int val);
+void        xmlStopParser                   (xmlParserCtxtPtr ctxt);
+int         xmlPedanticParserDefault        (int val);
+int         xmlLineNumbersDefault           (int val);
+xmlDocPtr   xmlRecoverDoc                   (xmlChar *cur);
+xmlDocPtr   xmlRecoverMemory                (const char *buffer,
                                              int size);
-xmlDocPtr   xmlRecoverFile                  (const char *filename);
-int         xmlParseDocument                (xmlParserCtxtPtr ctxt);
-int         xmlParseExtParsedEnt            (xmlParserCtxtPtr ctxt);
-xmlDocPtr   xmlSAXParseDoc                  (xmlSAXHandlerPtr sax,
-                                             xmlChar *cur,
+xmlDocPtr   xmlRecoverFile                  (const char *filename);
+int         xmlParseDocument                (xmlParserCtxtPtr ctxt);
+int         xmlParseExtParsedEnt            (xmlParserCtxtPtr ctxt);
+xmlDocPtr   xmlSAXParseDoc                  (xmlSAXHandlerPtr sax,
+                                             xmlChar *cur,
                                              int recovery);
-int         xmlSAXUserParseFile             (xmlSAXHandlerPtr sax,
+int         xmlSAXUserParseFile             (xmlSAXHandlerPtr sax,
                                              void *user_data,
                                              const char *filename);
-int         xmlSAXUserParseMemory           (xmlSAXHandlerPtr sax,
+int         xmlSAXUserParseMemory           (xmlSAXHandlerPtr sax,
                                              void *user_data,
                                              const char *buffer,
                                              int size);
-xmlDocPtr   xmlSAXParseMemory               (xmlSAXHandlerPtr sax,
+xmlDocPtr   xmlSAXParseMemory               (xmlSAXHandlerPtr sax,
                                              const char *buffer,
                                              int size,
                                              int recovery);
-xmlDocPtr   xmlSAXParseMemoryWithData       (xmlSAXHandlerPtr sax,
+xmlDocPtr   xmlSAXParseMemoryWithData       (xmlSAXHandlerPtr sax,
                                              const char *buffer,
                                              int size,
                                              int recovery,
                                              void *data);
-xmlDocPtr   xmlSAXParseFile                 (xmlSAXHandlerPtr sax,
+xmlDocPtr   xmlSAXParseFile                 (xmlSAXHandlerPtr sax,
                                              const char *filename,
                                              int recovery);
-xmlDocPtr   xmlSAXParseFileWithData         (xmlSAXHandlerPtr sax,
+xmlDocPtr   xmlSAXParseFileWithData         (xmlSAXHandlerPtr sax,
                                              const char *filename,
                                              int recovery,
                                              void *data);
-xmlDocPtr   xmlSAXParseEntity               (xmlSAXHandlerPtr sax,
+xmlDocPtr   xmlSAXParseEntity               (xmlSAXHandlerPtr sax,
                                              const char *filename);
-xmlDocPtr   xmlParseEntity                  (const char *filename);
-xmlDtdPtr   xmlParseDTD                     (const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
-xmlDtdPtr   xmlSAXParseDTD                  (xmlSAXHandlerPtr sax,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
-xmlDtdPtr   xmlIOParseDTD                   (xmlSAXHandlerPtr sax,
-                                             xmlParserInputBufferPtr input,
-                                             xmlCharEncoding enc);
-int         xmlParseBalancedChunkMemory     (xmlDocPtr doc,
-                                             xmlSAXHandlerPtr sax,
+xmlDocPtr   xmlParseEntity                  (const char *filename);
+xmlDtdPtr   xmlParseDTD                     (const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);
+xmlDtdPtr   xmlSAXParseDTD                  (xmlSAXHandlerPtr sax,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);
+xmlDtdPtr   xmlIOParseDTD                   (xmlSAXHandlerPtr sax,
+                                             xmlParserInputBufferPtr input,
+                                             xmlCharEncoding enc);
+int         xmlParseBalancedChunkMemory     (xmlDocPtr doc,
+                                             xmlSAXHandlerPtr sax,
                                              void *user_data,
                                              int depth,
-                                             const xmlChar *string,
-                                             xmlNodePtr *lst);
-int         xmlParseBalancedChunkMemoryRecover
-                                            (xmlDocPtr doc,
-                                             xmlSAXHandlerPtr sax,
+                                             const xmlChar *string,
+                                             xmlNodePtr *lst);
+int         xmlParseBalancedChunkMemoryRecover
+                                            (xmlDocPtr doc,
+                                             xmlSAXHandlerPtr sax,
                                              void *user_data,
                                              int depth,
-                                             const xmlChar *string,
-                                             xmlNodePtr *lst,
+                                             const xmlChar *string,
+                                             xmlNodePtr *lst,
                                              int recover);
-int         xmlParseExternalEntity          (xmlDocPtr doc,
-                                             xmlSAXHandlerPtr sax,
+int         xmlParseExternalEntity          (xmlDocPtr doc,
+                                             xmlSAXHandlerPtr sax,
                                              void *user_data,
                                              int depth,
-                                             const xmlChar *URL,
-                                             const xmlChar *ID,
-                                             xmlNodePtr *lst);
-int         xmlParseCtxtExternalEntity      (xmlParserCtxtPtr ctx,
-                                             const xmlChar *URL,
-                                             const xmlChar *ID,
-                                             xmlNodePtr *lst);
-void        xmlInitParserCtxt               (xmlParserCtxtPtr ctxt);
-void        xmlClearParserCtxt              (xmlParserCtxtPtr ctxt);
-void        xmlFreeParserCtxt               (xmlParserCtxtPtr ctxt);
-void        xmlSetupParserForBuffer         (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *buffer,
+                                             const xmlChar *URL,
+                                             const xmlChar *ID,
+                                             xmlNodePtr *lst);
+int         xmlParseCtxtExternalEntity      (xmlParserCtxtPtr ctx,
+                                             const xmlChar *URL,
+                                             const xmlChar *ID,
+                                             xmlNodePtr *lst);
+int         xmlInitParserCtxt               (xmlParserCtxtPtr ctxt);
+void        xmlClearParserCtxt              (xmlParserCtxtPtr ctxt);
+void        xmlFreeParserCtxt               (xmlParserCtxtPtr ctxt);
+void        xmlSetupParserForBuffer         (xmlParserCtxtPtr ctxt,
+                                             const xmlChar *buffer,
                                              const char *filename);
-xmlParserCtxtPtr xmlCreateDocParserCtxt     (xmlChar *cur);
-int         xmlGetFeaturesList              (int *len,
+xmlParserCtxtPtr xmlCreateDocParserCtxt     (xmlChar *cur);
+int         xmlGetFeaturesList              (int *len,
                                              const char **result);
-int         xmlGetFeature                   (xmlParserCtxtPtr ctxt,
+int         xmlGetFeature                   (xmlParserCtxtPtr ctxt,
                                              const char *name,
                                              void *result);
-int         xmlSetFeature                   (xmlParserCtxtPtr ctxt,
+int         xmlSetFeature                   (xmlParserCtxtPtr ctxt,
                                              const char *name,
                                              void *value);
-xmlParserCtxtPtr xmlCreatePushParserCtxt    (xmlSAXHandlerPtr sax,
+xmlParserCtxtPtr xmlCreatePushParserCtxt    (xmlSAXHandlerPtr sax,
                                              void *user_data,
                                              const char *chunk,
                                              int size,
                                              const char *filename);
-int         xmlParseChunk                   (xmlParserCtxtPtr ctxt,
+int         xmlParseChunk                   (xmlParserCtxtPtr ctxt,
                                              const char *chunk,
                                              int size,
                                              int terminate);
-xmlParserCtxtPtr xmlCreateIOParserCtxt      (xmlSAXHandlerPtr sax,
+xmlParserCtxtPtr xmlCreateIOParserCtxt      (xmlSAXHandlerPtr sax,
                                              void *user_data,
-                                             xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
+                                             xmlInputReadCallback ioread,
+                                             xmlInputCloseCallback ioclose,
                                              void *ioctx,
-                                             xmlCharEncoding enc);
-xmlParserInputPtr xmlNewIOInputStream       (xmlParserCtxtPtr ctxt,
-                                             xmlParserInputBufferPtr input,
-                                             xmlCharEncoding enc);
-const xmlParserNodeInfo* xmlParserFindNodeInfo
-                                            (const xmlParserCtxtPtr ctxt,
-                                             const xmlNodePtr node);
-void        xmlInitNodeInfoSeq              (xmlParserNodeInfoSeqPtr seq);
-void        xmlClearNodeInfoSeq             (xmlParserNodeInfoSeqPtr seq);
-unsigned long xmlParserFindNodeInfoIndex    (const xmlParserNodeInfoSeqPtr seq,
-                                             const xmlNodePtr node);
-void        xmlParserAddNodeInfo            (xmlParserCtxtPtr ctxt,
-                                             const xmlParserNodeInfoPtr info);
-void        xmlSetExternalEntityLoader      (xmlExternalEntityLoader f);
-xmlExternalEntityLoader xmlGetExternalEntityLoader
+                                             xmlCharEncoding enc);
+xmlParserInputPtr xmlNewIOInputStream       (xmlParserCtxtPtr ctxt,
+                                             xmlParserInputBufferPtr input,
+                                             xmlCharEncoding enc);
+const xmlParserNodeInfo* xmlParserFindNodeInfo
+                                            (const xmlParserCtxtPtr ctxt,
+                                             const xmlNodePtr node);
+void        xmlInitNodeInfoSeq              (xmlParserNodeInfoSeqPtr seq);
+void        xmlClearNodeInfoSeq             (xmlParserNodeInfoSeqPtr seq);
+unsigned long xmlParserFindNodeInfoIndex    (const xmlParserNodeInfoSeqPtr seq,
+                                             const xmlNodePtr node);
+void        xmlParserAddNodeInfo            (xmlParserCtxtPtr ctxt,
+                                             const xmlParserNodeInfoPtr info);
+void        xmlSetExternalEntityLoader      (xmlExternalEntityLoader f);
+xmlExternalEntityLoader xmlGetExternalEntityLoader
                                             (void);
-xmlParserInputPtr xmlLoadExternalEntity     (const char *URL,
+xmlParserInputPtr xmlLoadExternalEntity     (const char *URL,
                                              const char *ID,
-                                             xmlParserCtxtPtr ctxt);

Description

Details

XML_DEFAULT_VERSION

#define     XML_DEFAULT_VERSION

The default version of XML used: 1.0

xmlParserInputDeallocate ()

void        (*xmlParserInputDeallocate)     (xmlChar *str);

Callback for freeing some parser input allocations.

str : 

struct xmlParserInput

struct xmlParserInput {
+                                             xmlParserCtxtPtr ctxt);
+

Description

+ +

Details

XML_DEFAULT_VERSION

#define XML_DEFAULT_VERSION	"1.0"
+

+The default version of XML used: 1.0

+ +

xmlParserInputDeallocate ()

void        (*xmlParserInputDeallocate)     (xmlChar *str);

+Callback for freeing some parser input allocations.

+ +

str : the string to deallocate +

struct xmlParserInput

struct xmlParserInput {
     /* Input buffer */
     xmlParserInputBufferPtr buf;      /* UTF-8 encoded buffer */
 
@@ -1409,138 +318,52 @@ CLASS="PROGRAMLISTING"
     int length;                       /* length if known */
     int line;                         /* Current line */
     int col;                          /* Current column */
-    int consumed;                     /* How many xmlChars already consumed */
+    /*
+     * NOTE: consumed is only tested for equality in the parser code,
+     *       so even if there is an overflow this should not give troubles
+     *       for parsing very large instances.
+     */
+    unsigned long consumed;           /* How many xmlChars already consumed */
     xmlParserInputDeallocate free;    /* function to deallocate the base */
     const xmlChar *encoding;          /* the encoding string for entity */
     const xmlChar *version;           /* the version string for entity */
     int standalone;                   /* Was that entity marked standalone */
-};

An xmlParserInput is an input flow for the XML processor. +}; +

+An xmlParserInput is an input flow for the XML processor. Each entity parsed is associated an xmlParserInput (except the few predefined ones). This is the case both for internal entities - in which case the flow is already completely in memory - or external entities - in which case we use the buf structure for -progressive reading and I18N conversions to the internal UTF-8 format.

struct xmlParserNodeInfo

struct xmlParserNodeInfo {
+progressive reading and I18N conversions to the internal UTF-8 format.

+
+
struct xmlParserNodeInfo
struct xmlParserNodeInfo {
   const struct _xmlNode* node;
   /* Position & line # that text that created the node begins & ends on */
   unsigned long begin_pos;
   unsigned long begin_line;
   unsigned long end_pos;
   unsigned long end_line;
-};

The parser can be asked to collect Node informations, i.e. at what +}; +

+The parser can be asked to collect Node informations, i.e. at what place in the file they were detected. -NOTE: This is off by default and not very well tested.

xmlParserNodeInfoPtr

struct xmlParserNodeInfoSeq

struct xmlParserNodeInfoSeq {
+NOTE: This is off by default and not very well tested.

+
+
xmlParserNodeInfoPtr
typedef xmlParserNodeInfo *xmlParserNodeInfoPtr;
+

+
+
struct xmlParserNodeInfoSeq
struct xmlParserNodeInfoSeq {
   unsigned long maximum;
   unsigned long length;
   xmlParserNodeInfo* buffer;
-};

xmlParserNodeInfoSeqPtr

enum xmlParserInputState

typedef enum {
+};
+

+ +

xmlParserNodeInfoSeqPtr

typedef xmlParserNodeInfoSeq *xmlParserNodeInfoSeqPtr;
+

+ +

enum xmlParserInputState

typedef enum {
     XML_PARSER_EOF = -1,	/* nothing is to be parsed */
     XML_PARSER_START = 0,	/* nothing has been parsed */
     XML_PARSER_MISC,		/* Misc* before int subset */
@@ -1559,124 +382,28 @@ CLASS="PROGRAMLISTING"
     XML_PARSER_EPILOG, 		/* the Misc* after the last end tag */
     XML_PARSER_IGNORE,		/* within an IGNORED section */
     XML_PARSER_PUBLIC_LITERAL 	/* within a PUBLIC value */
-} xmlParserInputState;

The parser is now working also as a state based parser. -The recursive one use the state info for entities processing.

XML_DETECT_IDS

#define     XML_DETECT_IDS

Bit in the loadsubset context field to tell to do ID/REFs lookups. -Use it to initialize xmlLoadExtDtdDefaultValue.

XML_COMPLETE_ATTRS

#define     XML_COMPLETE_ATTRS

Bit in the loadsubset context field to tell to do complete the +} xmlParserInputState; +

+The parser is now working also as a state based parser. +The recursive one use the state info for entities processing.

+ +

XML_DETECT_IDS

#define XML_DETECT_IDS		2
+

+Bit in the loadsubset context field to tell to do ID/REFs lookups. +Use it to initialize xmlLoadExtDtdDefaultValue.

+ +

XML_COMPLETE_ATTRS

#define XML_COMPLETE_ATTRS	4
+

+Bit in the loadsubset context field to tell to do complete the elements attributes lists with the ones defaulted from the DTDs. -Use it to initialize xmlLoadExtDtdDefaultValue.

XML_SKIP_IDS

#define     XML_SKIP_IDS

Bit in the loadsubset context field to tell to not do ID/REFs registration. -Used to initialize xmlLoadExtDtdDefaultValue in some special cases.

struct xmlParserCtxt

struct xmlParserCtxt {
+Use it to initialize xmlLoadExtDtdDefaultValue.

+
+
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.

+
+
struct xmlParserCtxt
struct xmlParserCtxt {
     struct _xmlSAXHandler *sax;       /* The SAX handler */
     void            *userData;        /* For SAX interface only, used by DOM build */
     xmlDocPtr           myDoc;        /* the document being built */
@@ -1751,3110 +478,264 @@ CLASS="PROGRAMLISTING"
     int                linenumbers;   /* set line number in element content */
     void              *catalogs;       /* document's own catalog */
     int                recovery;      /* run in recovery mode */
-};

The parser context. + int progressive; /* is this a progressive parsing */ +}; +

+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.

struct xmlSAXLocator

struct xmlSAXLocator {
+     to a state based parser for progressive parsing shouldn't be too hard.

+
+
struct xmlSAXLocator
struct xmlSAXLocator {
     const xmlChar *(*getPublicId)(void *ctx);
     const xmlChar *(*getSystemId)(void *ctx);
     int (*getLineNumber)(void *ctx);
     int (*getColumnNumber)(void *ctx);
-};

A SAX Locator.

resolveEntitySAXFunc ()

xmlParserInputPtr (*resolveEntitySAXFunc)   (void *ctx,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId);

Callback: +}; +

+A SAX Locator.

+ +

resolveEntitySAXFunc ()

xmlParserInputPtr (*resolveEntitySAXFunc)   (void *ctx,
+                                             const xmlChar *publicId,
+                                             const xmlChar *systemId);

+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

ctx : 
publicId : 
systemId : 
Returns : 

internalSubsetSAXFunc ()

void        (*internalSubsetSAXFunc)        (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);

Callback on internal subset declaration.

ctx : 
name : 
ExternalID : 
SystemID : 

externalSubsetSAXFunc ()

void        (*externalSubsetSAXFunc)        (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);

Callback on external subset declaration.

ctx : 
name : 
ExternalID : 
SystemID : 

getEntitySAXFunc ()

xmlEntityPtr (*getEntitySAXFunc)            (void *ctx,
-                                             const xmlChar *name);

Get an entity by name.

ctx : 
name : 
Returns : 

getParameterEntitySAXFunc ()

xmlEntityPtr (*getParameterEntitySAXFunc)   (void *ctx,
-                                             const xmlChar *name);

Get a parameter entity by name.

ctx : 
name : 
Returns : 

entityDeclSAXFunc ()

void        (*entityDeclSAXFunc)            (void *ctx,
-                                             const xmlChar *name,
+   - override this resolveEntity() callback in the SAX block
+   - or better use the xmlSetExternalEntityLoader() function to
+     set up it's own entity resolution routine

+
+
ctx :  the user data (XML parser context)
+
publicId : The public ID of the entity
+
systemId : The system ID of the entity
+
Returns :the xmlParserInputPtr if inlined or NULL for DOM behaviour.
+
internalSubsetSAXFunc ()
void        (*internalSubsetSAXFunc)        (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);

+Callback on internal subset declaration.

+
+
ctx :  the user data (XML parser context)
+
name :  the root element name
+
ExternalID :  the external ID
+
SystemID :  the SYSTEM ID (e.g. filename or URL)
+
externalSubsetSAXFunc ()
void        (*externalSubsetSAXFunc)        (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);

+Callback on external subset declaration.

+
+
ctx :  the user data (XML parser context)
+
name :  the root element name
+
ExternalID :  the external ID
+
SystemID :  the SYSTEM ID (e.g. filename or URL)
+
getEntitySAXFunc ()
xmlEntityPtr (*getEntitySAXFunc)            (void *ctx,
+                                             const xmlChar *name);

+Get an entity by name.

+
+
ctx :  the user data (XML parser context)
+
name : The entity name
+
Returns :the xmlEntityPtr if found.
+
getParameterEntitySAXFunc ()
xmlEntityPtr (*getParameterEntitySAXFunc)   (void *ctx,
+                                             const xmlChar *name);

+Get a parameter entity by name.

+
+
ctx :  the user data (XML parser context)
+
name : The entity name
+
Returns :the xmlEntityPtr if found.
+
entityDeclSAXFunc ()
void        (*entityDeclSAXFunc)            (void *ctx,
+                                             const xmlChar *name,
                                              int type,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId,
-                                             xmlChar *content);

An entity definition has been parsed.

ctx : 
name : 
type : 
publicId : 
systemId : 
content : 

notationDeclSAXFunc ()

void        (*notationDeclSAXFunc)          (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId);

What to do when a notation declaration has been parsed.

ctx : 
name : 
publicId : 
systemId : 

attributeDeclSAXFunc ()

void        (*attributeDeclSAXFunc)         (void *ctx,
-                                             const xmlChar *elem,
-                                             const xmlChar *fullname,
+                                             const xmlChar *publicId,
+                                             const xmlChar *systemId,
+                                             xmlChar *content);

+An entity definition has been parsed.

+ +

ctx : the user data (XML parser context) +
name : the entity name +
type : the entity type +
publicId : The public ID of the entity +
systemId : The system ID of the entity +
content : the entity value (without processing). +

notationDeclSAXFunc ()

void        (*notationDeclSAXFunc)          (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *publicId,
+                                             const xmlChar *systemId);

+What to do when a notation declaration has been parsed.

+ +

ctx : the user data (XML parser context) +
name : The name of the notation +
publicId : The public ID of the entity +
systemId : The system ID of the entity +

attributeDeclSAXFunc ()

void        (*attributeDeclSAXFunc)         (void *ctx,
+                                             const xmlChar *elem,
+                                             const xmlChar *fullname,
                                              int type,
                                              int def,
-                                             const xmlChar *defaultValue,
-                                             xmlEnumerationPtr tree);

An attribute definition has been parsed.

ctx : 
elem : 
fullname : 
type : 
def : 
defaultValue : 
tree : 

elementDeclSAXFunc ()

void        (*elementDeclSAXFunc)           (void *ctx,
-                                             const xmlChar *name,
+                                             const xmlChar *defaultValue,
+                                             xmlEnumerationPtr tree);

+An attribute definition has been parsed.

+ +

ctx : the user data (XML parser context) +
elem : the name of the element +
fullname : the attribute name +
type : the attribute type +
def : the type of default value +
defaultValue : the attribute default value +
tree : the tree of enumerated value set +

elementDeclSAXFunc ()

void        (*elementDeclSAXFunc)           (void *ctx,
+                                             const xmlChar *name,
                                              int type,
-                                             xmlElementContentPtr content);

An element definition has been parsed.

ctx : 
name : 
type : 
content : 

unparsedEntityDeclSAXFunc ()

void        (*unparsedEntityDeclSAXFunc)    (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId,
-                                             const xmlChar *notationName);

What to do when an unparsed entity declaration is parsed.

ctx : 
name : 
publicId : 
systemId : 
notationName : 

setDocumentLocatorSAXFunc ()

void        (*setDocumentLocatorSAXFunc)    (void *ctx,
-                                             xmlSAXLocatorPtr loc);

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

ctx : 
loc : 

startDocumentSAXFunc ()

void        (*startDocumentSAXFunc)         (void *ctx);

Called when the document start being processed.

ctx : 

endDocumentSAXFunc ()

void        (*endDocumentSAXFunc)           (void *ctx);

Called when the document end has been detected.

ctx : 

startElementSAXFunc ()

void        (*startElementSAXFunc)          (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar **atts);

Called when an opening tag has been processed.

ctx : 
name : 
atts : 

endElementSAXFunc ()

void        (*endElementSAXFunc)            (void *ctx,
-                                             const xmlChar *name);

Called when the end of an element has been detected.

ctx : 
name : 

attributeSAXFunc ()

void        (*attributeSAXFunc)             (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *value);

Handle an attribute that has been read by the parser. + xmlElementContentPtr content);

+An element definition has been parsed.

+ +

ctx : the user data (XML parser context) +
name : the element name +
type : the element type +
content : the element value tree +

unparsedEntityDeclSAXFunc ()

void        (*unparsedEntityDeclSAXFunc)    (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *publicId,
+                                             const xmlChar *systemId,
+                                             const xmlChar *notationName);

+What to do when an unparsed entity declaration is parsed.

+ +

ctx : the user data (XML parser context) +
name : The name of the entity +
publicId : The public ID of the entity +
systemId : The system ID of the entity +
notationName : the name of the notation +

setDocumentLocatorSAXFunc ()

void        (*setDocumentLocatorSAXFunc)    (void *ctx,
+                                             xmlSAXLocatorPtr loc);

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

+ +

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

startDocumentSAXFunc ()

void        (*startDocumentSAXFunc)         (void *ctx);

+Called when the document start being processed.

+ +

ctx : the user data (XML parser context) +

endDocumentSAXFunc ()

void        (*endDocumentSAXFunc)           (void *ctx);

+Called when the document end has been detected.

+ +

ctx : the user data (XML parser context) +

startElementSAXFunc ()

void        (*startElementSAXFunc)          (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar **atts);

+Called when an opening tag has been processed.

+ +

ctx : the user data (XML parser context) +
name : The element name, including namespace prefix +
atts : An array of name/value attributes pairs, NULL terminated +

endElementSAXFunc ()

void        (*endElementSAXFunc)            (void *ctx,
+                                             const xmlChar *name);

+Called when the end of an element has been detected.

+ +

ctx : the user data (XML parser context) +
name : The element name +

attributeSAXFunc ()

void        (*attributeSAXFunc)             (void *ctx,
+                                             const xmlChar *name,
+                                             const xmlChar *value);

+Handle an attribute that has been read by the parser. The default handling is to convert the attribute into an DOM subtree and past it in a new xmlAttr element added to -the element.

ctx : 
name : 
value : 

referenceSAXFunc ()

void        (*referenceSAXFunc)             (void *ctx,
-                                             const xmlChar *name);

Called when an entity reference is detected.

ctx : 
name : 

charactersSAXFunc ()

void        (*charactersSAXFunc)            (void *ctx,
-                                             const xmlChar *ch,
-                                             int len);

Receiving some chars from the parser.

ctx : 
ch : 
len : 

ignorableWhitespaceSAXFunc ()

void        (*ignorableWhitespaceSAXFunc)   (void *ctx,
-                                             const xmlChar *ch,
-                                             int len);

Receiving some ignorable whitespaces from the parser. -UNUSED: by default the DOM building will use characters.

ctx : 
ch : 
len : 

processingInstructionSAXFunc ()

void        (*processingInstructionSAXFunc) (void *ctx,
-                                             const xmlChar *target,
-                                             const xmlChar *data);

A processing instruction has been parsed.

ctx : 
target : 
data : 

commentSAXFunc ()

void        (*commentSAXFunc)               (void *ctx,
-                                             const xmlChar *value);

A comment has been parsed.

ctx : 
value : 

cdataBlockSAXFunc ()

void        (*cdataBlockSAXFunc)            (void *ctx,
-                                             const xmlChar *value,
-                                             int len);

Called when a pcdata block has been parsed.

ctx : 
value : 
len : 

warningSAXFunc ()

void        (*warningSAXFunc)               (void *ctx,
+the element.

+
+
ctx :  the user data (XML parser context)
+
name :  The attribute name, including namespace prefix
+
value :  The attribute value
+
referenceSAXFunc ()
void        (*referenceSAXFunc)             (void *ctx,
+                                             const xmlChar *name);

+Called when an entity reference is detected.

+
+
ctx :  the user data (XML parser context)
+
name :  The entity name
+
charactersSAXFunc ()
void        (*charactersSAXFunc)            (void *ctx,
+                                             const xmlChar *ch,
+                                             int len);

+Receiving some chars from the parser.

+
+
ctx :  the user data (XML parser context)
+
ch :  a xmlChar string
+
len : the number of xmlChar
+
ignorableWhitespaceSAXFunc ()
void        (*ignorableWhitespaceSAXFunc)   (void *ctx,
+                                             const xmlChar *ch,
+                                             int len);

+Receiving some ignorable whitespaces from the parser.
+UNUSED: by default the DOM building will use characters.

+
+
ctx :  the user data (XML parser context)
+
ch :  a xmlChar string
+
len : the number of xmlChar
+
processingInstructionSAXFunc ()
void        (*processingInstructionSAXFunc) (void *ctx,
+                                             const xmlChar *target,
+                                             const xmlChar *data);

+A processing instruction has been parsed.

+
+
ctx :  the user data (XML parser context)
+
target :  the target name
+
data : the PI data's
+
commentSAXFunc ()
void        (*commentSAXFunc)               (void *ctx,
+                                             const xmlChar *value);

+A comment has been parsed.

+
+
ctx :  the user data (XML parser context)
+
value :  the comment content
+
cdataBlockSAXFunc ()
void        (*cdataBlockSAXFunc)            (void *ctx,
+                                             const xmlChar *value,
+                                             int len);

+Called when a pcdata block has been parsed.

+
+
ctx :  the user data (XML parser context)
+
value :  The pcdata content
+
len :  the block length
+
warningSAXFunc ()
void        (*warningSAXFunc)               (void *ctx,
                                              const char *msg,
-                                             ...);

Display and format a warning messages, callback.

ctx : 
msg : 
... : 

errorSAXFunc ()

void        (*errorSAXFunc)                 (void *ctx,
+                                             ...);

+Display and format a warning messages, callback.

+ +

ctx : an XML parser context +
msg : the message to display/transmit +
... : extra parameters for the message display +

errorSAXFunc ()

void        (*errorSAXFunc)                 (void *ctx,
                                              const char *msg,
-                                             ...);

Display and format an error messages, callback.

ctx : 
msg : 
... : 

fatalErrorSAXFunc ()

void        (*fatalErrorSAXFunc)            (void *ctx,
+                                             ...);

+Display and format an error messages, callback.

+ +

ctx : an XML parser context +
msg : the message to display/transmit +
... : extra parameters for the message display +

fatalErrorSAXFunc ()

void        (*fatalErrorSAXFunc)            (void *ctx,
                                              const char *msg,
-                                             ...);

Display and format fatal error messages, callback. -Note: so far fatalError() SAX callbacks are not used, error() - get all the callbacks for errors.

ctx : 
msg : 
... : 

isStandaloneSAXFunc ()

int         (*isStandaloneSAXFunc)          (void *ctx);

Is this document tagged standalone?

ctx : 
Returns : 

hasInternalSubsetSAXFunc ()

int         (*hasInternalSubsetSAXFunc)     (void *ctx);

Does this document has an internal subset.

ctx : 
Returns : 

hasExternalSubsetSAXFunc ()

int         (*hasExternalSubsetSAXFunc)     (void *ctx);

Does this document has an external subset?

ctx : 
Returns : 

struct xmlSAXHandler

struct xmlSAXHandler {
+                                             ...);

+Display and format fatal error messages, callback. +Note: so far fatalError() SAX callbacks are not used, error() + get all the callbacks for errors.

+ +

ctx : an XML parser context +
msg : the message to display/transmit +
... : extra parameters for the message display +

isStandaloneSAXFunc ()

int         (*isStandaloneSAXFunc)          (void *ctx);

+Is this document tagged standalone?

+ +

ctx : the user data (XML parser context) +
Returns :1 if true +

hasInternalSubsetSAXFunc ()

int         (*hasInternalSubsetSAXFunc)     (void *ctx);

+Does this document has an internal subset.

+ +

ctx : the user data (XML parser context) +
Returns :1 if true +

hasExternalSubsetSAXFunc ()

int         (*hasExternalSubsetSAXFunc)     (void *ctx);

+Does this document has an external subset?

+ +

ctx : the user data (XML parser context) +
Returns :1 if true +

struct xmlSAXHandler

struct xmlSAXHandler {
     internalSubsetSAXFunc internalSubset;
     isStandaloneSAXFunc isStandalone;
     hasInternalSubsetSAXFunc hasInternalSubset;
@@ -4883,7900 +764,672 @@ CLASS="PROGRAMLISTING"
     cdataBlockSAXFunc cdataBlock;
     externalSubsetSAXFunc externalSubset;
     int initialized;
-};

A SAX handler is bunch of callbacks called by the parser when processing -of the input generate data or structure informations.

xmlExternalEntityLoader ()

xmlParserInputPtr (*xmlExternalEntityLoader)
+};
+

+A SAX handler is bunch of callbacks called by the parser when processing +of the input generate data or structure informations.

+ +

xmlExternalEntityLoader ()

xmlParserInputPtr (*xmlExternalEntityLoader)
                                             (const char *URL,
                                              const char *ID,
-                                             xmlParserCtxtPtr context);

External entity loaders types.

URL : 
ID : 
context : 
Returns : 

xmlInitParser ()

void        xmlInitParser                   (void);

Initialization function for the XML parser. + xmlParserCtxtPtr context);

+External entity loaders types.

+ +

URL : The System ID of the resource requested +
ID : The Public ID of the resource requested +
context : the XML parser context +
Returns :the entity input parser. +

xmlInitParser ()

void        xmlInitParser                   (void);

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

xmlCleanupParser ()

void        xmlCleanupParser                (void);

Cleanup function for the XML parser. It tries to reclaim all +use in multithreaded programs.

+ +

xmlCleanupParser ()

void        xmlCleanupParser                (void);

+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. -One should call xmlCleanupParser() only when the process has -finished using the library or XML document built with it.

xmlParserInputRead ()

int         xmlParserInputRead              (xmlParserInputPtr in,
-                                             int len);

This function refresh the input for the parser. It doesn't try to -preserve pointers to the input buffer, and discard already read data

in : 
len : 
Returns : 

xmlParserInputGrow ()

int         xmlParserInputGrow              (xmlParserInputPtr in,
-                                             int len);

This function increase the input for the parser. It tries to -preserve pointers to the input buffer, and keep already read data

in : 
len : 
Returns : 

xmlStrdup ()

xmlChar*    xmlStrdup                       (const xmlChar *cur);

a strdup for array of xmlChar's. Since they are supposed to be +One should call xmlCleanupParser() only when the process has +finished using the library or XML document built with it.

+ +

xmlParserInputRead ()

int         xmlParserInputRead              (xmlParserInputPtr in,
+                                             int len);

+This function refresh the input for the parser. It doesn't try to +preserve pointers to the input buffer, and discard already read data

+ +

in : an XML parser input +
len : an indicative size for the lookahead +
Returns :the number of xmlChars read, or -1 in case of error, 0 indicate the +end of this entity +

xmlParserInputGrow ()

int         xmlParserInputGrow              (xmlParserInputPtr in,
+                                             int len);

+This function increase the input for the parser. It tries to +preserve pointers to the input buffer, and keep already read data

+ +

in : an XML parser input +
len : an indicative size for the lookahead +
Returns :the number of xmlChars read, or -1 in case of error, 0 indicate the +end of this entity +

xmlStrdup ()

xmlChar*    xmlStrdup                       (const xmlChar *cur);

+a strdup for array of xmlChar's. Since they are supposed to be encoded in UTF-8 or an encoding with 8bit based chars, we assume -a termination mark of '0'.

cur : 
Returns : 

xmlStrndup ()

xmlChar*    xmlStrndup                      (const xmlChar *cur,
-                                             int len);

a strndup for array of xmlChar's

cur : 
len : 
Returns : 

xmlCharStrndup ()

xmlChar*    xmlCharStrndup                  (const char *cur,
-                                             int len);

a strndup for char's to xmlChar's

cur : 
len : 
Returns : 

xmlCharStrdup ()

xmlChar*    xmlCharStrdup                   (const char *cur);

a strdup for char's to xmlChar's

cur : 
Returns : 

xmlStrsub ()

xmlChar*    xmlStrsub                       (const xmlChar *str,
+a termination mark of '0'.

+
+
cur :  the input xmlChar *
+
Returns :a new xmlChar * or NULL
+
xmlStrndup ()
xmlChar*    xmlStrndup                      (const xmlChar *cur,
+                                             int len);

+a strndup for array of xmlChar's

+
+
cur :  the input xmlChar *
+
len :  the len of cur
+
Returns :a new xmlChar * or NULL
+
xmlCharStrndup ()
xmlChar*    xmlCharStrndup                  (const char *cur,
+                                             int len);

+a strndup for char's to xmlChar's

+
+
cur :  the input char *
+
len :  the len of cur
+
Returns :a new xmlChar * or NULL
+
xmlCharStrdup ()
xmlChar*    xmlCharStrdup                   (const char *cur);

+a strdup for char's to xmlChar's

+
+
cur :  the input char *
+
Returns :a new xmlChar * or NULL
+
xmlStrsub ()
xmlChar*    xmlStrsub                       (const xmlChar *str,
                                              int start,
-                                             int len);

Extract a substring of a given string

str : 
start : 
len : 
Returns : 

xmlStrchr ()

const xmlChar* xmlStrchr                    (const xmlChar *str,
-                                             xmlChar val);

a strchr for xmlChar's

str : 
val : 
Returns : 

xmlStrstr ()

const xmlChar* xmlStrstr                    (const xmlChar *str,
-                                             const xmlChar *val);

a strstr for xmlChar's

str : 
val : 
Returns : 

xmlStrcasestr ()

const xmlChar* xmlStrcasestr                (const xmlChar *str,
-                                             xmlChar *val);

a case-ignoring strstr for xmlChar's

str : 
val : 
Returns : 

xmlStrcmp ()

int         xmlStrcmp                       (const xmlChar *str1,
-                                             const xmlChar *str2);

a strcmp for xmlChar's

str1 : 
str2 : 
Returns : 

xmlStrncmp ()

int         xmlStrncmp                      (const xmlChar *str1,
-                                             const xmlChar *str2,
-                                             int len);

a strncmp for xmlChar's

str1 : 
str2 : 
len : 
Returns : 

xmlStrcasecmp ()

int         xmlStrcasecmp                   (const xmlChar *str1,
-                                             const xmlChar *str2);

a strcasecmp for xmlChar's

str1 : 
str2 : 
Returns : 

xmlStrncasecmp ()

int         xmlStrncasecmp                  (const xmlChar *str1,
-                                             const xmlChar *str2,
-                                             int len);

a strncasecmp for xmlChar's

str1 : 
str2 : 
len : 
Returns : 

xmlStrEqual ()

int         xmlStrEqual                     (const xmlChar *str1,
-                                             const xmlChar *str2);

Check if both string are equal of have same content -Should be a bit more readable and faster than xmlStrEqual()

str1 : 
str2 : 
Returns : 

xmlStrlen ()

int         xmlStrlen                       (const xmlChar *str);

length of a xmlChar's string

str : 
Returns : 

xmlStrcat ()

xmlChar*    xmlStrcat                       (xmlChar *cur,
-                                             const xmlChar *add);

a strcat for array of xmlChar's. Since they are supposed to be + int len);

+Extract a substring of a given string

+ +

str : the xmlChar * array (haystack) +
start : the index of the first char (zero based) +
len : the length of the substring +
Returns :the xmlChar * for the first occurrence or NULL. +

xmlStrchr ()

const xmlChar* xmlStrchr                    (const xmlChar *str,
+                                             xmlChar val);

+a strchr for xmlChar's

+ +

str : the xmlChar * array +
val : the xmlChar to search +
Returns :the xmlChar * for the first occurrence or NULL. +

xmlStrstr ()

const xmlChar* xmlStrstr                    (const xmlChar *str,
+                                             const xmlChar *val);

+a strstr for xmlChar's

+ +

str : the xmlChar * array (haystack) +
val : the xmlChar to search (needle) +
Returns :the xmlChar * for the first occurrence or NULL. +

xmlStrcasestr ()

const xmlChar* xmlStrcasestr                (const xmlChar *str,
+                                             xmlChar *val);

+a case-ignoring strstr for xmlChar's

+ +

str : the xmlChar * array (haystack) +
val : the xmlChar to search (needle) +
Returns :the xmlChar * for the first occurrence or NULL. +

xmlStrcmp ()

int         xmlStrcmp                       (const xmlChar *str1,
+                                             const xmlChar *str2);

+a strcmp for xmlChar's

+ +

str1 : the first xmlChar * +
str2 : the second xmlChar * +
Returns :the integer result of the comparison +

xmlStrncmp ()

int         xmlStrncmp                      (const xmlChar *str1,
+                                             const xmlChar *str2,
+                                             int len);

+a strncmp for xmlChar's

+ +

str1 : the first xmlChar * +
str2 : the second xmlChar * +
len : the max comparison length +
Returns :the integer result of the comparison +

xmlStrcasecmp ()

int         xmlStrcasecmp                   (const xmlChar *str1,
+                                             const xmlChar *str2);

+a strcasecmp for xmlChar's

+ +

str1 : the first xmlChar * +
str2 : the second xmlChar * +
Returns :the integer result of the comparison +

xmlStrncasecmp ()

int         xmlStrncasecmp                  (const xmlChar *str1,
+                                             const xmlChar *str2,
+                                             int len);

+a strncasecmp for xmlChar's

+ +

str1 : the first xmlChar * +
str2 : the second xmlChar * +
len : the max comparison length +
Returns :the integer result of the comparison +

xmlStrEqual ()

int         xmlStrEqual                     (const xmlChar *str1,
+                                             const xmlChar *str2);

+Check if both string are equal of have same content +Should be a bit more readable and faster than xmlStrEqual()

+ +

str1 : the first xmlChar * +
str2 : the second xmlChar * +
Returns :1 if they are equal, 0 if they are different +

xmlStrlen ()

int         xmlStrlen                       (const xmlChar *str);

+length of a xmlChar's string

+ +

str : the xmlChar * array +
Returns :the number of xmlChar contained in the ARRAY. +

xmlStrcat ()

xmlChar*    xmlStrcat                       (xmlChar *cur,
+                                             const xmlChar *add);

+a strcat for array of xmlChar's. Since they are supposed to be encoded in UTF-8 or an encoding with 8bit based chars, we assume -a termination mark of '0'.

cur : 
add : 
Returns : 

xmlStrncat ()

xmlChar*    xmlStrncat                      (xmlChar *cur,
-                                             const xmlChar *add,
-                                             int len);

a strncat for array of xmlChar's, it will extend cur with the len -first bytes of add.

cur : 
add : 
len : 
Returns : 

xmlParseDoc ()

xmlDocPtr   xmlParseDoc                     (xmlChar *cur);

parse an XML in-memory document and build a tree.

cur : 
Returns : 

xmlParseMemory ()

xmlDocPtr   xmlParseMemory                  (const char *buffer,
-                                             int size);

parse an XML in-memory block and build a tree.

buffer : 
size : 
Returns : 

xmlParseFile ()

xmlDocPtr   xmlParseFile                    (const char *filename);

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

filename : 
Returns : 

xmlSubstituteEntitiesDefault ()

int         xmlSubstituteEntitiesDefault    (int val);

Set and return the previous value for default entity support. +a termination mark of '0'.

+ +

cur : the original xmlChar * array +
add : the xmlChar * array added +
Returns :a new xmlChar * containing the concatenated string. +

xmlStrncat ()

xmlChar*    xmlStrncat                      (xmlChar *cur,
+                                             const xmlChar *add,
+                                             int len);

+a strncat for array of xmlChar's, it will extend cur with the len +first bytes of add.

+ +

cur : the original xmlChar * array +
add : the xmlChar * array added +
len : the length of add +
Returns :a new xmlChar *, the original cur is reallocated if needed +and should not be freed +

xmlParseDoc ()

xmlDocPtr   xmlParseDoc                     (xmlChar *cur);

+parse an XML in-memory document and build a tree.

+ +

cur : a pointer to an array of xmlChar +
Returns :the resulting document tree +

xmlParseMemory ()

xmlDocPtr   xmlParseMemory                  (const char *buffer,
+                                             int size);

+parse an XML in-memory block and build a tree.

+ +

buffer : an pointer to a char array +
size : the size of the array +
Returns :the resulting document tree +

xmlParseFile ()

xmlDocPtr   xmlParseFile                    (const char *filename);

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

+ +

filename : the filename +
Returns :the resulting document tree if the file was wellformed, +NULL otherwise. +

xmlSubstituteEntitiesDefault ()

int         xmlSubstituteEntitiesDefault    (int val);

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

val : 
Returns : 

xmlKeepBlanksDefault ()

int         xmlKeepBlanksDefault            (int val);

Set and return the previous value for default blanks text nodes support. +SAX::substituteEntities() has to be used for changing that on a file by +file basis.

+ +

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

xmlKeepBlanksDefault ()

int         xmlKeepBlanksDefault            (int val);

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

val : 
Returns : 

xmlStopParser ()

void        xmlStopParser                   (xmlParserCtxtPtr ctxt);

Blocks further parser processing

ctxt : 

xmlPedanticParserDefault ()

int         xmlPedanticParserDefault        (int val);

Set and return the previous value for enabling pedantic warnings.

val : 
Returns : 

xmlLineNumbersDefault ()

int         xmlLineNumbersDefault           (int val);

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

val : 
Returns : 

xmlRecoverDoc ()

xmlDocPtr   xmlRecoverDoc                   (xmlChar *cur);

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

cur : 
Returns : 

xmlRecoverMemory ()

xmlDocPtr   xmlRecoverMemory                (const char *buffer,
-                                             int size);

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

buffer : 
size : 
Returns : 

xmlRecoverFile ()

xmlDocPtr   xmlRecoverFile                  (const char *filename);

parse an XML file and build a tree. Automatic support for ZLIB/Compress +if blanks sections are kept, indentation is not generated.

+ +

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

xmlStopParser ()

void        xmlStopParser                   (xmlParserCtxtPtr ctxt);

+Blocks further parser processing

+ +

ctxt : an XML parser context +

xmlPedanticParserDefault ()

int         xmlPedanticParserDefault        (int val);

+Set and return the previous value for enabling pedantic warnings.

+ +

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

xmlLineNumbersDefault ()

int         xmlLineNumbersDefault           (int val);

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

+ +

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

xmlRecoverDoc ()

xmlDocPtr   xmlRecoverDoc                   (xmlChar *cur);

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

+ +

cur : a pointer to an array of xmlChar +
Returns :the resulting document tree +

xmlRecoverMemory ()

xmlDocPtr   xmlRecoverMemory                (const char *buffer,
+                                             int size);

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

+ +

buffer : an pointer to a char array +
size : the size of the array +
Returns :the resulting document tree +

xmlRecoverFile ()

xmlDocPtr   xmlRecoverFile                  (const char *filename);

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

filename : 
Returns : 

xmlParseDocument ()

int         xmlParseDocument                (xmlParserCtxtPtr ctxt);

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

[1] document ::= prolog element Misc*

[22] prolog ::= XMLDecl? Misc* (doctypedecl Misc*)?

ctxt : 
Returns : 

xmlParseExtParsedEnt ()

int         xmlParseExtParsedEnt            (xmlParserCtxtPtr ctxt);

parse a general parsed entity +In the case the document is not Well Formed, a tree is built anyway

+ +

filename : the filename +
Returns :the resulting document tree +

xmlParseDocument ()

int         xmlParseDocument                (xmlParserCtxtPtr ctxt);

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

+[1] document ::= prolog element Misc* +

+[22] prolog ::= XMLDecl? Misc* (doctypedecl Misc*)?

+ +

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

xmlParseExtParsedEnt ()

int         xmlParseExtParsedEnt            (xmlParserCtxtPtr ctxt);

+parse a general parsed entity An external general parsed entity is well-formed if it matches the -production labeled extParsedEnt.

[78] extParsedEnt ::= TextDecl? content

ctxt : 
Returns : 

xmlSAXParseDoc ()

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

parse an XML in-memory document and build a tree. +production labeled extParsedEnt. +

+[78] extParsedEnt ::= TextDecl? content

+ +

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

xmlSAXParseDoc ()

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

+parse an XML in-memory document and build a tree. It use the given SAX function block to handle the parsing callback. -If sax is NULL, fallback to the default DOM tree building routines.

sax : 
cur : 
recovery : 
Returns : 

xmlSAXUserParseFile ()

int         xmlSAXUserParseFile             (xmlSAXHandlerPtr sax,
+If sax is NULL, fallback to the default DOM tree building routines.

+
+
sax :  the SAX handler block
+
cur :  a pointer to an array of xmlChar
+
recovery :  work in recovery mode, i.e. tries to read no Well Formed
+            documents
+
Returns :the resulting document tree
+
xmlSAXUserParseFile ()
int         xmlSAXUserParseFile             (xmlSAXHandlerPtr sax,
                                              void *user_data,
-                                             const char *filename);

parse an XML file and call the given SAX handler routines. -Automatic support for ZLIB/Compress compressed document is provided

sax : 
user_data : 
filename : 
Returns : 

xmlSAXUserParseMemory ()

int         xmlSAXUserParseMemory           (xmlSAXHandlerPtr sax,
+                                             const char *filename);

+parse an XML file and call the given SAX handler routines. +Automatic support for ZLIB/Compress compressed document is provided

+ +

sax : a SAX handler +
user_data : The user data returned on SAX callbacks +
filename : a file name +
Returns :0 in case of success or a error number otherwise +

xmlSAXUserParseMemory ()

int         xmlSAXUserParseMemory           (xmlSAXHandlerPtr sax,
                                              void *user_data,
                                              const char *buffer,
-                                             int size);

A better SAX parsing routine. -parse an XML in-memory buffer and call the given SAX handler routines.

sax : 
user_data : 
buffer : 
size : 
Returns : 

xmlSAXParseMemory ()

xmlDocPtr   xmlSAXParseMemory               (xmlSAXHandlerPtr sax,
+                                             int size);

+A better SAX parsing routine. +parse an XML in-memory buffer and call the given SAX handler routines.

+ +

sax : a SAX handler +
user_data : The user data returned on SAX callbacks +
buffer : an in-memory XML document input +
size : the length of the XML document in bytes +
Returns :0 in case of success or a error number otherwise +

xmlSAXParseMemory ()

xmlDocPtr   xmlSAXParseMemory               (xmlSAXHandlerPtr sax,
                                              const char *buffer,
                                              int size,
-                                             int recovery);

parse an XML in-memory block and use the given SAX function block + int recovery);

+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.

sax : 
buffer : 
size : 
recovery : 
Returns : 

xmlSAXParseMemoryWithData ()

xmlDocPtr   xmlSAXParseMemoryWithData       (xmlSAXHandlerPtr sax,
+DOM tree building routines.

+
+
sax :  the SAX handler block
+
buffer :  an pointer to a char array
+
size :  the size of the array
+
recovery :  work in recovery mode, i.e. tries to read not Well Formed
+            documents
+
Returns :the resulting document tree
+
xmlSAXParseMemoryWithData ()
xmlDocPtr   xmlSAXParseMemoryWithData       (xmlSAXHandlerPtr sax,
                                              const char *buffer,
                                              int size,
                                              int recovery,
-                                             void *data);

parse an XML in-memory block and use the given SAX function block + void *data);

+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

sax : 
buffer : 
size : 
recovery : 
data : 
Returns : 

xmlSAXParseFile ()

xmlDocPtr   xmlSAXParseFile                 (xmlSAXHandlerPtr sax,
+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
+
buffer :  an pointer to a char array
+
size :  the size of the array
+
recovery :  work in recovery mode, i.e. tries to read no Well Formed
+            documents
+
data :  the userdata
+
Returns :the resulting document tree
+
xmlSAXParseFile ()
xmlDocPtr   xmlSAXParseFile                 (xmlSAXHandlerPtr sax,
                                              const char *filename,
-                                             int recovery);

parse an XML file and build a tree. Automatic support for ZLIB/Compress + 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 : 
filename : 
recovery : 
Returns : 

xmlSAXParseFileWithData ()

xmlDocPtr   xmlSAXParseFileWithData         (xmlSAXHandlerPtr sax,
+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 + 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 : 
filename : 
recovery : 
data : 
Returns : 

xmlSAXParseEntity ()

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

parse an XML external entity out of context and build a tree. +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 +

xmlSAXParseEntity ()

xmlDocPtr   xmlSAXParseEntity               (xmlSAXHandlerPtr sax,
+                                             const char *filename);

+parse an XML external entity out of context and build a tree. It use the given SAX function block to handle the parsing callback. -If sax is NULL, fallback to the default DOM tree building routines.

[78] extParsedEnt ::= TextDecl? content

This correspond to a "Well Balanced" chunk

sax : 
filename : 
Returns : 

xmlParseEntity ()

xmlDocPtr   xmlParseEntity                  (const char *filename);

parse an XML external entity out of context and build a tree.

[78] extParsedEnt ::= TextDecl? content

This correspond to a "Well Balanced" chunk

filename : 
Returns : 

xmlParseDTD ()

xmlDtdPtr   xmlParseDTD                     (const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);

Load and parse an external subset.

ExternalID : 
SystemID : 
Returns : 

xmlSAXParseDTD ()

xmlDtdPtr   xmlSAXParseDTD                  (xmlSAXHandlerPtr sax,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);

Load and parse an external subset.

sax : 
ExternalID : 
SystemID : 
Returns : 

xmlIOParseDTD ()

xmlDtdPtr   xmlIOParseDTD                   (xmlSAXHandlerPtr sax,
-                                             xmlParserInputBufferPtr input,
-                                             xmlCharEncoding enc);

Load and parse a DTD

sax : 
input : 
enc : 
Returns : 

xmlParseBalancedChunkMemory ()

int         xmlParseBalancedChunkMemory     (xmlDocPtr doc,
-                                             xmlSAXHandlerPtr sax,
+If sax is NULL, fallback to the default DOM tree building routines.
+

+[78] extParsedEnt ::= TextDecl? content
+

+This correspond to a "Well Balanced" chunk

+
+
sax :  the SAX handler block
+
filename :  the filename
+
Returns :the resulting document tree
+
xmlParseEntity ()
xmlDocPtr   xmlParseEntity                  (const char *filename);

+parse an XML external entity out of context and build a tree.
+

+[78] extParsedEnt ::= TextDecl? content
+

+This correspond to a "Well Balanced" chunk

+
+
filename :  the filename
+
Returns :the resulting document tree
+
xmlParseDTD ()
xmlDtdPtr   xmlParseDTD                     (const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);

+Load and parse an external subset.

+
+
ExternalID :  a NAME* containing the External ID of the DTD
+
SystemID :  a NAME* containing the URL to the DTD
+
Returns :the resulting xmlDtdPtr or NULL in case of error.
+
xmlSAXParseDTD ()
xmlDtdPtr   xmlSAXParseDTD                  (xmlSAXHandlerPtr sax,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);

+Load and parse an external subset.

+
+
sax :  the SAX handler block
+
ExternalID :  a NAME* containing the External ID of the DTD
+
SystemID :  a NAME* containing the URL to the DTD
+
Returns :the resulting xmlDtdPtr or NULL in case of error.
+
xmlIOParseDTD ()
xmlDtdPtr   xmlIOParseDTD                   (xmlSAXHandlerPtr sax,
+                                             xmlParserInputBufferPtr input,
+                                             xmlCharEncoding enc);

+Load and parse a DTD

+
+
sax :  the SAX handler block or NULL
+
input :  an Input Buffer
+
enc :  the charset encoding if known
+
Returns :the resulting xmlDtdPtr or NULL in case of error.
+input will be freed at parsing end.
+
xmlParseBalancedChunkMemory ()
int         xmlParseBalancedChunkMemory     (xmlDocPtr doc,
+                                             xmlSAXHandlerPtr sax,
                                              void *user_data,
                                              int depth,
-                                             const xmlChar *string,
-                                             xmlNodePtr *lst);

Parse a well-balanced chunk of an XML document + const xmlChar *string, + xmlNodePtr *lst);

+Parse a well-balanced chunk of an XML document called by the parser The allowed sequence for the Well Balanced Chunk is the one defined by -the content production in the XML grammar:

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

doc : 
sax : 
user_data : 
depth : 
string : 
lst : 
Returns : 

xmlParseBalancedChunkMemoryRecover ()

int         xmlParseBalancedChunkMemoryRecover
-                                            (xmlDocPtr doc,
-                                             xmlSAXHandlerPtr sax,
+the content production in the XML grammar:
+

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

+
+
doc :  the document the chunk pertains to
+
sax :  the SAX handler bloc (possibly NULL)
+
user_data :  The user data returned on SAX callbacks (possibly NULL)
+
depth :  Used for loop detection, use 0
+
string :  the input string in UTF8 or ISO-Latin (zero terminated)
+
lst :  the return value for the set of parsed nodes
+
Returns :0 if the chunk is well balanced, -1 in case of args problem and
+   the parser error code otherwise
+
xmlParseBalancedChunkMemoryRecover ()
int         xmlParseBalancedChunkMemoryRecover
+                                            (xmlDocPtr doc,
+                                             xmlSAXHandlerPtr sax,
                                              void *user_data,
                                              int depth,
-                                             const xmlChar *string,
-                                             xmlNodePtr *lst,
-                                             int recover);

Parse a well-balanced chunk of an XML document + const xmlChar *string, + xmlNodePtr *lst, + int recover);

+Parse a well-balanced chunk of an XML document called by the parser The allowed sequence for the Well Balanced Chunk is the one defined by -the content production in the XML grammar:

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

doc : 
sax : 
user_data : 
depth : 
string : 
lst : 
recover : 
Returns : 

xmlParseExternalEntity ()

int         xmlParseExternalEntity          (xmlDocPtr doc,
-                                             xmlSAXHandlerPtr sax,
+the content production in the XML grammar:
+

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

+
+
doc :  the document the chunk pertains to
+
sax :  the SAX handler bloc (possibly NULL)
+
user_data :  The user data returned on SAX callbacks (possibly NULL)
+
depth :  Used for loop detection, use 0
+
string :  the input string in UTF8 or ISO-Latin (zero terminated)
+
lst :  the return value for the set of parsed nodes
+
recover : return nodes even if the data is broken (use 0)
+
Returns :0 if the chunk is well balanced, -1 in case of args problem and
+   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. 
+
xmlParseExternalEntity ()
int         xmlParseExternalEntity          (xmlDocPtr doc,
+                                             xmlSAXHandlerPtr sax,
                                              void *user_data,
                                              int depth,
-                                             const xmlChar *URL,
-                                             const xmlChar *ID,
-                                             xmlNodePtr *lst);

Parse an external general entity + const xmlChar *URL, + const xmlChar *ID, + xmlNodePtr *lst);

+Parse an external general entity An external general parsed entity is well-formed if it matches the -production labeled extParsedEnt.

[78] extParsedEnt ::= TextDecl? content

doc : 
sax : 
user_data : 
depth : 
URL : 
ID : 
lst : 
Returns : 

xmlParseCtxtExternalEntity ()

int         xmlParseCtxtExternalEntity      (xmlParserCtxtPtr ctx,
-                                             const xmlChar *URL,
-                                             const xmlChar *ID,
-                                             xmlNodePtr *lst);

Parse an external general entity within an existing parsing context +production labeled extParsedEnt. +

+[78] extParsedEnt ::= TextDecl? content

+ +

doc : the document the chunk pertains to +
sax : the SAX handler bloc (possibly NULL) +
user_data : The user data returned on SAX callbacks (possibly NULL) +
depth : Used for loop detection, use 0 +
URL : the URL for the entity to load +
ID : the System ID for the entity to load +
lst : the return value for the set of parsed nodes +
Returns :0 if the entity is well formed, -1 in case of args problem and + the parser error code otherwise +

xmlParseCtxtExternalEntity ()

int         xmlParseCtxtExternalEntity      (xmlParserCtxtPtr ctx,
+                                             const xmlChar *URL,
+                                             const xmlChar *ID,
+                                             xmlNodePtr *lst);

+Parse an external general entity within an existing parsing context An external general parsed entity is well-formed if it matches the -production labeled extParsedEnt.

[78] extParsedEnt ::= TextDecl? content

ctx : 
URL : 
ID : 
lst : 
Returns : 

xmlInitParserCtxt ()

void        xmlInitParserCtxt               (xmlParserCtxtPtr ctxt);

Initialize a parser context

ctxt : 

xmlClearParserCtxt ()

void        xmlClearParserCtxt              (xmlParserCtxtPtr ctxt);

Clear (release owned resources) and reinitialize a parser context

ctxt : 

xmlFreeParserCtxt ()

void        xmlFreeParserCtxt               (xmlParserCtxtPtr ctxt);

Free all the memory used by a parser context. However the parsed -document in ctxt->myDoc is not freed.

ctxt : 

xmlSetupParserForBuffer ()

void        xmlSetupParserForBuffer         (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *buffer,
-                                             const char *filename);

Setup the parser context to parse a new buffer; Clears any prior +production labeled extParsedEnt. +

+[78] extParsedEnt ::= TextDecl? content

+ +

ctx : the existing parsing context +
URL : the URL for the entity to load +
ID : the System ID for the entity to load +
lst : the return value for the set of parsed nodes +
Returns :0 if the entity is well formed, -1 in case of args problem and + the parser error code otherwise +

xmlInitParserCtxt ()

int         xmlInitParserCtxt               (xmlParserCtxtPtr ctxt);

+Initialize a parser context

+ +

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

xmlClearParserCtxt ()

void        xmlClearParserCtxt              (xmlParserCtxtPtr ctxt);

+Clear (release owned resources) and reinitialize a parser context

+ +

ctxt : an XML parser context +

xmlFreeParserCtxt ()

void        xmlFreeParserCtxt               (xmlParserCtxtPtr ctxt);

+Free all the memory used by a parser context. However the parsed +document in ctxt->myDoc is not freed.

+ +

ctxt : an XML parser context +

xmlSetupParserForBuffer ()

void        xmlSetupParserForBuffer         (xmlParserCtxtPtr ctxt,
+                                             const xmlChar *buffer,
+                                             const char *filename);

+Setup the parser context to parse a new buffer; Clears any prior contents from the parser context. The buffer parameter must not be -NULL, but the filename parameter can be

ctxt : 
buffer : 
filename : 

xmlCreateDocParserCtxt ()

xmlParserCtxtPtr xmlCreateDocParserCtxt     (xmlChar *cur);

Creates a parser context for an XML in-memory document.

cur : 
Returns : 

xmlGetFeaturesList ()

int         xmlGetFeaturesList              (int *len,
-                                             const char **result);

Copy at most *len feature names into the result array

len : 
result : 
Returns : 

xmlGetFeature ()

int         xmlGetFeature                   (xmlParserCtxtPtr ctxt,
+NULL, but the filename parameter can be

+
+
ctxt :  an XML parser context
+
buffer :  a xmlChar * buffer
+
filename :  a file name
+
xmlCreateDocParserCtxt ()
xmlParserCtxtPtr xmlCreateDocParserCtxt     (xmlChar *cur);

+Creates a parser context for an XML in-memory document.

+
+
cur :  a pointer to an array of xmlChar
+
Returns :the new parser context or NULL
+
xmlGetFeaturesList ()
int         xmlGetFeaturesList              (int *len,
+                                             const char **result);

+Copy at most *len feature names into the result array

+
+
len :  the length of the features name array (input/output)
+
result :  an array of string to be filled with the features name.
+
Returns :-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
+
xmlGetFeature ()
int         xmlGetFeature                   (xmlParserCtxtPtr ctxt,
                                              const char *name,
-                                             void *result);

Read the current value of one feature of this parser instance

ctxt : 
name : 
result : 
Returns : 

xmlSetFeature ()

int         xmlSetFeature                   (xmlParserCtxtPtr ctxt,
+                                             void *result);

+Read the current value of one feature of this parser instance

+ +

ctxt : an XML/HTML parser context +
name : the feature name +
result : location to store the result +
Returns :-1 in case or error, 0 otherwise +

xmlSetFeature ()

int         xmlSetFeature                   (xmlParserCtxtPtr ctxt,
                                              const char *name,
-                                             void *value);

Change the current value of one feature of this parser instance

ctxt : 
name : 
value : 
Returns : 

xmlCreatePushParserCtxt ()

xmlParserCtxtPtr xmlCreatePushParserCtxt    (xmlSAXHandlerPtr sax,
+                                             void *value);

+Change the current value of one feature of this parser instance

+ +

ctxt : an XML/HTML parser context +
name : the feature name +
value : pointer to the location of the new value +
Returns :-1 in case or error, 0 otherwise +

xmlCreatePushParserCtxt ()

xmlParserCtxtPtr xmlCreatePushParserCtxt    (xmlSAXHandlerPtr sax,
                                              void *user_data,
                                              const char *chunk,
                                              int size,
-                                             const char *filename);

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 + const char *filename);

+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, size should be >= 4 -The value of filename is used for fetching external entities -and error/warning reports.

sax : 
user_data : 
chunk : 
size : 
filename : 
Returns : 

xmlParseChunk ()

int         xmlParseChunk                   (xmlParserCtxtPtr ctxt,
+To allow content encoding detection, size should be >= 4
+The value of filename is used for fetching external entities
+and error/warning reports.

+
+
sax :  a SAX handler
+
user_data :  The user data returned on SAX callbacks
+
chunk :  a pointer to an array of chars
+
size :  number of chars in the array
+
filename :  an optional file name or URI
+
Returns :the new parser context or NULL
+
xmlParseChunk ()
int         xmlParseChunk                   (xmlParserCtxtPtr ctxt,
                                              const char *chunk,
                                              int size,
-                                             int terminate);

Parse a Chunk of memory

ctxt : 
chunk : 
size : 
terminate : 
Returns : 

xmlCreateIOParserCtxt ()

xmlParserCtxtPtr xmlCreateIOParserCtxt      (xmlSAXHandlerPtr sax,
+                                             int terminate);

+Parse a Chunk of memory

+ +

ctxt : an XML parser context +
chunk : an char array +
size : the size in byte of the chunk +
terminate : last chunk indicator +
Returns :zero if no error, the xmlParserErrors otherwise. +

xmlCreateIOParserCtxt ()

xmlParserCtxtPtr xmlCreateIOParserCtxt      (xmlSAXHandlerPtr sax,
                                              void *user_data,
-                                             xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
+                                             xmlInputReadCallback ioread,
+                                             xmlInputCloseCallback ioclose,
                                              void *ioctx,
-                                             xmlCharEncoding enc);

Create a parser context for using the XML parser with an existing -I/O stream

sax : 
user_data : 
ioread : 
ioclose : 
ioctx : 
enc : 
Returns : 

xmlNewIOInputStream ()

xmlParserInputPtr xmlNewIOInputStream       (xmlParserCtxtPtr ctxt,
-                                             xmlParserInputBufferPtr input,
-                                             xmlCharEncoding enc);

Create a new input stream structure encapsulating the input into -a stream suitable for the parser.

ctxt : 
input : 
enc : 
Returns : 

xmlParserFindNodeInfo ()

const xmlParserNodeInfo* xmlParserFindNodeInfo
-                                            (const xmlParserCtxtPtr ctxt,
-                                             const xmlNodePtr node);

Find the parser node info struct for a given node

ctxt : 
node : 
Returns : 

xmlInitNodeInfoSeq ()

void        xmlInitNodeInfoSeq              (xmlParserNodeInfoSeqPtr seq);

-- Initialize (set to initial state) node info sequence

seq : 

xmlClearNodeInfoSeq ()

void        xmlClearNodeInfoSeq             (xmlParserNodeInfoSeqPtr seq);

-- Clear (release memory and reinitialize) node - info sequence

seq : 

xmlParserFindNodeInfoIndex ()

unsigned long xmlParserFindNodeInfoIndex    (const xmlParserNodeInfoSeqPtr seq,
-                                             const xmlNodePtr node);

xmlParserFindNodeInfoIndex : Find the index that the info record for - the given node is or should be at in a sorted sequence

seq : 
node : 
Returns : 

xmlParserAddNodeInfo ()

void        xmlParserAddNodeInfo            (xmlParserCtxtPtr ctxt,
-                                             const xmlParserNodeInfoPtr info);

Insert node info record into the sorted sequence

ctxt : 
info : 

xmlSetExternalEntityLoader ()

void        xmlSetExternalEntityLoader      (xmlExternalEntityLoader f);

Changes the defaultexternal entity resolver function for the application

f : 

xmlGetExternalEntityLoader ()

xmlExternalEntityLoader xmlGetExternalEntityLoader
-                                            (void);

Get the default external entity resolver function for the application

Returns : 

xmlLoadExternalEntity ()

xmlParserInputPtr xmlLoadExternalEntity     (const char *URL,
+                                             xmlCharEncoding enc);

+Create a parser context for using the XML parser with an existing +I/O stream

+ +

sax : a SAX handler +
user_data : The user data returned on SAX callbacks +
ioread : an I/O read function +
ioclose : an I/O close function +
ioctx : an I/O handler +
enc : the charset encoding if known +
Returns :the new parser context or NULL +

xmlNewIOInputStream ()

xmlParserInputPtr xmlNewIOInputStream       (xmlParserCtxtPtr ctxt,
+                                             xmlParserInputBufferPtr input,
+                                             xmlCharEncoding enc);

+Create a new input stream structure encapsulating the input into +a stream suitable for the parser.

+ +

ctxt : an XML parser context +
input : an I/O Input +
enc : the charset encoding if known +
Returns :the new input stream or NULL +

xmlParserFindNodeInfo ()

const xmlParserNodeInfo* xmlParserFindNodeInfo
+                                            (const xmlParserCtxtPtr ctxt,
+                                             const xmlNodePtr node);

+Find the parser node info struct for a given node

+ +

ctxt : +
node : an XML node within the tree +
Returns :an xmlParserNodeInfo block pointer or NULL +

xmlInitNodeInfoSeq ()

void        xmlInitNodeInfoSeq              (xmlParserNodeInfoSeqPtr seq);

+-- Initialize (set to initial state) node info sequence

+ +

seq : a node info sequence pointer +

xmlClearNodeInfoSeq ()

void        xmlClearNodeInfoSeq             (xmlParserNodeInfoSeqPtr seq);

+-- Clear (release memory and reinitialize) node + info sequence

+ +

seq : a node info sequence pointer +

xmlParserFindNodeInfoIndex ()

unsigned long xmlParserFindNodeInfoIndex    (const xmlParserNodeInfoSeqPtr seq,
+                                             const xmlNodePtr node);

+xmlParserFindNodeInfoIndex : Find the index that the info record for + the given node is or should be at in a sorted sequence

+ +

seq : a node info sequence pointer +
node : an XML node pointer +
Returns :a long indicating the position of the record +

xmlParserAddNodeInfo ()

void        xmlParserAddNodeInfo            (xmlParserCtxtPtr ctxt,
+                                             const xmlParserNodeInfoPtr info);

+Insert node info record into the sorted sequence

+ +

ctxt : an XML parser context +
info : a node info sequence pointer +

xmlSetExternalEntityLoader ()

void        xmlSetExternalEntityLoader      (xmlExternalEntityLoader f);

+Changes the defaultexternal entity resolver function for the application

+ +

f : the new entity resolver function +

xmlGetExternalEntityLoader ()

xmlExternalEntityLoader xmlGetExternalEntityLoader
+                                            (void);

+Get the default external entity resolver function for the application

+ +

Returns :the xmlExternalEntityLoader function pointer +

xmlLoadExternalEntity ()

xmlParserInputPtr xmlLoadExternalEntity     (const char *URL,
                                              const char *ID,
-                                             xmlParserCtxtPtr ctxt);

Load an external entity, note that the use of this function for + xmlParserCtxtPtr ctxt);

+Load an external entity, note that the use of this function for unparsed entities may generate problems -TODO: a more generic External entity API must be designed

URL : 
ID : 
ctxt : 
Returns : 



<<< Previous PageHomeUpNext Page >>>
Libxml Library Referencexmlreader
\ No newline at end of file +TODO: a more generic External entity API must be designed

+ +

URL : the URL for the entity to load +
ID : the Public ID for the entity to load +
ctxt : the context in which the entity is called or NULL +
Returns :the xmlParserInputPtr or NULL +
<< Libxml Library Referencexmlreader >>
diff --git a/doc/html/libxml-parserInternals.html b/doc/html/libxml-parserInternals.html new file mode 100644 index 00000000..8118c512 --- /dev/null +++ b/doc/html/libxml-parserInternals.html @@ -0,0 +1,1431 @@ + +parserInternals
PrevUpHomeGnome XML Library Reference ManualNext

parserInternals

parserInternals —

Synopsis

+
+
+
+#define     XML_MAX_NAMELEN
+#define     INPUT_CHUNK
+#define     IS_CHAR                         (c)
+#define     IS_BLANK                        (c)
+#define     IS_BASECHAR                     (c)
+#define     IS_DIGIT                        (c)
+#define     IS_COMBINING                    (c)
+#define     IS_EXTENDER                     (c)
+#define     IS_IDEOGRAPHIC                  (c)
+#define     IS_LETTER                       (c)
+#define     IS_PUBIDCHAR                    (c)
+#define     SKIP_EOL                        (p)
+#define     MOVETO_ENDTAG                   (p)
+#define     MOVETO_STARTTAG                 (p)
+int         xmlIsBaseChar                   (int c);
+int         xmlIsBlank                      (int c);
+int         xmlIsPubidChar                  (int c);
+int         xmlIsLetter                     (int c);
+int         xmlIsDigit                      (int c);
+int         xmlIsIdeographic                (int c);
+int         xmlIsExtender                   (int c);
+int         xmlIsCombining                  (int c);
+int         xmlIsChar                       (int c);
+xmlParserCtxtPtr xmlCreateFileParserCtxt    (const char *filename);
+xmlParserCtxtPtr xmlCreateMemoryParserCtxt  (const char *buffer,
+                                             int size);
+xmlParserCtxtPtr xmlNewParserCtxt           (void);
+xmlParserCtxtPtr xmlCreateEntityParserCtxt  (const xmlChar *URL,
+                                             const xmlChar *ID,
+                                             const xmlChar *base);
+int         xmlSwitchEncoding               (xmlParserCtxtPtr ctxt,
+                                             xmlCharEncoding enc);
+int         xmlSwitchToEncoding             (xmlParserCtxtPtr ctxt,
+                                             xmlCharEncodingHandlerPtr handler);
+void        xmlHandleEntity                 (xmlParserCtxtPtr ctxt,
+                                             xmlEntityPtr entity);
+xmlParserInputPtr xmlNewStringInputStream   (xmlParserCtxtPtr ctxt,
+                                             const xmlChar *buffer);
+xmlParserInputPtr xmlNewEntityInputStream   (xmlParserCtxtPtr ctxt,
+                                             xmlEntityPtr entity);
+void        xmlPushInput                    (xmlParserCtxtPtr ctxt,
+                                             xmlParserInputPtr input);
+xmlChar     xmlPopInput                     (xmlParserCtxtPtr ctxt);
+void        xmlFreeInputStream              (xmlParserInputPtr input);
+xmlParserInputPtr xmlNewInputFromFile       (xmlParserCtxtPtr ctxt,
+                                             const char *filename);
+xmlParserInputPtr xmlNewInputStream         (xmlParserCtxtPtr ctxt);
+xmlChar*    xmlSplitQName                   (xmlParserCtxtPtr ctxt,
+                                             const xmlChar *name,
+                                             xmlChar **prefix);
+xmlChar*    xmlNamespaceParseNCName         (xmlParserCtxtPtr ctxt);
+xmlChar*    xmlNamespaceParseQName          (xmlParserCtxtPtr ctxt,
+                                             xmlChar **prefix);
+xmlChar*    xmlNamespaceParseNSDef          (xmlParserCtxtPtr ctxt);
+xmlChar*    xmlParseQuotedString            (xmlParserCtxtPtr ctxt);
+void        xmlParseNamespace               (xmlParserCtxtPtr ctxt);
+xmlChar*    xmlScanName                     (xmlParserCtxtPtr ctxt);
+xmlChar*    xmlParseName                    (xmlParserCtxtPtr ctxt);
+xmlChar*    xmlParseNmtoken                 (xmlParserCtxtPtr ctxt);
+xmlChar*    xmlParseEntityValue             (xmlParserCtxtPtr ctxt,
+                                             xmlChar **orig);
+xmlChar*    xmlParseAttValue                (xmlParserCtxtPtr ctxt);
+xmlChar*    xmlParseSystemLiteral           (xmlParserCtxtPtr ctxt);
+xmlChar*    xmlParsePubidLiteral            (xmlParserCtxtPtr ctxt);
+void        xmlParseCharData                (xmlParserCtxtPtr ctxt,
+                                             int cdata);
+xmlChar*    xmlParseExternalID              (xmlParserCtxtPtr ctxt,
+                                             xmlChar **publicID,
+                                             int strict);
+void        xmlParseComment                 (xmlParserCtxtPtr ctxt);
+xmlChar*    xmlParsePITarget                (xmlParserCtxtPtr ctxt);
+void        xmlParsePI                      (xmlParserCtxtPtr ctxt);
+void        xmlParseNotationDecl            (xmlParserCtxtPtr ctxt);
+void        xmlParseEntityDecl              (xmlParserCtxtPtr ctxt);
+int         xmlParseDefaultDecl             (xmlParserCtxtPtr ctxt,
+                                             xmlChar **value);
+xmlEnumerationPtr xmlParseNotationType      (xmlParserCtxtPtr ctxt);
+xmlEnumerationPtr xmlParseEnumerationType   (xmlParserCtxtPtr ctxt);
+int         xmlParseEnumeratedType          (xmlParserCtxtPtr ctxt,
+                                             xmlEnumerationPtr *tree);
+int         xmlParseAttributeType           (xmlParserCtxtPtr ctxt,
+                                             xmlEnumerationPtr *tree);
+void        xmlParseAttributeListDecl       (xmlParserCtxtPtr ctxt);
+xmlElementContentPtr xmlParseElementMixedContentDecl
+                                            (xmlParserCtxtPtr ctxt,
+                                             xmlParserInputPtr inputchk);
+xmlElementContentPtr xmlParseElementChildrenContentDecl
+                                            (xmlParserCtxtPtr ctxt,
+                                             xmlParserInputPtr inputchk);
+int         xmlParseElementContentDecl      (xmlParserCtxtPtr ctxt,
+                                             xmlChar *name,
+                                             xmlElementContentPtr *result);
+int         xmlParseElementDecl             (xmlParserCtxtPtr ctxt);
+void        xmlParseMarkupDecl              (xmlParserCtxtPtr ctxt);
+int         xmlParseCharRef                 (xmlParserCtxtPtr ctxt);
+xmlEntityPtr xmlParseEntityRef              (xmlParserCtxtPtr ctxt);
+void        xmlParseReference               (xmlParserCtxtPtr ctxt);
+void        xmlParsePEReference             (xmlParserCtxtPtr ctxt);
+void        xmlParseDocTypeDecl             (xmlParserCtxtPtr ctxt);
+xmlChar*    xmlParseAttribute               (xmlParserCtxtPtr ctxt,
+                                             xmlChar **value);
+xmlChar*    xmlParseStartTag                (xmlParserCtxtPtr ctxt);
+void        xmlParseEndTag                  (xmlParserCtxtPtr ctxt);
+void        xmlParseCDSect                  (xmlParserCtxtPtr ctxt);
+void        xmlParseContent                 (xmlParserCtxtPtr ctxt);
+void        xmlParseElement                 (xmlParserCtxtPtr ctxt);
+xmlChar*    xmlParseVersionNum              (xmlParserCtxtPtr ctxt);
+xmlChar*    xmlParseVersionInfo             (xmlParserCtxtPtr ctxt);
+xmlChar*    xmlParseEncName                 (xmlParserCtxtPtr ctxt);
+xmlChar*    xmlParseEncodingDecl            (xmlParserCtxtPtr ctxt);
+int         xmlParseSDDecl                  (xmlParserCtxtPtr ctxt);
+void        xmlParseXMLDecl                 (xmlParserCtxtPtr ctxt);
+void        xmlParseTextDecl                (xmlParserCtxtPtr ctxt);
+void        xmlParseMisc                    (xmlParserCtxtPtr ctxt);
+void        xmlParseExternalSubset          (xmlParserCtxtPtr ctxt,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);
+#define     XML_SUBSTITUTE_NONE
+#define     XML_SUBSTITUTE_REF
+#define     XML_SUBSTITUTE_PEREF
+#define     XML_SUBSTITUTE_BOTH
+xmlChar*    xmlDecodeEntities               (xmlParserCtxtPtr ctxt,
+                                             int len,
+                                             int what,
+                                             xmlChar end,
+                                             xmlChar end2,
+                                             xmlChar end3);
+xmlChar*    xmlStringDecodeEntities         (xmlParserCtxtPtr ctxt,
+                                             const xmlChar *str,
+                                             int what,
+                                             xmlChar end,
+                                             xmlChar end2,
+                                             xmlChar end3);
+int         nodePush                        (xmlParserCtxtPtr ctxt,
+                                             xmlNodePtr value);
+xmlNodePtr  nodePop                         (xmlParserCtxtPtr ctxt);
+int         inputPush                       (xmlParserCtxtPtr ctxt,
+                                             xmlParserInputPtr value);
+xmlParserInputPtr inputPop                  (xmlParserCtxtPtr ctxt);
+xmlChar*    namePop                         (xmlParserCtxtPtr ctxt);
+int         namePush                        (xmlParserCtxtPtr ctxt,
+                                             xmlChar *value);
+int         xmlSkipBlankChars               (xmlParserCtxtPtr ctxt);
+int         xmlStringCurrentChar            (xmlParserCtxtPtr ctxt,
+                                             const xmlChar *cur,
+                                             int *len);
+void        xmlParserHandlePEReference      (xmlParserCtxtPtr ctxt);
+void        xmlParserHandleReference        (xmlParserCtxtPtr ctxt);
+int         xmlCheckLanguageID              (const xmlChar *lang);
+int         xmlCurrentChar                  (xmlParserCtxtPtr ctxt,
+                                             int *len);
+int         xmlCopyCharMultiByte            (xmlChar *out,
+                                             int val);
+int         xmlCopyChar                     (int len,
+                                             xmlChar *out,
+                                             int val);
+void        xmlNextChar                     (xmlParserCtxtPtr ctxt);
+void        xmlParserInputShrink            (xmlParserInputPtr in);
+void        htmlInitAutoClose               (void);
+htmlParserCtxtPtr htmlCreateFileParserCtxt  (const char *filename,
+                                             const char *encoding);
+void        (*xmlEntityReferenceFunc)       (xmlEntityPtr ent,
+                                             xmlNodePtr firstNode,
+                                             xmlNodePtr lastNode);
+void        xmlSetEntityReferenceFunc       (xmlEntityReferenceFunc func);
+

Description

+ +

Details

XML_MAX_NAMELEN

#define XML_MAX_NAMELEN 100
+

+Identifiers can be longer, but this will be more costly +at runtime.

+ +

INPUT_CHUNK

#define INPUT_CHUNK	250
+

+The parser tries to always have that amount of input ready. +One of the point is providing context when reporting errors.

+ +

IS_CHAR()

#define     IS_CHAR(c)

+Macro to check the following production in the XML spec: +

+[2] Char ::= x9 | xA | xD | [x20-xD7FF] | [xE000-xFFFD] + | [x10000-x10FFFF] +any Unicode character, excluding the surrogate blocks, FFFE, and FFFF.

+ +

c : an UNICODE value (int) +

IS_BLANK()

#define     IS_BLANK(c)

+Macro to check the following production in the XML spec: +

+[3] S ::= (x20 | x9 | xD | xA)+

+ +

c : an UNICODE value (int) +

IS_BASECHAR()

#define IS_BASECHAR(c) xmlIsBaseChar(c)
+

+Macro to check the following production in the XML spec: +

+[85] BaseChar ::= ... long list see REC ...

+ +

c : an UNICODE value (int) +

IS_DIGIT()

#define IS_DIGIT(c) xmlIsDigit(c)
+

+Macro to check the following production in the XML spec: +

+[88] Digit ::= ... long list see REC ...

+ +

c : an UNICODE value (int) +

IS_COMBINING()

#define IS_COMBINING(c) xmlIsCombining(c)
+

+Macro to check the following production in the XML spec: +

+[87] CombiningChar ::= ... long list see REC ...

+ +

c : an UNICODE value (int) +

IS_EXTENDER()

#define IS_EXTENDER(c) xmlIsExtender(c)
+

+Macro to check the following production in the XML spec: +

+[89] Extender ::= x00B7 | x02D0 | x02D1 | x0387 | x0640 | + x0E46 | x0EC6 | x3005 | [x3031-x3035] | + [x309D-x309E] | [x30FC-x30FE]

+ +

c : an UNICODE value (int) +

IS_IDEOGRAPHIC()

#define IS_IDEOGRAPHIC(c) xmlIsIdeographic(c)
+

+Macro to check the following production in the XML spec: +

+[86] Ideographic ::= [x4E00-x9FA5] | x3007 | [x3021-x3029]

+ +

c : an UNICODE value (int) +

IS_LETTER()

#define IS_LETTER(c) (IS_BASECHAR(c) || IS_IDEOGRAPHIC(c))
+

+Macro to check the following production in the XML spec: +

+[84] Letter ::= BaseChar | Ideographic

+ +

c : an UNICODE value (int) +

IS_PUBIDCHAR()

#define IS_PUBIDCHAR(c)	xmlIsPubidChar(c)
+

+Macro to check the following production in the XML spec: +

+[13] PubidChar ::= x20 | xD | xA | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%]

+ +

c : an UNICODE value (int) +

SKIP_EOL()

#define     SKIP_EOL(p)

+Skips the end of line chars.

+ +

p : and UTF8 string pointer +

MOVETO_ENDTAG()

#define     MOVETO_ENDTAG(p)

+Skips to the next '>' char.

+ +

p : and UTF8 string pointer +

MOVETO_STARTTAG()

#define     MOVETO_STARTTAG(p)

+Skips to the next '<' char.

+ +

p : and UTF8 string pointer +

xmlIsBaseChar ()

int         xmlIsBaseChar                   (int c);

+Check whether the character is allowed by the production +[85] BaseChar ::= ... long list see REC ... +

+VI is your friend ! +:1,$ s/\[x\([0-9A-Z]*\)-x\([0-9A-Z]*\)\]/ (((c) >= 0x\1) \&\& ((c) <= 0x\2)) ||/ +and +:1,$ s/x\([0-9A-Z]*\)/ ((c) == 0x\1) ||/

+ +

c : an unicode character (int) +
Returns :0 if not, non-zero otherwise +

xmlIsBlank ()

int         xmlIsBlank                      (int c);

+Check whether the character is allowed by the production +[3] S ::= (x20 | x9 | xD | xA)+ +Also available as a macro IS_BLANK()

+ +

c : an unicode character (int) +
Returns :0 if not, non-zero otherwise +

xmlIsPubidChar ()

int         xmlIsPubidChar                  (int c);

+Check whether the character is allowed by the production +[13] PubidChar ::= x20 | xD | xA | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%]

+ +

c : an unicode character (int) +
Returns :0 if not, non-zero otherwise +

xmlIsLetter ()

int         xmlIsLetter                     (int c);

+Check whether the character is allowed by the production +[84] Letter ::= BaseChar | Ideographic

+ +

c : an unicode character (int) +
Returns :0 if not, non-zero otherwise +

xmlIsDigit ()

int         xmlIsDigit                      (int c);

+Check whether the character is allowed by the production +[88] Digit ::= ... long list see REC ...

+ +

c : an unicode character (int) +
Returns :0 if not, non-zero otherwise +

xmlIsIdeographic ()

int         xmlIsIdeographic                (int c);

+Check whether the character is allowed by the production +[86] Ideographic ::= [x4E00-x9FA5] | x3007 | [x3021-x3029]

+ +

c : an unicode character (int) +
Returns :0 if not, non-zero otherwise +

xmlIsExtender ()

int         xmlIsExtender                   (int c);

+Check whether the character is allowed by the production +[89] Extender ::= x00B7 | x02D0 | x02D1 | x0387 | x0640 | + x0E46 | x0EC6 | x3005 | [x3031-x3035] | + [x309D-x309E] | [x30FC-x30FE]

+ +

c : an unicode character (int) +
Returns :0 if not, non-zero otherwise +

xmlIsCombining ()

int         xmlIsCombining                  (int c);

+Check whether the character is allowed by the production +[87] CombiningChar ::= ... long list see REC ...

+ +

c : an unicode character (int) +
Returns :0 if not, non-zero otherwise +

xmlIsChar ()

int         xmlIsChar                       (int c);

+Check whether the character is allowed by the production +[2] Char ::= x9 | xA | xD | [x20-xD7FF] | [xE000-xFFFD] + | [x10000-x10FFFF] +any Unicode character, excluding the surrogate blocks, FFFE, and FFFF. +Also available as a macro IS_CHAR()

+ +

c : an unicode character (int) +
Returns :0 if not, non-zero otherwise +

xmlCreateFileParserCtxt ()

xmlParserCtxtPtr xmlCreateFileParserCtxt    (const char *filename);

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

+ +

filename : the filename +
Returns :the new parser context or NULL +

xmlCreateMemoryParserCtxt ()

xmlParserCtxtPtr xmlCreateMemoryParserCtxt  (const char *buffer,
+                                             int size);

+Create a parser context for an XML in-memory document.

+ +

buffer : a pointer to a char array +
size : the size of the array +
Returns :the new parser context or NULL +

xmlNewParserCtxt ()

xmlParserCtxtPtr xmlNewParserCtxt           (void);

+Allocate and initialize a new parser context.

+ +

Returns :the xmlParserCtxtPtr or NULL +

xmlCreateEntityParserCtxt ()

xmlParserCtxtPtr xmlCreateEntityParserCtxt  (const xmlChar *URL,
+                                             const xmlChar *ID,
+                                             const xmlChar *base);

+Create a parser context for an external entity +Automatic support for ZLIB/Compress compressed document is provided +by default if found at compile-time.

+ +

URL : the entity URL +
ID : the entity PUBLIC ID +
base : a possible base for the target URI +
Returns :the new parser context or NULL +

xmlSwitchEncoding ()

int         xmlSwitchEncoding               (xmlParserCtxtPtr ctxt,
+                                             xmlCharEncoding enc);

+change the input functions when discovering the character encoding +of a given entity.

+ +

ctxt : the parser context +
enc : the encoding value (number) +
Returns :0 in case of success, -1 otherwise +

xmlSwitchToEncoding ()

int         xmlSwitchToEncoding             (xmlParserCtxtPtr ctxt,
+                                             xmlCharEncodingHandlerPtr handler);

+change the input functions when discovering the character encoding +of a given entity.

+ +

ctxt : the parser context +
handler : the encoding handler +
Returns :0 in case of success, -1 otherwise +

xmlHandleEntity ()

void        xmlHandleEntity                 (xmlParserCtxtPtr ctxt,
+                                             xmlEntityPtr entity);

+Default handling of defined entities, when should we define a new input +stream ? When do we just handle that as a set of chars ? +

+OBSOLETE: to be removed at some point.

+ +

ctxt : an XML parser context +
entity : an XML entity pointer. +

xmlNewStringInputStream ()

xmlParserInputPtr xmlNewStringInputStream   (xmlParserCtxtPtr ctxt,
+                                             const xmlChar *buffer);

+Create a new input stream based on a memory buffer.

+ +

ctxt : an XML parser context +
buffer : an memory buffer +
Returns :the new input stream +

xmlNewEntityInputStream ()

xmlParserInputPtr xmlNewEntityInputStream   (xmlParserCtxtPtr ctxt,
+                                             xmlEntityPtr entity);

+Create a new input stream based on an xmlEntityPtr

+ +

ctxt : an XML parser context +
entity : an Entity pointer +
Returns :the new input stream or NULL +

xmlPushInput ()

void        xmlPushInput                    (xmlParserCtxtPtr ctxt,
+                                             xmlParserInputPtr input);

+xmlPushInput: switch to a new input stream which is stacked on top + of the previous one(s).

+ +

ctxt : an XML parser context +
input : an XML parser input fragment (entity, XML fragment ...). +

xmlPopInput ()

xmlChar     xmlPopInput                     (xmlParserCtxtPtr ctxt);

+xmlPopInput: the current input pointed by ctxt->input came to an end + pop it and return the next char.

+ +

ctxt : an XML parser context +
Returns :the current xmlChar in the parser context +

xmlFreeInputStream ()

void        xmlFreeInputStream              (xmlParserInputPtr input);

+Free up an input stream.

+ +

input : an xmlParserInputPtr +

xmlNewInputFromFile ()

xmlParserInputPtr xmlNewInputFromFile       (xmlParserCtxtPtr ctxt,
+                                             const char *filename);

+Create a new input stream based on a file.

+ +

ctxt : an XML parser context +
filename : the filename to use as entity +
Returns :the new input stream or NULL in case of error +

xmlNewInputStream ()

xmlParserInputPtr xmlNewInputStream         (xmlParserCtxtPtr ctxt);

+Create a new input stream structure

+ +

ctxt : an XML parser context +
Returns :the new input stream or NULL +

xmlSplitQName ()

xmlChar*    xmlSplitQName                   (xmlParserCtxtPtr ctxt,
+                                             const xmlChar *name,
+                                             xmlChar **prefix);

+parse an UTF8 encoded XML qualified name string +

+[NS 5] QName ::= (Prefix ':')? LocalPart +

+[NS 6] Prefix ::= NCName +

+[NS 7] LocalPart ::= NCName

+ +

ctxt : an XML parser context +
name : an XML parser context +
prefix : a xmlChar ** +
Returns :the local part, and prefix is updated + to get the Prefix if any. +

xmlNamespaceParseNCName ()

xmlChar*    xmlNamespaceParseNCName         (xmlParserCtxtPtr ctxt);

+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

+ +

ctxt : an XML parser context +
Returns :the namespace name or NULL +

xmlNamespaceParseQName ()

xmlChar*    xmlNamespaceParseQName          (xmlParserCtxtPtr ctxt,
+                                             xmlChar **prefix);

+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 +

+[NS 5] QName ::= (Prefix ':')? LocalPart +

+[NS 6] Prefix ::= NCName +

+[NS 7] LocalPart ::= NCName

+ +

ctxt : an XML parser context +
prefix : a xmlChar ** +
Returns :the local part, and prefix is updated + to get the Prefix if any. +

xmlNamespaceParseNSDef ()

xmlChar*    xmlNamespaceParseNSDef          (xmlParserCtxtPtr ctxt);

+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 +

+[NS 2] PrefixDef ::= 'xmlns' (':' NCName)?

+ +

ctxt : an XML parser context +
Returns :the namespace name +

xmlParseQuotedString ()

xmlChar*    xmlParseQuotedString            (xmlParserCtxtPtr ctxt);

+Parse and return a string between quotes or doublequotes +

+TODO: Deprecated, to be removed at next drop of binary compatibility

+ +

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

xmlParseNamespace ()

void        xmlParseNamespace               (xmlParserCtxtPtr ctxt);

+xmlParseNamespace: parse specific PI '<?namespace ...' constructs. +

+This is what the older xml-name Working Draft specified, a bunch of +other stuff may still rely on it, so support is still here as +if it was declared on the root of the Tree:-( +

+TODO: remove from library +

+To be removed at next drop of binary compatibility

+ +

ctxt : an XML parser context +

xmlScanName ()

xmlChar*    xmlScanName                     (xmlParserCtxtPtr ctxt);

+Trickery: parse an XML name but without consuming the input flow +Needed for rollback cases. Used only when parsing entities references. +

+TODO: seems deprecated now, only used in the default part of + xmlParserHandleReference +

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

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

+[6] Names ::= Name (S Name)*

+ +

ctxt : an XML parser context +
Returns :the Name parsed or NULL +

xmlParseName ()

xmlChar*    xmlParseName                    (xmlParserCtxtPtr ctxt);

+parse an XML name. +

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

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

+[6] Names ::= Name (S Name)*

+ +

ctxt : an XML parser context +
Returns :the Name parsed or NULL +

xmlParseNmtoken ()

xmlChar*    xmlParseNmtoken                 (xmlParserCtxtPtr ctxt);

+parse an XML Nmtoken. +

+[7] Nmtoken ::= (NameChar)+ +

+[8] Nmtokens ::= Nmtoken (S Nmtoken)*

+ +

ctxt : an XML parser context +
Returns :the Nmtoken parsed or NULL +

xmlParseEntityValue ()

xmlChar*    xmlParseEntityValue             (xmlParserCtxtPtr ctxt,
+                                             xmlChar **orig);

+parse a value for ENTITY declarations +

+[9] EntityValue ::= '"' ([^%&"] | PEReference | Reference)* '"' | + "'" ([^%&'] | PEReference | Reference)* "'"

+ +

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

xmlParseAttValue ()

xmlChar*    xmlParseAttValue                (xmlParserCtxtPtr ctxt);

+parse a value for an attribute +Note: the parser won't do substitution of entities here, this +will be handled later in xmlStringGetNodeList +

+[10] AttValue ::= '"' ([^<&"] | Reference)* '"' | + "'" ([^<&'] | Reference)* "'" +

+3.3.3 Attribute-Value Normalization: +Before the value of an attribute is passed to the application or +checked for validity, the XML processor must normalize it as follows: +- a character reference is processed by appending the referenced + character to the attribute value +- an entity reference is processed by recursively processing the + replacement text of the entity +- a whitespace character (x20, xD, xA, x9) is processed by + appending x20 to the normalized value, except that only a single + x20 is appended for a "xDxA" sequence that is part of an external + parsed entity or the literal entity value of an internal parsed entity +- other characters are processed by appending them to the normalized value +If the declared value is not CDATA, then the XML processor must further +process the normalized attribute value by discarding any leading and +trailing space (x20) characters, and by replacing sequences of space +(x20) characters by a single space (x20) character. +All attributes for which no declaration has been read should be treated +by a non-validating parser as if declared CDATA.

+ +

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

xmlParseSystemLiteral ()

xmlChar*    xmlParseSystemLiteral           (xmlParserCtxtPtr ctxt);

+parse an XML Literal +

+[11] SystemLiteral ::= ('"' [^"]* '"') | ("'" [^']* "'")

+ +

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

xmlParsePubidLiteral ()

xmlChar*    xmlParsePubidLiteral            (xmlParserCtxtPtr ctxt);

+parse an XML public literal +

+[12] PubidLiteral ::= '"' PubidChar* '"' | "'" (PubidChar - "'")* "'"

+ +

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

xmlParseCharData ()

void        xmlParseCharData                (xmlParserCtxtPtr ctxt,
+                                             int cdata);

+parse a CharData section. +if we are within a CDATA section ']]>' marks an end of section. +

+The right angle bracket (>) may be represented using the string "&gt;", +and must, for compatibility, be escaped using "&gt;" or a character +reference when it appears in the string "]]>" in content, when that +string is not marking the end of a CDATA section. +

+[14] CharData ::= [^<&]* - ([^<&]* ']]>' [^<&]*)

+ +

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

xmlParseExternalID ()

xmlChar*    xmlParseExternalID              (xmlParserCtxtPtr ctxt,
+                                             xmlChar **publicID,
+                                             int strict);

+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

+ +

ctxt : an XML parser context +
publicID : a xmlChar** receiving PubidLiteral +
strict : indicate whether we should restrict parsing to only + production [75], see NOTE below +
Returns :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. +

xmlParseComment ()

void        xmlParseComment                 (xmlParserCtxtPtr ctxt);

+Skip an XML (SGML) comment <!-- .... --> + The spec says that "For compatibility, the string "--" (double-hyphen) + must not occur within comments. " +

+[15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'

+ +

ctxt : an XML parser context +

xmlParsePITarget ()

xmlChar*    xmlParsePITarget                (xmlParserCtxtPtr ctxt);

+parse the name of a PI +

+[17] PITarget ::= Name - (('X' | 'x') ('M' | 'm') ('L' | 'l'))

+ +

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

xmlParsePI ()

void        xmlParsePI                      (xmlParserCtxtPtr ctxt);

+parse an XML Processing Instruction. +

+[16] PI ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>' +

+The processing is transfered to SAX once parsed.

+ +

ctxt : an XML parser context +

xmlParseNotationDecl ()

void        xmlParseNotationDecl            (xmlParserCtxtPtr ctxt);

+parse a notation declaration +

+[82] NotationDecl ::= '<!NOTATION' S Name S (ExternalID | PublicID) S? '>' +

+Hence there is actually 3 choices: + 'PUBLIC' S PubidLiteral + 'PUBLIC' S PubidLiteral S SystemLiteral +and 'SYSTEM' S SystemLiteral +

+See the NOTE on xmlParseExternalID().

+ +

ctxt : an XML parser context +

xmlParseEntityDecl ()

void        xmlParseEntityDecl              (xmlParserCtxtPtr ctxt);

+parse <!ENTITY declarations +

+[70] EntityDecl ::= GEDecl | PEDecl +

+[71] GEDecl ::= '<!ENTITY' S Name S EntityDef S? '>' +

+[72] PEDecl ::= '<!ENTITY' S '%' S Name S PEDef S? '>' +

+[73] EntityDef ::= EntityValue | (ExternalID NDataDecl?) +

+[74] PEDef ::= EntityValue | ExternalID +

+[76] NDataDecl ::= S 'NDATA' S Name +

+[ VC: Notation Declared ] +The Name must match the declared name of a notation.

+ +

ctxt : an XML parser context +

xmlParseDefaultDecl ()

int         xmlParseDefaultDecl             (xmlParserCtxtPtr ctxt,
+                                             xmlChar **value);

+Parse an attribute default declaration +

+[60] DefaultDecl ::= 'REQUIRED' | 'IMPLIED' | (('FIXED' S)? AttValue) +

+[ VC: Required Attribute ] +if the default declaration is the keyword REQUIRED, then the +attribute must be specified for all elements of the type in the +attribute-list declaration. +

+[ VC: Attribute Default Legal ] +The declared default value must meet the lexical constraints of +the declared attribute type c.f. xmlValidateAttributeDecl() +

+[ VC: Fixed Attribute Default ] +if an attribute has a default value declared with the FIXED +keyword, instances of that attribute must match the default value. +

+[ WFC: No < in Attribute Values ] +handled in xmlParseAttValue()

+ +

ctxt : an XML parser context +
value : Receive a possible fixed default value for the attribute +
Returns : XML_ATTRIBUTE_NONE, XML_ATTRIBUTE_REQUIRED, XML_ATTRIBUTE_IMPLIED + or XML_ATTRIBUTE_FIXED. +

xmlParseNotationType ()

xmlEnumerationPtr xmlParseNotationType      (xmlParserCtxtPtr ctxt);

+parse an Notation attribute type. +

+Note: the leading 'NOTATION' S part has already being parsed... +

+[58] NotationType ::= 'NOTATION' S '(' S? Name (S? '|' S? Name)* S? ')' +

+[ VC: Notation Attributes ] +Values of this type must match one of the notation names included +in the declaration; all notation names in the declaration must be declared.

+ +

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

xmlParseEnumerationType ()

xmlEnumerationPtr xmlParseEnumerationType   (xmlParserCtxtPtr ctxt);

+parse an Enumeration attribute type. +

+[59] Enumeration ::= '(' S? Nmtoken (S? '|' S? Nmtoken)* S? ')' +

+[ VC: Enumeration ] +Values of this type must match one of the Nmtoken tokens in +the declaration

+ +

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

xmlParseEnumeratedType ()

int         xmlParseEnumeratedType          (xmlParserCtxtPtr ctxt,
+                                             xmlEnumerationPtr *tree);

+parse an Enumerated attribute type. +

+[57] EnumeratedType ::= NotationType | Enumeration +

+[58] NotationType ::= 'NOTATION' S '(' S? Name (S? '|' S? Name)* S? ')'

+ +

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

xmlParseAttributeType ()

int         xmlParseAttributeType           (xmlParserCtxtPtr ctxt,
+                                             xmlEnumerationPtr *tree);

+parse the Attribute list def for an element +

+[54] AttType ::= StringType | TokenizedType | EnumeratedType +

+[55] StringType ::= 'CDATA' +

+[56] TokenizedType ::= 'ID' | 'IDREF' | 'IDREFS' | 'ENTITY' | + 'ENTITIES' | 'NMTOKEN' | 'NMTOKENS' +

+Validity constraints for attribute values syntax are checked in +xmlValidateAttributeValue() +

+[ VC: ID ] +Values of type ID must match the Name production. A name must not +appear more than once in an XML document as a value of this type; +i.e., ID values must uniquely identify the elements which bear them. +

+[ VC: One ID per Element Type ] +No element type may have more than one ID attribute specified. +

+[ VC: ID Attribute Default ] +An ID attribute must have a declared default of IMPLIED or REQUIRED. +

+[ VC: IDREF ] +Values of type IDREF must match the Name production, and values +of type IDREFS must match Names; each IDREF Name must match the value +of an ID attribute on some element in the XML document; i.e. IDREF +values must match the value of some ID attribute. +

+[ VC: Entity Name ] +Values of type ENTITY must match the Name production, values +of type ENTITIES must match Names; each Entity Name must match the +name of an unparsed entity declared in the DTD. +

+[ VC: Name Token ] +Values of type NMTOKEN must match the Nmtoken production; values +of type NMTOKENS must match Nmtokens.

+ +

ctxt : an XML parser context +
tree : the enumeration tree built while parsing +
Returns :the attribute type +

xmlParseAttributeListDecl ()

void        xmlParseAttributeListDecl       (xmlParserCtxtPtr ctxt);

+: parse the Attribute list def for an element +

+[52] AttlistDecl ::= '<!ATTLIST' S Name AttDef* S? '>' +

+[53] AttDef ::= S Name S AttType S DefaultDecl

+ +

ctxt : an XML parser context +

xmlParseElementMixedContentDecl ()

xmlElementContentPtr xmlParseElementMixedContentDecl
+                                            (xmlParserCtxtPtr ctxt,
+                                             xmlParserInputPtr inputchk);

+parse the declaration for a Mixed Element content +The leading '(' and spaces have been skipped in xmlParseElementContentDecl +

+[51] Mixed ::= '(' S? 'PCDATA' (S? '|' S? Name)* S? ')*' | + '(' S? 'PCDATA' S? ')' +

+[ VC: Proper Group/PE Nesting ] applies to [51] too (see [49]) +

+[ VC: No Duplicate Types ] +The same name must not appear more than once in a single +mixed-content declaration.

+ +

ctxt : an XML parser context +
inputchk : the input used for the current entity, needed for boundary checks +
Returns : the list of the xmlElementContentPtr describing the element choices +

xmlParseElementChildrenContentDecl ()

xmlElementContentPtr xmlParseElementChildrenContentDecl
+                                            (xmlParserCtxtPtr ctxt,
+                                             xmlParserInputPtr inputchk);

+parse the declaration for a Mixed Element content +The leading '(' and spaces have been skipped in xmlParseElementContentDecl +

+[47] children ::= (choice | seq) ('?' | '*' | '+')? +

+[48] cp ::= (Name | choice | seq) ('?' | '*' | '+')? +

+[49] choice ::= '(' S? cp ( S? '|' S? cp )* S? ')' +

+[50] seq ::= '(' S? cp ( S? ',' S? cp )* S? ')' +

+[ VC: Proper Group/PE Nesting ] applies to [49] and [50] +TODO Parameter-entity replacement text must be properly nested +with parenthesized groups. That is to say, if either of the +opening or closing parentheses in a choice, seq, or Mixed +construct is contained in the replacement text for a parameter +entity, both must be contained in the same replacement text. For +interoperability, if a parameter-entity reference appears in a +choice, seq, or Mixed construct, its replacement text should not +be empty, and neither the first nor last non-blank character of +the replacement text should be a connector (| or ,).

+ +

ctxt : an XML parser context +
inputchk : the input used for the current entity, needed for boundary checks +
Returns :the tree of xmlElementContentPtr describing the element + hierarchy. +

xmlParseElementContentDecl ()

int         xmlParseElementContentDecl      (xmlParserCtxtPtr ctxt,
+                                             xmlChar *name,
+                                             xmlElementContentPtr *result);

+parse the declaration for an Element content either Mixed or Children, +the cases EMPTY and ANY are handled directly in xmlParseElementDecl +

+[46] contentspec ::= 'EMPTY' | 'ANY' | Mixed | children

+ +

ctxt : an XML parser context +
name : the name of the element being defined. +
result : the Element Content pointer will be stored here if any +
Returns : the type of element content XML_ELEMENT_TYPE_xxx +

xmlParseElementDecl ()

int         xmlParseElementDecl             (xmlParserCtxtPtr ctxt);

+parse an Element declaration. +

+[45] elementdecl ::= '<!ELEMENT' S Name S contentspec S? '>' +

+[ VC: Unique Element Type Declaration ] +No element type may be declared more than once

+ +

ctxt : an XML parser context +
Returns :the type of the element, or -1 in case of error +

xmlParseMarkupDecl ()

void        xmlParseMarkupDecl              (xmlParserCtxtPtr ctxt);

+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 +markup declarations. That is to say, if either the first character +or the last character of a markup declaration (markupdecl above) is +contained in the replacement text for a parameter-entity reference, +both must be contained in the same replacement text. +

+[ WFC: PEs in Internal Subset ] +In the internal DTD subset, parameter-entity references can occur +only where markup declarations can occur, not within markup declarations. +(This does not apply to references that occur in external parameter +entities or to the external subset.)

+ +

ctxt : an XML parser context +

xmlParseCharRef ()

int         xmlParseCharRef                 (xmlParserCtxtPtr ctxt);

+parse Reference declarations +

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

+[ WFC: Legal Character ] +Characters referred to using character references must match the +production for Char.

+ +

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

xmlParseEntityRef ()

xmlEntityPtr xmlParseEntityRef              (xmlParserCtxtPtr ctxt);

+parse ENTITY references declarations +

+[68] EntityRef ::= '&' Name ';' +

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

+[ WFC: Parsed Entity ] +An entity reference must not contain the name of an unparsed entity

+ +

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

xmlParseReference ()

void        xmlParseReference               (xmlParserCtxtPtr ctxt);

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

+[67] Reference ::= EntityRef | CharRef

+ +

ctxt : an XML parser context +

xmlParsePEReference ()

void        xmlParsePEReference             (xmlParserCtxtPtr ctxt);

+parse PEReference declarations +The entity content is handled directly by pushing it's content as +a new input stream. +

+[69] PEReference ::= '%' Name ';' +

+[ WFC: No Recursion ] +A parsed entity must not contain a recursive +reference to itself, either directly or indirectly. +

+[ WFC: Entity Declared ] +In a document without any DTD, a document with only an internal DTD +subset which contains no parameter entity references, or a document +with "standalone='yes'", ... ... The declaration of a parameter +entity must precede any reference to it... +

+[ VC: Entity Declared ] +In a document with an external subset or external parameter entities +with "standalone='no'", ... ... The declaration of a parameter entity +must precede any reference to it... +

+[ WFC: In DTD ] +Parameter-entity references may only appear in the DTD. +NOTE: misleading but this is handled.

+ +

ctxt : an XML parser context +

xmlParseDocTypeDecl ()

void        xmlParseDocTypeDecl             (xmlParserCtxtPtr ctxt);

+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 +type of the root element.

+ +

ctxt : an XML parser context +

xmlParseAttribute ()

xmlChar*    xmlParseAttribute               (xmlParserCtxtPtr ctxt,
+                                             xmlChar **value);

+parse an attribute +

+[41] Attribute ::= Name Eq AttValue +

+[ WFC: No External Entity References ] +Attribute values cannot contain direct or indirect entity references +to external entities. +

+[ WFC: No < in Attribute Values ] +The replacement text of any entity referred to directly or indirectly in +an attribute value (other than "&lt;") must not contain a <. +

+[ VC: Attribute Value Type ] +The attribute must have been declared; the value must be of the type +declared for it. +

+[25] Eq ::= S? '=' S? +

+With namespace: +

+[NS 11] Attribute ::= QName Eq AttValue +

+Also the case QName == xmlns:??? is handled independently as a namespace +definition.

+ +

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

xmlParseStartTag ()

xmlChar*    xmlParseStartTag                (xmlParserCtxtPtr ctxt);

+parse a start of tag either for rule element or +EmptyElement. In both case we don't parse the tag closing chars. +

+[40] STag ::= '<' Name (S Attribute)* S? '>' +

+[ WFC: Unique Att Spec ] +No attribute name may appear more than once in the same start-tag or +empty-element tag. +

+[44] EmptyElemTag ::= '<' Name (S Attribute)* S? '/>' +

+[ WFC: Unique Att Spec ] +No attribute name may appear more than once in the same start-tag or +empty-element tag. +

+With namespace: +

+[NS 8] STag ::= '<' QName (S Attribute)* S? '>' +

+[NS 10] EmptyElement ::= '<' QName (S Attribute)* S? '/>'

+ +

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

xmlParseEndTag ()

void        xmlParseEndTag                  (xmlParserCtxtPtr ctxt);

+parse an end of tag +

+[42] ETag ::= '</' Name S? '>' +

+With namespace +

+[NS 9] ETag ::= '</' QName S? '>'

+ +

ctxt : an XML parser context +

xmlParseCDSect ()

void        xmlParseCDSect                  (xmlParserCtxtPtr ctxt);

+Parse escaped pure raw content. +

+[18] CDSect ::= CDStart CData CDEnd +

+[19] CDStart ::= '<![CDATA[' +

+[20] Data ::= (Char* - (Char* ']]>' Char*)) +

+[21] CDEnd ::= ']]>'

+ +

ctxt : an XML parser context +

xmlParseContent ()

void        xmlParseContent                 (xmlParserCtxtPtr ctxt);

+Parse a content: +

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

+ +

ctxt : an XML parser context +

xmlParseElement ()

void        xmlParseElement                 (xmlParserCtxtPtr ctxt);

+parse an XML element, this is highly recursive +

+[39] element ::= EmptyElemTag | STag content ETag +

+[ WFC: Element Type Match ] +The Name in an element's end-tag must match the element type in the +start-tag. +

+[ 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.

+ +

ctxt : an XML parser context +

xmlParseVersionNum ()

xmlChar*    xmlParseVersionNum              (xmlParserCtxtPtr ctxt);

+parse the XML version value. +

+[26] VersionNum ::= ([a-zA-Z0-9_.:] | '-')+

+ +

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

xmlParseVersionInfo ()

xmlChar*    xmlParseVersionInfo             (xmlParserCtxtPtr ctxt);

+parse the XML version. +

+[24] VersionInfo ::= S 'version' Eq (' VersionNum ' | " VersionNum ") +

+[25] Eq ::= S? '=' S?

+ +

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

xmlParseEncName ()

xmlChar*    xmlParseEncName                 (xmlParserCtxtPtr ctxt);

+parse the XML encoding name +

+[81] EncName ::= [A-Za-z] ([A-Za-z0-9._] | '-')*

+ +

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

xmlParseEncodingDecl ()

xmlChar*    xmlParseEncodingDecl            (xmlParserCtxtPtr ctxt);

+parse the XML encoding declaration +

+[80] EncodingDecl ::= S 'encoding' Eq ('"' EncName '"' | "'" EncName "'") +

+this setups the conversion filters.

+ +

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

xmlParseSDDecl ()

int         xmlParseSDDecl                  (xmlParserCtxtPtr ctxt);

+parse the XML standalone declaration +

+[32] SDDecl ::= S 'standalone' Eq + (("'" ('yes' | 'no') "'") | ('"' ('yes' | 'no')'"')) +

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

+ +

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

xmlParseXMLDecl ()

void        xmlParseXMLDecl                 (xmlParserCtxtPtr ctxt);

+parse an XML declaration header +

+[23] XMLDecl ::= '<?xml' VersionInfo EncodingDecl? SDDecl? S? '?>'

+ +

ctxt : an XML parser context +

xmlParseTextDecl ()

void        xmlParseTextDecl                (xmlParserCtxtPtr ctxt);

+parse an XML declaration header for external entities +

+[77] TextDecl ::= '<?xml' VersionInfo? EncodingDecl S? '?>' +

+Question: Seems that EncodingDecl is mandatory ? Is that a typo ?

+ +

ctxt : an XML parser context +

xmlParseMisc ()

void        xmlParseMisc                    (xmlParserCtxtPtr ctxt);

+parse an XML Misc* optional field. +

+[27] Misc ::= Comment | PI | S

+ +

ctxt : an XML parser context +

xmlParseExternalSubset ()

void        xmlParseExternalSubset          (xmlParserCtxtPtr ctxt,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);

+parse Markup declarations from an external subset +

+[30] extSubset ::= textDecl? extSubsetDecl +

+[31] extSubsetDecl ::= (markupdecl | conditionalSect | PEReference | S) *

+ +

ctxt : an XML parser context +
ExternalID : the external identifier +
SystemID : the system identifier (or URL) +

XML_SUBSTITUTE_NONE

#define XML_SUBSTITUTE_NONE	0
+

+If no entities need to be substituted.

+ +

XML_SUBSTITUTE_REF

#define XML_SUBSTITUTE_REF	1
+

+Whether general entities need to be substituted.

+ +

XML_SUBSTITUTE_PEREF

#define XML_SUBSTITUTE_PEREF	2
+

+Whether parameter entities need to be substituted.

+ +

XML_SUBSTITUTE_BOTH

#define XML_SUBSTITUTE_BOTH 	3
+

+Both general and parameter entities need to be substituted.

+ +

xmlDecodeEntities ()

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

+This function is deprecated, we now always process entities content +through xmlStringDecodeEntities +

+TODO: remove it in next major release. +

+[67] Reference ::= EntityRef | CharRef +

+[69] PEReference ::= '%' Name ';'

+ +

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

xmlStringDecodeEntities ()

xmlChar*    xmlStringDecodeEntities         (xmlParserCtxtPtr ctxt,
+                                             const xmlChar *str,
+                                             int what,
+                                             xmlChar end,
+                                             xmlChar end2,
+                                             xmlChar end3);

+Takes a entity string content and process to do the adequate substitutions. +

+[67] Reference ::= EntityRef | CharRef +

+[69] PEReference ::= '%' Name ';'

+ +

ctxt : the parser context +
str : the input string +
what : combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF +
end : an end marker xmlChar, 0 if none +
end2 : an end marker xmlChar, 0 if none +
end3 : an end marker xmlChar, 0 if none +
Returns :A newly allocated string with the substitution done. The caller + must deallocate it ! +

nodePush ()

int         nodePush                        (xmlParserCtxtPtr ctxt,
+                                             xmlNodePtr value);

+Pushes a new element node on top of the node stack

+ +

ctxt : an XML parser context +
value : the element node +
Returns :0 in case of error, the index in the stack otherwise +

nodePop ()

xmlNodePtr  nodePop                         (xmlParserCtxtPtr ctxt);

+Pops the top element node from the node stack

+ +

ctxt : an XML parser context +
Returns :the node just removed +

inputPush ()

int         inputPush                       (xmlParserCtxtPtr ctxt,
+                                             xmlParserInputPtr value);

+Pushes a new parser input on top of the input stack

+ +

ctxt : an XML parser context +
value : the parser input +
Returns :0 in case of error, the index in the stack otherwise +

inputPop ()

xmlParserInputPtr inputPop                  (xmlParserCtxtPtr ctxt);

+Pops the top parser input from the input stack

+ +

ctxt : an XML parser context +
Returns :the input just removed +

namePop ()

xmlChar*    namePop                         (xmlParserCtxtPtr ctxt);

+Pops the top element name from the name stack

+ +

ctxt : an XML parser context +
Returns :the name just removed +

namePush ()

int         namePush                        (xmlParserCtxtPtr ctxt,
+                                             xmlChar *value);

+Pushes a new element name on top of the name stack

+ +

ctxt : an XML parser context +
value : the element name +
Returns :0 in case of error, the index in the stack otherwise +

xmlSkipBlankChars ()

int         xmlSkipBlankChars               (xmlParserCtxtPtr ctxt);

+skip all blanks character found at that point in the input streams. +It pops up finished entities in the process if allowable at that point.

+ +

ctxt : the XML parser context +
Returns :the number of space chars skipped +

xmlStringCurrentChar ()

int         xmlStringCurrentChar            (xmlParserCtxtPtr ctxt,
+                                             const xmlChar *cur,
+                                             int *len);

+The current char value, if using UTF-8 this may actually span multiple +bytes in the input buffer.

+ +

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

xmlParserHandlePEReference ()

void        xmlParserHandlePEReference      (xmlParserCtxtPtr ctxt);

+[69] PEReference ::= '%' Name ';' +

+[ WFC: No Recursion ] +A parsed entity must not contain a recursive +reference to itself, either directly or indirectly. +

+[ WFC: Entity Declared ] +In a document without any DTD, a document with only an internal DTD +subset which contains no parameter entity references, or a document +with "standalone='yes'", ... ... The declaration of a parameter +entity must precede any reference to it... +

+[ VC: Entity Declared ] +In a document with an external subset or external parameter entities +with "standalone='no'", ... ... The declaration of a parameter entity +must precede any reference to it... +

+[ WFC: In DTD ] +Parameter-entity references may only appear in the DTD. +NOTE: misleading but this is handled. +

+A PEReference may have been detected in the current input stream +the handling is done accordingly to + http://www.w3.org/TR/REC-xmlentproc +i.e. + - Included in literal in entity values + - Included as Parameter Entity reference within DTDs

+ +

ctxt : the parser context +

xmlParserHandleReference ()

void        xmlParserHandleReference        (xmlParserCtxtPtr ctxt);

+TODO: Remove, now deprecated ... the test is done directly in the + content parsing +routines. +

+[67] Reference ::= EntityRef | CharRef +

+[68] EntityRef ::= '&' Name ';' +

+[ WFC: Entity Declared ] +the Name given in the entity reference must match that in an entity +declaration, except that well-formed documents need not declare any +of the following entities: amp, lt, gt, apos, quot. +

+[ WFC: Parsed Entity ] +An entity reference must not contain the name of an unparsed entity +

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

+A PEReference may have been detected in the current input stream +the handling is done accordingly to + http://www.w3.org/TR/REC-xmlentproc

+ +

ctxt : the parser context +

xmlCheckLanguageID ()

int         xmlCheckLanguageID              (const xmlChar *lang);

+Checks that the value conforms to the LanguageID production: +

+NOTE: this is somewhat deprecated, those productions were removed from + the XML Second edition. +

+[33] LanguageID ::= Langcode ('-' Subcode)* +[34] Langcode ::= ISO639Code | IanaCode | UserCode +[35] ISO639Code ::= ([a-z] | [A-Z]) ([a-z] | [A-Z]) +[36] IanaCode ::= ('i' | 'I') '-' ([a-z] | [A-Z])+ +[37] UserCode ::= ('x' | 'X') '-' ([a-z] | [A-Z])+ +[38] Subcode ::= ([a-z] | [A-Z])+

+ +

lang : pointer to the string value +
Returns :1 if correct 0 otherwise +

xmlCurrentChar ()

int         xmlCurrentChar                  (xmlParserCtxtPtr ctxt,
+                                             int *len);

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

+ +

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

xmlCopyCharMultiByte ()

int         xmlCopyCharMultiByte            (xmlChar *out,
+                                             int val);

+append the char value in the array

+ +

out : pointer to an array of xmlChar +
val : the char value +
Returns :the number of xmlChar written +

xmlCopyChar ()

int         xmlCopyChar                     (int len,
+                                             xmlChar *out,
+                                             int val);

+append the char value in the array

+ +

len : Ignored, compatibility +
out : pointer to an array of xmlChar +
val : the char value +
Returns :the number of xmlChar written +

xmlNextChar ()

void        xmlNextChar                     (xmlParserCtxtPtr ctxt);

+Skip to the next char input char.

+ +

ctxt : the XML parser context +

xmlParserInputShrink ()

void        xmlParserInputShrink            (xmlParserInputPtr in);

+This function removes used input for the parser.

+ +

in : an XML parser input +

htmlInitAutoClose ()

void        htmlInitAutoClose               (void);

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

+ +

htmlCreateFileParserCtxt ()

htmlParserCtxtPtr htmlCreateFileParserCtxt  (const char *filename,
+                                             const char *encoding);

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

+ +

filename : the filename +
encoding : a free form C string describing the HTML document encoding, or NULL +
Returns :the new parser context or NULL +

xmlEntityReferenceFunc ()

void        (*xmlEntityReferenceFunc)       (xmlEntityPtr ent,
+                                             xmlNodePtr firstNode,
+                                             xmlNodePtr lastNode);

+Callback function used when one needs to be able to track back the +provenance of a chunk of nodes inherited from an entity replacement.

+ +

ent : the entity +
firstNode : the fist node in the chunk +
lastNode : the last nod in the chunk +

xmlSetEntityReferenceFunc ()

void        xmlSetEntityReferenceFunc       (xmlEntityReferenceFunc func);

+Set the function to call call back when a xml reference has been made

+ +

func : A valid function +
<< DOCBparserencoding >>
diff --git a/doc/html/libxml-relaxng.html b/doc/html/libxml-relaxng.html index 096eb88a..0e44ed87 100644 --- a/doc/html/libxml-relaxng.html +++ b/doc/html/libxml-relaxng.html @@ -1,679 +1,130 @@ -relaxng
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

relaxng

Name

relaxng -- 

Synopsis


+
+relaxng
PrevUpHomeGnome XML Library Reference ManualNext
relaxng
relaxng — 
Synopsis
 
-struct      xmlRelaxNG;
-typedef     xmlRelaxNGPtr;
-void        (*xmlRelaxNGValidityErrorFunc)  (void *ctx,
+
+
+struct      xmlRelaxNG;
+typedef     xmlRelaxNGPtr;
+void        (*xmlRelaxNGValidityErrorFunc)  (void *ctx,
                                              const char *msg,
                                              ...);
-void        (*xmlRelaxNGValidityWarningFunc)
+void        (*xmlRelaxNGValidityWarningFunc)
                                             (void *ctx,
                                              const char *msg,
                                              ...);
-struct      xmlRelaxNGParserCtxt;
-typedef     xmlRelaxNGParserCtxtPtr;
-struct      xmlRelaxNGValidCtxt;
-typedef     xmlRelaxNGValidCtxtPtr;
-enum        xmlRelaxNGValidErr;
-xmlRelaxNGParserCtxtPtr xmlRelaxNGNewParserCtxt
+struct      xmlRelaxNGParserCtxt;
+typedef     xmlRelaxNGParserCtxtPtr;
+struct      xmlRelaxNGValidCtxt;
+typedef     xmlRelaxNGValidCtxtPtr;
+enum        xmlRelaxNGValidErr;
+xmlRelaxNGParserCtxtPtr xmlRelaxNGNewParserCtxt
                                             (const char *URL);
-xmlRelaxNGParserCtxtPtr xmlRelaxNGNewMemParserCtxt
+xmlRelaxNGParserCtxtPtr xmlRelaxNGNewMemParserCtxt
                                             (const char *buffer,
                                              int size);
-void        xmlRelaxNGFreeParserCtxt        (xmlRelaxNGParserCtxtPtr ctxt);
-void        xmlRelaxNGSetParserErrors       (xmlRelaxNGParserCtxtPtr ctxt,
-                                             xmlRelaxNGValidityErrorFunc err,
-                                             xmlRelaxNGValidityWarningFunc warn,
+xmlRelaxNGParserCtxtPtr xmlRelaxNGNewDocParserCtxt
+                                            (xmlDocPtr doc);
+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,
+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 doc);
-void        xmlRelaxNGCleanupTypes          (void);

Description

Details

struct xmlRelaxNG

struct xmlRelaxNG;

xmlRelaxNGPtr

xmlRelaxNGValidityErrorFunc ()

void        (*xmlRelaxNGValidityErrorFunc)  (void *ctx,
+xmlRelaxNGValidCtxtPtr xmlRelaxNGNewValidCtxt
+                                            (xmlRelaxNGPtr schema);
+void        xmlRelaxNGFreeValidCtxt         (xmlRelaxNGValidCtxtPtr ctxt);
+int         xmlRelaxNGValidateDoc           (xmlRelaxNGValidCtxtPtr ctxt,
+                                             xmlDocPtr doc);
+void        xmlRelaxNGCleanupTypes          (void);
+int         xmlRelaxNGValidatePushElement   (xmlRelaxNGValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem);
+int         xmlRelaxNGValidatePushCData     (xmlRelaxNGValidCtxtPtr ctxt,
+                                             const xmlChar *data,
+                                             int len);
+int         xmlRelaxNGValidatePopElement    (xmlRelaxNGValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem);
+int         xmlRelaxNGValidateFullElement   (xmlRelaxNGValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem);
+

Description

+ +

Details

struct xmlRelaxNG

struct xmlRelaxNG;

+ +

xmlRelaxNGPtr

typedef xmlRelaxNG *xmlRelaxNGPtr;
+

+ +

xmlRelaxNGValidityErrorFunc ()

void        (*xmlRelaxNGValidityErrorFunc)  (void *ctx,
                                              const char *msg,
-                                             ...);

ctx : 
msg : 
... : 

xmlRelaxNGValidityWarningFunc ()

void        (*xmlRelaxNGValidityWarningFunc)
+                                             ...);

+ +

ctx : +
msg : +
... : + + +

xmlRelaxNGValidityWarningFunc ()

void        (*xmlRelaxNGValidityWarningFunc)
                                             (void *ctx,
                                              const char *msg,
-                                             ...);

ctx : 
msg : 
... : 

struct xmlRelaxNGParserCtxt

struct xmlRelaxNGParserCtxt;

xmlRelaxNGParserCtxtPtr

struct xmlRelaxNGValidCtxt

struct xmlRelaxNGValidCtxt;

A RelaxNGs validation context

xmlRelaxNGValidCtxtPtr

enum xmlRelaxNGValidErr

typedef enum {
+                                             ...);

+ +

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,
@@ -711,1266 +162,141 @@ CLASS="PROGRAMLISTING"
     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 : 
Returns : 

xmlRelaxNGNewMemParserCtxt ()

xmlRelaxNGParserCtxtPtr xmlRelaxNGNewMemParserCtxt
+    XML_RELAXNG_ERR_INTERNAL,
+    XML_RELAXNG_ERR_ELEMWRONG,
+    XML_RELAXNG_ERR_TEXTWRONG
+} 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 : 
size : 
Returns : 

xmlRelaxNGFreeParserCtxt ()

void        xmlRelaxNGFreeParserCtxt        (xmlRelaxNGParserCtxtPtr ctxt);

Free the resources associated to the schema parser context

ctxt : 

xmlRelaxNGSetParserErrors ()

void        xmlRelaxNGSetParserErrors       (xmlRelaxNGParserCtxtPtr ctxt,
-                                             xmlRelaxNGValidityErrorFunc err,
-                                             xmlRelaxNGValidityWarningFunc warn,
-                                             void *ctx);

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

ctxt : 
err : 
warn : 
ctx : 

xmlRelaxNGParse ()

xmlRelaxNGPtr xmlRelaxNGParse               (xmlRelaxNGParserCtxtPtr ctxt);

parse a schema definition resource and build an internal + 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 +

xmlRelaxNGNewDocParserCtxt ()

xmlRelaxNGParserCtxtPtr xmlRelaxNGNewDocParserCtxt
+                                            (xmlDocPtr doc);

+Create an XML RelaxNGs parser context for that document. +Note: since the process of compiling a RelaxNG schemas modifies the + document, the doc parameter is duplicated internally.

+ +

doc : a preparsed document tree +
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 : 
Returns : 

xmlRelaxNGFree ()

void        xmlRelaxNGFree                  (xmlRelaxNGPtr schema);

Deallocate a RelaxNG structure.

schema : 

xmlRelaxNGDump ()

void        xmlRelaxNGDump                  (FILE *output,
-                                             xmlRelaxNGPtr schema);

Dump a RelaxNG structure back

output : 
schema : 

xmlRelaxNGDumpTree ()

void        xmlRelaxNGDumpTree              (FILE *output,
-                                             xmlRelaxNGPtr schema);

Dump the transformed RelaxNG tree.

output : 
schema : 

xmlRelaxNGSetValidErrors ()

void        xmlRelaxNGSetValidErrors        (xmlRelaxNGValidCtxtPtr ctxt,
-                                             xmlRelaxNGValidityErrorFunc err,
-                                             xmlRelaxNGValidityWarningFunc warn,
-                                             void *ctx);

Set the error and warning callback informations

ctxt : 
err : 
warn : 
ctx : 

xmlRelaxNGNewValidCtxt ()

xmlRelaxNGValidCtxtPtr xmlRelaxNGNewValidCtxt
-                                            (xmlRelaxNGPtr schema);

Create an XML RelaxNGs validation context based on the given schema

schema : 
Returns : 

xmlRelaxNGFreeValidCtxt ()

void        xmlRelaxNGFreeValidCtxt         (xmlRelaxNGValidCtxtPtr ctxt);

Free the resources associated to the schema validation context

ctxt : 

xmlRelaxNGValidateDoc ()

int         xmlRelaxNGValidateDoc           (xmlRelaxNGValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);

Validate a document tree in memory.

ctxt : 
doc : 
Returns : 

xmlRelaxNGCleanupTypes ()

void        xmlRelaxNGCleanupTypes          (void);

Cleanup the default Schemas type library associated to RelaxNG

\ No newline at end of file +*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 doc);

+Validate a document tree in memory.

+ +

ctxt : a Relax-NG validation context +
doc : a parsed document tree +
Returns :0 if the document is valid, a positive error code + number otherwise and -1 in case of internal or API error. +

xmlRelaxNGCleanupTypes ()

void        xmlRelaxNGCleanupTypes          (void);

+Cleanup the default Schemas type library associated to RelaxNG

+ +

xmlRelaxNGValidatePushElement ()

int         xmlRelaxNGValidatePushElement   (xmlRelaxNGValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem);

+Push a new element start on the RelaxNG validation stack.

+ +

ctxt : the validation context +
doc : a document instance +
elem : an element instance +
Returns :1 if no validation problem was found or 0 if validating the + element requires a full node, and -1 in case of error. +

xmlRelaxNGValidatePushCData ()

int         xmlRelaxNGValidatePushCData     (xmlRelaxNGValidCtxtPtr ctxt,
+                                             const xmlChar *data,
+                                             int len);

+check the CData parsed for validation in the current stack

+ +

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

xmlRelaxNGValidatePopElement ()

int         xmlRelaxNGValidatePopElement    (xmlRelaxNGValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem);

+Pop the element end from the RelaxNG validation stack.

+ +

ctxt : the RelaxNG validation context +
doc : a document instance +
elem : an element instance +
Returns :1 if no validation problem was found or 0 otherwise +

xmlRelaxNGValidateFullElement ()

int         xmlRelaxNGValidateFullElement   (xmlRelaxNGValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem);

+Validate a full subtree when xmlRelaxNGValidatePushElement() returned +0 and the content of the node has been expanded.

+ +

ctxt : the validation context +
doc : a document instance +
elem : an element instance +
Returns :1 if no validation problem was found or -1 in case of error. +
<< validuri >>
diff --git a/doc/html/libxml-schemasInternals.html b/doc/html/libxml-schemasInternals.html new file mode 100644 index 00000000..7cc0b924 --- /dev/null +++ b/doc/html/libxml-schemasInternals.html @@ -0,0 +1,347 @@ + +schemasInternals
PrevUpHomeGnome XML Library Reference Manual

schemasInternals

schemasInternals —

Synopsis

+
+
+
+enum        xmlSchemaTypeType;
+enum        xmlSchemaContentType;
+struct      xmlSchemaVal;
+typedef     xmlSchemaValPtr;
+struct      xmlSchemaType;
+typedef     xmlSchemaTypePtr;
+struct      xmlSchemaFacet;
+typedef     xmlSchemaFacetPtr;
+struct      xmlSchemaAnnot;
+typedef     xmlSchemaAnnotPtr;
+#define     XML_SCHEMAS_ANYATTR_SKIP
+#define     XML_SCHEMAS_ANYATTR_LAX
+#define     XML_SCHEMAS_ANYATTR_STRICT
+struct      xmlSchemaAttribute;
+typedef     xmlSchemaAttributePtr;
+struct      xmlSchemaAttributeGroup;
+typedef     xmlSchemaAttributeGroupPtr;
+#define     XML_SCHEMAS_TYPE_MIXED
+#define     XML_SCHEMAS_ELEM_NILLABLE
+#define     XML_SCHEMAS_ELEM_GLOBAL
+#define     XML_SCHEMAS_ELEM_DEFAULT
+#define     XML_SCHEMAS_ELEM_FIXED
+#define     XML_SCHEMAS_ELEM_ABSTRACT
+#define     XML_SCHEMAS_ELEM_TOPLEVEL
+#define     XML_SCHEMAS_ELEM_REF
+struct      xmlSchemaElement;
+typedef     xmlSchemaElementPtr;
+#define     XML_SCHEMAS_FACET_UNKNOWN
+#define     XML_SCHEMAS_FACET_PRESERVE
+#define     XML_SCHEMAS_FACET_REPLACE
+#define     XML_SCHEMAS_FACET_COLLAPSE
+struct      xmlSchemaNotation;
+typedef     xmlSchemaNotationPtr;
+#define     XML_SCHEMAS_QUALIF_ELEM
+#define     XML_SCHEMAS_QUALIF_ATTR
+struct      xmlSchema;
+void        xmlSchemaFreeType               (xmlSchemaTypePtr type);
+

Description

+ +

Details

enum xmlSchemaTypeType

typedef enum {
+    XML_SCHEMA_TYPE_BASIC = 1,
+    XML_SCHEMA_TYPE_ANY,
+    XML_SCHEMA_TYPE_FACET,
+    XML_SCHEMA_TYPE_SIMPLE,
+    XML_SCHEMA_TYPE_COMPLEX,
+    XML_SCHEMA_TYPE_SEQUENCE,
+    XML_SCHEMA_TYPE_CHOICE,
+    XML_SCHEMA_TYPE_ALL,
+    XML_SCHEMA_TYPE_SIMPLE_CONTENT,
+    XML_SCHEMA_TYPE_COMPLEX_CONTENT,
+    XML_SCHEMA_TYPE_UR,
+    XML_SCHEMA_TYPE_RESTRICTION,
+    XML_SCHEMA_TYPE_EXTENSION,
+    XML_SCHEMA_TYPE_ELEMENT,
+    XML_SCHEMA_TYPE_ATTRIBUTE,
+    XML_SCHEMA_TYPE_ATTRIBUTEGROUP,
+    XML_SCHEMA_TYPE_GROUP,
+    XML_SCHEMA_TYPE_NOTATION,
+    XML_SCHEMA_TYPE_LIST,
+    XML_SCHEMA_TYPE_UNION,
+    XML_SCHEMA_FACET_MININCLUSIVE = 1000,
+    XML_SCHEMA_FACET_MINEXCLUSIVE,
+    XML_SCHEMA_FACET_MAXINCLUSIVE,
+    XML_SCHEMA_FACET_MAXEXCLUSIVE,
+    XML_SCHEMA_FACET_TOTALDIGITS,
+    XML_SCHEMA_FACET_FRACTIONDIGITS,
+    XML_SCHEMA_FACET_PATTERN,
+    XML_SCHEMA_FACET_ENUMERATION,
+    XML_SCHEMA_FACET_WHITESPACE,
+    XML_SCHEMA_FACET_LENGTH,
+    XML_SCHEMA_FACET_MAXLENGTH,
+    XML_SCHEMA_FACET_MINLENGTH
+} xmlSchemaTypeType;
+

+ +

enum xmlSchemaContentType

typedef enum {
+    XML_SCHEMA_CONTENT_UNKNOWN = 0,
+    XML_SCHEMA_CONTENT_EMPTY = 1,
+    XML_SCHEMA_CONTENT_ELEMENTS,
+    XML_SCHEMA_CONTENT_MIXED,
+    XML_SCHEMA_CONTENT_SIMPLE,
+    XML_SCHEMA_CONTENT_MIXED_OR_ELEMENTS,
+    XML_SCHEMA_CONTENT_BASIC,
+    XML_SCHEMA_CONTENT_ANY
+} xmlSchemaContentType;
+

+ +

struct xmlSchemaVal

struct xmlSchemaVal;

+ +

xmlSchemaValPtr

typedef xmlSchemaVal *xmlSchemaValPtr;
+

+ +

struct xmlSchemaType

struct xmlSchemaType {
+    xmlSchemaTypeType type;	/* The kind of type */
+    struct _xmlSchemaType *next;/* the next type if in a sequence ... */
+    xmlChar *name;
+    xmlChar *id;
+    xmlChar *ref;
+    xmlChar *refNs;
+    xmlSchemaAnnotPtr annot;
+    xmlSchemaTypePtr subtypes;
+    xmlSchemaAttributePtr attributes;
+    xmlNodePtr node;
+    int minOccurs;
+    int maxOccurs;
+
+    int flags;
+    xmlSchemaContentType contentType;
+    xmlChar *base;
+    xmlChar *baseNs;
+    xmlSchemaTypePtr baseType;
+    xmlSchemaFacetPtr facets;
+};
+

+ +

xmlSchemaTypePtr

typedef xmlSchemaType *xmlSchemaTypePtr;
+

+ +

struct xmlSchemaFacet

struct xmlSchemaFacet {
+    xmlSchemaTypeType type;	/* The kind of type */
+    struct _xmlSchemaFacet *next;/* the next type if in a sequence ... */
+    xmlChar *value;
+    xmlChar *id;
+    xmlSchemaAnnotPtr annot;
+    xmlNodePtr node;
+    int fixed;
+    int whitespace;
+    xmlSchemaValPtr val;
+    xmlRegexpPtr    regexp;
+};
+

+ +

xmlSchemaFacetPtr

typedef xmlSchemaFacet *xmlSchemaFacetPtr;
+

+ +

struct xmlSchemaAnnot

struct xmlSchemaAnnot {
+    struct _xmlSchemaAnnot *next;
+    xmlNodePtr content;         /* the annotation */
+};
+

+ +

xmlSchemaAnnotPtr

typedef xmlSchemaAnnot *xmlSchemaAnnotPtr;
+

+ +

XML_SCHEMAS_ANYATTR_SKIP

#define XML_SCHEMAS_ANYATTR_SKIP	1
+

+ +

XML_SCHEMAS_ANYATTR_LAX

#define XML_SCHEMAS_ANYATTR_LAX		2
+

+ +

XML_SCHEMAS_ANYATTR_STRICT

#define XML_SCHEMAS_ANYATTR_STRICT	3
+

+ +

struct xmlSchemaAttribute

struct xmlSchemaAttribute {
+    xmlSchemaTypeType type;	/* The kind of type */
+    struct _xmlSchemaAttribute *next;/* the next attribute if in a group ... */
+    xmlChar *name;
+    xmlChar *id;
+    xmlChar *ref;
+    xmlChar *refNs;
+    xmlChar *typeName;
+    xmlChar *typeNs;
+    xmlSchemaAnnotPtr annot;
+
+    xmlSchemaTypePtr base;
+    int occurs;
+    xmlChar *defValue;
+    xmlSchemaTypePtr subtypes;
+};
+

+ +

xmlSchemaAttributePtr

typedef xmlSchemaAttribute *xmlSchemaAttributePtr;
+

+ +

struct xmlSchemaAttributeGroup

struct xmlSchemaAttributeGroup {
+    xmlSchemaTypeType type;	/* The kind of type */
+    struct _xmlSchemaAttribute *next;/* the next attribute if in a group ... */
+    xmlChar *name;
+    xmlChar *id;
+    xmlChar *ref;
+    xmlChar *refNs;
+    xmlSchemaAnnotPtr annot;
+
+    xmlSchemaAttributePtr attributes;
+};
+

+ +

xmlSchemaAttributeGroupPtr

typedef xmlSchemaAttributeGroup *xmlSchemaAttributeGroupPtr;
+

+ +

XML_SCHEMAS_TYPE_MIXED

#define XML_SCHEMAS_TYPE_MIXED		1 << 0
+

+the element content type is mixed

+ +

XML_SCHEMAS_ELEM_NILLABLE

#define XML_SCHEMAS_ELEM_NILLABLE	1 << 0
+

+the element is nillable

+ +

XML_SCHEMAS_ELEM_GLOBAL

#define XML_SCHEMAS_ELEM_GLOBAL		1 << 1
+

+the element is global

+ +

XML_SCHEMAS_ELEM_DEFAULT

#define XML_SCHEMAS_ELEM_DEFAULT	1 << 2
+

+the element has a default value

+ +

XML_SCHEMAS_ELEM_FIXED

#define XML_SCHEMAS_ELEM_FIXED		1 << 3
+

+the element has a fixed value

+ +

XML_SCHEMAS_ELEM_ABSTRACT

#define XML_SCHEMAS_ELEM_ABSTRACT	1 << 4
+

+the element is abstract

+ +

XML_SCHEMAS_ELEM_TOPLEVEL

#define XML_SCHEMAS_ELEM_TOPLEVEL	1 << 5
+

+the element is top level

+ +

XML_SCHEMAS_ELEM_REF

#define XML_SCHEMAS_ELEM_REF		1 << 6
+

+the element is a reference to a type

+ +

struct xmlSchemaElement

struct xmlSchemaElement {
+    xmlSchemaTypeType type;	/* The kind of type */
+    struct _xmlSchemaType *next;/* the next type if in a sequence ... */
+    xmlChar *name;
+    xmlChar *id;
+    xmlChar *ref;
+    xmlChar *refNs;
+    xmlSchemaAnnotPtr annot;
+    xmlSchemaTypePtr subtypes;
+    xmlSchemaAttributePtr attributes;
+    xmlNodePtr node;
+    int minOccurs;
+    int maxOccurs;
+
+    int flags;
+    xmlChar *targetNamespace;
+    xmlChar *namedType;
+    xmlChar *namedTypeNs;
+    xmlChar *substGroup;
+    xmlChar *substGroupNs;
+    xmlChar *scope;
+    xmlChar *value;
+    struct _xmlSchemaElement *refDecl;
+    xmlRegexpPtr contModel;
+    xmlSchemaContentType contentType;
+};
+

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

+ +

xmlSchemaElementPtr

typedef xmlSchemaElement *xmlSchemaElementPtr;
+

+ +

XML_SCHEMAS_FACET_UNKNOWN

#define XML_SCHEMAS_FACET_UNKNOWN	0
+

+ +

XML_SCHEMAS_FACET_PRESERVE

#define XML_SCHEMAS_FACET_PRESERVE	1
+

+ +

XML_SCHEMAS_FACET_REPLACE

#define XML_SCHEMAS_FACET_REPLACE	2
+

+ +

XML_SCHEMAS_FACET_COLLAPSE

#define XML_SCHEMAS_FACET_COLLAPSE	3
+

+ +

struct xmlSchemaNotation

struct xmlSchemaNotation {
+    xmlSchemaTypeType type;	/* The kind of type */
+    xmlChar *name;
+    xmlSchemaAnnotPtr annot;
+    xmlChar *identifier;
+};
+

+ +

xmlSchemaNotationPtr

typedef xmlSchemaNotation *xmlSchemaNotationPtr;
+

+ +

XML_SCHEMAS_QUALIF_ELEM

#define XML_SCHEMAS_QUALIF_ELEM		1 << 0
+

+the shemas requires qualified elements

+ +

XML_SCHEMAS_QUALIF_ATTR

#define XML_SCHEMAS_QUALIF_ATTR		1 << 1
+

+the shemas requires qualified attributes

+ +

struct xmlSchema

struct xmlSchema {
+    xmlChar *name;        /* schema name */
+    xmlChar *targetNamespace;     /* the target namespace */
+    xmlChar *version;
+    xmlChar *id;
+    xmlDocPtr doc;
+    xmlSchemaAnnotPtr annot;
+    int flags;
+
+    xmlHashTablePtr typeDecl;
+    xmlHashTablePtr attrDecl;
+    xmlHashTablePtr attrgrpDecl;
+    xmlHashTablePtr elemDecl;
+    xmlHashTablePtr notaDecl;
+
+    xmlHashTablePtr schemasImports;
+
+    void *_private;	/* unused by the library for users or bindings */
+};
+

+ +

xmlSchemaFreeType ()

void        xmlSchemaFreeType               (xmlSchemaTypePtr type);

+Deallocate a Schema Type structure.

+ +

type : a schema type structure +
<< xmlschemastypes
diff --git a/doc/html/libxml-threads.html b/doc/html/libxml-threads.html index 417c2dd3..da95a6f2 100644 --- a/doc/html/libxml-threads.html +++ b/doc/html/libxml-threads.html @@ -1,1371 +1,133 @@ -threads
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

threads

Name

threads -- 

Synopsis


+
+threads
PrevUpHomeGnome XML Library Reference ManualNext
threads
threads — 
Synopsis
 
-struct      xmlMutex;
-typedef     xmlMutexPtr;
-struct      xmlRMutex;
-typedef     xmlRMutexPtr;
-xmlMutexPtr xmlNewMutex                     (void);
-void        xmlMutexLock                    (xmlMutexPtr tok);
-void        xmlMutexUnlock                  (xmlMutexPtr tok);
-void        xmlFreeMutex                    (xmlMutexPtr tok);
-xmlRMutexPtr xmlNewRMutex                   (void);
-void        xmlRMutexLock                   (xmlRMutexPtr tok);
-void        xmlRMutexUnlock                 (xmlRMutexPtr tok);
-void        xmlFreeRMutex                   (xmlRMutexPtr tok);
-void        xmlInitThreads                  (void);
-void        xmlLockLibrary                  (void);
-void        xmlUnlockLibrary                (void);
-int         xmlGetThreadId                  (void);
-int         xmlIsMainThread                 (void);
-void        xmlCleanupThreads               (void);
-xmlGlobalStatePtr xmlGetGlobalState         (void);

Description

Details

struct xmlMutex

struct xmlMutex;

xmlMutexPtr

struct xmlRMutex

struct xmlRMutex;

xmlRMutexPtr

xmlNewMutex ()

xmlMutexPtr xmlNewMutex                     (void);

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

Returns : 

xmlMutexLock ()

void        xmlMutexLock                    (xmlMutexPtr tok);

xmlMutexLock() is used to lock a libxml2 token.

tok : 

xmlMutexUnlock ()

void        xmlMutexUnlock                  (xmlMutexPtr tok);

xmlMutexUnlock() is used to unlock a libxml2 token.

tok : 

xmlFreeMutex ()

void        xmlFreeMutex                    (xmlMutexPtr tok);

xmlFreeMutex() is used to reclaim resources associated with a libxml2 token -struct.

tok : 

xmlNewRMutex ()

xmlRMutexPtr xmlNewRMutex                   (void);

xmlRNewMutex() is used to allocate a reentrant mutex for use in + + +struct xmlMutex; +typedef xmlMutexPtr; +struct xmlRMutex; +typedef xmlRMutexPtr; +xmlMutexPtr xmlNewMutex (void); +void xmlMutexLock (xmlMutexPtr tok); +void xmlMutexUnlock (xmlMutexPtr tok); +void xmlFreeMutex (xmlMutexPtr tok); +xmlRMutexPtr xmlNewRMutex (void); +void xmlRMutexLock (xmlRMutexPtr tok); +void xmlRMutexUnlock (xmlRMutexPtr tok); +void xmlFreeRMutex (xmlRMutexPtr tok); +void xmlInitThreads (void); +void xmlLockLibrary (void); +void xmlUnlockLibrary (void); +int xmlGetThreadId (void); +int xmlIsMainThread (void); +void xmlCleanupThreads (void); +xmlGlobalStatePtr xmlGetGlobalState (void); +

Description

+ +

Details

struct xmlMutex

struct xmlMutex;

+ +

xmlMutexPtr

typedef xmlMutex *xmlMutexPtr;
+

+ +

struct xmlRMutex

struct xmlRMutex;

+ +

xmlRMutexPtr

typedef xmlRMutex *xmlRMutexPtr;
+

+ +

xmlNewMutex ()

xmlMutexPtr xmlNewMutex                     (void);

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

+ +

Returns :a new simple mutex pointer or NULL in case of error +

xmlMutexLock ()

void        xmlMutexLock                    (xmlMutexPtr tok);

+xmlMutexLock() is used to lock a libxml2 token.

+ +

tok : the simple mutex +

xmlMutexUnlock ()

void        xmlMutexUnlock                  (xmlMutexPtr tok);

+xmlMutexUnlock() is used to unlock a libxml2 token.

+ +

tok : the simple mutex +

xmlFreeMutex ()

void        xmlFreeMutex                    (xmlMutexPtr tok);

+xmlFreeMutex() is used to reclaim resources associated with a libxml2 token +struct.

+ +

tok : the simple mutex +

xmlNewRMutex ()

xmlRMutexPtr xmlNewRMutex                   (void);

+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.

Returns : 

xmlRMutexLock ()

void        xmlRMutexLock                   (xmlRMutexPtr tok);

xmlRMutexLock() is used to lock a libxml2 token_r.

tok : 

xmlRMutexUnlock ()

void        xmlRMutexUnlock                 (xmlRMutexPtr tok);

xmlRMutexUnlock() is used to unlock a libxml2 token_r.

tok : 

xmlFreeRMutex ()

void        xmlFreeRMutex                   (xmlRMutexPtr tok);

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

tok : 

xmlInitThreads ()

void        xmlInitThreads                  (void);

xmlInitThreads() is used to to initialize all the thread related -data of the libxml2 library.

xmlLockLibrary ()

void        xmlLockLibrary                  (void);

xmlLockLibrary() is used to take out a re-entrant lock on the libxml2 -library.

xmlUnlockLibrary ()

void        xmlUnlockLibrary                (void);

xmlUnlockLibrary() is used to release a re-entrant lock on the libxml2 -library.

xmlGetThreadId ()

int         xmlGetThreadId                  (void);

xmlGetThreadId() find the current thread ID number

Returns : 

xmlIsMainThread ()

int         xmlIsMainThread                 (void);

xmlIsMainThread() check whether the current thread is the main thread.

Returns : 

xmlCleanupThreads ()

void        xmlCleanupThreads               (void);

xmlCleanupThreads() is used to to cleanup all the thread related -data of the libxml2 library once processing has ended.

xmlGetGlobalState ()

xmlGlobalStatePtr xmlGetGlobalState         (void);

xmlGetGlobalState() is called to retrieve the global state for a thread.

Returns : 

\ No newline at end of file +recursive fashion.

+ +

Returns :the new reentrant mutex pointer or NULL in case of error +

xmlRMutexLock ()

void        xmlRMutexLock                   (xmlRMutexPtr tok);

+xmlRMutexLock() is used to lock a libxml2 token_r.

+ +

tok : the reentrant mutex +

xmlRMutexUnlock ()

void        xmlRMutexUnlock                 (xmlRMutexPtr tok);

+xmlRMutexUnlock() is used to unlock a libxml2 token_r.

+ +

tok : the reentrant mutex +

xmlFreeRMutex ()

void        xmlFreeRMutex                   (xmlRMutexPtr tok);

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

+ +

tok : the reentrant mutex +

xmlInitThreads ()

void        xmlInitThreads                  (void);

+xmlInitThreads() is used to to initialize all the thread related +data of the libxml2 library.

+ +

xmlLockLibrary ()

void        xmlLockLibrary                  (void);

+xmlLockLibrary() is used to take out a re-entrant lock on the libxml2 +library.

+ +

xmlUnlockLibrary ()

void        xmlUnlockLibrary                (void);

+xmlUnlockLibrary() is used to release a re-entrant lock on the libxml2 +library.

+ +

xmlGetThreadId ()

int         xmlGetThreadId                  (void);

+xmlGetThreadId() find the current thread ID number

+ +

Returns :the current thread ID number +

xmlIsMainThread ()

int         xmlIsMainThread                 (void);

+xmlIsMainThread() check whether the current thread is the main thread.

+ +

Returns :1 if the current thread is the main thread, 0 otherwise +

xmlCleanupThreads ()

void        xmlCleanupThreads               (void);

+xmlCleanupThreads() is used to to cleanup all the thread related +data of the libxml2 library once processing has ended.

+ +

xmlGetGlobalState ()

xmlGlobalStatePtr xmlGetGlobalState         (void);

+xmlGetGlobalState() is called to retrieve the global state for a thread.

+ +

Returns :the thread global state or NULL in case of error +
<< c14nglobals >>
diff --git a/doc/html/libxml-tree.html b/doc/html/libxml-tree.html index a0fb5112..2fd6defe 100644 --- a/doc/html/libxml-tree.html +++ b/doc/html/libxml-tree.html @@ -1,2091 +1,407 @@ -tree
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

tree

Name

tree -- 

Synopsis


+
+tree
PrevUpHomeGnome XML Library Reference ManualNext
tree
tree — 
Synopsis
 
-struct      xmlParserInputBuffer;
-typedef     xmlParserInputBufferPtr;
-struct      xmlOutputBuffer;
-typedef     xmlOutputBufferPtr;
-struct      xmlParserInput;
-typedef     xmlParserInputPtr;
-struct      xmlParserCtxt;
-typedef     xmlParserCtxtPtr;
-struct      xmlSAXLocator;
-typedef     xmlSAXLocatorPtr;
-struct      xmlSAXHandler;
-typedef     xmlSAXHandlerPtr;
-struct      xmlEntity;
-typedef     xmlEntityPtr;
-#define     BASE_BUFFER_SIZE
-#define     XML_XML_NAMESPACE
-enum        xmlElementType;
-typedef     xmlChar;
-#define     BAD_CAST
-struct      xmlNotation;
-typedef     xmlNotationPtr;
-enum        xmlAttributeType;
-enum        xmlAttributeDefault;
-struct      xmlEnumeration;
-typedef     xmlEnumerationPtr;
-struct      xmlAttribute;
-typedef     xmlAttributePtr;
-enum        xmlElementContentType;
-enum        xmlElementContentOccur;
-struct      xmlElementContent;
-typedef     xmlElementContentPtr;
-enum        xmlElementTypeVal;
-struct      xmlElement;
-typedef     xmlElementPtr;
-#define     XML_LOCAL_NAMESPACE
-typedef     xmlNsType;
-struct      xmlNs;
-typedef     xmlNsPtr;
-struct      xmlDtd;
-typedef     xmlDtdPtr;
-struct      xmlAttr;
-typedef     xmlAttrPtr;
-struct      xmlID;
-typedef     xmlIDPtr;
-struct      xmlRef;
-typedef     xmlRefPtr;
-enum        xmlBufferAllocationScheme;
-struct      xmlBuffer;
-typedef     xmlBufferPtr;
-struct      xmlNode;
-typedef     xmlNodePtr;
-#define     XML_GET_CONTENT                 (n)
-#define     XML_GET_LINE                    (n)
-struct      xmlDoc;
-typedef     xmlDocPtr;
-#define     xmlChildrenNode
-#define     xmlRootNode
-int         xmlValidateNCName               (const xmlChar *value,
+
+
+struct      xmlParserInputBuffer;
+typedef     xmlParserInputBufferPtr;
+struct      xmlOutputBuffer;
+typedef     xmlOutputBufferPtr;
+struct      xmlParserInput;
+typedef     xmlParserInputPtr;
+struct      xmlParserCtxt;
+typedef     xmlParserCtxtPtr;
+struct      xmlSAXLocator;
+typedef     xmlSAXLocatorPtr;
+struct      xmlSAXHandler;
+typedef     xmlSAXHandlerPtr;
+struct      xmlEntity;
+typedef     xmlEntityPtr;
+#define     BASE_BUFFER_SIZE
+#define     XML_XML_NAMESPACE
+enum        xmlElementType;
+typedef     xmlChar;
+#define     BAD_CAST
+struct      xmlNotation;
+typedef     xmlNotationPtr;
+enum        xmlAttributeType;
+enum        xmlAttributeDefault;
+struct      xmlEnumeration;
+typedef     xmlEnumerationPtr;
+struct      xmlAttribute;
+typedef     xmlAttributePtr;
+enum        xmlElementContentType;
+enum        xmlElementContentOccur;
+struct      xmlElementContent;
+typedef     xmlElementContentPtr;
+enum        xmlElementTypeVal;
+struct      xmlElement;
+typedef     xmlElementPtr;
+#define     XML_LOCAL_NAMESPACE
+typedef     xmlNsType;
+struct      xmlNs;
+typedef     xmlNsPtr;
+struct      xmlDtd;
+typedef     xmlDtdPtr;
+struct      xmlAttr;
+typedef     xmlAttrPtr;
+struct      xmlID;
+typedef     xmlIDPtr;
+struct      xmlRef;
+typedef     xmlRefPtr;
+enum        xmlBufferAllocationScheme;
+struct      xmlBuffer;
+typedef     xmlBufferPtr;
+struct      xmlNode;
+typedef     xmlNodePtr;
+#define     XML_GET_CONTENT                 (n)
+#define     XML_GET_LINE                    (n)
+struct      xmlDoc;
+typedef     xmlDocPtr;
+#define     xmlChildrenNode
+#define     xmlRootNode
+int         xmlValidateNCName               (const xmlChar *value,
                                              int space);
-int         xmlValidateQName                (const xmlChar *value,
+int         xmlValidateQName                (const xmlChar *value,
                                              int space);
-int         xmlValidateName                 (const xmlChar *value,
+int         xmlValidateName                 (const xmlChar *value,
                                              int space);
-int         xmlValidateNMToken              (const xmlChar *value,
+int         xmlValidateNMToken              (const xmlChar *value,
                                              int space);
-void        xmlSetBufferAllocationScheme    (xmlBufferAllocationScheme scheme);
-xmlBufferAllocationScheme xmlGetBufferAllocationScheme
+xmlChar*    xmlBuildQName                   (const xmlChar *ncname,
+                                             const xmlChar *prefix,
+                                             xmlChar *memory,
+                                             int len);
+xmlChar*    xmlSplitQName2                  (const xmlChar *name,
+                                             xmlChar **prefix);
+void        xmlSetBufferAllocationScheme    (xmlBufferAllocationScheme scheme);
+xmlBufferAllocationScheme xmlGetBufferAllocationScheme
                                             (void);
-xmlBufferPtr xmlBufferCreate                (void);
-xmlBufferPtr xmlBufferCreateSize            (size_t size);
-int         xmlBufferResize                 (xmlBufferPtr buf,
+xmlBufferPtr xmlBufferCreate                (void);
+xmlBufferPtr xmlBufferCreateSize            (size_t size);
+int         xmlBufferResize                 (xmlBufferPtr buf,
                                              unsigned int size);
-void        xmlBufferFree                   (xmlBufferPtr buf);
-int         xmlBufferDump                   (FILE *file,
-                                             xmlBufferPtr buf);
-void        xmlBufferAdd                    (xmlBufferPtr buf,
-                                             const xmlChar *str,
+void        xmlBufferFree                   (xmlBufferPtr buf);
+int         xmlBufferDump                   (FILE *file,
+                                             xmlBufferPtr buf);
+void        xmlBufferAdd                    (xmlBufferPtr buf,
+                                             const xmlChar *str,
                                              int len);
-void        xmlBufferAddHead                (xmlBufferPtr buf,
-                                             const xmlChar *str,
+void        xmlBufferAddHead                (xmlBufferPtr buf,
+                                             const xmlChar *str,
                                              int len);
-void        xmlBufferCat                    (xmlBufferPtr buf,
-                                             const xmlChar *str);
-void        xmlBufferCCat                   (xmlBufferPtr buf,
+void        xmlBufferCat                    (xmlBufferPtr buf,
+                                             const xmlChar *str);
+void        xmlBufferCCat                   (xmlBufferPtr buf,
                                              const char *str);
-int         xmlBufferShrink                 (xmlBufferPtr buf,
+int         xmlBufferShrink                 (xmlBufferPtr buf,
                                              unsigned int len);
-int         xmlBufferGrow                   (xmlBufferPtr buf,
+int         xmlBufferGrow                   (xmlBufferPtr buf,
                                              unsigned int len);
-void        xmlBufferEmpty                  (xmlBufferPtr buf);
-const xmlChar* xmlBufferContent             (const xmlBufferPtr buf);
-void        xmlBufferSetAllocationScheme    (xmlBufferPtr buf,
-                                             xmlBufferAllocationScheme scheme);
-int         xmlBufferLength                 (const xmlBufferPtr buf);
-xmlDtdPtr   xmlCreateIntSubset              (xmlDocPtr doc,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
-xmlDtdPtr   xmlNewDtd                       (xmlDocPtr doc,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
-xmlDtdPtr   xmlGetIntSubset                 (xmlDocPtr doc);
-void        xmlFreeDtd                      (xmlDtdPtr cur);
-xmlNsPtr    xmlNewGlobalNs                  (xmlDocPtr doc,
-                                             const xmlChar *href,
-                                             const xmlChar *prefix);
-xmlNsPtr    xmlNewNs                        (xmlNodePtr node,
-                                             const xmlChar *href,
-                                             const xmlChar *prefix);
-void        xmlFreeNs                       (xmlNsPtr cur);
-void        xmlFreeNsList                   (xmlNsPtr cur);
-xmlDocPtr   xmlNewDoc                       (const xmlChar *version);
-void        xmlFreeDoc                      (xmlDocPtr cur);
-xmlAttrPtr  xmlNewDocProp                   (xmlDocPtr doc,
-                                             const xmlChar *name,
-                                             const xmlChar *value);
-xmlAttrPtr  xmlNewProp                      (xmlNodePtr node,
-                                             const xmlChar *name,
-                                             const xmlChar *value);
-xmlAttrPtr  xmlNewNsProp                    (xmlNodePtr node,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *value);
-xmlAttrPtr  xmlNewNsPropEatName             (xmlNodePtr node,
-                                             xmlNsPtr ns,
-                                             xmlChar *name,
-                                             const xmlChar *value);
-void        xmlFreePropList                 (xmlAttrPtr cur);
-void        xmlFreeProp                     (xmlAttrPtr cur);
-xmlAttrPtr  xmlCopyProp                     (xmlNodePtr target,
-                                             xmlAttrPtr cur);
-xmlAttrPtr  xmlCopyPropList                 (xmlNodePtr target,
-                                             xmlAttrPtr cur);
-xmlDtdPtr   xmlCopyDtd                      (xmlDtdPtr dtd);
-xmlDocPtr   xmlCopyDoc                      (xmlDocPtr doc,
+void        xmlBufferEmpty                  (xmlBufferPtr buf);
+const xmlChar* xmlBufferContent             (const xmlBufferPtr buf);
+void        xmlBufferSetAllocationScheme    (xmlBufferPtr buf,
+                                             xmlBufferAllocationScheme scheme);
+int         xmlBufferLength                 (const xmlBufferPtr buf);
+xmlDtdPtr   xmlCreateIntSubset              (xmlDocPtr doc,
+                                             const xmlChar *name,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);
+xmlDtdPtr   xmlNewDtd                       (xmlDocPtr doc,
+                                             const xmlChar *name,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);
+xmlDtdPtr   xmlGetIntSubset                 (xmlDocPtr doc);
+void        xmlFreeDtd                      (xmlDtdPtr cur);
+xmlNsPtr    xmlNewGlobalNs                  (xmlDocPtr doc,
+                                             const xmlChar *href,
+                                             const xmlChar *prefix);
+xmlNsPtr    xmlNewNs                        (xmlNodePtr node,
+                                             const xmlChar *href,
+                                             const xmlChar *prefix);
+void        xmlFreeNs                       (xmlNsPtr cur);
+void        xmlFreeNsList                   (xmlNsPtr cur);
+xmlDocPtr   xmlNewDoc                       (const xmlChar *version);
+void        xmlFreeDoc                      (xmlDocPtr cur);
+xmlAttrPtr  xmlNewDocProp                   (xmlDocPtr doc,
+                                             const xmlChar *name,
+                                             const xmlChar *value);
+xmlAttrPtr  xmlNewProp                      (xmlNodePtr node,
+                                             const xmlChar *name,
+                                             const xmlChar *value);
+xmlAttrPtr  xmlNewNsProp                    (xmlNodePtr node,
+                                             xmlNsPtr ns,
+                                             const xmlChar *name,
+                                             const xmlChar *value);
+xmlAttrPtr  xmlNewNsPropEatName             (xmlNodePtr node,
+                                             xmlNsPtr ns,
+                                             xmlChar *name,
+                                             const xmlChar *value);
+void        xmlFreePropList                 (xmlAttrPtr cur);
+void        xmlFreeProp                     (xmlAttrPtr cur);
+xmlAttrPtr  xmlCopyProp                     (xmlNodePtr target,
+                                             xmlAttrPtr cur);
+xmlAttrPtr  xmlCopyPropList                 (xmlNodePtr target,
+                                             xmlAttrPtr cur);
+xmlDtdPtr   xmlCopyDtd                      (xmlDtdPtr dtd);
+xmlDocPtr   xmlCopyDoc                      (xmlDocPtr doc,
                                              int recursive);
-xmlNodePtr  xmlNewDocNode                   (xmlDocPtr doc,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *content);
-xmlNodePtr  xmlNewDocNodeEatName            (xmlDocPtr doc,
-                                             xmlNsPtr ns,
-                                             xmlChar *name,
-                                             const xmlChar *content);
-xmlNodePtr  xmlNewDocRawNode                (xmlDocPtr doc,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *content);
-xmlNodePtr  xmlNewNode                      (xmlNsPtr ns,
-                                             const xmlChar *name);
-xmlNodePtr  xmlNewNodeEatName               (xmlNsPtr ns,
-                                             xmlChar *name);
-xmlNodePtr  xmlNewChild                     (xmlNodePtr parent,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *content);
-xmlNodePtr  xmlNewTextChild                 (xmlNodePtr parent,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *content);
-xmlNodePtr  xmlNewDocText                   (xmlDocPtr doc,
-                                             const xmlChar *content);
-xmlNodePtr  xmlNewText                      (const xmlChar *content);
-xmlNodePtr  xmlNewPI                        (const xmlChar *name,
-                                             const xmlChar *content);
-xmlNodePtr  xmlNewDocTextLen                (xmlDocPtr doc,
-                                             const xmlChar *content,
+xmlNodePtr  xmlNewDocNode                   (xmlDocPtr doc,
+                                             xmlNsPtr ns,
+                                             const xmlChar *name,
+                                             const xmlChar *content);
+xmlNodePtr  xmlNewDocNodeEatName            (xmlDocPtr doc,
+                                             xmlNsPtr ns,
+                                             xmlChar *name,
+                                             const xmlChar *content);
+xmlNodePtr  xmlNewDocRawNode                (xmlDocPtr doc,
+                                             xmlNsPtr ns,
+                                             const xmlChar *name,
+                                             const xmlChar *content);
+xmlNodePtr  xmlNewNode                      (xmlNsPtr ns,
+                                             const xmlChar *name);
+xmlNodePtr  xmlNewNodeEatName               (xmlNsPtr ns,
+                                             xmlChar *name);
+xmlNodePtr  xmlNewChild                     (xmlNodePtr parent,
+                                             xmlNsPtr ns,
+                                             const xmlChar *name,
+                                             const xmlChar *content);
+xmlNodePtr  xmlNewTextChild                 (xmlNodePtr parent,
+                                             xmlNsPtr ns,
+                                             const xmlChar *name,
+                                             const xmlChar *content);
+xmlNodePtr  xmlNewDocText                   (xmlDocPtr doc,
+                                             const xmlChar *content);
+xmlNodePtr  xmlNewText                      (const xmlChar *content);
+xmlNodePtr  xmlNewPI                        (const xmlChar *name,
+                                             const xmlChar *content);
+xmlNodePtr  xmlNewDocTextLen                (xmlDocPtr doc,
+                                             const xmlChar *content,
                                              int len);
-xmlNodePtr  xmlNewTextLen                   (const xmlChar *content,
+xmlNodePtr  xmlNewTextLen                   (const xmlChar *content,
                                              int len);
-xmlNodePtr  xmlNewDocComment                (xmlDocPtr doc,
-                                             const xmlChar *content);
-xmlNodePtr  xmlNewComment                   (const xmlChar *content);
-xmlNodePtr  xmlNewCDataBlock                (xmlDocPtr doc,
-                                             const xmlChar *content,
+xmlNodePtr  xmlNewDocComment                (xmlDocPtr doc,
+                                             const xmlChar *content);
+xmlNodePtr  xmlNewComment                   (const xmlChar *content);
+xmlNodePtr  xmlNewCDataBlock                (xmlDocPtr doc,
+                                             const xmlChar *content,
                                              int len);
-xmlNodePtr  xmlNewCharRef                   (xmlDocPtr doc,
-                                             const xmlChar *name);
-xmlNodePtr  xmlNewReference                 (xmlDocPtr doc,
-                                             const xmlChar *name);
-xmlNodePtr  xmlCopyNode                     (const xmlNodePtr node,
+xmlNodePtr  xmlNewCharRef                   (xmlDocPtr doc,
+                                             const xmlChar *name);
+xmlNodePtr  xmlNewReference                 (xmlDocPtr doc,
+                                             const xmlChar *name);
+xmlNodePtr  xmlCopyNode                     (const xmlNodePtr node,
                                              int recursive);
-xmlNodePtr  xmlDocCopyNode                  (const xmlNodePtr node,
-                                             xmlDocPtr doc,
+xmlNodePtr  xmlDocCopyNode                  (const xmlNodePtr node,
+                                             xmlDocPtr doc,
                                              int recursive);
-xmlNodePtr  xmlCopyNodeList                 (const xmlNodePtr node);
-xmlNodePtr  xmlNewDocFragment               (xmlDocPtr doc);
-long        xmlGetLineNo                    (xmlNodePtr node);
-xmlChar*    xmlGetNodePath                  (xmlNodePtr node);
-xmlNodePtr  xmlDocGetRootElement            (xmlDocPtr doc);
-xmlNodePtr  xmlGetLastChild                 (xmlNodePtr parent);
-int         xmlNodeIsText                   (xmlNodePtr node);
-int         xmlIsBlankNode                  (xmlNodePtr node);
-xmlNodePtr  xmlDocSetRootElement            (xmlDocPtr doc,
-                                             xmlNodePtr root);
-void        xmlNodeSetName                  (xmlNodePtr cur,
-                                             const xmlChar *name);
-xmlNodePtr  xmlAddChild                     (xmlNodePtr parent,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlAddChildList                 (xmlNodePtr parent,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlReplaceNode                  (xmlNodePtr old,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlAddSibling                   (xmlNodePtr cur,
-                                             xmlNodePtr elem);
-xmlNodePtr  xmlAddPrevSibling               (xmlNodePtr cur,
-                                             xmlNodePtr elem);
-xmlNodePtr  xmlAddNextSibling               (xmlNodePtr cur,
-                                             xmlNodePtr elem);
-void        xmlUnlinkNode                   (xmlNodePtr cur);
-xmlNodePtr  xmlTextMerge                    (xmlNodePtr first,
-                                             xmlNodePtr second);
-void        xmlTextConcat                   (xmlNodePtr node,
-                                             const xmlChar *content,
+xmlNodePtr  xmlCopyNodeList                 (const xmlNodePtr node);
+xmlNodePtr  xmlNewDocFragment               (xmlDocPtr doc);
+long        xmlGetLineNo                    (xmlNodePtr node);
+xmlChar*    xmlGetNodePath                  (xmlNodePtr node);
+xmlNodePtr  xmlDocGetRootElement            (xmlDocPtr doc);
+xmlNodePtr  xmlGetLastChild                 (xmlNodePtr parent);
+int         xmlNodeIsText                   (xmlNodePtr node);
+int         xmlIsBlankNode                  (xmlNodePtr node);
+xmlNodePtr  xmlDocSetRootElement            (xmlDocPtr doc,
+                                             xmlNodePtr root);
+void        xmlNodeSetName                  (xmlNodePtr cur,
+                                             const xmlChar *name);
+xmlNodePtr  xmlAddChild                     (xmlNodePtr parent,
+                                             xmlNodePtr cur);
+xmlNodePtr  xmlAddChildList                 (xmlNodePtr parent,
+                                             xmlNodePtr cur);
+xmlNodePtr  xmlReplaceNode                  (xmlNodePtr old,
+                                             xmlNodePtr cur);
+xmlNodePtr  xmlAddSibling                   (xmlNodePtr cur,
+                                             xmlNodePtr elem);
+xmlNodePtr  xmlAddPrevSibling               (xmlNodePtr cur,
+                                             xmlNodePtr elem);
+xmlNodePtr  xmlAddNextSibling               (xmlNodePtr cur,
+                                             xmlNodePtr elem);
+void        xmlUnlinkNode                   (xmlNodePtr cur);
+xmlNodePtr  xmlTextMerge                    (xmlNodePtr first,
+                                             xmlNodePtr second);
+int         xmlTextConcat                   (xmlNodePtr node,
+                                             const xmlChar *content,
                                              int len);
-void        xmlFreeNodeList                 (xmlNodePtr cur);
-void        xmlFreeNode                     (xmlNodePtr cur);
-void        xmlSetTreeDoc                   (xmlNodePtr tree,
-                                             xmlDocPtr doc);
-void        xmlSetListDoc                   (xmlNodePtr list,
-                                             xmlDocPtr doc);
-xmlNsPtr    xmlSearchNs                     (xmlDocPtr doc,
-                                             xmlNodePtr node,
-                                             const xmlChar *nameSpace);
-xmlNsPtr    xmlSearchNsByHref               (xmlDocPtr doc,
-                                             xmlNodePtr node,
-                                             const xmlChar *href);
-xmlNsPtr*   xmlGetNsList                    (xmlDocPtr doc,
-                                             xmlNodePtr node);
-void        xmlSetNs                        (xmlNodePtr node,
-                                             xmlNsPtr ns);
-xmlNsPtr    xmlCopyNamespace                (xmlNsPtr cur);
-xmlNsPtr    xmlCopyNamespaceList            (xmlNsPtr cur);
-xmlAttrPtr  xmlSetProp                      (xmlNodePtr node,
-                                             const xmlChar *name,
-                                             const xmlChar *value);
-xmlChar*    xmlGetProp                      (xmlNodePtr node,
-                                             const xmlChar *name);
-xmlChar*    xmlGetNoNsProp                  (xmlNodePtr node,
-                                             const xmlChar *name);
-xmlAttrPtr  xmlHasProp                      (xmlNodePtr node,
-                                             const xmlChar *name);
-xmlAttrPtr  xmlHasNsProp                    (xmlNodePtr node,
-                                             const xmlChar *name,
-                                             const xmlChar *nameSpace);
-xmlAttrPtr  xmlSetNsProp                    (xmlNodePtr node,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *value);
-xmlChar*    xmlGetNsProp                    (xmlNodePtr node,
-                                             const xmlChar *name,
-                                             const xmlChar *nameSpace);
-xmlNodePtr  xmlStringGetNodeList            (xmlDocPtr doc,
-                                             const xmlChar *value);
-xmlNodePtr  xmlStringLenGetNodeList         (xmlDocPtr doc,
-                                             const xmlChar *value,
+void        xmlFreeNodeList                 (xmlNodePtr cur);
+void        xmlFreeNode                     (xmlNodePtr cur);
+void        xmlSetTreeDoc                   (xmlNodePtr tree,
+                                             xmlDocPtr doc);
+void        xmlSetListDoc                   (xmlNodePtr list,
+                                             xmlDocPtr doc);
+xmlNsPtr    xmlSearchNs                     (xmlDocPtr doc,
+                                             xmlNodePtr node,
+                                             const xmlChar *nameSpace);
+xmlNsPtr    xmlSearchNsByHref               (xmlDocPtr doc,
+                                             xmlNodePtr node,
+                                             const xmlChar *href);
+xmlNsPtr*   xmlGetNsList                    (xmlDocPtr doc,
+                                             xmlNodePtr node);
+void        xmlSetNs                        (xmlNodePtr node,
+                                             xmlNsPtr ns);
+xmlNsPtr    xmlCopyNamespace                (xmlNsPtr cur);
+xmlNsPtr    xmlCopyNamespaceList            (xmlNsPtr cur);
+xmlAttrPtr  xmlSetProp                      (xmlNodePtr node,
+                                             const xmlChar *name,
+                                             const xmlChar *value);
+xmlChar*    xmlGetProp                      (xmlNodePtr node,
+                                             const xmlChar *name);
+xmlChar*    xmlGetNoNsProp                  (xmlNodePtr node,
+                                             const xmlChar *name);
+xmlAttrPtr  xmlHasProp                      (xmlNodePtr node,
+                                             const xmlChar *name);
+xmlAttrPtr  xmlHasNsProp                    (xmlNodePtr node,
+                                             const xmlChar *name,
+                                             const xmlChar *nameSpace);
+xmlAttrPtr  xmlSetNsProp                    (xmlNodePtr node,
+                                             xmlNsPtr ns,
+                                             const xmlChar *name,
+                                             const xmlChar *value);
+xmlChar*    xmlGetNsProp                    (xmlNodePtr node,
+                                             const xmlChar *name,
+                                             const xmlChar *nameSpace);
+xmlNodePtr  xmlStringGetNodeList            (xmlDocPtr doc,
+                                             const xmlChar *value);
+xmlNodePtr  xmlStringLenGetNodeList         (xmlDocPtr doc,
+                                             const xmlChar *value,
                                              int len);
-xmlChar*    xmlNodeListGetString            (xmlDocPtr doc,
-                                             xmlNodePtr list,
+xmlChar*    xmlNodeListGetString            (xmlDocPtr doc,
+                                             xmlNodePtr list,
                                              int inLine);
-xmlChar*    xmlNodeListGetRawString         (xmlDocPtr doc,
-                                             xmlNodePtr list,
+xmlChar*    xmlNodeListGetRawString         (xmlDocPtr doc,
+                                             xmlNodePtr list,
                                              int inLine);
-void        xmlNodeSetContent               (xmlNodePtr cur,
-                                             const xmlChar *content);
-void        xmlNodeSetContentLen            (xmlNodePtr cur,
-                                             const xmlChar *content,
+void        xmlNodeSetContent               (xmlNodePtr cur,
+                                             const xmlChar *content);
+void        xmlNodeSetContentLen            (xmlNodePtr cur,
+                                             const xmlChar *content,
                                              int len);
-void        xmlNodeAddContent               (xmlNodePtr cur,
-                                             const xmlChar *content);
-void        xmlNodeAddContentLen            (xmlNodePtr cur,
-                                             const xmlChar *content,
+void        xmlNodeAddContent               (xmlNodePtr cur,
+                                             const xmlChar *content);
+void        xmlNodeAddContentLen            (xmlNodePtr cur,
+                                             const xmlChar *content,
                                              int len);
-xmlChar*    xmlNodeGetContent               (xmlNodePtr cur);
-xmlChar*    xmlNodeGetLang                  (xmlNodePtr cur);
-void        xmlNodeSetLang                  (xmlNodePtr cur,
-                                             const xmlChar *lang);
-int         xmlNodeGetSpacePreserve         (xmlNodePtr cur);
-void        xmlNodeSetSpacePreserve         (xmlNodePtr cur,
+xmlChar*    xmlNodeGetContent               (xmlNodePtr cur);
+xmlChar*    xmlNodeGetLang                  (xmlNodePtr cur);
+void        xmlNodeSetLang                  (xmlNodePtr cur,
+                                             const xmlChar *lang);
+int         xmlNodeGetSpacePreserve         (xmlNodePtr cur);
+void        xmlNodeSetSpacePreserve         (xmlNodePtr cur,
                                              int val);
-xmlChar*    xmlNodeGetBase                  (xmlDocPtr doc,
-                                             xmlNodePtr cur);
-void        xmlNodeSetBase                  (xmlNodePtr cur,
-                                             xmlChar *uri);
-int         xmlRemoveProp                   (xmlAttrPtr cur);
-int         xmlUnsetProp                    (xmlNodePtr node,
-                                             const xmlChar *name);
-int         xmlUnsetNsProp                  (xmlNodePtr node,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name);
-void        xmlBufferWriteCHAR              (xmlBufferPtr buf,
-                                             const xmlChar *string);
-void        xmlBufferWriteChar              (xmlBufferPtr buf,
+xmlChar*    xmlNodeGetBase                  (xmlDocPtr doc,
+                                             xmlNodePtr cur);
+void        xmlNodeSetBase                  (xmlNodePtr cur,
+                                             xmlChar *uri);
+int         xmlRemoveProp                   (xmlAttrPtr cur);
+int         xmlUnsetProp                    (xmlNodePtr node,
+                                             const xmlChar *name);
+int         xmlUnsetNsProp                  (xmlNodePtr node,
+                                             xmlNsPtr ns,
+                                             const xmlChar *name);
+void        xmlBufferWriteCHAR              (xmlBufferPtr buf,
+                                             const xmlChar *string);
+void        xmlBufferWriteChar              (xmlBufferPtr buf,
                                              const char *string);
-void        xmlBufferWriteQuotedString      (xmlBufferPtr buf,
-                                             const xmlChar *string);
-int         xmlReconciliateNs               (xmlDocPtr doc,
-                                             xmlNodePtr tree);
-void        xmlDocDumpFormatMemory          (xmlDocPtr cur,
-                                             xmlChar **mem,
+void        xmlBufferWriteQuotedString      (xmlBufferPtr buf,
+                                             const xmlChar *string);
+int         xmlReconciliateNs               (xmlDocPtr doc,
+                                             xmlNodePtr tree);
+void        xmlDocDumpFormatMemory          (xmlDocPtr cur,
+                                             xmlChar **mem,
                                              int *size,
                                              int format);
-void        xmlDocDumpMemory                (xmlDocPtr cur,
-                                             xmlChar **mem,
+void        xmlDocDumpMemory                (xmlDocPtr cur,
+                                             xmlChar **mem,
                                              int *size);
-void        xmlDocDumpMemoryEnc             (xmlDocPtr out_doc,
-                                             xmlChar **doc_txt_ptr,
+void        xmlDocDumpMemoryEnc             (xmlDocPtr out_doc,
+                                             xmlChar **doc_txt_ptr,
                                              int *doc_txt_len,
                                              const char *txt_encoding);
-void        xmlDocDumpFormatMemoryEnc       (xmlDocPtr out_doc,
-                                             xmlChar **doc_txt_ptr,
+void        xmlDocDumpFormatMemoryEnc       (xmlDocPtr out_doc,
+                                             xmlChar **doc_txt_ptr,
                                              int *doc_txt_len,
                                              const char *txt_encoding,
                                              int format);
-int         xmlDocFormatDump                (FILE *f,
-                                             xmlDocPtr cur,
+int         xmlDocFormatDump                (FILE *f,
+                                             xmlDocPtr cur,
                                              int format);
-int         xmlDocDump                      (FILE *f,
-                                             xmlDocPtr cur);
-void        xmlElemDump                     (FILE *f,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur);
-int         xmlSaveFile                     (const char *filename,
-                                             xmlDocPtr cur);
-int         xmlSaveFormatFile               (const char *filename,
-                                             xmlDocPtr cur,
+int         xmlDocDump                      (FILE *f,
+                                             xmlDocPtr cur);
+void        xmlElemDump                     (FILE *f,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr cur);
+int         xmlSaveFile                     (const char *filename,
+                                             xmlDocPtr cur);
+int         xmlSaveFormatFile               (const char *filename,
+                                             xmlDocPtr cur,
                                              int format);
-int         xmlNodeDump                     (xmlBufferPtr buf,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur,
+int         xmlNodeDump                     (xmlBufferPtr buf,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr cur,
                                              int level,
                                              int format);
-int         xmlSaveFileTo                   (xmlOutputBufferPtr buf,
-                                             xmlDocPtr cur,
+int         xmlSaveFileTo                   (xmlOutputBufferPtr buf,
+                                             xmlDocPtr cur,
                                              const char *encoding);
-int         xmlSaveFormatFileTo             (xmlOutputBufferPtr buf,
-                                             xmlDocPtr cur,
+int         xmlSaveFormatFileTo             (xmlOutputBufferPtr buf,
+                                             xmlDocPtr cur,
                                              const char *encoding,
                                              int format);
-void        xmlNodeDumpOutput               (xmlOutputBufferPtr buf,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur,
+void        xmlNodeDumpOutput               (xmlOutputBufferPtr buf,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr cur,
                                              int level,
                                              int format,
                                              const char *encoding);
-int         xmlSaveFormatFileEnc            (const char *filename,
-                                             xmlDocPtr cur,
+int         xmlSaveFormatFileEnc            (const char *filename,
+                                             xmlDocPtr cur,
                                              const char *encoding,
                                              int format);
-int         xmlSaveFileEnc                  (const char *filename,
-                                             xmlDocPtr cur,
+int         xmlSaveFileEnc                  (const char *filename,
+                                             xmlDocPtr cur,
                                              const char *encoding);
-int         xmlIsXHTML                      (const xmlChar *systemID,
-                                             const xmlChar *publicID);
-int         xmlGetDocCompressMode           (xmlDocPtr doc);
-void        xmlSetDocCompressMode           (xmlDocPtr doc,
+int         xmlIsXHTML                      (const xmlChar *systemID,
+                                             const xmlChar *publicID);
+int         xmlGetDocCompressMode           (xmlDocPtr doc);
+void        xmlSetDocCompressMode           (xmlDocPtr doc,
                                              int mode);
-int         xmlGetCompressMode              (void);
-void        xmlSetCompressMode              (int mode);

Description

Details

struct xmlParserInputBuffer

struct xmlParserInputBuffer {
+int         xmlGetCompressMode              (void);
+void        xmlSetCompressMode              (int mode);
+

Description

+ +

Details

struct xmlParserInputBuffer

struct xmlParserInputBuffer {
     void*                  context;
     xmlInputReadCallback   readcallback;
     xmlInputCloseCallback  closecallback;
@@ -2094,46 +410,13 @@ CLASS="PROGRAMLISTING"
     
     xmlBufferPtr buffer;    /* Local buffer encoded in UTF-8 */
     xmlBufferPtr raw;       /* if encoder != NULL buffer for raw input */
-};

xmlParserInputBufferPtr

struct xmlOutputBuffer

struct xmlOutputBuffer {
+};
+

+ +

xmlParserInputBufferPtr

typedef xmlParserInputBuffer *xmlParserInputBufferPtr;
+

+ +

struct xmlOutputBuffer

struct xmlOutputBuffer {
     void*                   context;
     xmlOutputWriteCallback  writecallback;
     xmlOutputCloseCallback  closecallback;
@@ -2143,46 +426,13 @@ CLASS="PROGRAMLISTING"
     xmlBufferPtr buffer;    /* Local buffer encoded in UTF-8 or ISOLatin */
     xmlBufferPtr conv;      /* if encoder != NULL buffer for output */
     int written;            /* total number of byte written */
-};

xmlOutputBufferPtr

struct xmlParserInput

struct xmlParserInput {
+};
+

+ +

xmlOutputBufferPtr

typedef xmlOutputBuffer *xmlOutputBufferPtr;
+

+ +

struct xmlParserInput

struct xmlParserInput {
     /* Input buffer */
     xmlParserInputBufferPtr buf;      /* UTF-8 encoded buffer */
 
@@ -2194,58 +444,29 @@ CLASS="PROGRAMLISTING"
     int length;                       /* length if known */
     int line;                         /* Current line */
     int col;                          /* Current column */
-    int consumed;                     /* How many xmlChars already consumed */
+    /*
+     * NOTE: consumed is only tested for equality in the parser code,
+     *       so even if there is an overflow this should not give troubles
+     *       for parsing very large instances.
+     */
+    unsigned long consumed;           /* How many xmlChars already consumed */
     xmlParserInputDeallocate free;    /* function to deallocate the base */
     const xmlChar *encoding;          /* the encoding string for entity */
     const xmlChar *version;           /* the version string for entity */
     int standalone;                   /* Was that entity marked standalone */
-};

An xmlParserInput is an input flow for the XML processor. +}; +

+An xmlParserInput is an input flow for the XML processor. Each entity parsed is associated an xmlParserInput (except the few predefined ones). This is the case both for internal entities - in which case the flow is already completely in memory - or external entities - in which case we use the buf structure for -progressive reading and I18N conversions to the internal UTF-8 format.

xmlParserInputPtr

struct xmlParserCtxt

struct xmlParserCtxt {
+progressive reading and I18N conversions to the internal UTF-8 format.

+
+
xmlParserInputPtr
typedef xmlParserInput *xmlParserInputPtr;
+

+
+
struct xmlParserCtxt
struct xmlParserCtxt {
     struct _xmlSAXHandler *sax;       /* The SAX handler */
     void            *userData;        /* For SAX interface only, used by DOM build */
     xmlDocPtr           myDoc;        /* the document being built */
@@ -2320,101 +541,34 @@ CLASS="PROGRAMLISTING"
     int                linenumbers;   /* set line number in element content */
     void              *catalogs;       /* document's own catalog */
     int                recovery;      /* run in recovery mode */
-};

The parser context. + int progressive; /* is this a progressive parsing */ +}; +

+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.

xmlParserCtxtPtr

struct xmlSAXLocator

struct xmlSAXLocator {
+     to a state based parser for progressive parsing shouldn't be too hard.

+
+
xmlParserCtxtPtr
typedef xmlParserCtxt *xmlParserCtxtPtr;
+

+
+
struct xmlSAXLocator
struct xmlSAXLocator {
     const xmlChar *(*getPublicId)(void *ctx);
     const xmlChar *(*getSystemId)(void *ctx);
     int (*getLineNumber)(void *ctx);
     int (*getColumnNumber)(void *ctx);
-};

A SAX Locator.

xmlSAXLocatorPtr

struct xmlSAXHandler

struct xmlSAXHandler {
+};
+

+A SAX Locator.

+ +

xmlSAXLocatorPtr

typedef xmlSAXLocator *xmlSAXLocatorPtr;
+

+ +

struct xmlSAXHandler

struct xmlSAXHandler {
     internalSubsetSAXFunc internalSubset;
     isStandaloneSAXFunc isStandalone;
     hasInternalSubsetSAXFunc hasInternalSubset;
@@ -2443,49 +597,15 @@ CLASS="PROGRAMLISTING"
     cdataBlockSAXFunc cdataBlock;
     externalSubsetSAXFunc externalSubset;
     int initialized;
-};

A SAX handler is bunch of callbacks called by the parser when processing -of the input generate data or structure informations.

xmlSAXHandlerPtr

struct xmlEntity

struct xmlEntity {
+};
+

+A SAX handler is bunch of callbacks called by the parser when processing +of the input generate data or structure informations.

+ +

xmlSAXHandlerPtr

typedef xmlSAXHandler *xmlSAXHandlerPtr;
+

+ +

struct xmlEntity

struct xmlEntity {
     void           *_private;	        /* application data */
     xmlElementType          type;       /* XML_ENTITY_DECL, must be second ! */
     const xmlChar          *name;	/* Entity name */
@@ -2506,103 +626,21 @@ CLASS="PROGRAMLISTING"
     struct _xmlEntity     *nexte;	/* unused */
     const xmlChar           *URI;	/* the full URI as computed */
     int                    owner;	/* does the entity own the childrens */
-};

xmlEntityPtr

BASE_BUFFER_SIZE

#define     BASE_BUFFER_SIZE

default buffer size 4000.

XML_XML_NAMESPACE

#define     XML_XML_NAMESPACE

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

enum xmlElementType

typedef enum {
+};
+

+ +

xmlEntityPtr

typedef xmlEntity *xmlEntityPtr;
+

+ +

BASE_BUFFER_SIZE

#define BASE_BUFFER_SIZE 4000
+

+default buffer size 4000.

+ +

XML_XML_NAMESPACE

#define     XML_XML_NAMESPACE

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

+ +

enum xmlElementType

typedef enum {
     XML_ELEMENT_NODE=		1,
     XML_ATTRIBUTE_NODE=		2,
     XML_TEXT_NODE=		3,
@@ -2626,123 +664,31 @@ CLASS="PROGRAMLISTING"
 #ifdef LIBXML_DOCB_ENABLED
    ,XML_DOCB_DOCUMENT_NODE=	21
 #endif
-} xmlElementType;

xmlChar

This is a basic byte in an UTF-8 encoded string. +} xmlElementType; +

+ +

xmlChar

typedef unsigned char xmlChar;
+

+This is a basic byte in an UTF-8 encoded string. It's unsigned allowing to pinpoint case where char * are assigned -to xmlChar * (possibly making serialization back impossible).

BAD_CAST

#define     BAD_CAST

Macro to cast a string to an xmlChar * when one know its safe.

struct xmlNotation

struct xmlNotation {
+to xmlChar * (possibly making serialization back impossible).

+
+
BAD_CAST
#define BAD_CAST (xmlChar *)
+

+Macro to cast a string to an xmlChar * when one know its safe.

+
+
struct xmlNotation
struct xmlNotation {
     const xmlChar               *name;	        /* Notation name */
     const xmlChar               *PublicID;	/* Public identifier, if any */
     const xmlChar               *SystemID;	/* System identifier, if any */
-};

A DTD Notation definition.

xmlNotationPtr

enum xmlAttributeType

typedef enum {
+};
+

+A DTD Notation definition.

+ +

xmlNotationPtr

typedef xmlNotation *xmlNotationPtr;
+

+ +

enum xmlAttributeType

typedef enum {
     XML_ATTRIBUTE_CDATA = 1,
     XML_ATTRIBUTE_ID,
     XML_ATTRIBUTE_IDREF	,
@@ -2753,112 +699,30 @@ CLASS="PROGRAMLISTING"
     XML_ATTRIBUTE_NMTOKENS,
     XML_ATTRIBUTE_ENUMERATION,
     XML_ATTRIBUTE_NOTATION
-} xmlAttributeType;

A DTD Attribute type definition.

enum xmlAttributeDefault

typedef enum {
+} xmlAttributeType;
+

+A DTD Attribute type definition.

+ +

enum xmlAttributeDefault

typedef enum {
     XML_ATTRIBUTE_NONE = 1,
     XML_ATTRIBUTE_REQUIRED,
     XML_ATTRIBUTE_IMPLIED,
     XML_ATTRIBUTE_FIXED
-} xmlAttributeDefault;

A DTD Attribute default definition.

struct xmlEnumeration

struct xmlEnumeration {
+} xmlAttributeDefault;
+

+A DTD Attribute default definition.

+ +

struct xmlEnumeration

struct xmlEnumeration {
     struct _xmlEnumeration    *next;	/* next one */
     const xmlChar            *name;	/* Enumeration name */
-};

List structure used when there is an enumeration in DTDs.

xmlEnumerationPtr

struct xmlAttribute

struct xmlAttribute {
+};
+

+List structure used when there is an enumeration in DTDs.

+ +

xmlEnumerationPtr

typedef xmlEnumeration *xmlEnumerationPtr;
+

+ +

struct xmlAttribute

struct xmlAttribute {
     void           *_private;	        /* application data */
     xmlElementType          type;       /* XML_ATTRIBUTE_DECL, must be second ! */
     const xmlChar          *name;	/* Attribute name */
@@ -2876,114 +740,32 @@ CLASS="PROGRAMLISTING"
     xmlEnumerationPtr       tree;       /* or the enumeration tree if any */
     const xmlChar        *prefix;	/* the namespace prefix if any */
     const xmlChar          *elem;	/* Element holding the attribute */
-};

An Attribute declaration in a DTD.

xmlAttributePtr

enum xmlElementContentType

typedef enum {
+};
+

+An Attribute declaration in a DTD.

+ +

xmlAttributePtr

typedef xmlAttribute *xmlAttributePtr;
+

+ +

enum xmlElementContentType

typedef enum {
     XML_ELEMENT_CONTENT_PCDATA = 1,
     XML_ELEMENT_CONTENT_ELEMENT,
     XML_ELEMENT_CONTENT_SEQ,
     XML_ELEMENT_CONTENT_OR
-} xmlElementContentType;

Possible definitions of element content types.

enum xmlElementContentOccur

typedef enum {
+} xmlElementContentType;
+

+Possible definitions of element content types.

+ +

enum xmlElementContentOccur

typedef enum {
     XML_ELEMENT_CONTENT_ONCE = 1,
     XML_ELEMENT_CONTENT_OPT,
     XML_ELEMENT_CONTENT_MULT,
     XML_ELEMENT_CONTENT_PLUS
-} xmlElementContentOccur;

Possible definitions of element content occurrences.

struct xmlElementContent

struct xmlElementContent {
+} xmlElementContentOccur;
+

+Possible definitions of element content occurrences.

+ +

struct xmlElementContent

struct xmlElementContent {
     xmlElementContentType     type;	/* PCDATA, ELEMENT, SEQ or OR */
     xmlElementContentOccur    ocur;	/* ONCE, OPT, MULT or PLUS */
     const xmlChar             *name;	/* Element name */
@@ -2991,83 +773,25 @@ CLASS="PROGRAMLISTING"
     struct _xmlElementContent *c2;	/* second child */
     struct _xmlElementContent *parent;	/* parent */
     const xmlChar             *prefix;	/* Namespace prefix */
-};

An XML Element content as stored after parsing an element definition -in a DTD.

xmlElementContentPtr

enum xmlElementTypeVal

typedef enum {
+};
+

+An XML Element content as stored after parsing an element definition +in a DTD.

+ +

xmlElementContentPtr

typedef xmlElementContent *xmlElementContentPtr;
+

+ +

enum xmlElementTypeVal

typedef enum {
     XML_ELEMENT_TYPE_UNDEFINED = 0,
     XML_ELEMENT_TYPE_EMPTY = 1,
     XML_ELEMENT_TYPE_ANY,
     XML_ELEMENT_TYPE_MIXED,
     XML_ELEMENT_TYPE_ELEMENT
-} xmlElementTypeVal;

The different possibilities for an element content type.

struct xmlElement

struct xmlElement {
+} xmlElementTypeVal;
+

+The different possibilities for an element content type.

+ +

struct xmlElement

struct xmlElement {
     void           *_private;	        /* application data */
     xmlElementType          type;       /* XML_ELEMENT_DECL, must be second ! */
     const xmlChar          *name;	/* Element name */
@@ -3087,140 +811,38 @@ CLASS="PROGRAMLISTING"
 #else
     void	      *contModel;
 #endif
-};

An XML Element declaration from a DTD.

xmlElementPtr

XML_LOCAL_NAMESPACE

#define     XML_LOCAL_NAMESPACE

A namespace declaration node.

xmlNsType

struct xmlNs

struct xmlNs {
+};
+

+An XML Element declaration from a DTD.

+ +

xmlElementPtr

typedef xmlElement *xmlElementPtr;
+

+ +

XML_LOCAL_NAMESPACE

#define XML_LOCAL_NAMESPACE XML_NAMESPACE_DECL
+

+A namespace declaration node.

+ +

xmlNsType

typedef xmlElementType xmlNsType;
+

+ +

struct xmlNs

struct xmlNs {
     struct _xmlNs  *next;	/* next Ns link for this node  */
     xmlNsType      type;	/* global or local */
     const xmlChar *href;	/* URL for the namespace */
     const xmlChar *prefix;	/* prefix for the namespace */
     void           *_private;   /* application data */
-};

An XML namespace. +}; +

+An XML namespace. Note that prefix == NULL is valid, it defines the default namespace -within the subtree (until overridden).

xmlNsType is unified with xmlElementType.

xmlNsPtr

struct xmlDtd

struct xmlDtd {
+within the subtree (until overridden).
+

+xmlNsType is unified with xmlElementType.

+
+
xmlNsPtr
typedef xmlNs *xmlNsPtr;
+

+
+
struct xmlDtd
struct xmlDtd {
     void           *_private;	/* application data */
     xmlElementType  type;       /* XML_DTD_NODE, must be second ! */
     const xmlChar *name;	/* Name of the DTD */
@@ -3239,49 +861,15 @@ CLASS="PROGRAMLISTING"
     const xmlChar *ExternalID;	/* External identifier for PUBLIC DTD */
     const xmlChar *SystemID;	/* URI for a SYSTEM or PUBLIC DTD */
     void          *pentities;   /* Hash table for param entities if any */
-};

An XML DTD, as defined by <!DOCTYPE ... There is actually one for -the internal subset and for the external subset.

xmlDtdPtr

struct xmlAttr

struct xmlAttr {
+};
+

+An XML DTD, as defined by <!DOCTYPE ... There is actually one for +the internal subset and for the external subset.

+ +

xmlDtdPtr

typedef xmlDtd *xmlDtdPtr;
+

+ +

struct xmlAttr

struct xmlAttr {
     void           *_private;	/* application data */
     xmlElementType   type;      /* XML_ATTRIBUTE_NODE, must be second ! */
     const xmlChar   *name;      /* the name of the property */
@@ -3293,220 +881,60 @@ CLASS="PROGRAMLISTING"
     struct _xmlDoc  *doc;	/* the containing document */
     xmlNs           *ns;        /* pointer to the associated namespace */
     xmlAttributeType atype;     /* the attribute type if validating */
-};

An attribute on an XML node.

xmlAttrPtr

struct xmlID

struct xmlID {
+};
+

+An attribute on an XML node.

+ +

xmlAttrPtr

typedef xmlAttr *xmlAttrPtr;
+

+ +

struct xmlID

struct xmlID {
     struct _xmlID    *next;	/* next ID */
     const xmlChar    *value;	/* The ID name */
     xmlAttrPtr        attr;	/* The attribute holding it */
     const xmlChar    *name;	/* The attribute if attr is not available */
     int               lineno;	/* The line number if attr is not available */
-};

An XML ID instance.

xmlIDPtr

struct xmlRef

struct xmlRef {
+};
+

+An XML ID instance.

+ +

xmlIDPtr

typedef xmlID *xmlIDPtr;
+

+ +

struct xmlRef

struct xmlRef {
     struct _xmlRef    *next;	/* next Ref */
     const xmlChar     *value;	/* The Ref name */
     xmlAttrPtr        attr;	/* The attribute holding it */
     const xmlChar    *name;	/* The attribute if attr is not available */
     int               lineno;	/* The line number if attr is not available */
-};

An XML IDREF instance.

xmlRefPtr

enum xmlBufferAllocationScheme

typedef enum {
+};
+

+An XML IDREF instance.

+ +

xmlRefPtr

typedef xmlRef *xmlRefPtr;
+

+ +

enum xmlBufferAllocationScheme

typedef enum {
     XML_BUFFER_ALLOC_DOUBLEIT,
     XML_BUFFER_ALLOC_EXACT
-} xmlBufferAllocationScheme;

A buffer allocation scheme can be defined to either match exactly the -need or double it's allocated size each time it is found too small.

struct xmlBuffer

struct xmlBuffer {
+} xmlBufferAllocationScheme;
+

+A buffer allocation scheme can be defined to either match exactly the +need or double it's allocated size each time it is found too small.

+ +

struct xmlBuffer

struct xmlBuffer {
     xmlChar *content;		/* The buffer content UTF8 */
     unsigned int use;		/* The buffer size used */
     unsigned int size;		/* The buffer size */
     xmlBufferAllocationScheme alloc; /* The realloc method */
-};

A buffer structure.

xmlBufferPtr

struct xmlNode

struct xmlNode {
+};
+

+A buffer structure.

+ +

xmlBufferPtr

typedef xmlBuffer *xmlBufferPtr;
+

+ +

struct xmlNode

struct xmlNode {
     void           *_private;	/* application data */
     xmlElementType   type;	/* type number, must be second ! */
     const xmlChar   *name;      /* the name of the node, or the entity */
@@ -3522,180 +950,28 @@ CLASS="PROGRAMLISTING"
     xmlChar         *content;   /* the content */
     struct _xmlAttr *properties;/* properties list */
     xmlNs           *nsDef;     /* namespace definitions on this node */
-};

A node in an XML tree.

xmlNodePtr

XML_GET_CONTENT()

#define     XML_GET_CONTENT(n)

Macro to extract the content pointer of a node.

n : 

XML_GET_LINE()

#define     XML_GET_LINE(n)

Macro to extract the line number of an element node. +}; +

+A node in an XML tree.

+ +

xmlNodePtr

typedef xmlNode *xmlNodePtr;
+

+ +

XML_GET_CONTENT()

#define     XML_GET_CONTENT(n)

+Macro to extract the content pointer of a node.

+ +

n : + + +

XML_GET_LINE()

#define     XML_GET_LINE(n)

+Macro to extract the line number of an element node. This will work only if line numbering is activated by -calling xmlLineNumbersDefault(1) before parsing.

n : 

struct xmlDoc

struct xmlDoc {
+calling xmlLineNumbersDefault(1) before parsing.

+
+
n :
+
+
+
struct xmlDoc
struct xmlDoc {
     void           *_private;	/* application data */
     xmlElementType  type;       /* XML_DOCUMENT_NODE, must be second ! */
     char           *name;	/* name/filename/URI of the document */
@@ -3719,15205 +995,1190 @@ CLASS="PROGRAMLISTING"
     const xmlChar  *URL;	/* The URI for that document */
     int             charset;    /* encoding of the in-memory content
 				   actually an xmlCharEncoding */
-};

An XML document.

xmlDocPtr

xmlChildrenNode

#define     xmlChildrenNode

Macro for compatibility naming layer with libxml1.

xmlRootNode

#define     xmlRootNode

Macro for compatibility naming layer with libxml1.

xmlValidateNCName ()

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

Check that a value conforms to the lexical space of NCName

value : 
space : 
Returns : 

xmlValidateQName ()

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

Check that a value conforms to the lexical space of QName

value : 
space : 
Returns : 

xmlValidateName ()

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

Check that a value conforms to the lexical space of Name

value : 
space : 
Returns : 

xmlValidateNMToken ()

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

Check that a value conforms to the lexical space of NMToken

value : 
space : 
Returns : 

xmlSetBufferAllocationScheme ()

void        xmlSetBufferAllocationScheme    (xmlBufferAllocationScheme scheme);

Set the buffer allocation method. Types are +}; +

+An XML document.

+ +

xmlDocPtr

typedef xmlDoc *xmlDocPtr;
+

+ +

xmlChildrenNode

#define xmlChildrenNode children
+

+Macro for compatibility naming layer with libxml1.

+ +

xmlRootNode

#define xmlRootNode children
+

+Macro for compatibility naming layer with libxml1.

+ +

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. +

xmlBuildQName ()

xmlChar*    xmlBuildQName                   (const xmlChar *ncname,
+                                             const xmlChar *prefix,
+                                             xmlChar *memory,
+                                             int len);

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

+ +

ncname : the Name +
prefix : the prefix +
memory : preallocated memory +
len : preallocated memory length +
Returns :the new string which must be freed by the caller if different from + memory and ncname or NULL in case of error +

xmlSplitQName2 ()

xmlChar*    xmlSplitQName2                  (const xmlChar *name,
+                                             xmlChar **prefix);

+parse an XML qualified name string +

+[NS 5] QName ::= (Prefix ':')? LocalPart +

+[NS 6] Prefix ::= NCName +

+[NS 7] LocalPart ::= NCName

+ +

name : the full QName +
prefix : a xmlChar ** +
Returns :NULL if not a QName, otherwise the local part, and prefix + is updated to get the Prefix if any. +

xmlSetBufferAllocationScheme ()

void        xmlSetBufferAllocationScheme    (xmlBufferAllocationScheme scheme);

+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

scheme : 

xmlGetBufferAllocationScheme ()

xmlBufferAllocationScheme xmlGetBufferAllocationScheme
-                                            (void);

Types are + improves performance

+ +

scheme : allocation method to use +

xmlGetBufferAllocationScheme ()

xmlBufferAllocationScheme xmlGetBufferAllocationScheme
+                                            (void);

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

Returns : 

xmlBufferCreate ()

xmlBufferPtr xmlBufferCreate                (void);

routine to create an XML buffer.

Returns : 

xmlBufferCreateSize ()

xmlBufferPtr xmlBufferCreateSize            (size_t size);

routine to create an XML buffer.

size : 
Returns : 

xmlBufferResize ()

int         xmlBufferResize                 (xmlBufferPtr buf,
-                                             unsigned int size);

Resize a buffer to accommodate minimum size of size.

buf : 
size : 
Returns : 

xmlBufferFree ()

void        xmlBufferFree                   (xmlBufferPtr buf);

Frees an XML buffer. It frees both the content and the structure which -encapsulate it.

buf : 

xmlBufferDump ()

int         xmlBufferDump                   (FILE *file,
-                                             xmlBufferPtr buf);

Dumps an XML buffer to a FILE *.

file : 
buf : 
Returns : 

xmlBufferAdd ()

void        xmlBufferAdd                    (xmlBufferPtr buf,
-                                             const xmlChar *str,
-                                             int len);

Add a string range to an XML buffer. if len == -1, the length of -str is recomputed.

buf : 
str : 
len : 

xmlBufferAddHead ()

void        xmlBufferAddHead                (xmlBufferPtr buf,
-                                             const xmlChar *str,
-                                             int len);

Add a string range to the beginning of an XML buffer. -if len == -1, the length of str is recomputed.

buf : 
str : 
len : 

xmlBufferCat ()

void        xmlBufferCat                    (xmlBufferPtr buf,
-                                             const xmlChar *str);

Append a zero terminated string to an XML buffer.

buf : 
str : 

xmlBufferCCat ()

void        xmlBufferCCat                   (xmlBufferPtr buf,
-                                             const char *str);

Append a zero terminated C string to an XML buffer.

buf : 
str : 

xmlBufferShrink ()

int         xmlBufferShrink                 (xmlBufferPtr buf,
-                                             unsigned int len);

Remove the beginning of an XML buffer.

buf : 
len : 
Returns : 

xmlBufferGrow ()

int         xmlBufferGrow                   (xmlBufferPtr buf,
-                                             unsigned int len);

Grow the available space of an XML buffer.

buf : 
len : 
Returns : 

xmlBufferEmpty ()

void        xmlBufferEmpty                  (xmlBufferPtr buf);

empty a buffer.

buf : 

xmlBufferContent ()

const xmlChar* xmlBufferContent             (const xmlBufferPtr buf);

Function to extract the content of a buffer

buf : 
Returns : 

xmlBufferSetAllocationScheme ()

void        xmlBufferSetAllocationScheme    (xmlBufferPtr buf,
-                                             xmlBufferAllocationScheme scheme);

Sets the allocation scheme for this buffer

buf : 
scheme : 

xmlBufferLength ()

int         xmlBufferLength                 (const xmlBufferPtr buf);

Function to get the length of a buffer

buf : 
Returns : 

xmlCreateIntSubset ()

xmlDtdPtr   xmlCreateIntSubset              (xmlDocPtr doc,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);

Create the internal subset of a document

doc : 
name : 
ExternalID : 
SystemID : 
Returns : 

xmlNewDtd ()

xmlDtdPtr   xmlNewDtd                       (xmlDocPtr doc,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);

Creation of a new DTD for the external subset. To create an -internal subset, use xmlCreateIntSubset().

doc : 
name : 
ExternalID : 
SystemID : 
Returns : 

xmlGetIntSubset ()

xmlDtdPtr   xmlGetIntSubset                 (xmlDocPtr doc);

Get the internal subset of a document

doc : 
Returns : 

xmlFreeDtd ()

void        xmlFreeDtd                      (xmlDtdPtr cur);

Free a DTD structure.

cur : 

xmlNewGlobalNs ()

xmlNsPtr    xmlNewGlobalNs                  (xmlDocPtr doc,
-                                             const xmlChar *href,
-                                             const xmlChar *prefix);

Creation of a Namespace, the old way using PI and without scoping + improves performance

+ +

Returns :the current allocation scheme +

xmlBufferCreate ()

xmlBufferPtr xmlBufferCreate                (void);

+routine to create an XML buffer.

+ +

Returns :the new structure. +

xmlBufferCreateSize ()

xmlBufferPtr xmlBufferCreateSize            (size_t size);

+routine to create an XML buffer.

+ +

size : initial size of buffer +
Returns :the new structure. +

xmlBufferResize ()

int         xmlBufferResize                 (xmlBufferPtr buf,
+                                             unsigned int size);

+Resize a buffer to accommodate minimum size of size.

+ +

buf : the buffer to resize +
size : the desired size +
Returns :0 in case of problems, 1 otherwise +

xmlBufferFree ()

void        xmlBufferFree                   (xmlBufferPtr buf);

+Frees an XML buffer. It frees both the content and the structure which +encapsulate it.

+ +

buf : the buffer to free +

xmlBufferDump ()

int         xmlBufferDump                   (FILE *file,
+                                             xmlBufferPtr buf);

+Dumps an XML buffer to a FILE *.

+ +

file : the file output +
buf : the buffer to dump +
Returns :the number of xmlChar written +

xmlBufferAdd ()

void        xmlBufferAdd                    (xmlBufferPtr buf,
+                                             const xmlChar *str,
+                                             int len);

+Add a string range to an XML buffer. if len == -1, the length of +str is recomputed.

+ +

buf : the buffer to dump +
str : the xmlChar string +
len : the number of xmlChar to add +

xmlBufferAddHead ()

void        xmlBufferAddHead                (xmlBufferPtr buf,
+                                             const xmlChar *str,
+                                             int len);

+Add a string range to the beginning of an XML buffer. +if len == -1, the length of str is recomputed.

+ +

buf : the buffer +
str : the xmlChar string +
len : the number of xmlChar to add +

xmlBufferCat ()

void        xmlBufferCat                    (xmlBufferPtr buf,
+                                             const xmlChar *str);

+Append a zero terminated string to an XML buffer.

+ +

buf : the buffer to dump +
str : the xmlChar string +

xmlBufferCCat ()

void        xmlBufferCCat                   (xmlBufferPtr buf,
+                                             const char *str);

+Append a zero terminated C string to an XML buffer.

+ +

buf : the buffer to dump +
str : the C char string +

xmlBufferShrink ()

int         xmlBufferShrink                 (xmlBufferPtr buf,
+                                             unsigned int len);

+Remove the beginning of an XML buffer.

+ +

buf : the buffer to dump +
len : the number of xmlChar to remove +
Returns :the number of xmlChar removed, or -1 in case of failure. +

xmlBufferGrow ()

int         xmlBufferGrow                   (xmlBufferPtr buf,
+                                             unsigned int len);

+Grow the available space of an XML buffer.

+ +

buf : the buffer +
len : the minimum free size to allocate +
Returns :the new available space or -1 in case of error +

xmlBufferEmpty ()

void        xmlBufferEmpty                  (xmlBufferPtr buf);

+empty a buffer.

+ +

buf : the buffer +

xmlBufferContent ()

const xmlChar* xmlBufferContent             (const xmlBufferPtr buf);

+Function to extract the content of a buffer

+ +

buf : the buffer +
Returns :the internal content +

xmlBufferSetAllocationScheme ()

void        xmlBufferSetAllocationScheme    (xmlBufferPtr buf,
+                                             xmlBufferAllocationScheme scheme);

+Sets the allocation scheme for this buffer

+ +

buf : the buffer to tune +
scheme : allocation scheme to use +

xmlBufferLength ()

int         xmlBufferLength                 (const xmlBufferPtr buf);

+Function to get the length of a buffer

+ +

buf : the buffer +
Returns :the length of data in the internal content +

xmlCreateIntSubset ()

xmlDtdPtr   xmlCreateIntSubset              (xmlDocPtr doc,
+                                             const xmlChar *name,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);

+Create the internal subset of a document

+ +

doc : the document pointer +
name : the DTD name +
ExternalID : the external (PUBLIC) ID +
SystemID : the system ID +
Returns :a pointer to the new DTD structure +

xmlNewDtd ()

xmlDtdPtr   xmlNewDtd                       (xmlDocPtr doc,
+                                             const xmlChar *name,
+                                             const xmlChar *ExternalID,
+                                             const xmlChar *SystemID);

+Creation of a new DTD for the external subset. To create an +internal subset, use xmlCreateIntSubset().

+ +

doc : the document pointer +
name : the DTD name +
ExternalID : the external ID +
SystemID : the system ID +
Returns :a pointer to the new DTD structure +

xmlGetIntSubset ()

xmlDtdPtr   xmlGetIntSubset                 (xmlDocPtr doc);

+Get the internal subset of a document

+ +

doc : the document pointer +
Returns :a pointer to the DTD structure or NULL if not found +

xmlFreeDtd ()

void        xmlFreeDtd                      (xmlDtdPtr cur);

+Free a DTD structure.

+ +

cur : the DTD structure to free up +

xmlNewGlobalNs ()

xmlNsPtr    xmlNewGlobalNs                  (xmlDocPtr doc,
+                                             const xmlChar *href,
+                                             const xmlChar *prefix);

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

doc : 
href : 
prefix : 
Returns : 

xmlNewNs ()

xmlNsPtr    xmlNewNs                        (xmlNodePtr node,
-                                             const xmlChar *href,
-                                             const xmlChar *prefix);

Creation of a new Namespace. This function will refuse to create +It now create a namespace on the root element of the document if found.

+ +

doc : the document carrying the namespace +
href : the URI associated +
prefix : the prefix for the namespace +
Returns :NULL this functionality had been removed +

xmlNewNs ()

xmlNsPtr    xmlNewNs                        (xmlNodePtr node,
+                                             const xmlChar *href,
+                                             const xmlChar *prefix);

+Creation of a new Namespace. This function will refuse to create a namespace with a similar prefix than an existing one present on this node. We use href==NULL in the case of an element creation where the namespace -was not defined.

node : 
href : 
prefix : 
Returns : 

xmlFreeNs ()

void        xmlFreeNs                       (xmlNsPtr cur);

Free up the structures associated to a namespace

cur : 

xmlFreeNsList ()

void        xmlFreeNsList                   (xmlNsPtr cur);

Free up all the structures associated to the chained namespaces.

cur : 

xmlNewDoc ()

xmlDocPtr   xmlNewDoc                       (const xmlChar *version);

Creates a new XML document

version : 
Returns : 

xmlFreeDoc ()

void        xmlFreeDoc                      (xmlDocPtr cur);

Free up all the structures used by a document, tree included.

cur : 

xmlNewDocProp ()

xmlAttrPtr  xmlNewDocProp                   (xmlDocPtr doc,
-                                             const xmlChar *name,
-                                             const xmlChar *value);

Create a new property carried by a document.

doc : 
name : 
value : 
Returns : 

xmlNewProp ()

xmlAttrPtr  xmlNewProp                      (xmlNodePtr node,
-                                             const xmlChar *name,
-                                             const xmlChar *value);

Create a new property carried by a node.

node : 
name : 
value : 
Returns : 

xmlNewNsProp ()

xmlAttrPtr  xmlNewNsProp                    (xmlNodePtr node,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *value);

Create a new property tagged with a namespace and carried by a node.

node : 
ns : 
name : 
value : 
Returns : 

xmlNewNsPropEatName ()

xmlAttrPtr  xmlNewNsPropEatName             (xmlNodePtr node,
-                                             xmlNsPtr ns,
-                                             xmlChar *name,
-                                             const xmlChar *value);

Create a new property tagged with a namespace and carried by a node.

node : 
ns : 
name : 
value : 
Returns : 

xmlFreePropList ()

void        xmlFreePropList                 (xmlAttrPtr cur);

Free a property and all its siblings, all the children are freed too.

cur : 

xmlFreeProp ()

void        xmlFreeProp                     (xmlAttrPtr cur);

Free one attribute, all the content is freed too

cur : 

xmlCopyProp ()

xmlAttrPtr  xmlCopyProp                     (xmlNodePtr target,
-                                             xmlAttrPtr cur);

Do a copy of the attribute.

target : 
cur : 
Returns : 

xmlCopyPropList ()

xmlAttrPtr  xmlCopyPropList                 (xmlNodePtr target,
-                                             xmlAttrPtr cur);

Do a copy of an attribute list.

target : 
cur : 
Returns : 

xmlCopyDtd ()

xmlDtdPtr   xmlCopyDtd                      (xmlDtdPtr dtd);

Do a copy of the dtd.

dtd : 
Returns : 

xmlCopyDoc ()

xmlDocPtr   xmlCopyDoc                      (xmlDocPtr doc,
-                                             int recursive);

Do a copy of the document info. If recursive, the content tree will -be copied too as well as DTD, namespaces and entities.

doc : 
recursive : 
Returns : 

xmlNewDocNode ()

xmlNodePtr  xmlNewDocNode                   (xmlDocPtr doc,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *content);

Creation of a new node element within a document. ns and content +was not defined.

+ +

node : the element carrying the namespace +
href : the URI associated +
prefix : the prefix for the namespace +
Returns :a new namespace pointer or NULL +

xmlFreeNs ()

void        xmlFreeNs                       (xmlNsPtr cur);

+Free up the structures associated to a namespace

+ +

cur : the namespace pointer +

xmlFreeNsList ()

void        xmlFreeNsList                   (xmlNsPtr cur);

+Free up all the structures associated to the chained namespaces.

+ +

cur : the first namespace pointer +

xmlNewDoc ()

xmlDocPtr   xmlNewDoc                       (const xmlChar *version);

+Creates a new XML document

+ +

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

xmlFreeDoc ()

void        xmlFreeDoc                      (xmlDocPtr cur);

+Free up all the structures used by a document, tree included.

+ +

cur : pointer to the document +

xmlNewDocProp ()

xmlAttrPtr  xmlNewDocProp                   (xmlDocPtr doc,
+                                             const xmlChar *name,
+                                             const xmlChar *value);

+Create a new property carried by a document.

+ +

doc : the document +
name : the name of the attribute +
value : the value of the attribute +
Returns :a pointer to the attribute +

xmlNewProp ()

xmlAttrPtr  xmlNewProp                      (xmlNodePtr node,
+                                             const xmlChar *name,
+                                             const xmlChar *value);

+Create a new property carried by a node.

+ +

node : the holding node +
name : the name of the attribute +
value : the value of the attribute +
Returns :a pointer to the attribute +

xmlNewNsProp ()

xmlAttrPtr  xmlNewNsProp                    (xmlNodePtr node,
+                                             xmlNsPtr ns,
+                                             const xmlChar *name,
+                                             const xmlChar *value);

+Create a new property tagged with a namespace and carried by a node.

+ +

node : the holding node +
ns : the namespace +
name : the name of the attribute +
value : the value of the attribute +
Returns :a pointer to the attribute +

xmlNewNsPropEatName ()

xmlAttrPtr  xmlNewNsPropEatName             (xmlNodePtr node,
+                                             xmlNsPtr ns,
+                                             xmlChar *name,
+                                             const xmlChar *value);

+Create a new property tagged with a namespace and carried by a node.

+ +

node : the holding node +
ns : the namespace +
name : the name of the attribute +
value : the value of the attribute +
Returns :a pointer to the attribute +

xmlFreePropList ()

void        xmlFreePropList                 (xmlAttrPtr cur);

+Free a property and all its siblings, all the children are freed too.

+ +

cur : the first property in the list +

xmlFreeProp ()

void        xmlFreeProp                     (xmlAttrPtr cur);

+Free one attribute, all the content is freed too

+ +

cur : an attribute +

xmlCopyProp ()

xmlAttrPtr  xmlCopyProp                     (xmlNodePtr target,
+                                             xmlAttrPtr cur);

+Do a copy of the attribute.

+ +

target : the element where the attribute will be grafted +
cur : the attribute +
Returns : a new xmlAttrPtr, or NULL in case of error. +

xmlCopyPropList ()

xmlAttrPtr  xmlCopyPropList                 (xmlNodePtr target,
+                                             xmlAttrPtr cur);

+Do a copy of an attribute list.

+ +

target : the element where the attributes will be grafted +
cur : the first attribute +
Returns : a new xmlAttrPtr, or NULL in case of error. +

xmlCopyDtd ()

xmlDtdPtr   xmlCopyDtd                      (xmlDtdPtr dtd);

+Do a copy of the dtd.

+ +

dtd : the dtd +
Returns : a new xmlDtdPtr, or NULL in case of error. +

xmlCopyDoc ()

xmlDocPtr   xmlCopyDoc                      (xmlDocPtr doc,
+                                             int recursive);

+Do a copy of the document info. If recursive, the content tree will +be copied too as well as DTD, namespaces and entities.

+ +

doc : the document +
recursive : if 1 do a recursive copy. +
Returns : a new xmlDocPtr, or NULL in case of error. +

xmlNewDocNode ()

xmlNodePtr  xmlNewDocNode                   (xmlDocPtr doc,
+                                             xmlNsPtr ns,
+                                             const xmlChar *name,
+                                             const xmlChar *content);

+Creation of a new node element within a document. ns and content are optional (NULL). -NOTE: content is supposed to be a piece of XML CDATA, so it allow entities +NOTE: 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.

doc : 
ns : 
name : 
content : 
Returns : 

xmlNewDocNodeEatName ()

xmlNodePtr  xmlNewDocNodeEatName            (xmlDocPtr doc,
-                                             xmlNsPtr ns,
-                                             xmlChar *name,
-                                             const xmlChar *content);

Creation of a new node element within a document. ns and content + xmlEncodeEntitiesReentrant(). Use xmlNewDocRawNode() if you don't + need entities support.

+ +

doc : the document +
ns : namespace if any +
name : the node name +
content : the XML text content if any +
Returns :a pointer to the new node object. +

xmlNewDocNodeEatName ()

xmlNodePtr  xmlNewDocNodeEatName            (xmlDocPtr doc,
+                                             xmlNsPtr ns,
+                                             xmlChar *name,
+                                             const xmlChar *content);

+Creation of a new node element within a document. ns and content are optional (NULL). -NOTE: content is supposed to be a piece of XML CDATA, so it allow entities +NOTE: 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.

doc : 
ns : 
name : 
content : 
Returns : 

xmlNewDocRawNode ()

xmlNodePtr  xmlNewDocRawNode                (xmlDocPtr doc,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *content);

Creation of a new node element within a document. ns and content -are optional (NULL).

doc : 
ns : 
name : 
content : 
Returns : 

xmlNewNode ()

xmlNodePtr  xmlNewNode                      (xmlNsPtr ns,
-                                             const xmlChar *name);

Creation of a new node element. ns is optional (NULL).

ns : 
name : 
Returns : 

xmlNewNodeEatName ()

xmlNodePtr  xmlNewNodeEatName               (xmlNsPtr ns,
-                                             xmlChar *name);

Creation of a new node element. ns is optional (NULL).

ns : 
name : 
Returns : 

xmlNewChild ()

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

Creation of a new child element, added at the end of parent children list. -ns and content parameters are optional (NULL). If content is non NULL, + xmlEncodeEntitiesReentrant(). Use xmlNewDocRawNode() if you don't + need entities support.

+ +

doc : the document +
ns : namespace if any +
name : the node name +
content : the XML text content if any +
Returns :a pointer to the new node object. +

xmlNewDocRawNode ()

xmlNodePtr  xmlNewDocRawNode                (xmlDocPtr doc,
+                                             xmlNsPtr ns,
+                                             const xmlChar *name,
+                                             const xmlChar *content);

+Creation of a new node element within a document. ns and content +are optional (NULL).

+ +

doc : the document +
ns : namespace if any +
name : the node name +
content : the text content if any +
Returns :a pointer to the new node object. +

xmlNewNode ()

xmlNodePtr  xmlNewNode                      (xmlNsPtr ns,
+                                             const xmlChar *name);

+Creation of a new node element. ns is optional (NULL).

+ +

ns : namespace if any +
name : the node name +
Returns :a pointer to the new node object. +

xmlNewNodeEatName ()

xmlNodePtr  xmlNewNodeEatName               (xmlNsPtr ns,
+                                             xmlChar *name);

+Creation of a new node element. ns is optional (NULL).

+ +

ns : namespace if any +
name : the node name +
Returns :a pointer to the new node object. +

xmlNewChild ()

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

+Creation of a new child element, added at the end of parent children list. +ns and content parameters are optional (NULL). If content is non NULL, a child list containing the TEXTs and ENTITY_REFs node will be created. -NOTE: content is supposed to be a piece of XML CDATA, so it allow entities +NOTE: 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.

parent : 
ns : 
name : 
content : 
Returns : 

xmlNewTextChild ()

xmlNodePtr  xmlNewTextChild                 (xmlNodePtr parent,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *content);

Creation of a new child element, added at the end of parent children list. -ns and content parameters are optional (NULL). If content is non NULL, -a child TEXT node will be created containing the string content.

parent : 
ns : 
name : 
content : 
Returns : 

xmlNewDocText ()

xmlNodePtr  xmlNewDocText                   (xmlDocPtr doc,
-                                             const xmlChar *content);

Creation of a new text node within a document.

doc : 
content : 
Returns : 

xmlNewText ()

xmlNodePtr  xmlNewText                      (const xmlChar *content);

Creation of a new text node.

content : 
Returns : 

xmlNewPI ()

xmlNodePtr  xmlNewPI                        (const xmlChar *name,
-                                             const xmlChar *content);

Creation of a processing instruction element.

name : 
content : 
Returns : 

xmlNewDocTextLen ()

xmlNodePtr  xmlNewDocTextLen                (xmlDocPtr doc,
-                                             const xmlChar *content,
-                                             int len);

Creation of a new text node with an extra content length parameter. The -text node pertain to a given document.

doc : 
content : 
len : 
Returns : 

xmlNewTextLen ()

xmlNodePtr  xmlNewTextLen                   (const xmlChar *content,
-                                             int len);

Creation of a new text node with an extra parameter for the content's length

content : 
len : 
Returns : 

xmlNewDocComment ()

xmlNodePtr  xmlNewDocComment                (xmlDocPtr doc,
-                                             const xmlChar *content);

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

doc : 
content : 
Returns : 

xmlNewComment ()

xmlNodePtr  xmlNewComment                   (const xmlChar *content);

Creation of a new node containing a comment.

content : 
Returns : 

xmlNewCDataBlock ()

xmlNodePtr  xmlNewCDataBlock                (xmlDocPtr doc,
-                                             const xmlChar *content,
-                                             int len);

Creation of a new node containing a CDATA block.

doc : 
content : 
len : 
Returns : 

xmlNewCharRef ()

xmlNodePtr  xmlNewCharRef                   (xmlDocPtr doc,
-                                             const xmlChar *name);

Creation of a new character reference node.

doc : 
name : 
Returns : 

xmlNewReference ()

xmlNodePtr  xmlNewReference                 (xmlDocPtr doc,
-                                             const xmlChar *name);

Creation of a new reference node.

doc : 
name : 
Returns : 

xmlCopyNode ()

xmlNodePtr  xmlCopyNode                     (const xmlNodePtr node,
-                                             int recursive);

Do a copy of the node.

node : 
recursive : 
Returns : 

xmlDocCopyNode ()

xmlNodePtr  xmlDocCopyNode                  (const xmlNodePtr node,
-                                             xmlDocPtr doc,
-                                             int recursive);

Do a copy of the node to a given document.

node : 
doc : 
recursive : 
Returns : 

xmlCopyNodeList ()

xmlNodePtr  xmlCopyNodeList                 (const xmlNodePtr node);

Do a recursive copy of the node list.

node : 
Returns : 

xmlNewDocFragment ()

xmlNodePtr  xmlNewDocFragment               (xmlDocPtr doc);

Creation of a new Fragment node.

doc : 
Returns : 

xmlGetLineNo ()

long        xmlGetLineNo                    (xmlNodePtr node);

Get line number of node. this requires activation of this option -before invoking the parser by calling xmlLineNumbersDefault(1)

node : 
Returns : 

xmlGetNodePath ()

xmlChar*    xmlGetNodePath                  (xmlNodePtr node);

Build a structure based Path for the given node

node : 
Returns : 

xmlDocGetRootElement ()

xmlNodePtr  xmlDocGetRootElement            (xmlDocPtr doc);

Get the root element of the document (doc->children is a list -containing possibly comments, PIs, etc ...).

doc : 
Returns : 

xmlGetLastChild ()

xmlNodePtr  xmlGetLastChild                 (xmlNodePtr parent);

Search the last child of a node.

parent : 
Returns : 

xmlNodeIsText ()

int         xmlNodeIsText                   (xmlNodePtr node);

Is this node a Text node ?

node : 
Returns : 

xmlIsBlankNode ()

int         xmlIsBlankNode                  (xmlNodePtr node);

Checks whether this node is an empty or whitespace only -(and possibly ignorable) text-node.

node : 
Returns : 

xmlDocSetRootElement ()

xmlNodePtr  xmlDocSetRootElement            (xmlDocPtr doc,
-                                             xmlNodePtr root);

Set the root element of the document (doc->children is a list -containing possibly comments, PIs, etc ...).

doc : 
root : 
Returns : 

xmlNodeSetName ()

void        xmlNodeSetName                  (xmlNodePtr cur,
-                                             const xmlChar *name);

Set (or reset) the name of a node.

cur : 
name : 

xmlAddChild ()

xmlNodePtr  xmlAddChild                     (xmlNodePtr parent,
-                                             xmlNodePtr cur);

Add a new node to parent, at the end of the child (or property) list -merging adjacent TEXT nodes (in which case cur is freed) + xmlEncodeEntitiesReentrant(). Use xmlNewTextChild() if entities + support is not needed.

+ +

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

xmlNewTextChild ()

xmlNodePtr  xmlNewTextChild                 (xmlNodePtr parent,
+                                             xmlNsPtr ns,
+                                             const xmlChar *name,
+                                             const xmlChar *content);

+Creation of a new child element, added at the end of parent children list. +ns and content parameters are optional (NULL). If content is non NULL, +a child TEXT node will be created containing the string content.

+ +

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

xmlNewDocText ()

xmlNodePtr  xmlNewDocText                   (xmlDocPtr doc,
+                                             const xmlChar *content);

+Creation of a new text node within a document.

+ +

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

xmlNewText ()

xmlNodePtr  xmlNewText                      (const xmlChar *content);

+Creation of a new text node.

+ +

content : the text content +
Returns :a pointer to the new node object. +

xmlNewPI ()

xmlNodePtr  xmlNewPI                        (const xmlChar *name,
+                                             const xmlChar *content);

+Creation of a processing instruction element.

+ +

name : the processing instruction name +
content : the PI content +
Returns :a pointer to the new node object. +

xmlNewDocTextLen ()

xmlNodePtr  xmlNewDocTextLen                (xmlDocPtr doc,
+                                             const xmlChar *content,
+                                             int len);

+Creation of a new text node with an extra content length parameter. The +text node pertain to a given document.

+ +

doc : the document +
content : the text content +
len : the text len. +
Returns :a pointer to the new node object. +

xmlNewTextLen ()

xmlNodePtr  xmlNewTextLen                   (const xmlChar *content,
+                                             int len);

+Creation of a new text node with an extra parameter for the content's length

+ +

content : the text content +
len : the text len. +
Returns :a pointer to the new node object. +

xmlNewDocComment ()

xmlNodePtr  xmlNewDocComment                (xmlDocPtr doc,
+                                             const xmlChar *content);

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

+ +

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

xmlNewComment ()

xmlNodePtr  xmlNewComment                   (const xmlChar *content);

+Creation of a new node containing a comment.

+ +

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

xmlNewCDataBlock ()

xmlNodePtr  xmlNewCDataBlock                (xmlDocPtr doc,
+                                             const xmlChar *content,
+                                             int len);

+Creation of a new node containing a CDATA block.

+ +

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

xmlNewCharRef ()

xmlNodePtr  xmlNewCharRef                   (xmlDocPtr doc,
+                                             const xmlChar *name);

+Creation of a new character reference node.

+ +

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

xmlNewReference ()

xmlNodePtr  xmlNewReference                 (xmlDocPtr doc,
+                                             const xmlChar *name);

+Creation of a new reference node.

+ +

doc : the document +
name : the reference name, or the reference string with & and ; +
Returns :a pointer to the new node object. +

xmlCopyNode ()

xmlNodePtr  xmlCopyNode                     (const xmlNodePtr node,
+                                             int recursive);

+Do a copy of the node.

+ +

node : the node +
recursive : if 1 do a recursive copy. +
Returns : a new xmlNodePtr, or NULL in case of error. +

xmlDocCopyNode ()

xmlNodePtr  xmlDocCopyNode                  (const xmlNodePtr node,
+                                             xmlDocPtr doc,
+                                             int recursive);

+Do a copy of the node to a given document.

+ +

node : the node +
doc : the document +
recursive : if 1 do a recursive copy. +
Returns : a new xmlNodePtr, or NULL in case of error. +

xmlCopyNodeList ()

xmlNodePtr  xmlCopyNodeList                 (const xmlNodePtr node);

+Do a recursive copy of the node list.

+ +

node : the first node in the list. +
Returns : a new xmlNodePtr, or NULL in case of error. +

xmlNewDocFragment ()

xmlNodePtr  xmlNewDocFragment               (xmlDocPtr doc);

+Creation of a new Fragment node.

+ +

doc : the document owning the fragment +
Returns :a pointer to the new node object. +

xmlGetLineNo ()

long        xmlGetLineNo                    (xmlNodePtr node);

+Get line number of node. this requires activation of this option +before invoking the parser by calling xmlLineNumbersDefault(1)

+ +

node : valid node +
Returns :the line number if successful, -1 otherwise +

xmlGetNodePath ()

xmlChar*    xmlGetNodePath                  (xmlNodePtr node);

+Build a structure based Path for the given node

+ +

node : a node +
Returns :the new path or NULL in case of error. The caller must free + the returned string +

xmlDocGetRootElement ()

xmlNodePtr  xmlDocGetRootElement            (xmlDocPtr doc);

+Get the root element of the document (doc->children is a list +containing possibly comments, PIs, etc ...).

+ +

doc : the document +
Returns :the xmlNodePtr for the root or NULL +

xmlGetLastChild ()

xmlNodePtr  xmlGetLastChild                 (xmlNodePtr parent);

+Search the last child of a node.

+ +

parent : the parent node +
Returns :the last child or NULL if none. +

xmlNodeIsText ()

int         xmlNodeIsText                   (xmlNodePtr node);

+Is this node a Text node ?

+ +

node : the node +
Returns :1 yes, 0 no +

xmlIsBlankNode ()

int         xmlIsBlankNode                  (xmlNodePtr node);

+Checks whether this node is an empty or whitespace only +(and possibly ignorable) text-node.

+ +

node : the node +
Returns :1 yes, 0 no +

xmlDocSetRootElement ()

xmlNodePtr  xmlDocSetRootElement            (xmlDocPtr doc,
+                                             xmlNodePtr root);

+Set the root element of the document (doc->children is a list +containing possibly comments, PIs, etc ...).

+ +

doc : the document +
root : the new document root element +
Returns :the old root element if any was found +

xmlNodeSetName ()

void        xmlNodeSetName                  (xmlNodePtr cur,
+                                             const xmlChar *name);

+Set (or reset) the name of a node.

+ +

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

xmlAddChild ()

xmlNodePtr  xmlAddChild                     (xmlNodePtr parent,
+                                             xmlNodePtr cur);

+Add a new node to parent, at the end of the child (or property) list +merging adjacent TEXT nodes (in which case cur is freed) 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.

parent : 
cur : 
Returns : 

xmlAddChildList ()

xmlNodePtr  xmlAddChildList                 (xmlNodePtr parent,
-                                             xmlNodePtr cur);

Add a list of node at the end of the child list of the parent -merging adjacent TEXT nodes (cur may be freed)

parent : 
cur : 
Returns : 

xmlReplaceNode ()

xmlNodePtr  xmlReplaceNode                  (xmlNodePtr old,
-                                             xmlNodePtr cur);

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

old : 
cur : 
Returns : 

xmlAddSibling ()

xmlNodePtr  xmlAddSibling                   (xmlNodePtr cur,
-                                             xmlNodePtr elem);

Add a new element elem to the list of siblings of cur -merging adjacent TEXT nodes (elem may be freed) +If there is an attribute with equal name, it is first destroyed.

+ +

parent : the parent node +
cur : the child node +
Returns :the child or NULL in case of error. +

xmlAddChildList ()

xmlNodePtr  xmlAddChildList                 (xmlNodePtr parent,
+                                             xmlNodePtr cur);

+Add a list of node at the end of the child list of the parent +merging adjacent TEXT nodes (cur may be freed)

+ +

parent : the parent node +
cur : the first node in the list +
Returns :the last child or NULL in case of error. +

xmlReplaceNode ()

xmlNodePtr  xmlReplaceNode                  (xmlNodePtr old,
+                                             xmlNodePtr cur);

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

+ +

old : the old node +
cur : the node +
Returns :the old node +

xmlAddSibling ()

xmlNodePtr  xmlAddSibling                   (xmlNodePtr cur,
+                                             xmlNodePtr elem);

+Add a new element elem to the list of siblings of cur +merging adjacent TEXT nodes (elem may be freed) If the new element was already inserted in a document it is -first unlinked from its existing context.

cur : 
elem : 
Returns : 

xmlAddPrevSibling ()

xmlNodePtr  xmlAddPrevSibling               (xmlNodePtr cur,
-                                             xmlNodePtr elem);

Add a new node elem as the previous sibling of cur -merging adjacent TEXT nodes (elem may be freed) +first unlinked from its existing context.

+ +

cur : the child node +
elem : the new node +
Returns :the new element or NULL in case of error. +

xmlAddPrevSibling ()

xmlNodePtr  xmlAddPrevSibling               (xmlNodePtr cur,
+                                             xmlNodePtr elem);

+Add a new node elem as the previous sibling of cur +merging adjacent TEXT nodes (elem may be 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.

cur : 
elem : 
Returns : 

xmlAddNextSibling ()

xmlNodePtr  xmlAddNextSibling               (xmlNodePtr cur,
-                                             xmlNodePtr elem);

Add a new node elem as the next sibling of cur +If there is an attribute with equal name, it is first destroyed.

+ +

cur : the child node +
elem : the new node +
Returns :the new node or NULL in case of error. +

xmlAddNextSibling ()

xmlNodePtr  xmlAddNextSibling               (xmlNodePtr cur,
+                                             xmlNodePtr elem);

+Add a new node elem as the next sibling of cur If the new node was already inserted in a document it is first unlinked from its existing context. -As a result of text merging elem may be freed. +As a result of text merging elem may be freed. 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.

cur : 
elem : 
Returns : 

xmlUnlinkNode ()

void        xmlUnlinkNode                   (xmlNodePtr cur);

Unlink a node from it's current context, the node is not freed

cur : 

xmlTextMerge ()

xmlNodePtr  xmlTextMerge                    (xmlNodePtr first,
-                                             xmlNodePtr second);

Merge two text nodes into one

first : 
second : 
Returns : 

xmlTextConcat ()

void        xmlTextConcat                   (xmlNodePtr node,
-                                             const xmlChar *content,
-                                             int len);

Concat the given string at the end of the existing node content

node : 
content : 
len : 

xmlFreeNodeList ()

void        xmlFreeNodeList                 (xmlNodePtr cur);

Free a node and all its siblings, this is a recursive behaviour, all -the children are freed too.

cur : 

xmlFreeNode ()

void        xmlFreeNode                     (xmlNodePtr cur);

Free a node, this is a recursive behaviour, all the children are freed too. -This doesn't unlink the child from the list, use xmlUnlinkNode() first.

cur : 

xmlSetTreeDoc ()

void        xmlSetTreeDoc                   (xmlNodePtr tree,
-                                             xmlDocPtr doc);

update all nodes under the tree to point to the right document

tree : 
doc : 

xmlSetListDoc ()

void        xmlSetListDoc                   (xmlNodePtr list,
-                                             xmlDocPtr doc);

update all nodes in the list to point to the right document

list : 
doc : 

xmlSearchNs ()

xmlNsPtr    xmlSearchNs                     (xmlDocPtr doc,
-                                             xmlNodePtr node,
-                                             const xmlChar *nameSpace);

Search a Ns registered under a given name space for a document. +If there is an attribute with equal name, it is first destroyed.

+ +

cur : the child node +
elem : the new node +
Returns :the new node or NULL in case of error. +

xmlUnlinkNode ()

void        xmlUnlinkNode                   (xmlNodePtr cur);

+Unlink a node from it's current context, the node is not freed

+ +

cur : the node +

xmlTextMerge ()

xmlNodePtr  xmlTextMerge                    (xmlNodePtr first,
+                                             xmlNodePtr second);

+Merge two text nodes into one

+ +

first : the first text node +
second : the second text node being merged +
Returns :the first text node augmented +

xmlTextConcat ()

int         xmlTextConcat                   (xmlNodePtr node,
+                                             const xmlChar *content,
+                                             int len);

+Concat the given string at the end of the existing node content

+ +

node : the node +
content : the content +
len : content length +
Returns :-1 in case of error, 0 otherwise +

xmlFreeNodeList ()

void        xmlFreeNodeList                 (xmlNodePtr cur);

+Free a node and all its siblings, this is a recursive behaviour, all +the children are freed too.

+ +

cur : the first node in the list +

xmlFreeNode ()

void        xmlFreeNode                     (xmlNodePtr cur);

+Free a node, this is a recursive behaviour, all the children are freed too. +This doesn't unlink the child from the list, use xmlUnlinkNode() first.

+ +

cur : the node +

xmlSetTreeDoc ()

void        xmlSetTreeDoc                   (xmlNodePtr tree,
+                                             xmlDocPtr doc);

+update all nodes under the tree to point to the right document

+ +

tree : the top element +
doc : the document +

xmlSetListDoc ()

void        xmlSetListDoc                   (xmlNodePtr list,
+                                             xmlDocPtr doc);

+update all nodes in the list to point to the right document

+ +

list : the first element +
doc : the document +

xmlSearchNs ()

xmlNsPtr    xmlSearchNs                     (xmlDocPtr doc,
+                                             xmlNodePtr node,
+                                             const xmlChar *nameSpace);

+Search a Ns registered under a given name space for a document. recurse on the parents until it finds the defined namespace or return NULL otherwise. -nameSpace can be NULL, this is a search for the default namespace. +nameSpace can be NULL, this is a search for the default namespace. We don't allow to cross entities boundaries. If you don't declare the namespace within those you will be in troubles !!! A warning -is generated to cover this case.

doc : 
node : 
nameSpace : 
Returns : 

xmlSearchNsByHref ()

xmlNsPtr    xmlSearchNsByHref               (xmlDocPtr doc,
-                                             xmlNodePtr node,
-                                             const xmlChar *href);

Search a Ns aliasing a given URI. Recurse on the parents until it finds -the defined namespace or return NULL otherwise.

doc : 
node : 
href : 
Returns : 

xmlGetNsList ()

xmlNsPtr*   xmlGetNsList                    (xmlDocPtr doc,
-                                             xmlNodePtr node);

Search all the namespace applying to a given element.

doc : 
node : 
Returns : 

xmlSetNs ()

void        xmlSetNs                        (xmlNodePtr node,
-                                             xmlNsPtr ns);

Associate a namespace to a node, a posteriori.

node : 
ns : 

xmlCopyNamespace ()

xmlNsPtr    xmlCopyNamespace                (xmlNsPtr cur);

Do a copy of the namespace.

cur : 
Returns : 

xmlCopyNamespaceList ()

xmlNsPtr    xmlCopyNamespaceList            (xmlNsPtr cur);

Do a copy of an namespace list.

cur : 
Returns : 

xmlSetProp ()

xmlAttrPtr  xmlSetProp                      (xmlNodePtr node,
-                                             const xmlChar *name,
-                                             const xmlChar *value);

Set (or reset) an attribute carried by a node.

node : 
name : 
value : 
Returns : 

xmlGetProp ()

xmlChar*    xmlGetProp                      (xmlNodePtr node,
-                                             const xmlChar *name);

Search and get the value of an attribute associated to a node +is generated to cover this case.

+ +

doc : the document +
node : the current node +
nameSpace : the namespace prefix +
Returns :the namespace pointer or NULL. +

xmlSearchNsByHref ()

xmlNsPtr    xmlSearchNsByHref               (xmlDocPtr doc,
+                                             xmlNodePtr node,
+                                             const xmlChar *href);

+Search a Ns aliasing a given URI. Recurse on the parents until it finds +the defined namespace or return NULL otherwise.

+ +

doc : the document +
node : the current node +
href : the namespace value +
Returns :the namespace pointer or NULL. +

xmlGetNsList ()

xmlNsPtr*   xmlGetNsList                    (xmlDocPtr doc,
+                                             xmlNodePtr node);

+Search all the namespace applying to a given element.

+ +

doc : the document +
node : the current node +
Returns :an NULL terminated array of all the xmlNsPtr found + that need to be freed by the caller or NULL if no + namespace if defined +

xmlSetNs ()

void        xmlSetNs                        (xmlNodePtr node,
+                                             xmlNsPtr ns);

+Associate a namespace to a node, a posteriori.

+ +

node : a node in the document +
ns : a namespace pointer +

xmlCopyNamespace ()

xmlNsPtr    xmlCopyNamespace                (xmlNsPtr cur);

+Do a copy of the namespace.

+ +

cur : the namespace +
Returns : a new xmlNsPtr, or NULL in case of error. +

xmlCopyNamespaceList ()

xmlNsPtr    xmlCopyNamespaceList            (xmlNsPtr cur);

+Do a copy of an namespace list.

+ +

cur : the first namespace +
Returns : a new xmlNsPtr, or NULL in case of error. +

xmlSetProp ()

xmlAttrPtr  xmlSetProp                      (xmlNodePtr node,
+                                             const xmlChar *name,
+                                             const xmlChar *value);

+Set (or reset) an attribute carried by a node.

+ +

node : the node +
name : the attribute name +
value : the attribute value +
Returns :the attribute pointer. +

xmlGetProp ()

xmlChar*    xmlGetProp                      (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 +This function looks in DTD attribute declaration for FIXED or default declaration values unless DTD use has been turned off. NOTE: this function acts independently of namespaces associated - to the attribute. Use xmlGetNsProp() or xmlGetNoNsProp() - for namespace aware processing.

node : 
name : 
Returns : 

xmlGetNoNsProp ()

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

Search and get the value of an attribute associated to a node + to the attribute. Use xmlGetNsProp() or xmlGetNoNsProp() + for namespace aware processing.

+ +

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(). +

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 +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 : 
name : 
Returns : 

xmlHasProp ()

xmlAttrPtr  xmlHasProp                      (xmlNodePtr node,
-                                             const xmlChar *name);

Search an attribute associated to a node -This function also looks in DTD attribute declaration for FIXED or -default declaration values unless DTD use has been turned off.

node : 
name : 
Returns : 

xmlHasNsProp ()

xmlAttrPtr  xmlHasNsProp                    (xmlNodePtr node,
-                                             const xmlChar *name,
-                                             const xmlChar *nameSpace);

Search for an attribute associated to a node +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(). +

xmlHasProp ()

xmlAttrPtr  xmlHasProp                      (xmlNodePtr node,
+                                             const xmlChar *name);

+Search an attribute associated to a node +This function also looks in DTD attribute declaration for FIXED or +default declaration values unless DTD use has been turned off.

+ +

node : the node +
name : the attribute name +
Returns :the attribute or the attribute declaration or NULL if + neither was found. +

xmlHasNsProp ()

xmlAttrPtr  xmlHasNsProp                    (xmlNodePtr node,
+                                             const xmlChar *name,
+                                             const xmlChar *nameSpace);

+Search for an attribute associated to a node This attribute has to be anchored in the namespace specified. 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.

node : 
name : 
nameSpace : 
Returns : 

xmlSetNsProp ()

xmlAttrPtr  xmlSetNsProp                    (xmlNodePtr node,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *value);

Set (or reset) an attribute carried by a node. -The ns structure must be in scope, this is not checked.

node : 
ns : 
name : 
value : 
Returns : 

xmlGetNsProp ()

xmlChar*    xmlGetNsProp                    (xmlNodePtr node,
-                                             const xmlChar *name,
-                                             const xmlChar *nameSpace);

Search and get the value of an attribute associated to a node +This function looks in DTD attribute declaration for FIXED or +default declaration values unless DTD use has been turned off.

+ +

node : the node +
name : the attribute name +
nameSpace : the URI of the namespace +
Returns :the attribute or the attribute declaration or NULL + if neither was found. +

xmlSetNsProp ()

xmlAttrPtr  xmlSetNsProp                    (xmlNodePtr node,
+                                             xmlNsPtr ns,
+                                             const xmlChar *name,
+                                             const xmlChar *value);

+Set (or reset) an attribute carried by a node. +The ns structure must be in scope, this is not checked.

+ +

node : the node +
ns : the namespace definition +
name : the attribute name +
value : the attribute value +
Returns :the attribute pointer. +

xmlGetNsProp ()

xmlChar*    xmlGetNsProp                    (xmlNodePtr node,
+                                             const xmlChar *name,
+                                             const xmlChar *nameSpace);

+Search and get the value of an attribute associated to a node This attribute has to be anchored in the namespace specified. 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.

node : 
name : 
nameSpace : 
Returns : 

xmlStringGetNodeList ()

xmlNodePtr  xmlStringGetNodeList            (xmlDocPtr doc,
-                                             const xmlChar *value);

Parse the value string and build the node list associated. Should -produce a flat tree with only TEXTs and ENTITY_REFs.

doc : 
value : 
Returns : 

xmlStringLenGetNodeList ()

xmlNodePtr  xmlStringLenGetNodeList         (xmlDocPtr doc,
-                                             const xmlChar *value,
-                                             int len);

Parse the value string and build the node list associated. Should -produce a flat tree with only TEXTs and ENTITY_REFs.

doc : 
value : 
len : 
Returns : 

xmlNodeListGetString ()

xmlChar*    xmlNodeListGetString            (xmlDocPtr doc,
-                                             xmlNodePtr list,
-                                             int inLine);

Build the string equivalent to the text contained in the Node list -made of TEXTs and ENTITY_REFs

doc : 
list : 
inLine : 
Returns : 

xmlNodeListGetRawString ()

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

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

doc : 
list : 
inLine : 
Returns : 

xmlNodeSetContent ()

void        xmlNodeSetContent               (xmlNodePtr cur,
-                                             const xmlChar *content);

Replace the content of a node.

cur : 
content : 

xmlNodeSetContentLen ()

void        xmlNodeSetContentLen            (xmlNodePtr cur,
-                                             const xmlChar *content,
-                                             int len);

Replace the content of a node.

cur : 
content : 
len : 

xmlNodeAddContent ()

void        xmlNodeAddContent               (xmlNodePtr cur,
-                                             const xmlChar *content);

Append the extra substring to the node content.

cur : 
content : 

xmlNodeAddContentLen ()

void        xmlNodeAddContentLen            (xmlNodePtr cur,
-                                             const xmlChar *content,
-                                             int len);

Append the extra substring to the node content.

cur : 
content : 
len : 

xmlNodeGetContent ()

xmlChar*    xmlNodeGetContent               (xmlNodePtr cur);

Read the value of a node, this can be either the text carried +This function looks in DTD attribute declaration for FIXED or +default declaration values unless DTD use has been turned off.

+ +

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

xmlStringGetNodeList ()

xmlNodePtr  xmlStringGetNodeList            (xmlDocPtr doc,
+                                             const xmlChar *value);

+Parse the value string and build the node list associated. Should +produce a flat tree with only TEXTs and ENTITY_REFs.

+ +

doc : the document +
value : the value of the attribute +
Returns :a pointer to the first child +

xmlStringLenGetNodeList ()

xmlNodePtr  xmlStringLenGetNodeList         (xmlDocPtr doc,
+                                             const xmlChar *value,
+                                             int len);

+Parse the value string and build the node list associated. Should +produce a flat tree with only TEXTs and ENTITY_REFs.

+ +

doc : the document +
value : the value of the text +
len : the length of the string value +
Returns :a pointer to the first child +

xmlNodeListGetString ()

xmlChar*    xmlNodeListGetString            (xmlDocPtr doc,
+                                             xmlNodePtr list,
+                                             int inLine);

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

+ +

doc : the document +
list : a Node list +
inLine : should we replace entity contents or show their external form +
Returns :a pointer to the string copy, the caller must free it with xmlFree(). +

xmlNodeListGetRawString ()

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

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

+ +

doc : the document +
list : a Node list +
inLine : should we replace entity contents or show their external form +
Returns :a pointer to the string copy, the caller must free it with xmlFree(). +

xmlNodeSetContent ()

void        xmlNodeSetContent               (xmlNodePtr cur,
+                                             const xmlChar *content);

+Replace the content of a node.

+ +

cur : the node being modified +
content : the new value of the content +

xmlNodeSetContentLen ()

void        xmlNodeSetContentLen            (xmlNodePtr cur,
+                                             const xmlChar *content,
+                                             int len);

+Replace the content of a node.

+ +

cur : the node being modified +
content : the new value of the content +
len : the size of content +

xmlNodeAddContent ()

void        xmlNodeAddContent               (xmlNodePtr cur,
+                                             const xmlChar *content);

+Append the extra substring to the node content.

+ +

cur : the node being modified +
content : extra content +

xmlNodeAddContentLen ()

void        xmlNodeAddContentLen            (xmlNodePtr cur,
+                                             const xmlChar *content,
+                                             int len);

+Append the extra substring to the node content.

+ +

cur : the node being modified +
content : extra content +
len : the size of content +

xmlNodeGetContent ()

xmlChar*    xmlNodeGetContent               (xmlNodePtr cur);

+Read the value of a node, this can be either the text carried directly by this node if it's a TEXT node or the aggregate string of the values carried by this node child's (TEXT and ENTITY_REF). -Entity references are substituted.

cur : 
Returns : 

xmlNodeGetLang ()

xmlChar*    xmlNodeGetLang                  (xmlNodePtr cur);

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

cur : 
Returns : 

xmlNodeSetLang ()

void        xmlNodeSetLang                  (xmlNodePtr cur,
-                                             const xmlChar *lang);

Set the language of a node, i.e. the values of the xml:lang -attribute.

cur : 
lang : 

xmlNodeGetSpacePreserve ()

int         xmlNodeGetSpacePreserve         (xmlNodePtr cur);

Searches the space preserving behaviour of a node, i.e. the values +Entity references are substituted.

+ +

cur : the node being read +
Returns :a new xmlChar * or NULL if no content is available. + It's up to the caller to free the memory with xmlFree(). +

xmlNodeGetLang ()

xmlChar*    xmlNodeGetLang                  (xmlNodePtr cur);

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

+ +

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

xmlNodeSetLang ()

void        xmlNodeSetLang                  (xmlNodePtr cur,
+                                             const xmlChar *lang);

+Set the language of a node, i.e. the values of the xml:lang +attribute.

+ +

cur : the node being changed +
lang : the language description +

xmlNodeGetSpacePreserve ()

int         xmlNodeGetSpacePreserve         (xmlNodePtr cur);

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

cur : 
Returns : 

xmlNodeSetSpacePreserve ()

void        xmlNodeSetSpacePreserve         (xmlNodePtr cur,
-                                             int val);

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

cur : 
val : 

xmlNodeGetBase ()

xmlChar*    xmlNodeGetBase                  (xmlDocPtr doc,
-                                             xmlNodePtr cur);

Searches for the BASE URL. The code should work on both XML +ancestor.

+ +

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

xmlNodeSetSpacePreserve ()

void        xmlNodeSetSpacePreserve         (xmlNodePtr cur,
+                                             int val);

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

+ +

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

xmlNodeGetBase ()

xmlChar*    xmlNodeGetBase                  (xmlDocPtr doc,
+                                             xmlNodePtr cur);

+Searches for the BASE URL. The code should work on both XML and HTML document even if base mechanisms are completely different. It returns the base as defined in RFC 2396 sections 5.1.1. Base URI within Document Content and 5.1.2. Base URI from the Encapsulating Entity However it does not return the document base (5.1.3), use -xmlDocumentGetBase() for this

doc : 
cur : 
Returns : 

xmlNodeSetBase ()

void        xmlNodeSetBase                  (xmlNodePtr cur,
-                                             xmlChar *uri);

Set (or reset) the base URI of a node, i.e. the value of the -xml:base attribute.

cur : 
uri : 

xmlRemoveProp ()

int         xmlRemoveProp                   (xmlAttrPtr cur);

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

cur : 
Returns : 

xmlUnsetProp ()

int         xmlUnsetProp                    (xmlNodePtr node,
-                                             const xmlChar *name);

Remove an attribute carried by a node.

node : 
name : 
Returns : 

xmlUnsetNsProp ()

int         xmlUnsetNsProp                  (xmlNodePtr node,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name);

Remove an attribute carried by a node.

node : 
ns : 
name : 
Returns : 

xmlBufferWriteCHAR ()

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

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

buf : 
string : 

xmlBufferWriteChar ()

void        xmlBufferWriteChar              (xmlBufferPtr buf,
-                                             const char *string);

routine which manage and grows an output buffer. This one add -C chars at the end of the array.

buf : 
string : 

xmlBufferWriteQuotedString ()

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

routine which manage and grows an output buffer. This one writes -a quoted or double quoted xmlChar string, checking first if it holds -quote or double-quotes internally

buf : 
string : 

xmlReconciliateNs ()

int         xmlReconciliateNs               (xmlDocPtr doc,
-                                             xmlNodePtr tree);

This function checks that all the namespaces declared within the given +xmlDocumentGetBase() for this

+ +

doc : the document the node pertains to +
cur : the node being checked +
Returns :a pointer to the base URL, or NULL if not found + It's up to the caller to free the memory with xmlFree(). +

xmlNodeSetBase ()

void        xmlNodeSetBase                  (xmlNodePtr cur,
+                                             xmlChar *uri);

+Set (or reset) the base URI of a node, i.e. the value of the +xml:base attribute.

+ +

cur : the node being changed +
uri : the new base URI +

xmlRemoveProp ()

int         xmlRemoveProp                   (xmlAttrPtr cur);

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

+ +

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

xmlUnsetProp ()

int         xmlUnsetProp                    (xmlNodePtr node,
+                                             const xmlChar *name);

+Remove an attribute carried by a node.

+ +

node : the node +
name : the attribute name +
Returns :0 if successful, -1 if not found +

xmlUnsetNsProp ()

int         xmlUnsetNsProp                  (xmlNodePtr node,
+                                             xmlNsPtr ns,
+                                             const xmlChar *name);

+Remove an attribute carried by a node.

+ +

node : the node +
ns : the namespace definition +
name : the attribute name +
Returns :0 if successful, -1 if not found +

xmlBufferWriteCHAR ()

void        xmlBufferWriteCHAR              (xmlBufferPtr buf,
+                                             const xmlChar *string);

+routine which manages and grows an output buffer. This one adds +xmlChars at the end of the buffer.

+ +

buf : the XML buffer +
string : the string to add +

xmlBufferWriteChar ()

void        xmlBufferWriteChar              (xmlBufferPtr buf,
+                                             const char *string);

+routine which manage and grows an output buffer. This one add +C chars at the end of the array.

+ +

buf : the XML buffer output +
string : the string to add +

xmlBufferWriteQuotedString ()

void        xmlBufferWriteQuotedString      (xmlBufferPtr buf,
+                                             const xmlChar *string);

+routine which manage and grows an output buffer. This one writes +a quoted or double quoted xmlChar string, checking first if it holds +quote or double-quotes internally

+ +

buf : the XML buffer output +
string : the string to add +

xmlReconciliateNs ()

int         xmlReconciliateNs               (xmlDocPtr doc,
+                                             xmlNodePtr tree);

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

doc : 
tree : 
Returns : 

xmlDocDumpFormatMemory ()

void        xmlDocDumpFormatMemory          (xmlDocPtr cur,
-                                             xmlChar **mem,
+on tree at the top of the given subtree.

+
+
doc :  the document
+
tree :  a node defining the subtree to reconciliate
+
Returns :the number of namespace declarations created or -1 in case of error.
+
xmlDocDumpFormatMemory ()
void        xmlDocDumpFormatMemory          (xmlDocPtr cur,
+                                             xmlChar **mem,
                                              int *size,
-                                             int format);

Dump an XML document in memory and return the xmlChar * and it's size. -It's up to the caller to free the memory with xmlFree(). -Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1 -or xmlKeepBlanksDefault(0) was called

cur : 
mem : 
size : 
format : 

xmlDocDumpMemory ()

void        xmlDocDumpMemory                (xmlDocPtr cur,
-                                             xmlChar **mem,
-                                             int *size);

Dump an XML document in memory and return the xmlChar * and it's size. -It's up to the caller to free the memory with xmlFree().

cur : 
mem : 
size : 

xmlDocDumpMemoryEnc ()

void        xmlDocDumpMemoryEnc             (xmlDocPtr out_doc,
-                                             xmlChar **doc_txt_ptr,
+                                             int format);

+Dump an XML document in memory and return the xmlChar * and it's size. +It's up to the caller to free the memory with xmlFree(). +Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1 +or xmlKeepBlanksDefault(0) was called

+ +

cur : the document +
mem : OUT: the memory pointer +
size : OUT: the memory length +
format : should formatting spaces been added +

xmlDocDumpMemory ()

void        xmlDocDumpMemory                (xmlDocPtr cur,
+                                             xmlChar **mem,
+                                             int *size);

+Dump an XML document in memory and return the xmlChar * and it's size. +It's up to the caller to free the memory with xmlFree().

+ +

cur : the document +
mem : OUT: the memory pointer +
size : OUT: the memory length +

xmlDocDumpMemoryEnc ()

void        xmlDocDumpMemoryEnc             (xmlDocPtr out_doc,
+                                             xmlChar **doc_txt_ptr,
                                              int *doc_txt_len,
-                                             const char *txt_encoding);

Dump the current DOM tree into memory using the character encoding specified + const char *txt_encoding);

+Dump the current DOM tree into memory using the character encoding specified by the caller. Note it is up to the caller of this function to free the -allocated memory with xmlFree().

out_doc : 
doc_txt_ptr : 
doc_txt_len : 
txt_encoding : 

xmlDocDumpFormatMemoryEnc ()

void        xmlDocDumpFormatMemoryEnc       (xmlDocPtr out_doc,
-                                             xmlChar **doc_txt_ptr,
+allocated memory with xmlFree().

+
+
out_doc :  Document to generate XML text from
+
doc_txt_ptr :  Memory pointer for allocated XML text
+
doc_txt_len :  Length of the generated XML text
+
txt_encoding :  Character encoding to use when generating XML text
+
xmlDocDumpFormatMemoryEnc ()
void        xmlDocDumpFormatMemoryEnc       (xmlDocPtr out_doc,
+                                             xmlChar **doc_txt_ptr,
                                              int *doc_txt_len,
                                              const char *txt_encoding,
-                                             int format);

Dump the current DOM tree into memory using the character encoding specified + int format);

+Dump the current DOM tree into memory using the character encoding specified by the caller. Note it is up to the caller of this function to free the -allocated memory with xmlFree(). -Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1 -or xmlKeepBlanksDefault(0) was called

out_doc : 
doc_txt_ptr : 
doc_txt_len : 
txt_encoding : 
format : 

xmlDocFormatDump ()

int         xmlDocFormatDump                (FILE *f,
-                                             xmlDocPtr cur,
-                                             int format);

Dump an XML document to an open FILE.

f : 
cur : 
format : 
Returns : 

xmlDocDump ()

int         xmlDocDump                      (FILE *f,
-                                             xmlDocPtr cur);

Dump an XML document to an open FILE.

f : 
cur : 
Returns : 

xmlElemDump ()

void        xmlElemDump                     (FILE *f,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur);

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

f : 
doc : 
cur : 

xmlSaveFile ()

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

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

filename : 
cur : 
Returns : 

xmlSaveFormatFile ()

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

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

filename : 
cur : 
format : 
Returns : 

xmlNodeDump ()

int         xmlNodeDump                     (xmlBufferPtr buf,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur,
+allocated memory with xmlFree().
+Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
+or xmlKeepBlanksDefault(0) was called

+
+
out_doc :  Document to generate XML text from
+
doc_txt_ptr :  Memory pointer for allocated XML text
+
doc_txt_len :  Length of the generated XML text
+
txt_encoding :  Character encoding to use when generating XML text
+
format :  should formatting spaces been added
+
xmlDocFormatDump ()
int         xmlDocFormatDump                (FILE *f,
+                                             xmlDocPtr cur,
+                                             int format);

+Dump an XML document to an open FILE.

+
+
f :  the FILE*
+
cur :  the document
+
format : should formatting spaces been added
+
Returns : 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
+
xmlDocDump ()
int         xmlDocDump                      (FILE *f,
+                                             xmlDocPtr cur);

+Dump an XML document to an open FILE.

+
+
f :  the FILE*
+
cur :  the document
+
Returns : the number of bytes written or -1 in case of failure.
+
xmlElemDump ()
void        xmlElemDump                     (FILE *f,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr cur);

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

+
+
f :  the FILE * for the output
+
doc :  the document
+
cur :  the current node
+
xmlSaveFile ()
int         xmlSaveFile                     (const char *filename,
+                                             xmlDocPtr cur);

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

+
+
filename :  the filename (or URL)
+
cur :  the document
+
Returns : the number of bytes written or -1 in case of failure.
+
xmlSaveFormatFile ()
int         xmlSaveFormatFile               (const char *filename,
+                                             xmlDocPtr cur,
+                                             int format);

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

+
+
filename :  the filename (or URL)
+
cur :  the document
+
format :  should formatting spaces been added
+
Returns : the number of bytes written or -1 in case of failure.
+
xmlNodeDump ()
int         xmlNodeDump                     (xmlBufferPtr buf,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr cur,
                                              int level,
-                                             int format);

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

buf : 
doc : 
cur : 
level : 
format : 
Returns : 

xmlSaveFileTo ()

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

Dump an XML document to an I/O buffer.

buf : 
cur : 
encoding : 
Returns : 

xmlSaveFormatFileTo ()

int         xmlSaveFormatFileTo             (xmlOutputBufferPtr buf,
-                                             xmlDocPtr cur,
+                                             int format);

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

+ +

buf : the XML buffer output +
doc : the document +
cur : the current node +
level : the imbrication level for indenting +
format : is formatting allowed +
Returns :the number of bytes written to the buffer or -1 in case of error +

xmlSaveFileTo ()

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

+Dump an XML document to an I/O buffer.

+ +

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

xmlSaveFormatFileTo ()

int         xmlSaveFormatFileTo             (xmlOutputBufferPtr buf,
+                                             xmlDocPtr cur,
                                              const char *encoding,
-                                             int format);

Dump an XML document to an I/O buffer.

buf : 
cur : 
encoding : 
format : 
Returns : 

xmlNodeDumpOutput ()

void        xmlNodeDumpOutput               (xmlOutputBufferPtr buf,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur,
+                                             int format);

+Dump an XML document to an I/O buffer.

+ +

buf : an output I/O buffer +
cur : the document +
encoding : the encoding if any assuming the I/O layer handles the trancoding +
format : should formatting spaces been added +
Returns : 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 +

xmlNodeDumpOutput ()

void        xmlNodeDumpOutput               (xmlOutputBufferPtr buf,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr cur,
                                              int level,
                                              int format,
-                                             const char *encoding);

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

buf : 
doc : 
cur : 
level : 
format : 
encoding : 

xmlSaveFormatFileEnc ()

int         xmlSaveFormatFileEnc            (const char *filename,
-                                             xmlDocPtr cur,
+                                             const char *encoding);

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

+ +

buf : the XML buffer output +
doc : the document +
cur : the current node +
level : the imbrication level for indenting +
format : is formatting allowed +
encoding : an optional encoding string +

xmlSaveFormatFileEnc ()

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

Dump an XML document to a file or an URL.

filename : 
cur : 
encoding : 
format : 
Returns : 

xmlSaveFileEnc ()

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

Dump an XML document, converting it to the given encoding

filename : 
cur : 
encoding : 
Returns : 

xmlIsXHTML ()

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

Try to find if the document correspond to an XHTML DTD

systemID : 
publicID : 
Returns : 

xmlGetDocCompressMode ()

int         xmlGetDocCompressMode           (xmlDocPtr doc);

get the compression ratio for a document, ZLIB based

doc : 
Returns : 

xmlSetDocCompressMode ()

void        xmlSetDocCompressMode           (xmlDocPtr doc,
-                                             int mode);

set the compression ratio for a document, ZLIB based -Correct values: 0 (uncompressed) to 9 (max compression)

doc : 
mode : 

xmlGetCompressMode ()

int         xmlGetCompressMode              (void);

get the default compression mode used, ZLIB based.

Returns : 

xmlSetCompressMode ()

void        xmlSetCompressMode              (int mode);

set the default compression mode used, ZLIB based -Correct values: 0 (uncompressed) to 9 (max compression)

mode : 

\ No newline at end of file + int format);

+Dump an XML document to a file or an URL.

+ +

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

xmlSaveFileEnc ()

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

+Dump an XML document, converting it to the given encoding

+ +

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

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 +

xmlGetDocCompressMode ()

int         xmlGetDocCompressMode           (xmlDocPtr doc);

+get the compression ratio for a document, ZLIB based

+ +

doc : the document +
Returns :0 (uncompressed) to 9 (max compression) +

xmlSetDocCompressMode ()

void        xmlSetDocCompressMode           (xmlDocPtr doc,
+                                             int mode);

+set the compression ratio for a document, ZLIB based +Correct values: 0 (uncompressed) to 9 (max compression)

+ +

doc : the document +
mode : the compression ratio +

xmlGetCompressMode ()

int         xmlGetCompressMode              (void);

+get the default compression mode used, ZLIB based.

+ +

Returns :0 (uncompressed) to 9 (max compression) +

xmlSetCompressMode ()

void        xmlSetCompressMode              (int mode);

+set the default compression mode used, ZLIB based +Correct values: 0 (uncompressed) to 9 (max compression)

+ +

mode : the compression ratio +
<< SAXentities >>
diff --git a/doc/html/libxml-uri.html b/doc/html/libxml-uri.html index 8d0c53fe..9949fc2f 100644 --- a/doc/html/libxml-uri.html +++ b/doc/html/libxml-uri.html @@ -1,308 +1,61 @@ -uri
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

uri

Name

uri -- 

Synopsis


+
+uri
PrevUpHomeGnome XML Library Reference ManualNext
uri
uri — 
Synopsis
 
-struct      xmlURI;
-typedef     xmlURIPtr;
-xmlURIPtr   xmlCreateURI                    (void);
-xmlChar*    xmlBuildURI                     (const xmlChar *URI,
-                                             const xmlChar *base);
-xmlURIPtr   xmlParseURI                     (const char *str);
-int         xmlParseURIReference            (xmlURIPtr uri,
+
+
+struct      xmlURI;
+typedef     xmlURIPtr;
+xmlURIPtr   xmlCreateURI                    (void);
+xmlChar*    xmlBuildURI                     (const xmlChar *URI,
+                                             const xmlChar *base);
+xmlURIPtr   xmlParseURI                     (const char *str);
+int         xmlParseURIReference            (xmlURIPtr uri,
                                              const char *str);
-xmlChar*    xmlSaveUri                      (xmlURIPtr uri);
-void        xmlPrintURI                     (FILE *stream,
-                                             xmlURIPtr uri);
-xmlChar*    xmlURIEscapeStr                 (const xmlChar *str,
-                                             const xmlChar *list);
-char*       xmlURIUnescapeString            (const char *str,
+xmlChar*    xmlSaveUri                      (xmlURIPtr uri);
+void        xmlPrintURI                     (FILE *stream,
+                                             xmlURIPtr uri);
+xmlChar*    xmlURIEscapeStr                 (const xmlChar *str,
+                                             const xmlChar *list);
+char*       xmlURIUnescapeString            (const char *str,
                                              int len,
                                              char *target);
-int         xmlNormalizeURIPath             (char *path);
-xmlChar*    xmlURIEscape                    (const xmlChar *str);
-void        xmlFreeURI                      (xmlURIPtr uri);
-xmlChar*    xmlCanonicPath                  (const xmlChar *path);

Description

Details

struct xmlURI

struct xmlURI {
+int         xmlNormalizeURIPath             (char *path);
+xmlChar*    xmlURIEscape                    (const xmlChar *str);
+void        xmlFreeURI                      (xmlURIPtr uri);
+xmlChar*    xmlCanonicPath                  (const xmlChar *path);
+

Description

+ +

Details

struct xmlURI

struct xmlURI {
     char *scheme;	/* the URI scheme */
     char *opaque;	/* opaque part */
     char *authority;	/* the authority part */
@@ -313,1268 +66,107 @@ CLASS="PROGRAMLISTING"
     char *query;	/* the query string */
     char *fragment;	/* the fragment identifier */
     int  cleanup;	/* parsing potentially unclean URI */
-};

A parsed URI reference. This is a struct containing the various fields -as described in RFC 2396 but separated for further processing.

xmlURIPtr

xmlCreateURI ()

xmlURIPtr   xmlCreateURI                    (void);

Simply creates an empty xmlURI

Returns : 

xmlBuildURI ()

xmlChar*    xmlBuildURI                     (const xmlChar *URI,
-                                             const xmlChar *base);

Computes he final URI of the reference done by checking that +}; +

+A parsed URI reference. This is a struct containing the various fields +as described in RFC 2396 but separated for further processing.

+ +

xmlURIPtr

typedef xmlURI *xmlURIPtr;
+

+ +

xmlCreateURI ()

xmlURIPtr   xmlCreateURI                    (void);

+Simply creates an empty xmlURI

+ +

Returns :the new structure or NULL in case of error +

xmlBuildURI ()

xmlChar*    xmlBuildURI                     (const xmlChar *URI,
+                                             const xmlChar *base);

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

5.2. Resolving Relative References to Absolute Form

URI : 
base : 
Returns : 

xmlParseURI ()

xmlURIPtr   xmlParseURI                     (const char *str);

Parse an URI

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

str : 
Returns : 

xmlParseURIReference ()

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

Parse an URI reference string and fills in the appropriate fields -of the uri structure

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

uri : 
str : 
Returns : 

xmlSaveUri ()

xmlChar*    xmlSaveUri                      (xmlURIPtr uri);

Save the URI as an escaped string

uri : 
Returns : 

xmlPrintURI ()

void        xmlPrintURI                     (FILE *stream,
-                                             xmlURIPtr uri);

Prints the URI in the stream steam.

stream : 
uri : 

xmlURIEscapeStr ()

xmlChar*    xmlURIEscapeStr                 (const xmlChar *str,
-                                             const xmlChar *list);

This routine escapes a string to hex, ignoring reserved characters (a-z) -and the characters in the exception list.

str : 
list : 
Returns : 

xmlURIUnescapeString ()

char*       xmlURIUnescapeString            (const char *str,
+RFC 2396
+

+5.2. Resolving Relative References to Absolute Form

+
+
URI :  the URI instance found in the document
+
base :  the base value
+
Returns :a new URI string (to be freed by the caller) or NULL in case
+        of error.
+
xmlParseURI ()
xmlURIPtr   xmlParseURI                     (const char *str);

+Parse an URI 
+

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

+
+
str :  the URI string to analyze
+
Returns :a newly build xmlURIPtr or NULL in case of error
+
xmlParseURIReference ()
int         xmlParseURIReference            (xmlURIPtr uri,
+                                             const char *str);

+Parse an URI reference string and fills in the appropriate fields
+of the uri structure
+

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

+
+
uri :  pointer to an URI structure
+
str :  the string to analyze
+
Returns :0 or the error code
+
xmlSaveUri ()
xmlChar*    xmlSaveUri                      (xmlURIPtr uri);

+Save the URI as an escaped string

+
+
uri :  pointer to an xmlURI
+
Returns :a new string (to be deallocated by caller)
+
xmlPrintURI ()
void        xmlPrintURI                     (FILE *stream,
+                                             xmlURIPtr uri);

+Prints the URI in the stream steam.

+
+
stream :  a FILE* for the output
+
uri :  pointer to an xmlURI
+
xmlURIEscapeStr ()
xmlChar*    xmlURIEscapeStr                 (const xmlChar *str,
+                                             const xmlChar *list);

+This routine escapes a string to hex, ignoring reserved characters (a-z)
+and the characters in the exception list.

+
+
str :  string to escape
+
list : exception list string of chars not to escape
+
Returns :a new escaped string or NULL in case of error.
+
xmlURIUnescapeString ()
char*       xmlURIUnescapeString            (const char *str,
                                              int len,
-                                             char *target);

Unescaping routine, does not do validity checks ! -Output is direct unsigned char translation of XX values (no encoding)

str : 
len : 
target : 
Returns : 

xmlNormalizeURIPath ()

int         xmlNormalizeURIPath             (char *path);

Applies the 5 normalization steps to a path string--that is, RFC 2396 -Section 5.2, steps 6.c through 6.g.

Normalization occurs directly on the string, no new allocation is done

path : 
Returns : 

xmlURIEscape ()

xmlChar*    xmlURIEscape                    (const xmlChar *str);

Escaping routine, does not do validity checks ! + char *target);

+Unescaping routine, does not do validity checks ! +Output is direct unsigned char translation of XX values (no encoding)

+ +

str : the string to unescape +
len : the length in bytes to unescape (or <= 0 to indicate full string) +
target : optional destination buffer +
Returns :an copy of the string, but unescaped +

xmlNormalizeURIPath ()

int         xmlNormalizeURIPath             (char *path);

+Applies the 5 normalization steps to a path string--that is, RFC 2396 +Section 5.2, steps 6.c through 6.g. +

+Normalization occurs directly on the string, no new allocation is done

+ +

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

xmlURIEscape ()

xmlChar*    xmlURIEscape                    (const xmlChar *str);

+Escaping routine, does not do validity checks ! It will try to escape the chars needing this, but this is heuristic -based it's impossible to be sure.

str : 
Returns : 

xmlFreeURI ()

void        xmlFreeURI                      (xmlURIPtr uri);

Free up the xmlURI struct

uri : 

xmlCanonicPath ()

xmlChar*    xmlCanonicPath                  (const xmlChar *path);

Constructs a canonic path from the specified path.

path : 
Returns : 

\ No newline at end of file +based it's impossible to be sure.

+ +

str : the string of the URI to escape +
Returns :an copy of the string, but escaped + +25 May 2001 +Uses xmlParseURI and xmlURIEscapeStr to try to escape correctly +according to RFC2396. + - Carl Douglas +

xmlFreeURI ()

void        xmlFreeURI                      (xmlURIPtr uri);

+Free up the xmlURI struct

+ +

uri : pointer to an xmlURI +

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. +
<< relaxngxmlerror >>
diff --git a/doc/html/libxml-valid.html b/doc/html/libxml-valid.html index f8626d6d..c42985a1 100644 --- a/doc/html/libxml-valid.html +++ b/doc/html/libxml-valid.html @@ -1,1397 +1,247 @@ -valid
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

valid

Name

valid -- 

Synopsis


+
+valid
PrevUpHomeGnome XML Library Reference ManualNext
valid
valid — 
Synopsis
 
-struct      xmlValidState;
-typedef     xmlValidStatePtr;
-void        (*xmlValidityErrorFunc)         (void *ctx,
+
+
+struct      xmlValidState;
+typedef     xmlValidStatePtr;
+void        (*xmlValidityErrorFunc)         (void *ctx,
                                              const char *msg,
                                              ...);
-void        (*xmlValidityWarningFunc)       (void *ctx,
+void        (*xmlValidityWarningFunc)       (void *ctx,
                                              const char *msg,
                                              ...);
-struct      xmlValidCtxt;
-typedef     xmlValidCtxtPtr;
-typedef     xmlNotationTablePtr;
-typedef     xmlElementTablePtr;
-typedef     xmlAttributeTablePtr;
-typedef     xmlIDTablePtr;
-typedef     xmlRefTablePtr;
-xmlChar*    xmlSplitQName2                  (const xmlChar *name,
-                                             xmlChar **prefix);
-xmlNotationPtr xmlAddNotationDecl           (xmlValidCtxtPtr ctxt,
-                                             xmlDtdPtr dtd,
-                                             const xmlChar *name,
-                                             const xmlChar *PublicID,
-                                             const xmlChar *SystemID);
-xmlNotationTablePtr xmlCopyNotationTable    (xmlNotationTablePtr table);
-void        xmlFreeNotationTable            (xmlNotationTablePtr table);
-void        xmlDumpNotationDecl             (xmlBufferPtr buf,
-                                             xmlNotationPtr nota);
-void        xmlDumpNotationTable            (xmlBufferPtr buf,
-                                             xmlNotationTablePtr table);
-xmlElementContentPtr xmlNewElementContent   (xmlChar *name,
-                                             xmlElementContentType type);
-xmlElementContentPtr xmlCopyElementContent  (xmlElementContentPtr content);
-void        xmlFreeElementContent           (xmlElementContentPtr cur);
-void        xmlSnprintfElementContent       (char *buf,
+struct      xmlValidCtxt;
+typedef     xmlValidCtxtPtr;
+typedef     xmlNotationTablePtr;
+typedef     xmlElementTablePtr;
+typedef     xmlAttributeTablePtr;
+typedef     xmlIDTablePtr;
+typedef     xmlRefTablePtr;
+xmlNotationPtr xmlAddNotationDecl           (xmlValidCtxtPtr ctxt,
+                                             xmlDtdPtr dtd,
+                                             const xmlChar *name,
+                                             const xmlChar *PublicID,
+                                             const xmlChar *SystemID);
+xmlNotationTablePtr xmlCopyNotationTable    (xmlNotationTablePtr table);
+void        xmlFreeNotationTable            (xmlNotationTablePtr table);
+void        xmlDumpNotationDecl             (xmlBufferPtr buf,
+                                             xmlNotationPtr nota);
+void        xmlDumpNotationTable            (xmlBufferPtr buf,
+                                             xmlNotationTablePtr table);
+xmlElementContentPtr xmlNewElementContent   (xmlChar *name,
+                                             xmlElementContentType type);
+xmlElementContentPtr xmlCopyElementContent  (xmlElementContentPtr content);
+void        xmlFreeElementContent           (xmlElementContentPtr cur);
+void        xmlSnprintfElementContent       (char *buf,
                                              int size,
-                                             xmlElementContentPtr content,
+                                             xmlElementContentPtr content,
                                              int glob);
-void        xmlSprintfElementContent        (char *buf,
-                                             xmlElementContentPtr content,
+void        xmlSprintfElementContent        (char *buf,
+                                             xmlElementContentPtr content,
                                              int glob);
-xmlElementPtr xmlAddElementDecl             (xmlValidCtxtPtr ctxt,
-                                             xmlDtdPtr dtd,
-                                             const xmlChar *name,
-                                             xmlElementTypeVal type,
-                                             xmlElementContentPtr content);
-xmlElementTablePtr xmlCopyElementTable      (xmlElementTablePtr table);
-void        xmlFreeElementTable             (xmlElementTablePtr table);
-void        xmlDumpElementTable             (xmlBufferPtr buf,
-                                             xmlElementTablePtr table);
-void        xmlDumpElementDecl              (xmlBufferPtr buf,
-                                             xmlElementPtr elem);
-xmlEnumerationPtr xmlCreateEnumeration      (xmlChar *name);
-void        xmlFreeEnumeration              (xmlEnumerationPtr cur);
-xmlEnumerationPtr xmlCopyEnumeration        (xmlEnumerationPtr cur);
-xmlAttributePtr xmlAddAttributeDecl         (xmlValidCtxtPtr ctxt,
-                                             xmlDtdPtr dtd,
-                                             const xmlChar *elem,
-                                             const xmlChar *name,
-                                             const xmlChar *ns,
-                                             xmlAttributeType type,
-                                             xmlAttributeDefault def,
-                                             const xmlChar *defaultValue,
-                                             xmlEnumerationPtr tree);
-xmlAttributeTablePtr xmlCopyAttributeTable  (xmlAttributeTablePtr table);
-void        xmlFreeAttributeTable           (xmlAttributeTablePtr table);
-void        xmlDumpAttributeTable           (xmlBufferPtr buf,
-                                             xmlAttributeTablePtr table);
-void        xmlDumpAttributeDecl            (xmlBufferPtr buf,
-                                             xmlAttributePtr attr);
-xmlIDPtr    xmlAddID                        (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             const xmlChar *value,
-                                             xmlAttrPtr attr);
-void        xmlFreeIDTable                  (xmlIDTablePtr table);
-xmlAttrPtr  xmlGetID                        (xmlDocPtr doc,
-                                             const xmlChar *ID);
-int         xmlIsID                         (xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             xmlAttrPtr attr);
-int         xmlRemoveID                     (xmlDocPtr doc,
-                                             xmlAttrPtr attr);
-xmlRefPtr   xmlAddRef                       (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             const xmlChar *value,
-                                             xmlAttrPtr attr);
-void        xmlFreeRefTable                 (xmlRefTablePtr table);
-int         xmlIsRef                        (xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             xmlAttrPtr attr);
-int         xmlRemoveRef                    (xmlDocPtr doc,
-                                             xmlAttrPtr attr);
-xmlListPtr  xmlGetRefs                      (xmlDocPtr doc,
-                                             const xmlChar *ID);
-int         xmlValidateRoot                 (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);
-int         xmlValidateElementDecl          (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlElementPtr elem);
-xmlChar*    xmlValidNormalizeAttributeValue (xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *name,
-                                             const xmlChar *value);
-xmlChar*    xmlValidCtxtNormalizeAttributeValue
-                                            (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *name,
-                                             const xmlChar *value);
-int         xmlValidateAttributeDecl        (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlAttributePtr attr);
-int         xmlValidateAttributeValue       (xmlAttributeType type,
-                                             const xmlChar *value);
-int         xmlValidateNotationDecl         (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNotationPtr nota);
-int         xmlValidateDtd                  (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlDtdPtr dtd);
-int         xmlValidateDtdFinal             (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);
-int         xmlValidateDocument             (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);
-int         xmlValidateElement              (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem);
-int         xmlValidateOneElement           (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem);
-int         xmlValidateOneAttribute         (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             xmlAttrPtr attr,
-                                             const xmlChar *value);
-int         xmlValidateOneNamespace         (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *prefix,
-                                             xmlNsPtr ns,
-                                             const xmlChar *value);
-int         xmlValidateDocumentFinal        (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);
-int         xmlValidateNotationUse          (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             const xmlChar *notationName);
-int         xmlIsMixedElement               (xmlDocPtr doc,
-                                             const xmlChar *name);
-xmlAttributePtr xmlGetDtdAttrDesc           (xmlDtdPtr dtd,
-                                             const xmlChar *elem,
-                                             const xmlChar *name);
-xmlAttributePtr xmlGetDtdQAttrDesc          (xmlDtdPtr dtd,
-                                             const xmlChar *elem,
-                                             const xmlChar *name,
-                                             const xmlChar *prefix);
-xmlNotationPtr xmlGetDtdNotationDesc        (xmlDtdPtr dtd,
-                                             const xmlChar *name);
-xmlElementPtr xmlGetDtdQElementDesc         (xmlDtdPtr dtd,
-                                             const xmlChar *name,
-                                             const xmlChar *prefix);
-xmlElementPtr xmlGetDtdElementDesc          (xmlDtdPtr dtd,
-                                             const xmlChar *name);
-int         xmlValidGetValidElements        (xmlNode *prev,
-                                             xmlNode *next,
-                                             const xmlChar **list,
+xmlElementPtr xmlAddElementDecl             (xmlValidCtxtPtr ctxt,
+                                             xmlDtdPtr dtd,
+                                             const xmlChar *name,
+                                             xmlElementTypeVal type,
+                                             xmlElementContentPtr content);
+xmlElementTablePtr xmlCopyElementTable      (xmlElementTablePtr table);
+void        xmlFreeElementTable             (xmlElementTablePtr table);
+void        xmlDumpElementTable             (xmlBufferPtr buf,
+                                             xmlElementTablePtr table);
+void        xmlDumpElementDecl              (xmlBufferPtr buf,
+                                             xmlElementPtr elem);
+xmlEnumerationPtr xmlCreateEnumeration      (xmlChar *name);
+void        xmlFreeEnumeration              (xmlEnumerationPtr cur);
+xmlEnumerationPtr xmlCopyEnumeration        (xmlEnumerationPtr cur);
+xmlAttributePtr xmlAddAttributeDecl         (xmlValidCtxtPtr ctxt,
+                                             xmlDtdPtr dtd,
+                                             const xmlChar *elem,
+                                             const xmlChar *name,
+                                             const xmlChar *ns,
+                                             xmlAttributeType type,
+                                             xmlAttributeDefault def,
+                                             const xmlChar *defaultValue,
+                                             xmlEnumerationPtr tree);
+xmlAttributeTablePtr xmlCopyAttributeTable  (xmlAttributeTablePtr table);
+void        xmlFreeAttributeTable           (xmlAttributeTablePtr table);
+void        xmlDumpAttributeTable           (xmlBufferPtr buf,
+                                             xmlAttributeTablePtr table);
+void        xmlDumpAttributeDecl            (xmlBufferPtr buf,
+                                             xmlAttributePtr attr);
+xmlIDPtr    xmlAddID                        (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             const xmlChar *value,
+                                             xmlAttrPtr attr);
+void        xmlFreeIDTable                  (xmlIDTablePtr table);
+xmlAttrPtr  xmlGetID                        (xmlDocPtr doc,
+                                             const xmlChar *ID);
+int         xmlIsID                         (xmlDocPtr doc,
+                                             xmlNodePtr elem,
+                                             xmlAttrPtr attr);
+int         xmlRemoveID                     (xmlDocPtr doc,
+                                             xmlAttrPtr attr);
+xmlRefPtr   xmlAddRef                       (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             const xmlChar *value,
+                                             xmlAttrPtr attr);
+void        xmlFreeRefTable                 (xmlRefTablePtr table);
+int         xmlIsRef                        (xmlDocPtr doc,
+                                             xmlNodePtr elem,
+                                             xmlAttrPtr attr);
+int         xmlRemoveRef                    (xmlDocPtr doc,
+                                             xmlAttrPtr attr);
+xmlListPtr  xmlGetRefs                      (xmlDocPtr doc,
+                                             const xmlChar *ID);
+int         xmlValidateRoot                 (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc);
+int         xmlValidateElementDecl          (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlElementPtr elem);
+xmlChar*    xmlValidNormalizeAttributeValue (xmlDocPtr doc,
+                                             xmlNodePtr elem,
+                                             const xmlChar *name,
+                                             const xmlChar *value);
+xmlChar*    xmlValidCtxtNormalizeAttributeValue
+                                            (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem,
+                                             const xmlChar *name,
+                                             const xmlChar *value);
+int         xmlValidateAttributeDecl        (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlAttributePtr attr);
+int         xmlValidateAttributeValue       (xmlAttributeType type,
+                                             const xmlChar *value);
+int         xmlValidateNotationDecl         (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNotationPtr nota);
+int         xmlValidateDtd                  (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlDtdPtr dtd);
+int         xmlValidateDtdFinal             (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc);
+int         xmlValidateDocument             (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc);
+int         xmlValidateElement              (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem);
+int         xmlValidateOneElement           (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem);
+int         xmlValidateOneAttribute         (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem,
+                                             xmlAttrPtr attr,
+                                             const xmlChar *value);
+int         xmlValidateOneNamespace         (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem,
+                                             const xmlChar *prefix,
+                                             xmlNsPtr ns,
+                                             const xmlChar *value);
+int         xmlValidateDocumentFinal        (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc);
+int         xmlValidateNotationUse          (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             const xmlChar *notationName);
+int         xmlIsMixedElement               (xmlDocPtr doc,
+                                             const xmlChar *name);
+xmlAttributePtr xmlGetDtdAttrDesc           (xmlDtdPtr dtd,
+                                             const xmlChar *elem,
+                                             const xmlChar *name);
+xmlAttributePtr xmlGetDtdQAttrDesc          (xmlDtdPtr dtd,
+                                             const xmlChar *elem,
+                                             const xmlChar *name,
+                                             const xmlChar *prefix);
+xmlNotationPtr xmlGetDtdNotationDesc        (xmlDtdPtr dtd,
+                                             const xmlChar *name);
+xmlElementPtr xmlGetDtdQElementDesc         (xmlDtdPtr dtd,
+                                             const xmlChar *name,
+                                             const xmlChar *prefix);
+xmlElementPtr xmlGetDtdElementDesc          (xmlDtdPtr dtd,
+                                             const xmlChar *name);
+int         xmlValidGetValidElements        (xmlNode *prev,
+                                             xmlNode *next,
+                                             const xmlChar **list,
                                              int max);
-int         xmlValidGetPotentialChildren    (xmlElementContent *ctree,
-                                             const xmlChar **list,
+int         xmlValidGetPotentialChildren    (xmlElementContent *ctree,
+                                             const xmlChar **list,
                                              int *len,
                                              int max);
-int         xmlValidateNameValue            (const xmlChar *value);
-int         xmlValidateNamesValue           (const xmlChar *value);
-int         xmlValidateNmtokenValue         (const xmlChar *value);
-int         xmlValidateNmtokensValue        (const xmlChar *value);
-int         xmlValidBuildContentModel       (xmlValidCtxtPtr ctxt,
-                                             xmlElementPtr elem);
-int         xmlValidatePushElement          (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *qname);
-int         xmlValidatePushCData            (xmlValidCtxtPtr ctxt,
-                                             const xmlChar *data,
+int         xmlValidateNameValue            (const xmlChar *value);
+int         xmlValidateNamesValue           (const xmlChar *value);
+int         xmlValidateNmtokenValue         (const xmlChar *value);
+int         xmlValidateNmtokensValue        (const xmlChar *value);
+int         xmlValidBuildContentModel       (xmlValidCtxtPtr ctxt,
+                                             xmlElementPtr 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

struct xmlValidState

struct xmlValidState;

xmlValidStatePtr

xmlValidityErrorFunc ()

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

Description

+ +

Details

struct xmlValidState

struct xmlValidState;

+ +

xmlValidStatePtr

typedef xmlValidState *xmlValidStatePtr;
+

+ +

xmlValidityErrorFunc ()

void        (*xmlValidityErrorFunc)         (void *ctx,
                                              const char *msg,
-                                             ...);

Callback called when a validity error is found. This is a message -oriented function similar to an *printf function.

ctx : 
msg : 
... : 

xmlValidityWarningFunc ()

void        (*xmlValidityWarningFunc)       (void *ctx,
+                                             ...);

+Callback called when a validity error is found. This is a message +oriented function similar to an *printf function.

+ +

ctx : an xmlValidCtxtPtr validity error context +
msg : the string to format *printf like vararg +
... : remaining arguments to the format +

xmlValidityWarningFunc ()

void        (*xmlValidityWarningFunc)       (void *ctx,
                                              const char *msg,
-                                             ...);

Callback called when a validity warning is found. This is a message -oriented function similar to an *printf function.

ctx : 
msg : 
... : 

struct xmlValidCtxt

struct xmlValidCtxt {
+                                             ...);

+Callback called when a validity warning is found. This is a message +oriented function similar to an *printf function.

+ +

ctx : an xmlValidCtxtPtr validity error context +
msg : the string to format *printf like vararg +
... : remaining arguments to the format +

struct xmlValidCtxt

struct xmlValidCtxt {
     void *userData;			/* user specific data block */
     xmlValidityErrorFunc error;		/* the callback in case of errors */
     xmlValidityWarningFunc warning;	/* the callback in case of warning */
@@ -1419,5357 +269,458 @@ CLASS="PROGRAMLISTING"
     void                     *am;
     void                  *state;
 #endif
-};

xmlValidCtxtPtr

xmlNotationTablePtr

xmlElementTablePtr

xmlAttributeTablePtr

xmlIDTablePtr

xmlRefTablePtr

xmlSplitQName2 ()

xmlChar*    xmlSplitQName2                  (const xmlChar *name,
-                                             xmlChar **prefix);

parse an XML qualified name string

[NS 5] QName ::= (Prefix ':')? LocalPart

[NS 6] Prefix ::= NCName

[NS 7] LocalPart ::= NCName

name : 
prefix : 
Returns : 

xmlAddNotationDecl ()

xmlNotationPtr xmlAddNotationDecl           (xmlValidCtxtPtr ctxt,
-                                             xmlDtdPtr dtd,
-                                             const xmlChar *name,
-                                             const xmlChar *PublicID,
-                                             const xmlChar *SystemID);

Register a new notation declaration

ctxt : 
dtd : 
name : 
PublicID : 
SystemID : 
Returns : 

xmlCopyNotationTable ()

xmlNotationTablePtr xmlCopyNotationTable    (xmlNotationTablePtr table);

Build a copy of a notation table.

table : 
Returns : 

xmlFreeNotationTable ()

void        xmlFreeNotationTable            (xmlNotationTablePtr table);

Deallocate the memory used by an entities hash table.

table : 

xmlDumpNotationDecl ()

void        xmlDumpNotationDecl             (xmlBufferPtr buf,
-                                             xmlNotationPtr nota);

This will dump the content the notation declaration as an XML DTD definition

buf : 
nota : 

xmlDumpNotationTable ()

void        xmlDumpNotationTable            (xmlBufferPtr buf,
-                                             xmlNotationTablePtr table);

This will dump the content of the notation table as an XML DTD definition

buf : 
table : 

xmlNewElementContent ()

xmlElementContentPtr xmlNewElementContent   (xmlChar *name,
-                                             xmlElementContentType type);

Allocate an element content structure.

name : 
type : 
Returns : 

xmlCopyElementContent ()

xmlElementContentPtr xmlCopyElementContent  (xmlElementContentPtr content);

Build a copy of an element content description.

content : 
Returns : 

xmlFreeElementContent ()

void        xmlFreeElementContent           (xmlElementContentPtr cur);

Free an element content structure. This is a recursive call !

cur : 

xmlSnprintfElementContent ()

void        xmlSnprintfElementContent       (char *buf,
+};
+

+

+ +

xmlValidCtxtPtr

typedef xmlValidCtxt *xmlValidCtxtPtr;
+

+ +

xmlNotationTablePtr

typedef xmlNotationTable *xmlNotationTablePtr;
+

+ +

xmlElementTablePtr

typedef xmlElementTable *xmlElementTablePtr;
+

+ +

xmlAttributeTablePtr

typedef xmlAttributeTable *xmlAttributeTablePtr;
+

+ +

xmlIDTablePtr

typedef xmlIDTable *xmlIDTablePtr;
+

+ +

xmlRefTablePtr

typedef xmlRefTable *xmlRefTablePtr;
+

+ +

xmlAddNotationDecl ()

xmlNotationPtr xmlAddNotationDecl           (xmlValidCtxtPtr ctxt,
+                                             xmlDtdPtr dtd,
+                                             const xmlChar *name,
+                                             const xmlChar *PublicID,
+                                             const xmlChar *SystemID);

+Register a new notation declaration

+ +

ctxt : the validation context +
dtd : pointer to the DTD +
name : the entity name +
PublicID : the public identifier or NULL +
SystemID : the system identifier or NULL +
Returns :NULL if not, otherwise the entity +

xmlCopyNotationTable ()

xmlNotationTablePtr xmlCopyNotationTable    (xmlNotationTablePtr table);

+Build a copy of a notation table.

+ +

table : A notation table +
Returns :the new xmlNotationTablePtr or NULL in case of error. +

xmlFreeNotationTable ()

void        xmlFreeNotationTable            (xmlNotationTablePtr table);

+Deallocate the memory used by an entities hash table.

+ +

table : An notation table +

xmlDumpNotationDecl ()

void        xmlDumpNotationDecl             (xmlBufferPtr buf,
+                                             xmlNotationPtr nota);

+This will dump the content the notation declaration as an XML DTD definition

+ +

buf : the XML buffer output +
nota : A notation declaration +

xmlDumpNotationTable ()

void        xmlDumpNotationTable            (xmlBufferPtr buf,
+                                             xmlNotationTablePtr table);

+This will dump the content of the notation table as an XML DTD definition

+ +

buf : the XML buffer output +
table : A notation table +

xmlNewElementContent ()

xmlElementContentPtr xmlNewElementContent   (xmlChar *name,
+                                             xmlElementContentType type);

+Allocate an element content structure.

+ +

name : the subelement name or NULL +
type : the type of element content decl +
Returns :NULL if not, otherwise the new element content structure +

xmlCopyElementContent ()

xmlElementContentPtr xmlCopyElementContent  (xmlElementContentPtr content);

+Build a copy of an element content description.

+ +

content : +
Returns :the new xmlElementContentPtr or NULL in case of error. +

xmlFreeElementContent ()

void        xmlFreeElementContent           (xmlElementContentPtr cur);

+Free an element content structure. This is a recursive call !

+ +

cur : the element content tree to free +

xmlSnprintfElementContent ()

void        xmlSnprintfElementContent       (char *buf,
                                              int size,
-                                             xmlElementContentPtr content,
-                                             int glob);

This will dump the content of the element content definition -Intended just for the debug routine

buf : 
size : 
content : 
glob : 

xmlSprintfElementContent ()

void        xmlSprintfElementContent        (char *buf,
-                                             xmlElementContentPtr content,
-                                             int glob);

Deprecated, unsafe, use xmlSnprintfElementContent

buf : 
content : 
glob : 

xmlAddElementDecl ()

xmlElementPtr xmlAddElementDecl             (xmlValidCtxtPtr ctxt,
-                                             xmlDtdPtr dtd,
-                                             const xmlChar *name,
-                                             xmlElementTypeVal type,
-                                             xmlElementContentPtr content);

Register a new element declaration

ctxt : 
dtd : 
name : 
type : 
content : 
Returns : 

xmlCopyElementTable ()

xmlElementTablePtr xmlCopyElementTable      (xmlElementTablePtr table);

Build a copy of an element table.

table : 
Returns : 

xmlFreeElementTable ()

void        xmlFreeElementTable             (xmlElementTablePtr table);

Deallocate the memory used by an element hash table.

table : 

xmlDumpElementTable ()

void        xmlDumpElementTable             (xmlBufferPtr buf,
-                                             xmlElementTablePtr table);

This will dump the content of the element table as an XML DTD definition

buf : 
table : 

xmlDumpElementDecl ()

void        xmlDumpElementDecl              (xmlBufferPtr buf,
-                                             xmlElementPtr elem);

This will dump the content of the element declaration as an XML -DTD definition

buf : 
elem : 

xmlCreateEnumeration ()

xmlEnumerationPtr xmlCreateEnumeration      (xmlChar *name);

create and initialize an enumeration attribute node.

name : 
Returns : 

xmlFreeEnumeration ()

void        xmlFreeEnumeration              (xmlEnumerationPtr cur);

free an enumeration attribute node (recursive).

cur : 

xmlCopyEnumeration ()

xmlEnumerationPtr xmlCopyEnumeration        (xmlEnumerationPtr cur);

Copy an enumeration attribute node (recursive).

cur : 
Returns : 

xmlAddAttributeDecl ()

xmlAttributePtr xmlAddAttributeDecl         (xmlValidCtxtPtr ctxt,
-                                             xmlDtdPtr dtd,
-                                             const xmlChar *elem,
-                                             const xmlChar *name,
-                                             const xmlChar *ns,
-                                             xmlAttributeType type,
-                                             xmlAttributeDefault def,
-                                             const xmlChar *defaultValue,
-                                             xmlEnumerationPtr tree);

Register a new attribute declaration -Note that tree becomes the ownership of the DTD

ctxt : 
dtd : 
elem : 
name : 
ns : 
type : 
def : 
defaultValue : 
tree : 
Returns : 

xmlCopyAttributeTable ()

xmlAttributeTablePtr xmlCopyAttributeTable  (xmlAttributeTablePtr table);

Build a copy of an attribute table.

table : 
Returns : 

xmlFreeAttributeTable ()

void        xmlFreeAttributeTable           (xmlAttributeTablePtr table);

Deallocate the memory used by an entities hash table.

table : 

xmlDumpAttributeTable ()

void        xmlDumpAttributeTable           (xmlBufferPtr buf,
-                                             xmlAttributeTablePtr table);

This will dump the content of the attribute table as an XML DTD definition

buf : 
table : 

xmlDumpAttributeDecl ()

void        xmlDumpAttributeDecl            (xmlBufferPtr buf,
-                                             xmlAttributePtr attr);

This will dump the content of the attribute declaration as an XML -DTD definition

buf : 
attr : 

xmlAddID ()

xmlIDPtr    xmlAddID                        (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             const xmlChar *value,
-                                             xmlAttrPtr attr);

Register a new id declaration

ctxt : 
doc : 
value : 
attr : 
Returns : 

xmlFreeIDTable ()

void        xmlFreeIDTable                  (xmlIDTablePtr table);

Deallocate the memory used by an ID hash table.

table : 

xmlGetID ()

xmlAttrPtr  xmlGetID                        (xmlDocPtr doc,
-                                             const xmlChar *ID);

Search the attribute declaring the given ID

doc : 
ID : 
Returns : 

xmlIsID ()

int         xmlIsID                         (xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             xmlAttrPtr attr);

Determine whether an attribute is of type ID. In case we have DTD(s) + xmlElementContentPtr content, + int glob);

+This will dump the content of the element content definition +Intended just for the debug routine

+ +

buf : an output buffer +
size : the buffer size +
content : An element table +
glob : 1 if one must print the englobing parenthesis, 0 otherwise +

xmlSprintfElementContent ()

void        xmlSprintfElementContent        (char *buf,
+                                             xmlElementContentPtr content,
+                                             int glob);

+Deprecated, unsafe, use xmlSnprintfElementContent

+ +

buf : an output buffer +
content : An element table +
glob : 1 if one must print the englobing parenthesis, 0 otherwise +

xmlAddElementDecl ()

xmlElementPtr xmlAddElementDecl             (xmlValidCtxtPtr ctxt,
+                                             xmlDtdPtr dtd,
+                                             const xmlChar *name,
+                                             xmlElementTypeVal type,
+                                             xmlElementContentPtr content);

+Register a new element declaration

+ +

ctxt : the validation context +
dtd : pointer to the DTD +
name : the entity name +
type : the element type +
content : the element content tree or NULL +
Returns :NULL if not, otherwise the entity +

xmlCopyElementTable ()

xmlElementTablePtr xmlCopyElementTable      (xmlElementTablePtr table);

+Build a copy of an element table.

+ +

table : An element table +
Returns :the new xmlElementTablePtr or NULL in case of error. +

xmlFreeElementTable ()

void        xmlFreeElementTable             (xmlElementTablePtr table);

+Deallocate the memory used by an element hash table.

+ +

table : An element table +

xmlDumpElementTable ()

void        xmlDumpElementTable             (xmlBufferPtr buf,
+                                             xmlElementTablePtr table);

+This will dump the content of the element table as an XML DTD definition

+ +

buf : the XML buffer output +
table : An element table +

xmlDumpElementDecl ()

void        xmlDumpElementDecl              (xmlBufferPtr buf,
+                                             xmlElementPtr elem);

+This will dump the content of the element declaration as an XML +DTD definition

+ +

buf : the XML buffer output +
elem : An element table +

xmlCreateEnumeration ()

xmlEnumerationPtr xmlCreateEnumeration      (xmlChar *name);

+create and initialize an enumeration attribute node.

+ +

name : the enumeration name or NULL +
Returns :the xmlEnumerationPtr just created or NULL in case + of error. +

xmlFreeEnumeration ()

void        xmlFreeEnumeration              (xmlEnumerationPtr cur);

+free an enumeration attribute node (recursive).

+ +

cur : the tree to free. +

xmlCopyEnumeration ()

xmlEnumerationPtr xmlCopyEnumeration        (xmlEnumerationPtr cur);

+Copy an enumeration attribute node (recursive).

+ +

cur : the tree to copy. +
Returns :the xmlEnumerationPtr just created or NULL in case + of error. +

xmlAddAttributeDecl ()

xmlAttributePtr xmlAddAttributeDecl         (xmlValidCtxtPtr ctxt,
+                                             xmlDtdPtr dtd,
+                                             const xmlChar *elem,
+                                             const xmlChar *name,
+                                             const xmlChar *ns,
+                                             xmlAttributeType type,
+                                             xmlAttributeDefault def,
+                                             const xmlChar *defaultValue,
+                                             xmlEnumerationPtr tree);

+Register a new attribute declaration +Note that tree becomes the ownership of the DTD

+ +

ctxt : the validation context +
dtd : pointer to the DTD +
elem : the element name +
name : the attribute name +
ns : the attribute namespace prefix +
type : the attribute type +
def : the attribute default type +
defaultValue : the attribute default value +
tree : if it's an enumeration, the associated list +
Returns :NULL if not new, otherwise the attribute decl +

xmlCopyAttributeTable ()

xmlAttributeTablePtr xmlCopyAttributeTable  (xmlAttributeTablePtr table);

+Build a copy of an attribute table.

+ +

table : An attribute table +
Returns :the new xmlAttributeTablePtr or NULL in case of error. +

xmlFreeAttributeTable ()

void        xmlFreeAttributeTable           (xmlAttributeTablePtr table);

+Deallocate the memory used by an entities hash table.

+ +

table : An attribute table +

xmlDumpAttributeTable ()

void        xmlDumpAttributeTable           (xmlBufferPtr buf,
+                                             xmlAttributeTablePtr table);

+This will dump the content of the attribute table as an XML DTD definition

+ +

buf : the XML buffer output +
table : An attribute table +

xmlDumpAttributeDecl ()

void        xmlDumpAttributeDecl            (xmlBufferPtr buf,
+                                             xmlAttributePtr attr);

+This will dump the content of the attribute declaration as an XML +DTD definition

+ +

buf : the XML buffer output +
attr : An attribute declaration +

xmlAddID ()

xmlIDPtr    xmlAddID                        (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             const xmlChar *value,
+                                             xmlAttrPtr attr);

+Register a new id declaration

+ +

ctxt : the validation context +
doc : pointer to the document +
value : the value name +
attr : the attribute holding the ID +
Returns :NULL if not, otherwise the new xmlIDPtr +

xmlFreeIDTable ()

void        xmlFreeIDTable                  (xmlIDTablePtr table);

+Deallocate the memory used by an ID hash table.

+ +

table : An id table +

xmlGetID ()

xmlAttrPtr  xmlGetID                        (xmlDocPtr doc,
+                                             const xmlChar *ID);

+Search the attribute declaring the given ID

+ +

doc : pointer to the document +
ID : the ID value +
Returns :NULL if not found, otherwise the xmlAttrPtr defining the ID +

xmlIsID ()

int         xmlIsID                         (xmlDocPtr doc,
+                                             xmlNodePtr elem,
+                                             xmlAttrPtr attr);

+Determine whether an attribute is of type ID. In case we have DTD(s) then this is done if DTD loading has been requested. In the case of HTML documents parsed with the HTML parser, then ID detection is -done systematically.

doc : 
elem : 
attr : 
Returns : 

xmlRemoveID ()

int         xmlRemoveID                     (xmlDocPtr doc,
-                                             xmlAttrPtr attr);

Remove the given attribute from the ID table maintained internally.

doc : 
attr : 
Returns : 

xmlAddRef ()

xmlRefPtr   xmlAddRef                       (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             const xmlChar *value,
-                                             xmlAttrPtr attr);

Register a new ref declaration

ctxt : 
doc : 
value : 
attr : 
Returns : 

xmlFreeRefTable ()

void        xmlFreeRefTable                 (xmlRefTablePtr table);

Deallocate the memory used by an Ref hash table.

table : 

xmlIsRef ()

int         xmlIsRef                        (xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             xmlAttrPtr attr);

Determine whether an attribute is of type Ref. In case we have DTD(s) +done systematically.

+ +

doc : the document +
elem : the element carrying the attribute +
attr : the attribute +
Returns :0 or 1 depending on the lookup result +

xmlRemoveID ()

int         xmlRemoveID                     (xmlDocPtr doc,
+                                             xmlAttrPtr attr);

+Remove the given attribute from the ID table maintained internally.

+ +

doc : the document +
attr : the attribute +
Returns :-1 if the lookup failed and 0 otherwise +

xmlAddRef ()

xmlRefPtr   xmlAddRef                       (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             const xmlChar *value,
+                                             xmlAttrPtr attr);

+Register a new ref declaration

+ +

ctxt : the validation context +
doc : pointer to the document +
value : the value name +
attr : the attribute holding the Ref +
Returns :NULL if not, otherwise the new xmlRefPtr +

xmlFreeRefTable ()

void        xmlFreeRefTable                 (xmlRefTablePtr table);

+Deallocate the memory used by an Ref hash table.

+ +

table : An ref table +

xmlIsRef ()

int         xmlIsRef                        (xmlDocPtr doc,
+                                             xmlNodePtr elem,
+                                             xmlAttrPtr attr);

+Determine whether an attribute is of type Ref. In case we have DTD(s) then this is simple, otherwise we use an heuristic: name Ref (upper -or lowercase).

doc : 
elem : 
attr : 
Returns : 

xmlRemoveRef ()

int         xmlRemoveRef                    (xmlDocPtr doc,
-                                             xmlAttrPtr attr);

Remove the given attribute from the Ref table maintained internally.

doc : 
attr : 
Returns : 

xmlGetRefs ()

xmlListPtr  xmlGetRefs                      (xmlDocPtr doc,
-                                             const xmlChar *ID);

Find the set of references for the supplied ID.

doc : 
ID : 
Returns : 

xmlValidateRoot ()

int         xmlValidateRoot                 (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);

Try to validate a the root element +or lowercase).

+ +

doc : the document +
elem : the element carrying the attribute +
attr : the attribute +
Returns :0 or 1 depending on the lookup result +

xmlRemoveRef ()

int         xmlRemoveRef                    (xmlDocPtr doc,
+                                             xmlAttrPtr attr);

+Remove the given attribute from the Ref table maintained internally.

+ +

doc : the document +
attr : the attribute +
Returns :-1 if the lookup failed and 0 otherwise +

xmlGetRefs ()

xmlListPtr  xmlGetRefs                      (xmlDocPtr doc,
+                                             const xmlChar *ID);

+Find the set of references for the supplied ID.

+ +

doc : pointer to the document +
ID : the ID value +
Returns :NULL if not found, otherwise node set for the ID. +

xmlValidateRoot ()

int         xmlValidateRoot                 (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc);

+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 ] -it doesn't try to recurse or apply other check to the element

ctxt : 
doc : 
Returns : 

xmlValidateElementDecl ()

int         xmlValidateElementDecl          (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlElementPtr elem);

Try to validate a single element definition +it doesn't try to recurse or apply other check to the element

+ +

ctxt : the validation context +
doc : a document instance +
Returns :1 if valid or 0 otherwise +

xmlValidateElementDecl ()

int         xmlValidateElementDecl          (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlElementPtr elem);

+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 ]

ctxt : 
doc : 
elem : 
Returns : 

xmlValidNormalizeAttributeValue ()

xmlChar*    xmlValidNormalizeAttributeValue (xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *name,
-                                             const xmlChar *value);

Does the validation related extra step of the normalization of attribute -values:

If the declared value is not CDATA, then the XML processor must further + - [ VC: Unique Element Type Declaration ]

+ +

ctxt : the validation context +
doc : a document instance +
elem : an element definition +
Returns :1 if valid or 0 otherwise +

xmlValidNormalizeAttributeValue ()

xmlChar*    xmlValidNormalizeAttributeValue (xmlDocPtr doc,
+                                             xmlNodePtr elem,
+                                             const xmlChar *name,
+                                             const xmlChar *value);

+Does the validation related extra step of the normalization of attribute +values: +

+If the declared value is not CDATA, then the XML processor must further process the normalized attribute value by discarding any leading and -trailing space (x20) characters, and by replacing sequences of space -(x20) characters by single space (x20) character.

doc : 
elem : 
name : 
value : 
Returns : 

xmlValidCtxtNormalizeAttributeValue ()

xmlChar*    xmlValidCtxtNormalizeAttributeValue
-                                            (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *name,
-                                             const xmlChar *value);

Does the validation related extra step of the normalization of attribute -values:

If the declared value is not CDATA, then the XML processor must further +trailing space (x20) characters, and by replacing sequences of space +(x20) characters by single space (x20) character.

+ +

doc : the document +
elem : the parent +
name : the attribute name +
value : the attribute value +
Returns :a new normalized string if normalization is needed, NULL otherwise + the caller must free the returned value. +

xmlValidCtxtNormalizeAttributeValue ()

xmlChar*    xmlValidCtxtNormalizeAttributeValue
+                                            (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem,
+                                             const xmlChar *name,
+                                             const xmlChar *value);

+Does the validation related extra step of the normalization of attribute +values: +

+If the declared value is not CDATA, then the XML processor must further process the normalized attribute value by discarding any leading and -trailing space (x20) characters, and by replacing sequences of space -(x20) characters by single space (x20) character.

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

ctxt : the validation context or NULL
doc : 
elem : 
name : 
value : 
Returns : 

xmlValidateAttributeDecl ()

int         xmlValidateAttributeDecl        (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlAttributePtr attr);

Try to validate a single attribute definition +trailing space (x20) characters, and by replacing sequences of space +(x20) characters by single space (x20) character. +

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

+ +

ctxt : the validation context +
doc : the document +
elem : the parent +
name : the attribute name +
value : the attribute value +
Returns :a new normalized string if normalization is needed, NULL otherwise + the caller must free the returned value. +

xmlValidateAttributeDecl ()

int         xmlValidateAttributeDecl        (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlAttributePtr attr);

+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

ctxt : 
doc : 
attr : 
Returns : 

xmlValidateAttributeValue ()

int         xmlValidateAttributeValue       (xmlAttributeType type,
-                                             const xmlChar *value);

Validate that the given attribute value match the proper production

[ VC: ID ] -Values of type ID must match the Name production....

[ VC: IDREF ] + - [ VC: ID Attribute Default ] +

+The ID/IDREF uniqueness and matching are done separately

+ +

ctxt : the validation context +
doc : a document instance +
attr : an attribute definition +
Returns :1 if valid or 0 otherwise +

xmlValidateAttributeValue ()

int         xmlValidateAttributeValue       (xmlAttributeType type,
+                                             const xmlChar *value);

+Validate that the given attribute value match the proper production +

+[ VC: ID ] +Values of type ID must match the Name production.... +

+[ VC: IDREF ] Values of type IDREF must match the Name production, and values -of type IDREFS must match Names ...

[ VC: Entity Name ] +of type IDREFS must match Names ... +

+[ VC: Entity Name ] Values of type ENTITY must match the Name production, values -of type ENTITIES must match Names ...

[ VC: Name Token ] +of type ENTITIES must match Names ... +

+[ VC: Name Token ] Values of type NMTOKEN must match the Nmtoken production; values -of type NMTOKENS must match Nmtokens.

type : 
value : 
Returns : 

xmlValidateNotationDecl ()

int         xmlValidateNotationDecl         (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNotationPtr nota);

Try to validate a single notation definition +of type NMTOKENS must match Nmtokens.

+ +

type : an attribute type +
value : an attribute value +
Returns :1 if valid or 0 otherwise +

xmlValidateNotationDecl ()

int         xmlValidateNotationDecl         (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNotationPtr nota);

+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 -But this function get called anyway ...

ctxt : 
doc : 
nota : 
Returns : 

xmlValidateDtd ()

int         xmlValidateDtd                  (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlDtdPtr dtd);

Try to validate the document against the dtd instance

basically it does check all the definitions in the DtD.

ctxt : 
doc : 
dtd : 
Returns : 

xmlValidateDtdFinal ()

int         xmlValidateDtdFinal             (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);

Does the final step for the dtds validation once all the -subsets have been parsed

basically it does the following checks described by the XML Rec +But this function get called anyway ...

+ +

ctxt : the validation context +
doc : a document instance +
nota : a notation definition +
Returns :1 if valid or 0 otherwise +

xmlValidateDtd ()

int         xmlValidateDtd                  (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlDtdPtr dtd);

+Try to validate the document against the dtd instance +

+basically it does check all the definitions in the DtD.

+ +

ctxt : the validation context +
doc : a document instance +
dtd : a dtd instance +
Returns :1 if valid or 0 otherwise +

xmlValidateDtdFinal ()

int         xmlValidateDtdFinal             (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc);

+Does the final step for the dtds validation once all the +subsets have been parsed +

+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. - check that NOTATION type attributes default or - possible values matches one of the defined notations.

ctxt : 
doc : 
Returns : 

xmlValidateDocument ()

int         xmlValidateDocument             (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);

Try to validate the document instance

basically it does the all the checks described by the XML Rec + possible values matches one of the defined notations.

+ +

ctxt : the validation context +
doc : a document instance +
Returns :1 if valid or 0 if invalid and -1 if not well-formed +

xmlValidateDocument ()

int         xmlValidateDocument             (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc);

+Try to validate the document instance +

+basically it does the all the checks described by the XML Rec i.e. validates the internal and external subset (if present) -and validate the document tree.

ctxt : 
doc : 
Returns : 

xmlValidateElement ()

int         xmlValidateElement              (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem);

Try to validate the subtree under an element

ctxt : 
doc : 
elem : 
Returns : 

xmlValidateOneElement ()

int         xmlValidateOneElement           (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem);

Try to validate a single element and it's attributes, +and validate the document tree.

+ +

ctxt : the validation context +
doc : a document instance +
Returns :1 if valid or 0 otherwise +

xmlValidateElement ()

int         xmlValidateElement              (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem);

+Try to validate the subtree under an element

+ +

ctxt : the validation context +
doc : a document instance +
elem : an element instance +
Returns :1 if valid or 0 otherwise +

xmlValidateOneElement ()

int         xmlValidateOneElement           (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem);

+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 ] -Then call xmlValidateOneAttribute() for each attribute present.

The ID/IDREF checkings are done separately

ctxt : 
doc : 
elem : 
Returns : 

xmlValidateOneAttribute ()

int         xmlValidateOneAttribute         (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             xmlAttrPtr attr,
-                                             const xmlChar *value);

Try to validate a single attribute for an element +Then call xmlValidateOneAttribute() for each attribute present. +

+The ID/IDREF checkings are done separately

+ +

ctxt : the validation context +
doc : a document instance +
elem : an element instance +
Returns :1 if valid or 0 otherwise +

xmlValidateOneAttribute ()

int         xmlValidateOneAttribute         (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem,
+                                             xmlAttrPtr attr,
+                                             const xmlChar *value);

+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 ] @@ -6779,183 +730,23 @@ XML-1.0 recommendation: - [ VC: ID ] - [ VC: IDREF ] - [ VC: Entity Name ] - - [ VC: Notation Attributes ]

The ID/IDREF uniqueness and matching are done separately

ctxt : 
doc : 
elem : 
attr : 
value : 
Returns : 

xmlValidateOneNamespace ()

int         xmlValidateOneNamespace         (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *prefix,
-                                             xmlNsPtr ns,
-                                             const xmlChar *value);

Try to validate a single namespace declaration for an element + - [ VC: Notation Attributes ] +

+The ID/IDREF uniqueness and matching are done separately

+ +

ctxt : the validation context +
doc : a document instance +
elem : an element instance +
attr : an attribute instance +
value : the attribute value (without entities processing) +
Returns :1 if valid or 0 otherwise +

xmlValidateOneNamespace ()

int         xmlValidateOneNamespace         (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             xmlNodePtr elem,
+                                             const xmlChar *prefix,
+                                             xmlNsPtr ns,
+                                             const xmlChar *value);

+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 ] @@ -6965,2430 +756,188 @@ XML-1.0 recommendation: - [ VC: ID ] - [ VC: IDREF ] - [ VC: Entity Name ] - - [ VC: Notation Attributes ]

The ID/IDREF uniqueness and matching are done separately

ctxt : 
doc : 
elem : 
prefix : 
ns : 
value : 
Returns : 

xmlValidateDocumentFinal ()

int         xmlValidateDocumentFinal        (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);

Does the final step for the document validation once all the -incremental validation steps have been completed

basically it does the following checks described by the XML Rec

Check all the IDREF/IDREFS attributes definition for validity

ctxt : 
doc : 
Returns : 

xmlValidateNotationUse ()

int         xmlValidateNotationUse          (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             const xmlChar *notationName);

Validate that the given name match a notation declaration. -- [ VC: Notation Declared ]

ctxt : 
doc : 
notationName : 
Returns : 

xmlIsMixedElement ()

int         xmlIsMixedElement               (xmlDocPtr doc,
-                                             const xmlChar *name);

Search in the DtDs whether an element accept Mixed content (or ANY) -basically if it is supposed to accept text childs

doc : 
name : 
Returns : 

xmlGetDtdAttrDesc ()

xmlAttributePtr xmlGetDtdAttrDesc           (xmlDtdPtr dtd,
-                                             const xmlChar *elem,
-                                             const xmlChar *name);

Search the DTD for the description of this attribute on -this element.

dtd : 
elem : 
name : 
Returns : 

xmlGetDtdQAttrDesc ()

xmlAttributePtr xmlGetDtdQAttrDesc          (xmlDtdPtr dtd,
-                                             const xmlChar *elem,
-                                             const xmlChar *name,
-                                             const xmlChar *prefix);

Search the DTD for the description of this qualified attribute on -this element.

dtd : 
elem : 
name : 
prefix : 
Returns : 

xmlGetDtdNotationDesc ()

xmlNotationPtr xmlGetDtdNotationDesc        (xmlDtdPtr dtd,
-                                             const xmlChar *name);

Search the DTD for the description of this notation

dtd : 
name : 
Returns : 

xmlGetDtdQElementDesc ()

xmlElementPtr xmlGetDtdQElementDesc         (xmlDtdPtr dtd,
-                                             const xmlChar *name,
-                                             const xmlChar *prefix);

Search the DTD for the description of this element

dtd : 
name : 
prefix : 
Returns : 

xmlGetDtdElementDesc ()

xmlElementPtr xmlGetDtdElementDesc          (xmlDtdPtr dtd,
-                                             const xmlChar *name);

Search the DTD for the description of this element

dtd : 
name : 
Returns : 

xmlValidGetValidElements ()

int         xmlValidGetValidElements        (xmlNode *prev,
-                                             xmlNode *next,
-                                             const xmlChar **list,
-                                             int max);

This function returns the list of authorized children to insert + - [ VC: Notation Attributes ] +

+The ID/IDREF uniqueness and matching are done separately

+ +

ctxt : the validation context +
doc : a document instance +
elem : an element instance +
prefix : the namespace prefix +
ns : an namespace declaration instance +
value : the attribute value (without entities processing) +
Returns :1 if valid or 0 otherwise +

xmlValidateDocumentFinal ()

int         xmlValidateDocumentFinal        (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc);

+Does the final step for the document validation once all the +incremental validation steps have been completed +

+basically it does the following checks described by the XML Rec +

+Check all the IDREF/IDREFS attributes definition for validity

+ +

ctxt : the validation context +
doc : a document instance +
Returns :1 if valid or 0 otherwise +

xmlValidateNotationUse ()

int         xmlValidateNotationUse          (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             const xmlChar *notationName);

+Validate that the given name match a notation declaration. +- [ VC: Notation Declared ]

+ +

ctxt : the validation context +
doc : the document +
notationName : the notation name to check +
Returns :1 if valid or 0 otherwise +

xmlIsMixedElement ()

int         xmlIsMixedElement               (xmlDocPtr doc,
+                                             const xmlChar *name);

+Search in the DtDs whether an element accept Mixed content (or ANY) +basically if it is supposed to accept text childs

+ +

doc : the document +
name : the element name +
Returns :0 if no, 1 if yes, and -1 if no element description is available +

xmlGetDtdAttrDesc ()

xmlAttributePtr xmlGetDtdAttrDesc           (xmlDtdPtr dtd,
+                                             const xmlChar *elem,
+                                             const xmlChar *name);

+Search the DTD for the description of this attribute on +this element.

+ +

dtd : a pointer to the DtD to search +
elem : the element name +
name : the attribute name +
Returns :the xmlAttributePtr if found or NULL +

xmlGetDtdQAttrDesc ()

xmlAttributePtr xmlGetDtdQAttrDesc          (xmlDtdPtr dtd,
+                                             const xmlChar *elem,
+                                             const xmlChar *name,
+                                             const xmlChar *prefix);

+Search the DTD for the description of this qualified attribute on +this element.

+ +

dtd : a pointer to the DtD to search +
elem : the element name +
name : the attribute name +
prefix : the attribute namespace prefix +
Returns :the xmlAttributePtr if found or NULL +

xmlGetDtdNotationDesc ()

xmlNotationPtr xmlGetDtdNotationDesc        (xmlDtdPtr dtd,
+                                             const xmlChar *name);

+Search the DTD for the description of this notation

+ +

dtd : a pointer to the DtD to search +
name : the notation name +
Returns :the xmlNotationPtr if found or NULL +

xmlGetDtdQElementDesc ()

xmlElementPtr xmlGetDtdQElementDesc         (xmlDtdPtr dtd,
+                                             const xmlChar *name,
+                                             const xmlChar *prefix);

+Search the DTD for the description of this element

+ +

dtd : a pointer to the DtD to search +
name : the element name +
prefix : the element namespace prefix +
Returns :the xmlElementPtr if found or NULL +

xmlGetDtdElementDesc ()

xmlElementPtr xmlGetDtdElementDesc          (xmlDtdPtr dtd,
+                                             const xmlChar *name);

+Search the DTD for the description of this element

+ +

dtd : a pointer to the DtD to search +
name : the element name +
Returns :the xmlElementPtr if found or NULL +

xmlValidGetValidElements ()

int         xmlValidGetValidElements        (xmlNode *prev,
+                                             xmlNode *next,
+                                             const xmlChar **list,
+                                             int max);

+This function returns the list of authorized children to insert within an existing tree while respecting the validity constraints -forced by the Dtd. The insertion point is defined using prev and -next in the following ways: +forced by the Dtd. The insertion point is defined using prev and +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.

prev : 
next : 
list : 
max : 
Returns : 

xmlValidGetPotentialChildren ()

int         xmlValidGetPotentialChildren    (xmlElementContent *ctree,
-                                             const xmlChar **list,
+ 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.

+
+
prev :  an element to insert after
+
next :  an element to insert next
+
list :  an array to store the list of child names
+
max :  the size of the array
+
Returns :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.
+
xmlValidGetPotentialChildren ()
int         xmlValidGetPotentialChildren    (xmlElementContent *ctree,
+                                             const xmlChar **list,
                                              int *len,
-                                             int max);

Build/extend a list of potential children allowed by the content tree

ctree : 
list : 
len : 
max : 
Returns : 

xmlValidateNameValue ()

int         xmlValidateNameValue            (const xmlChar *value);

Validate that the given value match Name production

value : 
Returns : 

xmlValidateNamesValue ()

int         xmlValidateNamesValue           (const xmlChar *value);

Validate that the given value match Names production

value : 
Returns : 

xmlValidateNmtokenValue ()

int         xmlValidateNmtokenValue         (const xmlChar *value);

Validate that the given value match Nmtoken production

[ VC: Name Token ]

value : 
Returns : 

xmlValidateNmtokensValue ()

int         xmlValidateNmtokensValue        (const xmlChar *value);

Validate that the given value match Nmtokens production

[ VC: Name Token ]

value : 
Returns : 

xmlValidBuildContentModel ()

int         xmlValidBuildContentModel       (xmlValidCtxtPtr ctxt,
-                                             xmlElementPtr elem);

(Re)Build the automata associated to the content model of this -element

ctxt : 
elem : 
Returns : 

xmlValidatePushElement ()

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

Push a new element start on the validation stack.

ctxt : 
doc : 
elem : 
qname : 
Returns : 

xmlValidatePushCData ()

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

check the CData parsed for validation in the current stack

ctxt : 
data : 
len : 
Returns : 

xmlValidatePopElement ()

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

Pop the element end from the validation stack.

ctxt : 
doc : 
elem : 
qname : 
Returns : 

\ No newline at end of file + int max);

+Build/extend a list of potential children allowed by the content tree

+ +

ctree : an element content tree +
list : an array to store the list of child names +
len : a pointer to the number of element in the list +
max : the size of the array +
Returns :the number of element in the list, or -1 in case of error. +

xmlValidateNameValue ()

int         xmlValidateNameValue            (const xmlChar *value);

+Validate that the given value match Name production

+ +

value : an Name value +
Returns :1 if valid or 0 otherwise +

xmlValidateNamesValue ()

int         xmlValidateNamesValue           (const xmlChar *value);

+Validate that the given value match Names production

+ +

value : an Names value +
Returns :1 if valid or 0 otherwise +

xmlValidateNmtokenValue ()

int         xmlValidateNmtokenValue         (const xmlChar *value);

+Validate that the given value match Nmtoken production +

+[ VC: Name Token ]

+ +

value : an Nmtoken value +
Returns :1 if valid or 0 otherwise +

xmlValidateNmtokensValue ()

int         xmlValidateNmtokensValue        (const xmlChar *value);

+Validate that the given value match Nmtokens production +

+[ VC: Name Token ]

+ +

value : an Nmtokens value +
Returns :1 if valid or 0 otherwise +

xmlValidBuildContentModel ()

int         xmlValidBuildContentModel       (xmlValidCtxtPtr ctxt,
+                                             xmlElementPtr elem);

+(Re)Build the automata associated to the content model of this +element

+ +

ctxt : a validation context +
elem : an element declaration node +
Returns :1 in case of success, 0 in case of error +

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 +
<< entitiesrelaxng >>
diff --git a/doc/html/libxml-xinclude.html b/doc/html/libxml-xinclude.html index 9f46ee7b..6375fa21 100644 --- a/doc/html/libxml-xinclude.html +++ b/doc/html/libxml-xinclude.html @@ -1,374 +1,45 @@ -xinclude
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

xinclude

Name

xinclude -- 

Synopsis


+
+xinclude
PrevUpHomeGnome XML Library Reference ManualNext
xinclude
xinclude — 
Synopsis
 
-int         xmlXIncludeProcess              (xmlDocPtr doc);

Description

Details

xmlXIncludeProcess ()

int         xmlXIncludeProcess              (xmlDocPtr doc);

Implement the XInclude substitution on the XML document doc

doc : 
Returns : 

\ No newline at end of file + + +int xmlXIncludeProcess (xmlDocPtr doc); +

Description

+ +

Details

xmlXIncludeProcess ()

int         xmlXIncludeProcess              (xmlDocPtr doc);

+Implement the XInclude substitution on the XML document doc

+ +

doc : an XML document +
Returns :0 if no substitution were done, -1 if some processing failed + or the number of substitutions done. +
<< xpointernanohttp >>
diff --git a/doc/html/libxml-xmlIO.html b/doc/html/libxml-xmlIO.html new file mode 100644 index 00000000..ae502c5a --- /dev/null +++ b/doc/html/libxml-xmlIO.html @@ -0,0 +1,552 @@ + +xmlIO
PrevUpHomeGnome XML Library Reference ManualNext

xmlIO

xmlIO —

Synopsis

+
+
+
+int         (*xmlInputMatchCallback)        (char const *filename);
+void*       (*xmlInputOpenCallback)         (char const *filename);
+int         (*xmlInputReadCallback)         (void *context,
+                                             char *buffer,
+                                             int len);
+int         (*xmlInputCloseCallback)        (void *context);
+int         (*xmlOutputMatchCallback)       (char const *filename);
+void*       (*xmlOutputOpenCallback)        (char const *filename);
+int         (*xmlOutputWriteCallback)       (void *context,
+                                             const char *buffer,
+                                             int len);
+int         (*xmlOutputCloseCallback)       (void *context);
+struct      xmlParserInputBuffer;
+struct      xmlOutputBuffer;
+void        xmlCleanupInputCallbacks        (void);
+void        xmlCleanupOutputCallbacks       (void);
+void        xmlRegisterDefaultInputCallbacks
+                                            (void);
+xmlParserInputBufferPtr xmlAllocParserInputBuffer
+                                            (xmlCharEncoding enc);
+xmlParserInputBufferPtr xmlParserInputBufferCreateFilename
+                                            (const char *URI,
+                                             xmlCharEncoding enc);
+xmlParserInputBufferPtr xmlParserInputBufferCreateFile
+                                            (FILE *file,
+                                             xmlCharEncoding enc);
+xmlParserInputBufferPtr xmlParserInputBufferCreateFd
+                                            (int fd,
+                                             xmlCharEncoding enc);
+xmlParserInputBufferPtr xmlParserInputBufferCreateMem
+                                            (const char *mem,
+                                             int size,
+                                             xmlCharEncoding enc);
+xmlParserInputBufferPtr xmlParserInputBufferCreateIO
+                                            (xmlInputReadCallback ioread,
+                                             xmlInputCloseCallback ioclose,
+                                             void *ioctx,
+                                             xmlCharEncoding enc);
+int         xmlParserInputBufferRead        (xmlParserInputBufferPtr in,
+                                             int len);
+int         xmlParserInputBufferGrow        (xmlParserInputBufferPtr in,
+                                             int len);
+int         xmlParserInputBufferPush        (xmlParserInputBufferPtr in,
+                                             int len,
+                                             const char *buf);
+void        xmlFreeParserInputBuffer        (xmlParserInputBufferPtr in);
+char*       xmlParserGetDirectory           (const char *filename);
+int         xmlRegisterInputCallbacks       (xmlInputMatchCallback matchFunc,
+                                             xmlInputOpenCallback openFunc,
+                                             xmlInputReadCallback readFunc,
+                                             xmlInputCloseCallback closeFunc);
+void        xmlRegisterDefaultOutputCallbacks
+                                            (void);
+xmlOutputBufferPtr xmlAllocOutputBuffer     (xmlCharEncodingHandlerPtr encoder);
+xmlOutputBufferPtr xmlOutputBufferCreateFilename
+                                            (const char *URI,
+                                             xmlCharEncodingHandlerPtr encoder,
+                                             int compression);
+xmlOutputBufferPtr xmlOutputBufferCreateFile
+                                            (FILE *file,
+                                             xmlCharEncodingHandlerPtr encoder);
+xmlOutputBufferPtr xmlOutputBufferCreateFd  (int fd,
+                                             xmlCharEncodingHandlerPtr encoder);
+xmlOutputBufferPtr xmlOutputBufferCreateIO  (xmlOutputWriteCallback iowrite,
+                                             xmlOutputCloseCallback ioclose,
+                                             void *ioctx,
+                                             xmlCharEncodingHandlerPtr encoder);
+int         xmlOutputBufferWrite            (xmlOutputBufferPtr out,
+                                             int len,
+                                             const char *buf);
+int         xmlOutputBufferWriteString      (xmlOutputBufferPtr out,
+                                             const char *str);
+int         xmlOutputBufferFlush            (xmlOutputBufferPtr out);
+int         xmlOutputBufferClose            (xmlOutputBufferPtr out);
+int         xmlRegisterOutputCallbacks      (xmlOutputMatchCallback matchFunc,
+                                             xmlOutputOpenCallback openFunc,
+                                             xmlOutputWriteCallback writeFunc,
+                                             xmlOutputCloseCallback closeFunc);
+void*       xmlIOHTTPOpenW                  (const char *post_uri,
+                                             int compression);
+void        xmlRegisterHTTPPostCallbacks    (void);
+xmlParserInputPtr xmlNoNetExternalEntityLoader
+                                            (const char *URL,
+                                             const char *ID,
+                                             xmlParserCtxtPtr ctxt);
+xmlChar*    xmlNormalizeWindowsPath         (const xmlChar *path);
+int         xmlCheckFilename                (const char *path);
+int         xmlFileMatch                    (const char *filename);
+void*       xmlFileOpen                     (const char *filename);
+int         xmlFileRead                     (void *context,
+                                             char *buffer,
+                                             int len);
+int         xmlFileClose                    (void *context);
+int         xmlIOHTTPMatch                  (const char *filename);
+void*       xmlIOHTTPOpen                   (const char *filename);
+int         xmlIOHTTPRead                   (void *context,
+                                             char *buffer,
+                                             int len);
+int         xmlIOHTTPClose                  (void *context);
+int         xmlIOFTPMatch                   (const char *filename);
+void*       xmlIOFTPOpen                    (const char *filename);
+int         xmlIOFTPRead                    (void *context,
+                                             char *buffer,
+                                             int len);
+int         xmlIOFTPClose                   (void *context);
+

Description

+ +

Details

xmlInputMatchCallback ()

int         (*xmlInputMatchCallback)        (char const *filename);

+Callback used in the I/O Input API to detect if the current handler +can provide input fonctionnalities for this resource.

+ +

filename : the filename or URI +
Returns :1 if yes and 0 if another Input module should be used +

xmlInputOpenCallback ()

void*       (*xmlInputOpenCallback)         (char const *filename);

+Callback used in the I/O Input API to open the resource

+ +

filename : the filename or URI +

xmlInputReadCallback ()

int         (*xmlInputReadCallback)         (void *context,
+                                             char *buffer,
+                                             int len);

+Callback used in the I/O Input API to read the resource

+ +

context : an Input context +
buffer : the buffer to store data read +
len : the length of the buffer in bytes +
Returns :the number of bytes read or -1 in case of error +

xmlInputCloseCallback ()

int         (*xmlInputCloseCallback)        (void *context);

+Callback used in the I/O Input API to close the resource

+ +

context : an Input context +
Returns :0 or -1 in case of error +

xmlOutputMatchCallback ()

int         (*xmlOutputMatchCallback)       (char const *filename);

+Callback used in the I/O Output API to detect if the current handler +can provide output fonctionnalities for this resource.

+ +

filename : the filename or URI +
Returns :1 if yes and 0 if another Output module should be used +

xmlOutputOpenCallback ()

void*       (*xmlOutputOpenCallback)        (char const *filename);

+Callback used in the I/O Output API to open the resource

+ +

filename : the filename or URI +

xmlOutputWriteCallback ()

int         (*xmlOutputWriteCallback)       (void *context,
+                                             const char *buffer,
+                                             int len);

+Callback used in the I/O Output API to write to the resource

+ +

context : an Output context +
buffer : the buffer of data to write +
len : the length of the buffer in bytes +
Returns :the number of bytes written or -1 in case of error +

xmlOutputCloseCallback ()

int         (*xmlOutputCloseCallback)       (void *context);

+Callback used in the I/O Output API to close the resource

+ +

context : an Output context +
Returns :0 or -1 in case of error +

struct xmlParserInputBuffer

struct xmlParserInputBuffer {
+    void*                  context;
+    xmlInputReadCallback   readcallback;
+    xmlInputCloseCallback  closecallback;
+    
+    xmlCharEncodingHandlerPtr encoder; /* I18N conversions to UTF-8 */
+    
+    xmlBufferPtr buffer;    /* Local buffer encoded in UTF-8 */
+    xmlBufferPtr raw;       /* if encoder != NULL buffer for raw input */
+};
+

+ +

struct xmlOutputBuffer

struct xmlOutputBuffer {
+    void*                   context;
+    xmlOutputWriteCallback  writecallback;
+    xmlOutputCloseCallback  closecallback;
+    
+    xmlCharEncodingHandlerPtr encoder; /* I18N conversions to UTF-8 */
+    
+    xmlBufferPtr buffer;    /* Local buffer encoded in UTF-8 or ISOLatin */
+    xmlBufferPtr conv;      /* if encoder != NULL buffer for output */
+    int written;            /* total number of byte written */
+};
+

+ +

xmlCleanupInputCallbacks ()

void        xmlCleanupInputCallbacks        (void);

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

+ +

xmlCleanupOutputCallbacks ()

void        xmlCleanupOutputCallbacks       (void);

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

+ +

xmlRegisterDefaultInputCallbacks ()

void        xmlRegisterDefaultInputCallbacks
+                                            (void);

+Registers the default compiled-in I/O handlers.

+ +

xmlAllocParserInputBuffer ()

xmlParserInputBufferPtr xmlAllocParserInputBuffer
+                                            (xmlCharEncoding enc);

+Create a buffered parser input for progressive parsing

+ +

enc : the charset encoding if known +
Returns :the new parser input or NULL +

xmlParserInputBufferCreateFilename ()

xmlParserInputBufferPtr xmlParserInputBufferCreateFilename
+                                            (const char *URI,
+                                             xmlCharEncoding enc);

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

+ +

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

xmlParserInputBufferCreateFile ()

xmlParserInputBufferPtr xmlParserInputBufferCreateFile
+                                            (FILE *file,
+                                             xmlCharEncoding enc);

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

+ +

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

xmlParserInputBufferCreateFd ()

xmlParserInputBufferPtr xmlParserInputBufferCreateFd
+                                            (int fd,
+                                             xmlCharEncoding enc);

+Create a buffered parser input for the progressive parsing for the input +from a file descriptor

+ +

fd : a file descriptor number +
enc : the charset encoding if known +
Returns :the new parser input or NULL +

xmlParserInputBufferCreateMem ()

xmlParserInputBufferPtr xmlParserInputBufferCreateMem
+                                            (const char *mem,
+                                             int size,
+                                             xmlCharEncoding enc);

+Create a buffered parser input for the progressive parsing for the input +from a memory area.

+ +

mem : the memory input +
size : the length of the memory block +
enc : the charset encoding if known +
Returns :the new parser input or NULL +

xmlParserInputBufferCreateIO ()

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

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

+ +

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

xmlParserInputBufferRead ()

int         xmlParserInputBufferRead        (xmlParserInputBufferPtr in,
+                                             int len);

+Refresh the content of the input buffer, the old data are considered +consumed +This routine handle the I18N transcoding to internal UTF-8

+ +

in : a buffered parser input +
len : indicative value of the amount of chars to read +
Returns :the number of chars read and stored in the buffer, or -1 + in case of error. +

xmlParserInputBufferGrow ()

int         xmlParserInputBufferGrow        (xmlParserInputBufferPtr in,
+                                             int len);

+Grow up the content of the input buffer, the old data are preserved +This routine handle the I18N transcoding to internal UTF-8 +This routine is used when operating the parser in normal (pull) mode +

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

+ +

in : a buffered parser input +
len : indicative value of the amount of chars to read +
Returns :the number of chars read and stored in the buffer, or -1 + in case of error. +

xmlParserInputBufferPush ()

int         xmlParserInputBufferPush        (xmlParserInputBufferPtr in,
+                                             int len,
+                                             const char *buf);

+Push the content of the arry in the input buffer +This routine handle the I18N transcoding to internal UTF-8 +This is used when operating the parser in progressive (push) mode.

+ +

in : a buffered parser input +
len : the size in bytes of the array. +
buf : an char array +
Returns :the number of chars read and stored in the buffer, or -1 + in case of error. +

xmlFreeParserInputBuffer ()

void        xmlFreeParserInputBuffer        (xmlParserInputBufferPtr in);

+Free up the memory used by a buffered parser input

+ +

in : a buffered parser input +

xmlParserGetDirectory ()

char*       xmlParserGetDirectory           (const char *filename);

+lookup the directory for that file

+ +

filename : the path to a file +
Returns :a new allocated string containing the directory, or NULL. +

xmlRegisterInputCallbacks ()

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

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

+ +

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

xmlRegisterDefaultOutputCallbacks ()

void        xmlRegisterDefaultOutputCallbacks
+                                            (void);

+Registers the default compiled-in I/O handlers.

+ +

xmlAllocOutputBuffer ()

xmlOutputBufferPtr xmlAllocOutputBuffer     (xmlCharEncodingHandlerPtr encoder);

+Create a buffered parser output

+ +

encoder : the encoding converter or NULL +
Returns :the new parser output or NULL +

xmlOutputBufferCreateFilename ()

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

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

+ +

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

xmlOutputBufferCreateFile ()

xmlOutputBufferPtr xmlOutputBufferCreateFile
+                                            (FILE *file,
+                                             xmlCharEncodingHandlerPtr encoder);

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

+ +

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

xmlOutputBufferCreateFd ()

xmlOutputBufferPtr xmlOutputBufferCreateFd  (int fd,
+                                             xmlCharEncodingHandlerPtr encoder);

+Create a buffered output for the progressive saving +to a file descriptor

+ +

fd : a file descriptor number +
encoder : the encoding converter or NULL +
Returns :the new parser output or NULL +

xmlOutputBufferCreateIO ()

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

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

+ +

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

xmlOutputBufferWrite ()

int         xmlOutputBufferWrite            (xmlOutputBufferPtr out,
+                                             int len,
+                                             const char *buf);

+Write the content of the array in the output I/O buffer +This routine handle the I18N transcoding from internal UTF-8 +The buffer is lossless, i.e. will store in case of partial +or delayed writes.

+ +

out : a buffered parser output +
len : the size in bytes of the array. +
buf : an char array +
Returns :the number of chars immediately written, or -1 + in case of error. +

xmlOutputBufferWriteString ()

int         xmlOutputBufferWriteString      (xmlOutputBufferPtr out,
+                                             const char *str);

+Write the content of the string in the output I/O buffer +This routine handle the I18N transcoding from internal UTF-8 +The buffer is lossless, i.e. will store in case of partial +or delayed writes.

+ +

out : a buffered parser output +
str : a zero terminated C string +
Returns :the number of chars immediately written, or -1 + in case of error. +

xmlOutputBufferFlush ()

int         xmlOutputBufferFlush            (xmlOutputBufferPtr out);

+flushes the output I/O channel

+ +

out : a buffered output +
Returns :the number of byte written or -1 in case of error. +

xmlOutputBufferClose ()

int         xmlOutputBufferClose            (xmlOutputBufferPtr out);

+flushes and close the output I/O channel +and free up all the associated resources

+ +

out : a buffered output +
Returns :the number of byte written or -1 in case of error. +

xmlRegisterOutputCallbacks ()

int         xmlRegisterOutputCallbacks      (xmlOutputMatchCallback matchFunc,
+                                             xmlOutputOpenCallback openFunc,
+                                             xmlOutputWriteCallback writeFunc,
+                                             xmlOutputCloseCallback closeFunc);

+Register a new set of I/O callback for handling output.

+ +

matchFunc : the xmlOutputMatchCallback +
openFunc : the xmlOutputOpenCallback +
writeFunc : the xmlOutputWriteCallback +
closeFunc : the xmlOutputCloseCallback +
Returns :the registered handler number or -1 in case of error +

xmlIOHTTPOpenW ()

void*       xmlIOHTTPOpenW                  (const char *post_uri,
+                                             int compression);

+Open a temporary buffer to collect the document for a subsequent HTTP POST +request. Non-static as is called from the output buffer creation routine.

+ +

post_uri : The destination URI for the document +
compression : The compression desired for the document. +

xmlRegisterHTTPPostCallbacks ()

void        xmlRegisterHTTPPostCallbacks    (void);

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

+ +

xmlNoNetExternalEntityLoader ()

xmlParserInputPtr xmlNoNetExternalEntityLoader
+                                            (const char *URL,
+                                             const char *ID,
+                                             xmlParserCtxtPtr ctxt);

+A specific entity loader disabling network accesses, though still +allowing local catalog accesses for resolution.

+ +

URL : the URL for the entity to load +
ID : the System ID for the entity to load +
ctxt : the context in which the entity is called or NULL +
Returns :a new allocated xmlParserInputPtr, or NULL. +

xmlNormalizeWindowsPath ()

xmlChar*    xmlNormalizeWindowsPath         (const xmlChar *path);

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

+ +

path : the input file path +
Returns :a canonicalized version of the path +

xmlCheckFilename ()

int         xmlCheckFilename                (const char *path);

+function checks to see if path is a valid source +(file, socket...) for XML. +

+if stat is not available on the target machine, +returns 1. if stat fails, returns 0 (if calling +stat on the filename fails, it can't be right). +if stat succeeds and the file is a directory,

+ +

path : the path to check +
Returns :2. otherwise returns 1. +

xmlFileMatch ()

int         xmlFileMatch                    (const char *filename);

+input from FILE *

+ +

filename : the URI for matching +
Returns :1 if matches, 0 otherwise +

xmlFileOpen ()

void*       xmlFileOpen                     (const char *filename);

+Wrapper around xmlFileOpen_real that try it with an unescaped +version of filename, if this fails fallback to filename

+ +

filename : the URI for matching +

xmlFileRead ()

int         xmlFileRead                     (void *context,
+                                             char *buffer,
+                                             int len);

+Read len bytes to buffer from the I/O channel.

+ +

context : the I/O context +
buffer : where to drop data +
len : number of bytes to write +
Returns :the number of bytes written +

xmlFileClose ()

int         xmlFileClose                    (void *context);

+Close an I/O channel

+ +

context : the I/O context +
Returns :0 or -1 in case of error +

xmlIOHTTPMatch ()

int         xmlIOHTTPMatch                  (const char *filename);

+check if the URI matches an HTTP one

+ +

filename : the URI for matching +
Returns :1 if matches, 0 otherwise +

xmlIOHTTPOpen ()

void*       xmlIOHTTPOpen                   (const char *filename);

+open an HTTP I/O channel

+ +

filename : the URI for matching +

xmlIOHTTPRead ()

int         xmlIOHTTPRead                   (void *context,
+                                             char *buffer,
+                                             int len);

+Read len bytes to buffer from the I/O channel.

+ +

context : the I/O context +
buffer : where to drop data +
len : number of bytes to write +
Returns :the number of bytes written +

xmlIOHTTPClose ()

int         xmlIOHTTPClose                  (void *context);

+Close an HTTP I/O channel

+ +

context : the I/O context +
Returns :0 +

xmlIOFTPMatch ()

int         xmlIOFTPMatch                   (const char *filename);

+check if the URI matches an FTP one

+ +

filename : the URI for matching +
Returns :1 if matches, 0 otherwise +

xmlIOFTPOpen ()

void*       xmlIOFTPOpen                    (const char *filename);

+open an FTP I/O channel

+ +

filename : the URI for matching +

xmlIOFTPRead ()

int         xmlIOFTPRead                    (void *context,
+                                             char *buffer,
+                                             int len);

+Read len bytes to buffer from the I/O channel.

+ +

context : the I/O context +
buffer : where to drop data +
len : number of bytes to write +
Returns :the number of bytes written +

xmlIOFTPClose ()

int         xmlIOFTPClose                   (void *context);

+Close an FTP I/O channel

+ +

context : the I/O context +
Returns :0 +
<< nanoftpcatalog >>
diff --git a/doc/html/libxml-xmlautomata.html b/doc/html/libxml-xmlautomata.html index f8265c2f..698112f3 100644 --- a/doc/html/libxml-xmlautomata.html +++ b/doc/html/libxml-xmlautomata.html @@ -1,2609 +1,284 @@ -xmlautomata
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

xmlautomata

Name

xmlautomata -- 

Synopsis


+
+xmlautomata
PrevUpHomeGnome XML Library Reference ManualNext
xmlautomata
xmlautomata — 
Synopsis
 
-struct      xmlAutomata;
-typedef     xmlAutomataPtr;
-struct      xmlAutomataState;
-typedef     xmlAutomataStatePtr;
-xmlAutomataPtr xmlNewAutomata               (void);
-void        xmlFreeAutomata                 (xmlAutomataPtr am);
-xmlAutomataStatePtr xmlAutomataGetInitState (xmlAutomataPtr am);
-int         xmlAutomataSetFinalState        (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr state);
-xmlAutomataStatePtr xmlAutomataNewState     (xmlAutomataPtr am);
-xmlAutomataStatePtr xmlAutomataNewTransition
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             const xmlChar *token,
+
+
+struct      xmlAutomata;
+typedef     xmlAutomataPtr;
+struct      xmlAutomataState;
+typedef     xmlAutomataStatePtr;
+xmlAutomataPtr xmlNewAutomata               (void);
+void        xmlFreeAutomata                 (xmlAutomataPtr am);
+xmlAutomataStatePtr xmlAutomataGetInitState (xmlAutomataPtr am);
+int         xmlAutomataSetFinalState        (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr state);
+xmlAutomataStatePtr xmlAutomataNewState     (xmlAutomataPtr am);
+xmlAutomataStatePtr xmlAutomataNewTransition
+                                            (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr from,
+                                             xmlAutomataStatePtr to,
+                                             const xmlChar *token,
                                              void *data);
-xmlAutomataStatePtr xmlAutomataNewCountTrans
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             const xmlChar *token,
+xmlAutomataStatePtr xmlAutomataNewTransition2
+                                            (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr from,
+                                             xmlAutomataStatePtr to,
+                                             const xmlChar *token,
+                                             const xmlChar *token2,
+                                             void *data);
+xmlAutomataStatePtr xmlAutomataNewCountTrans
+                                            (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr from,
+                                             xmlAutomataStatePtr to,
+                                             const xmlChar *token,
                                              int min,
                                              int max,
                                              void *data);
-xmlAutomataStatePtr xmlAutomataNewOnceTrans (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             const xmlChar *token,
+xmlAutomataStatePtr xmlAutomataNewOnceTrans (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr from,
+                                             xmlAutomataStatePtr to,
+                                             const xmlChar *token,
                                              int min,
                                              int max,
                                              void *data);
-xmlAutomataStatePtr xmlAutomataNewAllTrans  (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
+xmlAutomataStatePtr xmlAutomataNewAllTrans  (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr from,
+                                             xmlAutomataStatePtr to,
                                              int lax);
-xmlAutomataStatePtr xmlAutomataNewEpsilon   (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to);
-xmlAutomataStatePtr xmlAutomataNewCountedTrans
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
+xmlAutomataStatePtr xmlAutomataNewEpsilon   (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr from,
+                                             xmlAutomataStatePtr to);
+xmlAutomataStatePtr xmlAutomataNewCountedTrans
+                                            (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr from,
+                                             xmlAutomataStatePtr to,
                                              int counter);
-xmlAutomataStatePtr xmlAutomataNewCounterTrans
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
+xmlAutomataStatePtr xmlAutomataNewCounterTrans
+                                            (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr from,
+                                             xmlAutomataStatePtr to,
                                              int counter);
-int         xmlAutomataNewCounter           (xmlAutomataPtr am,
+int         xmlAutomataNewCounter           (xmlAutomataPtr am,
                                              int min,
                                              int max);
-xmlRegexpPtr xmlAutomataCompile             (xmlAutomataPtr am);
-int         xmlAutomataIsDeterminist        (xmlAutomataPtr am);

Description

Details

struct xmlAutomata

struct xmlAutomata;

xmlAutomataPtr

A libxml automata description, It can be compiled into a regexp

struct xmlAutomataState

struct xmlAutomataState;

xmlAutomataStatePtr

A state int the automata description,

xmlNewAutomata ()

xmlAutomataPtr xmlNewAutomata               (void);

Create a new automata

Returns : 

xmlFreeAutomata ()

void        xmlFreeAutomata                 (xmlAutomataPtr am);

Free an automata

am : 

xmlAutomataGetInitState ()

xmlAutomataStatePtr xmlAutomataGetInitState (xmlAutomataPtr am);

Initial state lookup

am : 
Returns : 

xmlAutomataSetFinalState ()

int         xmlAutomataSetFinalState        (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr state);

Makes that state a final state

am : 
state : 
Returns : 

xmlAutomataNewState ()

xmlAutomataStatePtr xmlAutomataNewState     (xmlAutomataPtr am);

Create a new disconnected state in the automata

am : 
Returns : 

xmlAutomataNewTransition ()

xmlAutomataStatePtr xmlAutomataNewTransition
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             const xmlChar *token,
-                                             void *data);

If to is NULL, this create first a new target state in the automata -and then adds a transition from the from state to the target state -activated by the value of token

am : 
from : 
to : 
token : 
data : 
Returns : 

xmlAutomataNewCountTrans ()

xmlAutomataStatePtr xmlAutomataNewCountTrans
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             const xmlChar *token,
+xmlRegexpPtr xmlAutomataCompile             (xmlAutomataPtr am);
+int         xmlAutomataIsDeterminist        (xmlAutomataPtr am);
+

Description

+ +

Details

struct xmlAutomata

struct xmlAutomata;

+ +

xmlAutomataPtr

typedef xmlAutomata *xmlAutomataPtr;
+

+A libxml automata description, It can be compiled into a regexp

+ +

struct xmlAutomataState

struct xmlAutomataState;

+ +

xmlAutomataStatePtr

typedef xmlAutomataState *xmlAutomataStatePtr;
+

+A state int the automata description,

+ +

xmlNewAutomata ()

xmlAutomataPtr xmlNewAutomata               (void);

+Create a new automata

+ +

Returns :the new object or NULL in case of failure +

xmlFreeAutomata ()

void        xmlFreeAutomata                 (xmlAutomataPtr am);

+Free an automata

+ +

am : an automata +

xmlAutomataGetInitState ()

xmlAutomataStatePtr xmlAutomataGetInitState (xmlAutomataPtr am);

+Initial state lookup

+ +

am : an automata +
Returns :the initial state of the automata +

xmlAutomataSetFinalState ()

int         xmlAutomataSetFinalState        (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr state);

+Makes that state a final state

+ +

am : an automata +
state : a state in this automata +
Returns :0 or -1 in case of error +

xmlAutomataNewState ()

xmlAutomataStatePtr xmlAutomataNewState     (xmlAutomataPtr am);

+Create a new disconnected state in the automata

+ +

am : an automata +
Returns :the new state or NULL in case of error +

xmlAutomataNewTransition ()

xmlAutomataStatePtr xmlAutomataNewTransition
+                                            (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr from,
+                                             xmlAutomataStatePtr to,
+                                             const xmlChar *token,
+                                             void *data);

+If to is NULL, this create first a new target state in the automata +and then adds a transition from the from state to the target state +activated by the value of token

+ +

am : an automata +
from : the starting point of the transition +
to : the target point of the transition or NULL +
token : the input string associated to that transition +
data : data passed to the callback function if the transition is activated +
Returns :the target state or NULL in case of error +

xmlAutomataNewTransition2 ()

xmlAutomataStatePtr xmlAutomataNewTransition2
+                                            (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr from,
+                                             xmlAutomataStatePtr to,
+                                             const xmlChar *token,
+                                             const xmlChar *token2,
+                                             void *data);

+If to is NULL, this create first a new target state in the automata +and then adds a transition from the from state to the target state +activated by the value of token

+ +

am : an automata +
from : the starting point of the transition +
to : the target point of the transition or NULL +
token : the first input string associated to that transition +
token2 : the second input string associated to that transition +
data : data passed to the callback function if the transition is activated +
Returns :the target state or NULL in case of error +

xmlAutomataNewCountTrans ()

xmlAutomataStatePtr xmlAutomataNewCountTrans
+                                            (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr from,
+                                             xmlAutomataStatePtr to,
+                                             const xmlChar *token,
                                              int min,
                                              int max,
-                                             void *data);

If to is NULL, this create first a new target state in the automata -and then adds a transition from the from state to the target state -activated by a succession of input of value token and whose number -is between min and max

am : 
from : 
to : 
token : 
min : 
max : 
data : 
Returns : 

xmlAutomataNewOnceTrans ()

xmlAutomataStatePtr xmlAutomataNewOnceTrans (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             const xmlChar *token,
+                                             void *data);

+If to is NULL, this create first a new target state in the automata +and then adds a transition from the from state to the target state +activated by a succession of input of value token and whose number +is between min and max

+ +

am : an automata +
from : the starting point of the transition +
to : the target point of the transition or NULL +
token : the input string associated to that transition +
min : the minimum successive occurences of token +
max : the maximum successive occurences of token +
data : data associated to the transition +
Returns :the target state or NULL in case of error +

xmlAutomataNewOnceTrans ()

xmlAutomataStatePtr xmlAutomataNewOnceTrans (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr from,
+                                             xmlAutomataStatePtr to,
+                                             const xmlChar *token,
                                              int min,
                                              int max,
-                                             void *data);

If to is NULL, this create first a new target state in the automata -and then adds a transition from the from state to the target state -activated by a succession of input of value token and whose number -is between min and max, moreover that transistion can only be crossed -once.

am : 
from : 
to : 
token : 
min : 
max : 
data : 
Returns : 

xmlAutomataNewAllTrans ()

xmlAutomataStatePtr xmlAutomataNewAllTrans  (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             int lax);

If to is NULL, this create first a new target state in the automata -and then adds a an ALL transition from the from state to the + void *data);

+If to is NULL, this create first a new target state in the automata +and then adds a transition from the from state to the target state +activated by a succession of input of value token and whose number +is between min and max, moreover that transistion can only be crossed +once.

+ +

am : an automata +
from : the starting point of the transition +
to : the target point of the transition or NULL +
token : the input string associated to that transition +
min : the minimum successive occurences of token +
max : the maximum successive occurences of token +
data : data associated to the transition +
Returns :the target state or NULL in case of error +

xmlAutomataNewAllTrans ()

xmlAutomataStatePtr xmlAutomataNewAllTrans  (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr from,
+                                             xmlAutomataStatePtr to,
+                                             int lax);

+If to is NULL, this create first a new target state in the automata +and then adds a an ALL transition from the from state to the target state. That transition is an epsilon transition allowed only when -all transitions from the from node have been activated.

am : 
from : 
to : 
lax : 
Returns : 

xmlAutomataNewEpsilon ()

xmlAutomataStatePtr xmlAutomataNewEpsilon   (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to);

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

am : 
from : 
to : 
Returns : 

xmlAutomataNewCountedTrans ()

xmlAutomataStatePtr xmlAutomataNewCountedTrans
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             int counter);

If to is NULL, this create first a new target state in the automata -and then adds an epsilon transition from the from state to the target state -which will increment the counter provided

am : 
from : 
to : 
counter : 
Returns : 

xmlAutomataNewCounterTrans ()

xmlAutomataStatePtr xmlAutomataNewCounterTrans
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             int counter);

If to is NULL, this create first a new target state in the automata -and then adds an epsilon transition from the from state to the target state -which will be allowed only if the counter is within the right range.

am : 
from : 
to : 
counter : 
Returns : 

xmlAutomataNewCounter ()

int         xmlAutomataNewCounter           (xmlAutomataPtr am,
+all transitions from the from node have been activated.

+
+
am : an automata
+
from : the starting point of the transition
+
to : the target point of the transition or NULL
+
lax : allow to transition if not all all transitions have been activated
+
Returns :the target state or NULL in case of error
+
xmlAutomataNewEpsilon ()
xmlAutomataStatePtr xmlAutomataNewEpsilon   (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr from,
+                                             xmlAutomataStatePtr to);

+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

+
+
am : an automata
+
from : the starting point of the transition
+
to : the target point of the transition or NULL
+
Returns :the target state or NULL in case of error
+
xmlAutomataNewCountedTrans ()
xmlAutomataStatePtr xmlAutomataNewCountedTrans
+                                            (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr from,
+                                             xmlAutomataStatePtr to,
+                                             int counter);

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

+
+
am : an automata
+
from : the starting point of the transition
+
to : the target point of the transition or NULL
+
counter : the counter associated to that transition
+
Returns :the target state or NULL in case of error
+
xmlAutomataNewCounterTrans ()
xmlAutomataStatePtr xmlAutomataNewCounterTrans
+                                            (xmlAutomataPtr am,
+                                             xmlAutomataStatePtr from,
+                                             xmlAutomataStatePtr to,
+                                             int counter);

+If to is NULL, this create first a new target state in the automata
+and then adds an epsilon transition from the from state to the target state
+which will be allowed only if the counter is within the right range.

+
+
am : an automata
+
from : the starting point of the transition
+
to : the target point of the transition or NULL
+
counter : the counter associated to that transition
+
Returns :the target state or NULL in case of error
+
xmlAutomataNewCounter ()
int         xmlAutomataNewCounter           (xmlAutomataPtr am,
                                              int min,
-                                             int max);

Create a new counter

am : 
min : 
max : 
Returns : 

xmlAutomataCompile ()

xmlRegexpPtr xmlAutomataCompile             (xmlAutomataPtr am);

Compile the automata into a Reg Exp ready for being executed. -The automata should be free after this point.

am : 
Returns : 

xmlAutomataIsDeterminist ()

int         xmlAutomataIsDeterminist        (xmlAutomataPtr am);

Checks if an automata is determinist.

am : 
Returns : 

\ No newline at end of file + int max);

+Create a new counter

+ +

am : an automata +
min : the minimal value on the counter +
max : the maximal value on the counter +
Returns :the counter number or -1 in case of error +

xmlAutomataCompile ()

xmlRegexpPtr xmlAutomataCompile             (xmlAutomataPtr am);

+Compile the automata into a Reg Exp ready for being executed. +The automata should be free after this point.

+ +

am : an automata +
Returns :the compiled regexp or NULL in case of error +

xmlAutomataIsDeterminist ()

int         xmlAutomataIsDeterminist        (xmlAutomataPtr am);

+Checks if an automata is determinist.

+ +

am : an automata +
Returns :1 if true, 0 if not, and -1 in case of error +
<< xmlregexpxmlunicode >>
diff --git a/doc/html/libxml-xmlerror.html b/doc/html/libxml-xmlerror.html index 69ffd1c1..2dbddfc7 100644 --- a/doc/html/libxml-xmlerror.html +++ b/doc/html/libxml-xmlerror.html @@ -1,255 +1,62 @@ -xmlerror
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

xmlerror

Name

xmlerror -- 

Synopsis


+
+xmlerror
PrevUpHomeGnome XML Library Reference ManualNext
xmlerror
xmlerror — 
Synopsis
 
-enum        xmlParserErrors;
-void        (*xmlGenericErrorFunc)          (void *ctx,
+
+
+enum        xmlParserErrors;
+void        (*xmlGenericErrorFunc)          (void *ctx,
                                              const char *msg,
                                              ...);
-void        xmlSetGenericErrorFunc          (void *ctx,
-                                             xmlGenericErrorFunc handler);
-void        initGenericErrorDefaultFunc     (xmlGenericErrorFunc *handler);
-void        xmlParserError                  (void *ctx,
+void        xmlSetGenericErrorFunc          (void *ctx,
+                                             xmlGenericErrorFunc handler);
+void        initGenericErrorDefaultFunc     (xmlGenericErrorFunc *handler);
+void        xmlParserError                  (void *ctx,
                                              const char *msg,
                                              ...);
-void        xmlParserWarning                (void *ctx,
+void        xmlParserWarning                (void *ctx,
                                              const char *msg,
                                              ...);
-void        xmlParserValidityError          (void *ctx,
+void        xmlParserValidityError          (void *ctx,
                                              const char *msg,
                                              ...);
-void        xmlParserValidityWarning        (void *ctx,
+void        xmlParserValidityWarning        (void *ctx,
                                              const char *msg,
                                              ...);
-void        xmlParserPrintFileInfo          (xmlParserInputPtr input);
-void        xmlParserPrintFileContext       (xmlParserInputPtr input);

Description

Details

enum xmlParserErrors

typedef enum {
+void        xmlParserPrintFileInfo          (xmlParserInputPtr input);
+void        xmlParserPrintFileContext       (xmlParserInputPtr input);
+

Description

+ +

Details

enum xmlParserErrors

typedef enum {
     XML_ERR_OK = 0,
     XML_ERR_INTERNAL_ERROR,
     XML_ERR_NO_MEMORY,
@@ -378,949 +185,77 @@ CLASS="PROGRAMLISTING"
     XML_ERR_URI_FRAGMENT, /* 92 */
     XML_WAR_CATALOG_PI, /* 93 */
     XML_ERR_NO_DTD  /* 94 */
-}xmlParserErrors;

xmlGenericErrorFunc ()

void        (*xmlGenericErrorFunc)          (void *ctx,
+}xmlParserErrors;
+

+ +

xmlGenericErrorFunc ()

void        (*xmlGenericErrorFunc)          (void *ctx,
                                              const char *msg,
-                                             ...);

Signature of the function to use when there is an error and -no parsing or validity context available .

ctx : 
msg : 
... : 

xmlSetGenericErrorFunc ()

void        xmlSetGenericErrorFunc          (void *ctx,
-                                             xmlGenericErrorFunc handler);

Function to reset the handler and the error context for out of + ...);

+Signature of the function to use when there is an error and +no parsing or validity context available .

+ +

ctx : a parsing context +
msg : the message +
... : the extra arguments of the varags to format the message +

xmlSetGenericErrorFunc ()

void        xmlSetGenericErrorFunc          (void *ctx,
+                                             xmlGenericErrorFunc handler);

+Function to reset the handler and the error context for out of context error messages. -This simply means that handler will be called for subsequent -error messages while not parsing nor validating. And ctx will -be passed as first argument to handler +This simply means that handler will be called for subsequent +error messages while not parsing nor validating. And ctx will +be passed as first argument to handler One can simply force messages to be emitted to another FILE * than -stderr by setting ctx to this file handle and handler to NULL.

ctx : 
handler : 

initGenericErrorDefaultFunc ()

void        initGenericErrorDefaultFunc     (xmlGenericErrorFunc *handler);

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

handler : 

xmlParserError ()

void        xmlParserError                  (void *ctx,
+stderr by setting ctx to this file handle and handler to NULL.

+
+
ctx :  the new error handling context
+
handler :  the new handler function
+
initGenericErrorDefaultFunc ()
void        initGenericErrorDefaultFunc     (xmlGenericErrorFunc *handler);

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

+
+
handler :  the handler
+
xmlParserError ()
void        xmlParserError                  (void *ctx,
                                              const char *msg,
-                                             ...);

Display and format an error messages, gives file, line, position and -extra parameters.

ctx : 
msg : 
... : 

xmlParserWarning ()

void        xmlParserWarning                (void *ctx,
+                                             ...);

+Display and format an error messages, gives file, line, position and +extra parameters.

+ +

ctx : an XML parser context +
msg : the message to display/transmit +
... : extra parameters for the message display +

xmlParserWarning ()

void        xmlParserWarning                (void *ctx,
                                              const char *msg,
-                                             ...);

Display and format a warning messages, gives file, line, position and -extra parameters.

ctx : 
msg : 
... : 

xmlParserValidityError ()

void        xmlParserValidityError          (void *ctx,
+                                             ...);

+Display and format a warning messages, gives file, line, position and +extra parameters.

+ +

ctx : an XML parser context +
msg : the message to display/transmit +
... : extra parameters for the message display +

xmlParserValidityError ()

void        xmlParserValidityError          (void *ctx,
                                              const char *msg,
-                                             ...);

Display and format an validity error messages, gives file, -line, position and extra parameters.

ctx : 
msg : 
... : 

xmlParserValidityWarning ()

void        xmlParserValidityWarning        (void *ctx,
+                                             ...);

+Display and format an validity error messages, gives file, +line, position and extra parameters.

+ +

ctx : an XML parser context +
msg : the message to display/transmit +
... : extra parameters for the message display +

xmlParserValidityWarning ()

void        xmlParserValidityWarning        (void *ctx,
                                              const char *msg,
-                                             ...);

Display and format a validity warning messages, gives file, line, -position and extra parameters.

ctx : 
msg : 
... : 

xmlParserPrintFileInfo ()

void        xmlParserPrintFileInfo          (xmlParserInputPtr input);

Displays the associated file and line informations for the current input

input : 

xmlParserPrintFileContext ()

void        xmlParserPrintFileContext       (xmlParserInputPtr input);

Displays current context within the input content for error tracking

input : 

\ No newline at end of file + ...);

+Display and format a validity warning messages, gives file, line, +position and extra parameters.

+ +

ctx : an XML parser context +
msg : the message to display/transmit +
... : extra parameters for the message display +

xmlParserPrintFileInfo ()

void        xmlParserPrintFileInfo          (xmlParserInputPtr input);

+Displays the associated file and line informations for the current input

+ +

input : an xmlParserInputPtr input +

xmlParserPrintFileContext ()

void        xmlParserPrintFileContext       (xmlParserInputPtr input);

+Displays current context within the input content for error tracking

+ +

input : an xmlParserInputPtr input +
<< uriHTMLparser >>
diff --git a/doc/html/libxml-xmlmemory.html b/doc/html/libxml-xmlmemory.html index 78c43443..4e7a0374 100644 --- a/doc/html/libxml-xmlmemory.html +++ b/doc/html/libxml-xmlmemory.html @@ -1,2287 +1,260 @@ -xmlmemory
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

xmlmemory

Name

xmlmemory -- 

Synopsis


+
+xmlmemory
PrevUpHomeGnome XML Library Reference ManualNext
xmlmemory
xmlmemory — 
Synopsis
 
-#define     DEBUG_MEMORY
-void        (*xmlFreeFunc)                  (void *mem);
-void*       (*xmlMallocFunc)                (size_t size);
-void*       (*xmlReallocFunc)               (void *mem,
-                                             size_t size);
-char*       (*xmlStrdupFunc)                (const char *str);
-int         xmlMemSetup                     (xmlFreeFunc freeFunc,
-                                             xmlMallocFunc mallocFunc,
-                                             xmlReallocFunc reallocFunc,
-                                             xmlStrdupFunc strdupFunc);
-int         xmlMemGet                       (xmlFreeFunc *freeFunc,
-                                             xmlMallocFunc *mallocFunc,
-                                             xmlReallocFunc *reallocFunc,
-                                             xmlStrdupFunc *strdupFunc);
-int         xmlInitMemory                   (void);
-int         xmlMemUsed                      (void);
-void        xmlMemDisplay                   (FILE *fp);
-void        xmlMemShow                      (FILE *fp,
+
+
+#define     DEBUG_MEMORY
+void        (*xmlFreeFunc)                  (void *mem);
+void*       (*xmlMallocFunc)                (size_t size);
+void*       (*xmlReallocFunc)               (void *mem,
+                                             size_t size);
+char*       (*xmlStrdupFunc)                (const char *str);
+int         xmlMemSetup                     (xmlFreeFunc freeFunc,
+                                             xmlMallocFunc mallocFunc,
+                                             xmlReallocFunc reallocFunc,
+                                             xmlStrdupFunc strdupFunc);
+int         xmlMemGet                       (xmlFreeFunc *freeFunc,
+                                             xmlMallocFunc *mallocFunc,
+                                             xmlReallocFunc *reallocFunc,
+                                             xmlStrdupFunc *strdupFunc);
+int         xmlGcMemSetup                   (xmlFreeFunc freeFunc,
+                                             xmlMallocFunc mallocFunc,
+                                             xmlMallocFunc mallocAtomicFunc,
+                                             xmlReallocFunc reallocFunc,
+                                             xmlStrdupFunc strdupFunc);
+int         xmlGcMemGet                     (xmlFreeFunc *freeFunc,
+                                             xmlMallocFunc *mallocFunc,
+                                             xmlMallocFunc *mallocAtomicFunc,
+                                             xmlReallocFunc *reallocFunc,
+                                             xmlStrdupFunc *strdupFunc);
+int         xmlInitMemory                   (void);
+int         xmlMemUsed                      (void);
+void        xmlMemDisplay                   (FILE *fp);
+void        xmlMemShow                      (FILE *fp,
                                              int nr);
-void        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                       (size)
-#define     xmlRealloc                      (ptr, size)
-#define     xmlMemStrdup                    (str)
-void*       xmlMallocLoc                    (size_t size,
+void        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                       (size)
+#define     xmlMallocAtomic                 (size)
+#define     xmlRealloc                      (ptr, size)
+#define     xmlMemStrdup                    (str)
+void*       xmlMallocLoc                    (size_t size,
                                              const char *file,
                                              int line);
-void*       xmlReallocLoc                   (void *ptr,
-                                             size_t size,
+void*       xmlReallocLoc                   (void *ptr,
+                                             size_t size,
                                              const char *file,
                                              int line);
-char*       xmlMemStrdupLoc                 (const char *str,
+char*       xmlMemStrdupLoc                 (const char *str,
                                              const char *file,
-                                             int line);

Description

Details

DEBUG_MEMORY

#define     DEBUG_MEMORY

DEBUG_MEMORY replaces the allocator with a collect and debug + int line); +

Description

+ +

Details

DEBUG_MEMORY

#define DEBUG_MEMORY
+

+DEBUG_MEMORY replaces the allocator with a collect and debug shell to the libc allocator. DEBUG_MEMORY should only be activated when debugging -libxml i.e. if libxml has been configured with --with-debug-mem too.

xmlFreeFunc ()

void        (*xmlFreeFunc)                  (void *mem);

Signature for a free() implementation.

mem : 

xmlMallocFunc ()

void*       (*xmlMallocFunc)                (size_t size);

Signature for a malloc() implementation.

size : 

xmlReallocFunc ()

void*       (*xmlReallocFunc)               (void *mem,
-                                             size_t size);

Signature for a realloc() implementation.

mem : 
size : 

xmlStrdupFunc ()

char*       (*xmlStrdupFunc)                (const char *str);

Signature for an strdup() implementation.

str : 
Returns : 

xmlMemSetup ()

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

Override the default memory access functions with a new set -This has to be called before any other libxml routines !

Should this be blocked if there was already some allocations -done ?

freeFunc : 
mallocFunc : 
reallocFunc : 
strdupFunc : 
Returns : 

xmlMemGet ()

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

Provides the memory access functions set currently in use

freeFunc : 
mallocFunc : 
reallocFunc : 
strdupFunc : 
Returns : 

xmlInitMemory ()

int         xmlInitMemory                   (void);

Initialize the memory layer.

Returns : 

xmlMemUsed ()

int         xmlMemUsed                      (void);

Provides the amount of memory currently allocated

Returns : 

xmlMemDisplay ()

void        xmlMemDisplay                   (FILE *fp);

show in-extenso the memory blocks allocated

fp : 

xmlMemShow ()

void        xmlMemShow                      (FILE *fp,
-                                             int nr);

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

fp : 
nr : 

xmlMemoryDump ()

void        xmlMemoryDump                   (void);

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

xmlMemMalloc ()

void*       xmlMemMalloc                    (size_t size);

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

size : 

xmlMemRealloc ()

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

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

ptr : 
size : 

xmlMemFree ()

void        xmlMemFree                      (void *ptr);

a free() equivalent, with error checking.

ptr : 

xmlMemoryStrdup ()

char*       xmlMemoryStrdup                 (const char *str);

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

str : 
Returns : 

xmlMalloc()

#define     xmlMalloc(size)

Wrapper for the malloc() function used in the XML library.

size : 

xmlRealloc()

#define     xmlRealloc(ptr, size)

Wrapper for the realloc() function used in the XML library.

ptr : 
size : 

xmlMemStrdup()

#define     xmlMemStrdup(str)

Wrapper for the strdup() function, xmlStrdup() is usually preferred.

str : 

xmlMallocLoc ()

void*       xmlMallocLoc                    (size_t size,
+libxml i.e. if libxml has been configured with --with-debug-mem too.

+
+
xmlFreeFunc ()
void        (*xmlFreeFunc)                  (void *mem);

+Signature for a free() implementation.

+
+
mem : an already allocated block of memory
+
xmlMallocFunc ()
void*       (*xmlMallocFunc)                (size_t size);

+Signature for a malloc() implementation.

+
+
size :  the size requested in bytes
+
xmlReallocFunc ()
void*       (*xmlReallocFunc)               (void *mem,
+                                             size_t size);

+Signature for a realloc() implementation.

+
+
mem : an already allocated block of memory
+
size :  the new size requested in bytes
+
xmlStrdupFunc ()
char*       (*xmlStrdupFunc)                (const char *str);

+Signature for an strdup() implementation.

+
+
str : a zero terminated string
+
Returns :the copy of the string or NULL in case of error.
+
xmlMemSetup ()
int         xmlMemSetup                     (xmlFreeFunc freeFunc,
+                                             xmlMallocFunc mallocFunc,
+                                             xmlReallocFunc reallocFunc,
+                                             xmlStrdupFunc strdupFunc);

+Override the default memory access functions with a new set
+This has to be called before any other libxml routines !
+

+Should this be blocked if there was already some allocations
+done ?

+
+
freeFunc : the free() function to use
+
mallocFunc : the malloc() function to use
+
reallocFunc : the realloc() function to use
+
strdupFunc : the strdup() function to use
+
Returns :0 on success
+
xmlMemGet ()
int         xmlMemGet                       (xmlFreeFunc *freeFunc,
+                                             xmlMallocFunc *mallocFunc,
+                                             xmlReallocFunc *reallocFunc,
+                                             xmlStrdupFunc *strdupFunc);

+Provides the memory access functions set currently in use

+
+
freeFunc : place to save the free() function in use
+
mallocFunc : place to save the malloc() function in use
+
reallocFunc : place to save the realloc() function in use
+
strdupFunc : place to save the strdup() function in use
+
Returns :0 on success
+
xmlGcMemSetup ()
int         xmlGcMemSetup                   (xmlFreeFunc freeFunc,
+                                             xmlMallocFunc mallocFunc,
+                                             xmlMallocFunc mallocAtomicFunc,
+                                             xmlReallocFunc reallocFunc,
+                                             xmlStrdupFunc strdupFunc);

+Override the default memory access functions with a new set
+This has to be called before any other libxml routines !
+The mallocAtomicFunc is specialized for atomic block
+allocations (i.e. of areas  useful for garbage collected memory allocators
+

+Should this be blocked if there was already some allocations
+done ?

+
+
freeFunc : the free() function to use
+
mallocFunc : the malloc() function to use
+
mallocAtomicFunc : the malloc() function to use for atomic allocations
+
reallocFunc : the realloc() function to use
+
strdupFunc : the strdup() function to use
+
Returns :0 on success
+
xmlGcMemGet ()
int         xmlGcMemGet                     (xmlFreeFunc *freeFunc,
+                                             xmlMallocFunc *mallocFunc,
+                                             xmlMallocFunc *mallocAtomicFunc,
+                                             xmlReallocFunc *reallocFunc,
+                                             xmlStrdupFunc *strdupFunc);

+Provides the memory access functions set currently in use
+The mallocAtomicFunc is specialized for atomic block
+allocations (i.e. of areas  useful for garbage collected memory allocators

+
+
freeFunc : place to save the free() function in use
+
mallocFunc : place to save the malloc() function in use
+
mallocAtomicFunc : place to save the atomic malloc() function in use
+
reallocFunc : place to save the realloc() function in use
+
strdupFunc : place to save the strdup() function in use
+
Returns :0 on success
+
xmlInitMemory ()
int         xmlInitMemory                   (void);

+Initialize the memory layer.

+
+
Returns :0 on success
+
xmlMemUsed ()
int         xmlMemUsed                      (void);

+Provides the amount of memory currently allocated

+
+
Returns :an int representing the amount of memory allocated.
+
xmlMemDisplay ()
void        xmlMemDisplay                   (FILE *fp);

+show in-extenso the memory blocks allocated

+
+
fp :  a FILE descriptor used as the output file, if NULL, the result is
+      written to the file .memorylist
+
xmlMemShow ()
void        xmlMemShow                      (FILE *fp,
+                                             int nr);

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

+
+
fp :  a FILE descriptor used as the output file
+
nr :  number of entries to dump
+
xmlMemoryDump ()
void        xmlMemoryDump                   (void);

+Dump in-extenso the memory blocks allocated 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.
+
xmlMalloc()
#define     xmlMalloc(size)

+Wrapper for the malloc() function used in the XML library.

+
+
size :  number of bytes to allocate
+
xmlMallocAtomic()
#define     xmlMallocAtomic(size)

+Wrapper for the malloc() function used in the XML library for allocation
+of block not containing pointers to other areas.

+
+
size :  number of bytes to allocate
+
xmlRealloc()
#define     xmlRealloc(ptr, size)

+Wrapper for the realloc() function used in the XML library.

+
+
ptr :  pointer to the existing allocated area
+
size :  number of bytes to allocate
+
xmlMemStrdup()
#define     xmlMemStrdup(str)

+Wrapper for the strdup() function, xmlStrdup() is usually preferred.

+
+
str :  pointer to the existing string
+
xmlMallocLoc ()
void*       xmlMallocLoc                    (size_t size,
                                              const char *file,
-                                             int line);

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

size : 
file : 
line : 

xmlReallocLoc ()

void*       xmlReallocLoc                   (void *ptr,
-                                             size_t size,
+                                             int line);

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

+ +

size : an int specifying the size in byte to allocate. +
file : the file name or NULL +
line : the line number +

xmlReallocLoc ()

void*       xmlReallocLoc                   (void *ptr,
+                                             size_t size,
                                              const char *file,
-                                             int line);

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

ptr : 
size : 
file : 
line : 

xmlMemStrdupLoc ()

char*       xmlMemStrdupLoc                 (const char *str,
+                                             int line);

+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. +
file : the file name or NULL +
line : the line number +

xmlMemStrdupLoc ()

char*       xmlMemStrdupLoc                 (const char *str,
                                              const char *file,
-                                             int line);

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

str : 
file : 
line : 
Returns : 

\ No newline at end of file + int line);

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

+ +

str : the initial string pointer +
file : the file name or NULL +
line : the line number +
Returns :a pointer to the new string or NULL if allocation error occurred. +
<< debugXMLxmlregexp >>
diff --git a/doc/html/libxml-xmlreader.html b/doc/html/libxml-xmlreader.html index 734ea90a..6d45244e 100644 --- a/doc/html/libxml-xmlreader.html +++ b/doc/html/libxml-xmlreader.html @@ -1,5218 +1,497 @@ -xmlreader
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

xmlreader

Name

xmlreader -- 

Synopsis


+
+xmlreader
PrevUpHomeGnome XML Library Reference ManualNext
xmlreader
xmlreader — 
Synopsis
 
-enum        xmlParserProperties;
-enum        xmlParserSeverities;
-struct      xmlTextReader;
-typedef     xmlTextReaderPtr;
-xmlTextReaderPtr xmlNewTextReader           (xmlParserInputBufferPtr input,
+
+
+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,
+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,
+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         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         xmlTextReaderGetParserProp      (xmlTextReaderPtr reader,
                                              int prop);
-xmlNodePtr  xmlTextReaderCurrentNode        (xmlTextReaderPtr reader);
-xmlDocPtr   xmlTextReaderCurrentDoc         (xmlTextReaderPtr reader);
-typedef     xmlTextReaderLocatorPtr;
-void        (*xmlTextReaderErrorFunc)       (void *arg,
+xmlNodePtr  xmlTextReaderCurrentNode        (xmlTextReaderPtr reader);
+xmlDocPtr   xmlTextReaderCurrentDoc         (xmlTextReaderPtr reader);
+xmlNodePtr  xmlTextReaderExpand             (xmlTextReaderPtr reader);
+int         xmlTextReaderNext               (xmlTextReaderPtr reader);
+int         xmlTextReaderIsValid            (xmlTextReaderPtr reader);
+int         xmlTextReaderRelaxNGValidate    (xmlTextReaderPtr reader,
+                                             const char *rng);
+int         xmlTextReaderRelaxNGSetSchema   (xmlTextReaderPtr reader,
+                                             xmlRelaxNGPtr schema);
+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,
+                                             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 {
+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 {
+} 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

xmlNewTextReader ()

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

Create an xmlTextReader structure fed with input

input : 
URI : 
Returns : 

xmlNewTextReaderFilename ()

xmlTextReaderPtr xmlNewTextReaderFilename   (const char *URI);

Create an xmlTextReader structure fed with the resource at URI

URI : 
Returns : 

xmlFreeTextReader ()

void        xmlFreeTextReader               (xmlTextReaderPtr reader);

Deallocate all the resources associated to the reader

reader : 

xmlTextReaderRead ()

int         xmlTextReaderRead               (xmlTextReaderPtr reader);

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

reader : 
Returns : 

xmlTextReaderReadInnerXml ()

xmlChar*    xmlTextReaderReadInnerXml       (xmlTextReaderPtr reader);

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

reader : 
Returns : 

xmlTextReaderReadOuterXml ()

xmlChar*    xmlTextReaderReadOuterXml       (xmlTextReaderPtr reader);

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

reader : 
Returns : 

xmlTextReaderReadString ()

xmlChar*    xmlTextReaderReadString         (xmlTextReaderPtr reader);

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

reader : 
Returns : 

xmlTextReaderReadAttributeValue ()

int         xmlTextReaderReadAttributeValue (xmlTextReaderPtr reader);

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

reader : 
Returns : 

xmlTextReaderAttributeCount ()

int         xmlTextReaderAttributeCount     (xmlTextReaderPtr reader);

Provides the number of attributes of the current node

reader : 
Returns : 

xmlTextReaderBaseUri ()

xmlChar*    xmlTextReaderBaseUri            (xmlTextReaderPtr reader);

The base URI of the node.

reader : 
Returns : 

xmlTextReaderDepth ()

int         xmlTextReaderDepth              (xmlTextReaderPtr reader);

The depth of the node in the tree.

reader : 
Returns : 

xmlTextReaderHasAttributes ()

int         xmlTextReaderHasAttributes      (xmlTextReaderPtr reader);

Whether the node has attributes.

reader : 
Returns : 

xmlTextReaderHasValue ()

int         xmlTextReaderHasValue           (xmlTextReaderPtr reader);

Whether the node can have a text value.

reader : 
Returns : 

xmlTextReaderIsDefault ()

int         xmlTextReaderIsDefault          (xmlTextReaderPtr reader);

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

reader : 
Returns : 

xmlTextReaderIsEmptyElement ()

int         xmlTextReaderIsEmptyElement     (xmlTextReaderPtr reader);

Check if the current node is empty

reader : 
Returns : 

xmlTextReaderLocalName ()

xmlChar*    xmlTextReaderLocalName          (xmlTextReaderPtr reader);

The local name of the node.

reader : 
Returns : 

xmlTextReaderName ()

xmlChar*    xmlTextReaderName               (xmlTextReaderPtr reader);

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

reader : 
Returns : 

xmlTextReaderNamespaceUri ()

xmlChar*    xmlTextReaderNamespaceUri       (xmlTextReaderPtr reader);

The URI defining the namespace associated with the node.

reader : 
Returns : 

xmlTextReaderNodeType ()

int         xmlTextReaderNodeType           (xmlTextReaderPtr reader);

Get the node type of the current node +} 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 : 
Returns : 

xmlTextReaderPrefix ()

xmlChar*    xmlTextReaderPrefix             (xmlTextReaderPtr reader);

A shorthand reference to the namespace associated with the node.

reader : 
Returns : 

xmlTextReaderQuoteChar ()

int         xmlTextReaderQuoteChar          (xmlTextReaderPtr reader);

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

reader : 
Returns : 

xmlTextReaderValue ()

xmlChar*    xmlTextReaderValue              (xmlTextReaderPtr reader);

Provides the text value of the node if present

reader : 
Returns : 

xmlTextReaderXmlLang ()

xmlChar*    xmlTextReaderXmlLang            (xmlTextReaderPtr reader);

The xml:lang scope within which the node resides.

reader : 
Returns : 

xmlTextReaderReadState ()

int         xmlTextReaderReadState          (xmlTextReaderPtr reader);

Gets the read state of the reader.

reader : 
Returns : 

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 : 
Returns : 

xmlTextReaderGetAttributeNo ()

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

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

reader : 
no : 
Returns : 

xmlTextReaderGetAttribute ()

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

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

reader : 
name : 
Returns : 

xmlTextReaderGetAttributeNs ()

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

Provides the value of the specified attribute

reader : 
localName : 
namespaceURI : 
Returns : 

xmlTextReaderGetRemainder ()

xmlParserInputBufferPtr xmlTextReaderGetRemainder
-                                            (xmlTextReaderPtr reader);

Method to get the remainder of the buffered XML. this method stops the +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 : 
Returns : 

xmlTextReaderLookupNamespace ()

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

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

reader : 
prefix : 
Returns : 

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 : 
no : 
Returns : 

xmlTextReaderMoveToAttribute ()

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

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

reader : 
name : 
Returns : 

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 : 
localName : 
namespaceURI : 
Returns : 

xmlTextReaderMoveToFirstAttribute ()

int         xmlTextReaderMoveToFirstAttribute
-                                            (xmlTextReaderPtr reader);

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

reader : 
Returns : 

xmlTextReaderMoveToNextAttribute ()

int         xmlTextReaderMoveToNextAttribute
-                                            (xmlTextReaderPtr reader);

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

reader : 
Returns : 

xmlTextReaderMoveToElement ()

int         xmlTextReaderMoveToElement      (xmlTextReaderPtr reader);

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

reader : 
Returns : 

xmlTextReaderNormalization ()

int         xmlTextReaderNormalization      (xmlTextReaderPtr reader);

The value indicating whether to normalize white space and attribute values. +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 : 
Returns : 

xmlTextReaderSetParserProp ()

int         xmlTextReaderSetParserProp      (xmlTextReaderPtr reader,
+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 + 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 : 
prop : 
value : 
Returns : 

xmlTextReaderGetParserProp ()

int         xmlTextReaderGetParserProp      (xmlTextReaderPtr reader,
-                                             int prop);

Read the parser internal property.

reader : 
prop : 
Returns : 

xmlTextReaderCurrentNode ()

xmlNodePtr  xmlTextReaderCurrentNode        (xmlTextReaderPtr reader);

Hacking interface allowing to get the xmlNodePtr correponding to the +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 : 
Returns : 

xmlTextReaderCurrentDoc ()

xmlDocPtr   xmlTextReaderCurrentDoc         (xmlTextReaderPtr reader);

Hacking interface allowing to get the xmlDocPtr correponding to the +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 : 
Returns : 

xmlTextReaderLocatorPtr

xmlTextReaderErrorFunc ()

void        (*xmlTextReaderErrorFunc)       (void *arg,
+because the associated node may be destroyed on the next Reads.

+
+
reader :  the xmlTextReaderPtr used
+
Returns :the xmlDocPtr or NULL in case of error.
+
xmlTextReaderExpand ()
xmlNodePtr  xmlTextReaderExpand             (xmlTextReaderPtr reader);

+Reads the contents of the current node and the full subtree. It then makes
+the subtree availsble until the next xmlTextReaderRead() call

+
+
reader :  the xmlTextReaderPtr used
+
Returns :a node pointer valid until the next xmlTextReaderRead() call
+        or NULL in case of error.
+
xmlTextReaderNext ()
int         xmlTextReaderNext               (xmlTextReaderPtr reader);

+Skip to the node following the current one in document order while
+avoiding the subtree if any.

+
+
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
+
xmlTextReaderIsValid ()
int         xmlTextReaderIsValid            (xmlTextReaderPtr reader);

+Retrieve the validity status from the parser context

+
+
reader :  the xmlTextReaderPtr used
+
Returns :the flag value 1 if valid, 0 if no, and -1 in case of error
+
xmlTextReaderRelaxNGValidate ()
int         xmlTextReaderRelaxNGValidate    (xmlTextReaderPtr reader,
+                                             const char *rng);

+Use RelaxNG to validate the document as it is processed.
+Activation is only possible before the first Read().
+if rng is NULL, then RelaxNG validation is desactivated.

+
+
reader :  the xmlTextReaderPtr used
+
rng :  the path to a RelaxNG schema or NULL
+
Returns :0 in case the RelaxNG validation could be (des)activated and
+        -1 in case of error.
+
xmlTextReaderRelaxNGSetSchema ()
int         xmlTextReaderRelaxNGSetSchema   (xmlTextReaderPtr reader,
+                                             xmlRelaxNGPtr schema);

+Use RelaxNG to validate the document as it is processed.
+Activation is only possible before the first Read().
+if schema is NULL, then RelaxNG validation is desactivated.
+ @ The schema should not be freed until the reader is deallocated
+or its use has been deactivated.

+
+
reader :  the xmlTextReaderPtr used
+
schema :  a precompiled RelaxNG schema
+
Returns :0 in case the RelaxNG validation could be (des)activated and
+        -1 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 : 
Returns : 

xmlTextReaderLocatorBaseURI ()

xmlChar*    xmlTextReaderLocatorBaseURI     (xmlTextReaderLocatorPtr locator);

Obtain the base URI for the given locator.

locator : 
Returns : 

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 : 
f : 
arg : 

xmlTextReaderGetErrorHandler ()

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

Retrieve the error callback function and user argument.

reader : 
f : 
arg : 

\ No newline at end of file + 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 +
<< parserSAX >>
diff --git a/doc/html/libxml-xmlregexp.html b/doc/html/libxml-xmlregexp.html index 52477674..8a8c572c 100644 --- a/doc/html/libxml-xmlregexp.html +++ b/doc/html/libxml-xmlregexp.html @@ -1,1353 +1,153 @@ -xmlregexp
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

xmlregexp

Name

xmlregexp -- 

Synopsis


+
+xmlregexp
PrevUpHomeGnome XML Library Reference ManualNext
xmlregexp
xmlregexp — 
Synopsis
 
-struct      xmlRegexp;
-typedef     xmlRegexpPtr;
-struct      xmlRegExecCtxt;
-typedef     xmlRegExecCtxtPtr;
-xmlRegexpPtr xmlRegexpCompile               (const xmlChar *regexp);
-void        xmlRegFreeRegexp                (xmlRegexpPtr regexp);
-int         xmlRegexpExec                   (xmlRegexpPtr comp,
-                                             const xmlChar *value);
-void        xmlRegexpPrint                  (FILE *output,
-                                             xmlRegexpPtr regexp);
-int         xmlRegexpIsDeterminist          (xmlRegexpPtr comp);
-void        (*xmlRegExecCallbacks)          (xmlRegExecCtxtPtr exec,
-                                             const xmlChar *token,
+
+
+struct      xmlRegexp;
+typedef     xmlRegexpPtr;
+struct      xmlRegExecCtxt;
+typedef     xmlRegExecCtxtPtr;
+xmlRegexpPtr xmlRegexpCompile               (const xmlChar *regexp);
+void        xmlRegFreeRegexp                (xmlRegexpPtr regexp);
+int         xmlRegexpExec                   (xmlRegexpPtr comp,
+                                             const xmlChar *value);
+void        xmlRegexpPrint                  (FILE *output,
+                                             xmlRegexpPtr regexp);
+int         xmlRegexpIsDeterminist          (xmlRegexpPtr comp);
+void        (*xmlRegExecCallbacks)          (xmlRegExecCtxtPtr exec,
+                                             const xmlChar *token,
                                              void *transdata,
                                              void *inputdata);
-xmlRegExecCtxtPtr xmlRegNewExecCtxt         (xmlRegexpPtr comp,
-                                             xmlRegExecCallbacks callback,
+xmlRegExecCtxtPtr xmlRegNewExecCtxt         (xmlRegexpPtr comp,
+                                             xmlRegExecCallbacks callback,
                                              void *data);
-void        xmlRegFreeExecCtxt              (xmlRegExecCtxtPtr exec);
-int         xmlRegExecPushString            (xmlRegExecCtxtPtr exec,
-                                             const xmlChar *value,
-                                             void *data);

Description

Details

struct xmlRegexp

struct xmlRegexp;

xmlRegexpPtr

A libxml regular expression, they can actually be far more complex -thank the POSIX regex expressions.

struct xmlRegExecCtxt

struct xmlRegExecCtxt;

xmlRegExecCtxtPtr

A libxml progressive regular expression evaluation context

xmlRegexpCompile ()

xmlRegexpPtr xmlRegexpCompile               (const xmlChar *regexp);

Parses a regular expression conforming to XML Schemas Part 2 Datatype +void xmlRegFreeExecCtxt (xmlRegExecCtxtPtr exec); +int xmlRegExecPushString (xmlRegExecCtxtPtr exec, + const xmlChar *value, + void *data); +int xmlRegExecPushString2 (xmlRegExecCtxtPtr exec, + const xmlChar *value, + const xmlChar *value2, + void *data); +

Description

+ +

Details

struct xmlRegexp

struct xmlRegexp;

+ +

xmlRegexpPtr

typedef xmlRegexp *xmlRegexpPtr;
+

+A libxml regular expression, they can actually be far more complex +thank the POSIX regex expressions.

+ +

struct xmlRegExecCtxt

struct xmlRegExecCtxt;

+ +

xmlRegExecCtxtPtr

typedef xmlRegExecCtxt *xmlRegExecCtxtPtr;
+

+A libxml progressive regular expression evaluation context

+ +

xmlRegexpCompile ()

xmlRegexpPtr xmlRegexpCompile               (const xmlChar *regexp);

+Parses a regular expression conforming to XML Schemas Part 2 Datatype Appendix F and build an automata suitable for testing strings against -that regular expression

regexp : 
Returns : 

xmlRegFreeRegexp ()

void        xmlRegFreeRegexp                (xmlRegexpPtr regexp);

Free a regexp

regexp : 

xmlRegexpExec ()

int         xmlRegexpExec                   (xmlRegexpPtr comp,
-                                             const xmlChar *value);

Check if the regular expression generate the value

comp : 
value : 
Returns : 

xmlRegexpPrint ()

void        xmlRegexpPrint                  (FILE *output,
-                                             xmlRegexpPtr regexp);

Print the content of the compiled regular expression

output : 
regexp : 

xmlRegexpIsDeterminist ()

int         xmlRegexpIsDeterminist          (xmlRegexpPtr comp);

Check if the regular expression is determinist

comp : 
Returns : 

xmlRegExecCallbacks ()

void        (*xmlRegExecCallbacks)          (xmlRegExecCtxtPtr exec,
-                                             const xmlChar *token,
+that regular expression

+
+
regexp :  a regular expression string
+
Returns :the compiled expression or NULL in case of error
+
xmlRegFreeRegexp ()
void        xmlRegFreeRegexp                (xmlRegexpPtr regexp);

+Free a regexp

+
+
regexp :  the regexp
+
xmlRegexpExec ()
int         xmlRegexpExec                   (xmlRegexpPtr comp,
+                                             const xmlChar *value);

+Check if the regular expression generate the value

+
+
comp :  the compiled regular expression
+
value :
+
Returns :1 if it matches, 0 if not and a negativa value in case of error
+
xmlRegexpPrint ()
void        xmlRegexpPrint                  (FILE *output,
+                                             xmlRegexpPtr regexp);

+Print the content of the compiled regular expression

+
+
output : the file for the output debug
+
regexp : the compiled regexp
+
xmlRegexpIsDeterminist ()
int         xmlRegexpIsDeterminist          (xmlRegexpPtr comp);

+Check if the regular expression is determinist

+
+
comp :  the compiled regular expression
+
Returns :1 if it yes, 0 if not and a negativa value in case of error
+
xmlRegExecCallbacks ()
void        (*xmlRegExecCallbacks)          (xmlRegExecCtxtPtr exec,
+                                             const xmlChar *token,
                                              void *transdata,
-                                             void *inputdata);

exec : 
token : 
transdata : 
inputdata : 

xmlRegNewExecCtxt ()

xmlRegExecCtxtPtr xmlRegNewExecCtxt         (xmlRegexpPtr comp,
-                                             xmlRegExecCallbacks callback,
-                                             void *data);

Build a context used for progressive evaluation of a regexp.

comp : 
callback : 
data : 
Returns : 

xmlRegFreeExecCtxt ()

void        xmlRegFreeExecCtxt              (xmlRegExecCtxtPtr exec);

Free the structures associated to a regular expression evaulation context.

exec : 

xmlRegExecPushString ()

int         xmlRegExecPushString            (xmlRegExecCtxtPtr exec,
-                                             const xmlChar *value,
-                                             void *data);

Push one input token in the execution context

exec : 
value : 
data : 
Returns : 

\ No newline at end of file + void *inputdata);

+ +

exec : +
token : +
transdata : +
inputdata : + + +

xmlRegNewExecCtxt ()

xmlRegExecCtxtPtr xmlRegNewExecCtxt         (xmlRegexpPtr comp,
+                                             xmlRegExecCallbacks callback,
+                                             void *data);

+Build a context used for progressive evaluation of a regexp.

+ +

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

xmlRegFreeExecCtxt ()

void        xmlRegFreeExecCtxt              (xmlRegExecCtxtPtr exec);

+Free the structures associated to a regular expression evaulation context.

+ +

exec : a regular expression evaulation context +

xmlRegExecPushString ()

int         xmlRegExecPushString            (xmlRegExecCtxtPtr exec,
+                                             const xmlChar *value,
+                                             void *data);

+Push one input token in the execution context

+ +

exec : a regexp execution context or NULL to indicate the end +
value : a string token input +
data : data associated to the token to reuse in callbacks +
Returns : 1 if the regexp reached a final state, 0 if non-final, and + a negative value in case of error. +

xmlRegExecPushString2 ()

int         xmlRegExecPushString2           (xmlRegExecCtxtPtr exec,
+                                             const xmlChar *value,
+                                             const xmlChar *value2,
+                                             void *data);

+Push one input token in the execution context

+ +

exec : a regexp execution context or NULL to indicate the end +
value : the first string token input +
value2 : the second string token input +
data : data associated to the token to reuse in callbacks +
Returns : 1 if the regexp reached a final state, 0 if non-final, and + a negative value in case of error. +
<< xmlmemoryxmlautomata >>
diff --git a/doc/html/libxml-xmlschemas.html b/doc/html/libxml-xmlschemas.html index d7ec1c03..740081e3 100644 --- a/doc/html/libxml-xmlschemas.html +++ b/doc/html/libxml-xmlschemas.html @@ -1,364 +1,81 @@ -xmlschemas
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

xmlschemas

Name

xmlschemas -- 

Synopsis


+
+xmlschemas
PrevUpHomeGnome XML Library Reference ManualNext
xmlschemas
xmlschemas — 
Synopsis
 
-enum        xmlSchemaValidError;
-struct      xmlSchema;
-typedef     xmlSchemaPtr;
-void        (*xmlSchemaValidityErrorFunc)   (void *ctx,
+
+
+enum        xmlSchemaValidError;
+struct      xmlSchema;
+typedef     xmlSchemaPtr;
+void        (*xmlSchemaValidityErrorFunc)   (void *ctx,
                                              const char *msg,
                                              ...);
-void        (*xmlSchemaValidityWarningFunc) (void *ctx,
+void        (*xmlSchemaValidityWarningFunc) (void *ctx,
                                              const char *msg,
                                              ...);
-struct      xmlSchemaParserCtxt;
-typedef     xmlSchemaParserCtxtPtr;
-struct      xmlSchemaValidCtxt;
-typedef     xmlSchemaValidCtxtPtr;
-xmlSchemaParserCtxtPtr xmlSchemaNewParserCtxt
+struct      xmlSchemaParserCtxt;
+typedef     xmlSchemaParserCtxtPtr;
+struct      xmlSchemaValidCtxt;
+typedef     xmlSchemaValidCtxtPtr;
+xmlSchemaParserCtxtPtr xmlSchemaNewParserCtxt
                                             (const char *URL);
-xmlSchemaParserCtxtPtr xmlSchemaNewMemParserCtxt
+xmlSchemaParserCtxtPtr xmlSchemaNewMemParserCtxt
                                             (const char *buffer,
                                              int size);
-void        xmlSchemaFreeParserCtxt         (xmlSchemaParserCtxtPtr ctxt);
-void        xmlSchemaSetParserErrors        (xmlSchemaParserCtxtPtr ctxt,
-                                             xmlSchemaValidityErrorFunc err,
-                                             xmlSchemaValidityWarningFunc warn,
+void        xmlSchemaFreeParserCtxt         (xmlSchemaParserCtxtPtr ctxt);
+void        xmlSchemaSetParserErrors        (xmlSchemaParserCtxtPtr ctxt,
+                                             xmlSchemaValidityErrorFunc err,
+                                             xmlSchemaValidityWarningFunc warn,
                                              void *ctx);
-xmlSchemaPtr xmlSchemaParse                 (xmlSchemaParserCtxtPtr ctxt);
-void        xmlSchemaFree                   (xmlSchemaPtr schema);
-void        xmlSchemaDump                   (FILE *output,
-                                             xmlSchemaPtr schema);
-void        xmlSchemaSetValidErrors         (xmlSchemaValidCtxtPtr ctxt,
-                                             xmlSchemaValidityErrorFunc err,
-                                             xmlSchemaValidityWarningFunc warn,
+xmlSchemaPtr xmlSchemaParse                 (xmlSchemaParserCtxtPtr ctxt);
+void        xmlSchemaFree                   (xmlSchemaPtr schema);
+void        xmlSchemaDump                   (FILE *output,
+                                             xmlSchemaPtr schema);
+void        xmlSchemaSetValidErrors         (xmlSchemaValidCtxtPtr ctxt,
+                                             xmlSchemaValidityErrorFunc err,
+                                             xmlSchemaValidityWarningFunc warn,
                                              void *ctx);
-xmlSchemaValidCtxtPtr xmlSchemaNewValidCtxt (xmlSchemaPtr schema);
-void        xmlSchemaFreeValidCtxt          (xmlSchemaValidCtxtPtr ctxt);
-int         xmlSchemaValidateDoc            (xmlSchemaValidCtxtPtr ctxt,
-                                             xmlDocPtr instance);
-int         xmlSchemaValidateStream         (xmlSchemaValidCtxtPtr ctxt,
-                                             xmlParserInputBufferPtr input,
-                                             xmlCharEncoding enc,
-                                             xmlSAXHandlerPtr sax,
-                                             void *user_data);

Description

Details

enum xmlSchemaValidError

typedef enum {
+xmlSchemaValidCtxtPtr xmlSchemaNewValidCtxt (xmlSchemaPtr schema);
+void        xmlSchemaFreeValidCtxt          (xmlSchemaValidCtxtPtr ctxt);
+int         xmlSchemaValidateDoc            (xmlSchemaValidCtxtPtr ctxt,
+                                             xmlDocPtr instance);
+int         xmlSchemaValidateStream         (xmlSchemaValidCtxtPtr ctxt,
+                                             xmlParserInputBufferPtr input,
+                                             xmlCharEncoding enc,
+                                             xmlSAXHandlerPtr sax,
+                                             void *user_data);
+

Description

+ +

Details

enum xmlSchemaValidError

typedef enum {
     XML_SCHEMAS_ERR_OK		= 0,
     XML_SCHEMAS_ERR_NOROOT	= 1,
     XML_SCHEMAS_ERR_UNDECLAREDELEM,
@@ -382,35 +99,13 @@ CLASS="PROGRAMLISTING"
     XML_SCHEMAS_ERR_ATTRUNKNOWN,
     XML_SCHEMAS_ERR_ATTRINVALID,
     XML_SCHEMAS_ERR_VALUE,
+    XML_SCHEMAS_ERR_FACET,
     XML_SCHEMAS_ERR_,
     XML_SCHEMAS_ERR_XXX
-} xmlSchemaValidError;

struct xmlSchema

struct xmlSchema {
+} xmlSchemaValidError;
+

+ +

struct xmlSchema

struct xmlSchema {
     xmlChar *name;        /* schema name */
     xmlChar *targetNamespace;     /* the target namespace */
     xmlChar *version;
@@ -428,1605 +123,128 @@ CLASS="PROGRAMLISTING"
     xmlHashTablePtr schemasImports;
 
     void *_private;	/* unused by the library for users or bindings */
-};

xmlSchemaPtr

xmlSchemaValidityErrorFunc ()

void        (*xmlSchemaValidityErrorFunc)   (void *ctx,
+};
+

+ +

xmlSchemaPtr

typedef xmlSchema *xmlSchemaPtr;
+

+ +

xmlSchemaValidityErrorFunc ()

void        (*xmlSchemaValidityErrorFunc)   (void *ctx,
                                              const char *msg,
-                                             ...);

ctx : 
msg : 
... : 

xmlSchemaValidityWarningFunc ()

void        (*xmlSchemaValidityWarningFunc) (void *ctx,
+                                             ...);

+ +

ctx : +
msg : +
... : + + +

xmlSchemaValidityWarningFunc ()

void        (*xmlSchemaValidityWarningFunc) (void *ctx,
                                              const char *msg,
-                                             ...);

ctx : 
msg : 
... : 

struct xmlSchemaParserCtxt

struct xmlSchemaParserCtxt;

xmlSchemaParserCtxtPtr

struct xmlSchemaValidCtxt

struct xmlSchemaValidCtxt;

A Schemas validation context

xmlSchemaValidCtxtPtr

xmlSchemaNewParserCtxt ()

xmlSchemaParserCtxtPtr xmlSchemaNewParserCtxt
-                                            (const char *URL);

Create an XML Schemas parse context for that file/resource expected -to contain an XML Schemas file.

URL : 
Returns : 

xmlSchemaNewMemParserCtxt ()

xmlSchemaParserCtxtPtr xmlSchemaNewMemParserCtxt
+                                             ...);

+ +

ctx : +
msg : +
... : + + +

struct xmlSchemaParserCtxt

struct xmlSchemaParserCtxt;

+ +

xmlSchemaParserCtxtPtr

typedef xmlSchemaParserCtxt *xmlSchemaParserCtxtPtr;
+

+ +

struct xmlSchemaValidCtxt

struct xmlSchemaValidCtxt;

+A Schemas validation context

+ +

xmlSchemaValidCtxtPtr

typedef xmlSchemaValidCtxt *xmlSchemaValidCtxtPtr;
+

+ +

xmlSchemaNewParserCtxt ()

xmlSchemaParserCtxtPtr xmlSchemaNewParserCtxt
+                                            (const char *URL);

+Create an XML Schemas parse context for that file/resource expected +to contain an XML Schemas file.

+ +

URL : the location of the schema +
Returns :the parser context or NULL in case of error +

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 : 
size : 
Returns : 

xmlSchemaFreeParserCtxt ()

void        xmlSchemaFreeParserCtxt         (xmlSchemaParserCtxtPtr ctxt);

Free the resources associated to the schema parser context

ctxt : 

xmlSchemaSetParserErrors ()

void        xmlSchemaSetParserErrors        (xmlSchemaParserCtxtPtr ctxt,
-                                             xmlSchemaValidityErrorFunc err,
-                                             xmlSchemaValidityWarningFunc warn,
-                                             void *ctx);

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

ctxt : 
err : 
warn : 
ctx : 

xmlSchemaParse ()

xmlSchemaPtr xmlSchemaParse                 (xmlSchemaParserCtxtPtr ctxt);

parse a schema definition resource and build an internal + 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 +

xmlSchemaFreeParserCtxt ()

void        xmlSchemaFreeParserCtxt         (xmlSchemaParserCtxtPtr ctxt);

+Free the resources associated to the schema parser context

+ +

ctxt : the schema parser context +

xmlSchemaSetParserErrors ()

void        xmlSchemaSetParserErrors        (xmlSchemaParserCtxtPtr ctxt,
+                                             xmlSchemaValidityErrorFunc err,
+                                             xmlSchemaValidityWarningFunc warn,
+                                             void *ctx);

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

+ +

ctxt : a schema validation context +
err : the error callback +
warn : the warning callback +
ctx : contextual data for the callbacks +

xmlSchemaParse ()

xmlSchemaPtr xmlSchemaParse                 (xmlSchemaParserCtxtPtr 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 : 
Returns : 

xmlSchemaFree ()

void        xmlSchemaFree                   (xmlSchemaPtr schema);

Deallocate a Schema structure.

schema : 

xmlSchemaDump ()

void        xmlSchemaDump                   (FILE *output,
-                                             xmlSchemaPtr schema);

Dump a Schema structure.

output : 
schema : 

xmlSchemaSetValidErrors ()

void        xmlSchemaSetValidErrors         (xmlSchemaValidCtxtPtr ctxt,
-                                             xmlSchemaValidityErrorFunc err,
-                                             xmlSchemaValidityWarningFunc warn,
-                                             void *ctx);

Set the error and warning callback informations

ctxt : 
err : 
warn : 
ctx : 

xmlSchemaNewValidCtxt ()

xmlSchemaValidCtxtPtr xmlSchemaNewValidCtxt (xmlSchemaPtr schema);

Create an XML Schemas validation context based on the given schema

schema : 
Returns : 

xmlSchemaFreeValidCtxt ()

void        xmlSchemaFreeValidCtxt          (xmlSchemaValidCtxtPtr ctxt);

Free the resources associated to the schema validation context

ctxt : 

xmlSchemaValidateDoc ()

int         xmlSchemaValidateDoc            (xmlSchemaValidCtxtPtr ctxt,
-                                             xmlDocPtr instance);

Validate a document tree in memory.

ctxt : 
instance : 
Returns : 

xmlSchemaValidateStream ()

int         xmlSchemaValidateStream         (xmlSchemaValidCtxtPtr ctxt,
-                                             xmlParserInputBufferPtr input,
-                                             xmlCharEncoding enc,
-                                             xmlSAXHandlerPtr sax,
-                                             void *user_data);

Validate a document tree in memory.

ctxt : 
input : 
enc : 
sax : 
user_data : 
Returns : 



<<< Previous PageHomeUpNext Page >>>
xmlunicodexmlschemastypes
\ No newline at end of file +*WARNING* this interface is highly subject to change

+ +

ctxt : a schema validation context +
Returns :the internal XML Schema structure built from the resource or + NULL in case of error +

xmlSchemaFree ()

void        xmlSchemaFree                   (xmlSchemaPtr schema);

+Deallocate a Schema structure.

+ +

schema : a schema structure +

xmlSchemaDump ()

void        xmlSchemaDump                   (FILE *output,
+                                             xmlSchemaPtr schema);

+Dump a Schema structure.

+ +

output : the file output +
schema : a schema structure +

xmlSchemaSetValidErrors ()

void        xmlSchemaSetValidErrors         (xmlSchemaValidCtxtPtr ctxt,
+                                             xmlSchemaValidityErrorFunc err,
+                                             xmlSchemaValidityWarningFunc warn,
+                                             void *ctx);

+Set the error and warning callback informations

+ +

ctxt : a schema validation context +
err : the error function +
warn : the warning function +
ctx : the functions context +

xmlSchemaNewValidCtxt ()

xmlSchemaValidCtxtPtr xmlSchemaNewValidCtxt (xmlSchemaPtr schema);

+Create an XML Schemas validation context based on the given schema

+ +

schema : a precompiled XML Schemas +
Returns :the validation context or NULL in case of error +

xmlSchemaFreeValidCtxt ()

void        xmlSchemaFreeValidCtxt          (xmlSchemaValidCtxtPtr ctxt);

+Free the resources associated to the schema validation context

+ +

ctxt : the schema validation context +

xmlSchemaValidateDoc ()

int         xmlSchemaValidateDoc            (xmlSchemaValidCtxtPtr ctxt,
+                                             xmlDocPtr instance);

+Validate a document tree in memory.

+ +

ctxt : a schema validation context +
instance : +
Returns :0 if the document is schemas valid, a positive error code + number otherwise and -1 in case of internal or API error. +

xmlSchemaValidateStream ()

int         xmlSchemaValidateStream         (xmlSchemaValidCtxtPtr ctxt,
+                                             xmlParserInputBufferPtr input,
+                                             xmlCharEncoding enc,
+                                             xmlSAXHandlerPtr sax,
+                                             void *user_data);

+Validate a document tree in memory.

+ +

ctxt : a schema validation context +
input : the input to use for reading the data +
enc : an optional encoding information +
sax : a SAX handler for the resulting events +
user_data : the context to provide to the SAX handler. +
Returns :0 if the document is schemas valid, a positive error code + number otherwise and -1 in case of internal or API error. +
<< xmlunicodexmlschemastypes >>
diff --git a/doc/html/libxml-xmlschemastypes.html b/doc/html/libxml-xmlschemastypes.html index 0d513911..e6f344ce 100644 --- a/doc/html/libxml-xmlschemastypes.html +++ b/doc/html/libxml-xmlschemastypes.html @@ -1,1465 +1,143 @@ -xmlschemastypes
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

xmlschemastypes

Name

xmlschemastypes -- 

Synopsis


+
+xmlschemastypes
PrevUpHomeGnome XML Library Reference ManualNext
xmlschemastypes
xmlschemastypes — 
Synopsis
 
-void        xmlSchemaInitTypes              (void);
-void        xmlSchemaCleanupTypes           (void);
-xmlSchemaTypePtr xmlSchemaGetPredefinedType (const xmlChar *name,
-                                             const xmlChar *ns);
-int         xmlSchemaValidatePredefinedType (xmlSchemaTypePtr type,
-                                             const xmlChar *value,
-                                             xmlSchemaValPtr *val);
-int         xmlSchemaValPredefTypeNode      (xmlSchemaTypePtr type,
-                                             const xmlChar *value,
-                                             xmlSchemaValPtr *val,
-                                             xmlNodePtr node);
-int         xmlSchemaValidateFacet          (xmlSchemaTypePtr base,
-                                             xmlSchemaFacetPtr facet,
-                                             const xmlChar *value,
-                                             xmlSchemaValPtr val);
-void        xmlSchemaFreeValue              (xmlSchemaValPtr val);
-xmlSchemaFacetPtr xmlSchemaNewFacet         (void);
-int         xmlSchemaCheckFacet             (xmlSchemaFacetPtr facet,
-                                             xmlSchemaTypePtr typeDecl,
-                                             xmlSchemaParserCtxtPtr ctxt,
-                                             const xmlChar *name);
-void        xmlSchemaFreeFacet              (xmlSchemaFacetPtr facet);
-int         xmlSchemaCompareValues          (xmlSchemaValPtr x,
-                                             xmlSchemaValPtr y);

Description

Details

xmlSchemaInitTypes ()

void        xmlSchemaInitTypes              (void);

xmlSchemaCleanupTypes ()

void        xmlSchemaCleanupTypes           (void);

Cleanup the default XML Schemas type library

xmlSchemaGetPredefinedType ()

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

Lookup a type in the default XML Schemas type library

name : 
ns : 
Returns : 

xmlSchemaValidatePredefinedType ()

int         xmlSchemaValidatePredefinedType (xmlSchemaTypePtr type,
-                                             const xmlChar *value,
-                                             xmlSchemaValPtr *val);

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

type : 
value : 
val : 
Returns : 

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 : 
value : 
val : 
node : 
Returns : 

xmlSchemaValidateFacet ()

int         xmlSchemaValidateFacet          (xmlSchemaTypePtr base,
-                                             xmlSchemaFacetPtr facet,
-                                             const xmlChar *value,
-                                             xmlSchemaValPtr val);

Check a value against a facet condition

base : 
facet : 
value : 
val : 
Returns : 

xmlSchemaFreeValue ()

void        xmlSchemaFreeValue              (xmlSchemaValPtr val);

Cleanup the default XML Schemas type library

val : 

xmlSchemaNewFacet ()

xmlSchemaFacetPtr xmlSchemaNewFacet         (void);

Allocate a new Facet structure.

Returns : 

xmlSchemaCheckFacet ()

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

Checks the default values types, especially for facets

facet : 
typeDecl : 
ctxt : 
name : 
Returns : 

xmlSchemaFreeFacet ()

void        xmlSchemaFreeFacet              (xmlSchemaFacetPtr facet);

Deallocate a Schema Facet structure.

facet : 

xmlSchemaCompareValues ()

int         xmlSchemaCompareValues          (xmlSchemaValPtr x,
-                                             xmlSchemaValPtr y);

Compare 2 values

x : 
y : 
Returns : 



<<< Previous PageHomeUpNext Page >>>
xmlschemasschemasInternals
\ No newline at end of file + + +void xmlSchemaInitTypes (void); +void xmlSchemaCleanupTypes (void); +xmlSchemaTypePtr xmlSchemaGetPredefinedType (const xmlChar *name, + const xmlChar *ns); +int xmlSchemaValidatePredefinedType (xmlSchemaTypePtr type, + const xmlChar *value, + xmlSchemaValPtr *val); +int xmlSchemaValPredefTypeNode (xmlSchemaTypePtr type, + const xmlChar *value, + xmlSchemaValPtr *val, + xmlNodePtr node); +int xmlSchemaValidateFacet (xmlSchemaTypePtr base, + xmlSchemaFacetPtr facet, + const xmlChar *value, + xmlSchemaValPtr val); +void xmlSchemaFreeValue (xmlSchemaValPtr val); +xmlSchemaFacetPtr xmlSchemaNewFacet (void); +int xmlSchemaCheckFacet (xmlSchemaFacetPtr facet, + xmlSchemaTypePtr typeDecl, + xmlSchemaParserCtxtPtr ctxt, + const xmlChar *name); +void xmlSchemaFreeFacet (xmlSchemaFacetPtr facet); +int xmlSchemaCompareValues (xmlSchemaValPtr x, + xmlSchemaValPtr y); +

Description

+ +

Details

xmlSchemaInitTypes ()

void        xmlSchemaInitTypes              (void);

+ +

xmlSchemaCleanupTypes ()

void        xmlSchemaCleanupTypes           (void);

+Cleanup the default XML Schemas type library

+ +

xmlSchemaGetPredefinedType ()

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

+Lookup a type in the default XML Schemas type library

+ +

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

xmlSchemaValidatePredefinedType ()

int         xmlSchemaValidatePredefinedType (xmlSchemaTypePtr type,
+                                             const xmlChar *value,
+                                             xmlSchemaValPtr *val);

+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 +
Returns :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. +

xmlSchemaValidateFacet ()

int         xmlSchemaValidateFacet          (xmlSchemaTypePtr base,
+                                             xmlSchemaFacetPtr facet,
+                                             const xmlChar *value,
+                                             xmlSchemaValPtr val);

+Check a value against a facet condition

+ +

base : the base type +
facet : the facet to check +
value : the lexical repr of the value to validate +
val : the precomputed value +
Returns :0 if the element is schemas valid, a positive error code + number otherwise and -1 in case of internal or API error. +

xmlSchemaFreeValue ()

void        xmlSchemaFreeValue              (xmlSchemaValPtr val);

+Cleanup the default XML Schemas type library

+ +

val : + + +

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 +

xmlSchemaCompareValues ()

int         xmlSchemaCompareValues          (xmlSchemaValPtr x,
+                                             xmlSchemaValPtr y);

+Compare 2 values

+ +

x : a first value +
y : a second value +
Returns :-1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, and -2 in +case of error +
<< xmlschemasschemasInternals >>
diff --git a/doc/html/libxml-xmlunicode.html b/doc/html/libxml-xmlunicode.html index a717d871..f61e1485 100644 --- a/doc/html/libxml-xmlunicode.html +++ b/doc/html/libxml-xmlunicode.html @@ -1,12008 +1,884 @@ -xmlunicode
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

xmlunicode

Name

xmlunicode -- 

Synopsis


+
+xmlunicode
PrevUpHomeGnome XML Library Reference ManualNext
xmlunicode
xmlunicode — 
Synopsis
 
-int         xmlUCSIsAlphabeticPresentationForms
+
+
+int         xmlUCSIsAlphabeticPresentationForms
                                             (int code);
-int         xmlUCSIsArabic                  (int code);
-int         xmlUCSIsArabicPresentationFormsA
+int         xmlUCSIsArabic                  (int code);
+int         xmlUCSIsArabicPresentationFormsA
                                             (int code);
-int         xmlUCSIsArabicPresentationFormsB
+int         xmlUCSIsArabicPresentationFormsB
                                             (int code);
-int         xmlUCSIsArmenian                (int code);
-int         xmlUCSIsArrows                  (int code);
-int         xmlUCSIsBasicLatin              (int code);
-int         xmlUCSIsBengali                 (int code);
-int         xmlUCSIsBlockElements           (int code);
-int         xmlUCSIsBopomofo                (int code);
-int         xmlUCSIsBopomofoExtended        (int code);
-int         xmlUCSIsBoxDrawing              (int code);
-int         xmlUCSIsBraillePatterns         (int code);
-int         xmlUCSIsByzantineMusicalSymbols (int code);
-int         xmlUCSIsCJKCompatibility        (int code);
-int         xmlUCSIsCJKCompatibilityForms   (int code);
-int         xmlUCSIsCJKCompatibilityIdeographs
+int         xmlUCSIsArmenian                (int code);
+int         xmlUCSIsArrows                  (int code);
+int         xmlUCSIsBasicLatin              (int code);
+int         xmlUCSIsBengali                 (int code);
+int         xmlUCSIsBlockElements           (int code);
+int         xmlUCSIsBopomofo                (int code);
+int         xmlUCSIsBopomofoExtended        (int code);
+int         xmlUCSIsBoxDrawing              (int code);
+int         xmlUCSIsBraillePatterns         (int code);
+int         xmlUCSIsByzantineMusicalSymbols (int code);
+int         xmlUCSIsCJKCompatibility        (int code);
+int         xmlUCSIsCJKCompatibilityForms   (int code);
+int         xmlUCSIsCJKCompatibilityIdeographs
                                             (int code);
-int         xmlUCSIsCJKCompatibilityIdeographsSupplement
+int         xmlUCSIsCJKCompatibilityIdeographsSupplement
                                             (int code);
-int         xmlUCSIsCJKRadicalsSupplement   (int code);
-int         xmlUCSIsCJKSymbolsandPunctuation
+int         xmlUCSIsCJKRadicalsSupplement   (int code);
+int         xmlUCSIsCJKSymbolsandPunctuation
                                             (int code);
-int         xmlUCSIsCJKUnifiedIdeographs    (int code);
-int         xmlUCSIsCJKUnifiedIdeographsExtensionA
+int         xmlUCSIsCJKUnifiedIdeographs    (int code);
+int         xmlUCSIsCJKUnifiedIdeographsExtensionA
                                             (int code);
-int         xmlUCSIsCJKUnifiedIdeographsExtensionB
+int         xmlUCSIsCJKUnifiedIdeographsExtensionB
                                             (int code);
-int         xmlUCSIsCherokee                (int code);
-int         xmlUCSIsCombiningDiacriticalMarks
+int         xmlUCSIsCherokee                (int code);
+int         xmlUCSIsCombiningDiacriticalMarks
                                             (int code);
-int         xmlUCSIsCombiningHalfMarks      (int code);
-int         xmlUCSIsCombiningMarksforSymbols
+int         xmlUCSIsCombiningHalfMarks      (int code);
+int         xmlUCSIsCombiningMarksforSymbols
                                             (int code);
-int         xmlUCSIsControlPictures         (int code);
-int         xmlUCSIsCurrencySymbols         (int code);
-int         xmlUCSIsCyrillic                (int code);
-int         xmlUCSIsDeseret                 (int code);
-int         xmlUCSIsDevanagari              (int code);
-int         xmlUCSIsDingbats                (int code);
-int         xmlUCSIsEnclosedAlphanumerics   (int code);
-int         xmlUCSIsEnclosedCJKLettersandMonths
+int         xmlUCSIsControlPictures         (int code);
+int         xmlUCSIsCurrencySymbols         (int code);
+int         xmlUCSIsCyrillic                (int code);
+int         xmlUCSIsDeseret                 (int code);
+int         xmlUCSIsDevanagari              (int code);
+int         xmlUCSIsDingbats                (int code);
+int         xmlUCSIsEnclosedAlphanumerics   (int code);
+int         xmlUCSIsEnclosedCJKLettersandMonths
                                             (int code);
-int         xmlUCSIsEthiopic                (int code);
-int         xmlUCSIsGeneralPunctuation      (int code);
-int         xmlUCSIsGeometricShapes         (int code);
-int         xmlUCSIsGeorgian                (int code);
-int         xmlUCSIsGothic                  (int code);
-int         xmlUCSIsGreek                   (int code);
-int         xmlUCSIsGreekExtended           (int code);
-int         xmlUCSIsGujarati                (int code);
-int         xmlUCSIsGurmukhi                (int code);
-int         xmlUCSIsHalfwidthandFullwidthForms
+int         xmlUCSIsEthiopic                (int code);
+int         xmlUCSIsGeneralPunctuation      (int code);
+int         xmlUCSIsGeometricShapes         (int code);
+int         xmlUCSIsGeorgian                (int code);
+int         xmlUCSIsGothic                  (int code);
+int         xmlUCSIsGreek                   (int code);
+int         xmlUCSIsGreekExtended           (int code);
+int         xmlUCSIsGujarati                (int code);
+int         xmlUCSIsGurmukhi                (int code);
+int         xmlUCSIsHalfwidthandFullwidthForms
                                             (int code);
-int         xmlUCSIsHangulCompatibilityJamo (int code);
-int         xmlUCSIsHangulJamo              (int code);
-int         xmlUCSIsHangulSyllables         (int code);
-int         xmlUCSIsHebrew                  (int code);
-int         xmlUCSIsHighPrivateUseSurrogates
+int         xmlUCSIsHangulCompatibilityJamo (int code);
+int         xmlUCSIsHangulJamo              (int code);
+int         xmlUCSIsHangulSyllables         (int code);
+int         xmlUCSIsHebrew                  (int code);
+int         xmlUCSIsHighPrivateUseSurrogates
                                             (int code);
-int         xmlUCSIsHighSurrogates          (int code);
-int         xmlUCSIsHiragana                (int code);
-int         xmlUCSIsIPAExtensions           (int code);
-int         xmlUCSIsIdeographicDescriptionCharacters
+int         xmlUCSIsHighSurrogates          (int code);
+int         xmlUCSIsHiragana                (int code);
+int         xmlUCSIsIPAExtensions           (int code);
+int         xmlUCSIsIdeographicDescriptionCharacters
                                             (int code);
-int         xmlUCSIsKanbun                  (int code);
-int         xmlUCSIsKangxiRadicals          (int code);
-int         xmlUCSIsKannada                 (int code);
-int         xmlUCSIsKatakana                (int code);
-int         xmlUCSIsKhmer                   (int code);
-int         xmlUCSIsLao                     (int code);
-int         xmlUCSIsLatin1Supplement        (int code);
-int         xmlUCSIsLatinExtendedA          (int code);
-int         xmlUCSIsLatinExtendedB          (int code);
-int         xmlUCSIsLatinExtendedAdditional (int code);
-int         xmlUCSIsLetterlikeSymbols       (int code);
-int         xmlUCSIsLowSurrogates           (int code);
-int         xmlUCSIsMalayalam               (int code);
-int         xmlUCSIsMathematicalAlphanumericSymbols
+int         xmlUCSIsKanbun                  (int code);
+int         xmlUCSIsKangxiRadicals          (int code);
+int         xmlUCSIsKannada                 (int code);
+int         xmlUCSIsKatakana                (int code);
+int         xmlUCSIsKhmer                   (int code);
+int         xmlUCSIsLao                     (int code);
+int         xmlUCSIsLatin1Supplement        (int code);
+int         xmlUCSIsLatinExtendedA          (int code);
+int         xmlUCSIsLatinExtendedB          (int code);
+int         xmlUCSIsLatinExtendedAdditional (int code);
+int         xmlUCSIsLetterlikeSymbols       (int code);
+int         xmlUCSIsLowSurrogates           (int code);
+int         xmlUCSIsMalayalam               (int code);
+int         xmlUCSIsMathematicalAlphanumericSymbols
                                             (int code);
-int         xmlUCSIsMathematicalOperators   (int code);
-int         xmlUCSIsMiscellaneousSymbols    (int code);
-int         xmlUCSIsMiscellaneousTechnical  (int code);
-int         xmlUCSIsMongolian               (int code);
-int         xmlUCSIsMusicalSymbols          (int code);
-int         xmlUCSIsMyanmar                 (int code);
-int         xmlUCSIsNumberForms             (int code);
-int         xmlUCSIsOgham                   (int code);
-int         xmlUCSIsOldItalic               (int code);
-int         xmlUCSIsOpticalCharacterRecognition
+int         xmlUCSIsMathematicalOperators   (int code);
+int         xmlUCSIsMiscellaneousSymbols    (int code);
+int         xmlUCSIsMiscellaneousTechnical  (int code);
+int         xmlUCSIsMongolian               (int code);
+int         xmlUCSIsMusicalSymbols          (int code);
+int         xmlUCSIsMyanmar                 (int code);
+int         xmlUCSIsNumberForms             (int code);
+int         xmlUCSIsOgham                   (int code);
+int         xmlUCSIsOldItalic               (int code);
+int         xmlUCSIsOpticalCharacterRecognition
                                             (int code);
-int         xmlUCSIsOriya                   (int code);
-int         xmlUCSIsPrivateUse              (int code);
-int         xmlUCSIsRunic                   (int code);
-int         xmlUCSIsSinhala                 (int code);
-int         xmlUCSIsSmallFormVariants       (int code);
-int         xmlUCSIsSpacingModifierLetters  (int code);
-int         xmlUCSIsSpecials                (int code);
-int         xmlUCSIsSuperscriptsandSubscripts
+int         xmlUCSIsOriya                   (int code);
+int         xmlUCSIsPrivateUse              (int code);
+int         xmlUCSIsRunic                   (int code);
+int         xmlUCSIsSinhala                 (int code);
+int         xmlUCSIsSmallFormVariants       (int code);
+int         xmlUCSIsSpacingModifierLetters  (int code);
+int         xmlUCSIsSpecials                (int code);
+int         xmlUCSIsSuperscriptsandSubscripts
                                             (int code);
-int         xmlUCSIsSyriac                  (int code);
-int         xmlUCSIsTags                    (int code);
-int         xmlUCSIsTamil                   (int code);
-int         xmlUCSIsTelugu                  (int code);
-int         xmlUCSIsThaana                  (int code);
-int         xmlUCSIsThai                    (int code);
-int         xmlUCSIsTibetan                 (int code);
-int         xmlUCSIsUnifiedCanadianAboriginalSyllabics
+int         xmlUCSIsSyriac                  (int code);
+int         xmlUCSIsTags                    (int code);
+int         xmlUCSIsTamil                   (int code);
+int         xmlUCSIsTelugu                  (int code);
+int         xmlUCSIsThaana                  (int code);
+int         xmlUCSIsThai                    (int code);
+int         xmlUCSIsTibetan                 (int code);
+int         xmlUCSIsUnifiedCanadianAboriginalSyllabics
                                             (int code);
-int         xmlUCSIsYiRadicals              (int code);
-int         xmlUCSIsYiSyllables             (int code);
-int         xmlUCSIsBlock                   (int code,
+int         xmlUCSIsYiRadicals              (int code);
+int         xmlUCSIsYiSyllables             (int code);
+int         xmlUCSIsBlock                   (int code,
                                              const char *block);
-int         xmlUCSIsCatC                    (int code);
-int         xmlUCSIsCatCc                   (int code);
-int         xmlUCSIsCatCf                   (int code);
-int         xmlUCSIsCatCo                   (int code);
-int         xmlUCSIsCatCs                   (int code);
-int         xmlUCSIsCatL                    (int code);
-int         xmlUCSIsCatLl                   (int code);
-int         xmlUCSIsCatLm                   (int code);
-int         xmlUCSIsCatLo                   (int code);
-int         xmlUCSIsCatLt                   (int code);
-int         xmlUCSIsCatLu                   (int code);
-int         xmlUCSIsCatM                    (int code);
-int         xmlUCSIsCatMc                   (int code);
-int         xmlUCSIsCatMe                   (int code);
-int         xmlUCSIsCatMn                   (int code);
-int         xmlUCSIsCatN                    (int code);
-int         xmlUCSIsCatNd                   (int code);
-int         xmlUCSIsCatNl                   (int code);
-int         xmlUCSIsCatNo                   (int code);
-int         xmlUCSIsCatP                    (int code);
-int         xmlUCSIsCatPc                   (int code);
-int         xmlUCSIsCatPd                   (int code);
-int         xmlUCSIsCatPe                   (int code);
-int         xmlUCSIsCatPf                   (int code);
-int         xmlUCSIsCatPi                   (int code);
-int         xmlUCSIsCatPo                   (int code);
-int         xmlUCSIsCatPs                   (int code);
-int         xmlUCSIsCatS                    (int code);
-int         xmlUCSIsCatSc                   (int code);
-int         xmlUCSIsCatSk                   (int code);
-int         xmlUCSIsCatSm                   (int code);
-int         xmlUCSIsCatSo                   (int code);
-int         xmlUCSIsCatZ                    (int code);
-int         xmlUCSIsCatZl                   (int code);
-int         xmlUCSIsCatZp                   (int code);
-int         xmlUCSIsCatZs                   (int code);
-int         xmlUCSIsCat                     (int code,
-                                             const char *cat);

Description

Details

xmlUCSIsAlphabeticPresentationForms ()

int         xmlUCSIsAlphabeticPresentationForms
-                                            (int code);

Check whether the character is part of AlphabeticPresentationForms UCS Block

code : 
Returns : 

xmlUCSIsArabic ()

int         xmlUCSIsArabic                  (int code);

Check whether the character is part of Arabic UCS Block

code : 
Returns : 

xmlUCSIsArabicPresentationFormsA ()

int         xmlUCSIsArabicPresentationFormsA
-                                            (int code);

Check whether the character is part of ArabicPresentationForms-A UCS Block

code : 
Returns : 

xmlUCSIsArabicPresentationFormsB ()

int         xmlUCSIsArabicPresentationFormsB
-                                            (int code);

Check whether the character is part of ArabicPresentationForms-B UCS Block

code : 
Returns : 

xmlUCSIsArmenian ()

int         xmlUCSIsArmenian                (int code);

Check whether the character is part of Armenian UCS Block

code : 
Returns : 

xmlUCSIsArrows ()

int         xmlUCSIsArrows                  (int code);

Check whether the character is part of Arrows UCS Block

code : 
Returns : 

xmlUCSIsBasicLatin ()

int         xmlUCSIsBasicLatin              (int code);

Check whether the character is part of BasicLatin UCS Block

code : 
Returns : 

xmlUCSIsBengali ()

int         xmlUCSIsBengali                 (int code);

Check whether the character is part of Bengali UCS Block

code : 
Returns : 

xmlUCSIsBlockElements ()

int         xmlUCSIsBlockElements           (int code);

Check whether the character is part of BlockElements UCS Block

code : 
Returns : 

xmlUCSIsBopomofo ()

int         xmlUCSIsBopomofo                (int code);

Check whether the character is part of Bopomofo UCS Block

code : 
Returns : 

xmlUCSIsBopomofoExtended ()

int         xmlUCSIsBopomofoExtended        (int code);

Check whether the character is part of BopomofoExtended UCS Block

code : 
Returns : 

xmlUCSIsBoxDrawing ()

int         xmlUCSIsBoxDrawing              (int code);

Check whether the character is part of BoxDrawing UCS Block

code : 
Returns : 

xmlUCSIsBraillePatterns ()

int         xmlUCSIsBraillePatterns         (int code);

Check whether the character is part of BraillePatterns UCS Block

code : 
Returns : 

xmlUCSIsByzantineMusicalSymbols ()

int         xmlUCSIsByzantineMusicalSymbols (int code);

Check whether the character is part of ByzantineMusicalSymbols UCS Block

code : 
Returns : 

xmlUCSIsCJKCompatibility ()

int         xmlUCSIsCJKCompatibility        (int code);

Check whether the character is part of CJKCompatibility UCS Block

code : 
Returns : 

xmlUCSIsCJKCompatibilityForms ()

int         xmlUCSIsCJKCompatibilityForms   (int code);

Check whether the character is part of CJKCompatibilityForms UCS Block

code : 
Returns : 

xmlUCSIsCJKCompatibilityIdeographs ()

int         xmlUCSIsCJKCompatibilityIdeographs
-                                            (int code);

Check whether the character is part of CJKCompatibilityIdeographs UCS Block

code : 
Returns : 

xmlUCSIsCJKCompatibilityIdeographsSupplement ()

int         xmlUCSIsCJKCompatibilityIdeographsSupplement
-                                            (int code);

Check whether the character is part of CJKCompatibilityIdeographsSupplement UCS Block

code : 
Returns : 

xmlUCSIsCJKRadicalsSupplement ()

int         xmlUCSIsCJKRadicalsSupplement   (int code);

Check whether the character is part of CJKRadicalsSupplement UCS Block

code : 
Returns : 

xmlUCSIsCJKSymbolsandPunctuation ()

int         xmlUCSIsCJKSymbolsandPunctuation
-                                            (int code);

Check whether the character is part of CJKSymbolsandPunctuation UCS Block

code : 
Returns : 

xmlUCSIsCJKUnifiedIdeographs ()

int         xmlUCSIsCJKUnifiedIdeographs    (int code);

Check whether the character is part of CJKUnifiedIdeographs UCS Block

code : 
Returns : 

xmlUCSIsCJKUnifiedIdeographsExtensionA ()

int         xmlUCSIsCJKUnifiedIdeographsExtensionA
-                                            (int code);

Check whether the character is part of CJKUnifiedIdeographsExtensionA UCS Block

code : 
Returns : 

xmlUCSIsCJKUnifiedIdeographsExtensionB ()

int         xmlUCSIsCJKUnifiedIdeographsExtensionB
-                                            (int code);

Check whether the character is part of CJKUnifiedIdeographsExtensionB UCS Block

code : 
Returns : 

xmlUCSIsCherokee ()

int         xmlUCSIsCherokee                (int code);

Check whether the character is part of Cherokee UCS Block

code : 
Returns : 

xmlUCSIsCombiningDiacriticalMarks ()

int         xmlUCSIsCombiningDiacriticalMarks
-                                            (int code);

Check whether the character is part of CombiningDiacriticalMarks UCS Block

code : 
Returns : 

xmlUCSIsCombiningHalfMarks ()

int         xmlUCSIsCombiningHalfMarks      (int code);

Check whether the character is part of CombiningHalfMarks UCS Block

code : 
Returns : 

xmlUCSIsCombiningMarksforSymbols ()

int         xmlUCSIsCombiningMarksforSymbols
-                                            (int code);

Check whether the character is part of CombiningMarksforSymbols UCS Block

code : 
Returns : 

xmlUCSIsControlPictures ()

int         xmlUCSIsControlPictures         (int code);

Check whether the character is part of ControlPictures UCS Block

code : 
Returns : 

xmlUCSIsCurrencySymbols ()

int         xmlUCSIsCurrencySymbols         (int code);

Check whether the character is part of CurrencySymbols UCS Block

code : 
Returns : 

xmlUCSIsCyrillic ()

int         xmlUCSIsCyrillic                (int code);

Check whether the character is part of Cyrillic UCS Block

code : 
Returns : 

xmlUCSIsDeseret ()

int         xmlUCSIsDeseret                 (int code);

Check whether the character is part of Deseret UCS Block

code : 
Returns : 

xmlUCSIsDevanagari ()

int         xmlUCSIsDevanagari              (int code);

Check whether the character is part of Devanagari UCS Block

code : 
Returns : 

xmlUCSIsDingbats ()

int         xmlUCSIsDingbats                (int code);

Check whether the character is part of Dingbats UCS Block

code : 
Returns : 

xmlUCSIsEnclosedAlphanumerics ()

int         xmlUCSIsEnclosedAlphanumerics   (int code);

Check whether the character is part of EnclosedAlphanumerics UCS Block

code : 
Returns : 

xmlUCSIsEnclosedCJKLettersandMonths ()

int         xmlUCSIsEnclosedCJKLettersandMonths
-                                            (int code);

Check whether the character is part of EnclosedCJKLettersandMonths UCS Block

code : 
Returns : 

xmlUCSIsEthiopic ()

int         xmlUCSIsEthiopic                (int code);

Check whether the character is part of Ethiopic UCS Block

code : 
Returns : 

xmlUCSIsGeneralPunctuation ()

int         xmlUCSIsGeneralPunctuation      (int code);

Check whether the character is part of GeneralPunctuation UCS Block

code : 
Returns : 

xmlUCSIsGeometricShapes ()

int         xmlUCSIsGeometricShapes         (int code);

Check whether the character is part of GeometricShapes UCS Block

code : 
Returns : 

xmlUCSIsGeorgian ()

int         xmlUCSIsGeorgian                (int code);

Check whether the character is part of Georgian UCS Block

code : 
Returns : 

xmlUCSIsGothic ()

int         xmlUCSIsGothic                  (int code);

Check whether the character is part of Gothic UCS Block

code : 
Returns : 

xmlUCSIsGreek ()

int         xmlUCSIsGreek                   (int code);

Check whether the character is part of Greek UCS Block

code : 
Returns : 

xmlUCSIsGreekExtended ()

int         xmlUCSIsGreekExtended           (int code);

Check whether the character is part of GreekExtended UCS Block

code : 
Returns : 

xmlUCSIsGujarati ()

int         xmlUCSIsGujarati                (int code);

Check whether the character is part of Gujarati UCS Block

code : 
Returns : 

xmlUCSIsGurmukhi ()

int         xmlUCSIsGurmukhi                (int code);

Check whether the character is part of Gurmukhi UCS Block

code : 
Returns : 

xmlUCSIsHalfwidthandFullwidthForms ()

int         xmlUCSIsHalfwidthandFullwidthForms
-                                            (int code);

Check whether the character is part of HalfwidthandFullwidthForms UCS Block

code : 
Returns : 

xmlUCSIsHangulCompatibilityJamo ()

int         xmlUCSIsHangulCompatibilityJamo (int code);

Check whether the character is part of HangulCompatibilityJamo UCS Block

code : 
Returns : 

xmlUCSIsHangulJamo ()

int         xmlUCSIsHangulJamo              (int code);

Check whether the character is part of HangulJamo UCS Block

code : 
Returns : 

xmlUCSIsHangulSyllables ()

int         xmlUCSIsHangulSyllables         (int code);

Check whether the character is part of HangulSyllables UCS Block

code : 
Returns : 

xmlUCSIsHebrew ()

int         xmlUCSIsHebrew                  (int code);

Check whether the character is part of Hebrew UCS Block

code : 
Returns : 

xmlUCSIsHighPrivateUseSurrogates ()

int         xmlUCSIsHighPrivateUseSurrogates
-                                            (int code);

Check whether the character is part of HighPrivateUseSurrogates UCS Block

code : 
Returns : 

xmlUCSIsHighSurrogates ()

int         xmlUCSIsHighSurrogates          (int code);

Check whether the character is part of HighSurrogates UCS Block

code : 
Returns : 

xmlUCSIsHiragana ()

int         xmlUCSIsHiragana                (int code);

Check whether the character is part of Hiragana UCS Block

code : 
Returns : 

xmlUCSIsIPAExtensions ()

int         xmlUCSIsIPAExtensions           (int code);

Check whether the character is part of IPAExtensions UCS Block

code : 
Returns : 

xmlUCSIsIdeographicDescriptionCharacters ()

int         xmlUCSIsIdeographicDescriptionCharacters
-                                            (int code);

Check whether the character is part of IdeographicDescriptionCharacters UCS Block

code : 
Returns : 

xmlUCSIsKanbun ()

int         xmlUCSIsKanbun                  (int code);

Check whether the character is part of Kanbun UCS Block

code : 
Returns : 

xmlUCSIsKangxiRadicals ()

int         xmlUCSIsKangxiRadicals          (int code);

Check whether the character is part of KangxiRadicals UCS Block

code : 
Returns : 

xmlUCSIsKannada ()

int         xmlUCSIsKannada                 (int code);

Check whether the character is part of Kannada UCS Block

code : 
Returns : 

xmlUCSIsKatakana ()

int         xmlUCSIsKatakana                (int code);

Check whether the character is part of Katakana UCS Block

code : 
Returns : 

xmlUCSIsKhmer ()

int         xmlUCSIsKhmer                   (int code);

Check whether the character is part of Khmer UCS Block

code : 
Returns : 

xmlUCSIsLao ()

int         xmlUCSIsLao                     (int code);

Check whether the character is part of Lao UCS Block

code : 
Returns : 

xmlUCSIsLatin1Supplement ()

int         xmlUCSIsLatin1Supplement        (int code);

Check whether the character is part of Latin-1Supplement UCS Block

code : 
Returns : 

xmlUCSIsLatinExtendedA ()

int         xmlUCSIsLatinExtendedA          (int code);

Check whether the character is part of LatinExtended-A UCS Block

code : 
Returns : 

xmlUCSIsLatinExtendedB ()

int         xmlUCSIsLatinExtendedB          (int code);

Check whether the character is part of LatinExtended-B UCS Block

code : 
Returns : 

xmlUCSIsLatinExtendedAdditional ()

int         xmlUCSIsLatinExtendedAdditional (int code);

Check whether the character is part of LatinExtendedAdditional UCS Block

code : 
Returns : 

xmlUCSIsLetterlikeSymbols ()

int         xmlUCSIsLetterlikeSymbols       (int code);

Check whether the character is part of LetterlikeSymbols UCS Block

code : 
Returns : 

xmlUCSIsLowSurrogates ()

int         xmlUCSIsLowSurrogates           (int code);

Check whether the character is part of LowSurrogates UCS Block

code : 
Returns : 

xmlUCSIsMalayalam ()

int         xmlUCSIsMalayalam               (int code);

Check whether the character is part of Malayalam UCS Block

code : 
Returns : 

xmlUCSIsMathematicalAlphanumericSymbols ()

int         xmlUCSIsMathematicalAlphanumericSymbols
-                                            (int code);

Check whether the character is part of MathematicalAlphanumericSymbols UCS Block

code : 
Returns : 

xmlUCSIsMathematicalOperators ()

int         xmlUCSIsMathematicalOperators   (int code);

Check whether the character is part of MathematicalOperators UCS Block

code : 
Returns : 

xmlUCSIsMiscellaneousSymbols ()

int         xmlUCSIsMiscellaneousSymbols    (int code);

Check whether the character is part of MiscellaneousSymbols UCS Block

code : 
Returns : 

xmlUCSIsMiscellaneousTechnical ()

int         xmlUCSIsMiscellaneousTechnical  (int code);

Check whether the character is part of MiscellaneousTechnical UCS Block

code : 
Returns : 

xmlUCSIsMongolian ()

int         xmlUCSIsMongolian               (int code);

Check whether the character is part of Mongolian UCS Block

code : 
Returns : 

xmlUCSIsMusicalSymbols ()

int         xmlUCSIsMusicalSymbols          (int code);

Check whether the character is part of MusicalSymbols UCS Block

code : 
Returns : 

xmlUCSIsMyanmar ()

int         xmlUCSIsMyanmar                 (int code);

Check whether the character is part of Myanmar UCS Block

code : 
Returns : 

xmlUCSIsNumberForms ()

int         xmlUCSIsNumberForms             (int code);

Check whether the character is part of NumberForms UCS Block

code : 
Returns : 

xmlUCSIsOgham ()

int         xmlUCSIsOgham                   (int code);

Check whether the character is part of Ogham UCS Block

code : 
Returns : 

xmlUCSIsOldItalic ()

int         xmlUCSIsOldItalic               (int code);

Check whether the character is part of OldItalic UCS Block

code : 
Returns : 

xmlUCSIsOpticalCharacterRecognition ()

int         xmlUCSIsOpticalCharacterRecognition
-                                            (int code);

Check whether the character is part of OpticalCharacterRecognition UCS Block

code : 
Returns : 

xmlUCSIsOriya ()

int         xmlUCSIsOriya                   (int code);

Check whether the character is part of Oriya UCS Block

code : 
Returns : 

xmlUCSIsPrivateUse ()

int         xmlUCSIsPrivateUse              (int code);

Check whether the character is part of PrivateUse UCS Block

code : 
Returns : 

xmlUCSIsRunic ()

int         xmlUCSIsRunic                   (int code);

Check whether the character is part of Runic UCS Block

code : 
Returns : 

xmlUCSIsSinhala ()

int         xmlUCSIsSinhala                 (int code);

Check whether the character is part of Sinhala UCS Block

code : 
Returns : 

xmlUCSIsSmallFormVariants ()

int         xmlUCSIsSmallFormVariants       (int code);

Check whether the character is part of SmallFormVariants UCS Block

code : 
Returns : 

xmlUCSIsSpacingModifierLetters ()

int         xmlUCSIsSpacingModifierLetters  (int code);

Check whether the character is part of SpacingModifierLetters UCS Block

code : 
Returns : 

xmlUCSIsSpecials ()

int         xmlUCSIsSpecials                (int code);

Check whether the character is part of Specials UCS Block

code : 
Returns : 

xmlUCSIsSuperscriptsandSubscripts ()

int         xmlUCSIsSuperscriptsandSubscripts
-                                            (int code);

Check whether the character is part of SuperscriptsandSubscripts UCS Block

code : 
Returns : 

xmlUCSIsSyriac ()

int         xmlUCSIsSyriac                  (int code);

Check whether the character is part of Syriac UCS Block

code : 
Returns : 

xmlUCSIsTags ()

int         xmlUCSIsTags                    (int code);

Check whether the character is part of Tags UCS Block

code : 
Returns : 

xmlUCSIsTamil ()

int         xmlUCSIsTamil                   (int code);

Check whether the character is part of Tamil UCS Block

code : 
Returns : 

xmlUCSIsTelugu ()

int         xmlUCSIsTelugu                  (int code);

Check whether the character is part of Telugu UCS Block

code : 
Returns : 

xmlUCSIsThaana ()

int         xmlUCSIsThaana                  (int code);

Check whether the character is part of Thaana UCS Block

code : 
Returns : 

xmlUCSIsThai ()

int         xmlUCSIsThai                    (int code);

Check whether the character is part of Thai UCS Block

code : 
Returns : 

xmlUCSIsTibetan ()

int         xmlUCSIsTibetan                 (int code);

Check whether the character is part of Tibetan UCS Block

code : 
Returns : 

xmlUCSIsUnifiedCanadianAboriginalSyllabics ()

int         xmlUCSIsUnifiedCanadianAboriginalSyllabics
-                                            (int code);

Check whether the character is part of UnifiedCanadianAboriginalSyllabics UCS Block

code : 
Returns : 

xmlUCSIsYiRadicals ()

int         xmlUCSIsYiRadicals              (int code);

Check whether the character is part of YiRadicals UCS Block

code : 
Returns : 

xmlUCSIsYiSyllables ()

int         xmlUCSIsYiSyllables             (int code);

Check whether the character is part of YiSyllables UCS Block

code : 
Returns : 

xmlUCSIsBlock ()

int         xmlUCSIsBlock                   (int code,
-                                             const char *block);

Check whether the caracter is part of the UCS Block

code : 
block : 
Returns : 

xmlUCSIsCatC ()

int         xmlUCSIsCatC                    (int code);

Check whether the character is part of C UCS Category

code : 
Returns : 

xmlUCSIsCatCc ()

int         xmlUCSIsCatCc                   (int code);

Check whether the character is part of Cc UCS Category

code : 
Returns : 

xmlUCSIsCatCf ()

int         xmlUCSIsCatCf                   (int code);

Check whether the character is part of Cf UCS Category

code : 
Returns : 

xmlUCSIsCatCo ()

int         xmlUCSIsCatCo                   (int code);

Check whether the character is part of Co UCS Category

code : 
Returns : 

xmlUCSIsCatCs ()

int         xmlUCSIsCatCs                   (int code);

Check whether the character is part of Cs UCS Category

code : 
Returns : 

xmlUCSIsCatL ()

int         xmlUCSIsCatL                    (int code);

Check whether the character is part of L UCS Category

code : 
Returns : 

xmlUCSIsCatLl ()

int         xmlUCSIsCatLl                   (int code);

Check whether the character is part of Ll UCS Category

code : 
Returns : 

xmlUCSIsCatLm ()

int         xmlUCSIsCatLm                   (int code);

Check whether the character is part of Lm UCS Category

code : 
Returns : 

xmlUCSIsCatLo ()

int         xmlUCSIsCatLo                   (int code);

Check whether the character is part of Lo UCS Category

code : 
Returns : 

xmlUCSIsCatLt ()

int         xmlUCSIsCatLt                   (int code);

Check whether the character is part of Lt UCS Category

code : 
Returns : 

xmlUCSIsCatLu ()

int         xmlUCSIsCatLu                   (int code);

Check whether the character is part of Lu UCS Category

code : 
Returns : 

xmlUCSIsCatM ()

int         xmlUCSIsCatM                    (int code);

Check whether the character is part of M UCS Category

code : 
Returns : 

xmlUCSIsCatMc ()

int         xmlUCSIsCatMc                   (int code);

Check whether the character is part of Mc UCS Category

code : 
Returns : 

xmlUCSIsCatMe ()

int         xmlUCSIsCatMe                   (int code);

Check whether the character is part of Me UCS Category

code : 
Returns : 

xmlUCSIsCatMn ()

int         xmlUCSIsCatMn                   (int code);

Check whether the character is part of Mn UCS Category

code : 
Returns : 

xmlUCSIsCatN ()

int         xmlUCSIsCatN                    (int code);

Check whether the character is part of N UCS Category

code : 
Returns : 

xmlUCSIsCatNd ()

int         xmlUCSIsCatNd                   (int code);

Check whether the character is part of Nd UCS Category

code : 
Returns : 

xmlUCSIsCatNl ()

int         xmlUCSIsCatNl                   (int code);

Check whether the character is part of Nl UCS Category

code : 
Returns : 

xmlUCSIsCatNo ()

int         xmlUCSIsCatNo                   (int code);

Check whether the character is part of No UCS Category

code : 
Returns : 

xmlUCSIsCatP ()

int         xmlUCSIsCatP                    (int code);

Check whether the character is part of P UCS Category

code : 
Returns : 

xmlUCSIsCatPc ()

int         xmlUCSIsCatPc                   (int code);

Check whether the character is part of Pc UCS Category

code : 
Returns : 

xmlUCSIsCatPd ()

int         xmlUCSIsCatPd                   (int code);

Check whether the character is part of Pd UCS Category

code : 
Returns : 

xmlUCSIsCatPe ()

int         xmlUCSIsCatPe                   (int code);

Check whether the character is part of Pe UCS Category

code : 
Returns : 

xmlUCSIsCatPf ()

int         xmlUCSIsCatPf                   (int code);

Check whether the character is part of Pf UCS Category

code : 
Returns : 

xmlUCSIsCatPi ()

int         xmlUCSIsCatPi                   (int code);

Check whether the character is part of Pi UCS Category

code : 
Returns : 

xmlUCSIsCatPo ()

int         xmlUCSIsCatPo                   (int code);

Check whether the character is part of Po UCS Category

code : 
Returns : 

xmlUCSIsCatPs ()

int         xmlUCSIsCatPs                   (int code);

Check whether the character is part of Ps UCS Category

code : 
Returns : 

xmlUCSIsCatS ()

int         xmlUCSIsCatS                    (int code);

Check whether the character is part of S UCS Category

code : 
Returns : 

xmlUCSIsCatSc ()

int         xmlUCSIsCatSc                   (int code);

Check whether the character is part of Sc UCS Category

code : 
Returns : 

xmlUCSIsCatSk ()

int         xmlUCSIsCatSk                   (int code);

Check whether the character is part of Sk UCS Category

code : 
Returns : 

xmlUCSIsCatSm ()

int         xmlUCSIsCatSm                   (int code);

Check whether the character is part of Sm UCS Category

code : 
Returns : 

xmlUCSIsCatSo ()

int         xmlUCSIsCatSo                   (int code);

Check whether the character is part of So UCS Category

code : 
Returns : 

xmlUCSIsCatZ ()

int         xmlUCSIsCatZ                    (int code);

Check whether the character is part of Z UCS Category

code : 
Returns : 

xmlUCSIsCatZl ()

int         xmlUCSIsCatZl                   (int code);

Check whether the character is part of Zl UCS Category

code : 
Returns : 

xmlUCSIsCatZp ()

int         xmlUCSIsCatZp                   (int code);

Check whether the character is part of Zp UCS Category

code : 
Returns : 

xmlUCSIsCatZs ()

int         xmlUCSIsCatZs                   (int code);

Check whether the character is part of Zs UCS Category

code : 
Returns : 

xmlUCSIsCat ()

int         xmlUCSIsCat                     (int code,
-                                             const char *cat);

Check whether the caracter is part of the UCS Category

code : 
cat : 
Returns : 

\ No newline at end of file +int xmlUCSIsCatC (int code); +int xmlUCSIsCatCc (int code); +int xmlUCSIsCatCf (int code); +int xmlUCSIsCatCo (int code); +int xmlUCSIsCatCs (int code); +int xmlUCSIsCatL (int code); +int xmlUCSIsCatLl (int code); +int xmlUCSIsCatLm (int code); +int xmlUCSIsCatLo (int code); +int xmlUCSIsCatLt (int code); +int xmlUCSIsCatLu (int code); +int xmlUCSIsCatM (int code); +int xmlUCSIsCatMc (int code); +int xmlUCSIsCatMe (int code); +int xmlUCSIsCatMn (int code); +int xmlUCSIsCatN (int code); +int xmlUCSIsCatNd (int code); +int xmlUCSIsCatNl (int code); +int xmlUCSIsCatNo (int code); +int xmlUCSIsCatP (int code); +int xmlUCSIsCatPc (int code); +int xmlUCSIsCatPd (int code); +int xmlUCSIsCatPe (int code); +int xmlUCSIsCatPf (int code); +int xmlUCSIsCatPi (int code); +int xmlUCSIsCatPo (int code); +int xmlUCSIsCatPs (int code); +int xmlUCSIsCatS (int code); +int xmlUCSIsCatSc (int code); +int xmlUCSIsCatSk (int code); +int xmlUCSIsCatSm (int code); +int xmlUCSIsCatSo (int code); +int xmlUCSIsCatZ (int code); +int xmlUCSIsCatZl (int code); +int xmlUCSIsCatZp (int code); +int xmlUCSIsCatZs (int code); +int xmlUCSIsCat (int code, + const char *cat); +

Description

+ +

Details

xmlUCSIsAlphabeticPresentationForms ()

int         xmlUCSIsAlphabeticPresentationForms
+                                            (int code);

+Check whether the character is part of AlphabeticPresentationForms UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsArabic ()

int         xmlUCSIsArabic                  (int code);

+Check whether the character is part of Arabic UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsArabicPresentationFormsA ()

int         xmlUCSIsArabicPresentationFormsA
+                                            (int code);

+Check whether the character is part of ArabicPresentationForms-A UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsArabicPresentationFormsB ()

int         xmlUCSIsArabicPresentationFormsB
+                                            (int code);

+Check whether the character is part of ArabicPresentationForms-B UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsArmenian ()

int         xmlUCSIsArmenian                (int code);

+Check whether the character is part of Armenian UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsArrows ()

int         xmlUCSIsArrows                  (int code);

+Check whether the character is part of Arrows UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsBasicLatin ()

int         xmlUCSIsBasicLatin              (int code);

+Check whether the character is part of BasicLatin UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsBengali ()

int         xmlUCSIsBengali                 (int code);

+Check whether the character is part of Bengali UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsBlockElements ()

int         xmlUCSIsBlockElements           (int code);

+Check whether the character is part of BlockElements UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsBopomofo ()

int         xmlUCSIsBopomofo                (int code);

+Check whether the character is part of Bopomofo UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsBopomofoExtended ()

int         xmlUCSIsBopomofoExtended        (int code);

+Check whether the character is part of BopomofoExtended UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsBoxDrawing ()

int         xmlUCSIsBoxDrawing              (int code);

+Check whether the character is part of BoxDrawing UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsBraillePatterns ()

int         xmlUCSIsBraillePatterns         (int code);

+Check whether the character is part of BraillePatterns UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsByzantineMusicalSymbols ()

int         xmlUCSIsByzantineMusicalSymbols (int code);

+Check whether the character is part of ByzantineMusicalSymbols UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCJKCompatibility ()

int         xmlUCSIsCJKCompatibility        (int code);

+Check whether the character is part of CJKCompatibility UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCJKCompatibilityForms ()

int         xmlUCSIsCJKCompatibilityForms   (int code);

+Check whether the character is part of CJKCompatibilityForms UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCJKCompatibilityIdeographs ()

int         xmlUCSIsCJKCompatibilityIdeographs
+                                            (int code);

+Check whether the character is part of CJKCompatibilityIdeographs UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCJKCompatibilityIdeographsSupplement ()

int         xmlUCSIsCJKCompatibilityIdeographsSupplement
+                                            (int code);

+Check whether the character is part of CJKCompatibilityIdeographsSupplement UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCJKRadicalsSupplement ()

int         xmlUCSIsCJKRadicalsSupplement   (int code);

+Check whether the character is part of CJKRadicalsSupplement UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCJKSymbolsandPunctuation ()

int         xmlUCSIsCJKSymbolsandPunctuation
+                                            (int code);

+Check whether the character is part of CJKSymbolsandPunctuation UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCJKUnifiedIdeographs ()

int         xmlUCSIsCJKUnifiedIdeographs    (int code);

+Check whether the character is part of CJKUnifiedIdeographs UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCJKUnifiedIdeographsExtensionA ()

int         xmlUCSIsCJKUnifiedIdeographsExtensionA
+                                            (int code);

+Check whether the character is part of CJKUnifiedIdeographsExtensionA UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCJKUnifiedIdeographsExtensionB ()

int         xmlUCSIsCJKUnifiedIdeographsExtensionB
+                                            (int code);

+Check whether the character is part of CJKUnifiedIdeographsExtensionB UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCherokee ()

int         xmlUCSIsCherokee                (int code);

+Check whether the character is part of Cherokee UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCombiningDiacriticalMarks ()

int         xmlUCSIsCombiningDiacriticalMarks
+                                            (int code);

+Check whether the character is part of CombiningDiacriticalMarks UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCombiningHalfMarks ()

int         xmlUCSIsCombiningHalfMarks      (int code);

+Check whether the character is part of CombiningHalfMarks UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCombiningMarksforSymbols ()

int         xmlUCSIsCombiningMarksforSymbols
+                                            (int code);

+Check whether the character is part of CombiningMarksforSymbols UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsControlPictures ()

int         xmlUCSIsControlPictures         (int code);

+Check whether the character is part of ControlPictures UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCurrencySymbols ()

int         xmlUCSIsCurrencySymbols         (int code);

+Check whether the character is part of CurrencySymbols UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCyrillic ()

int         xmlUCSIsCyrillic                (int code);

+Check whether the character is part of Cyrillic UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsDeseret ()

int         xmlUCSIsDeseret                 (int code);

+Check whether the character is part of Deseret UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsDevanagari ()

int         xmlUCSIsDevanagari              (int code);

+Check whether the character is part of Devanagari UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsDingbats ()

int         xmlUCSIsDingbats                (int code);

+Check whether the character is part of Dingbats UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsEnclosedAlphanumerics ()

int         xmlUCSIsEnclosedAlphanumerics   (int code);

+Check whether the character is part of EnclosedAlphanumerics UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsEnclosedCJKLettersandMonths ()

int         xmlUCSIsEnclosedCJKLettersandMonths
+                                            (int code);

+Check whether the character is part of EnclosedCJKLettersandMonths UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsEthiopic ()

int         xmlUCSIsEthiopic                (int code);

+Check whether the character is part of Ethiopic UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsGeneralPunctuation ()

int         xmlUCSIsGeneralPunctuation      (int code);

+Check whether the character is part of GeneralPunctuation UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsGeometricShapes ()

int         xmlUCSIsGeometricShapes         (int code);

+Check whether the character is part of GeometricShapes UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsGeorgian ()

int         xmlUCSIsGeorgian                (int code);

+Check whether the character is part of Georgian UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsGothic ()

int         xmlUCSIsGothic                  (int code);

+Check whether the character is part of Gothic UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsGreek ()

int         xmlUCSIsGreek                   (int code);

+Check whether the character is part of Greek UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsGreekExtended ()

int         xmlUCSIsGreekExtended           (int code);

+Check whether the character is part of GreekExtended UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsGujarati ()

int         xmlUCSIsGujarati                (int code);

+Check whether the character is part of Gujarati UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsGurmukhi ()

int         xmlUCSIsGurmukhi                (int code);

+Check whether the character is part of Gurmukhi UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsHalfwidthandFullwidthForms ()

int         xmlUCSIsHalfwidthandFullwidthForms
+                                            (int code);

+Check whether the character is part of HalfwidthandFullwidthForms UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsHangulCompatibilityJamo ()

int         xmlUCSIsHangulCompatibilityJamo (int code);

+Check whether the character is part of HangulCompatibilityJamo UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsHangulJamo ()

int         xmlUCSIsHangulJamo              (int code);

+Check whether the character is part of HangulJamo UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsHangulSyllables ()

int         xmlUCSIsHangulSyllables         (int code);

+Check whether the character is part of HangulSyllables UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsHebrew ()

int         xmlUCSIsHebrew                  (int code);

+Check whether the character is part of Hebrew UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsHighPrivateUseSurrogates ()

int         xmlUCSIsHighPrivateUseSurrogates
+                                            (int code);

+Check whether the character is part of HighPrivateUseSurrogates UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsHighSurrogates ()

int         xmlUCSIsHighSurrogates          (int code);

+Check whether the character is part of HighSurrogates UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsHiragana ()

int         xmlUCSIsHiragana                (int code);

+Check whether the character is part of Hiragana UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsIPAExtensions ()

int         xmlUCSIsIPAExtensions           (int code);

+Check whether the character is part of IPAExtensions UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsIdeographicDescriptionCharacters ()

int         xmlUCSIsIdeographicDescriptionCharacters
+                                            (int code);

+Check whether the character is part of IdeographicDescriptionCharacters UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsKanbun ()

int         xmlUCSIsKanbun                  (int code);

+Check whether the character is part of Kanbun UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsKangxiRadicals ()

int         xmlUCSIsKangxiRadicals          (int code);

+Check whether the character is part of KangxiRadicals UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsKannada ()

int         xmlUCSIsKannada                 (int code);

+Check whether the character is part of Kannada UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsKatakana ()

int         xmlUCSIsKatakana                (int code);

+Check whether the character is part of Katakana UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsKhmer ()

int         xmlUCSIsKhmer                   (int code);

+Check whether the character is part of Khmer UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsLao ()

int         xmlUCSIsLao                     (int code);

+Check whether the character is part of Lao UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsLatin1Supplement ()

int         xmlUCSIsLatin1Supplement        (int code);

+Check whether the character is part of Latin-1Supplement UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsLatinExtendedA ()

int         xmlUCSIsLatinExtendedA          (int code);

+Check whether the character is part of LatinExtended-A UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsLatinExtendedB ()

int         xmlUCSIsLatinExtendedB          (int code);

+Check whether the character is part of LatinExtended-B UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsLatinExtendedAdditional ()

int         xmlUCSIsLatinExtendedAdditional (int code);

+Check whether the character is part of LatinExtendedAdditional UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsLetterlikeSymbols ()

int         xmlUCSIsLetterlikeSymbols       (int code);

+Check whether the character is part of LetterlikeSymbols UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsLowSurrogates ()

int         xmlUCSIsLowSurrogates           (int code);

+Check whether the character is part of LowSurrogates UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsMalayalam ()

int         xmlUCSIsMalayalam               (int code);

+Check whether the character is part of Malayalam UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsMathematicalAlphanumericSymbols ()

int         xmlUCSIsMathematicalAlphanumericSymbols
+                                            (int code);

+Check whether the character is part of MathematicalAlphanumericSymbols UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsMathematicalOperators ()

int         xmlUCSIsMathematicalOperators   (int code);

+Check whether the character is part of MathematicalOperators UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsMiscellaneousSymbols ()

int         xmlUCSIsMiscellaneousSymbols    (int code);

+Check whether the character is part of MiscellaneousSymbols UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsMiscellaneousTechnical ()

int         xmlUCSIsMiscellaneousTechnical  (int code);

+Check whether the character is part of MiscellaneousTechnical UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsMongolian ()

int         xmlUCSIsMongolian               (int code);

+Check whether the character is part of Mongolian UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsMusicalSymbols ()

int         xmlUCSIsMusicalSymbols          (int code);

+Check whether the character is part of MusicalSymbols UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsMyanmar ()

int         xmlUCSIsMyanmar                 (int code);

+Check whether the character is part of Myanmar UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsNumberForms ()

int         xmlUCSIsNumberForms             (int code);

+Check whether the character is part of NumberForms UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsOgham ()

int         xmlUCSIsOgham                   (int code);

+Check whether the character is part of Ogham UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsOldItalic ()

int         xmlUCSIsOldItalic               (int code);

+Check whether the character is part of OldItalic UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsOpticalCharacterRecognition ()

int         xmlUCSIsOpticalCharacterRecognition
+                                            (int code);

+Check whether the character is part of OpticalCharacterRecognition UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsOriya ()

int         xmlUCSIsOriya                   (int code);

+Check whether the character is part of Oriya UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsPrivateUse ()

int         xmlUCSIsPrivateUse              (int code);

+Check whether the character is part of PrivateUse UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsRunic ()

int         xmlUCSIsRunic                   (int code);

+Check whether the character is part of Runic UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsSinhala ()

int         xmlUCSIsSinhala                 (int code);

+Check whether the character is part of Sinhala UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsSmallFormVariants ()

int         xmlUCSIsSmallFormVariants       (int code);

+Check whether the character is part of SmallFormVariants UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsSpacingModifierLetters ()

int         xmlUCSIsSpacingModifierLetters  (int code);

+Check whether the character is part of SpacingModifierLetters UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsSpecials ()

int         xmlUCSIsSpecials                (int code);

+Check whether the character is part of Specials UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsSuperscriptsandSubscripts ()

int         xmlUCSIsSuperscriptsandSubscripts
+                                            (int code);

+Check whether the character is part of SuperscriptsandSubscripts UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsSyriac ()

int         xmlUCSIsSyriac                  (int code);

+Check whether the character is part of Syriac UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsTags ()

int         xmlUCSIsTags                    (int code);

+Check whether the character is part of Tags UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsTamil ()

int         xmlUCSIsTamil                   (int code);

+Check whether the character is part of Tamil UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsTelugu ()

int         xmlUCSIsTelugu                  (int code);

+Check whether the character is part of Telugu UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsThaana ()

int         xmlUCSIsThaana                  (int code);

+Check whether the character is part of Thaana UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsThai ()

int         xmlUCSIsThai                    (int code);

+Check whether the character is part of Thai UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsTibetan ()

int         xmlUCSIsTibetan                 (int code);

+Check whether the character is part of Tibetan UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsUnifiedCanadianAboriginalSyllabics ()

int         xmlUCSIsUnifiedCanadianAboriginalSyllabics
+                                            (int code);

+Check whether the character is part of UnifiedCanadianAboriginalSyllabics UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsYiRadicals ()

int         xmlUCSIsYiRadicals              (int code);

+Check whether the character is part of YiRadicals UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsYiSyllables ()

int         xmlUCSIsYiSyllables             (int code);

+Check whether the character is part of YiSyllables UCS Block

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsBlock ()

int         xmlUCSIsBlock                   (int code,
+                                             const char *block);

+Check whether the caracter is part of the UCS Block

+ +

code : UCS code point +
block : UCS block name +
Returns :1 if true, 0 if false and -1 on unknown block +

xmlUCSIsCatC ()

int         xmlUCSIsCatC                    (int code);

+Check whether the character is part of C UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatCc ()

int         xmlUCSIsCatCc                   (int code);

+Check whether the character is part of Cc UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatCf ()

int         xmlUCSIsCatCf                   (int code);

+Check whether the character is part of Cf UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatCo ()

int         xmlUCSIsCatCo                   (int code);

+Check whether the character is part of Co UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatCs ()

int         xmlUCSIsCatCs                   (int code);

+Check whether the character is part of Cs UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatL ()

int         xmlUCSIsCatL                    (int code);

+Check whether the character is part of L UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatLl ()

int         xmlUCSIsCatLl                   (int code);

+Check whether the character is part of Ll UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatLm ()

int         xmlUCSIsCatLm                   (int code);

+Check whether the character is part of Lm UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatLo ()

int         xmlUCSIsCatLo                   (int code);

+Check whether the character is part of Lo UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatLt ()

int         xmlUCSIsCatLt                   (int code);

+Check whether the character is part of Lt UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatLu ()

int         xmlUCSIsCatLu                   (int code);

+Check whether the character is part of Lu UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatM ()

int         xmlUCSIsCatM                    (int code);

+Check whether the character is part of M UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatMc ()

int         xmlUCSIsCatMc                   (int code);

+Check whether the character is part of Mc UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatMe ()

int         xmlUCSIsCatMe                   (int code);

+Check whether the character is part of Me UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatMn ()

int         xmlUCSIsCatMn                   (int code);

+Check whether the character is part of Mn UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatN ()

int         xmlUCSIsCatN                    (int code);

+Check whether the character is part of N UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatNd ()

int         xmlUCSIsCatNd                   (int code);

+Check whether the character is part of Nd UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatNl ()

int         xmlUCSIsCatNl                   (int code);

+Check whether the character is part of Nl UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatNo ()

int         xmlUCSIsCatNo                   (int code);

+Check whether the character is part of No UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatP ()

int         xmlUCSIsCatP                    (int code);

+Check whether the character is part of P UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatPc ()

int         xmlUCSIsCatPc                   (int code);

+Check whether the character is part of Pc UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatPd ()

int         xmlUCSIsCatPd                   (int code);

+Check whether the character is part of Pd UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatPe ()

int         xmlUCSIsCatPe                   (int code);

+Check whether the character is part of Pe UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatPf ()

int         xmlUCSIsCatPf                   (int code);

+Check whether the character is part of Pf UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatPi ()

int         xmlUCSIsCatPi                   (int code);

+Check whether the character is part of Pi UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatPo ()

int         xmlUCSIsCatPo                   (int code);

+Check whether the character is part of Po UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatPs ()

int         xmlUCSIsCatPs                   (int code);

+Check whether the character is part of Ps UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatS ()

int         xmlUCSIsCatS                    (int code);

+Check whether the character is part of S UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatSc ()

int         xmlUCSIsCatSc                   (int code);

+Check whether the character is part of Sc UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatSk ()

int         xmlUCSIsCatSk                   (int code);

+Check whether the character is part of Sk UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatSm ()

int         xmlUCSIsCatSm                   (int code);

+Check whether the character is part of Sm UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatSo ()

int         xmlUCSIsCatSo                   (int code);

+Check whether the character is part of So UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatZ ()

int         xmlUCSIsCatZ                    (int code);

+Check whether the character is part of Z UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatZl ()

int         xmlUCSIsCatZl                   (int code);

+Check whether the character is part of Zl UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatZp ()

int         xmlUCSIsCatZp                   (int code);

+Check whether the character is part of Zp UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCatZs ()

int         xmlUCSIsCatZs                   (int code);

+Check whether the character is part of Zs UCS Category

+ +

code : UCS code point +
Returns :1 if true 0 otherwise +

xmlUCSIsCat ()

int         xmlUCSIsCat                     (int code,
+                                             const char *cat);

+Check whether the caracter is part of the UCS Category

+ +

code : UCS code point +
cat : UCS Category name +
Returns :1 if true, 0 if false and -1 on unknown category +
<< xmlautomataxmlschemas >>
diff --git a/doc/html/libxml-xpath.html b/doc/html/libxml-xpath.html index c2a21550..44ad5026 100644 --- a/doc/html/libxml-xpath.html +++ b/doc/html/libxml-xpath.html @@ -1,641 +1,112 @@ -xpath
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

xpath

Name

xpath -- 

Synopsis


+
+xpath
PrevUpHomeGnome XML Library Reference ManualNext
xpath
xpath — 
Synopsis
 
-struct      xmlXPathContext;
-typedef     xmlXPathContextPtr;
-struct      xmlXPathParserContext;
-typedef     xmlXPathParserContextPtr;
-enum        xmlXPathError;
-struct      xmlNodeSet;
-typedef     xmlNodeSetPtr;
-enum        xmlXPathObjectType;
-struct      xmlXPathObject;
-typedef     xmlXPathObjectPtr;
-int         (*xmlXPathConvertFunc)          (xmlXPathObjectPtr obj,
+
+
+struct      xmlXPathContext;
+typedef     xmlXPathContextPtr;
+struct      xmlXPathParserContext;
+typedef     xmlXPathParserContextPtr;
+enum        xmlXPathError;
+struct      xmlNodeSet;
+typedef     xmlNodeSetPtr;
+enum        xmlXPathObjectType;
+struct      xmlXPathObject;
+typedef     xmlXPathObjectPtr;
+int         (*xmlXPathConvertFunc)          (xmlXPathObjectPtr obj,
                                              int type);
-struct      xmlXPathType;
-typedef     xmlXPathTypePtr;
-struct      xmlXPathVariable;
-typedef     xmlXPathVariablePtr;
-void        (*xmlXPathEvalFunc)             (xmlXPathParserContextPtr ctxt,
+struct      xmlXPathType;
+typedef     xmlXPathTypePtr;
+struct      xmlXPathVariable;
+typedef     xmlXPathVariablePtr;
+void        (*xmlXPathEvalFunc)             (xmlXPathParserContextPtr ctxt,
                                              int nargs);
-struct      xmlXPathFunct;
-typedef     xmlXPathFuncPtr;
-xmlXPathObjectPtr (*xmlXPathAxisFunc)       (xmlXPathParserContextPtr ctxt,
-                                             xmlXPathObjectPtr cur);
-struct      xmlXPathAxis;
-typedef     xmlXPathAxisPtr;
-struct      xmlXPathCompExpr;
-typedef     xmlXPathCompExprPtr;
-void        (*xmlXPathFunction)             (xmlXPathParserContextPtr ctxt,
+struct      xmlXPathFunct;
+typedef     xmlXPathFuncPtr;
+xmlXPathObjectPtr (*xmlXPathAxisFunc)       (xmlXPathParserContextPtr ctxt,
+                                             xmlXPathObjectPtr cur);
+struct      xmlXPathAxis;
+typedef     xmlXPathAxisPtr;
+struct      xmlXPathCompExpr;
+typedef     xmlXPathCompExprPtr;
+void        (*xmlXPathFunction)             (xmlXPathParserContextPtr ctxt,
                                              int nargs);
-int         xmlXPathIsNaN                   (double val);
-int         xmlXPathIsInf                   (double val);
-#define     xmlXPathNodeSetGetLength        (ns)
-#define     xmlXPathNodeSetItem             (ns, index)
-#define     xmlXPathNodeSetIsEmpty          (ns)
-void        xmlXPathFreeObject              (xmlXPathObjectPtr obj);
-xmlNodeSetPtr xmlXPathNodeSetCreate         (xmlNodePtr val);
-void        xmlXPathFreeNodeSetList         (xmlXPathObjectPtr obj);
-void        xmlXPathFreeNodeSet             (xmlNodeSetPtr obj);
-xmlXPathObjectPtr xmlXPathObjectCopy        (xmlXPathObjectPtr val);
-int         xmlXPathCmpNodes                (xmlNodePtr node1,
-                                             xmlNodePtr node2);
-int         xmlXPathCastNumberToBoolean     (double val);
-int         xmlXPathCastStringToBoolean     (const xmlChar *val);
-int         xmlXPathCastNodeSetToBoolean    (xmlNodeSetPtr ns);
-int         xmlXPathCastToBoolean           (xmlXPathObjectPtr val);
-double      xmlXPathCastBooleanToNumber     (int val);
-double      xmlXPathCastStringToNumber      (const xmlChar *val);
-double      xmlXPathCastNodeToNumber        (xmlNodePtr node);
-double      xmlXPathCastNodeSetToNumber     (xmlNodeSetPtr ns);
-double      xmlXPathCastToNumber            (xmlXPathObjectPtr val);
-xmlChar*    xmlXPathCastBooleanToString     (int val);
-xmlChar*    xmlXPathCastNumberToString      (double val);
-xmlChar*    xmlXPathCastNodeToString        (xmlNodePtr node);
-xmlChar*    xmlXPathCastNodeSetToString     (xmlNodeSetPtr ns);
-xmlChar*    xmlXPathCastToString            (xmlXPathObjectPtr val);
-xmlXPathObjectPtr xmlXPathConvertBoolean    (xmlXPathObjectPtr val);
-xmlXPathObjectPtr xmlXPathConvertNumber     (xmlXPathObjectPtr val);
-xmlXPathObjectPtr xmlXPathConvertString     (xmlXPathObjectPtr val);
-void        xmlXPathInit                    (void);
-xmlXPathContextPtr xmlXPathNewContext       (xmlDocPtr doc);
-void        xmlXPathFreeContext             (xmlXPathContextPtr ctxt);
-long        xmlXPathOrderDocElems           (xmlDocPtr doc);
-xmlXPathObjectPtr xmlXPathEval              (const xmlChar *str,
-                                             xmlXPathContextPtr ctx);
-xmlXPathObjectPtr xmlXPathEvalExpression    (const xmlChar *str,
-                                             xmlXPathContextPtr ctxt);
-int         xmlXPathEvalPredicate           (xmlXPathContextPtr ctxt,
-                                             xmlXPathObjectPtr res);
-xmlXPathCompExprPtr xmlXPathCompile         (const xmlChar *str);
-xmlXPathObjectPtr xmlXPathCompiledEval      (xmlXPathCompExprPtr comp,
-                                             xmlXPathContextPtr ctx);
-void        xmlXPathFreeCompExpr            (xmlXPathCompExprPtr comp);

Description

Details

struct xmlXPathContext

struct xmlXPathContext {
+int         xmlXPathIsNaN                   (double val);
+int         xmlXPathIsInf                   (double val);
+#define     xmlXPathNodeSetGetLength        (ns)
+#define     xmlXPathNodeSetItem             (ns, index)
+#define     xmlXPathNodeSetIsEmpty          (ns)
+void        xmlXPathFreeObject              (xmlXPathObjectPtr obj);
+xmlNodeSetPtr xmlXPathNodeSetCreate         (xmlNodePtr val);
+void        xmlXPathFreeNodeSetList         (xmlXPathObjectPtr obj);
+void        xmlXPathFreeNodeSet             (xmlNodeSetPtr obj);
+xmlXPathObjectPtr xmlXPathObjectCopy        (xmlXPathObjectPtr val);
+int         xmlXPathCmpNodes                (xmlNodePtr node1,
+                                             xmlNodePtr node2);
+int         xmlXPathCastNumberToBoolean     (double val);
+int         xmlXPathCastStringToBoolean     (const xmlChar *val);
+int         xmlXPathCastNodeSetToBoolean    (xmlNodeSetPtr ns);
+int         xmlXPathCastToBoolean           (xmlXPathObjectPtr val);
+double      xmlXPathCastBooleanToNumber     (int val);
+double      xmlXPathCastStringToNumber      (const xmlChar *val);
+double      xmlXPathCastNodeToNumber        (xmlNodePtr node);
+double      xmlXPathCastNodeSetToNumber     (xmlNodeSetPtr ns);
+double      xmlXPathCastToNumber            (xmlXPathObjectPtr val);
+xmlChar*    xmlXPathCastBooleanToString     (int val);
+xmlChar*    xmlXPathCastNumberToString      (double val);
+xmlChar*    xmlXPathCastNodeToString        (xmlNodePtr node);
+xmlChar*    xmlXPathCastNodeSetToString     (xmlNodeSetPtr ns);
+xmlChar*    xmlXPathCastToString            (xmlXPathObjectPtr val);
+xmlXPathObjectPtr xmlXPathConvertBoolean    (xmlXPathObjectPtr val);
+xmlXPathObjectPtr xmlXPathConvertNumber     (xmlXPathObjectPtr val);
+xmlXPathObjectPtr xmlXPathConvertString     (xmlXPathObjectPtr val);
+void        xmlXPathInit                    (void);
+xmlXPathContextPtr xmlXPathNewContext       (xmlDocPtr doc);
+void        xmlXPathFreeContext             (xmlXPathContextPtr ctxt);
+long        xmlXPathOrderDocElems           (xmlDocPtr doc);
+xmlXPathObjectPtr xmlXPathEval              (const xmlChar *str,
+                                             xmlXPathContextPtr ctx);
+xmlXPathObjectPtr xmlXPathEvalExpression    (const xmlChar *str,
+                                             xmlXPathContextPtr ctxt);
+int         xmlXPathEvalPredicate           (xmlXPathContextPtr ctxt,
+                                             xmlXPathObjectPtr res);
+xmlXPathCompExprPtr xmlXPathCompile         (const xmlChar *str);
+xmlXPathObjectPtr xmlXPathCompiledEval      (xmlXPathCompExprPtr comp,
+                                             xmlXPathContextPtr ctx);
+void        xmlXPathFreeCompExpr            (xmlXPathCompExprPtr comp);
+

Description

+ +

Details

struct xmlXPathContext

struct xmlXPathContext {
     xmlDocPtr doc;			/* The current document */
     xmlNodePtr node;			/* The current node */
 
@@ -688,12 +159,9 @@ CLASS="PROGRAMLISTING"
     /* temporary namespace lists kept for walking the namespace axis */
     xmlNsPtr *tmpNsList;		/* Array of namespaces */
     int tmpNsNr;			/* number of namespace in scope */
-};

Expression evaluation occurs with respect to a context. +}; +

+Expression evaluation occurs with respect to a context. he context consists of: - a node (the context node) - a node list (the context node list) @@ -701,43 +169,12 @@ he context consists of: - 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.

xmlXPathContextPtr

struct xmlXPathParserContext

struct xmlXPathParserContext {
+the next binary incompatible release.

+
+
xmlXPathContextPtr
typedef xmlXPathContext *xmlXPathContextPtr;
+

+
+
struct xmlXPathParserContext
struct xmlXPathParserContext {
     const xmlChar *cur;			/* the current char being parsed */
     const xmlChar *base;			/* the full expression */
 
@@ -752,49 +189,15 @@ CLASS="PROGRAMLISTING"
     xmlXPathCompExprPtr comp;		/* the precompiled expression */
     int xptr;				/* it this an XPointer expression */
     xmlNodePtr         ancestor;	/* used for walking preceding axis */
-};

An XPath parser context. It contains pure parsing informations, -an xmlXPathContext, and the stack of objects.

xmlXPathParserContextPtr

enum xmlXPathError

typedef enum {
+};
+

+An XPath parser context. It contains pure parsing informations, +an xmlXPathContext, and the stack of objects.

+ +

xmlXPathParserContextPtr

typedef xmlXPathParserContext *xmlXPathParserContextPtr;
+

+ +

enum xmlXPathError

typedef enum {
     XPATH_EXPRESSION_OK = 0,
     XPATH_NUMBER_ERROR,
     XPATH_UNFINISHED_LITERAL_ERROR,
@@ -817,77 +220,21 @@ CLASS="PROGRAMLISTING"
     XPATH_UNDEF_PREFIX_ERROR,
     XPATH_ENCODING_ERROR,
     XPATH_INVALID_CHAR_ERROR
-} xmlXPathError;

struct xmlNodeSet

struct xmlNodeSet {
+} xmlXPathError;
+

+ +

struct xmlNodeSet

struct xmlNodeSet {
     int nodeNr;			/* number of nodes in the set */
     int nodeMax;		/* size of the array as allocated */
     xmlNodePtr *nodeTab;	/* array of nodes in no particular order */
     /* @@ with_ns to check wether namespace nodes should be looked at @@ */
-};

xmlNodeSetPtr

enum xmlXPathObjectType

typedef enum {
+};
+

+ +

xmlNodeSetPtr

typedef xmlNodeSet *xmlNodeSetPtr;
+

+ +

enum xmlXPathObjectType

typedef enum {
     XPATH_UNDEFINED = 0,
     XPATH_NODESET = 1,
     XPATH_BOOLEAN = 2,
@@ -898,33 +245,10 @@ CLASS="PROGRAMLISTING"
     XPATH_LOCATIONSET = 7,
     XPATH_USERS = 8,
     XPATH_XSLT_TREE = 9  /* An XSLT value tree, non modifiable */
-} xmlXPathObjectType;

struct xmlXPathObject

struct xmlXPathObject {
+} xmlXPathObjectType;
+

+ +

struct xmlXPathObject

struct xmlXPathObject {
     xmlXPathObjectType type;
     xmlNodeSetPtr nodesetval;
     int boolval;
@@ -934,4024 +258,301 @@ CLASS="PROGRAMLISTING"
     int index;
     void *user2;
     int index2;
-};

xmlXPathObjectPtr

xmlXPathConvertFunc ()

int         (*xmlXPathConvertFunc)          (xmlXPathObjectPtr obj,
-                                             int type);

A conversion function is associated to a type and used to cast -the new type to primitive values.

obj : 
type : 
Returns : 

struct xmlXPathType

struct xmlXPathType {
+};
+

+ +

xmlXPathObjectPtr

typedef xmlXPathObject *xmlXPathObjectPtr;
+

+ +

xmlXPathConvertFunc ()

int         (*xmlXPathConvertFunc)          (xmlXPathObjectPtr obj,
+                                             int type);

+A conversion function is associated to a type and used to cast +the new type to primitive values.

+ +

obj : an XPath object +
type : the number of the target type +
Returns :-1 in case of error, 0 otherwise +

struct xmlXPathType

struct xmlXPathType {
     const xmlChar         *name;		/* the type name */
     xmlXPathConvertFunc func;		/* the conversion function */
-};

xmlXPathTypePtr

struct xmlXPathVariable

struct xmlXPathVariable {
+};
+

+ +

xmlXPathTypePtr

typedef xmlXPathType *xmlXPathTypePtr;
+

+ +

struct xmlXPathVariable

struct xmlXPathVariable {
     const xmlChar       *name;		/* the variable name */
     xmlXPathObjectPtr value;		/* the value */
-};

xmlXPathVariablePtr

xmlXPathEvalFunc ()

void        (*xmlXPathEvalFunc)             (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

An XPath evaluation function, the parameters are on the XPath context stack.

ctxt : 
nargs : 

struct xmlXPathFunct

struct xmlXPathFunct {
+};
+

+ +

xmlXPathVariablePtr

typedef xmlXPathVariable *xmlXPathVariablePtr;
+

+ +

xmlXPathEvalFunc ()

void        (*xmlXPathEvalFunc)             (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+An XPath evaluation function, the parameters are on the XPath context stack.

+ +

ctxt : an XPath parser context +
nargs : the number of arguments passed to the function +

struct xmlXPathFunct

struct xmlXPathFunct {
     const xmlChar      *name;		/* the function name */
     xmlXPathEvalFunc func;		/* the evaluation function */
-};

xmlXPathFuncPtr

xmlXPathAxisFunc ()

xmlXPathObjectPtr (*xmlXPathAxisFunc)       (xmlXPathParserContextPtr ctxt,
-                                             xmlXPathObjectPtr cur);

An axis traversal function. To traverse an axis, the engine calls +}; +

+ +

xmlXPathFuncPtr

typedef xmlXPathFunct *xmlXPathFuncPtr;
+

+ +

xmlXPathAxisFunc ()

xmlXPathObjectPtr (*xmlXPathAxisFunc)       (xmlXPathParserContextPtr ctxt,
+                                             xmlXPathObjectPtr cur);

+An axis traversal function. To traverse an axis, the engine calls the first time with cur == NULL and repeat until the function returns -NULL indicating the end of the axis traversal.

ctxt : 
cur : 
Returns : 

struct xmlXPathAxis

struct xmlXPathAxis {
+NULL indicating the end of the axis traversal.

+
+
ctxt :  the XPath interpreter context
+
cur :  the previous node being explored on that axis
+
Returns :the next node in that axis or NULL if at the end of the axis.
+
struct xmlXPathAxis
struct xmlXPathAxis {
     const xmlChar      *name;		/* the axis name */
     xmlXPathAxisFunc func;		/* the search function */
-};

xmlXPathAxisPtr

struct xmlXPathCompExpr

struct xmlXPathCompExpr;

xmlXPathCompExprPtr

xmlXPathFunction ()

void        (*xmlXPathFunction)             (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

An XPath function. +}; +

+ +

xmlXPathAxisPtr

typedef xmlXPathAxis *xmlXPathAxisPtr;
+

+ +

struct xmlXPathCompExpr

struct xmlXPathCompExpr;

+ +

xmlXPathCompExprPtr

typedef xmlXPathCompExpr *xmlXPathCompExprPtr;
+

+ +

xmlXPathFunction ()

void        (*xmlXPathFunction)             (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+An XPath function. The arguments (if any) are popped out from the context stack -and the result is pushed on the stack.

ctxt : 
nargs : 

xmlXPathIsNaN ()

int         xmlXPathIsNaN                   (double val);

Provides a portable isnan() function to detect whether a double +and the result is pushed on the stack.

+ +

ctxt : the XPath interprestation context +
nargs : the number of arguments +

xmlXPathIsNaN ()

int         xmlXPathIsNaN                   (double val);

+Provides a portable isnan() function to detect whether a double is a NotaNumber. Based on trio code -http://sourceforge.net/projects/ctrio/

val : 
Returns : 

xmlXPathIsInf ()

int         xmlXPathIsInf                   (double val);

Provides a portable isinf() function to detect whether a double +http://sourceforge.net/projects/ctrio/

+ +

val : a double value +
Returns :1 if the value is a NaN, 0 otherwise +

xmlXPathIsInf ()

int         xmlXPathIsInf                   (double val);

+Provides a portable isinf() function to detect whether a double is a +Infinite or -Infinite. Based on trio code -http://sourceforge.net/projects/ctrio/

val : 
Returns : 

xmlXPathNodeSetGetLength()

#define     xmlXPathNodeSetGetLength(ns)

Implement a functionality similar to the DOM NodeList.length.

ns : 

xmlXPathNodeSetItem()

#define     xmlXPathNodeSetItem(ns, index)

Implements a functionality similar to the DOM NodeList.item().

ns : 
index : 

xmlXPathNodeSetIsEmpty()

#define     xmlXPathNodeSetIsEmpty(ns)

Checks whether ns is empty or not.

ns : 

xmlXPathFreeObject ()

void        xmlXPathFreeObject              (xmlXPathObjectPtr obj);

Free up an xmlXPathObjectPtr object.

obj : 

xmlXPathNodeSetCreate ()

xmlNodeSetPtr xmlXPathNodeSetCreate         (xmlNodePtr val);

Create a new xmlNodeSetPtr of type double and of value val

val : 
Returns : 

xmlXPathFreeNodeSetList ()

void        xmlXPathFreeNodeSetList         (xmlXPathObjectPtr obj);

Free up the xmlXPathObjectPtr obj but don't deallocate the objects in -the list contrary to xmlXPathFreeObject().

obj : 

xmlXPathFreeNodeSet ()

void        xmlXPathFreeNodeSet             (xmlNodeSetPtr obj);

Free the NodeSet compound (not the actual nodes !).

obj : 

xmlXPathObjectCopy ()

xmlXPathObjectPtr xmlXPathObjectCopy        (xmlXPathObjectPtr val);

allocate a new copy of a given object

val : 
Returns : 

xmlXPathCmpNodes ()

int         xmlXPathCmpNodes                (xmlNodePtr node1,
-                                             xmlNodePtr node2);

Compare two nodes w.r.t document order

node1 : 
node2 : 
Returns : 

xmlXPathCastNumberToBoolean ()

int         xmlXPathCastNumberToBoolean     (double val);

Converts a number to its boolean value

val : 
Returns : 

xmlXPathCastStringToBoolean ()

int         xmlXPathCastStringToBoolean     (const xmlChar *val);

Converts a string to its boolean value

val : 
Returns : 

xmlXPathCastNodeSetToBoolean ()

int         xmlXPathCastNodeSetToBoolean    (xmlNodeSetPtr ns);

Converts a node-set to its boolean value

ns : 
Returns : 

xmlXPathCastToBoolean ()

int         xmlXPathCastToBoolean           (xmlXPathObjectPtr val);

Converts an XPath object to its boolean value

val : 
Returns : 

xmlXPathCastBooleanToNumber ()

double      xmlXPathCastBooleanToNumber     (int val);

Converts a boolean to its number value

val : 
Returns : 

xmlXPathCastStringToNumber ()

double      xmlXPathCastStringToNumber      (const xmlChar *val);

Converts a string to its number value

val : 
Returns : 

xmlXPathCastNodeToNumber ()

double      xmlXPathCastNodeToNumber        (xmlNodePtr node);

Converts a node to its number value

node : 
Returns : 

xmlXPathCastNodeSetToNumber ()

double      xmlXPathCastNodeSetToNumber     (xmlNodeSetPtr ns);

Converts a node-set to its number value

ns : 
Returns : 

xmlXPathCastToNumber ()

double      xmlXPathCastToNumber            (xmlXPathObjectPtr val);

Converts an XPath object to its number value

val : 
Returns : 

xmlXPathCastBooleanToString ()

xmlChar*    xmlXPathCastBooleanToString     (int val);

Converts a boolean to its string value.

val : 
Returns : 

xmlXPathCastNumberToString ()

xmlChar*    xmlXPathCastNumberToString      (double val);

Converts a number to its string value.

val : 
Returns : 

xmlXPathCastNodeToString ()

xmlChar*    xmlXPathCastNodeToString        (xmlNodePtr node);

Converts a node to its string value.

node : 
Returns : 

xmlXPathCastNodeSetToString ()

xmlChar*    xmlXPathCastNodeSetToString     (xmlNodeSetPtr ns);

Converts a node-set to its string value.

ns : 
Returns : 

xmlXPathCastToString ()

xmlChar*    xmlXPathCastToString            (xmlXPathObjectPtr val);

Converts an existing object to its string() equivalent

val : 
Returns : 

xmlXPathConvertBoolean ()

xmlXPathObjectPtr xmlXPathConvertBoolean    (xmlXPathObjectPtr val);

Converts an existing object to its boolean() equivalent

val : 
Returns : 

xmlXPathConvertNumber ()

xmlXPathObjectPtr xmlXPathConvertNumber     (xmlXPathObjectPtr val);

Converts an existing object to its number() equivalent

val : 
Returns : 

xmlXPathConvertString ()

xmlXPathObjectPtr xmlXPathConvertString     (xmlXPathObjectPtr val);

Converts an existing object to its string() equivalent

val : 
Returns : 

xmlXPathInit ()

void        xmlXPathInit                    (void);

Initialize the XPath environment

xmlXPathNewContext ()

xmlXPathContextPtr xmlXPathNewContext       (xmlDocPtr doc);

Create a new xmlXPathContext

doc : 
Returns : 

xmlXPathFreeContext ()

void        xmlXPathFreeContext             (xmlXPathContextPtr ctxt);

Free up an xmlXPathContext

ctxt : 

xmlXPathOrderDocElems ()

long        xmlXPathOrderDocElems           (xmlDocPtr doc);

Call this routine to speed up XPath computation on static documents. +http://sourceforge.net/projects/ctrio/

+ +

val : a double value +
Returns :1 vi the value is +Infinite, -1 if -Infinite, 0 otherwise +

xmlXPathNodeSetGetLength()

#define xmlXPathNodeSetGetLength(ns) ((ns) ? (ns)->nodeNr : 0)
+

+Implement a functionality similar to the DOM NodeList.length.

+ +

ns : a node-set +

xmlXPathNodeSetItem()

#define     xmlXPathNodeSetItem(ns, index)

+Implements a functionality similar to the DOM NodeList.item().

+ +

ns : a node-set +
index : index of a node in the set +

xmlXPathNodeSetIsEmpty()

#define     xmlXPathNodeSetIsEmpty(ns)

+Checks whether ns is empty or not.

+ +

ns : a node-set +

xmlXPathFreeObject ()

void        xmlXPathFreeObject              (xmlXPathObjectPtr obj);

+Free up an xmlXPathObjectPtr object.

+ +

obj : the object to free +

xmlXPathNodeSetCreate ()

xmlNodeSetPtr xmlXPathNodeSetCreate         (xmlNodePtr val);

+Create a new xmlNodeSetPtr of type double and of value val

+ +

val : an initial xmlNodePtr, or NULL +
Returns :the newly created object. +

xmlXPathFreeNodeSetList ()

void        xmlXPathFreeNodeSetList         (xmlXPathObjectPtr obj);

+Free up the xmlXPathObjectPtr obj but don't deallocate the objects in +the list contrary to xmlXPathFreeObject().

+ +

obj : an existing NodeSetList object +

xmlXPathFreeNodeSet ()

void        xmlXPathFreeNodeSet             (xmlNodeSetPtr obj);

+Free the NodeSet compound (not the actual nodes !).

+ +

obj : the xmlNodeSetPtr to free +

xmlXPathObjectCopy ()

xmlXPathObjectPtr xmlXPathObjectCopy        (xmlXPathObjectPtr val);

+allocate a new copy of a given object

+ +

val : the original object +
Returns :the newly created object. +

xmlXPathCmpNodes ()

int         xmlXPathCmpNodes                (xmlNodePtr node1,
+                                             xmlNodePtr node2);

+Compare two nodes w.r.t document order

+ +

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

xmlXPathCastNumberToBoolean ()

int         xmlXPathCastNumberToBoolean     (double val);

+Converts a number to its boolean value

+ +

val : a number +
Returns :the boolean value +

xmlXPathCastStringToBoolean ()

int         xmlXPathCastStringToBoolean     (const xmlChar *val);

+Converts a string to its boolean value

+ +

val : a string +
Returns :the boolean value +

xmlXPathCastNodeSetToBoolean ()

int         xmlXPathCastNodeSetToBoolean    (xmlNodeSetPtr ns);

+Converts a node-set to its boolean value

+ +

ns : a node-set +
Returns :the boolean value +

xmlXPathCastToBoolean ()

int         xmlXPathCastToBoolean           (xmlXPathObjectPtr val);

+Converts an XPath object to its boolean value

+ +

val : an XPath object +
Returns :the boolean value +

xmlXPathCastBooleanToNumber ()

double      xmlXPathCastBooleanToNumber     (int val);

+Converts a boolean to its number value

+ +

val : a boolean +
Returns :the number value +

xmlXPathCastStringToNumber ()

double      xmlXPathCastStringToNumber      (const xmlChar *val);

+Converts a string to its number value

+ +

val : a string +
Returns :the number value +

xmlXPathCastNodeToNumber ()

double      xmlXPathCastNodeToNumber        (xmlNodePtr node);

+Converts a node to its number value

+ +

node : a node +
Returns :the number value +

xmlXPathCastNodeSetToNumber ()

double      xmlXPathCastNodeSetToNumber     (xmlNodeSetPtr ns);

+Converts a node-set to its number value

+ +

ns : a node-set +
Returns :the number value +

xmlXPathCastToNumber ()

double      xmlXPathCastToNumber            (xmlXPathObjectPtr val);

+Converts an XPath object to its number value

+ +

val : an XPath object +
Returns :the number value +

xmlXPathCastBooleanToString ()

xmlChar*    xmlXPathCastBooleanToString     (int val);

+Converts a boolean to its string value.

+ +

val : a boolean +
Returns :a newly allocated string. +

xmlXPathCastNumberToString ()

xmlChar*    xmlXPathCastNumberToString      (double val);

+Converts a number to its string value.

+ +

val : a number +
Returns :a newly allocated string. +

xmlXPathCastNodeToString ()

xmlChar*    xmlXPathCastNodeToString        (xmlNodePtr node);

+Converts a node to its string value.

+ +

node : a node +
Returns :a newly allocated string. +

xmlXPathCastNodeSetToString ()

xmlChar*    xmlXPathCastNodeSetToString     (xmlNodeSetPtr ns);

+Converts a node-set to its string value.

+ +

ns : a node-set +
Returns :a newly allocated string. +

xmlXPathCastToString ()

xmlChar*    xmlXPathCastToString            (xmlXPathObjectPtr val);

+Converts an existing object to its string() equivalent

+ +

val : an XPath object +
Returns :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). +

xmlXPathConvertBoolean ()

xmlXPathObjectPtr xmlXPathConvertBoolean    (xmlXPathObjectPtr val);

+Converts an existing object to its boolean() equivalent

+ +

val : an XPath object +
Returns :the new object, the old one is freed (or the operation + is done directly on val) +

xmlXPathConvertNumber ()

xmlXPathObjectPtr xmlXPathConvertNumber     (xmlXPathObjectPtr val);

+Converts an existing object to its number() equivalent

+ +

val : an XPath object +
Returns :the new object, the old one is freed (or the operation + is done directly on val) +

xmlXPathConvertString ()

xmlXPathObjectPtr xmlXPathConvertString     (xmlXPathObjectPtr val);

+Converts an existing object to its string() equivalent

+ +

val : an XPath object +
Returns :the new object, the old one is freed (or the operation + is done directly on val) +

xmlXPathInit ()

void        xmlXPathInit                    (void);

+Initialize the XPath environment

+ +

xmlXPathNewContext ()

xmlXPathContextPtr xmlXPathNewContext       (xmlDocPtr doc);

+Create a new xmlXPathContext

+ +

doc : the XML document +
Returns :the xmlXPathContext just allocated. The caller will need to free it. +

xmlXPathFreeContext ()

void        xmlXPathFreeContext             (xmlXPathContextPtr ctxt);

+Free up an xmlXPathContext

+ +

ctxt : the context to free +

xmlXPathOrderDocElems ()

long        xmlXPathOrderDocElems           (xmlDocPtr doc);

+Call this routine to speed up XPath computation on static documents. This stamps all the element nodes with the document order Like for line information, the order is kept in the element->content field, the value stored is actually - the node number (startting at -1) -to be able to differenciate from line numbers.

doc : 
Returns : 

xmlXPathEval ()

xmlXPathObjectPtr xmlXPathEval              (const xmlChar *str,
-                                             xmlXPathContextPtr ctx);

Evaluate the XPath Location Path in the given context.

str : 
ctx : 
Returns : 

xmlXPathEvalExpression ()

xmlXPathObjectPtr xmlXPathEvalExpression    (const xmlChar *str,
-                                             xmlXPathContextPtr ctxt);

Evaluate the XPath expression in the given context.

str : 
ctxt : 
Returns : 

xmlXPathEvalPredicate ()

int         xmlXPathEvalPredicate           (xmlXPathContextPtr ctxt,
-                                             xmlXPathObjectPtr res);

Evaluate a predicate result for the current node. +to be able to differenciate from line numbers.

+ +

doc : an input document +
Returns :the number of element found in the document or -1 in case + of error. +

xmlXPathEval ()

xmlXPathObjectPtr xmlXPathEval              (const xmlChar *str,
+                                             xmlXPathContextPtr ctx);

+Evaluate the XPath Location Path in the given context.

+ +

str : the XPath expression +
ctx : the XPath context +
Returns :the xmlXPathObjectPtr resulting from the evaluation or NULL. + the caller has to free the object. +

xmlXPathEvalExpression ()

xmlXPathObjectPtr xmlXPathEvalExpression    (const xmlChar *str,
+                                             xmlXPathContextPtr ctxt);

+Evaluate the XPath expression in the given context.

+ +

str : the XPath expression +
ctxt : the XPath context +
Returns :the xmlXPathObjectPtr resulting from the evaluation or NULL. + the caller has to free the object. +

xmlXPathEvalPredicate ()

int         xmlXPathEvalPredicate           (xmlXPathContextPtr ctxt,
+                                             xmlXPathObjectPtr res);

+Evaluate a predicate result for the current node. A PredicateExpr is evaluated by evaluating the Expr and converting the result to a boolean. If the result is a number, the result will be converted to true if the number is equal to the position of the context node in the context node list (as returned by the position function) and will be converted to false otherwise; if the result is not a number, then the result will be converted as if by a call -to the boolean function.

ctxt : 
res : 
Returns : 

xmlXPathCompile ()

xmlXPathCompExprPtr xmlXPathCompile         (const xmlChar *str);

Compile an XPath expression

str : 
Returns : 

xmlXPathCompiledEval ()

xmlXPathObjectPtr xmlXPathCompiledEval      (xmlXPathCompExprPtr comp,
-                                             xmlXPathContextPtr ctx);

Evaluate the Precompiled XPath expression in the given context.

comp : 
ctx : 
Returns : 

xmlXPathFreeCompExpr ()

void        xmlXPathFreeCompExpr            (xmlXPathCompExprPtr comp);

Free up the memory allocated by comp

comp : 

\ No newline at end of file +to the boolean function.

+ +

ctxt : the XPath context +
res : the Predicate Expression evaluation result +
Returns :1 if predicate is true, 0 otherwise +

xmlXPathCompile ()

xmlXPathCompExprPtr xmlXPathCompile         (const xmlChar *str);

+Compile an XPath expression

+ +

str : the XPath expression +
Returns :the xmlXPathCompExprPtr resulting from the compilation or NULL. + the caller has to free the object. +

xmlXPathCompiledEval ()

xmlXPathObjectPtr xmlXPathCompiledEval      (xmlXPathCompExprPtr comp,
+                                             xmlXPathContextPtr ctx);

+Evaluate the Precompiled XPath expression in the given context.

+ +

comp : the compiled XPath expression +
ctx : the XPath context +
Returns :the xmlXPathObjectPtr resulting from the evaluation or NULL. + the caller has to free the object. +

xmlXPathFreeCompExpr ()

void        xmlXPathFreeCompExpr            (xmlXPathCompExprPtr comp);

+Free up the memory allocated by comp

+ +

comp : an XPATH comp +
<< HTMLtreexpathInternals >>
diff --git a/doc/html/libxml-xpathInternals.html b/doc/html/libxml-xpathInternals.html new file mode 100644 index 00000000..bf37b62c --- /dev/null +++ b/doc/html/libxml-xpathInternals.html @@ -0,0 +1,1465 @@ + +xpathInternals
PrevUpHomeGnome XML Library Reference ManualNext

xpathInternals

xpathInternals —

Synopsis

+
+
+
+#define     xmlXPathSetError                (ctxt, err)
+#define     xmlXPathSetArityError           (ctxt)
+#define     xmlXPathSetTypeError            (ctxt)
+#define     xmlXPathGetError                (ctxt)
+#define     xmlXPathCheckError              (ctxt)
+#define     xmlXPathGetDocument             (ctxt)
+#define     xmlXPathGetContextNode          (ctxt)
+int         xmlXPathPopBoolean              (xmlXPathParserContextPtr ctxt);
+double      xmlXPathPopNumber               (xmlXPathParserContextPtr ctxt);
+xmlChar*    xmlXPathPopString               (xmlXPathParserContextPtr ctxt);
+xmlNodeSetPtr xmlXPathPopNodeSet            (xmlXPathParserContextPtr ctxt);
+void*       xmlXPathPopExternal             (xmlXPathParserContextPtr ctxt);
+#define     xmlXPathReturnBoolean           (ctxt, val)
+#define     xmlXPathReturnTrue              (ctxt)
+#define     xmlXPathReturnFalse             (ctxt)
+#define     xmlXPathReturnNumber            (ctxt, val)
+#define     xmlXPathReturnString            (ctxt, str)
+#define     xmlXPathReturnEmptyString       (ctxt)
+#define     xmlXPathReturnNodeSet           (ctxt, ns)
+#define     xmlXPathReturnEmptyNodeSet      (ctxt)
+#define     xmlXPathReturnExternal          (ctxt, val)
+#define     xmlXPathStackIsNodeSet          (ctxt)
+#define     xmlXPathStackIsExternal         (ctxt)
+#define     xmlXPathEmptyNodeSet            (ns)
+#define     CHECK_ERROR
+#define     CHECK_ERROR0
+#define     XP_ERROR                        (X)
+#define     XP_ERROR0                       (X)
+#define     CHECK_TYPE                      (typeval)
+#define     CHECK_TYPE0                     (typeval)
+#define     CHECK_ARITY                     (x)
+#define     CAST_TO_STRING
+#define     CAST_TO_NUMBER
+#define     CAST_TO_BOOLEAN
+xmlXPathObjectPtr (*xmlXPathVariableLookupFunc)
+                                            (void *ctxt,
+                                             const xmlChar *name,
+                                             const xmlChar *ns_uri);
+void        xmlXPathRegisterVariableLookup  (xmlXPathContextPtr ctxt,
+                                             xmlXPathVariableLookupFunc f,
+                                             void *data);
+xmlXPathFunction (*xmlXPathFuncLookupFunc)  (void *ctxt,
+                                             const xmlChar *name,
+                                             const xmlChar *ns_uri);
+void        xmlXPathRegisterFuncLookup      (xmlXPathContextPtr ctxt,
+                                             xmlXPathFuncLookupFunc f,
+                                             void *funcCtxt);
+void        xmlXPatherror                   (xmlXPathParserContextPtr ctxt,
+                                             const char *file,
+                                             int line,
+                                             int no);
+void        xmlXPathDebugDumpObject         (FILE *output,
+                                             xmlXPathObjectPtr cur,
+                                             int depth);
+void        xmlXPathDebugDumpCompExpr       (FILE *output,
+                                             xmlXPathCompExprPtr comp,
+                                             int depth);
+int         xmlXPathNodeSetContains         (xmlNodeSetPtr cur,
+                                             xmlNodePtr val);
+xmlNodeSetPtr xmlXPathDifference            (xmlNodeSetPtr nodes1,
+                                             xmlNodeSetPtr nodes2);
+xmlNodeSetPtr xmlXPathIntersection          (xmlNodeSetPtr nodes1,
+                                             xmlNodeSetPtr nodes2);
+xmlNodeSetPtr xmlXPathDistinctSorted        (xmlNodeSetPtr nodes);
+xmlNodeSetPtr xmlXPathDistinct              (xmlNodeSetPtr nodes);
+int         xmlXPathHasSameNodes            (xmlNodeSetPtr nodes1,
+                                             xmlNodeSetPtr nodes2);
+xmlNodeSetPtr xmlXPathNodeLeadingSorted     (xmlNodeSetPtr nodes,
+                                             xmlNodePtr node);
+xmlNodeSetPtr xmlXPathLeadingSorted         (xmlNodeSetPtr nodes1,
+                                             xmlNodeSetPtr nodes2);
+xmlNodeSetPtr xmlXPathNodeLeading           (xmlNodeSetPtr nodes,
+                                             xmlNodePtr node);
+xmlNodeSetPtr xmlXPathLeading               (xmlNodeSetPtr nodes1,
+                                             xmlNodeSetPtr nodes2);
+xmlNodeSetPtr xmlXPathNodeTrailingSorted    (xmlNodeSetPtr nodes,
+                                             xmlNodePtr node);
+xmlNodeSetPtr xmlXPathTrailingSorted        (xmlNodeSetPtr nodes1,
+                                             xmlNodeSetPtr nodes2);
+xmlNodeSetPtr xmlXPathNodeTrailing          (xmlNodeSetPtr nodes,
+                                             xmlNodePtr node);
+xmlNodeSetPtr xmlXPathTrailing              (xmlNodeSetPtr nodes1,
+                                             xmlNodeSetPtr nodes2);
+int         xmlXPathRegisterNs              (xmlXPathContextPtr ctxt,
+                                             const xmlChar *prefix,
+                                             const xmlChar *ns_uri);
+const xmlChar* xmlXPathNsLookup             (xmlXPathContextPtr ctxt,
+                                             const xmlChar *prefix);
+void        xmlXPathRegisteredNsCleanup     (xmlXPathContextPtr ctxt);
+int         xmlXPathRegisterFunc            (xmlXPathContextPtr ctxt,
+                                             const xmlChar *name,
+                                             xmlXPathFunction f);
+int         xmlXPathRegisterFuncNS          (xmlXPathContextPtr ctxt,
+                                             const xmlChar *name,
+                                             const xmlChar *ns_uri,
+                                             xmlXPathFunction f);
+int         xmlXPathRegisterVariable        (xmlXPathContextPtr ctxt,
+                                             const xmlChar *name,
+                                             xmlXPathObjectPtr value);
+int         xmlXPathRegisterVariableNS      (xmlXPathContextPtr ctxt,
+                                             const xmlChar *name,
+                                             const xmlChar *ns_uri,
+                                             xmlXPathObjectPtr value);
+xmlXPathFunction xmlXPathFunctionLookup     (xmlXPathContextPtr ctxt,
+                                             const xmlChar *name);
+xmlXPathFunction xmlXPathFunctionLookupNS   (xmlXPathContextPtr ctxt,
+                                             const xmlChar *name,
+                                             const xmlChar *ns_uri);
+void        xmlXPathRegisteredFuncsCleanup  (xmlXPathContextPtr ctxt);
+xmlXPathObjectPtr xmlXPathVariableLookup    (xmlXPathContextPtr ctxt,
+                                             const xmlChar *name);
+xmlXPathObjectPtr xmlXPathVariableLookupNS  (xmlXPathContextPtr ctxt,
+                                             const xmlChar *name,
+                                             const xmlChar *ns_uri);
+void        xmlXPathRegisteredVariablesCleanup
+                                            (xmlXPathContextPtr ctxt);
+xmlXPathParserContextPtr xmlXPathNewParserContext
+                                            (const xmlChar *str,
+                                             xmlXPathContextPtr ctxt);
+void        xmlXPathFreeParserContext       (xmlXPathParserContextPtr ctxt);
+xmlXPathObjectPtr valuePop                  (xmlXPathParserContextPtr ctxt);
+int         valuePush                       (xmlXPathParserContextPtr ctxt,
+                                             xmlXPathObjectPtr value);
+xmlXPathObjectPtr xmlXPathNewString         (const xmlChar *val);
+xmlXPathObjectPtr xmlXPathNewCString        (const char *val);
+xmlXPathObjectPtr xmlXPathWrapString        (xmlChar *val);
+xmlXPathObjectPtr xmlXPathWrapCString       (char *val);
+xmlXPathObjectPtr xmlXPathNewFloat          (double val);
+xmlXPathObjectPtr xmlXPathNewBoolean        (int val);
+xmlXPathObjectPtr xmlXPathNewNodeSet        (xmlNodePtr val);
+xmlXPathObjectPtr xmlXPathNewValueTree      (xmlNodePtr val);
+void        xmlXPathNodeSetAdd              (xmlNodeSetPtr cur,
+                                             xmlNodePtr val);
+void        xmlXPathNodeSetAddUnique        (xmlNodeSetPtr cur,
+                                             xmlNodePtr val);
+void        xmlXPathNodeSetAddNs            (xmlNodeSetPtr cur,
+                                             xmlNodePtr node,
+                                             xmlNsPtr ns);
+void        xmlXPathNodeSetSort             (xmlNodeSetPtr set);
+void        xmlXPathRoot                    (xmlXPathParserContextPtr ctxt);
+void        xmlXPathEvalExpr                (xmlXPathParserContextPtr ctxt);
+xmlChar*    xmlXPathParseName               (xmlXPathParserContextPtr ctxt);
+xmlChar*    xmlXPathParseNCName             (xmlXPathParserContextPtr ctxt);
+double      xmlXPathStringEvalNumber        (const xmlChar *str);
+int         xmlXPathEvaluatePredicateResult (xmlXPathParserContextPtr ctxt,
+                                             xmlXPathObjectPtr res);
+void        xmlXPathRegisterAllFunctions    (xmlXPathContextPtr ctxt);
+xmlNodeSetPtr xmlXPathNodeSetMerge          (xmlNodeSetPtr val1,
+                                             xmlNodeSetPtr val2);
+void        xmlXPathNodeSetDel              (xmlNodeSetPtr cur,
+                                             xmlNodePtr val);
+void        xmlXPathNodeSetRemove           (xmlNodeSetPtr cur,
+                                             int val);
+xmlXPathObjectPtr xmlXPathNewNodeSetList    (xmlNodeSetPtr val);
+xmlXPathObjectPtr xmlXPathWrapNodeSet       (xmlNodeSetPtr val);
+xmlXPathObjectPtr xmlXPathWrapExternal      (void *val);
+int         xmlXPathEqualValues             (xmlXPathParserContextPtr ctxt);
+int         xmlXPathNotEqualValues          (xmlXPathParserContextPtr ctxt);
+int         xmlXPathCompareValues           (xmlXPathParserContextPtr ctxt,
+                                             int inf,
+                                             int strict);
+void        xmlXPathValueFlipSign           (xmlXPathParserContextPtr ctxt);
+void        xmlXPathAddValues               (xmlXPathParserContextPtr ctxt);
+void        xmlXPathSubValues               (xmlXPathParserContextPtr ctxt);
+void        xmlXPathMultValues              (xmlXPathParserContextPtr ctxt);
+void        xmlXPathDivValues               (xmlXPathParserContextPtr ctxt);
+void        xmlXPathModValues               (xmlXPathParserContextPtr ctxt);
+int         xmlXPathIsNodeType              (const xmlChar *name);
+xmlNodePtr  xmlXPathNextSelf                (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);
+xmlNodePtr  xmlXPathNextChild               (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);
+xmlNodePtr  xmlXPathNextDescendant          (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);
+xmlNodePtr  xmlXPathNextDescendantOrSelf    (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);
+xmlNodePtr  xmlXPathNextParent              (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);
+xmlNodePtr  xmlXPathNextAncestorOrSelf      (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);
+xmlNodePtr  xmlXPathNextFollowingSibling    (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);
+xmlNodePtr  xmlXPathNextFollowing           (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);
+xmlNodePtr  xmlXPathNextNamespace           (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);
+xmlNodePtr  xmlXPathNextAttribute           (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);
+xmlNodePtr  xmlXPathNextPreceding           (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);
+xmlNodePtr  xmlXPathNextAncestor            (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);
+xmlNodePtr  xmlXPathNextPrecedingSibling    (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);
+void        xmlXPathLastFunction            (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathPositionFunction        (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathCountFunction           (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathIdFunction              (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathLocalNameFunction       (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathNamespaceURIFunction    (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathStringFunction          (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathStringLengthFunction    (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathConcatFunction          (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathContainsFunction        (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathStartsWithFunction      (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathSubstringFunction       (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathSubstringBeforeFunction (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathSubstringAfterFunction  (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathNormalizeFunction       (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathTranslateFunction       (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathNotFunction             (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathTrueFunction            (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathFalseFunction           (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathLangFunction            (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathNumberFunction          (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathSumFunction             (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathFloorFunction           (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathCeilingFunction         (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathRoundFunction           (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathBooleanFunction         (xmlXPathParserContextPtr ctxt,
+                                             int nargs);
+void        xmlXPathNodeSetFreeNs           (xmlNsPtr ns);
+

Description

+ +

Details

xmlXPathSetError()

#define     xmlXPathSetError(ctxt, err)

+Raises an error.

+ +

ctxt : an XPath parser context +
err : an xmlXPathError code +

xmlXPathSetArityError()

#define     xmlXPathSetArityError(ctxt)

+Raises an XPATH_INVALID_ARITY error.

+ +

ctxt : an XPath parser context +

xmlXPathSetTypeError()

#define     xmlXPathSetTypeError(ctxt)

+Raises an XPATH_INVALID_TYPE error.

+ +

ctxt : an XPath parser context +

xmlXPathGetError()

#define xmlXPathGetError(ctxt)	  ((ctxt)->error)
+

+Get the error code of an XPath context.

+ +

ctxt : an XPath parser context +

xmlXPathCheckError()

#define xmlXPathCheckError(ctxt)  ((ctxt)->error != XPATH_EXPRESSION_OK)
+

+Check if an XPath error was raised.

+ +

ctxt : an XPath parser context +

xmlXPathGetDocument()

#define xmlXPathGetDocument(ctxt)	((ctxt)->context->doc)
+

+Get the document of an XPath context.

+ +

ctxt : an XPath parser context +

xmlXPathGetContextNode()

#define xmlXPathGetContextNode(ctxt)	((ctxt)->context->node)
+

+Get the context node of an XPath context.

+ +

ctxt : an XPath parser context +

xmlXPathPopBoolean ()

int         xmlXPathPopBoolean              (xmlXPathParserContextPtr ctxt);

+Pops a boolean from the stack, handling conversion if needed. +Check error with xmlXPathCheckError.

+ +

ctxt : an XPath parser context +
Returns :the boolean +

xmlXPathPopNumber ()

double      xmlXPathPopNumber               (xmlXPathParserContextPtr ctxt);

+Pops a number from the stack, handling conversion if needed. +Check error with xmlXPathCheckError.

+ +

ctxt : an XPath parser context +
Returns :the number +

xmlXPathPopString ()

xmlChar*    xmlXPathPopString               (xmlXPathParserContextPtr ctxt);

+Pops a string from the stack, handling conversion if needed. +Check error with xmlXPathCheckError.

+ +

ctxt : an XPath parser context +
Returns :the string +

xmlXPathPopNodeSet ()

xmlNodeSetPtr xmlXPathPopNodeSet            (xmlXPathParserContextPtr ctxt);

+Pops a node-set from the stack, handling conversion if needed. +Check error with xmlXPathCheckError.

+ +

ctxt : an XPath parser context +
Returns :the node-set +

xmlXPathPopExternal ()

void*       xmlXPathPopExternal             (xmlXPathParserContextPtr ctxt);

+Pops an external object from the stack, handling conversion if needed. +Check error with xmlXPathCheckError.

+ +

ctxt : an XPath parser context +

xmlXPathReturnBoolean()

#define     xmlXPathReturnBoolean(ctxt, val)

+Pushes the boolean val on the context stack.

+ +

ctxt : an XPath parser context +
val : a boolean +

xmlXPathReturnTrue()

#define xmlXPathReturnTrue(ctxt)   xmlXPathReturnBoolean((ctxt), 1)
+

+Pushes true on the context stack.

+ +

ctxt : an XPath parser context +

xmlXPathReturnFalse()

#define xmlXPathReturnFalse(ctxt)  xmlXPathReturnBoolean((ctxt), 0)
+

+Pushes false on the context stack.

+ +

ctxt : an XPath parser context +

xmlXPathReturnNumber()

#define     xmlXPathReturnNumber(ctxt, val)

+Pushes the double val on the context stack.

+ +

ctxt : an XPath parser context +
val : a double +

xmlXPathReturnString()

#define     xmlXPathReturnString(ctxt, str)

+Pushes the string str on the context stack.

+ +

ctxt : an XPath parser context +
str : a string +

xmlXPathReturnEmptyString()

#define     xmlXPathReturnEmptyString(ctxt)

+Pushes an empty string on the stack.

+ +

ctxt : an XPath parser context +

xmlXPathReturnNodeSet()

#define     xmlXPathReturnNodeSet(ctxt, ns)

+Pushes the node-set ns on the context stack.

+ +

ctxt : an XPath parser context +
ns : a node-set +

xmlXPathReturnEmptyNodeSet()

#define     xmlXPathReturnEmptyNodeSet(ctxt)

+Pushes an empty node-set on the context stack.

+ +

ctxt : an XPath parser context +

xmlXPathReturnExternal()

#define     xmlXPathReturnExternal(ctxt, val)

+Pushes user data on the context stack.

+ +

ctxt : an XPath parser context +
val : user data +

xmlXPathStackIsNodeSet()

#define     xmlXPathStackIsNodeSet(ctxt)

+Check if the current value on the XPath stack is a node set or +an XSLT value tree.

+ +

ctxt : an XPath parser context +

xmlXPathStackIsExternal()

#define     xmlXPathStackIsExternal(ctxt)

+Checks if the current value on the XPath stack is an external +object.

+ +

ctxt : an XPath parser context +

xmlXPathEmptyNodeSet()

#define     xmlXPathEmptyNodeSet(ns)

+Empties a node-set.

+ +

ns : a node-set +

CHECK_ERROR

#define     CHECK_ERROR

+Macro to return from the function if an XPath error was detected.

+ +

CHECK_ERROR0

#define     CHECK_ERROR0

+Macro to return 0 from the function if an XPath error was detected.

+ +

XP_ERROR()

#define     XP_ERROR(X)

+Macro to raise an XPath error and return.

+ +

X : the error code +

XP_ERROR0()

#define     XP_ERROR0(X)

+Macro to raise an XPath error and return 0.

+ +

X : the error code +

CHECK_TYPE()

#define     CHECK_TYPE(typeval)

+Macro to check that the value on top of the XPath stack is of a given +type.

+ +

typeval : the XPath type +

CHECK_TYPE0()

#define     CHECK_TYPE0(typeval)

+Macro to check that the value on top of the XPath stack is of a given +type. Return(0) in case of failure

+ +

typeval : the XPath type +

CHECK_ARITY()

#define     CHECK_ARITY(x)

+Macro to check that the number of args passed to an XPath function matches.

+ +

x : the number of expected args +

CAST_TO_STRING

#define     CAST_TO_STRING

+Macro to try to cast the value on the top of the XPath stack to a string.

+ +

CAST_TO_NUMBER

#define     CAST_TO_NUMBER

+Macro to try to cast the value on the top of the XPath stack to a number.

+ +

CAST_TO_BOOLEAN

#define     CAST_TO_BOOLEAN

+Macro to try to cast the value on the top of the XPath stack to a boolean.

+ +

xmlXPathVariableLookupFunc ()

xmlXPathObjectPtr (*xmlXPathVariableLookupFunc)
+                                            (void *ctxt,
+                                             const xmlChar *name,
+                                             const xmlChar *ns_uri);

+Prototype for callbacks used to plug variable lookup in the XPath +engine.

+ +

ctxt : an XPath context +
name : name of the variable +
ns_uri : the namespace name hosting this variable +
Returns :the XPath object value or NULL if not found. +

xmlXPathRegisterVariableLookup ()

void        xmlXPathRegisterVariableLookup  (xmlXPathContextPtr ctxt,
+                                             xmlXPathVariableLookupFunc f,
+                                             void *data);

+register an external mechanism to do variable lookup

+ +

ctxt : the XPath context +
f : the lookup function +
data : the lookup data +

xmlXPathFuncLookupFunc ()

xmlXPathFunction (*xmlXPathFuncLookupFunc)  (void *ctxt,
+                                             const xmlChar *name,
+                                             const xmlChar *ns_uri);

+Prototype for callbacks used to plug function lookup in the XPath +engine.

+ +

ctxt : an XPath context +
name : name of the function +
ns_uri : the namespace name hosting this function +
Returns :the XPath function or NULL if not found. +

xmlXPathRegisterFuncLookup ()

void        xmlXPathRegisterFuncLookup      (xmlXPathContextPtr ctxt,
+                                             xmlXPathFuncLookupFunc f,
+                                             void *funcCtxt);

+Registers an external mechanism to do function lookup.

+ +

ctxt : the XPath context +
f : the lookup function +
funcCtxt : the lookup data +

xmlXPatherror ()

void        xmlXPatherror                   (xmlXPathParserContextPtr ctxt,
+                                             const char *file,
+                                             int line,
+                                             int no);

+Formats an error message.

+ +

ctxt : the XPath Parser context +
file : the file name +
line : the line number +
no : the error number +

xmlXPathDebugDumpObject ()

void        xmlXPathDebugDumpObject         (FILE *output,
+                                             xmlXPathObjectPtr cur,
+                                             int depth);

+Dump the content of the object for debugging purposes

+ +

output : the FILE * to dump the output +
cur : the object to inspect +
depth : indentation level +

xmlXPathDebugDumpCompExpr ()

void        xmlXPathDebugDumpCompExpr       (FILE *output,
+                                             xmlXPathCompExprPtr comp,
+                                             int depth);

+Dumps the tree of the compiled XPath expression.

+ +

output : the FILE * for the output +
comp : the precompiled XPath expression +
depth : the indentation level. +

xmlXPathNodeSetContains ()

int         xmlXPathNodeSetContains         (xmlNodeSetPtr cur,
+                                             xmlNodePtr val);

+checks whether cur contains val

+ +

cur : the node-set +
val : the node +
Returns :true (1) if cur contains val, false (0) otherwise +

xmlXPathDifference ()

xmlNodeSetPtr xmlXPathDifference            (xmlNodeSetPtr nodes1,
+                                             xmlNodeSetPtr nodes2);

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

+ +

nodes1 : a node-set +
nodes2 : a node-set +
Returns :the difference between the two node sets, or nodes1 if + nodes2 is empty +

xmlXPathIntersection ()

xmlNodeSetPtr xmlXPathIntersection          (xmlNodeSetPtr nodes1,
+                                             xmlNodeSetPtr nodes2);

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

+ +

nodes1 : a node-set +
nodes2 : a node-set +
Returns :a node set comprising the nodes that are within both the + node sets passed as arguments +

xmlXPathDistinctSorted ()

xmlNodeSetPtr xmlXPathDistinctSorted        (xmlNodeSetPtr nodes);

+Implements the EXSLT - Sets distinct() function: + node-set set:distinct (node-set)

+ +

nodes : a node-set, sorted by document order +
Returns :a subset of the nodes contained in nodes, or nodes if + it is empty +

xmlXPathDistinct ()

xmlNodeSetPtr xmlXPathDistinct              (xmlNodeSetPtr nodes);

+Implements the EXSLT - Sets distinct() function: + node-set set:distinct (node-set) +nodes is sorted by document order, then exslSetsDistinctSorted +is called with the sorted node-set

+ +

nodes : a node-set +
Returns :a subset of the nodes contained in nodes, or nodes if + it is empty +

xmlXPathHasSameNodes ()

int         xmlXPathHasSameNodes            (xmlNodeSetPtr nodes1,
+                                             xmlNodeSetPtr nodes2);

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

+ +

nodes1 : a node-set +
nodes2 : a node-set +
Returns :true (1) if nodes1 shares any node with nodes2, false (0) + otherwise +

xmlXPathNodeLeadingSorted ()

xmlNodeSetPtr xmlXPathNodeLeadingSorted     (xmlNodeSetPtr nodes,
+                                             xmlNodePtr node);

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

+ +

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

xmlXPathLeadingSorted ()

xmlNodeSetPtr xmlXPathLeadingSorted         (xmlNodeSetPtr nodes1,
+                                             xmlNodeSetPtr nodes2);

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

+ +

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

xmlXPathNodeLeading ()

xmlNodeSetPtr xmlXPathNodeLeading           (xmlNodeSetPtr nodes,
+                                             xmlNodePtr node);

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

+ +

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

xmlXPathLeading ()

xmlNodeSetPtr xmlXPathLeading               (xmlNodeSetPtr nodes1,
+                                             xmlNodeSetPtr nodes2);

+Implements the EXSLT - Sets leading() function: + node-set set:leading (node-set, node-set) +nodes1 and nodes2 are sorted by document order, then +exslSetsLeadingSorted is called.

+ +

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

xmlXPathNodeTrailingSorted ()

xmlNodeSetPtr xmlXPathNodeTrailingSorted    (xmlNodeSetPtr nodes,
+                                             xmlNodePtr node);

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

+ +

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

xmlXPathTrailingSorted ()

xmlNodeSetPtr xmlXPathTrailingSorted        (xmlNodeSetPtr nodes1,
+                                             xmlNodeSetPtr nodes2);

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

+ +

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

xmlXPathNodeTrailing ()

xmlNodeSetPtr xmlXPathNodeTrailing          (xmlNodeSetPtr nodes,
+                                             xmlNodePtr node);

+Implements the EXSLT - Sets trailing() function: + node-set set:trailing (node-set, node-set) +nodes is sorted by document order, then xmlXPathNodeTrailingSorted +is called.

+ +

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

xmlXPathTrailing ()

xmlNodeSetPtr xmlXPathTrailing              (xmlNodeSetPtr nodes1,
+                                             xmlNodeSetPtr nodes2);

+Implements the EXSLT - Sets trailing() function: + node-set set:trailing (node-set, node-set) +nodes1 and nodes2 are sorted by document order, then +xmlXPathTrailingSorted is called.

+ +

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

xmlXPathRegisterNs ()

int         xmlXPathRegisterNs              (xmlXPathContextPtr ctxt,
+                                             const xmlChar *prefix,
+                                             const xmlChar *ns_uri);

+Register a new namespace. If ns_uri is NULL it unregisters +the namespace

+ +

ctxt : the XPath context +
prefix : the namespace prefix +
ns_uri : the namespace name +
Returns :0 in case of success, -1 in case of error +

xmlXPathNsLookup ()

const xmlChar* xmlXPathNsLookup             (xmlXPathContextPtr ctxt,
+                                             const xmlChar *prefix);

+Search in the namespace declaration array of the context for the given +namespace name associated to the given prefix

+ +

ctxt : the XPath context +
prefix : the namespace prefix value +
Returns :the value or NULL if not found +

xmlXPathRegisteredNsCleanup ()

void        xmlXPathRegisteredNsCleanup     (xmlXPathContextPtr ctxt);

+Cleanup the XPath context data associated to registered variables

+ +

ctxt : the XPath context +

xmlXPathRegisterFunc ()

int         xmlXPathRegisterFunc            (xmlXPathContextPtr ctxt,
+                                             const xmlChar *name,
+                                             xmlXPathFunction f);

+Register a new function. If f is NULL it unregisters the function

+ +

ctxt : the XPath context +
name : the function name +
f : the function implementation or NULL +
Returns :0 in case of success, -1 in case of error +

xmlXPathRegisterFuncNS ()

int         xmlXPathRegisterFuncNS          (xmlXPathContextPtr ctxt,
+                                             const xmlChar *name,
+                                             const xmlChar *ns_uri,
+                                             xmlXPathFunction f);

+Register a new function. If f is NULL it unregisters the function

+ +

ctxt : the XPath context +
name : the function name +
ns_uri : the function namespace URI +
f : the function implementation or NULL +
Returns :0 in case of success, -1 in case of error +

xmlXPathRegisterVariable ()

int         xmlXPathRegisterVariable        (xmlXPathContextPtr ctxt,
+                                             const xmlChar *name,
+                                             xmlXPathObjectPtr value);

+Register a new variable value. If value is NULL it unregisters +the variable

+ +

ctxt : the XPath context +
name : the variable name +
value : the variable value or NULL +
Returns :0 in case of success, -1 in case of error +

xmlXPathRegisterVariableNS ()

int         xmlXPathRegisterVariableNS      (xmlXPathContextPtr ctxt,
+                                             const xmlChar *name,
+                                             const xmlChar *ns_uri,
+                                             xmlXPathObjectPtr value);

+Register a new variable value. If value is NULL it unregisters +the variable

+ +

ctxt : the XPath context +
name : the variable name +
ns_uri : the variable namespace URI +
value : the variable value or NULL +
Returns :0 in case of success, -1 in case of error +

xmlXPathFunctionLookup ()

xmlXPathFunction xmlXPathFunctionLookup     (xmlXPathContextPtr ctxt,
+                                             const xmlChar *name);

+Search in the Function array of the context for the given +function.

+ +

ctxt : the XPath context +
name : the function name +
Returns :the xmlXPathFunction or NULL if not found +

xmlXPathFunctionLookupNS ()

xmlXPathFunction xmlXPathFunctionLookupNS   (xmlXPathContextPtr ctxt,
+                                             const xmlChar *name,
+                                             const xmlChar *ns_uri);

+Search in the Function array of the context for the given +function.

+ +

ctxt : the XPath context +
name : the function name +
ns_uri : the function namespace URI +
Returns :the xmlXPathFunction or NULL if not found +

xmlXPathRegisteredFuncsCleanup ()

void        xmlXPathRegisteredFuncsCleanup  (xmlXPathContextPtr ctxt);

+Cleanup the XPath context data associated to registered functions

+ +

ctxt : the XPath context +

xmlXPathVariableLookup ()

xmlXPathObjectPtr xmlXPathVariableLookup    (xmlXPathContextPtr ctxt,
+                                             const xmlChar *name);

+Search in the Variable array of the context for the given +variable value.

+ +

ctxt : the XPath context +
name : the variable name +
Returns :a copy of the value or NULL if not found +

xmlXPathVariableLookupNS ()

xmlXPathObjectPtr xmlXPathVariableLookupNS  (xmlXPathContextPtr ctxt,
+                                             const xmlChar *name,
+                                             const xmlChar *ns_uri);

+Search in the Variable array of the context for the given +variable value.

+ +

ctxt : the XPath context +
name : the variable name +
ns_uri : the variable namespace URI +
Returns :the a copy of the value or NULL if not found +

xmlXPathRegisteredVariablesCleanup ()

void        xmlXPathRegisteredVariablesCleanup
+                                            (xmlXPathContextPtr ctxt);

+Cleanup the XPath context data associated to registered variables

+ +

ctxt : the XPath context +

xmlXPathNewParserContext ()

xmlXPathParserContextPtr xmlXPathNewParserContext
+                                            (const xmlChar *str,
+                                             xmlXPathContextPtr ctxt);

+Create a new xmlXPathParserContext

+ +

str : the XPath expression +
ctxt : the XPath context +
Returns :the xmlXPathParserContext just allocated. +

xmlXPathFreeParserContext ()

void        xmlXPathFreeParserContext       (xmlXPathParserContextPtr ctxt);

+Free up an xmlXPathParserContext

+ +

ctxt : the context to free +

valuePop ()

xmlXPathObjectPtr valuePop                  (xmlXPathParserContextPtr ctxt);

+Pops the top XPath object from the value stack

+ +

ctxt : an XPath evaluation context +
Returns :the XPath object just removed +

valuePush ()

int         valuePush                       (xmlXPathParserContextPtr ctxt,
+                                             xmlXPathObjectPtr value);

+Pushes a new XPath object on top of the value stack

+ +

ctxt : an XPath evaluation context +
value : the XPath object +
Returns :the number of items on the value stack +

xmlXPathNewString ()

xmlXPathObjectPtr xmlXPathNewString         (const xmlChar *val);

+Create a new xmlXPathObjectPtr of type string and of value val

+ +

val : the xmlChar * value +
Returns :the newly created object. +

xmlXPathNewCString ()

xmlXPathObjectPtr xmlXPathNewCString        (const char *val);

+Create a new xmlXPathObjectPtr of type string and of value val

+ +

val : the char * value +
Returns :the newly created object. +

xmlXPathWrapString ()

xmlXPathObjectPtr xmlXPathWrapString        (xmlChar *val);

+Wraps the val string into an XPath object.

+ +

val : the xmlChar * value +
Returns :the newly created object. +

xmlXPathWrapCString ()

xmlXPathObjectPtr xmlXPathWrapCString       (char *val);

+Wraps a string into an XPath object.

+ +

val : the char * value +
Returns :the newly created object. +

xmlXPathNewFloat ()

xmlXPathObjectPtr xmlXPathNewFloat          (double val);

+Create a new xmlXPathObjectPtr of type double and of value val

+ +

val : the double value +
Returns :the newly created object. +

xmlXPathNewBoolean ()

xmlXPathObjectPtr xmlXPathNewBoolean        (int val);

+Create a new xmlXPathObjectPtr of type boolean and of value val

+ +

val : the boolean value +
Returns :the newly created object. +

xmlXPathNewNodeSet ()

xmlXPathObjectPtr xmlXPathNewNodeSet        (xmlNodePtr val);

+Create a new xmlXPathObjectPtr of type NodeSet and initialize +it with the single Node val

+ +

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

xmlXPathNewValueTree ()

xmlXPathObjectPtr xmlXPathNewValueTree      (xmlNodePtr val);

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

+ +

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

xmlXPathNodeSetAdd ()

void        xmlXPathNodeSetAdd              (xmlNodeSetPtr cur,
+                                             xmlNodePtr val);

+add a new xmlNodePtr to an existing NodeSet

+ +

cur : the initial node set +
val : a new xmlNodePtr +

xmlXPathNodeSetAddUnique ()

void        xmlXPathNodeSetAddUnique        (xmlNodeSetPtr cur,
+                                             xmlNodePtr val);

+add a new xmlNodePtr to an existing NodeSet, optimized version +when we are sure the node is not already in the set.

+ +

cur : the initial node set +
val : a new xmlNodePtr +

xmlXPathNodeSetAddNs ()

void        xmlXPathNodeSetAddNs            (xmlNodeSetPtr cur,
+                                             xmlNodePtr node,
+                                             xmlNsPtr ns);

+add a new namespace node to an existing NodeSet

+ +

cur : the initial node set +
node : the hosting node +
ns : a the namespace node +

xmlXPathNodeSetSort ()

void        xmlXPathNodeSetSort             (xmlNodeSetPtr set);

+Sort the node set in document order

+ +

set : the node set +

xmlXPathRoot ()

void        xmlXPathRoot                    (xmlXPathParserContextPtr ctxt);

+Initialize the context to the root of the document

+ +

ctxt : the XPath Parser context +

xmlXPathEvalExpr ()

void        xmlXPathEvalExpr                (xmlXPathParserContextPtr ctxt);

+Parse and evaluate an XPath expression in the given context, +then push the result on the context stack

+ +

ctxt : the XPath Parser context +

xmlXPathParseName ()

xmlChar*    xmlXPathParseName               (xmlXPathParserContextPtr ctxt);

+parse an XML name +

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

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

+ +

ctxt : the XPath Parser context +
Returns :the namespace name or NULL +

xmlXPathParseNCName ()

xmlChar*    xmlXPathParseNCName             (xmlXPathParserContextPtr ctxt);

+parse an XML namespace non qualified name. +

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

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

+ +

ctxt : the XPath Parser context +
Returns :the namespace name or NULL +

xmlXPathStringEvalNumber ()

double      xmlXPathStringEvalNumber        (const xmlChar *str);

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

+ [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 +negative values : '-' Number.

+ +

str : A string to scan +
Returns :the double value. +

xmlXPathEvaluatePredicateResult ()

int         xmlXPathEvaluatePredicateResult (xmlXPathParserContextPtr ctxt,
+                                             xmlXPathObjectPtr res);

+Evaluate a predicate result for the current node. +A PredicateExpr is evaluated by evaluating the Expr and converting +the result to a boolean. If the result is a number, the result will +be converted to true if the number is equal to the position of the +context node in the context node list (as returned by the position +function) and will be converted to false otherwise; if the result +is not a number, then the result will be converted as if by a call +to the boolean function.

+ +

ctxt : the XPath Parser context +
res : the Predicate Expression evaluation result +
Returns :1 if predicate is true, 0 otherwise +

xmlXPathRegisterAllFunctions ()

void        xmlXPathRegisterAllFunctions    (xmlXPathContextPtr ctxt);

+Registers all default XPath functions in this context

+ +

ctxt : the XPath context +

xmlXPathNodeSetMerge ()

xmlNodeSetPtr xmlXPathNodeSetMerge          (xmlNodeSetPtr val1,
+                                             xmlNodeSetPtr val2);

+Merges two nodesets, all nodes from val2 are added to val1 +if val1 is NULL, a new set is created and copied from val2

+ +

val1 : the first NodeSet or NULL +
val2 : the second NodeSet +
Returns :val1 once extended or NULL in case of error. +

xmlXPathNodeSetDel ()

void        xmlXPathNodeSetDel              (xmlNodeSetPtr cur,
+                                             xmlNodePtr val);

+Removes an xmlNodePtr from an existing NodeSet

+ +

cur : the initial node set +
val : an xmlNodePtr +

xmlXPathNodeSetRemove ()

void        xmlXPathNodeSetRemove           (xmlNodeSetPtr cur,
+                                             int val);

+Removes an entry from an existing NodeSet list.

+ +

cur : the initial node set +
val : the index to remove +

xmlXPathNewNodeSetList ()

xmlXPathObjectPtr xmlXPathNewNodeSetList    (xmlNodeSetPtr val);

+Create a new xmlXPathObjectPtr of type NodeSet and initialize +it with the Nodeset val

+ +

val : an existing NodeSet +
Returns :the newly created object. +

xmlXPathWrapNodeSet ()

xmlXPathObjectPtr xmlXPathWrapNodeSet       (xmlNodeSetPtr val);

+Wrap the Nodeset val in a new xmlXPathObjectPtr

+ +

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

xmlXPathWrapExternal ()

xmlXPathObjectPtr xmlXPathWrapExternal      (void *val);

+Wraps the val data into an XPath object.

+ +

val : the user data +
Returns :the newly created object. +

xmlXPathEqualValues ()

int         xmlXPathEqualValues             (xmlXPathParserContextPtr ctxt);

+Implement the equal operation on XPath objects content: arg1 == arg2

+ +

ctxt : the XPath Parser context +
Returns :0 or 1 depending on the results of the test. +

xmlXPathNotEqualValues ()

int         xmlXPathNotEqualValues          (xmlXPathParserContextPtr ctxt);

+Implement the equal operation on XPath objects content: arg1 == arg2

+ +

ctxt : the XPath Parser context +
Returns :0 or 1 depending on the results of the test. +

xmlXPathCompareValues ()

int         xmlXPathCompareValues           (xmlXPathParserContextPtr ctxt,
+                                             int inf,
+                                             int strict);

+Implement the compare operation on XPath objects: + arg1 < arg2 (1, 1, ... + arg1 <= arg2 (1, 0, ... + arg1 > arg2 (0, 1, ... + arg1 >= arg2 (0, 0, ... +

+When neither object to be compared is a node-set and the operator is +<=, <, >=, >, then the objects are compared by converted both objects +to numbers and comparing the numbers according to IEEE 754. The < +comparison will be true if and only if the first number is less than the +second number. The <= comparison will be true if and only if the first +number is less than or equal to the second number. The > comparison +will be true if and only if the first number is greater than the second +number. The >= comparison will be true if and only if the first number +is greater than or equal to the second number.

+ +

ctxt : the XPath Parser context +
inf : less than (1) or greater than (0) +
strict : is the comparison strict +
Returns :1 if the comparison succeeded, 0 if it failed +

xmlXPathValueFlipSign ()

void        xmlXPathValueFlipSign           (xmlXPathParserContextPtr ctxt);

+Implement the unary - operation on an XPath object +The numeric operators convert their operands to numbers as if +by calling the number function.

+ +

ctxt : the XPath Parser context +

xmlXPathAddValues ()

void        xmlXPathAddValues               (xmlXPathParserContextPtr ctxt);

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

+ +

ctxt : the XPath Parser context +

xmlXPathSubValues ()

void        xmlXPathSubValues               (xmlXPathParserContextPtr ctxt);

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

+ +

ctxt : the XPath Parser context +

xmlXPathMultValues ()

void        xmlXPathMultValues              (xmlXPathParserContextPtr ctxt);

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

+ +

ctxt : the XPath Parser context +

xmlXPathDivValues ()

void        xmlXPathDivValues               (xmlXPathParserContextPtr ctxt);

+Implement the div operation on XPath objects arg1 / arg2: +The numeric operators convert their operands to numbers as if +by calling the number function.

+ +

ctxt : the XPath Parser context +

xmlXPathModValues ()

void        xmlXPathModValues               (xmlXPathParserContextPtr ctxt);

+Implement the mod operation on XPath objects: arg1 / arg2 +The numeric operators convert their operands to numbers as if +by calling the number function.

+ +

ctxt : the XPath Parser context +

xmlXPathIsNodeType ()

int         xmlXPathIsNodeType              (const xmlChar *name);

+Is the name given a NodeType one. +

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

+ +

name : a name string +
Returns :1 if true 0 otherwise +

xmlXPathNextSelf ()

xmlNodePtr  xmlXPathNextSelf                (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);

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

+ +

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

xmlXPathNextChild ()

xmlNodePtr  xmlXPathNextChild               (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);

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

+ +

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

xmlXPathNextDescendant ()

xmlNodePtr  xmlXPathNextDescendant          (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);

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

+ +

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

xmlXPathNextDescendantOrSelf ()

xmlNodePtr  xmlXPathNextDescendantOrSelf    (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);

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

+ +

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

xmlXPathNextParent ()

xmlNodePtr  xmlXPathNextParent              (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);

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

+ +

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

xmlXPathNextAncestorOrSelf ()

xmlNodePtr  xmlXPathNextAncestorOrSelf      (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);

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

+ +

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

xmlXPathNextFollowingSibling ()

xmlNodePtr  xmlXPathNextFollowingSibling    (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);

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

+ +

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

xmlXPathNextFollowing ()

xmlNodePtr  xmlXPathNextFollowing           (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);

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

+ +

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

xmlXPathNextNamespace ()

xmlNodePtr  xmlXPathNextNamespace           (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);

+Traversal function for the "namespace" direction +the namespace axis contains the namespace nodes of the context node; +the order of nodes on this axis is implementation-defined; the axis will +be empty unless the context node is an element +

+We keep the XML namespace node at the end of the list.

+ +

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

xmlXPathNextAttribute ()

xmlNodePtr  xmlXPathNextAttribute           (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);

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

+ +

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

xmlXPathNextPreceding ()

xmlNodePtr  xmlXPathNextPreceding           (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);

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

+ +

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

xmlXPathNextAncestor ()

xmlNodePtr  xmlXPathNextAncestor            (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);

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

+ +

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

xmlXPathNextPrecedingSibling ()

xmlNodePtr  xmlXPathNextPrecedingSibling    (xmlXPathParserContextPtr ctxt,
+                                             xmlNodePtr cur);

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

+ +

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

xmlXPathLastFunction ()

void        xmlXPathLastFunction            (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the last() XPath function + number last() +The last function returns the number of nodes in the context node list.

+ +

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

xmlXPathPositionFunction ()

void        xmlXPathPositionFunction        (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the position() XPath function + number position() +The position function returns the position of the context node in the +context node list. The first position is 1, and so the last position +will be equal to last().

+ +

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

xmlXPathCountFunction ()

void        xmlXPathCountFunction           (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the count() XPath function + number count(node-set)

+ +

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

xmlXPathIdFunction ()

void        xmlXPathIdFunction              (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the id() XPath function + 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 +string value of each of the nodes in the argument node-set. When the +argument to id is of any other type, the argument is converted to a +string as if by a call to the string function; the string is split +into a whitespace-separated list of tokens (whitespace is any sequence +of characters matching the production S); the result is a node-set +containing the elements in the same document as the context node that +have a unique ID equal to any of the tokens in the list.

+ +

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

xmlXPathLocalNameFunction ()

void        xmlXPathLocalNameFunction       (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the local-name() XPath function + 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 +name, an empty string is returned. If the argument is omitted it +defaults to the context node.

+ +

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

xmlXPathNamespaceURIFunction ()

void        xmlXPathNamespaceURIFunction    (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the namespace-uri() XPath function + 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, +the first node has no name, or the expanded name has no namespace +URI, an empty string is returned. If the argument is omitted it +defaults to the context node.

+ +

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

xmlXPathStringFunction ()

void        xmlXPathStringFunction          (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the string() XPath function + 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.

+ +

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

xmlXPathStringLengthFunction ()

void        xmlXPathStringLengthFunction    (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the string-length() XPath function + 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 +of the context node.

+ +

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

xmlXPathConcatFunction ()

void        xmlXPathConcatFunction          (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

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

+ +

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

xmlXPathContainsFunction ()

void        xmlXPathContainsFunction        (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

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

+ +

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

xmlXPathStartsWithFunction ()

void        xmlXPathStartsWithFunction      (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the starts-with() XPath function + 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.

+ +

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

xmlXPathSubstringFunction ()

void        xmlXPathSubstringFunction       (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

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

+ +

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

xmlXPathSubstringBeforeFunction ()

void        xmlXPathSubstringBeforeFunction (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

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

+ +

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

xmlXPathSubstringAfterFunction ()

void        xmlXPathSubstringAfterFunction  (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

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

+ +

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

xmlXPathNormalizeFunction ()

void        xmlXPathNormalizeFunction       (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the normalize-space() XPath function + 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 +space. Whitespace characters are the same allowed by the S production +in XML. If the argument is omitted, it defaults to the context +node converted to a string, in other words the value of the context node.

+ +

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

xmlXPathTranslateFunction ()

void        xmlXPathTranslateFunction       (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

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

+ +

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

xmlXPathNotFunction ()

void        xmlXPathNotFunction             (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

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

+ +

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

xmlXPathTrueFunction ()

void        xmlXPathTrueFunction            (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the true() XPath function + boolean true()

+ +

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

xmlXPathFalseFunction ()

void        xmlXPathFalseFunction           (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the false() XPath function + boolean false()

+ +

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

xmlXPathLangFunction ()

void        xmlXPathLangFunction            (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the lang() XPath function + 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 +the argument string. The language of the context node is determined +by the value of the xml:lang attribute on the context node, or, if +the context node has no xml:lang attribute, by the value of the +xml:lang attribute on the nearest ancestor of the context node that +has an xml:lang attribute. If there is no such attribute, then lang

+ +

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

xmlXPathNumberFunction ()

void        xmlXPathNumberFunction          (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the number() XPath function + number number(object?)

+ +

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

xmlXPathSumFunction ()

void        xmlXPathSumFunction             (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

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

+ +

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

xmlXPathFloorFunction ()

void        xmlXPathFloorFunction           (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the floor() XPath function + 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.

+ +

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

xmlXPathCeilingFunction ()

void        xmlXPathCeilingFunction         (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the ceiling() XPath function + 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.

+ +

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

xmlXPathRoundFunction ()

void        xmlXPathRoundFunction           (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the round() XPath function + 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.

+ +

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

xmlXPathBooleanFunction ()

void        xmlXPathBooleanFunction         (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the boolean() XPath function + 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

+ +

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

xmlXPathNodeSetFreeNs ()

void        xmlXPathNodeSetFreeNs           (xmlNsPtr ns);

+Namespace node in libxml don't match the XPath semantic. In a node set +the namespace nodes are duplicated and the next pointer is set to the +parent node in the XPath semantic. Check if such a node need to be freed

+ +

ns : the XPath namespace node found in a nodeset. +
<< xpathxpointer >>
diff --git a/doc/html/libxml-xpointer.html b/doc/html/libxml-xpointer.html index f9c81a3d..dae37e5b 100644 --- a/doc/html/libxml-xpointer.html +++ b/doc/html/libxml-xpointer.html @@ -1,2721 +1,236 @@ -xpointer
Gnome XML Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

xpointer

Name

xpointer -- 

Synopsis


+
+xpointer
PrevUpHomeGnome XML Library Reference ManualNext
xpointer
xpointer — 
Synopsis
 
-struct      xmlLocationSet;
-typedef     xmlLocationSetPtr;
-xmlLocationSetPtr xmlXPtrLocationSetCreate  (xmlXPathObjectPtr val);
-void        xmlXPtrFreeLocationSet          (xmlLocationSetPtr obj);
-xmlLocationSetPtr xmlXPtrLocationSetMerge   (xmlLocationSetPtr val1,
-                                             xmlLocationSetPtr val2);
-xmlXPathObjectPtr xmlXPtrNewRange           (xmlNodePtr start,
+
+
+struct      xmlLocationSet;
+typedef     xmlLocationSetPtr;
+xmlLocationSetPtr xmlXPtrLocationSetCreate  (xmlXPathObjectPtr val);
+void        xmlXPtrFreeLocationSet          (xmlLocationSetPtr obj);
+xmlLocationSetPtr xmlXPtrLocationSetMerge   (xmlLocationSetPtr val1,
+                                             xmlLocationSetPtr val2);
+xmlXPathObjectPtr xmlXPtrNewRange           (xmlNodePtr start,
                                              int startindex,
-                                             xmlNodePtr end,
+                                             xmlNodePtr end,
                                              int endindex);
-xmlXPathObjectPtr xmlXPtrNewRangePoints     (xmlXPathObjectPtr start,
-                                             xmlXPathObjectPtr end);
-xmlXPathObjectPtr xmlXPtrNewRangeNodePoint  (xmlNodePtr start,
-                                             xmlXPathObjectPtr end);
-xmlXPathObjectPtr xmlXPtrNewRangePointNode  (xmlXPathObjectPtr start,
-                                             xmlNodePtr end);
-xmlXPathObjectPtr xmlXPtrNewRangeNodes      (xmlNodePtr start,
-                                             xmlNodePtr end);
-xmlXPathObjectPtr xmlXPtrNewLocationSetNodes
-                                            (xmlNodePtr start,
-                                             xmlNodePtr end);
-xmlXPathObjectPtr xmlXPtrNewLocationSetNodeSet
-                                            (xmlNodeSetPtr set);
-xmlXPathObjectPtr xmlXPtrNewRangeNodeObject (xmlNodePtr start,
-                                             xmlXPathObjectPtr end);
-xmlXPathObjectPtr xmlXPtrNewCollapsedRange  (xmlNodePtr start);
-void        xmlXPtrLocationSetAdd           (xmlLocationSetPtr cur,
-                                             xmlXPathObjectPtr val);
-xmlXPathObjectPtr xmlXPtrWrapLocationSet    (xmlLocationSetPtr val);
-void        xmlXPtrLocationSetDel           (xmlLocationSetPtr cur,
-                                             xmlXPathObjectPtr val);
-void        xmlXPtrLocationSetRemove        (xmlLocationSetPtr cur,
+xmlXPathObjectPtr xmlXPtrNewRangePoints     (xmlXPathObjectPtr start,
+                                             xmlXPathObjectPtr end);
+xmlXPathObjectPtr xmlXPtrNewRangeNodePoint  (xmlNodePtr start,
+                                             xmlXPathObjectPtr end);
+xmlXPathObjectPtr xmlXPtrNewRangePointNode  (xmlXPathObjectPtr start,
+                                             xmlNodePtr end);
+xmlXPathObjectPtr xmlXPtrNewRangeNodes      (xmlNodePtr start,
+                                             xmlNodePtr end);
+xmlXPathObjectPtr xmlXPtrNewLocationSetNodes
+                                            (xmlNodePtr start,
+                                             xmlNodePtr end);
+xmlXPathObjectPtr xmlXPtrNewLocationSetNodeSet
+                                            (xmlNodeSetPtr set);
+xmlXPathObjectPtr xmlXPtrNewRangeNodeObject (xmlNodePtr start,
+                                             xmlXPathObjectPtr end);
+xmlXPathObjectPtr xmlXPtrNewCollapsedRange  (xmlNodePtr start);
+void        xmlXPtrLocationSetAdd           (xmlLocationSetPtr cur,
+                                             xmlXPathObjectPtr val);
+xmlXPathObjectPtr xmlXPtrWrapLocationSet    (xmlLocationSetPtr val);
+void        xmlXPtrLocationSetDel           (xmlLocationSetPtr cur,
+                                             xmlXPathObjectPtr val);
+void        xmlXPtrLocationSetRemove        (xmlLocationSetPtr cur,
                                              int val);
-xmlXPathContextPtr xmlXPtrNewContext        (xmlDocPtr doc,
-                                             xmlNodePtr here,
-                                             xmlNodePtr origin);
-xmlXPathObjectPtr xmlXPtrEval               (const xmlChar *str,
-                                             xmlXPathContextPtr ctx);
-void        xmlXPtrRangeToFunction          (xmlXPathParserContextPtr ctxt,
+xmlXPathContextPtr xmlXPtrNewContext        (xmlDocPtr doc,
+                                             xmlNodePtr here,
+                                             xmlNodePtr origin);
+xmlXPathObjectPtr xmlXPtrEval               (const xmlChar *str,
+                                             xmlXPathContextPtr ctx);
+void        xmlXPtrRangeToFunction          (xmlXPathParserContextPtr ctxt,
                                              int nargs);
-xmlNodePtr  xmlXPtrBuildNodeList            (xmlXPathObjectPtr obj);
-void        xmlXPtrEvalRangePredicate       (xmlXPathParserContextPtr ctxt);

Description

Details

struct xmlLocationSet

struct xmlLocationSet {
+xmlNodePtr  xmlXPtrBuildNodeList            (xmlXPathObjectPtr obj);
+void        xmlXPtrEvalRangePredicate       (xmlXPathParserContextPtr ctxt);
+

Description

+ +

Details

struct xmlLocationSet

struct xmlLocationSet {
     int locNr;		      /* number of locations in the set */
     int locMax;		      /* size of the array as allocated */
     xmlXPathObjectPtr *locTab;/* array of locations */
-};

xmlLocationSetPtr

xmlXPtrLocationSetCreate ()

xmlLocationSetPtr xmlXPtrLocationSetCreate  (xmlXPathObjectPtr val);

Create a new xmlLocationSetPtr of type double and of value val

val : 
Returns : 

xmlXPtrFreeLocationSet ()

void        xmlXPtrFreeLocationSet          (xmlLocationSetPtr obj);

Free the LocationSet compound (not the actual ranges !).

obj : 

xmlXPtrLocationSetMerge ()

xmlLocationSetPtr xmlXPtrLocationSetMerge   (xmlLocationSetPtr val1,
-                                             xmlLocationSetPtr val2);

Merges two rangesets, all ranges from val2 are added to val1

val1 : 
val2 : 
Returns : 

xmlXPtrNewRange ()

xmlXPathObjectPtr xmlXPtrNewRange           (xmlNodePtr start,
+};
+

+ +

xmlLocationSetPtr

typedef xmlLocationSet *xmlLocationSetPtr;
+

+ +

xmlXPtrLocationSetCreate ()

xmlLocationSetPtr xmlXPtrLocationSetCreate  (xmlXPathObjectPtr val);

+Create a new xmlLocationSetPtr of type double and of value val

+ +

val : an initial xmlXPathObjectPtr, or NULL +
Returns :the newly created object. +

xmlXPtrFreeLocationSet ()

void        xmlXPtrFreeLocationSet          (xmlLocationSetPtr obj);

+Free the LocationSet compound (not the actual ranges !).

+ +

obj : the xmlLocationSetPtr to free +

xmlXPtrLocationSetMerge ()

xmlLocationSetPtr xmlXPtrLocationSetMerge   (xmlLocationSetPtr val1,
+                                             xmlLocationSetPtr val2);

+Merges two rangesets, all ranges from val2 are added to val1

+ +

val1 : the first LocationSet +
val2 : the second LocationSet +
Returns :val1 once extended or NULL in case of error. +

xmlXPtrNewRange ()

xmlXPathObjectPtr xmlXPtrNewRange           (xmlNodePtr start,
                                              int startindex,
-                                             xmlNodePtr end,
-                                             int endindex);

Create a new xmlXPathObjectPtr of type range

start : 
startindex : 
end : 
endindex : 
Returns : 

xmlXPtrNewRangePoints ()

xmlXPathObjectPtr xmlXPtrNewRangePoints     (xmlXPathObjectPtr start,
-                                             xmlXPathObjectPtr end);

Create a new xmlXPathObjectPtr of type range using 2 Points

start : 
end : 
Returns : 

xmlXPtrNewRangeNodePoint ()

xmlXPathObjectPtr xmlXPtrNewRangeNodePoint  (xmlNodePtr start,
-                                             xmlXPathObjectPtr end);

Create a new xmlXPathObjectPtr of type range from a node to a point

start : 
end : 
Returns : 

xmlXPtrNewRangePointNode ()

xmlXPathObjectPtr xmlXPtrNewRangePointNode  (xmlXPathObjectPtr start,
-                                             xmlNodePtr end);

Create a new xmlXPathObjectPtr of type range from a point to a node

start : 
end : 
Returns : 

xmlXPtrNewRangeNodes ()

xmlXPathObjectPtr xmlXPtrNewRangeNodes      (xmlNodePtr start,
-                                             xmlNodePtr end);

Create a new xmlXPathObjectPtr of type range using 2 nodes

start : 
end : 
Returns : 

xmlXPtrNewLocationSetNodes ()

xmlXPathObjectPtr xmlXPtrNewLocationSetNodes
-                                            (xmlNodePtr start,
-                                             xmlNodePtr end);

Create a new xmlXPathObjectPtr of type LocationSet and initialize -it with the single range made of the two nodes start and end

start : 
end : 
Returns : 

xmlXPtrNewLocationSetNodeSet ()

xmlXPathObjectPtr xmlXPtrNewLocationSetNodeSet
-                                            (xmlNodeSetPtr set);

Create a new xmlXPathObjectPtr of type LocationSet and initialize -it with all the nodes from set

set : 
Returns : 

xmlXPtrNewRangeNodeObject ()

xmlXPathObjectPtr xmlXPtrNewRangeNodeObject (xmlNodePtr start,
-                                             xmlXPathObjectPtr end);

Create a new xmlXPathObjectPtr of type range from a not to an object

start : 
end : 
Returns : 

xmlXPtrNewCollapsedRange ()

xmlXPathObjectPtr xmlXPtrNewCollapsedRange  (xmlNodePtr start);

Create a new xmlXPathObjectPtr of type range using a single nodes

start : 
Returns : 

xmlXPtrLocationSetAdd ()

void        xmlXPtrLocationSetAdd           (xmlLocationSetPtr cur,
-                                             xmlXPathObjectPtr val);

add a new xmlXPathObjectPtr to an existing LocationSet -If the location already exist in the set val is freed.

cur : 
val : 

xmlXPtrWrapLocationSet ()

xmlXPathObjectPtr xmlXPtrWrapLocationSet    (xmlLocationSetPtr val);

Wrap the LocationSet val in a new xmlXPathObjectPtr

val : 
Returns : 

xmlXPtrLocationSetDel ()

void        xmlXPtrLocationSetDel           (xmlLocationSetPtr cur,
-                                             xmlXPathObjectPtr val);

Removes an xmlXPathObjectPtr from an existing LocationSet

cur : 
val : 

xmlXPtrLocationSetRemove ()

void        xmlXPtrLocationSetRemove        (xmlLocationSetPtr cur,
-                                             int val);

Removes an entry from an existing LocationSet list.

cur : 
val : 

xmlXPtrNewContext ()

xmlXPathContextPtr xmlXPtrNewContext        (xmlDocPtr doc,
-                                             xmlNodePtr here,
-                                             xmlNodePtr origin);

Create a new XPointer context

doc : 
here : 
origin : 
Returns : 

xmlXPtrEval ()

xmlXPathObjectPtr xmlXPtrEval               (const xmlChar *str,
-                                             xmlXPathContextPtr ctx);

Evaluate the XPath Location Path in the given context.

str : 
ctx : 
Returns : 

xmlXPtrRangeToFunction ()

void        xmlXPtrRangeToFunction          (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

Implement the range-to() XPointer function

ctxt : 
nargs : 

xmlXPtrBuildNodeList ()

xmlNodePtr  xmlXPtrBuildNodeList            (xmlXPathObjectPtr obj);

Build a node list tree copy of the XPointer result. -This will drop Attributes and Namespace declarations.

obj : 
Returns : 

xmlXPtrEvalRangePredicate ()

void        xmlXPtrEvalRangePredicate       (xmlXPathParserContextPtr ctxt);

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

Evaluate a predicate as in xmlXPathEvalPredicate() but for -a Location Set instead of a node set

ctxt : 

\ No newline at end of file + xmlNodePtr end, + int endindex);

+Create a new xmlXPathObjectPtr of type range

+ +

start : the starting node +
startindex : the start index +
end : the ending point +
endindex : the ending index +
Returns :the newly created object. +

xmlXPtrNewRangePoints ()

xmlXPathObjectPtr xmlXPtrNewRangePoints     (xmlXPathObjectPtr start,
+                                             xmlXPathObjectPtr end);

+Create a new xmlXPathObjectPtr of type range using 2 Points

+ +

start : the starting point +
end : the ending point +
Returns :the newly created object. +

xmlXPtrNewRangeNodePoint ()

xmlXPathObjectPtr xmlXPtrNewRangeNodePoint  (xmlNodePtr start,
+                                             xmlXPathObjectPtr end);

+Create a new xmlXPathObjectPtr of type range from a node to a point

+ +

start : the starting node +
end : the ending point +
Returns :the newly created object. +

xmlXPtrNewRangePointNode ()

xmlXPathObjectPtr xmlXPtrNewRangePointNode  (xmlXPathObjectPtr start,
+                                             xmlNodePtr end);

+Create a new xmlXPathObjectPtr of type range from a point to a node

+ +

start : the starting point +
end : the ending node +
Returns :the newly created object. +

xmlXPtrNewRangeNodes ()

xmlXPathObjectPtr xmlXPtrNewRangeNodes      (xmlNodePtr start,
+                                             xmlNodePtr end);

+Create a new xmlXPathObjectPtr of type range using 2 nodes

+ +

start : the starting node +
end : the ending node +
Returns :the newly created object. +

xmlXPtrNewLocationSetNodes ()

xmlXPathObjectPtr xmlXPtrNewLocationSetNodes
+                                            (xmlNodePtr start,
+                                             xmlNodePtr end);

+Create a new xmlXPathObjectPtr of type LocationSet and initialize +it with the single range made of the two nodes start and end

+ +

start : the start NodePtr value +
end : the end NodePtr value or NULL +
Returns :the newly created object. +

xmlXPtrNewLocationSetNodeSet ()

xmlXPathObjectPtr xmlXPtrNewLocationSetNodeSet
+                                            (xmlNodeSetPtr set);

+Create a new xmlXPathObjectPtr of type LocationSet and initialize +it with all the nodes from set

+ +

set : a node set +
Returns :the newly created object. +

xmlXPtrNewRangeNodeObject ()

xmlXPathObjectPtr xmlXPtrNewRangeNodeObject (xmlNodePtr start,
+                                             xmlXPathObjectPtr end);

+Create a new xmlXPathObjectPtr of type range from a not to an object

+ +

start : the starting node +
end : the ending object +
Returns :the newly created object. +

xmlXPtrNewCollapsedRange ()

xmlXPathObjectPtr xmlXPtrNewCollapsedRange  (xmlNodePtr start);

+Create a new xmlXPathObjectPtr of type range using a single nodes

+ +

start : the starting and ending node +
Returns :the newly created object. +

xmlXPtrLocationSetAdd ()

void        xmlXPtrLocationSetAdd           (xmlLocationSetPtr cur,
+                                             xmlXPathObjectPtr val);

+add a new xmlXPathObjectPtr to an existing LocationSet +If the location already exist in the set val is freed.

+ +

cur : the initial range set +
val : a new xmlXPathObjectPtr +

xmlXPtrWrapLocationSet ()

xmlXPathObjectPtr xmlXPtrWrapLocationSet    (xmlLocationSetPtr val);

+Wrap the LocationSet val in a new xmlXPathObjectPtr

+ +

val : the LocationSet value +
Returns :the newly created object. +

xmlXPtrLocationSetDel ()

void        xmlXPtrLocationSetDel           (xmlLocationSetPtr cur,
+                                             xmlXPathObjectPtr val);

+Removes an xmlXPathObjectPtr from an existing LocationSet

+ +

cur : the initial range set +
val : an xmlXPathObjectPtr +

xmlXPtrLocationSetRemove ()

void        xmlXPtrLocationSetRemove        (xmlLocationSetPtr cur,
+                                             int val);

+Removes an entry from an existing LocationSet list.

+ +

cur : the initial range set +
val : the index to remove +

xmlXPtrNewContext ()

xmlXPathContextPtr xmlXPtrNewContext        (xmlDocPtr doc,
+                                             xmlNodePtr here,
+                                             xmlNodePtr origin);

+Create a new XPointer context

+ +

doc : the XML document +
here : the node that directly contains the XPointer being evaluated or NULL +
origin : the element from which a user or program initiated traversal of + the link, or NULL. +
Returns :the xmlXPathContext just allocated. +

xmlXPtrEval ()

xmlXPathObjectPtr xmlXPtrEval               (const xmlChar *str,
+                                             xmlXPathContextPtr ctx);

+Evaluate the XPath Location Path in the given context.

+ +

str : the XPointer expression +
ctx : the XPointer context +
Returns :the xmlXPathObjectPtr resulting from the evaluation or NULL. + the caller has to free the object. +

xmlXPtrRangeToFunction ()

void        xmlXPtrRangeToFunction          (xmlXPathParserContextPtr ctxt,
+                                             int nargs);

+Implement the range-to() XPointer function

+ +

ctxt : the XPointer Parser context +
nargs : the number of args +

xmlXPtrBuildNodeList ()

xmlNodePtr  xmlXPtrBuildNodeList            (xmlXPathObjectPtr obj);

+Build a node list tree copy of the XPointer result. +This will drop Attributes and Namespace declarations.

+ +

obj : the XPointer result from the evaluation. +
Returns :an xmlNodePtr list or NULL. + the caller has to free the node tree. +

xmlXPtrEvalRangePredicate ()

void        xmlXPtrEvalRangePredicate       (xmlXPathParserContextPtr ctxt);

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

+Evaluate a predicate as in xmlXPathEvalPredicate() but for +a Location Set instead of a node set

+ +

ctxt : the XPointer Parser context +
<< xpathInternalsxinclude >>
diff --git a/doc/html/right.png b/doc/html/right.png new file mode 100644 index 0000000000000000000000000000000000000000..92832e3a4566e59d6e4092010e08d28f3be3a68d GIT binary patch literal 472 zcmV;}0Vn>6P)Cd4HCN^TYHBC0dz3r5|}*T3c5!K}0^NPTey!^rYo;W&eW{b1SE%dR-1ljcju- zJITo5P_e{cPDWDszO|97o#m$fni3V4d%~7^?0HU4-k!+X`e~w55Q}HA=c?CM9`EK` z^o5GF_RsnG`ey+9wOf8O4bzg>7W*;jU~M?g`OZAA$mNp|Lz<$s+~N9!2`ir8RcClo$(Q~19INM~9}j;&*|enC yGd}kJak0wj?aUKd8;%}`i}SSew>!A-2iw}^5}Rh(M>+vRkipZ{&t;ucLK6U4uc96R literal 0 HcmV?d00001 diff --git a/doc/libxml2-api.xml b/doc/libxml2-api.xml index f3e6d7dc..85814cc7 100644 --- a/doc/libxml2-api.xml +++ b/doc/libxml2-api.xml @@ -501,6 +501,19 @@ + + + + + + + + + + + + + @@ -1109,6 +1122,92 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1175,6 +1274,55 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2177,6 +2325,54 @@ Identifiers can be longer, but this will be more costly at runtime. + + + + + + + + the element is abstract + + + the element has a default value + + + the element has a fixed value + + + the element is global + + + the element is nillable + + + the element is a reference to a type + + + the element is top level + + + collapse the types of the facet + + + preserve the type of the facet + + + replace the type of the facet + + + unknown facet handling + + + the shemas requires qualified attributes + + + the shemas requires qualified elements + + + the element content type is mixed + Bit in the loadsubset context field to tell to not do ID/REFs registration. Used to initialize xmlLoadExtDtdDefaultValue in some special cases. @@ -2571,6 +2767,72 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -3114,6 +3376,131 @@ actually an xmlCharEncoding'/> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -7958,6 +8345,163 @@ actually an xmlCharEncoding'/> + + Checks the default values types, especially for facets + + + + + + + + Cleanup the default XML Schemas type library + + + + Compare 2 values + + + + + + Dump a Schema structure. + + + + + + Deallocate a Schema structure. + + + + + Deallocate a Schema Facet structure. + + + + + Free the resources associated to the schema parser context + + + + + Deallocate a Schema Type structure. + + + + + Free the resources associated to the schema validation context + + + + + Cleanup the default XML Schemas type library + + + + + Lookup a type in the default XML Schemas type library + + + + + + Initialize the default XML Schemas type library + + + + Allocate a new Facet structure. + + + + Create an XML Schemas parse context for that memory buffer expected to contain an XML Schemas file. + + + + + + Create an XML Schemas parse context for that file/resource expected to contain an XML Schemas file. + + + + + Create an XML Schemas validation context based on the given schema + + + + + 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 + + + + + Set the callback functions used to handle errors for a validation context + + + + + + + + Set the error and warning callback informations + + + + + + + + Check that a value conforms to the lexical space of the predefined type. if true a value is computed and returned in @val. + + + + + + + + Validate a document tree in memory. + + + + + + Check a value against a facet condition + + + + + + + + Check that a value conforms to the lexical space of the predefined type. if true a value is computed and returned in @val. + + + + + + + Validate a document tree in memory. + + + + + + + + + + + + + + + + + + + + + Search a Ns registered under a given name space for a document. recurse on the parents until it finds the defined namespace or return NULL otherwise. @nameSpace can be NULL, this is a search for the default namespace. We don't allow to cross entities boundaries. If you don't declare the namespace within those you will be in troubles !!! A warning is generated to cover this case. diff --git a/xmlschemas.c b/xmlschemas.c index 55cdef54..bb639709 100644 --- a/xmlschemas.c +++ b/xmlschemas.c @@ -166,7 +166,6 @@ xmlSchemaNewSchema(xmlSchemaParserCtxtPtr ctxt) /** * xmlSchemaNewFacet: - * @ctxt: a schema validation context (optional) * * Allocate a new Facet structure. *