diff options
| author | Nick Wellnhofer <wellnhofer@aevum.de> | 2023-04-26 21:21:31 +0200 |
|---|---|---|
| committer | Nick Wellnhofer <wellnhofer@aevum.de> | 2023-04-26 21:22:17 +0200 |
| commit | 6e12409b33c01da2c4823628c6ec2c50482fe3d9 (patch) | |
| tree | d9a3be3cdb4652882c85d775b7ef49f6238a2a6f | |
| parent | 2df2562e2baa5ef31605175a2dfe0360e597a3dd (diff) | |
| download | libxml2-6e12409b33c01da2c4823628c6ec2c50482fe3d9.tar.gz | |
Regenerate docs and testapi.c
26 files changed, 557 insertions, 637 deletions
diff --git a/doc/devhelp/libxml2-HTMLparser.html b/doc/devhelp/libxml2-HTMLparser.html index 778753c6..a25e40bb 100644 --- a/doc/devhelp/libxml2-HTMLparser.html +++ b/doc/devhelp/libxml2-HTMLparser.html @@ -63,7 +63,7 @@ void <a href="#htmlInitAutoClose">htmlInitAutoClose</a> (void); int <a href="#htmlIsAutoClosed">htmlIsAutoClosed</a> (<a href="libxml2-HTMLparser.html#htmlDocPtr">htmlDocPtr</a> doc, <br> <a href="libxml2-HTMLparser.html#htmlNodePtr">htmlNodePtr</a> elem); int <a href="#htmlIsScriptAttribute">htmlIsScriptAttribute</a> (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name); <a href="libxml2-HTMLparser.html#htmlParserCtxtPtr">htmlParserCtxtPtr</a> <a href="#htmlNewParserCtxt">htmlNewParserCtxt</a> (void); -<a href="libxml2-HTMLparser.html#htmlParserCtxtPtr">htmlParserCtxtPtr</a> <a href="#htmlNewSAXParserCtxt">htmlNewSAXParserCtxt</a> (<a href="libxml2-HTMLparser.html#htmlSAXHandlerPtr">htmlSAXHandlerPtr</a> sax, <br> void * userData); +<a href="libxml2-HTMLparser.html#htmlParserCtxtPtr">htmlParserCtxtPtr</a> <a href="#htmlNewSAXParserCtxt">htmlNewSAXParserCtxt</a> (const <a href="libxml2-HTMLparser.html#htmlSAXHandler">htmlSAXHandler</a> * sax, <br> void * userData); <a href="libxml2-HTMLparser.html#htmlStatus">htmlStatus</a> <a href="#htmlNodeStatus">htmlNodeStatus</a> (const <a href="libxml2-HTMLparser.html#htmlNodePtr">htmlNodePtr</a> node, <br> int legacy); int <a href="#htmlParseCharRef">htmlParseCharRef</a> (<a href="libxml2-HTMLparser.html#htmlParserCtxtPtr">htmlParserCtxtPtr</a> ctxt); int <a href="#htmlParseChunk">htmlParseChunk</a> (<a href="libxml2-HTMLparser.html#htmlParserCtxtPtr">htmlParserCtxtPtr</a> ctxt, <br> const char * chunk, <br> int size, <br> int terminate); @@ -881,7 +881,7 @@ const <a href="libxml2-HTMLparser.html#htmlElemDesc">htmlElemDesc</a> * <a href= <a name="htmlInitAutoClose"></a>htmlInitAutoClose ()</h3> <pre class="programlisting">void htmlInitAutoClose (void)<br> </pre> -<p>DEPRECATED: This function will be made private. Call <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a> to initialize the library. This is a no-op now.</p> +<p>DEPRECATED: This is a no-op.</p> </div> <hr> <div class="refsect2" lang="en"> @@ -948,9 +948,9 @@ const <a href="libxml2-HTMLparser.html#htmlElemDesc">htmlElemDesc</a> * <a href= <div class="refsect2" lang="en"> <h3> <a name="htmlNewSAXParserCtxt"></a>htmlNewSAXParserCtxt ()</h3> -<pre class="programlisting"><a href="libxml2-HTMLparser.html#htmlParserCtxtPtr">htmlParserCtxtPtr</a> htmlNewSAXParserCtxt (<a href="libxml2-HTMLparser.html#htmlSAXHandlerPtr">htmlSAXHandlerPtr</a> sax, <br> void * userData)<br> +<pre class="programlisting"><a href="libxml2-HTMLparser.html#htmlParserCtxtPtr">htmlParserCtxtPtr</a> htmlNewSAXParserCtxt (const <a href="libxml2-HTMLparser.html#htmlSAXHandler">htmlSAXHandler</a> * sax, <br> void * userData)<br> </pre> -<p>Allocate and initialize a new parser context.</p> +<p>Allocate and initialize a new SAX parser context. If userData is NULL, the parser context will be passed as user data.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1000,7 +1000,7 @@ const <a href="libxml2-HTMLparser.html#htmlElemDesc">htmlElemDesc</a> * <a href= <a name="htmlParseCharRef"></a>htmlParseCharRef ()</h3> <pre class="programlisting">int htmlParseCharRef (<a href="libxml2-HTMLparser.html#htmlParserCtxtPtr">htmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse Reference declarations [66] CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';'</p> +<p>DEPRECATED: Internal function, don't use. parse Reference declarations [66] CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';'</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1101,7 +1101,7 @@ const <a href="libxml2-HTMLparser.html#htmlElemDesc">htmlElemDesc</a> * <a href= <a name="htmlParseElement"></a>htmlParseElement ()</h3> <pre class="programlisting">void htmlParseElement (<a href="libxml2-HTMLparser.html#htmlParserCtxtPtr">htmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse an HTML element, this is highly recursive this is kept for compatibility with previous code versions [39] element ::= EmptyElemTag | STag content ETag [41] Attribute ::= Name Eq AttValue</p> +<p>DEPRECATED: Internal function, don't use. parse an HTML element, this is highly recursive this is kept for compatibility with previous code versions [39] element ::= EmptyElemTag | STag content ETag [41] Attribute ::= Name Eq AttValue</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -1116,7 +1116,7 @@ const <a href="libxml2-HTMLparser.html#htmlElemDesc">htmlElemDesc</a> * <a href= <a name="htmlParseEntityRef"></a>htmlParseEntityRef ()</h3> <pre class="programlisting">const <a href="libxml2-HTMLparser.html#htmlEntityDesc">htmlEntityDesc</a> * htmlParseEntityRef (<a href="libxml2-HTMLparser.html#htmlParserCtxtPtr">htmlParserCtxtPtr</a> ctxt, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> ** str)<br> </pre> -<p>parse an HTML ENTITY references [68] EntityRef ::= '&' Name ';'</p> +<p>DEPRECATED: Internal function, don't use. parse an HTML ENTITY references [68] EntityRef ::= '&' Name ';'</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1339,7 +1339,7 @@ const <a href="libxml2-HTMLparser.html#htmlElemDesc">htmlElemDesc</a> * <a href= <a name="htmlSAXParseDoc"></a>htmlSAXParseDoc ()</h3> <pre class="programlisting"><a href="libxml2-HTMLparser.html#htmlDocPtr">htmlDocPtr</a> htmlSAXParseDoc (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * cur, <br> const char * encoding, <br> <a href="libxml2-HTMLparser.html#htmlSAXHandlerPtr">htmlSAXHandlerPtr</a> sax, <br> void * userData)<br> </pre> -<p>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.</p> +<p>DEPRECATED: Use <a href="libxml2-HTMLparser.html#htmlNewSAXParserCtxt">htmlNewSAXParserCtxt</a> and <a href="libxml2-HTMLparser.html#htmlCtxtReadDoc">htmlCtxtReadDoc</a>. 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.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1373,7 +1373,7 @@ const <a href="libxml2-HTMLparser.html#htmlElemDesc">htmlElemDesc</a> * <a href= <a name="htmlSAXParseFile"></a>htmlSAXParseFile ()</h3> <pre class="programlisting"><a href="libxml2-HTMLparser.html#htmlDocPtr">htmlDocPtr</a> htmlSAXParseFile (const char * filename, <br> const char * encoding, <br> <a href="libxml2-HTMLparser.html#htmlSAXHandlerPtr">htmlSAXHandlerPtr</a> sax, <br> void * userData)<br> </pre> -<p>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.</p> +<p>DEPRECATED: Use <a href="libxml2-HTMLparser.html#htmlNewSAXParserCtxt">htmlNewSAXParserCtxt</a> and <a href="libxml2-HTMLparser.html#htmlCtxtReadFile">htmlCtxtReadFile</a>. 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.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> diff --git a/doc/devhelp/libxml2-SAX2.html b/doc/devhelp/libxml2-SAX2.html index 4a463b17..b0bb2c79 100644 --- a/doc/devhelp/libxml2-SAX2.html +++ b/doc/devhelp/libxml2-SAX2.html @@ -69,7 +69,7 @@ int <a href="#xmlSAXVersion">xmlSAXVersion</a> (<a href="libxml2-tree.html#xml <a name="htmlDefaultSAXHandlerInit"></a>htmlDefaultSAXHandlerInit ()</h3> <pre class="programlisting">void htmlDefaultSAXHandlerInit (void)<br> </pre> -<p>DEPRECATED: This function will be made private. Call <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a> to initialize the library. Initialize the default SAX handler</p> +<p>DEPRECATED: This function is a no-op. Call <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a> to initialize the library.</p> </div> <hr> <div class="refsect2" lang="en"> @@ -77,7 +77,7 @@ int <a href="#xmlSAXVersion">xmlSAXVersion</a> (<a href="libxml2-tree.html#xml <a name="xmlDefaultSAXHandlerInit"></a>xmlDefaultSAXHandlerInit ()</h3> <pre class="programlisting">void xmlDefaultSAXHandlerInit (void)<br> </pre> -<p>DEPRECATED: This function will be made private. Call <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a> to initialize the library. Initialize the default SAX2 handler</p> +<p>DEPRECATED: This function is a no-op. Call <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a> to initialize the library. Initialize the default SAX2 handler</p> </div> <hr> <div class="refsect2" lang="en"> diff --git a/doc/devhelp/libxml2-dict.html b/doc/devhelp/libxml2-dict.html index 5a2c8835..08e914d1 100644 --- a/doc/devhelp/libxml2-dict.html +++ b/doc/devhelp/libxml2-dict.html @@ -66,7 +66,7 @@ The content of this structure is not made public by the API. <a name="xmlDictCleanup"></a>xmlDictCleanup ()</h3> <pre class="programlisting">void xmlDictCleanup (void)<br> </pre> -<p>DEPRECATED: This function will be made private. Call <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> to free global state but see the warnings there. <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> should be only called once at program exit. In most cases, you don't have call cleanup functions at all. Free the dictionary mutex. Do not call unless sure the library is not in use anymore !</p> +<p>DEPRECATED: This function is a no-op. Call <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> to free global state but see the warnings there. <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> should be only called once at program exit. In most cases, you don't have call cleanup functions at all.</p> </div> <hr> <div class="refsect2" lang="en"> @@ -325,12 +325,12 @@ The content of this structure is not made public by the API. <a name="xmlInitializeDict"></a>xmlInitializeDict ()</h3> <pre class="programlisting">int xmlInitializeDict (void)<br> </pre> -<p>DEPRECATED: This function will be made private. Call <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a> to initialize the library. Do the dictionary mutex initialization.</p> +<p>DEPRECATED: Alias for <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a>.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> <td><span class="term"><i><tt>Returns</tt></i>:</span></td> -<td>0 if initialization was already done, and 1 if that call led to the initialization</td> +<td></td> </tr></tbody> </table></div> </div> diff --git a/doc/devhelp/libxml2-encoding.html b/doc/devhelp/libxml2-encoding.html index cc9e2fb6..2eb52b3d 100644 --- a/doc/devhelp/libxml2-encoding.html +++ b/doc/devhelp/libxml2-encoding.html @@ -292,7 +292,7 @@ void <a href="#xmlRegisterCharEncodingHandler">xmlRegisterCharEncodingHandler</a <a name="xmlCharEncFirstLine"></a>xmlCharEncFirstLine ()</h3> <pre class="programlisting">int xmlCharEncFirstLine (<a href="libxml2-encoding.html#xmlCharEncodingHandler">xmlCharEncodingHandler</a> * handler, <br> <a href="libxml2-tree.html#xmlBufferPtr">xmlBufferPtr</a> out, <br> <a href="libxml2-tree.html#xmlBufferPtr">xmlBufferPtr</a> in)<br> </pre> -<p>Front-end for the encoding handler input function, but handle only the very first line, i.e. limit itself to 45 chars.</p> +<p>DEPERECATED: Don't use.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -310,7 +310,7 @@ void <a href="#xmlRegisterCharEncodingHandler">xmlRegisterCharEncodingHandler</a </tr> <tr> <td><span class="term"><i><tt>Returns</tt></i>:</span></td> -<td>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</td> +<td></td> </tr> </tbody> </table></div> @@ -441,7 +441,7 @@ void <a href="#xmlRegisterCharEncodingHandler">xmlRegisterCharEncodingHandler</a <a name="xmlFindCharEncodingHandler"></a>xmlFindCharEncodingHandler ()</h3> <pre class="programlisting"><a href="libxml2-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> xmlFindCharEncodingHandler (const char * name)<br> </pre> -<p>Search in the registered set the handler able to read/write that encoding.</p> +<p>Search in the registered set the handler able to read/write that encoding or create a new one.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -525,7 +525,7 @@ void <a href="#xmlRegisterCharEncodingHandler">xmlRegisterCharEncodingHandler</a <a name="xmlInitCharEncodingHandlers"></a>xmlInitCharEncodingHandlers ()</h3> <pre class="programlisting">void xmlInitCharEncodingHandlers (void)<br> </pre> -<p>DEPRECATED: This function will be made private. Call <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a> to initialize the library. 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.</p> +<p>DEPRECATED: Alias for <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a>.</p> </div> <hr> <div class="refsect2" lang="en"> diff --git a/doc/devhelp/libxml2-globals.html b/doc/devhelp/libxml2-globals.html index ea7696de..0c1eb574 100644 --- a/doc/devhelp/libxml2-globals.html +++ b/doc/devhelp/libxml2-globals.html @@ -455,7 +455,7 @@ const char * <a href="#xmlThrDefTreeIndentString">xmlThrDefTreeIndentString</a> <a name="xmlCleanupGlobals"></a>xmlCleanupGlobals ()</h3> <pre class="programlisting">void xmlCleanupGlobals (void)<br> </pre> -<p>DEPRECATED: This function will be made private. Call <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> to free global state but see the warnings there. <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> should be only called once at program exit. In most cases, you don't have call cleanup functions at all. Additional cleanup for multi-threading</p> +<p>DEPRECATED: This function is a no-op. Call <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> to free global state but see the warnings there. <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> should be only called once at program exit. In most cases, you don't have call cleanup functions at all.</p> </div> <hr> <div class="refsect2" lang="en"> @@ -484,7 +484,7 @@ const char * <a href="#xmlThrDefTreeIndentString">xmlThrDefTreeIndentString</a> <a name="xmlInitGlobals"></a>xmlInitGlobals ()</h3> <pre class="programlisting">void xmlInitGlobals (void)<br> </pre> -<p>DEPRECATED: This function will be made private. Call <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a> to initialize the library. Additional initialisation for multi-threading</p> +<p>DEPRECATED: Alias for <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a>.</p> </div> <hr> <div class="refsect2" lang="en"> diff --git a/doc/devhelp/libxml2-parser.html b/doc/devhelp/libxml2-parser.html index bc37b594..07410f11 100644 --- a/doc/devhelp/libxml2-parser.html +++ b/doc/devhelp/libxml2-parser.html @@ -98,7 +98,7 @@ int <a href="#xmlLineNumbersDefault">xmlLineNumbersDefault</a> (int val); <a href="libxml2-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> <a href="#xmlLoadExternalEntity">xmlLoadExternalEntity</a> (const char * URL, <br> const char * ID, <br> <a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt); <a href="libxml2-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> <a href="#xmlNewIOInputStream">xmlNewIOInputStream</a> (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> <a href="libxml2-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> input, <br> <a href="libxml2-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc); <a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> <a href="#xmlNewParserCtxt">xmlNewParserCtxt</a> (void); -<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> <a href="#xmlNewSAXParserCtxt">xmlNewSAXParserCtxt</a> (<a href="libxml2-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax, <br> void * userData); +<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> <a href="#xmlNewSAXParserCtxt">xmlNewSAXParserCtxt</a> (const <a href="libxml2-tree.html#xmlSAXHandler">xmlSAXHandler</a> * sax, <br> void * userData); int <a href="#xmlParseBalancedChunkMemory">xmlParseBalancedChunkMemory</a> (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br> <a href="libxml2-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax, <br> void * user_data, <br> int depth, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * string, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> * lst); int <a href="#xmlParseBalancedChunkMemoryRecover">xmlParseBalancedChunkMemoryRecover</a> (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br> <a href="libxml2-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax, <br> void * user_data, <br> int depth, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * string, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> * lst, <br> int recover); int <a href="#xmlParseChunk">xmlParseChunk</a> (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> const char * chunk, <br> int size, <br> int terminate); @@ -1964,9 +1964,9 @@ The content of this structure is not made public by the API. <div class="refsect2" lang="en"> <h3> <a name="xmlNewSAXParserCtxt"></a>xmlNewSAXParserCtxt ()</h3> -<pre class="programlisting"><a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> xmlNewSAXParserCtxt (<a href="libxml2-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax, <br> void * userData)<br> +<pre class="programlisting"><a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> xmlNewSAXParserCtxt (const <a href="libxml2-tree.html#xmlSAXHandler">xmlSAXHandler</a> * sax, <br> void * userData)<br> </pre> -<p>Allocate and initialize a new SAX parser context.</p> +<p>Allocate and initialize a new SAX parser context. If userData is NULL, the parser context will be passed as user data.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1980,7 +1980,7 @@ The content of this structure is not made public by the API. </tr> <tr> <td><span class="term"><i><tt>Returns</tt></i>:</span></td> -<td>the <a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> or NULL</td> +<td>the <a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> or NULL if memory allocation failed.</td> </tr> </tbody> </table></div> diff --git a/doc/devhelp/libxml2-parserInternals.html b/doc/devhelp/libxml2-parserInternals.html index b119aa46..2a0d6d5b 100644 --- a/doc/devhelp/libxml2-parserInternals.html +++ b/doc/devhelp/libxml2-parserInternals.html @@ -42,10 +42,8 @@ #define <a href="#IS_LETTER_CH">IS_LETTER_CH</a>(c); #define <a href="#IS_PUBIDCHAR">IS_PUBIDCHAR</a>(c); #define <a href="#IS_PUBIDCHAR_CH">IS_PUBIDCHAR_CH</a>(c); -#define <a href="#MOVETO_ENDTAG">MOVETO_ENDTAG</a>(p); -#define <a href="#MOVETO_STARTTAG">MOVETO_STARTTAG</a>(p); -#define <a href="#SKIP_EOL">SKIP_EOL</a>(p); #define <a href="#XML_MAX_DICTIONARY_LIMIT">XML_MAX_DICTIONARY_LIMIT</a>; +#define <a href="#XML_MAX_HUGE_LENGTH">XML_MAX_HUGE_LENGTH</a>; #define <a href="#XML_MAX_LOOKUP_LIMIT">XML_MAX_LOOKUP_LIMIT</a>; #define <a href="#XML_MAX_NAMELEN">XML_MAX_NAMELEN</a>; #define <a href="#XML_MAX_NAME_LENGTH">XML_MAX_NAME_LENGTH</a>; @@ -70,7 +68,6 @@ int <a href="#xmlCopyCharMultiByte">xmlCopyCharMultiByte</a> (<a href="libxml2- int <a href="#xmlCurrentChar">xmlCurrentChar</a> (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> int * len); <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * <a href="#xmlDecodeEntities">xmlDecodeEntities</a> (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> int len, <br> int what, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> end, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> end2, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> end3); typedef void <a href="#xmlEntityReferenceFunc">xmlEntityReferenceFunc</a> (<a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> ent, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> firstNode, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> lastNode); -void <a href="#xmlErrMemory">xmlErrMemory</a> (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> const char * extra); void <a href="#xmlFreeInputStream">xmlFreeInputStream</a> (<a href="libxml2-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> input); void <a href="#xmlHandleEntity">xmlHandleEntity</a> (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> <a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> entity); int <a href="#xmlIsLetter">xmlIsLetter</a> (int c); @@ -444,55 +441,18 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <hr> <div class="refsect2" lang="en"> <h3> -<a name="MOVETO_ENDTAG">Macro </a>MOVETO_ENDTAG</h3> -<pre class="programlisting">#define <a href="#MOVETO_ENDTAG">MOVETO_ENDTAG</a>(p); -</pre> -<p>Skips to the next '>' char.</p> -<div class="variablelist"><table border="0"> -<col align="left"> -<tbody><tr> -<td><span class="term"><i><tt>p</tt></i>:</span></td> -<td>and UTF8 string pointer</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" lang="en"> -<h3> -<a name="MOVETO_STARTTAG">Macro </a>MOVETO_STARTTAG</h3> -<pre class="programlisting">#define <a href="#MOVETO_STARTTAG">MOVETO_STARTTAG</a>(p); -</pre> -<p>Skips to the next '<' char.</p> -<div class="variablelist"><table border="0"> -<col align="left"> -<tbody><tr> -<td><span class="term"><i><tt>p</tt></i>:</span></td> -<td>and UTF8 string pointer</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" lang="en"> -<h3> -<a name="SKIP_EOL">Macro </a>SKIP_EOL</h3> -<pre class="programlisting">#define <a href="#SKIP_EOL">SKIP_EOL</a>(p); +<a name="XML_MAX_DICTIONARY_LIMIT">Macro </a>XML_MAX_DICTIONARY_LIMIT</h3> +<pre class="programlisting">#define <a href="#XML_MAX_DICTIONARY_LIMIT">XML_MAX_DICTIONARY_LIMIT</a>; </pre> -<p>Skips the end of line chars.</p> -<div class="variablelist"><table border="0"> -<col align="left"> -<tbody><tr> -<td><span class="term"><i><tt>p</tt></i>:</span></td> -<td>and UTF8 string pointer</td> -</tr></tbody> -</table></div> +<p>Maximum size allowed by the parser for a dictionary by default This is not a limitation of the parser but a safety boundary feature, use <a href="libxml2-parser.html#XML_PARSE_HUGE">XML_PARSE_HUGE</a> option to override it. Introduced in 2.9.0</p> </div> <hr> <div class="refsect2" lang="en"> <h3> -<a name="XML_MAX_DICTIONARY_LIMIT">Macro </a>XML_MAX_DICTIONARY_LIMIT</h3> -<pre class="programlisting">#define <a href="#XML_MAX_DICTIONARY_LIMIT">XML_MAX_DICTIONARY_LIMIT</a>; +<a name="XML_MAX_HUGE_LENGTH">Macro </a>XML_MAX_HUGE_LENGTH</h3> +<pre class="programlisting">#define <a href="#XML_MAX_HUGE_LENGTH">XML_MAX_HUGE_LENGTH</a>; </pre> -<p>Maximum size allowed by the parser for a dictionary by default This is not a limitation of the parser but a safety boundary feature, use <a href="libxml2-parser.html#XML_PARSE_HUGE">XML_PARSE_HUGE</a> option to override it. Introduced in 2.9.0</p> +<p>Maximum size allowed when <a href="libxml2-parser.html#XML_PARSE_HUGE">XML_PARSE_HUGE</a> is set.</p> </div> <hr> <div class="refsect2" lang="en"> @@ -667,7 +627,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="namePop"></a>namePop ()</h3> <pre class="programlisting">const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * namePop (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>Pops the top element name from the name stack</p> +<p>DEPRECATED: Internal function, do not use. Pops the top element name from the name stack</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -688,7 +648,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="namePush"></a>namePush ()</h3> <pre class="programlisting">int namePush (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * value)<br> </pre> -<p>Pushes a new element name on top of the name stack</p> +<p>DEPRECATED: Internal function, do not use. Pushes a new element name on top of the name stack</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -713,7 +673,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="nodePop"></a>nodePop ()</h3> <pre class="programlisting"><a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> nodePop (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>Pops the top element node from the node stack</p> +<p>DEPRECATED: Internal function, do not use. Pops the top element node from the node stack</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -734,7 +694,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="nodePush"></a>nodePush ()</h3> <pre class="programlisting">int nodePush (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> value)<br> </pre> -<p>Pushes a new element node on top of the node stack</p> +<p>DEPRECATED: Internal function, do not use. Pushes a new element node on top of the node stack</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -759,7 +719,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlCheckLanguageID"></a>xmlCheckLanguageID ()</h3> <pre class="programlisting">int xmlCheckLanguageID (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * lang)<br> </pre> -<p>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])+ The current REC <a href="libxml2-SAX.html#reference">reference</a> the successors of RFC 1766, currently 5646 http://www.rfc-editor.org/rfc/rfc5646.txt langtag = language ["-" script] ["-" region] *("-" variant) *("-" extension) ["-" privateuse] language = 2*3ALPHA ; shortest ISO 639 code ["-" extlang] ; sometimes followed by ; extended language subtags / 4ALPHA ; or reserved for future use / 5*8ALPHA ; or registered language subtag extlang = 3ALPHA ; selected ISO 639 codes *2("-" 3ALPHA) ; permanently reserved script = 4ALPHA ; ISO 15924 code region = 2ALPHA ; ISO 3166-1 code / 3DIGIT ; UN M.49 code variant = 5*8alphanum ; registered variants / (DIGIT 3alphanum) extension = singleton 1*("-" (2*8alphanum)) ; Single alphanumerics ; "x" reserved for private use singleton = DIGIT ; 0 - 9 / %x41-57 ; A - W / %x59-5A ; Y - Z / %x61-77 ; a - w / %x79-7A ; y - z it sounds right to still allow Irregular i-xxx IANA and user codes too The parser below doesn't try to cope with extension or privateuse that could be added but that's not interoperable anyway</p> +<p>DEPRECATED: Internal function, do not use. 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])+ The current REC <a href="libxml2-SAX.html#reference">reference</a> the successors of RFC 1766, currently 5646 http://www.rfc-editor.org/rfc/rfc5646.txt langtag = language ["-" script] ["-" region] *("-" variant) *("-" extension) ["-" privateuse] language = 2*3ALPHA ; shortest ISO 639 code ["-" extlang] ; sometimes followed by ; extended language subtags / 4ALPHA ; or reserved for future use / 5*8ALPHA ; or registered language subtag extlang = 3ALPHA ; selected ISO 639 codes *2("-" 3ALPHA) ; permanently reserved script = 4ALPHA ; ISO 15924 code region = 2ALPHA ; ISO 3166-1 code / 3DIGIT ; UN M.49 code variant = 5*8alphanum ; registered variants / (DIGIT 3alphanum) extension = singleton 1*("-" (2*8alphanum)) ; Single alphanumerics ; "x" reserved for private use singleton = DIGIT ; 0 - 9 / %x41-57 ; A - W / %x59-5A ; Y - Z / %x61-77 ; a - w / %x79-7A ; y - z it sounds right to still allow Irregular i-xxx IANA and user codes too The parser below doesn't try to cope with extension or privateuse that could be added but that's not interoperable anyway</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -937,7 +897,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlCurrentChar"></a>xmlCurrentChar ()</h3> <pre class="programlisting">int xmlCurrentChar (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> int * len)<br> </pre> -<p>The current char value, if using UTF-8 this may actually span multiple bytes in the input buffer. Implement the end of line normalization: 2.11 End-of-Line Handling Wherever an external parsed entity or the literal entity value of an internal parsed entity contains either the literal two-character sequence "#xD#xA" or a standalone literal #xD, an XML processor must pass to the application the single character #xA. This behavior can conveniently be produced by normalizing all line breaks to #xA on input, before parsing.)</p> +<p>DEPRECATED: Internal function, do not use. The current char value, if using UTF-8 this may actually span multiple bytes in the input buffer. Implement the end of line normalization: 2.11 End-of-Line Handling Wherever an external parsed entity or the literal entity value of an internal parsed entity contains either the literal two-character sequence "#xD#xA" or a standalone literal #xD, an XML processor must pass to the application the single character #xA. This behavior can conveniently be produced by normalizing all line breaks to #xA on input, before parsing.)</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1001,27 +961,6 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <hr> <div class="refsect2" lang="en"> <h3> -<a name="xmlErrMemory"></a>xmlErrMemory ()</h3> -<pre class="programlisting">void xmlErrMemory (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> const char * extra)<br> -</pre> -<p>Handle a redefinition of <a href="libxml2-SAX.html#attribute">attribute</a> error</p> -<div class="variablelist"><table border="0"> -<col align="left"> -<tbody> -<tr> -<td><span class="term"><i><tt>ctxt</tt></i>:</span></td> -<td>an XML parser context</td> -</tr> -<tr> -<td><span class="term"><i><tt>extra</tt></i>:</span></td> -<td>extra information</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" lang="en"> -<h3> <a name="xmlFreeInputStream"></a>xmlFreeInputStream ()</h3> <pre class="programlisting">void xmlFreeInputStream (<a href="libxml2-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> input)<br> </pre> @@ -1150,7 +1089,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlNewEntityInputStream"></a>xmlNewEntityInputStream ()</h3> <pre class="programlisting"><a href="libxml2-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> xmlNewEntityInputStream (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> <a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> entity)<br> </pre> -<p>Create a new input stream based on an <a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a></p> +<p>DEPRECATED: Internal function, do not use. Create a new input stream based on an <a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a></p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1246,7 +1185,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlNextChar"></a>xmlNextChar ()</h3> <pre class="programlisting">void xmlNextChar (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>Skip to the next char input char.</p> +<p>DEPRECATED: Internal function, do not use. Skip to the next char input char.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -1261,7 +1200,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseAttValue"></a>xmlParseAttValue ()</h3> <pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlParseAttValue (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse a value for an <a href="libxml2-SAX.html#attribute">attribute</a> Note: the parser won't do substitution of entities here, this will be handled later in <a href="libxml2-tree.html#xmlStringGetNodeList">xmlStringGetNodeList</a> [10] AttValue ::= '"' ([^<&"] | Reference)* '"' | "'" ([^<&'] | Reference)* "'" 3.3.3 Attribute-Value Normalization: Before the value of an <a href="libxml2-SAX.html#attribute">attribute</a> is passed to the application or checked for validity, the XML processor must normalize it as follows: - a character <a href="libxml2-SAX.html#reference">reference</a> is processed by appending the referenced character to the <a href="libxml2-SAX.html#attribute">attribute</a> value - an entity <a href="libxml2-SAX.html#reference">reference</a> is processed by recursively processing the replacement text of the entity - a whitespace character (#x20, #xD, #xA, #x9) is processed by appending #x20 to the normalized value, except that only a single #x20 is appended for a "#xD#xA" sequence that is part of an external parsed entity or the literal entity value of an internal parsed entity - other <a href="libxml2-SAX.html#characters">characters</a> 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 <a href="libxml2-SAX.html#attribute">attribute</a> value by discarding any leading and trailing space (#x20) characters, and by replacing sequences of space (#x20) <a href="libxml2-SAX.html#characters">characters</a> 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.</p> +<p>DEPRECATED: Internal function, don't use. parse a value for an <a href="libxml2-SAX.html#attribute">attribute</a> Note: the parser won't do substitution of entities here, this will be handled later in <a href="libxml2-tree.html#xmlStringGetNodeList">xmlStringGetNodeList</a> [10] AttValue ::= '"' ([^<&"] | Reference)* '"' | "'" ([^<&'] | Reference)* "'" 3.3.3 Attribute-Value Normalization: Before the value of an <a href="libxml2-SAX.html#attribute">attribute</a> is passed to the application or checked for validity, the XML processor must normalize it as follows: - a character <a href="libxml2-SAX.html#reference">reference</a> is processed by appending the referenced character to the <a href="libxml2-SAX.html#attribute">attribute</a> value - an entity <a href="libxml2-SAX.html#reference">reference</a> is processed by recursively processing the replacement text of the entity - a whitespace character (#x20, #xD, #xA, #x9) is processed by appending #x20 to the normalized value, except that only a single #x20 is appended for a "#xD#xA" sequence that is part of an external parsed entity or the literal entity value of an internal parsed entity - other <a href="libxml2-SAX.html#characters">characters</a> 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 <a href="libxml2-SAX.html#attribute">attribute</a> value by discarding any leading and trailing space (#x20) characters, and by replacing sequences of space (#x20) <a href="libxml2-SAX.html#characters">characters</a> 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.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1282,7 +1221,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseAttribute"></a>xmlParseAttribute ()</h3> <pre class="programlisting">const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlParseAttribute (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> ** value)<br> </pre> -<p>DEPRECATED: Don't use. parse an <a href="libxml2-SAX.html#attribute">attribute</a> [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 <a href="libxml2-SAX.html#attribute">attribute</a> value (other than "&lt;") must not contain a <. [ VC: Attribute Value Type ] The <a href="libxml2-SAX.html#attribute">attribute</a> 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.</p> +<p>DEPRECATED: Internal function, don't use. parse an <a href="libxml2-SAX.html#attribute">attribute</a> [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 <a href="libxml2-SAX.html#attribute">attribute</a> value (other than "&lt;") must not contain a <. [ VC: Attribute Value Type ] The <a href="libxml2-SAX.html#attribute">attribute</a> 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.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1308,7 +1247,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseAttributeListDecl"></a>xmlParseAttributeListDecl ()</h3> <pre class="programlisting">void xmlParseAttributeListDecl (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>: parse the Attribute list def for an element [52] AttlistDecl ::= '<!ATTLIST' S Name AttDef* S? '>' [53] AttDef ::= S Name S AttType S DefaultDecl</p> +<p>DEPRECATED: Internal function, don't use. Parse an <a href="libxml2-SAX.html#attribute">attribute</a> list declaration for an element. Always consumes '<!'. [52] AttlistDecl ::= '<!ATTLIST' S Name AttDef* S? '>' [53] AttDef ::= S Name S AttType S DefaultDecl</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -1323,7 +1262,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseAttributeType"></a>xmlParseAttributeType ()</h3> <pre class="programlisting">int xmlParseAttributeType (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> <a href="libxml2-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> * tree)<br> </pre> -<p>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 <a href="libxml2-SAX.html#attribute">attribute</a> 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 <a href="libxml2-SAX.html#attribute">attribute</a> specified. [ VC: ID Attribute Default ] An ID <a href="libxml2-SAX.html#attribute">attribute</a> 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 <a href="libxml2-SAX.html#attribute">attribute</a> on some element in the XML document; i.e. IDREF values must match the value of some ID <a href="libxml2-SAX.html#attribute">attribute</a>. [ 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.</p> +<p>DEPRECATED: Internal function, don't use. 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 <a href="libxml2-SAX.html#attribute">attribute</a> 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 <a href="libxml2-SAX.html#attribute">attribute</a> specified. [ VC: ID Attribute Default ] An ID <a href="libxml2-SAX.html#attribute">attribute</a> 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 <a href="libxml2-SAX.html#attribute">attribute</a> on some element in the XML document; i.e. IDREF values must match the value of some ID <a href="libxml2-SAX.html#attribute">attribute</a>. [ 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.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1348,7 +1287,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseCDSect"></a>xmlParseCDSect ()</h3> <pre class="programlisting">void xmlParseCDSect (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>Parse escaped pure raw content. [18] CDSect ::= CDStart CData CDEnd [19] CDStart ::= '<![CDATA[' [20] Data ::= (Char* - (Char* ']]>' Char*)) [21] CDEnd ::= ']]>'</p> +<p>DEPRECATED: Internal function, don't use. Parse escaped pure raw content. Always consumes '<!['. [18] CDSect ::= CDStart CData CDEnd [19] CDStart ::= '<![CDATA[' [20] Data ::= (Char* - (Char* ']]>' Char*)) [21] CDEnd ::= ']]>'</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -1363,7 +1302,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseCharData"></a>xmlParseCharData ()</h3> <pre class="programlisting">void xmlParseCharData (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> int cdata)<br> </pre> -<p>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 <a href="libxml2-SAX.html#reference">reference</a> when it appears in the string "]]>" in content, when that string is not marking the end of a CDATA section. [14] CharData ::= [^<&]* - ([^<&]* ']]>' [^<&]*)</p> +<p>DEPRECATED: Internal function, don't use. Parse character data. Always makes progress if the first char isn't '<' or '&'. 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 <a href="libxml2-SAX.html#reference">reference</a> when it appears in the string "]]>" in content, when that string is not marking the end of a CDATA section. [14] CharData ::= [^<&]* - ([^<&]* ']]>' [^<&]*)</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1373,7 +1312,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr </tr> <tr> <td><span class="term"><i><tt>cdata</tt></i>:</span></td> -<td>int indicating whether we are within a CDATA section</td> +<td>unused</td> </tr> </tbody> </table></div> @@ -1384,7 +1323,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseCharRef"></a>xmlParseCharRef ()</h3> <pre class="programlisting">int xmlParseCharRef (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>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.</p> +<p>DEPRECATED: Internal function, don't use. Parse a numeric character <a href="libxml2-SAX.html#reference">reference</a>. Always consumes '&'. [66] CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';' [ WFC: Legal Character ] Characters referred to using character references must match the production for Char.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1405,7 +1344,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseComment"></a>xmlParseComment ()</h3> <pre class="programlisting">void xmlParseComment (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>Skip an XML (SGML) <a href="libxml2-SAX.html#comment">comment</a> <!-- .... --> The spec says that "For compatibility, the string "--" (double-hyphen) must not occur within comments. " [15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'</p> +<p>DEPRECATED: Internal function, don't use. Parse an XML (SGML) <a href="libxml2-SAX.html#comment">comment</a>. Always consumes '<!'. The spec says that "For compatibility, the string "--" (double-hyphen) must not occur within comments. " [15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -1435,7 +1374,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseDefaultDecl"></a>xmlParseDefaultDecl ()</h3> <pre class="programlisting">int xmlParseDefaultDecl (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> ** value)<br> </pre> -<p>Parse an <a href="libxml2-SAX.html#attribute">attribute</a> default declaration [60] DefaultDecl ::= '#REQUIRED' | '#IMPLIED' | (('#FIXED' S)? AttValue) [ VC: Required Attribute ] if the default declaration is the keyword #REQUIRED, then the <a href="libxml2-SAX.html#attribute">attribute</a> 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 <a href="libxml2-SAX.html#attribute">attribute</a> type c.f. xmlValidateAttributeDecl() [ VC: Fixed Attribute Default ] if an <a href="libxml2-SAX.html#attribute">attribute</a> has a default value declared with the #FIXED keyword, instances of that <a href="libxml2-SAX.html#attribute">attribute</a> must match the default value. [ WFC: No < in Attribute Values ] handled in xmlParseAttValue()</p> +<p>DEPRECATED: Internal function, don't use. Parse an <a href="libxml2-SAX.html#attribute">attribute</a> default declaration [60] DefaultDecl ::= '#REQUIRED' | '#IMPLIED' | (('#FIXED' S)? AttValue) [ VC: Required Attribute ] if the default declaration is the keyword #REQUIRED, then the <a href="libxml2-SAX.html#attribute">attribute</a> 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 <a href="libxml2-SAX.html#attribute">attribute</a> type c.f. xmlValidateAttributeDecl() [ VC: Fixed Attribute Default ] if an <a href="libxml2-SAX.html#attribute">attribute</a> has a default value declared with the #FIXED keyword, instances of that <a href="libxml2-SAX.html#attribute">attribute</a> must match the default value. [ WFC: No < in Attribute Values ] handled in xmlParseAttValue()</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1461,7 +1400,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseDocTypeDecl"></a>xmlParseDocTypeDecl ()</h3> <pre class="programlisting">void xmlParseDocTypeDecl (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>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.</p> +<p>DEPRECATED: Internal function, don't use. 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.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -1476,7 +1415,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseElement"></a>xmlParseElement ()</h3> <pre class="programlisting">void xmlParseElement (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse an XML element [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.</p> +<p>DEPRECATED: Internal function, don't use. parse an XML element [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.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -1491,7 +1430,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseElementChildrenContentDecl"></a>xmlParseElementChildrenContentDecl ()</h3> <pre class="programlisting"><a href="libxml2-tree.html#xmlElementContentPtr">xmlElementContentPtr</a> xmlParseElementChildrenContentDecl (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> int inputchk)<br> </pre> -<p>parse the declaration for a Mixed Element content The leading '(' and spaces have been skipped in <a href="libxml2-parserInternals.html#xmlParseElementContentDecl">xmlParseElementContentDecl</a> [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 <a href="libxml2-SAX.html#reference">reference</a> 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 ,).</p> +<p>DEPRECATED: Internal function, don't use. parse the declaration for a Mixed Element content The leading '(' and spaces have been skipped in <a href="libxml2-parserInternals.html#xmlParseElementContentDecl">xmlParseElementContentDecl</a> [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 <a href="libxml2-SAX.html#reference">reference</a> 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 ,).</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1516,7 +1455,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseElementContentDecl"></a>xmlParseElementContentDecl ()</h3> <pre class="programlisting">int xmlParseElementContentDecl (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> <a href="libxml2-tree.html#xmlElementContentPtr">xmlElementContentPtr</a> * result)<br> </pre> -<p>parse the declaration for an Element content either Mixed or Children, the cases EMPTY and ANY are handled directly in <a href="libxml2-parserInternals.html#xmlParseElementDecl">xmlParseElementDecl</a> [46] contentspec ::= 'EMPTY' | 'ANY' | Mixed | children</p> +<p>DEPRECATED: Internal function, don't use. parse the declaration for an Element content either Mixed or Children, the cases EMPTY and ANY are handled directly in <a href="libxml2-parserInternals.html#xmlParseElementDecl">xmlParseElementDecl</a> [46] contentspec ::= 'EMPTY' | 'ANY' | Mixed | children</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1545,7 +1484,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseElementDecl"></a>xmlParseElementDecl ()</h3> <pre class="programlisting">int xmlParseElementDecl (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>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</p> +<p>DEPRECATED: Internal function, don't use. Parse an element declaration. Always consumes '<!'. [45] elementdecl ::= '<!ELEMENT' S Name S contentspec S? '>' [ VC: Unique Element Type Declaration ] No element type may be declared more than once</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1566,7 +1505,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseElementMixedContentDecl"></a>xmlParseElementMixedContentDecl ()</h3> <pre class="programlisting"><a href="libxml2-tree.html#xmlElementContentPtr">xmlElementContentPtr</a> xmlParseElementMixedContentDecl (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> int inputchk)<br> </pre> -<p>parse the declaration for a Mixed Element content The leading '(' and spaces have been skipped in <a href="libxml2-parserInternals.html#xmlParseElementContentDecl">xmlParseElementContentDecl</a> [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.</p> +<p>DEPRECATED: Internal function, don't use. parse the declaration for a Mixed Element content The leading '(' and spaces have been skipped in <a href="libxml2-parserInternals.html#xmlParseElementContentDecl">xmlParseElementContentDecl</a> [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.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1591,7 +1530,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseEncName"></a>xmlParseEncName ()</h3> <pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlParseEncName (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse the XML encoding name [81] EncName ::= [A-Za-z] ([A-Za-z0-9._] | '-')*</p> +<p>DEPRECATED: Internal function, don't use. parse the XML encoding name [81] EncName ::= [A-Za-z] ([A-Za-z0-9._] | '-')*</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1612,7 +1551,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseEncodingDecl"></a>xmlParseEncodingDecl ()</h3> <pre class="programlisting">const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlParseEncodingDecl (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse the XML encoding declaration [80] EncodingDecl ::= S 'encoding' Eq ('"' EncName '"' | "'" EncName "'") this setups the conversion filters.</p> +<p>DEPRECATED: Internal function, don't use. parse the XML encoding declaration [80] EncodingDecl ::= S 'encoding' Eq ('"' EncName '"' | "'" EncName "'") this setups the conversion filters.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1633,7 +1572,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseEndTag"></a>xmlParseEndTag ()</h3> <pre class="programlisting">void xmlParseEndTag (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse an end of tag [42] ETag ::= '</' Name S? '>' With namespace [NS 9] ETag ::= '</' QName S? '>'</p> +<p>DEPRECATED: Internal function, don't use. parse an end of tag [42] ETag ::= '</' Name S? '>' With namespace [NS 9] ETag ::= '</' QName S? '>'</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -1648,7 +1587,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseEntityDecl"></a>xmlParseEntityDecl ()</h3> <pre class="programlisting">void xmlParseEntityDecl (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>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.</p> +<p>DEPRECATED: Internal function, don't use. Parse an entity declaration. Always consumes '<!'. [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.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -1663,7 +1602,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseEntityRef"></a>xmlParseEntityRef ()</h3> <pre class="programlisting"><a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> xmlParseEntityRef (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>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 <a href="libxml2-SAX.html#reference">reference</a> 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 <a href="libxml2-SAX.html#reference">reference</a> to it. Similarly, the declaration of a general entity must precede any <a href="libxml2-SAX.html#reference">reference</a> 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 <a href="libxml2-SAX.html#reference">reference</a> must not contain the name of an unparsed entity</p> +<p>DEPRECATED: Internal function, don't use. Parse an entitiy <a href="libxml2-SAX.html#reference">reference</a>. Always consumes '&'. [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 <a href="libxml2-SAX.html#reference">reference</a> 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 <a href="libxml2-SAX.html#reference">reference</a> to it. Similarly, the declaration of a general entity must precede any <a href="libxml2-SAX.html#reference">reference</a> 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 <a href="libxml2-SAX.html#reference">reference</a> must not contain the name of an unparsed entity</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1684,7 +1623,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseEntityValue"></a>xmlParseEntityValue ()</h3> <pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlParseEntityValue (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> ** orig)<br> </pre> -<p>parse a value for ENTITY declarations [9] EntityValue ::= '"' ([^%&"] | PEReference | Reference)* '"' | "'" ([^%&'] | PEReference | Reference)* "'"</p> +<p>DEPRECATED: Internal function, don't use. parse a value for ENTITY declarations [9] EntityValue ::= '"' ([^%&"] | PEReference | Reference)* '"' | "'" ([^%&'] | PEReference | Reference)* "'"</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1709,7 +1648,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseEnumeratedType"></a>xmlParseEnumeratedType ()</h3> <pre class="programlisting">int xmlParseEnumeratedType (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> <a href="libxml2-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> * tree)<br> </pre> -<p>parse an Enumerated <a href="libxml2-SAX.html#attribute">attribute</a> type. [57] EnumeratedType ::= NotationType | Enumeration [58] NotationType ::= 'NOTATION' S '(' S? Name (S? '|' S? Name)* S? ')'</p> +<p>DEPRECATED: Internal function, don't use. parse an Enumerated <a href="libxml2-SAX.html#attribute">attribute</a> type. [57] EnumeratedType ::= NotationType | Enumeration [58] NotationType ::= 'NOTATION' S '(' S? Name (S? '|' S? Name)* S? ')'</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1736,7 +1675,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseEnumerationType"></a>xmlParseEnumerationType ()</h3> <pre class="programlisting"><a href="libxml2-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> xmlParseEnumerationType (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse an Enumeration <a href="libxml2-SAX.html#attribute">attribute</a> 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</p> +<p>DEPRECATED: Internal function, don't use. parse an Enumeration <a href="libxml2-SAX.html#attribute">attribute</a> 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</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1757,7 +1696,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseExternalID"></a>xmlParseExternalID ()</h3> <pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlParseExternalID (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> ** publicID, <br> int strict)<br> </pre> -<p>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</p> +<p>DEPRECATED: Internal function, don't use. 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</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1811,7 +1750,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseMarkupDecl"></a>xmlParseMarkupDecl ()</h3> <pre class="programlisting">void xmlParseMarkupDecl (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>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.)</p> +<p>DEPRECATED: Internal function, don't use. Parse markup declarations. Always consumes '<!' or '<?'. [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.)</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -1826,7 +1765,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseMisc"></a>xmlParseMisc ()</h3> <pre class="programlisting">void xmlParseMisc (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse an XML Misc* optional field. [27] Misc ::= Comment | PI | S</p> +<p>DEPRECATED: Internal function, don't use. parse an XML Misc* optional field. [27] Misc ::= Comment | PI | S</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -1841,7 +1780,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseName"></a>xmlParseName ()</h3> <pre class="programlisting">const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlParseName (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse an XML name. [4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' | CombiningChar | Extender [5] Name ::= (Letter | '_' | ':') (NameChar)* [6] Names ::= Name (#x20 Name)*</p> +<p>DEPRECATED: Internal function, don't use. parse an XML name. [4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' | CombiningChar | Extender [5] Name ::= (Letter | '_' | ':') (NameChar)* [6] Names ::= Name (#x20 Name)*</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1877,7 +1816,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseNmtoken"></a>xmlParseNmtoken ()</h3> <pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlParseNmtoken (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse an XML Nmtoken. [7] Nmtoken ::= (NameChar)+ [8] Nmtokens ::= Nmtoken (#x20 Nmtoken)*</p> +<p>DEPRECATED: Internal function, don't use. parse an XML Nmtoken. [7] Nmtoken ::= (NameChar)+ [8] Nmtokens ::= Nmtoken (#x20 Nmtoken)*</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1898,7 +1837,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseNotationDecl"></a>xmlParseNotationDecl ()</h3> <pre class="programlisting">void xmlParseNotationDecl (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>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().</p> +<p>DEPRECATED: Internal function, don't use. Parse a notation declaration. Always consumes '<!'. [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().</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -1913,7 +1852,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseNotationType"></a>xmlParseNotationType ()</h3> <pre class="programlisting"><a href="libxml2-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> xmlParseNotationType (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse an Notation <a href="libxml2-SAX.html#attribute">attribute</a> 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.</p> +<p>DEPRECATED: Internal function, don't use. parse an Notation <a href="libxml2-SAX.html#attribute">attribute</a> 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.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1934,7 +1873,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParsePEReference"></a>xmlParsePEReference ()</h3> <pre class="programlisting">void xmlParsePEReference (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>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 <a href="libxml2-SAX.html#reference">reference</a> 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 <a href="libxml2-SAX.html#reference">reference</a> 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 <a href="libxml2-SAX.html#reference">reference</a> to it... [ WFC: In DTD ] Parameter-entity references may only appear in the DTD. NOTE: misleading but this is handled.</p> +<p>DEPRECATED: Internal function, don't use. Parse a parameter entity <a href="libxml2-SAX.html#reference">reference</a>. Always consumes '%'. 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 <a href="libxml2-SAX.html#reference">reference</a> 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 <a href="libxml2-SAX.html#reference">reference</a> 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 <a href="libxml2-SAX.html#reference">reference</a> to it... [ WFC: In DTD ] Parameter-entity references may only appear in the DTD. NOTE: misleading but this is handled.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -1949,7 +1888,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParsePI"></a>xmlParsePI ()</h3> <pre class="programlisting">void xmlParsePI (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse an XML Processing Instruction. [16] PI ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>' The processing is transferred to SAX once parsed.</p> +<p>DEPRECATED: Internal function, don't use. parse an XML Processing Instruction. [16] PI ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>' The processing is transferred to SAX once parsed.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -1964,7 +1903,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParsePITarget"></a>xmlParsePITarget ()</h3> <pre class="programlisting">const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlParsePITarget (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse the name of a PI [17] PITarget ::= Name - (('X' | 'x') ('M' | 'm') ('L' | 'l'))</p> +<p>DEPRECATED: Internal function, don't use. parse the name of a PI [17] PITarget ::= Name - (('X' | 'x') ('M' | 'm') ('L' | 'l'))</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1985,7 +1924,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParsePubidLiteral"></a>xmlParsePubidLiteral ()</h3> <pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlParsePubidLiteral (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse an XML public literal [12] PubidLiteral ::= '"' PubidChar* '"' | "'" (PubidChar - "'")* "'"</p> +<p>DEPRECATED: Internal function, don't use. parse an XML public literal [12] PubidLiteral ::= '"' PubidChar* '"' | "'" (PubidChar - "'")* "'"</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -2027,7 +1966,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseReference"></a>xmlParseReference ()</h3> <pre class="programlisting">void xmlParseReference (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>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</p> +<p>DEPRECATED: Internal function, don't use. 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. Always consumes '&'. [67] Reference ::= EntityRef | CharRef</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -2042,7 +1981,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseSDDecl"></a>xmlParseSDDecl ()</h3> <pre class="programlisting">int xmlParseSDDecl (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>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 <a href="libxml2-SAX.html#attribute">attribute</a> 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.</p> +<p>DEPRECATED: Internal function, don't use. 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 <a href="libxml2-SAX.html#attribute">attribute</a> 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.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -2063,7 +2002,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseStartTag"></a>xmlParseStartTag ()</h3> <pre class="programlisting">const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlParseStartTag (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>DEPRECATED: Don't use. 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 <a href="libxml2-SAX.html#attribute">attribute</a> 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 <a href="libxml2-SAX.html#attribute">attribute</a> 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? '/>'</p> +<p>DEPRECATED: Internal function, don't use. Parse a start tag. Always consumes '<'. [40] STag ::= '<' Name (S Attribute)* S? '>' [ WFC: Unique Att Spec ] No <a href="libxml2-SAX.html#attribute">attribute</a> 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 <a href="libxml2-SAX.html#attribute">attribute</a> 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? '/>'</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -2084,7 +2023,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseSystemLiteral"></a>xmlParseSystemLiteral ()</h3> <pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlParseSystemLiteral (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse an XML Literal [11] SystemLiteral ::= ('"' [^"]* '"') | ("'" [^']* "'")</p> +<p>DEPRECATED: Internal function, don't use. parse an XML Literal [11] SystemLiteral ::= ('"' [^"]* '"') | ("'" [^']* "'")</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -2105,7 +2044,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseTextDecl"></a>xmlParseTextDecl ()</h3> <pre class="programlisting">void xmlParseTextDecl (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse an XML declaration header for external entities [77] TextDecl ::= '<?xml' VersionInfo? EncodingDecl S? '?>'</p> +<p>DEPRECATED: Internal function, don't use. parse an XML declaration header for external entities [77] TextDecl ::= '<?xml' VersionInfo? EncodingDecl S? '?>'</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -2120,7 +2059,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseVersionInfo"></a>xmlParseVersionInfo ()</h3> <pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlParseVersionInfo (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse the XML version. [24] VersionInfo ::= S 'version' Eq (' VersionNum ' | " VersionNum ") [25] Eq ::= S? '=' S?</p> +<p>DEPRECATED: Internal function, don't use. parse the XML version. [24] VersionInfo ::= S 'version' Eq (' VersionNum ' | " VersionNum ") [25] Eq ::= S? '=' S?</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -2141,7 +2080,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseVersionNum"></a>xmlParseVersionNum ()</h3> <pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlParseVersionNum (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse the XML version value. [26] VersionNum ::= '1.' [0-9]+ In practice allow [0-9].[0-9]+ at that level</p> +<p>DEPRECATED: Internal function, don't use. parse the XML version value. [26] VersionNum ::= '1.' [0-9]+ In practice allow [0-9].[0-9]+ at that level</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -2162,7 +2101,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParseXMLDecl"></a>xmlParseXMLDecl ()</h3> <pre class="programlisting">void xmlParseXMLDecl (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>parse an XML declaration header [23] XMLDecl ::= '<?xml' VersionInfo EncodingDecl? SDDecl? S? '?>'</p> +<p>DEPRECATED: Internal function, don't use. parse an XML declaration header [23] XMLDecl ::= '<?xml' VersionInfo EncodingDecl? SDDecl? S? '?>'</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -2177,7 +2116,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParserHandlePEReference"></a>xmlParserHandlePEReference ()</h3> <pre class="programlisting">void xmlParserHandlePEReference (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>[69] PEReference ::= '%' Name ';' [ WFC: No Recursion ] A parsed entity must not contain a recursive <a href="libxml2-SAX.html#reference">reference</a> 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 <a href="libxml2-SAX.html#reference">reference</a> 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 <a href="libxml2-SAX.html#reference">reference</a> to it... [ WFC: In DTD ] Parameter-entity references may only appear in the DTD. NOTE: misleading but this is handled. A PEReference may have been detected in the current input stream the handling is done accordingly to http://www.w3.org/TR/REC-xml#entproc i.e. - Included in literal in entity values - Included as Parameter Entity <a href="libxml2-SAX.html#reference">reference</a> within DTDs</p> +<p>DEPRECATED: Internal function, do not use. [69] PEReference ::= '%' Name ';' [ WFC: No Recursion ] A parsed entity must not contain a recursive <a href="libxml2-SAX.html#reference">reference</a> 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 <a href="libxml2-SAX.html#reference">reference</a> 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 <a href="libxml2-SAX.html#reference">reference</a> to it... [ WFC: In DTD ] Parameter-entity references may only appear in the DTD. NOTE: misleading but this is handled. A PEReference may have been detected in the current input stream the handling is done accordingly to http://www.w3.org/TR/REC-xml#entproc i.e. - Included in literal in entity values - Included as Parameter Entity <a href="libxml2-SAX.html#reference">reference</a> within DTDs</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -2207,7 +2146,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlParserInputShrink"></a>xmlParserInputShrink ()</h3> <pre class="programlisting">void xmlParserInputShrink (<a href="libxml2-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> in)<br> </pre> -<p>This function removes used input for the parser.</p> +<p>DEPRECATED: Don't use. This function removes used input for the parser.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -2304,7 +2243,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlSkipBlankChars"></a>xmlSkipBlankChars ()</h3> <pre class="programlisting">int xmlSkipBlankChars (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt)<br> </pre> -<p>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.</p> +<p>DEPRECATED: Internal function, do not use. 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.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -2354,7 +2293,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlStringCurrentChar"></a>xmlStringCurrentChar ()</h3> <pre class="programlisting">int xmlStringCurrentChar (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * cur, <br> int * len)<br> </pre> -<p>The current char value, if using UTF-8 this may actually span multiple bytes in the input buffer.</p> +<p>DEPRECATED: Internal function, do not use. The current char value, if using UTF-8 this may actually span multiple bytes in the input buffer.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -2383,7 +2322,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlStringDecodeEntities"></a>xmlStringDecodeEntities ()</h3> <pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlStringDecodeEntities (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str, <br> int what, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> end, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> end2, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> end3)<br> </pre> -<p>Takes a entity string content and process to do the adequate substitutions. [67] Reference ::= EntityRef | CharRef [69] PEReference ::= '%' Name ';'</p> +<p>DEPRECATED: Internal function, don't use. Takes a entity string content and process to do the adequate substitutions. [67] Reference ::= EntityRef | CharRef [69] PEReference ::= '%' Name ';'</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -2425,7 +2364,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlStringLenDecodeEntities"></a>xmlStringLenDecodeEntities ()</h3> <pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlStringLenDecodeEntities (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str, <br> int len, <br> int what, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> end, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> end2, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> end3)<br> </pre> -<p>Takes a entity string content and process to do the adequate substitutions. [67] Reference ::= EntityRef | CharRef [69] PEReference ::= '%' Name ';'</p> +<p>DEPRECATED: Internal function, don't use. Takes a entity string content and process to do the adequate substitutions. [67] Reference ::= EntityRef | CharRef [69] PEReference ::= '%' Name ';'</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -2496,7 +2435,7 @@ int <a href="#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml2-tr <a name="xmlSwitchInputEncoding"></a>xmlSwitchInputEncoding ()</h3> <pre class="programlisting">int xmlSwitchInputEncoding (<a href="libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt, <br> <a href="libxml2-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> input, <br> <a href="libxml2-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> handler)<br> </pre> -<p>DEPRECATED: Use <a href="libxml2-parserInternals.html#xmlSwitchToEncoding">xmlSwitchToEncoding</a> change the input functions when discovering the character encoding of a given entity.</p> +<p>change the input functions when discovering the character encoding of a given entity.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> diff --git a/doc/devhelp/libxml2-threads.html b/doc/devhelp/libxml2-threads.html index 4ab52dc2..2dcd5b05 100644 --- a/doc/devhelp/libxml2-threads.html +++ b/doc/devhelp/libxml2-threads.html @@ -27,7 +27,6 @@ typedef <a href="libxml2-threads.html#xmlMutex">xmlMutex</a> * <a href="#xmlMute typedef struct _xmlRMutex <a href="#xmlRMutex">xmlRMutex</a>; typedef <a href="libxml2-threads.html#xmlRMutex">xmlRMutex</a> * <a href="#xmlRMutexPtr">xmlRMutexPtr</a>; void <a href="#xmlCleanupThreads">xmlCleanupThreads</a> (void); -int <a href="#xmlDllMain">xmlDllMain</a> (void * hinstDLL, <br> unsigned long fdwReason, <br> void * lpvReserved); void <a href="#xmlFreeMutex">xmlFreeMutex</a> (<a href="libxml2-threads.html#xmlMutexPtr">xmlMutexPtr</a> tok); void <a href="#xmlFreeRMutex">xmlFreeRMutex</a> (<a href="libxml2-threads.html#xmlRMutexPtr">xmlRMutexPtr</a> tok); <a href="libxml2-globals.html#xmlGlobalStatePtr">xmlGlobalStatePtr</a> <a href="#xmlGetGlobalState">xmlGetGlobalState</a> (void); @@ -89,36 +88,7 @@ The content of this structure is not made public by the API. <a name="xmlCleanupThreads"></a>xmlCleanupThreads ()</h3> <pre class="programlisting">void xmlCleanupThreads (void)<br> </pre> -<p>DEPRECATED: This function will be made private. Call <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> to free global state but see the warnings there. <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> should be only called once at program exit. In most cases, you don't have call cleanup functions at all. xmlCleanupThreads() is used to to cleanup all the thread related data of the libxml2 library once processing has ended. WARNING: if your application is multithreaded or has plugin support calling this may crash the application if another thread or a plugin is still using libxml2. It's sometimes very hard to guess if libxml2 is in use in the application, some libraries or plugins may use it without notice. In case of doubt abstain from calling this function or do it just before calling exit() to avoid leak reports from valgrind !</p> -</div> -<hr> -<div class="refsect2" lang="en"> -<h3> -<a name="xmlDllMain"></a>xmlDllMain ()</h3> -<pre class="programlisting">int xmlDllMain (void * hinstDLL, <br> unsigned long fdwReason, <br> void * lpvReserved)<br> -</pre> -<p></p> -<div class="variablelist"><table border="0"> -<col align="left"> -<tbody> -<tr> -<td><span class="term"><i><tt>hinstDLL</tt></i>:</span></td> -<td></td> -</tr> -<tr> -<td><span class="term"><i><tt>fdwReason</tt></i>:</span></td> -<td></td> -</tr> -<tr> -<td><span class="term"><i><tt>lpvReserved</tt></i>:</span></td> -<td></td> -</tr> -<tr> -<td><span class="term"><i><tt>Returns</tt></i>:</span></td> -<td></td> -</tr> -</tbody> -</table></div> +<p>DEPRECATED: This function is a no-op. Call <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> to free global state but see the warnings there. <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> should be only called once at program exit. In most cases, you don't have call cleanup functions at all.</p> </div> <hr> <div class="refsect2" lang="en"> @@ -126,7 +96,7 @@ The content of this structure is not made public by the API. <a name="xmlFreeMutex"></a>xmlFreeMutex ()</h3> <pre class="programlisting">void xmlFreeMutex (<a href="libxml2-threads.html#xmlMutexPtr">xmlMutexPtr</a> tok)<br> </pre> -<p>xmlFreeMutex() is used to reclaim resources associated with a libxml2 token struct.</p> +<p>Free a mutex.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -156,7 +126,7 @@ The content of this structure is not made public by the API. <a name="xmlGetGlobalState"></a>xmlGetGlobalState ()</h3> <pre class="programlisting"><a href="libxml2-globals.html#xmlGlobalStatePtr">xmlGlobalStatePtr</a> xmlGetGlobalState (void)<br> </pre> -<p>xmlGetGlobalState() is called to retrieve the global state for a thread.</p> +<p>DEPRECATED: Internal function, do not use. xmlGetGlobalState() is called to retrieve the global state for a thread.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -171,7 +141,7 @@ The content of this structure is not made public by the API. <a name="xmlGetThreadId"></a>xmlGetThreadId ()</h3> <pre class="programlisting">int xmlGetThreadId (void)<br> </pre> -<p>xmlGetThreadId() find the current thread ID number Note that this is likely to be broken on some platforms using pthreads as the specification doesn't mandate pthread_t to be an integer type</p> +<p>DEPRECATED: Internal function, do not use. xmlGetThreadId() find the current thread ID number Note that this is likely to be broken on some platforms using pthreads as the specification doesn't mandate pthread_t to be an integer type</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> @@ -186,7 +156,7 @@ The content of this structure is not made public by the API. <a name="xmlInitThreads"></a>xmlInitThreads ()</h3> <pre class="programlisting">void xmlInitThreads (void)<br> </pre> -<p>DEPRECATED: This function will be made private. Call <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a> to initialize the library. xmlInitThreads() is used to to initialize all the thread related data of the libxml2 library.</p> +<p>DEPRECATED: Alias for <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a>.</p> </div> <hr> <div class="refsect2" lang="en"> @@ -194,7 +164,7 @@ The content of this structure is not made public by the API. <a name="xmlIsMainThread"></a>xmlIsMainThread ()</h3> <pre class="programlisting">int xmlIsMainThread (void)<br> </pre> -<p>xmlIsMainThread() check whether the current thread is the main thread.</p> +<p>DEPRECATED: Internal function, do not use. xmlIsMainThread() check whether the current thread is the main thread.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> diff --git a/doc/devhelp/libxml2-tree.html b/doc/devhelp/libxml2-tree.html index e4987c13..4d4e1ebd 100644 --- a/doc/devhelp/libxml2-tree.html +++ b/doc/devhelp/libxml2-tree.html @@ -459,7 +459,7 @@ The content of this structure is not made public by the API. <pre class="programlisting">enum <a href="#xmlBufferAllocationScheme">xmlBufferAllocationScheme</a> { <a name="XML_BUFFER_ALLOC_DOUBLEIT">XML_BUFFER_ALLOC_DOUBLEIT</a> = 1 /* double each time one need to grow */ <a name="XML_BUFFER_ALLOC_EXACT">XML_BUFFER_ALLOC_EXACT</a> = 2 /* grow only to the minimal size */ - <a name="XML_BUFFER_ALLOC_IMMUTABLE">XML_BUFFER_ALLOC_IMMUTABLE</a> = 3 /* immutable buffer */ + <a name="XML_BUFFER_ALLOC_IMMUTABLE">XML_BUFFER_ALLOC_IMMUTABLE</a> = 3 /* immutable buffer, deprecated */ <a name="XML_BUFFER_ALLOC_IO">XML_BUFFER_ALLOC_IO</a> = 4 /* special allocation scheme used for I/O */ <a name="XML_BUFFER_ALLOC_HYBRID">XML_BUFFER_ALLOC_HYBRID</a> = 5 /* exact up to a threshold, and doubleit thereafter */ <a name="XML_BUFFER_ALLOC_BOUNDED">XML_BUFFER_ALLOC_BOUNDED</a> = 6 /* limit the upper size of the buffer */ @@ -735,7 +735,8 @@ The content of this structure is not made public by the API. struct _xmlEntity * nexte : unused const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * URI : the full URI as computed int owner : does the entity own the childrens - int checked : was the entity content checked this is also used to count entities * + int flags : various flags + unsigned long expandedSize : expanded size } xmlEntity; </pre> <p></p> @@ -985,7 +986,7 @@ The content of this structure is not made public by the API. <a href="libxml2-tree.html#xmlAttrPtr">xmlAttrPtr</a> freeAttrs : * the complete error information for the last error. * <a href="libxml2-xmlerror.html#xmlError">xmlError</a> lastError <a href="libxml2-parser.html#xmlParserMode">xmlParserMode</a> parseMode : the parser mode - unsigned long nbentities : number of entities references + unsigned long nbentities : unused unsigned long sizeentities : size of parsed entities for use by HTML non-recursive parser <a href="libxml2-parser.html#xmlParserNodeInfo">xmlParserNodeInfo</a> * nodeInfo : Current NodeInfo int nodeInfoNr : Depth of the parsing stack @@ -993,6 +994,9 @@ The content of this structure is not made public by the API. <a href="libxml2-parser.html#xmlParserNodeInfo">xmlParserNodeInfo</a> * nodeInfoTab : array of nodeInfos int input_id : we need to label inputs unsigned long sizeentcopy : volume of entity copy + int endCheckState : quote state for push parser + unsigned short nbErrors : number of errors + unsigned short nbWarnings : number of warnings } xmlParserCtxt; </pre> <p></p> @@ -1018,13 +1022,15 @@ The content of this structure is not made public by the API. const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * end : end of the array to parse int length : length if known int line : Current line - int col : * NOTE: consumed is only tested for equality in the parser code, * + int col : Current column unsigned long consumed : How many xmlChars already consumed <a href="libxml2-parser.html#xmlParserInputDeallocate">xmlParserInputDeallocate</a> free : function to deallocate the base const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * encoding : the encoding string for entity const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * version : the version string for entity int standalone : Was that entity marked standalone int id : an unique identifier for the entity + unsigned long parentConsumed : consumed bytes from parents + <a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> entity : entity, if any } xmlParserInput; </pre> <p></p> @@ -1664,7 +1670,7 @@ The content of this structure is not made public by the API. <a name="xmlBufferCreateStatic"></a>xmlBufferCreateStatic ()</h3> <pre class="programlisting"><a href="libxml2-tree.html#xmlBufferPtr">xmlBufferPtr</a> xmlBufferCreateStatic (void * mem, <br> size_t size)<br> </pre> -<p>routine to create an XML buffer from an immutable memory area. The area won't be modified nor copied, and is expected to be present until the end of the buffer lifetime.</p> +<p>Create an XML buffer initialized with bytes.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> @@ -1678,7 +1684,7 @@ The content of this structure is not made public by the API. </tr> <tr> <td><span class="term"><i><tt>Returns</tt></i>:</span></td> -<td>the new structure.</td> +<td></td> </tr> </tbody> </table></div> diff --git a/doc/devhelp/libxml2-uri.html b/doc/devhelp/libxml2-uri.html index 755e78da..de7a0aa4 100644 --- a/doc/devhelp/libxml2-uri.html +++ b/doc/devhelp/libxml2-uri.html @@ -358,7 +358,7 @@ char * <a href="#xmlURIUnescapeString">xmlURIUnescapeString</a> (const char * s <a name="xmlURIEscapeStr"></a>xmlURIEscapeStr ()</h3> <pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * xmlURIEscapeStr (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * list)<br> </pre> -<p>This routine escapes a string to hex, ignoring reserved <a href="libxml2-SAX.html#characters">characters</a> (a-z) and the <a href="libxml2-SAX.html#characters">characters</a> in the exception list.</p> +<p>This routine escapes a string to hex, ignoring reserved <a href="libxml2-SAX.html#characters">characters</a> (a-z, A-Z, 0-9, "@-_.!~*'()") and the <a href="libxml2-SAX.html#characters">characters</a> in the exception list.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> diff --git a/doc/devhelp/libxml2-valid.html b/doc/devhelp/libxml2-valid.html index 3ea0bb80..821d3fa6 100644 --- a/doc/devhelp/libxml2-valid.html +++ b/doc/devhelp/libxml2-valid.html @@ -22,9 +22,7 @@ <p>Author(s): Daniel Veillard </p> <div class="refsynopsisdiv"> <h2>Synopsis</h2> -<pre class="synopsis">#define <a href="#XML_VCTXT_DTD_VALIDATED">XML_VCTXT_DTD_VALIDATED</a>; -#define <a href="#XML_VCTXT_USE_PCTXT">XML_VCTXT_USE_PCTXT</a>; -typedef struct _xmlHashTable <a href="#xmlAttributeTable">xmlAttributeTable</a>; +<pre class="synopsis">typedef struct _xmlHashTable <a href="#xmlAttributeTable">xmlAttributeTable</a>; typedef <a href="libxml2-valid.html#xmlAttributeTable">xmlAttributeTable</a> * <a href="#xmlAttributeTablePtr">xmlAttributeTablePtr</a>; typedef struct _xmlHashTable <a href="#xmlElementTable">xmlElementTable</a>; typedef <a href="libxml2-valid.html#xmlElementTable">xmlElementTable</a> * <a href="#xmlElementTablePtr">xmlElementTablePtr</a>; @@ -93,7 +91,7 @@ int <a href="#xmlValidateDocument">xmlValidateDocument</a> (<a href="libxml2-va int <a href="#xmlValidateDocumentFinal">xmlValidateDocumentFinal</a> (<a href="libxml2-valid.html#xmlValidCtxtPtr">xmlValidCtxtPtr</a> ctxt, <br> <a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc); int <a href="#xmlValidateDtd">xmlValidateDtd</a> (<a href="libxml2-valid.html#xmlValidCtxtPtr">xmlValidCtxtPtr</a> ctxt, <br> <a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br> <a href="libxml2-tree.html#xmlDtdPtr">xmlDtdPtr</a> dtd); int <a href="#xmlValidateDtdFinal">xmlValidateDtdFinal</a> (<a href="libxml2-valid.html#xmlValidCtxtPtr">xmlValidCtxtPtr</a> ctxt, <br> <a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc); -int <a href="#xmlValidateElement">xmlValidateElement</a> (<a href="libxml2-valid.html#xmlValidCtxtPtr">xmlValidCtxtPtr</a> ctxt, <br> <a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> elem); +int <a href="#xmlValidateElement">xmlValidateElement</a> (<a href="libxml2-valid.html#xmlValidCtxtPtr">xmlValidCtxtPtr</a> ctxt, <br> <a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> root); int <a href="#xmlValidateElementDecl">xmlValidateElementDecl</a> (<a href="libxml2-valid.html#xmlValidCtxtPtr">xmlValidCtxtPtr</a> ctxt, <br> <a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br> <a href="libxml2-tree.html#xmlElementPtr">xmlElementPtr</a> elem); int <a href="#xmlValidateNameValue">xmlValidateNameValue</a> (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * value); int <a href="#xmlValidateNamesValue">xmlValidateNamesValue</a> (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * value); @@ -118,22 +116,6 @@ typedef void <a href="#xmlValidityWarningFunc">xmlValidityWarningFunc</a> (void <div class="refsect2" lang="en"> <div class="refsect2" lang="en"> <h3> -<a name="XML_VCTXT_DTD_VALIDATED">Macro </a>XML_VCTXT_DTD_VALIDATED</h3> -<pre class="programlisting">#define <a href="#XML_VCTXT_DTD_VALIDATED">XML_VCTXT_DTD_VALIDATED</a>; -</pre> -<p>Set after <a href="libxml2-valid.html#xmlValidateDtdFinal">xmlValidateDtdFinal</a> was called.</p> -</div> -<hr> -<div class="refsect2" lang="en"> -<h3> -<a name="XML_VCTXT_USE_PCTXT">Macro </a>XML_VCTXT_USE_PCTXT</h3> -<pre class="programlisting">#define <a href="#XML_VCTXT_USE_PCTXT">XML_VCTXT_USE_PCTXT</a>; -</pre> -<p>Set if the validation context is part of a parser context.</p> -</div> -<hr> -<div class="refsect2" lang="en"> -<h3> <a name="xmlAttributeTable">Structure </a>xmlAttributeTable</h3> <pre class="programlisting">struct _xmlHashTable { The content of this structure is not made public by the API. @@ -1713,7 +1695,7 @@ The content of this structure is not made public by the API. <div class="refsect2" lang="en"> <h3> <a name="xmlValidateElement"></a>xmlValidateElement ()</h3> -<pre class="programlisting">int xmlValidateElement (<a href="libxml2-valid.html#xmlValidCtxtPtr">xmlValidCtxtPtr</a> ctxt, <br> <a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> elem)<br> +<pre class="programlisting">int xmlValidateElement (<a href="libxml2-valid.html#xmlValidCtxtPtr">xmlValidCtxtPtr</a> ctxt, <br> <a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> root)<br> </pre> <p>Try to validate the subtree under an element</p> <div class="variablelist"><table border="0"> @@ -1728,8 +1710,8 @@ The content of this structure is not made public by the API. <td>a document instance</td> </tr> <tr> -<td><span class="term"><i><tt>elem</tt></i>:</span></td> -<td>an element instance</td> +<td><span class="term"><i><tt>root</tt></i>:</span></td> +<td></td> </tr> <tr> <td><span class="term"><i><tt>Returns</tt></i>:</span></td> diff --git a/doc/devhelp/libxml2-xmlIO.html b/doc/devhelp/libxml2-xmlIO.html index e25ee025..1210a2f5 100644 --- a/doc/devhelp/libxml2-xmlIO.html +++ b/doc/devhelp/libxml2-xmlIO.html @@ -1211,7 +1211,7 @@ int <a href="#xmlRegisterOutputCallbacks">xmlRegisterOutputCallbacks</a> (<a hre <a name="xmlParserInputBufferCreateStatic"></a>xmlParserInputBufferCreateStatic ()</h3> <pre class="programlisting"><a href="libxml2-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> xmlParserInputBufferCreateStatic (const char * mem, <br> int size, <br> <a href="libxml2-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc)<br> </pre> -<p>Create a buffered parser input for the progressive parsing for the input from an immutable memory area. This will not copy the memory area to the buffer, but the memory is expected to be available until the end of the parsing, this is useful for example when using mmap'ed file.</p> +<p>DEPRECATED: Use <a href="libxml2-xmlIO.html#xmlParserInputBufferCreateMem">xmlParserInputBufferCreateMem</a>.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody> diff --git a/doc/devhelp/libxml2-xmlerror.html b/doc/devhelp/libxml2-xmlerror.html index f97c8e14..b4d3a26b 100644 --- a/doc/devhelp/libxml2-xmlerror.html +++ b/doc/devhelp/libxml2-xmlerror.html @@ -929,7 +929,7 @@ typedef void <a href="#xmlStructuredErrorFunc">xmlStructuredErrorFunc</a> (void <a name="initGenericErrorDefaultFunc"></a>initGenericErrorDefaultFunc ()</h3> <pre class="programlisting">void initGenericErrorDefaultFunc (<a href="libxml2-xmlerror.html#xmlGenericErrorFunc">xmlGenericErrorFunc</a> * handler)<br> </pre> -<p>Set or reset (if NULL) the default handler for generic errors to the builtin error function.</p> +<p>DEPRECATED: Use <a href="libxml2-xmlerror.html#xmlSetGenericErrorFunc">xmlSetGenericErrorFunc</a>. Set or reset (if NULL) the default handler for generic errors to the builtin error function.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> diff --git a/doc/devhelp/libxml2-xmlexports.html b/doc/devhelp/libxml2-xmlexports.html index 422affc1..937d7cb9 100644 --- a/doc/devhelp/libxml2-xmlexports.html +++ b/doc/devhelp/libxml2-xmlexports.html @@ -22,10 +22,7 @@ <p>Author(s): </p> <div class="refsynopsisdiv"> <h2>Synopsis</h2> -<pre class="synopsis">#define <a href="#XMLCALL">XMLCALL</a>; -#define <a href="#XMLCDECL">XMLCDECL</a>; -#define <a href="#XMLPUBFUN">XMLPUBFUN</a>; -#define <a href="#XMLPUBLIC">XMLPUBLIC</a>; +<pre class="synopsis">#define <a href="#XMLPUBFUN">XMLPUBFUN</a>; #define <a href="#XMLPUBVAR">XMLPUBVAR</a>; </pre> </div> @@ -35,22 +32,6 @@ <div class="refsect2" lang="en"> <div class="refsect2" lang="en"> <h3> -<a name="XMLCALL">Macro </a>XMLCALL</h3> -<pre class="programlisting">#define <a href="#XMLCALL">XMLCALL</a>; -</pre> -<p>Macro which declares the calling convention for exported functions</p> -</div> -<hr> -<div class="refsect2" lang="en"> -<h3> -<a name="XMLCDECL">Macro </a>XMLCDECL</h3> -<pre class="programlisting">#define <a href="#XMLCDECL">XMLCDECL</a>; -</pre> -<p>Macro which declares the calling convention for exported functions that use '...'.</p> -</div> -<hr> -<div class="refsect2" lang="en"> -<h3> <a name="XMLPUBFUN">Macro </a>XMLPUBFUN</h3> <pre class="programlisting">#define <a href="#XMLPUBFUN">XMLPUBFUN</a>; </pre> @@ -59,14 +40,6 @@ <hr> <div class="refsect2" lang="en"> <h3> -<a name="XMLPUBLIC">Macro </a>XMLPUBLIC</h3> -<pre class="programlisting">#define <a href="#XMLPUBLIC">XMLPUBLIC</a>; -</pre> -<p>Macro which declares a public symbol</p> -</div> -<hr> -<div class="refsect2" lang="en"> -<h3> <a name="XMLPUBVAR">Macro </a>XMLPUBVAR</h3> <pre class="programlisting">#define <a href="#XMLPUBVAR">XMLPUBVAR</a>; </pre> diff --git a/doc/devhelp/libxml2-xmlmemory.html b/doc/devhelp/libxml2-xmlmemory.html index e1aef9db..f663bb69 100644 --- a/doc/devhelp/libxml2-xmlmemory.html +++ b/doc/devhelp/libxml2-xmlmemory.html @@ -44,6 +44,7 @@ void * <a href="#xmlMemMalloc">xmlMemMalloc</a> (size_t size); void * <a href="#xmlMemRealloc">xmlMemRealloc</a> (void * ptr, <br> size_t size); int <a href="#xmlMemSetup">xmlMemSetup</a> (<a href="libxml2-xmlmemory.html#xmlFreeFunc">xmlFreeFunc</a> freeFunc, <br> <a href="libxml2-xmlmemory.html#xmlMallocFunc">xmlMallocFunc</a> mallocFunc, <br> <a href="libxml2-xmlmemory.html#xmlReallocFunc">xmlReallocFunc</a> reallocFunc, <br> <a href="libxml2-xmlmemory.html#xmlStrdupFunc">xmlStrdupFunc</a> strdupFunc); void <a href="#xmlMemShow">xmlMemShow</a> (FILE * fp, <br> int nr); +size_t <a href="#xmlMemSize">xmlMemSize</a> (void * ptr); char * <a href="#xmlMemStrdupLoc">xmlMemStrdupLoc</a> (const char * str, <br> const char * file, <br> int line); int <a href="#xmlMemUsed">xmlMemUsed</a> (void); void <a href="#xmlMemoryDump">xmlMemoryDump</a> (void); @@ -152,7 +153,7 @@ typedef char * <a href="#xmlStrdupFunc">xmlStrdupFunc</a> (const char * str); <a name="xmlCleanupMemory"></a>xmlCleanupMemory ()</h3> <pre class="programlisting">void xmlCleanupMemory (void)<br> </pre> -<p>DEPRECATED: This function will be made private. Call <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> to free global state but see the warnings there. <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> should be only called once at program exit. In most cases, you don't have call cleanup functions at all. Free up all the memory allocated by the library for its own use. This should not be called by user level code.</p> +<p>DEPRECATED: This function is a no-op. Call <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> to free global state but see the warnings there. <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> should be only called once at program exit. In most cases, you don't have call cleanup functions at all.</p> </div> <hr> <div class="refsect2" lang="en"> @@ -234,12 +235,12 @@ typedef char * <a href="#xmlStrdupFunc">xmlStrdupFunc</a> (const char * str); <a name="xmlInitMemory"></a>xmlInitMemory ()</h3> <pre class="programlisting">int xmlInitMemory (void)<br> </pre> -<p>DEPRECATED: This function will be made private. Call <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a> to initialize the library. Initialize the memory layer.</p> +<p>DEPRECATED: Alias for <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a>.</p> <div class="variablelist"><table border="0"> <col align="left"> <tbody><tr> <td><span class="term"><i><tt>Returns</tt></i>:</span></td> -<td>0 on success</td> +<td></td> </tr></tbody> </table></div> </div> @@ -503,6 +504,27 @@ typedef char * <a href="#xmlStrdupFunc">xmlStrdupFunc</a> (const char * str); <hr> <div class="refsect2" lang="en"> <h3> +<a name="xmlMemSize"></a>xmlMemSize ()</h3> +<pre class="programlisting">size_t xmlMemSize (void * ptr)<br> +</pre> +<p></p> +<div class="variablelist"><table border="0"> +<col align="left"> +<tbody> +<tr> +<td><span class="term"><i><tt>ptr</tt></i>:</span></td> +<td>pointer to the memory allocation</td> +</tr> +<tr> +<td><span class="term"><i><tt>Returns</tt></i>:</span></td> +<td>the size of a memory allocation.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" lang="en"> +<h3> <a name="xmlMemStrdupLoc"></a>xmlMemStrdupLoc ()</h3> <pre class="programlisting">char * xmlMemStrdupLoc (const char * str, <br> const char * file, <br> int line)<br> </pre> diff --git a/doc/devhelp/libxml2-xmlschemastypes.html b/doc/devhelp/libxml2-xmlschemastypes.html index 8d4459ab..011da789 100644 --- a/doc/devhelp/libxml2-xmlschemastypes.html +++ b/doc/devhelp/libxml2-xmlschemastypes.html @@ -38,7 +38,7 @@ int <a href="#xmlSchemaGetCanonValueWhtsp">xmlSchemaGetCanonValueWhtsp</a> (<a h unsigned long <a href="#xmlSchemaGetFacetValueAsULong">xmlSchemaGetFacetValueAsULong</a> (<a href="libxml2-schemasInternals.html#xmlSchemaFacetPtr">xmlSchemaFacetPtr</a> facet); <a href="libxml2-schemasInternals.html#xmlSchemaTypePtr">xmlSchemaTypePtr</a> <a href="#xmlSchemaGetPredefinedType">xmlSchemaGetPredefinedType</a> (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ns); <a href="libxml2-schemasInternals.html#xmlSchemaValType">xmlSchemaValType</a> <a href="#xmlSchemaGetValType">xmlSchemaGetValType</a> (<a href="libxml2-schemasInternals.html#xmlSchemaValPtr">xmlSchemaValPtr</a> val); -void <a href="#xmlSchemaInitTypes">xmlSchemaInitTypes</a> (void); +int <a href="#xmlSchemaInitTypes">xmlSchemaInitTypes</a> (void); int <a href="#xmlSchemaIsBuiltInTypeFacet">xmlSchemaIsBuiltInTypeFacet</a> (<a href="libxml2-schemasInternals.html#xmlSchemaTypePtr">xmlSchemaTypePtr</a> type, <br> int facetType); <a href="libxml2-schemasInternals.html#xmlSchemaFacetPtr">xmlSchemaFacetPtr</a> <a href="#xmlSchemaNewFacet">xmlSchemaNewFacet</a> (void); <a href="libxml2-schemasInternals.html#xmlSchemaValPtr">xmlSchemaValPtr</a> <a href="#xmlSchemaNewNOTATIONValue">xmlSchemaNewNOTATIONValue</a> (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ns); @@ -114,7 +114,7 @@ const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * <a href="#xmlSchema <a name="xmlSchemaCleanupTypes"></a>xmlSchemaCleanupTypes ()</h3> <pre class="programlisting">void xmlSchemaCleanupTypes (void)<br> </pre> -<p>DEPRECATED: This function will be made private. Call <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> to free global state but see the warnings there. <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> should be only called once at program exit. In most cases, you don't have call cleanup functions at all. Cleanup the default XML Schemas type library</p> +<p>DEPRECATED: This function will be made private. Call <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> to free global state but see the warnings there. <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> should be only called once at program exit. In most cases, you don't have to call cleanup functions at all. Cleanup the default XML Schemas type library</p> </div> <hr> <div class="refsect2" lang="en"> @@ -413,9 +413,16 @@ const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * <a href="#xmlSchema <div class="refsect2" lang="en"> <h3> <a name="xmlSchemaInitTypes"></a>xmlSchemaInitTypes ()</h3> -<pre class="programlisting">void xmlSchemaInitTypes (void)<br> +<pre class="programlisting">int xmlSchemaInitTypes (void)<br> </pre> <p>Initialize the default XML Schemas type library</p> +<div class="variablelist"><table border="0"> +<col align="left"> +<tbody><tr> +<td><span class="term"><i><tt>Returns</tt></i>:</span></td> +<td>0 on success, -1 on error.</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2" lang="en"> diff --git a/doc/devhelp/libxml2-xmlversion.html b/doc/devhelp/libxml2-xmlversion.html index 98b08196..7e202ac2 100644 --- a/doc/devhelp/libxml2-xmlversion.html +++ b/doc/devhelp/libxml2-xmlversion.html @@ -68,7 +68,6 @@ #define <a href="#LIBXML_ZLIB_ENABLED">LIBXML_ZLIB_ENABLED</a>; #define <a href="#WITHOUT_TRIO">WITHOUT_TRIO</a>; #define <a href="#WITH_TRIO">WITH_TRIO</a>; -#define <a href="#XML_DEPRECATED">XML_DEPRECATED</a>; void <a href="#xmlCheckVersion">xmlCheckVersion</a> (int version); </pre> </div> @@ -145,7 +144,7 @@ void <a href="#xmlCheckVersion">xmlCheckVersion</a> (int version); <a name="LIBXML_DEBUG_RUNTIME">Macro </a>LIBXML_DEBUG_RUNTIME</h3> <pre class="programlisting">#define <a href="#LIBXML_DEBUG_RUNTIME">LIBXML_DEBUG_RUNTIME</a>; </pre> -<p>Whether the runtime debugging is configured in</p> +<p>Removed</p> </div> <hr> <div class="refsect2" lang="en"> @@ -446,14 +445,6 @@ void <a href="#xmlCheckVersion">xmlCheckVersion</a> (int version); <hr> <div class="refsect2" lang="en"> <h3> -<a name="XML_DEPRECATED">Macro </a>XML_DEPRECATED</h3> -<pre class="programlisting">#define <a href="#XML_DEPRECATED">XML_DEPRECATED</a>; -</pre> -<p>Macro used to indicate that a function, variable, type or struct member is deprecated.</p> -</div> -<hr> -<div class="refsect2" lang="en"> -<h3> <a name="xmlCheckVersion"></a>xmlCheckVersion ()</h3> <pre class="programlisting">void xmlCheckVersion (int version)<br> </pre> diff --git a/doc/devhelp/libxml2-xpath.html b/doc/devhelp/libxml2-xpath.html index a5970ac0..9a4c3069 100644 --- a/doc/devhelp/libxml2-xpath.html +++ b/doc/devhelp/libxml2-xpath.html @@ -397,7 +397,7 @@ The content of this structure is not made public by the API. <a href="libxml2-xpath.html#xmlXPathCompExprPtr">xmlXPathCompExprPtr</a> comp : the precompiled expression int xptr : it this an XPointer expression <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> ancestor : used for walking preceding axis - int valueFrame : used to limit Pop on the stack + int valueFrame : unused } xmlXPathParserContext; </pre> <p></p> @@ -1289,7 +1289,7 @@ The content of this structure is not made public by the API. <a name="xmlXPathInit"></a>xmlXPathInit ()</h3> <pre class="programlisting">void xmlXPathInit (void)<br> </pre> -<p>DEPRECATED: This function will be made private. Call <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a> to initialize the library. Initialize the XPath environment</p> +<p>DEPRECATED: Alias for <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a>.</p> </div> <hr> <div class="refsect2" lang="en"> diff --git a/doc/devhelp/libxml2-xpathInternals.html b/doc/devhelp/libxml2-xpathInternals.html index 750dade3..3a1f3ba7 100644 --- a/doc/devhelp/libxml2-xpathInternals.html +++ b/doc/devhelp/libxml2-xpathInternals.html @@ -650,7 +650,7 @@ void <a href="#xmlXPatherror">xmlXPatherror</a> (<a href="libxml2-xpath.html#x </tr> <tr> <td><span class="term"><i><tt>Returns</tt></i>:</span></td> -<td>the number of items on the value stack, or -1 in case of error.</td> +<td>the number of items on the value stack, or -1 in case of error. The object is destroyed in case of error.</td> </tr> </tbody> </table></div> @@ -2095,7 +2095,7 @@ void <a href="#xmlXPatherror">xmlXPatherror</a> (<a href="libxml2-xpath.html#x </tr> <tr> <td><span class="term"><i><tt>Returns</tt></i>:</span></td> -<td>@val1 once extended or NULL in case of error.</td> +<td>@val1 once extended or NULL in case of error. Frees @val1 in case of error.</td> </tr> </tbody> </table></div> @@ -3164,7 +3164,7 @@ void <a href="#xmlXPatherror">xmlXPatherror</a> (<a href="libxml2-xpath.html#x </tr> <tr> <td><span class="term"><i><tt>Returns</tt></i>:</span></td> -<td>the newly created object.</td> +<td>the newly created object. In case of error the node set is destroyed and NULL is returned.</td> </tr> </tbody> </table></div> @@ -3185,7 +3185,7 @@ void <a href="#xmlXPatherror">xmlXPatherror</a> (<a href="libxml2-xpath.html#x </tr> <tr> <td><span class="term"><i><tt>Returns</tt></i>:</span></td> -<td>the newly created object.</td> +<td>the newly created object. Frees @val in case of error.</td> </tr> </tbody> </table></div> diff --git a/doc/devhelp/libxml2.devhelp2 b/doc/devhelp/libxml2.devhelp2 index 3f6459e9..1d9ec80b 100644 --- a/doc/devhelp/libxml2.devhelp2 +++ b/doc/devhelp/libxml2.devhelp2 @@ -133,9 +133,6 @@ <keyword type="macro" name="LIBXML_XPTR_ENABLED" link="libxml2-xmlversion.html#LIBXML_XPTR_ENABLED"/> <keyword type="macro" name="LIBXML_XPTR_LOCS_ENABLED" link="libxml2-xmlversion.html#LIBXML_XPTR_LOCS_ENABLED"/> <keyword type="macro" name="LIBXML_ZLIB_ENABLED" link="libxml2-xmlversion.html#LIBXML_ZLIB_ENABLED"/> - <keyword type="macro" name="MOVETO_ENDTAG" link="libxml2-parserInternals.html#MOVETO_ENDTAG"/> - <keyword type="macro" name="MOVETO_STARTTAG" link="libxml2-parserInternals.html#MOVETO_STARTTAG"/> - <keyword type="macro" name="SKIP_EOL" link="libxml2-parserInternals.html#SKIP_EOL"/> <keyword type="macro" name="SOCKET" link="libxml2-nanoftp.html#SOCKET"/> <keyword type="macro" name="WITHOUT_TRIO" link="libxml2-xmlversion.html#WITHOUT_TRIO"/> <keyword type="macro" name="WITH_TRIO" link="libxml2-xmlversion.html#WITH_TRIO"/> @@ -149,22 +146,19 @@ <keyword type="macro" name="XINCLUDE_PARSE_TEXT" link="libxml2-xinclude.html#XINCLUDE_PARSE_TEXT"/> <keyword type="macro" name="XINCLUDE_PARSE_XML" link="libxml2-xinclude.html#XINCLUDE_PARSE_XML"/> <keyword type="macro" name="XINCLUDE_PARSE_XPOINTER" link="libxml2-xinclude.html#XINCLUDE_PARSE_XPOINTER"/> - <keyword type="macro" name="XMLCALL" link="libxml2-xmlexports.html#XMLCALL"/> - <keyword type="macro" name="XMLCDECL" link="libxml2-xmlexports.html#XMLCDECL"/> <keyword type="macro" name="XMLPUBFUN" link="libxml2-xmlexports.html#XMLPUBFUN"/> - <keyword type="macro" name="XMLPUBLIC" link="libxml2-xmlexports.html#XMLPUBLIC"/> <keyword type="macro" name="XMLPUBVAR" link="libxml2-xmlexports.html#XMLPUBVAR"/> <keyword type="macro" name="XML_CAST_FPTR" link="libxml2-hash.html#XML_CAST_FPTR"/> <keyword type="macro" name="XML_CATALOGS_NAMESPACE" link="libxml2-catalog.html#XML_CATALOGS_NAMESPACE"/> <keyword type="macro" name="XML_CATALOG_PI" link="libxml2-catalog.html#XML_CATALOG_PI"/> <keyword type="macro" name="XML_COMPLETE_ATTRS" link="libxml2-parser.html#XML_COMPLETE_ATTRS"/> <keyword type="macro" name="XML_DEFAULT_VERSION" link="libxml2-parser.html#XML_DEFAULT_VERSION"/> - <keyword type="macro" name="XML_DEPRECATED" link="libxml2-xmlversion.html#XML_DEPRECATED"/> <keyword type="macro" name="XML_DETECT_IDS" link="libxml2-parser.html#XML_DETECT_IDS"/> <keyword type="macro" name="XML_GET_CONTENT" link="libxml2-tree.html#XML_GET_CONTENT"/> <keyword type="macro" name="XML_GET_LINE" link="libxml2-tree.html#XML_GET_LINE"/> <keyword type="macro" name="XML_LOCAL_NAMESPACE" link="libxml2-tree.html#XML_LOCAL_NAMESPACE"/> <keyword type="macro" name="XML_MAX_DICTIONARY_LIMIT" link="libxml2-parserInternals.html#XML_MAX_DICTIONARY_LIMIT"/> + <keyword type="macro" name="XML_MAX_HUGE_LENGTH" link="libxml2-parserInternals.html#XML_MAX_HUGE_LENGTH"/> <keyword type="macro" name="XML_MAX_LOOKUP_LIMIT" link="libxml2-parserInternals.html#XML_MAX_LOOKUP_LIMIT"/> <keyword type="macro" name="XML_MAX_NAMELEN" link="libxml2-parserInternals.html#XML_MAX_NAMELEN"/> <keyword type="macro" name="XML_MAX_NAME_LENGTH" link="libxml2-parserInternals.html#XML_MAX_NAME_LENGTH"/> @@ -257,8 +251,6 @@ <keyword type="macro" name="XML_SUBSTITUTE_NONE" link="libxml2-parserInternals.html#XML_SUBSTITUTE_NONE"/> <keyword type="macro" name="XML_SUBSTITUTE_PEREF" link="libxml2-parserInternals.html#XML_SUBSTITUTE_PEREF"/> <keyword type="macro" name="XML_SUBSTITUTE_REF" link="libxml2-parserInternals.html#XML_SUBSTITUTE_REF"/> - <keyword type="macro" name="XML_VCTXT_DTD_VALIDATED" link="libxml2-valid.html#XML_VCTXT_DTD_VALIDATED"/> - <keyword type="macro" name="XML_VCTXT_USE_PCTXT" link="libxml2-valid.html#XML_VCTXT_USE_PCTXT"/> <keyword type="macro" name="XML_XML_ID" link="libxml2-tree.html#XML_XML_ID"/> <keyword type="macro" name="XML_XML_NAMESPACE" link="libxml2-tree.html#XML_XML_NAMESPACE"/> <keyword type="macro" name="XML_XPATH_CHECKNS" link="libxml2-xpath.html#XML_XPATH_CHECKNS"/> @@ -2248,7 +2240,6 @@ <keyword type="function" name="xmlDictReference ()" link="libxml2-dict.html#xmlDictReference"/> <keyword type="function" name="xmlDictSetLimit ()" link="libxml2-dict.html#xmlDictSetLimit"/> <keyword type="function" name="xmlDictSize ()" link="libxml2-dict.html#xmlDictSize"/> - <keyword type="function" name="xmlDllMain ()" link="libxml2-threads.html#xmlDllMain"/> <keyword type="function" name="xmlDocCopyNode ()" link="libxml2-tree.html#xmlDocCopyNode"/> <keyword type="function" name="xmlDocCopyNodeList ()" link="libxml2-tree.html#xmlDocCopyNodeList"/> <keyword type="function" name="xmlDocDump ()" link="libxml2-tree.html#xmlDocDump"/> @@ -2271,7 +2262,6 @@ <keyword type="function" name="xmlEncodeEntities ()" link="libxml2-entities.html#xmlEncodeEntities"/> <keyword type="function" name="xmlEncodeEntitiesReentrant ()" link="libxml2-entities.html#xmlEncodeEntitiesReentrant"/> <keyword type="function" name="xmlEncodeSpecialChars ()" link="libxml2-entities.html#xmlEncodeSpecialChars"/> - <keyword type="function" name="xmlErrMemory ()" link="libxml2-parserInternals.html#xmlErrMemory"/> <keyword type="function" name="xmlExpCtxtNbCons ()" link="libxml2-xmlregexp.html#xmlExpCtxtNbCons"/> <keyword type="function" name="xmlExpCtxtNbNodes ()" link="libxml2-xmlregexp.html#xmlExpCtxtNbNodes"/> <keyword type="function" name="xmlExpDump ()" link="libxml2-xmlregexp.html#xmlExpDump"/> @@ -2475,6 +2465,7 @@ <keyword type="function" name="xmlMemRealloc ()" link="libxml2-xmlmemory.html#xmlMemRealloc"/> <keyword type="function" name="xmlMemSetup ()" link="libxml2-xmlmemory.html#xmlMemSetup"/> <keyword type="function" name="xmlMemShow ()" link="libxml2-xmlmemory.html#xmlMemShow"/> + <keyword type="function" name="xmlMemSize ()" link="libxml2-xmlmemory.html#xmlMemSize"/> <keyword type="function" name="xmlMemStrdupLoc ()" link="libxml2-xmlmemory.html#xmlMemStrdupLoc"/> <keyword type="function" name="xmlMemUsed ()" link="libxml2-xmlmemory.html#xmlMemUsed"/> <keyword type="function" name="xmlMemoryDump ()" link="libxml2-xmlmemory.html#xmlMemoryDump"/> diff --git a/doc/libxml2-api.xml b/doc/libxml2-api.xml index b36fea54..303da576 100644 --- a/doc/libxml2-api.xml +++ b/doc/libxml2-api.xml @@ -885,6 +885,7 @@ <exports symbol='IS_PUBIDCHAR' type='macro'/> <exports symbol='IS_PUBIDCHAR_CH' type='macro'/> <exports symbol='XML_MAX_DICTIONARY_LIMIT' type='macro'/> + <exports symbol='XML_MAX_HUGE_LENGTH' type='macro'/> <exports symbol='XML_MAX_LOOKUP_LIMIT' type='macro'/> <exports symbol='XML_MAX_NAMELEN' type='macro'/> <exports symbol='XML_MAX_NAME_LENGTH' type='macro'/> @@ -2786,6 +2787,7 @@ <exports symbol='xmlMemRealloc' type='function'/> <exports symbol='xmlMemSetup' type='function'/> <exports symbol='xmlMemShow' type='function'/> + <exports symbol='xmlMemSize' type='function'/> <exports symbol='xmlMemStrdupLoc' type='function'/> <exports symbol='xmlMemUsed' type='function'/> <exports symbol='xmlMemoryDump' type='function'/> @@ -4133,6 +4135,9 @@ <macro name='XML_MAX_DICTIONARY_LIMIT' file='parserInternals'> <info>Maximum size allowed by the parser for a dictionary by default This is not a limitation of the parser but a safety boundary feature, use XML_PARSE_HUGE option to override it. Introduced in 2.9.0</info> </macro> + <macro name='XML_MAX_HUGE_LENGTH' file='parserInternals'> + <info>Maximum size allowed when XML_PARSE_HUGE is set.</info> + </macro> <macro name='XML_MAX_LOOKUP_LIMIT' file='parserInternals'> <info>Maximum size allowed by the parser for ahead lookup This is an upper boundary enforced by the parser to avoid bad behaviour on "unfriendly' content Introduced in 2.9.0</info> </macro> @@ -6129,9 +6134,8 @@ set at the end of parsing'/> <field name='nexte' type='struct _xmlEntity *' info=' unused'/> <field name='URI' type='const xmlChar *' info=' the full URI as computed'/> <field name='owner' type='int' info=' does the entity own the childrens'/> - <field name='checked' type='int' info=' was the entity content checked this is also used to count entities -* references done from that entity -* and if it contains '<''/> + <field name='flags' type='int' info=' various flags'/> + <field name='expandedSize' type='unsigned long' info=' expanded size'/> </struct> <typedef name='xmlEntityPtr' file='tree' type='xmlEntity *'/> <typedef name='xmlEntityType' file='entities' type='enum'/> @@ -6374,7 +6378,7 @@ actually an xmlCharEncoding'/> *'/> <field name='lastError' type='xmlError' info=''/> <field name='parseMode' type='xmlParserMode' info=' the parser mode'/> - <field name='nbentities' type='unsigned long' info=' number of entities references'/> + <field name='nbentities' type='unsigned long' info=' unused'/> <field name='sizeentities' type='unsigned long' info=' size of parsed entities for use by HTML non-recursive parser'/> <field name='nodeInfo' type='xmlParserNodeInfo *' info=' Current NodeInfo'/> <field name='nodeInfoNr' type='int' info=' Depth of the parsing stack'/> @@ -6383,6 +6387,8 @@ actually an xmlCharEncoding'/> <field name='input_id' type='int' info=' we need to label inputs'/> <field name='sizeentcopy' type='unsigned long' info=' volume of entity copy'/> <field name='endCheckState' type='int' info=' quote state for push parser'/> + <field name='nbErrors' type='unsigned short' info=' number of errors'/> + <field name='nbWarnings' type='unsigned short' info=' number of warnings'/> </struct> <typedef name='xmlParserCtxtPtr' file='tree' type='xmlParserCtxt *'/> <typedef name='xmlParserErrors' file='xmlerror' type='enum'/> @@ -6395,16 +6401,15 @@ actually an xmlCharEncoding'/> <field name='end' type='const xmlChar *' info=' end of the array to parse'/> <field name='length' type='int' info=' length if known'/> <field name='line' type='int' info=' Current line'/> - <field name='col' type='int' info='* 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. -*'/> + <field name='col' type='int' info=' Current column'/> <field name='consumed' type='unsigned long' info=' How many xmlChars already consumed'/> <field name='free' type='xmlParserInputDeallocate' info=' function to deallocate the base'/> <field name='encoding' type='const xmlChar *' info=' the encoding string for entity'/> <field name='version' type='const xmlChar *' info=' the version string for entity'/> <field name='standalone' type='int' info=' Was that entity marked standalone'/> <field name='id' type='int' info=' an unique identifier for the entity'/> + <field name='parentConsumed' type='unsigned long' info=' consumed bytes from parents'/> + <field name='entity' type='xmlEntityPtr' info=' entity, if any'/> </struct> <struct name='xmlParserInputBuffer' file='tree' type='struct _xmlParserInputBuffer'> <field name='context' type='void *' info=''/> @@ -6898,7 +6903,7 @@ Could we use @subtypes for this?'/> <field name='comp' type='xmlXPathCompExprPtr' info=' the precompiled expression'/> <field name='xptr' type='int' info=' it this an XPointer expression'/> <field name='ancestor' type='xmlNodePtr' info=' used for walking preceding axis'/> - <field name='valueFrame' type='int' info=' used to limit Pop on the stack'/> + <field name='valueFrame' type='int' info=' unused'/> </struct> <typedef name='xmlXPathParserContextPtr' file='xpath' type='xmlXPathParserContext *'/> <struct name='xmlXPathType' file='xpath' type='struct _xmlXPathType'> @@ -7880,12 +7885,12 @@ Could we use @subtypes for this?'/> <arg name='inlen' type='int *' info='the length of @in'/> </function> <function name='namePop' file='parserInternals' module='parser'> - <info>Pops the top element name from the name stack</info> + <info>DEPRECATED: Internal function, do not use. Pops the top element name from the name stack</info> <return type='const xmlChar *' info='the name just removed'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='an XML parser context'/> </function> <function name='namePush' file='parserInternals' module='parser'> - <info>Pushes a new element name on top of the name stack</info> + <info>DEPRECATED: Internal function, do not use. Pushes a new element name on top of the name stack</info> <return type='int' info='-1 in case of error, the index in the stack otherwise'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='an XML parser context'/> <arg name='value' type='const xmlChar *' info='the element name'/> @@ -7899,12 +7904,12 @@ Could we use @subtypes for this?'/> <arg name='prefix' type='const xmlChar *' info='the namespace prefix'/> </function> <function name='nodePop' file='parserInternals' module='parser'> - <info>Pops the top element node from the node stack</info> + <info>DEPRECATED: Internal function, do not use. Pops the top element node from the node stack</info> <return type='xmlNodePtr' info='the node just removed'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='an XML parser context'/> </function> <function name='nodePush' file='parserInternals' module='parser'> - <info>Pushes a new element node on top of the node stack</info> + <info>DEPRECATED: Internal function, do not use. Pushes a new element node on top of the node stack</info> <return type='int' info='-1 in case of error, the index in the stack otherwise'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='an XML parser context'/> <arg name='value' type='xmlNodePtr' info='the element node'/> @@ -8056,7 +8061,7 @@ Could we use @subtypes for this?'/> <function name='valuePush' file='xpathInternals' module='xpath'> <cond>defined(LIBXML_XPATH_ENABLED)</cond> <info>Pushes a new XPath object on top of the value stack. If value is NULL, a memory error is recorded in the parser context.</info> - <return type='int' info='the number of items on the value stack, or -1 in case of error.'/> + <return type='int' info='the number of items on the value stack, or -1 in case of error. The object is destroyed in case of error.'/> <arg name='ctxt' type='xmlXPathParserContextPtr' info='an XPath evaluation context'/> <arg name='value' type='xmlXPathObjectPtr' info='the XPath object'/> </function> @@ -8847,8 +8852,8 @@ Could we use @subtypes for this?'/> <arg name='handler' type='xmlCharEncodingHandler *' info='char encoding transformation data structure'/> </function> <function name='xmlCharEncFirstLine' file='encoding' module='encoding'> - <info>Front-end for the encoding handler input function, but handle only the very first line, i.e. limit itself to 45 chars.</info> - <return type='int' info='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'/> + <info>DEPERECATED: Don't use.</info> + <return type='int' info=''/> <arg name='handler' type='xmlCharEncodingHandler *' info='char encoding transformation data structure'/> <arg name='out' type='xmlBufferPtr' info='an xmlBuffer for the output.'/> <arg name='in' type='xmlBufferPtr' info='an xmlBuffer for the input'/> @@ -8912,7 +8917,7 @@ Could we use @subtypes for this?'/> <arg name='ret' type='xmlParserInputPtr' info='an XML parser input'/> </function> <function name='xmlCheckLanguageID' file='parserInternals' module='parser'> - <info>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])+ The current REC reference the successors of RFC 1766, currently 5646 http://www.rfc-editor.org/rfc/rfc5646.txt langtag = language ["-" script] ["-" region] *("-" variant) *("-" extension) ["-" privateuse] language = 2*3ALPHA ; shortest ISO 639 code ["-" extlang] ; sometimes followed by ; extended language subtags / 4ALPHA ; or reserved for future use / 5*8ALPHA ; or registered language subtag extlang = 3ALPHA ; selected ISO 639 codes *2("-" 3ALPHA) ; permanently reserved script = 4ALPHA ; ISO 15924 code region = 2ALPHA ; ISO 3166-1 code / 3DIGIT ; UN M.49 code variant = 5*8alphanum ; registered variants / (DIGIT 3alphanum) extension = singleton 1*("-" (2*8alphanum)) ; Single alphanumerics ; "x" reserved for private use singleton = DIGIT ; 0 - 9 / %x41-57 ; A - W / %x59-5A ; Y - Z / %x61-77 ; a - w / %x79-7A ; y - z it sounds right to still allow Irregular i-xxx IANA and user codes too The parser below doesn't try to cope with extension or privateuse that could be added but that's not interoperable anyway</info> + <info>DEPRECATED: Internal function, do not use. 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])+ The current REC reference the successors of RFC 1766, currently 5646 http://www.rfc-editor.org/rfc/rfc5646.txt langtag = language ["-" script] ["-" region] *("-" variant) *("-" extension) ["-" privateuse] language = 2*3ALPHA ; shortest ISO 639 code ["-" extlang] ; sometimes followed by ; extended language subtags / 4ALPHA ; or reserved for future use / 5*8ALPHA ; or registered language subtag extlang = 3ALPHA ; selected ISO 639 codes *2("-" 3ALPHA) ; permanently reserved script = 4ALPHA ; ISO 15924 code region = 2ALPHA ; ISO 3166-1 code / 3DIGIT ; UN M.49 code variant = 5*8alphanum ; registered variants / (DIGIT 3alphanum) extension = singleton 1*("-" (2*8alphanum)) ; Single alphanumerics ; "x" reserved for private use singleton = DIGIT ; 0 - 9 / %x41-57 ; A - W / %x59-5A ; Y - Z / %x61-77 ; a - w / %x79-7A ; y - z it sounds right to still allow Irregular i-xxx IANA and user codes too The parser below doesn't try to cope with extension or privateuse that could be added but that's not interoperable anyway</info> <return type='int' info='1 if correct 0 otherwise'/> <arg name='lang' type='const xmlChar *' info='pointer to the string value'/> </function> @@ -9240,7 +9245,7 @@ Could we use @subtypes for this?'/> <arg name='options' type='int' info='a combination of xmlParserOption'/> </function> <function name='xmlCurrentChar' file='parserInternals' module='parserInternals'> - <info>The current char value, if using UTF-8 this may actually span multiple bytes in the input buffer. Implement the end of line normalization: 2.11 End-of-Line Handling Wherever an external parsed entity or the literal entity value of an internal parsed entity contains either the literal two-character sequence "#xD#xA" or a standalone literal #xD, an XML processor must pass to the application the single character #xA. This behavior can conveniently be produced by normalizing all line breaks to #xA on input, before parsing.)</info> + <info>DEPRECATED: Internal function, do not use. The current char value, if using UTF-8 this may actually span multiple bytes in the input buffer. Implement the end of line normalization: 2.11 End-of-Line Handling Wherever an external parsed entity or the literal entity value of an internal parsed entity contains either the literal two-character sequence "#xD#xA" or a standalone literal #xD, an XML processor must pass to the application the single character #xA. This behavior can conveniently be produced by normalizing all line breaks to #xA on input, before parsing.)</info> <return type='int' info='the current char value and its length'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='the XML parser context'/> <arg name='len' type='int *' info='pointer to the length of the char read'/> @@ -10966,6 +10971,11 @@ Could we use @subtypes for this?'/> <arg name='fp' type='FILE *' info='a FILE descriptor used as the output file'/> <arg name='nr' type='int' info='number of entries to dump'/> </function> + <function name='xmlMemSize' file='xmlmemory' module='xmlmemory'> + <info></info> + <return type='size_t' info='the size of a memory allocation.'/> + <arg name='ptr' type='void *' info='pointer to the memory allocation'/> + </function> <function name='xmlMemStrdupLoc' file='xmlmemory' module='xmlmemory'> <info>a strdup() equivalent, with logging of the allocation info.</info> <return type='char *' info='a pointer to the new string or NULL if allocation error occurred.'/> @@ -11454,7 +11464,7 @@ Could we use @subtypes for this?'/> <arg name='content' type='const xmlChar *' info='the entity content'/> </function> <function name='xmlNewEntityInputStream' file='parserInternals' module='parserInternals'> - <info>Create a new input stream based on an xmlEntityPtr</info> + <info>DEPRECATED: Internal function, do not use. Create a new input stream based on an xmlEntityPtr</info> <return type='xmlParserInputPtr' info='the new input stream or NULL'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='an XML parser context'/> <arg name='entity' type='xmlEntityPtr' info='an Entity pointer'/> @@ -11645,7 +11655,7 @@ Could we use @subtypes for this?'/> <return type='xmlValidCtxtPtr' info='NULL if not, otherwise the new validation context structure'/> </function> <function name='xmlNextChar' file='parserInternals' module='parserInternals'> - <info>Skip to the next char input char.</info> + <info>DEPRECATED: Internal function, do not use. Skip to the next char input char.</info> <return type='void'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='the XML parser context'/> </function> @@ -12329,7 +12339,7 @@ Could we use @subtypes for this?'/> <arg name='filename' type='const char *' info='the path to a file'/> </function> <function name='xmlParserHandlePEReference' file='parserInternals' module='parser'> - <info>[69] PEReference ::= '%' Name ';' [ WFC: No Recursion ] A parsed entity must not contain a recursive reference to itself, either directly or indirectly. [ WFC: Entity Declared ] In a document without any DTD, a document with only an internal DTD subset which contains no parameter entity references, or a document with "standalone='yes'", ... ... The declaration of a parameter entity must precede any reference to it... [ VC: Entity Declared ] In a document with an external subset or external parameter entities with "standalone='no'", ... ... The declaration of a parameter entity must precede any reference to it... [ WFC: In DTD ] Parameter-entity references may only appear in the DTD. NOTE: misleading but this is handled. A PEReference may have been detected in the current input stream the handling is done accordingly to http://www.w3.org/TR/REC-xml#entproc i.e. - Included in literal in entity values - Included as Parameter Entity reference within DTDs</info> + <info>DEPRECATED: Internal function, do not use. [69] PEReference ::= '%' Name ';' [ WFC: No Recursion ] A parsed entity must not contain a recursive reference to itself, either directly or indirectly. [ WFC: Entity Declared ] In a document without any DTD, a document with only an internal DTD subset which contains no parameter entity references, or a document with "standalone='yes'", ... ... The declaration of a parameter entity must precede any reference to it... [ VC: Entity Declared ] In a document with an external subset or external parameter entities with "standalone='no'", ... ... The declaration of a parameter entity must precede any reference to it... [ WFC: In DTD ] Parameter-entity references may only appear in the DTD. NOTE: misleading but this is handled. A PEReference may have been detected in the current input stream the handling is done accordingly to http://www.w3.org/TR/REC-xml#entproc i.e. - Included in literal in entity values - Included as Parameter Entity reference within DTDs</info> <return type='void'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/> </function> @@ -12427,7 +12437,7 @@ Could we use @subtypes for this?'/> <arg name='len' type='int' info='an indicative size for the lookahead'/> </function> <function name='xmlParserInputShrink' file='parserInternals' module='parserInternals'> - <info>This function removes used input for the parser.</info> + <info>DEPRECATED: Don't use. This function removes used input for the parser.</info> <return type='void'/> <arg name='in' type='xmlParserInputPtr' info='an XML parser input'/> </function> @@ -13566,7 +13576,7 @@ Could we use @subtypes for this?'/> </function> <function name='xmlSchemaCleanupTypes' file='xmlschemastypes' module='xmlschemastypes'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info>DEPRECATED: This function will be made private. Call xmlCleanupParser to free global state but see the warnings there. xmlCleanupParser should be only called once at program exit. In most cases, you don't have call cleanup functions at all. Cleanup the default XML Schemas type library</info> + <info>DEPRECATED: This function will be made private. Call xmlCleanupParser to free global state but see the warnings there. xmlCleanupParser should be only called once at program exit. In most cases, you don't have to call cleanup functions at all. Cleanup the default XML Schemas type library</info> <return type='void'/> </function> <function name='xmlSchemaCollapseString' file='xmlschemastypes' module='xmlschemastypes'> @@ -13713,7 +13723,7 @@ Could we use @subtypes for this?'/> <function name='xmlSchemaInitTypes' file='xmlschemastypes' module='xmlschemastypes'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> <info>Initialize the default XML Schemas type library</info> - <return type='void'/> + <return type='int' info='0 on success, -1 on error.'/> </function> <function name='xmlSchemaIsBuiltInTypeFacet' file='xmlschemastypes' module='xmlschemastypes'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> @@ -14349,7 +14359,7 @@ Could we use @subtypes for this?'/> <arg name='node2' type='xmlNodePtr' info='unused'/> </function> <function name='xmlSkipBlankChars' file='parserInternals' module='parser'> - <info>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.</info> + <info>DEPRECATED: Internal function, do not use. 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.</info> <return type='int' info='the number of space chars skipped'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='the XML parser context'/> </function> @@ -14500,14 +14510,14 @@ Could we use @subtypes for this?'/> <arg name='streamCtxt' type='xmlStreamCtxtPtr' info='the stream context'/> </function> <function name='xmlStringCurrentChar' file='parserInternals' module='parserInternals'> - <info>The current char value, if using UTF-8 this may actually span multiple bytes in the input buffer.</info> + <info>DEPRECATED: Internal function, do not use. The current char value, if using UTF-8 this may actually span multiple bytes in the input buffer.</info> <return type='int' info='the current char value and its length'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='the XML parser context'/> <arg name='cur' type='const xmlChar *' info='pointer to the beginning of the char'/> <arg name='len' type='int *' info='pointer to the length of the char read'/> </function> <function name='xmlStringDecodeEntities' file='parserInternals' module='parser'> - <info>Takes a entity string content and process to do the adequate substitutions. [67] Reference ::= EntityRef | CharRef [69] PEReference ::= '%' Name ';'</info> + <info>DEPRECATED: Internal function, don't use. Takes a entity string content and process to do the adequate substitutions. [67] Reference ::= EntityRef | CharRef [69] PEReference ::= '%' Name ';'</info> <return type='xmlChar *' info='A newly allocated string with the substitution done. The caller must deallocate it !'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/> <arg name='str' type='const xmlChar *' info='the input string'/> @@ -14523,7 +14533,7 @@ Could we use @subtypes for this?'/> <arg name='value' type='const xmlChar *' info='the value of the attribute'/> </function> <function name='xmlStringLenDecodeEntities' file='parserInternals' module='parser'> - <info>Takes a entity string content and process to do the adequate substitutions. [67] Reference ::= EntityRef | CharRef [69] PEReference ::= '%' Name ';'</info> + <info>DEPRECATED: Internal function, don't use. Takes a entity string content and process to do the adequate substitutions. [67] Reference ::= EntityRef | CharRef [69] PEReference ::= '%' Name ';'</info> <return type='xmlChar *' info='A newly allocated string with the substitution done. The caller must deallocate it !'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/> <arg name='str' type='const xmlChar *' info='the input string'/> @@ -14610,7 +14620,7 @@ Could we use @subtypes for this?'/> <arg name='enc' type='xmlCharEncoding' info='the encoding value (number)'/> </function> <function name='xmlSwitchInputEncoding' file='parserInternals' module='parserInternals'> - <info>DEPRECATED: Use xmlSwitchToEncoding change the input functions when discovering the character encoding of a given entity.</info> + <info>change the input functions when discovering the character encoding of a given entity.</info> <return type='int' info='0 in case of success, -1 otherwise'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/> <arg name='input' type='xmlParserInputPtr' info='the input stream'/> @@ -16979,7 +16989,7 @@ Could we use @subtypes for this?'/> <return type='int' info='1 if valid or 0 otherwise'/> <arg name='ctxt' type='xmlValidCtxtPtr' info='the validation context'/> <arg name='doc' type='xmlDocPtr' info='a document instance'/> - <arg name='elem' type='xmlNodePtr' info='an element instance'/> + <arg name='root' type='xmlNodePtr' info=''/> </function> <function name='xmlValidateElementDecl' file='valid' module='valid'> <cond>defined(LIBXML_VALID_ENABLED)</cond> @@ -17901,7 +17911,7 @@ Could we use @subtypes for this?'/> <function name='xmlXPathNodeSetMerge' file='xpathInternals' module='xpath'> <cond>defined(LIBXML_XPATH_ENABLED)</cond> <info>Merges two nodesets, all nodes from @val2 are added to @val1 if @val1 is NULL, a new set is created and copied from @val2</info> - <return type='xmlNodeSetPtr' info='@val1 once extended or NULL in case of error.'/> + <return type='xmlNodeSetPtr' info='@val1 once extended or NULL in case of error. Frees @val1 in case of error.'/> <arg name='val1' type='xmlNodeSetPtr' info='the first NodeSet or NULL'/> <arg name='val2' type='xmlNodeSetPtr' info='the second NodeSet'/> </function> @@ -18262,13 +18272,13 @@ Could we use @subtypes for this?'/> <function name='xmlXPathWrapNodeSet' file='xpathInternals' module='xpath'> <cond>defined(LIBXML_XPATH_ENABLED)</cond> <info>Wrap the Nodeset @val in a new xmlXPathObjectPtr</info> - <return type='xmlXPathObjectPtr' info='the newly created object.'/> + <return type='xmlXPathObjectPtr' info='the newly created object. In case of error the node set is destroyed and NULL is returned.'/> <arg name='val' type='xmlNodeSetPtr' info='the NodePtr value'/> </function> <function name='xmlXPathWrapString' file='xpathInternals' module='xpath'> <cond>defined(LIBXML_XPATH_ENABLED)</cond> <info>Wraps the @val string into an XPath object.</info> - <return type='xmlXPathObjectPtr' info='the newly created object.'/> + <return type='xmlXPathObjectPtr' info='the newly created object. Frees @val in case of error.'/> <arg name='val' type='xmlChar *' info='the xmlChar * value'/> </function> <function name='xmlXPatherror' file='xpathInternals' module='xpath'> diff --git a/doc/xmlcatalog.1 b/doc/xmlcatalog.1 index 5605bea8..15ab9f73 100644 --- a/doc/xmlcatalog.1 +++ b/doc/xmlcatalog.1 @@ -1,13 +1,13 @@ '\" t .\" Title: xmlcatalog .\" Author: John Fleck <jfleck@inkstain.net> -.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 08/17/2022 +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 04/26/2023 .\" Manual: xmlcatalog Manual .\" Source: libxml2 .\" Language: English .\" -.TH "XMLCATALOG" "1" "08/17/2022" "libxml2" "xmlcatalog Manual" +.TH "XMLCATALOG" "1" "04/26/2023" "libxml2" "xmlcatalog Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -31,7 +31,7 @@ xmlcatalog \- Command line tool to parse and manipulate XML or SGML catalog files\&. .SH "SYNOPSIS" .HP \w'\fBxmlcatalog\fR\ 'u -\fBxmlcatalog\fR [\fB\-\-sgml\fR | \fB\-\-shell\fR | \fB\-\-create\fR | \fB\-\-del\ \fR\fB\fIVALUE(S)\fR\fR | [\ \fB\-\-add\ \fR\fB\fITYPE\fR\fR\fB\ \fR\fB\fIORIG\fR\fR\fB\ \fR\fB\fIREPLACE\fR\fR\fB\ \fR\ |\ \fB\-\-add\ \fR\fB\fIFILENAME\fR\fR] | \fB\-\-noout\fR | \fB\-\-no\-super\-update\fR | [\fB\-v\fR\ |\ \fB\-\-verbose\fR]] {\fICATALOGFILE\fR} {\fIENTITIES\fR...} +\fBxmlcatalog\fR [\fB\-\-sgml\fR | \fB\-\-shell\fR | \fB\-\-convert\fR | \fB\-\-create\fR | \fB\-\-del\ \fR\fB\fIVALUE(S)\fR\fR | [\ \fB\-\-add\ \fR\fB\fITYPE\fR\fR\fB\ \fR\fB\fIORIG\fR\fR\fB\ \fR\fB\fIREPLACE\fR\fR\fB\ \fR\ |\ \fB\-\-add\ \fR\fB\fIFILENAME\fR\fR] | \fB\-\-noout\fR | \fB\-\-no\-super\-update\fR | [\fB\-v\fR\ |\ \fB\-\-verbose\fR]] {\fICATALOGFILE\fR} {\fIENTITIES\fR...} .SH "DESCRIPTION" .PP \fBxmlcatalog\fR @@ -91,6 +91,11 @@ SGML catalog files\&. .RE .PP +\fB\-\-convert\fR +.RS 4 +Convert SGML catalog to XML\&. +.RE +.PP \fB\-\-create\fR .RS 4 Create a new @@ -245,9 +250,10 @@ Execute a Formal Public Identifier lookup of the catalog entry for XML catalog behavior can be changed by redirecting queries to the user\*(Aqs own set of catalogs\&. This can be done by setting the \fBXML_CATALOG_FILES\fR -environment variable to a space\-separated list of catalogs\&. Use percent\-encoding to escape spaces or other characters\&. An empty variable should deactivate loading the default +environment variable to a space\-separated list of catalogs\&. Use percent\-encoding to escape spaces or other characters\&. An empty variable should deactivate loading the default catalog from /etc/xml/catalog -catalog\&. +or, more specifically, +${sysconfdir}/xml/catalog\&. .RE .SH "DIAGNOSTICS" .PP diff --git a/doc/xmlcatalog.html b/doc/xmlcatalog.html index ae2ebabd..01ff8640 100644 --- a/doc/xmlcatalog.html +++ b/doc/xmlcatalog.html @@ -1,140 +1,144 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xmlcatalog</title><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"><a name="idm1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xmlcatalog — - Command line tool to parse and manipulate <acronym class="acronym">XML</acronym> - or <acronym class="acronym">SGML</acronym> catalog files. - </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xmlcatalog</code> [ <code class="option">--sgml</code> | <code class="option">--shell</code> | <code class="option">--create</code> | <code class="option">--del <em class="replaceable"><code>VALUE(S)</code></em></code> | - [ - <code class="option">--add - <em class="replaceable"><code>TYPE</code></em> - <em class="replaceable"><code>ORIG</code></em> - <em class="replaceable"><code>REPLACE</code></em> - </code> - | <code class="option">--add <em class="replaceable"><code>FILENAME</code></em></code> ] - | <code class="option">--noout</code> | <code class="option">--no-super-update</code> | - [ <code class="option">-v</code> | <code class="option">--verbose</code> ] - ] {<em class="replaceable"><code>CATALOGFILE</code></em>} {<em class="replaceable"><code>ENTITIES</code></em>...}</p></div></div><div class="refsect1"><a name="description"></a><h2>DESCRIPTION</h2><p> - <span class="command"><strong>xmlcatalog</strong></span> is a command line application allowing users to monitor and - manipulate <acronym class="acronym">XML</acronym> and <acronym class="acronym">SGML</acronym> catalogs. It - is included in <span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span>. - </p><p> - Its functions can be invoked from a single command from the command line, - or it can perform multiple functions in interactive mode. It can operate - on both <acronym class="acronym">XML</acronym> and <acronym class="acronym">SGML</acronym> files. - </p></div><div class="refsect1"><a name="options"></a><h2>OPTIONS</h2><p> - <span class="command"><strong>xmlcatalog</strong></span> accepts the following options (in alphabetical order): - </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> - <code class="option">--add - <em class="replaceable"><code>TYPE</code></em> - <em class="replaceable"><code>ORIG</code></em> - <em class="replaceable"><code>REPLACE</code></em> - </code> - </span></dt><dd><p> - Add an entry to <code class="filename">CATALOGFILE</code>. <em class="replaceable"><code>TYPE</code></em> - indicates the type of entry. Possible types are: <span class="simplelist"><em class="parameter"><code>public</code></em>, <em class="parameter"><code>system</code></em>, <em class="parameter"><code>uri</code></em>, <em class="parameter"><code>rewriteSystem</code></em>, <em class="parameter"><code>rewriteURI</code></em>, <em class="parameter"><code>delegatePublic</code></em>, <em class="parameter"><code>delegateSystem</code></em>, <em class="parameter"><code>delegateURI</code></em>, <em class="parameter"><code>nextCatalog</code></em></span>. <em class="replaceable"><code>ORIG</code></em> is the original - reference to be replaced, and <em class="replaceable"><code>REPLACE</code></em> - is the <acronym class="acronym">URI</acronym> of the replacement entity to be - used. The <code class="option">--add</code> option will not overwrite - <code class="filename">CATALOGFILE</code>, outputting - to <code class="filename">stdout</code>, unless - <code class="option">--noout</code> is used. The <code class="option">--add</code> will - always take three parameters even if some of the <acronym class="acronym">XML</acronym> - catalog constructs will have only a single argument. - </p></dd><dt><span class="term"><code class="option">--add <em class="replaceable"><code>FILENAME</code></em></code></span></dt><dd><p> - If the <code class="option">--add</code> option is used following - the <code class="option">--sgml</code> option, only a single argument, - a <em class="replaceable"><code>FILENAME</code></em>, is used. This is used to add - the name of a catalog file to an <acronym class="acronym">SGML</acronym> supercatalog, - a file that contains references to other included <acronym class="acronym">SGML</acronym> - catalog files. - </p></dd><dt><span class="term"><code class="option">--create</code></span></dt><dd><p> - Create a new <acronym class="acronym">XML</acronym> catalog. Outputs - to <code class="filename">stdout</code>, - ignoring <em class="replaceable"><code>filename</code></em> unless <code class="option">--noout</code> is - used, in which case it creates a new catalog - file <em class="replaceable"><code>filename</code></em>. - </p></dd><dt><span class="term"><code class="option">--del <em class="replaceable"><code>VALUE(S)</code></em></code></span></dt><dd><p> - Remove entries from <em class="replaceable"><code>CATALOGFILE</code></em> - matching <em class="replaceable"><code>VALUE(S)</code></em>. The <code class="option">--del</code> - option will not overwrite <em class="replaceable"><code>CATALOGFILE</code></em>, - outputting to <code class="filename">stdout</code>, - unless <code class="option">--noout</code> is used. - </p></dd><dt><span class="term"><code class="option">--noout</code></span></dt><dd><p> - Save output to the named file rather than outputting - to <code class="filename">stdout</code>. - </p></dd><dt><span class="term"><code class="option">--no-super-update</code></span></dt><dd><p> - Do not update the <acronym class="acronym">SGML</acronym> super catalog. - </p></dd><dt><span class="term"><code class="option">--shell</code></span></dt><dd><p> - Run a shell allowing interactive queries on catalog - file <em class="replaceable"><code>CATALOGFILE</code></em>. For the set of available - commands see <a class="xref" href="#shell" title="SHELL COMMANDS">the section called “SHELL COMMANDS”</a>. - </p></dd><dt><span class="term"><code class="option">--sgml</code></span></dt><dd><p> - Uses <acronym class="acronym">SGML</acronym> super catalogs for <code class="option">--add</code> - and <code class="option">--del</code> options. - </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p>Output debugging information.</p></dd></dl></div><p> - Invoking <span class="command"><strong>xmlcatalog</strong></span> non-interactively without a designated action - (imposed with options like <code class="option">--add</code>) will result in a lookup - of the catalog entry for <em class="replaceable"><code>ENTITIES</code></em> in the - catalog denoted with <em class="replaceable"><code>CATALOGFILE</code></em>. The - corresponding entries will be output to the command line. This mode of - operation, together with <code class="option">--shell</code> mode and non-modifying - (i.e. without <code class="option">--noout</code>) direct actions, allows for - a special shortcut of the void <em class="replaceable"><code>CATALOGFILE</code></em> - specification (possibly expressed as "" in the shell - environment) appointing the default system catalog. That simplifies the - handling when its exact location is irrelevant but the respective built-in - still needs to be consulted. - </p></div><div class="refsect1"><a name="shell"></a><h2>SHELL COMMANDS</h2><p> - Invoking <span class="command"><strong>xmlcatalog</strong></span> with - the <code class="option">--shell <em class="replaceable"><code>CATALOGFILE</code></em></code> option opens - a command line shell allowing interactive access to the catalog file - identified by <em class="replaceable"><code>CATALOGFILE</code></em>. Invoking the shell - provides a command line prompt after which the following commands (described in - alphabetical order) can be entered. - </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> - <code class="option">add - <em class="replaceable"><code>TYPE</code></em> - <em class="replaceable"><code>ORIG</code></em> - <em class="replaceable"><code>REPLACE</code></em> - </code> - </span></dt><dd><p> - Add an entry to the catalog file. <em class="replaceable"><code>TYPE</code></em> - indicates the type of entry. Possible types are: <span class="simplelist"><em class="parameter"><code>public</code></em>, <em class="parameter"><code>system</code></em>, <em class="parameter"><code>uri</code></em>, <em class="parameter"><code>rewriteSystem</code></em>, <em class="parameter"><code>rewriteURI</code></em>, <em class="parameter"><code>delegatePublic</code></em>, <em class="parameter"><code>delegateSystem</code></em>, <em class="parameter"><code>delegateURI</code></em>, <em class="parameter"><code>nextCatalog</code></em></span>. <em class="replaceable"><code>ORIG</code></em> is the original - reference to be replaced, and <em class="replaceable"><code>REPLACE</code></em> - is the <acronym class="acronym">URI</acronym> of the replacement entity to be - used. The <code class="option">--add</code> option will not overwrite - <code class="filename">CATALOGFILE</code>, outputting - to <code class="filename">stdout</code>, unless - <code class="option">--noout</code> is used. The <code class="option">--add</code> will - always take three parameters even if some of the <acronym class="acronym">XML</acronym> - catalog constructs will have only a single argument. - </p></dd><dt><span class="term"><code class="option">debug</code></span></dt><dd><p> - Print debugging statements showing the steps <span class="command"><strong>xmlcatalog</strong></span> is executing. - </p></dd><dt><span class="term"><code class="option">del <em class="replaceable"><code>VALUE(S)</code></em></code></span></dt><dd><p> - Remove the catalog entry corresponding to <em class="replaceable"><code>VALUE(S)</code></em>. - </p></dd><dt><span class="term"><code class="option">dump</code></span></dt><dd><p>Print the current catalog.</p></dd><dt><span class="term"><code class="option">exit</code></span></dt><dd><p>Quit the shell.</p></dd><dt><span class="term"><code class="option">public <em class="replaceable"><code>PUBLIC-ID</code></em></code></span></dt><dd><p> - Execute a Formal Public Identifier lookup of the catalog entry - for <em class="replaceable"><code>PUBLIC-ID</code></em>. The corresponding entry will be - output to the command line. - </p></dd><dt><span class="term"><code class="option">quiet</code></span></dt><dd><p>Stop printing debugging statements.</p></dd><dt><span class="term"><code class="option">system <em class="replaceable"><code>SYSTEM-ID</code></em></code></span></dt><dd><p> - Execute a Formal Public Identifier lookup of the catalog entry - for <em class="replaceable"><code>SYSTEM-ID</code></em>. The corresponding entry will be - output to the command line. - </p></dd></dl></div></div><div class="refsect1"><a name="environment"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="envar">XML_CATALOG_FILES</code></span></dt><dd><p><acronym class="acronym">XML</acronym> catalog behavior can be changed by redirecting - queries to the user's own set of catalogs. This can be done by setting - the <code class="envar">XML_CATALOG_FILES</code> environment variable to a space-separated - list of catalogs. Use percent-encoding to escape spaces or other characters. - An empty variable should deactivate loading the default <code class="filename">/etc/xml/catalog</code> catalog. - </p></dd></dl></div></div><div class="refsect1"><a name="diagnostics"></a><h2>DIAGNOSTICS</h2><p> - <span class="command"><strong>xmlcatalog</strong></span> return codes provide information that can be used when - calling it from scripts. - </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="errorcode">0</span></span></dt><dd><p>No error</p></dd><dt><span class="term"><span class="errorcode">1</span></span></dt><dd><p>Failed to remove an entry from the catalog</p></dd><dt><span class="term"><span class="errorcode">2</span></span></dt><dd><p>Failed to save to the catalog, check file permissions</p></dd><dt><span class="term"><span class="errorcode">3</span></span></dt><dd><p>Failed to add an entry to the catalog</p></dd><dt><span class="term"><span class="errorcode">4</span></span></dt><dd><p>Failed to look up an entry in the catalog</p></dd></dl></div></div><div class="refsect1"><a name="seealso"></a><h2>SEE ALSO</h2><p><span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span> - </p><p> - More information can be found at - </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span> web page <a class="ulink" href="https://gitlab.gnome.org/GNOME/libxml2" target="_top">https://gitlab.gnome.org/GNOME/libxml2</a> - </p></li><li class="listitem"><p><span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span> catalog support web page - at <a class="ulink" href="https://gitlab.gnome.org/GNOME/libxml2/-/wikis/Catalog-support" target="_top">https://gitlab.gnome.org/GNOME/libxml2/-/wikis/Catalog-support</a> - </p></li><li class="listitem"><p>James Clark's <acronym class="acronym">SGML</acronym> catalog - page <a class="ulink" href="http://www.jclark.com/sp/catalog.htm" target="_top">http://www.jclark.com/sp/catalog.htm</a> - </p></li><li class="listitem"><p><acronym class="acronym">OASIS</acronym> <acronym class="acronym">XML</acronym> catalog specification - <a class="ulink" href="http://www.oasis-open.org/committees/entity/spec.html" target="_top">http://www.oasis-open.org/committees/entity/spec.html</a> - </p></li></ul></div><p> - </p></div></div></body></html> +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xmlcatalog</title><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"><a name="idm1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xmlcatalog — + Command line tool to parse and manipulate <acronym class="acronym">XML</acronym> + or <acronym class="acronym">SGML</acronym> catalog files. + </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xmlcatalog</code> [ <code class="option">--sgml</code> | <code class="option">--shell</code> | <code class="option">--convert</code> | <code class="option">--create</code> | <code class="option">--del <em class="replaceable"><code>VALUE(S)</code></em></code> | + [ + <code class="option">--add + <em class="replaceable"><code>TYPE</code></em> + <em class="replaceable"><code>ORIG</code></em> + <em class="replaceable"><code>REPLACE</code></em> + </code> + | <code class="option">--add <em class="replaceable"><code>FILENAME</code></em></code> ] + | <code class="option">--noout</code> | <code class="option">--no-super-update</code> | + [ <code class="option">-v</code> | <code class="option">--verbose</code> ] + ] {<em class="replaceable"><code>CATALOGFILE</code></em>} {<em class="replaceable"><code>ENTITIES</code></em>...}</p></div></div><div class="refsect1"><a name="description"></a><h2>DESCRIPTION</h2><p> + <span class="command"><strong>xmlcatalog</strong></span> is a command line application allowing users to monitor and + manipulate <acronym class="acronym">XML</acronym> and <acronym class="acronym">SGML</acronym> catalogs. It + is included in <span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span>. + </p><p> + Its functions can be invoked from a single command from the command line, + or it can perform multiple functions in interactive mode. It can operate + on both <acronym class="acronym">XML</acronym> and <acronym class="acronym">SGML</acronym> files. + </p></div><div class="refsect1"><a name="options"></a><h2>OPTIONS</h2><p> + <span class="command"><strong>xmlcatalog</strong></span> accepts the following options (in alphabetical order): + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> + <code class="option">--add + <em class="replaceable"><code>TYPE</code></em> + <em class="replaceable"><code>ORIG</code></em> + <em class="replaceable"><code>REPLACE</code></em> + </code> + </span></dt><dd><p> + Add an entry to <code class="filename">CATALOGFILE</code>. <em class="replaceable"><code>TYPE</code></em> + indicates the type of entry. Possible types are: <span class="simplelist"><em class="parameter"><code>public</code></em>, <em class="parameter"><code>system</code></em>, <em class="parameter"><code>uri</code></em>, <em class="parameter"><code>rewriteSystem</code></em>, <em class="parameter"><code>rewriteURI</code></em>, <em class="parameter"><code>delegatePublic</code></em>, <em class="parameter"><code>delegateSystem</code></em>, <em class="parameter"><code>delegateURI</code></em>, <em class="parameter"><code>nextCatalog</code></em></span>. <em class="replaceable"><code>ORIG</code></em> is the original + reference to be replaced, and <em class="replaceable"><code>REPLACE</code></em> + is the <acronym class="acronym">URI</acronym> of the replacement entity to be + used. The <code class="option">--add</code> option will not overwrite + <code class="filename">CATALOGFILE</code>, outputting + to <code class="filename">stdout</code>, unless + <code class="option">--noout</code> is used. The <code class="option">--add</code> will + always take three parameters even if some of the <acronym class="acronym">XML</acronym> + catalog constructs will have only a single argument. + </p></dd><dt><span class="term"><code class="option">--add <em class="replaceable"><code>FILENAME</code></em></code></span></dt><dd><p> + If the <code class="option">--add</code> option is used following + the <code class="option">--sgml</code> option, only a single argument, + a <em class="replaceable"><code>FILENAME</code></em>, is used. This is used to add + the name of a catalog file to an <acronym class="acronym">SGML</acronym> supercatalog, + a file that contains references to other included <acronym class="acronym">SGML</acronym> + catalog files. + </p></dd><dt><span class="term"><code class="option">--convert</code></span></dt><dd><p> + Convert SGML catalog to XML. + </p></dd><dt><span class="term"><code class="option">--create</code></span></dt><dd><p> + Create a new <acronym class="acronym">XML</acronym> catalog. Outputs + to <code class="filename">stdout</code>, + ignoring <em class="replaceable"><code>filename</code></em> unless <code class="option">--noout</code> is + used, in which case it creates a new catalog + file <em class="replaceable"><code>filename</code></em>. + </p></dd><dt><span class="term"><code class="option">--del <em class="replaceable"><code>VALUE(S)</code></em></code></span></dt><dd><p> + Remove entries from <em class="replaceable"><code>CATALOGFILE</code></em> + matching <em class="replaceable"><code>VALUE(S)</code></em>. The <code class="option">--del</code> + option will not overwrite <em class="replaceable"><code>CATALOGFILE</code></em>, + outputting to <code class="filename">stdout</code>, + unless <code class="option">--noout</code> is used. + </p></dd><dt><span class="term"><code class="option">--noout</code></span></dt><dd><p> + Save output to the named file rather than outputting + to <code class="filename">stdout</code>. + </p></dd><dt><span class="term"><code class="option">--no-super-update</code></span></dt><dd><p> + Do not update the <acronym class="acronym">SGML</acronym> super catalog. + </p></dd><dt><span class="term"><code class="option">--shell</code></span></dt><dd><p> + Run a shell allowing interactive queries on catalog + file <em class="replaceable"><code>CATALOGFILE</code></em>. For the set of available + commands see <a class="xref" href="#shell" title="SHELL COMMANDS">the section called “SHELL COMMANDS”</a>. + </p></dd><dt><span class="term"><code class="option">--sgml</code></span></dt><dd><p> + Uses <acronym class="acronym">SGML</acronym> super catalogs for <code class="option">--add</code> + and <code class="option">--del</code> options. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p>Output debugging information.</p></dd></dl></div><p> + Invoking <span class="command"><strong>xmlcatalog</strong></span> non-interactively without a designated action + (imposed with options like <code class="option">--add</code>) will result in a lookup + of the catalog entry for <em class="replaceable"><code>ENTITIES</code></em> in the + catalog denoted with <em class="replaceable"><code>CATALOGFILE</code></em>. The + corresponding entries will be output to the command line. This mode of + operation, together with <code class="option">--shell</code> mode and non-modifying + (i.e. without <code class="option">--noout</code>) direct actions, allows for + a special shortcut of the void <em class="replaceable"><code>CATALOGFILE</code></em> + specification (possibly expressed as "" in the shell + environment) appointing the default system catalog. That simplifies the + handling when its exact location is irrelevant but the respective built-in + still needs to be consulted. + </p></div><div class="refsect1"><a name="shell"></a><h2>SHELL COMMANDS</h2><p> + Invoking <span class="command"><strong>xmlcatalog</strong></span> with + the <code class="option">--shell <em class="replaceable"><code>CATALOGFILE</code></em></code> option opens + a command line shell allowing interactive access to the catalog file + identified by <em class="replaceable"><code>CATALOGFILE</code></em>. Invoking the shell + provides a command line prompt after which the following commands (described in + alphabetical order) can be entered. + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> + <code class="option">add + <em class="replaceable"><code>TYPE</code></em> + <em class="replaceable"><code>ORIG</code></em> + <em class="replaceable"><code>REPLACE</code></em> + </code> + </span></dt><dd><p> + Add an entry to the catalog file. <em class="replaceable"><code>TYPE</code></em> + indicates the type of entry. Possible types are: <span class="simplelist"><em class="parameter"><code>public</code></em>, <em class="parameter"><code>system</code></em>, <em class="parameter"><code>uri</code></em>, <em class="parameter"><code>rewriteSystem</code></em>, <em class="parameter"><code>rewriteURI</code></em>, <em class="parameter"><code>delegatePublic</code></em>, <em class="parameter"><code>delegateSystem</code></em>, <em class="parameter"><code>delegateURI</code></em>, <em class="parameter"><code>nextCatalog</code></em></span>. <em class="replaceable"><code>ORIG</code></em> is the original + reference to be replaced, and <em class="replaceable"><code>REPLACE</code></em> + is the <acronym class="acronym">URI</acronym> of the replacement entity to be + used. The <code class="option">--add</code> option will not overwrite + <code class="filename">CATALOGFILE</code>, outputting + to <code class="filename">stdout</code>, unless + <code class="option">--noout</code> is used. The <code class="option">--add</code> will + always take three parameters even if some of the <acronym class="acronym">XML</acronym> + catalog constructs will have only a single argument. + </p></dd><dt><span class="term"><code class="option">debug</code></span></dt><dd><p> + Print debugging statements showing the steps <span class="command"><strong>xmlcatalog</strong></span> is executing. + </p></dd><dt><span class="term"><code class="option">del <em class="replaceable"><code>VALUE(S)</code></em></code></span></dt><dd><p> + Remove the catalog entry corresponding to <em class="replaceable"><code>VALUE(S)</code></em>. + </p></dd><dt><span class="term"><code class="option">dump</code></span></dt><dd><p>Print the current catalog.</p></dd><dt><span class="term"><code class="option">exit</code></span></dt><dd><p>Quit the shell.</p></dd><dt><span class="term"><code class="option">public <em class="replaceable"><code>PUBLIC-ID</code></em></code></span></dt><dd><p> + Execute a Formal Public Identifier lookup of the catalog entry + for <em class="replaceable"><code>PUBLIC-ID</code></em>. The corresponding entry will be + output to the command line. + </p></dd><dt><span class="term"><code class="option">quiet</code></span></dt><dd><p>Stop printing debugging statements.</p></dd><dt><span class="term"><code class="option">system <em class="replaceable"><code>SYSTEM-ID</code></em></code></span></dt><dd><p> + Execute a Formal Public Identifier lookup of the catalog entry + for <em class="replaceable"><code>SYSTEM-ID</code></em>. The corresponding entry will be + output to the command line. + </p></dd></dl></div></div><div class="refsect1"><a name="environment"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="envar">XML_CATALOG_FILES</code></span></dt><dd><p><acronym class="acronym">XML</acronym> catalog behavior can be changed by redirecting + queries to the user's own set of catalogs. This can be done by setting + the <code class="envar">XML_CATALOG_FILES</code> environment variable to a space-separated + list of catalogs. Use percent-encoding to escape spaces or other characters. + An empty variable should deactivate loading the default catalog from + <code class="filename">/etc/xml/catalog</code> or, more specifically, + <code class="filename">${sysconfdir}/xml/catalog</code>. + </p></dd></dl></div></div><div class="refsect1"><a name="diagnostics"></a><h2>DIAGNOSTICS</h2><p> + <span class="command"><strong>xmlcatalog</strong></span> return codes provide information that can be used when + calling it from scripts. + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="errorcode">0</span></span></dt><dd><p>No error</p></dd><dt><span class="term"><span class="errorcode">1</span></span></dt><dd><p>Failed to remove an entry from the catalog</p></dd><dt><span class="term"><span class="errorcode">2</span></span></dt><dd><p>Failed to save to the catalog, check file permissions</p></dd><dt><span class="term"><span class="errorcode">3</span></span></dt><dd><p>Failed to add an entry to the catalog</p></dd><dt><span class="term"><span class="errorcode">4</span></span></dt><dd><p>Failed to look up an entry in the catalog</p></dd></dl></div></div><div class="refsect1"><a name="seealso"></a><h2>SEE ALSO</h2><p><span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span> + </p><p> + More information can be found at + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span> web page <a class="ulink" href="https://gitlab.gnome.org/GNOME/libxml2" target="_top">https://gitlab.gnome.org/GNOME/libxml2</a> + </p></li><li class="listitem"><p><span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span> catalog support web page + at <a class="ulink" href="https://gitlab.gnome.org/GNOME/libxml2/-/wikis/Catalog-support" target="_top">https://gitlab.gnome.org/GNOME/libxml2/-/wikis/Catalog-support</a> + </p></li><li class="listitem"><p>James Clark's <acronym class="acronym">SGML</acronym> catalog + page <a class="ulink" href="http://www.jclark.com/sp/catalog.htm" target="_top">http://www.jclark.com/sp/catalog.htm</a> + </p></li><li class="listitem"><p><acronym class="acronym">OASIS</acronym> <acronym class="acronym">XML</acronym> catalog specification + <a class="ulink" href="http://www.oasis-open.org/committees/entity/spec.html" target="_top">http://www.oasis-open.org/committees/entity/spec.html</a> + </p></li></ul></div><p> + </p></div></div></body></html> diff --git a/doc/xmllint.1 b/doc/xmllint.1 index 512dfd6b..a6b9ba6e 100644 --- a/doc/xmllint.1 +++ b/doc/xmllint.1 @@ -1,13 +1,13 @@ '\" t .\" Title: xmllint .\" Author: John Fleck <jfleck@inkstain.net> -.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 08/17/2022 +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 04/26/2023 .\" Manual: xmllint Manual .\" Source: libxml2 .\" Language: English .\" -.TH "XMLLINT" "1" "08/17/2022" "libxml2" "xmllint Manual" +.TH "XMLLINT" "1" "04/26/2023" "libxml2" "xmllint Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -31,7 +31,7 @@ xmllint \- command line XML tool .SH "SYNOPSIS" .HP \w'\fBxmllint\fR\ 'u -\fBxmllint\fR [\fB\-\-version\fR | \fB\-\-debug\fR | \fB\-\-shell\fR | \fB\-\-xpath\ "\fR\fB\fIXPath_expression\fR\fR\fB"\fR | \fB\-\-debugent\fR | \fB\-\-copy\fR | \fB\-\-recover\fR | \fB\-\-noent\fR | \fB\-\-noout\fR | \fB\-\-nonet\fR | \fB\-\-path\ "\fR\fB\fIPATH(S)\fR\fR\fB"\fR | \fB\-\-load\-trace\fR | \fB\-\-htmlout\fR | \fB\-\-nowrap\fR | \fB\-\-valid\fR | \fB\-\-postvalid\fR | \fB\-\-dtdvalid\ \fR\fB\fIURL\fR\fR | \fB\-\-dtdvalidfpi\ \fR\fB\fIFPI\fR\fR | \fB\-\-timing\fR | \fB\-\-output\ \fR\fB\fIFILE\fR\fR | \fB\-\-repeat\fR | \fB\-\-insert\fR | \fB\-\-compress\fR | \fB\-\-html\fR | \fB\-\-xmlout\fR | \fB\-\-push\fR | \fB\-\-memory\fR | \fB\-\-maxmem\ \fR\fB\fINBBYTES\fR\fR | \fB\-\-nowarning\fR | \fB\-\-noblanks\fR | \fB\-\-nocdata\fR | \fB\-\-format\fR | \fB\-\-encode\ \fR\fB\fIENCODING\fR\fR | \fB\-\-dropdtd\fR | \fB\-\-nsclean\fR | \fB\-\-testIO\fR | \fB\-\-catalogs\fR | \fB\-\-nocatalogs\fR | \fB\-\-auto\fR | \fB\-\-xinclude\fR | \fB\-\-noxincludenode\fR | \fB\-\-loaddtd\fR | \fB\-\-dtdattr\fR | \fB\-\-stream\fR | \fB\-\-walker\fR | \fB\-\-pattern\ \fR\fB\fIPATTERNVALUE\fR\fR | \fB\-\-chkregister\fR | \fB\-\-relaxng\ \fR\fB\fISCHEMA\fR\fR | \fB\-\-schema\ \fR\fB\fISCHEMA\fR\fR | \fB\-\-c14n\fR] {\fIXML\-FILE(S)\fR... | \-} +\fBxmllint\fR [\fB\-\-version\fR | \fB\-\-debug\fR | \fB\-\-quiet\fR | \fB\-\-shell\fR | \fB\-\-xpath\ "\fR\fB\fIXPath_expression\fR\fR\fB"\fR | \fB\-\-debugent\fR | \fB\-\-copy\fR | \fB\-\-recover\fR | \fB\-\-nodict\fR | \fB\-\-noent\fR | \fB\-\-noout\fR | \fB\-\-nonet\fR | \fB\-\-path\ "\fR\fB\fIPATH(S)\fR\fR\fB"\fR | \fB\-\-load\-trace\fR | \fB\-\-htmlout\fR | \fB\-\-nowrap\fR | \fB\-\-valid\fR | \fB\-\-postvalid\fR | \fB\-\-dtdvalid\ \fR\fB\fIURL\fR\fR | \fB\-\-dtdvalidfpi\ \fR\fB\fIFPI\fR\fR | \fB\-\-timing\fR | \fB\-\-output\ \fR\fB\fIFILE\fR\fR | \fB\-\-repeat\fR | \fB\-\-insert\fR | \fB\-\-compress\fR | \fB\-\-html\fR | \fB\-\-xmlout\fR | \fB\-\-push\fR | \fB\-\-memory\fR | \fB\-\-maxmem\ \fR\fB\fINBBYTES\fR\fR | \fB\-\-nowarning\fR | \fB\-\-noblanks\fR | \fB\-\-nocdata\fR | \fB\-\-format\fR | \fB\-\-encode\ \fR\fB\fIENCODING\fR\fR | \fB\-\-dropdtd\fR | \fB\-\-nsclean\fR | \fB\-\-testIO\fR | \fB\-\-catalogs\fR | \fB\-\-nocatalogs\fR | \fB\-\-auto\fR | \fB\-\-xinclude\fR | \fB\-\-noxincludenode\fR | \fB\-\-loaddtd\fR | \fB\-\-dtdattr\fR | \fB\-\-stream\fR | \fB\-\-walker\fR | \fB\-\-pattern\ \fR\fB\fIPATTERNVALUE\fR\fR | \fB\-\-chkregister\fR | \fB\-\-relaxng\ \fR\fB\fISCHEMA\fR\fR | \fB\-\-schema\ \fR\fB\fISCHEMA\fR\fR | \fB\-\-c14n\fR | \fB\-\-pedantic\fR] {\fIXML\-FILE(S)\fR... | \-} .HP \w'\fBxmllint\fR\ 'u \fBxmllint\fR \fB\-\-help\fR .SH "DESCRIPTION" @@ -72,6 +72,8 @@ catalog(s) from XML catalogs starting from /etc/xml/catalog +or, more specifically, +${sysconfdir}/xml/catalog are used by default\&. .RE .PP @@ -226,6 +228,11 @@ Do not use any catalogs\&. Substitute CDATA section by equivalent text nodes\&. .RE .PP +\fB\-\-nodict\fR +.RS 4 +Don\*(Aqt use dictionaries (parser option XML_PARSE_NODICT)\&. Only for debugging\&. +.RE +.PP \fB\-\-noent\fR .RS 4 Substitute entity values for entity references\&. By default, @@ -291,6 +298,11 @@ DTDs or entities\&. Enclose space\-separated lists by quotation marks\&. Used to exercise the pattern recognition engine, which can be used with the reader interface to the parser\&. It allows to select some nodes in the document based on an XPath (subset) expression\&. Used for debugging\&. .RE .PP +\fB\-\-pedantic\fR +.RS 4 +Enable additional warnings\&. +.RE +.PP \fB\-\-postvalid\fR .RS 4 Validate after parsing has completed\&. @@ -301,6 +313,11 @@ Validate after parsing has completed\&. Use the push mode of the parser\&. .RE .PP +\fB\-\-quiet\fR +.RS 4 +Don\*(Aqt print informational messages to stderr\&. +.RE +.PP \fB\-\-recover\fR .RS 4 Output any parsable portions of an invalid document\&. @@ -501,9 +518,7 @@ Write the current node to the given filename\&. SGML catalog behavior can be changed by redirecting queries to the user\*(Aqs own set of catalogs\&. This can be done by setting the \fBSGML_CATALOG_FILES\fR -environment variable to a list of catalogs\&. An empty one should deactivate loading the default -/etc/sgml/catalog -catalog\&. +environment variable to a list of catalogs\&. An empty one should deactivate loading the default catalog\&. .RE .PP \fBXML_CATALOG_FILES\fR @@ -511,9 +526,7 @@ catalog\&. XML catalog behavior can be changed by redirecting queries to the user\*(Aqs own set of catalogs\&. This can be done by setting the \fBXML_CATALOG_FILES\fR -environment variable to a space\-separated list of catalogs\&. Use percent\-encoding to escape spaces or other characters\&. An empty variable should deactivate loading the default -/etc/xml/catalog -catalog\&. +environment variable to a space\-separated list of catalogs\&. Use percent\-encoding to escape spaces or other characters\&. An empty variable should deactivate loading the default catalog\&. .RE .PP \fBXML_DEBUG_CATALOG\fR diff --git a/doc/xmllint.html b/doc/xmllint.html index 8d4400fe..9e2e7ce6 100644 --- a/doc/xmllint.html +++ b/doc/xmllint.html @@ -1,161 +1,165 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xmllint</title><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"><a name="idm1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xmllint — command line <acronym class="acronym">XML</acronym> tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xmllint</code> [ <code class="option">--version</code> | <code class="option">--debug</code> | <code class="option">--shell</code> | <code class="option">--xpath "<em class="replaceable"><code>XPath_expression</code></em>"</code> | <code class="option">--debugent</code> | <code class="option">--copy</code> | <code class="option">--recover</code> | <code class="option">--noent</code> | <code class="option">--noout</code> | <code class="option">--nonet</code> | <code class="option">--path "<em class="replaceable"><code>PATH(S)</code></em>"</code> | <code class="option">--load-trace</code> | <code class="option">--htmlout</code> | <code class="option">--nowrap</code> | <code class="option">--valid</code> | <code class="option">--postvalid</code> | <code class="option">--dtdvalid <em class="replaceable"><code>URL</code></em></code> | <code class="option">--dtdvalidfpi <em class="replaceable"><code>FPI</code></em></code> | <code class="option">--timing</code> | <code class="option">--output <em class="replaceable"><code>FILE</code></em></code> | <code class="option">--repeat</code> | <code class="option">--insert</code> | <code class="option">--compress</code> | <code class="option">--html</code> | <code class="option">--xmlout</code> | <code class="option">--push</code> | <code class="option">--memory</code> | <code class="option">--maxmem <em class="replaceable"><code>NBBYTES</code></em></code> | <code class="option">--nowarning</code> | <code class="option">--noblanks</code> | <code class="option">--nocdata</code> | <code class="option">--format</code> | <code class="option">--encode <em class="replaceable"><code>ENCODING</code></em></code> | <code class="option">--dropdtd</code> | <code class="option">--nsclean</code> | <code class="option">--testIO</code> | <code class="option">--catalogs</code> | <code class="option">--nocatalogs</code> | <code class="option">--auto</code> | <code class="option">--xinclude</code> | <code class="option">--noxincludenode</code> | <code class="option">--loaddtd</code> | <code class="option">--dtdattr</code> | <code class="option">--stream</code> | <code class="option">--walker</code> | <code class="option">--pattern <em class="replaceable"><code>PATTERNVALUE</code></em></code> | <code class="option">--chkregister</code> | <code class="option">--relaxng <em class="replaceable"><code>SCHEMA</code></em></code> | <code class="option">--schema <em class="replaceable"><code>SCHEMA</code></em></code> | <code class="option">--c14n</code> ] { <em class="replaceable"><code>XML-FILE(S)</code></em>... | - }</p></div><div class="cmdsynopsis"><p><code class="command">xmllint</code> <code class="option">--help</code> </p></div></div><div class="refsect1"><a name="description"></a><h2>DESCRIPTION</h2><p> - The <span class="command"><strong>xmllint</strong></span> program parses one or more <acronym class="acronym">XML</acronym> files, - specified on the command line as <em class="replaceable"><code>XML-FILE</code></em> - (or the standard input if the filename provided - is <span class="bold"><strong>-</strong></span> ). It prints various types of - output, depending upon the options selected. It is useful for detecting - errors both in <acronym class="acronym">XML</acronym> code and in - the <acronym class="acronym">XML</acronym> parser itself. - </p><p><span class="command"><strong>xmllint</strong></span> is included in <span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span>.</p></div><div class="refsect1"><a name="options"></a><h2>OPTIONS</h2><p> - <span class="command"><strong>xmllint</strong></span> accepts the following options (in alphabetical order): - </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">--auto</code></span></dt><dd><p>Generate a small document for testing purposes.</p></dd><dt><span class="term"><code class="option">--catalogs</code></span></dt><dd><p> - Use the <acronym class="acronym">SGML</acronym> catalog(s) from <code class="envar">SGML_CATALOG_FILES</code>. - Otherwise <acronym class="acronym">XML</acronym> catalogs starting - from <code class="filename">/etc/xml/catalog</code> are used by default. - </p></dd><dt><span class="term"><code class="option">--chkregister</code></span></dt><dd><p> - Turn on node registration. Useful for developers testing <span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span> node tracking code. - </p></dd><dt><span class="term"><code class="option">--compress</code></span></dt><dd><p> - Turn on <span class="citerefentry"><span class="refentrytitle">gzip</span>(1)</span> compression of output. - </p></dd><dt><span class="term"><code class="option">--copy</code></span></dt><dd><p>Test the internal copy implementation.</p></dd><dt><span class="term"><code class="option">--c14n</code></span></dt><dd><p> - Use the W3C <acronym class="acronym">XML</acronym> Canonicalisation (<acronym class="acronym">C14N</acronym>) to - serialize the result of parsing to <code class="filename">stdout</code>. - It keeps comments in the result. - </p></dd><dt><span class="term"><code class="option">--dtdvalid <em class="replaceable"><code>URL</code></em></code></span></dt><dd><p> - Use the <acronym class="acronym">DTD</acronym> specified by - an <em class="replaceable"><code>URL</code></em> for validation. - </p></dd><dt><span class="term"><code class="option">--dtdvalidfpi <em class="replaceable"><code>FPI</code></em></code></span></dt><dd><p> - Use the <acronym class="acronym">DTD</acronym> specified by a Formal Public - Identifier <em class="replaceable"><code>FPI</code></em> for validation, note that this - will require a catalog exporting that Formal Public Identifier to work. - </p></dd><dt><span class="term"><code class="option">--debug</code></span></dt><dd><p> - Parse a file and output an annotated tree of the - in-memory version of the document. - </p></dd><dt><span class="term"><code class="option">--debugent</code></span></dt><dd><p>Debug the entities defined in the document.</p></dd><dt><span class="term"><code class="option">--dropdtd</code></span></dt><dd><p>Remove <acronym class="acronym">DTD</acronym> from output.</p></dd><dt><span class="term"><code class="option">--dtdattr</code></span></dt><dd><p> - Fetch external <acronym class="acronym">DTD</acronym> and populate the tree with - inherited attributes. - </p></dd><dt><span class="term"><code class="option">--encode <em class="replaceable"><code>ENCODING</code></em></code></span></dt><dd><p>Output in the given encoding. Note that this works for full document not fragments or result from XPath queries.</p></dd><dt><span class="term"><code class="option">--format</code></span></dt><dd><p> - Reformat and reindent the output. The <code class="envar">XMLLINT_INDENT</code> - environment variable controls the indentation. The default value is two - spaces " "). - </p></dd><dt><span class="term"><code class="option">--help</code></span></dt><dd><p>Print out a short usage summary for <span class="command"><strong>xmllint</strong></span>.</p></dd><dt><span class="term"><code class="option">--html</code></span></dt><dd><p>Use the <acronym class="acronym">HTML</acronym> parser.</p></dd><dt><span class="term"><code class="option">--htmlout</code></span></dt><dd><p> - Output results as an <acronym class="acronym">HTML</acronym> file. This - causes <span class="command"><strong>xmllint</strong></span> to output the necessary <acronym class="acronym">HTML</acronym> - tags surrounding the result tree output so the results can be - displayed/viewed in a browser. - </p></dd><dt><span class="term"><code class="option">--insert</code></span></dt><dd><p>Test for valid insertions.</p></dd><dt><span class="term"><code class="option">--loaddtd</code></span></dt><dd><p>Fetch an external <acronym class="acronym">DTD</acronym>.</p></dd><dt><span class="term"><code class="option">--load-trace</code></span></dt><dd><p> - Display all the documents loaded during the processing - to <code class="filename">stderr</code>. - </p></dd><dt><span class="term"><code class="option">--maxmem <em class="replaceable"><code>NNBYTES</code></em></code></span></dt><dd><p> - Test the parser memory support. <em class="replaceable"><code>NNBYTES</code></em> - is the maximum number of bytes the library is allowed to allocate. - This can also be used to make sure batch processing - of <acronym class="acronym">XML</acronym> files will not exhaust the virtual memory - of the server running them. - </p></dd><dt><span class="term"><code class="option">--memory</code></span></dt><dd><p>Parse from memory.</p></dd><dt><span class="term"><code class="option">--noblanks</code></span></dt><dd><p>Drop ignorable blank spaces.</p></dd><dt><span class="term"><code class="option">--nocatalogs</code></span></dt><dd><p>Do not use any catalogs.</p></dd><dt><span class="term"><code class="option">--nocdata</code></span></dt><dd><p>Substitute CDATA section by equivalent text nodes.</p></dd><dt><span class="term"><code class="option">--noent</code></span></dt><dd><p> - Substitute entity values for entity references. By default, <span class="command"><strong>xmllint</strong></span> - leaves entity references in place. - </p></dd><dt><span class="term"><code class="option">--nonet</code></span></dt><dd><p> - Do not use the Internet to fetch <acronym class="acronym">DTD</acronym>s or entities. - </p></dd><dt><span class="term"><code class="option">--noout</code></span></dt><dd><p> - Suppress output. By default, <span class="command"><strong>xmllint</strong></span> outputs the result tree. - </p></dd><dt><span class="term"><code class="option">--nowarning</code></span></dt><dd><p>Do not emit warnings from the parser and/or validator.</p></dd><dt><span class="term"><code class="option">--nowrap</code></span></dt><dd><p>Do not output <acronym class="acronym">HTML</acronym> doc wrapper.</p></dd><dt><span class="term"><code class="option">--noxincludenode</code></span></dt><dd><p> - Do XInclude processing but do not generate XInclude start and end nodes. - </p></dd><dt><span class="term"><code class="option">--nsclean</code></span></dt><dd><p>Remove redundant namespace declarations.</p></dd><dt><span class="term"><code class="option">--output <em class="replaceable"><code>FILE</code></em></code></span></dt><dd><p> - Define a file path where <span class="command"><strong>xmllint</strong></span> will save the result of parsing. - Usually the programs build a tree and save it - on <code class="filename">stdout</code>, with this option - the result <acronym class="acronym">XML</acronym> instance will be saved onto a file. - </p></dd><dt><span class="term"><code class="option">--path "<em class="replaceable"><code>PATH(S)</code></em>"</code></span></dt><dd><p> - Use the (space- or colon-separated) list of filesystem paths specified - by <em class="replaceable"><code>PATHS</code></em> to load <acronym class="acronym">DTD</acronym>s or - entities. Enclose space-separated lists by quotation marks. - </p></dd><dt><span class="term"><code class="option">--pattern <em class="replaceable"><code>PATTERNVALUE</code></em></code></span></dt><dd><p> - Used to exercise the pattern recognition engine, which can be used - with the reader interface to the parser. It allows to select some - nodes in the document based on an XPath (subset) expression. Used - for debugging. - </p></dd><dt><span class="term"><code class="option">--postvalid</code></span></dt><dd><p>Validate after parsing has completed.</p></dd><dt><span class="term"><code class="option">--push</code></span></dt><dd><p>Use the push mode of the parser.</p></dd><dt><span class="term"><code class="option">--recover</code></span></dt><dd><p>Output any parsable portions of an invalid document.</p></dd><dt><span class="term"><code class="option">--relaxng <em class="replaceable"><code>SCHEMA</code></em></code></span></dt><dd><p> - Use RelaxNG file named <em class="replaceable"><code>SCHEMA</code></em> - for validation. - </p></dd><dt><span class="term"><code class="option">--repeat</code></span></dt><dd><p>Repeat 100 times, for timing or profiling.</p></dd><dt><span class="term"><code class="option">--schema <em class="replaceable"><code>SCHEMA</code></em></code></span></dt><dd><p> - Use a W3C <acronym class="acronym">XML</acronym> Schema file - named <em class="replaceable"><code>SCHEMA</code></em> for validation. - </p></dd><dt><span class="term"><code class="option">--shell</code></span></dt><dd><p> - Run a navigating shell. Details on available commands in shell mode - are below (see <a class="xref" href="#shell" title="SHELL COMMANDS">the section called “SHELL COMMANDS”</a>). - </p></dd><dt><span class="term"><code class="option">--xpath "<em class="replaceable"><code>XPath_expression</code></em>"</code></span></dt><dd><p> - Run an XPath expression given as argument and print the - result. In case of a nodeset result, each node in the - node set is serialized in full in the output. In case - of an empty node set the "XPath set is empty" result - will be shown and an error exit code will be returned. - </p></dd><dt><span class="term"><code class="option">--stream</code></span></dt><dd><p> - Use streaming <acronym class="acronym">API</acronym> - useful when used in combination - with <code class="option">--relaxng</code> or <code class="option">--valid</code> options - for validation of files that are too large to be held in memory. - </p></dd><dt><span class="term"><code class="option">--testIO</code></span></dt><dd><p>Test user input/output support.</p></dd><dt><span class="term"><code class="option">--timing</code></span></dt><dd><p> - Output information about the time it takes <span class="command"><strong>xmllint</strong></span> to perform the - various steps. - </p></dd><dt><span class="term"><code class="option">--valid</code></span></dt><dd><p> - Determine if the document is a valid instance of the included - Document Type Definition (<acronym class="acronym">DTD</acronym>). - A <acronym class="acronym">DTD</acronym> to be validated against also can be - specified at the command line using the <code class="option">--dtdvalid</code> - option. By default, <span class="command"><strong>xmllint</strong></span> also checks to determine if the - document is well-formed. - </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> - Display the version of <span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span> used. - </p></dd><dt><span class="term"><code class="option">--walker</code></span></dt><dd><p> - Test the walker module, which is a reader interface but for a - document tree, instead of using the reader <acronym class="acronym">API</acronym> on - an unparsed document it works on an existing in-memory tree. Used for - debugging. - </p></dd><dt><span class="term"><code class="option">--xinclude</code></span></dt><dd><p>Do XInclude processing.</p></dd><dt><span class="term"><code class="option">--xmlout</code></span></dt><dd><p> - Used in conjunction with <code class="option">--html</code>. Usually - when <acronym class="acronym">HTML</acronym> is parsed the document is saved with - the <acronym class="acronym">HTML</acronym> serializer. But with this option the - resulting document is saved with the <acronym class="acronym">XML</acronym> - serializer. This is primarily used to - generate <acronym class="acronym">XHTML</acronym> from <acronym class="acronym">HTML</acronym> input. - </p></dd></dl></div></div><div class="refsect1"><a name="shell"></a><h2>SHELL COMMANDS</h2><p> - <span class="command"><strong>xmllint</strong></span> offers an interactive shell mode invoked with - the <code class="option">--shell</code> command. Available commands in shell mode - include (in alphabetical order): - </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="command"><strong>base</strong></span></span></dt><dd><p>Display <acronym class="acronym">XML</acronym> base of the node.</p></dd><dt><span class="term"><span class="command"><strong>bye</strong></span></span></dt><dd><p>Leave the shell.</p></dd><dt><span class="term"><span class="command"><strong>cat <em class="replaceable"><code>NODE</code></em></strong></span></span></dt><dd><p>Display the given node or the current one.</p></dd><dt><span class="term"><span class="command"><strong>cd <em class="replaceable"><code>PATH</code></em></strong></span></span></dt><dd><p> - Change the current node to the given path (if unique) or root if no - argument is given. - </p></dd><dt><span class="term"><span class="command"><strong>dir <em class="replaceable"><code>PATH</code></em></strong></span></span></dt><dd><p> - Dumps information about the node (namespace, attributes, content). - </p></dd><dt><span class="term"><span class="command"><strong>du <em class="replaceable"><code>PATH</code></em></strong></span></span></dt><dd><p> - Show the structure of the subtree under the given path or the current node. - </p></dd><dt><span class="term"><span class="command"><strong>exit</strong></span></span></dt><dd><p>Leave the shell.</p></dd><dt><span class="term"><span class="command"><strong>help</strong></span></span></dt><dd><p>Show this help.</p></dd><dt><span class="term"><span class="command"><strong>free</strong></span></span></dt><dd><p>Display memory usage.</p></dd><dt><span class="term"><span class="command"><strong>load <em class="replaceable"><code>FILENAME</code></em></strong></span></span></dt><dd><p>Load a new document with the given filename.</p></dd><dt><span class="term"><span class="command"><strong>ls <em class="replaceable"><code>PATH</code></em></strong></span></span></dt><dd><p>List contents of the given path or the current directory.</p></dd><dt><span class="term"><span class="command"><strong>pwd</strong></span></span></dt><dd><p>Display the path to the current node.</p></dd><dt><span class="term"><span class="command"><strong>quit</strong></span></span></dt><dd><p>Leave the shell.</p></dd><dt><span class="term"><span class="command"><strong>save <em class="replaceable"><code>FILENAME</code></em></strong></span></span></dt><dd><p> - Save the current document to the given filename or to the original name. - </p></dd><dt><span class="term"><code class="option">validate</code></span></dt><dd><p>Check the document for errors.</p></dd><dt><span class="term"><span class="command"><strong>write <em class="replaceable"><code>FILENAME</code></em></strong></span></span></dt><dd><p>Write the current node to the given filename.</p></dd></dl></div></div><div class="refsect1"><a name="environment"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="envar">SGML_CATALOG_FILES</code></span></dt><dd><p><acronym class="acronym">SGML</acronym> catalog behavior can be changed by redirecting - queries to the user's own set of catalogs. This can be done by setting - the <code class="envar">SGML_CATALOG_FILES</code> environment variable to a list - of catalogs. An empty one should deactivate loading the - default <code class="filename">/etc/sgml/catalog</code> catalog. - </p></dd><dt><span class="term"><code class="envar">XML_CATALOG_FILES</code></span></dt><dd><p><acronym class="acronym">XML</acronym> catalog behavior can be changed by redirecting - queries to the user's own set of catalogs. This can be done by setting - the <code class="envar">XML_CATALOG_FILES</code> environment variable to a space-separated - list of catalogs. Use percent-encoding to escape spaces or other characters. - An empty variable should deactivate loading the default <code class="filename">/etc/xml/catalog</code> catalog. - </p></dd><dt><span class="term"><code class="envar">XML_DEBUG_CATALOG</code></span></dt><dd><p>Setting the environment variable <code class="envar">XML_DEBUG_CATALOG</code> - to <em class="parameter"><code>non-zero</code></em> using the <span class="command"><strong>export</strong></span> - command outputs debugging information related to catalog operations. - </p></dd><dt><span class="term"><code class="envar">XMLLINT_INDENT</code></span></dt><dd><p>Setting the environment variable <code class="envar">XMLLINT_INDENT</code> - controls the indentation. The default value is two spaces " ". - </p></dd></dl></div></div><div class="refsect1"><a name="diagnostics"></a><h2>DIAGNOSTICS</h2><p> - <span class="command"><strong>xmllint</strong></span> return codes provide information that can be used when - calling it from scripts. - </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="errorcode">0</span></span></dt><dd><p>No error</p></dd><dt><span class="term"><span class="errorcode">1</span></span></dt><dd><p>Unclassified</p></dd><dt><span class="term"><span class="errorcode">2</span></span></dt><dd><p>Error in <acronym class="acronym">DTD</acronym></p></dd><dt><span class="term"><span class="errorcode">3</span></span></dt><dd><p>Validation error</p></dd><dt><span class="term"><span class="errorcode">4</span></span></dt><dd><p>Validation error</p></dd><dt><span class="term"><span class="errorcode">5</span></span></dt><dd><p>Error in schema compilation</p></dd><dt><span class="term"><span class="errorcode">6</span></span></dt><dd><p>Error writing output</p></dd><dt><span class="term"><span class="errorcode">7</span></span></dt><dd><p> - Error in pattern (generated when <code class="option">--pattern</code> option is used) - </p></dd><dt><span class="term"><span class="errorcode">8</span></span></dt><dd><p> - Error in Reader registration (generated - when <code class="option">--chkregister</code> option is used) - </p></dd><dt><span class="term"><span class="errorcode">9</span></span></dt><dd><p>Out of memory error</p></dd><dt><span class="term"><span class="errorcode">10</span></span></dt><dd><p>XPath evaluation error</p></dd></dl></div></div><div class="refsect1"><a name="seealso"></a><h2>SEE ALSO</h2><p><span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span> - </p><p> - More information can be found at - </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span> web page <a class="ulink" href="https://gitlab.gnome.org/GNOME/libxml2" target="_top">https://gitlab.gnome.org/GNOME/libxml2</a> - </p></li></ul></div><p> - </p></div></div></body></html> +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xmllint</title><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"><a name="idm1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xmllint — command line <acronym class="acronym">XML</acronym> tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xmllint</code> [ <code class="option">--version</code> | <code class="option">--debug</code> | <code class="option">--quiet</code> | <code class="option">--shell</code> | <code class="option">--xpath "<em class="replaceable"><code>XPath_expression</code></em>"</code> | <code class="option">--debugent</code> | <code class="option">--copy</code> | <code class="option">--recover</code> | <code class="option">--nodict</code> | <code class="option">--noent</code> | <code class="option">--noout</code> | <code class="option">--nonet</code> | <code class="option">--path "<em class="replaceable"><code>PATH(S)</code></em>"</code> | <code class="option">--load-trace</code> | <code class="option">--htmlout</code> | <code class="option">--nowrap</code> | <code class="option">--valid</code> | <code class="option">--postvalid</code> | <code class="option">--dtdvalid <em class="replaceable"><code>URL</code></em></code> | <code class="option">--dtdvalidfpi <em class="replaceable"><code>FPI</code></em></code> | <code class="option">--timing</code> | <code class="option">--output <em class="replaceable"><code>FILE</code></em></code> | <code class="option">--repeat</code> | <code class="option">--insert</code> | <code class="option">--compress</code> | <code class="option">--html</code> | <code class="option">--xmlout</code> | <code class="option">--push</code> | <code class="option">--memory</code> | <code class="option">--maxmem <em class="replaceable"><code>NBBYTES</code></em></code> | <code class="option">--nowarning</code> | <code class="option">--noblanks</code> | <code class="option">--nocdata</code> | <code class="option">--format</code> | <code class="option">--encode <em class="replaceable"><code>ENCODING</code></em></code> | <code class="option">--dropdtd</code> | <code class="option">--nsclean</code> | <code class="option">--testIO</code> | <code class="option">--catalogs</code> | <code class="option">--nocatalogs</code> | <code class="option">--auto</code> | <code class="option">--xinclude</code> | <code class="option">--noxincludenode</code> | <code class="option">--loaddtd</code> | <code class="option">--dtdattr</code> | <code class="option">--stream</code> | <code class="option">--walker</code> | <code class="option">--pattern <em class="replaceable"><code>PATTERNVALUE</code></em></code> | <code class="option">--chkregister</code> | <code class="option">--relaxng <em class="replaceable"><code>SCHEMA</code></em></code> | <code class="option">--schema <em class="replaceable"><code>SCHEMA</code></em></code> | <code class="option">--c14n</code> | <code class="option">--pedantic</code> ] { <em class="replaceable"><code>XML-FILE(S)</code></em>... | - }</p></div><div class="cmdsynopsis"><p><code class="command">xmllint</code> <code class="option">--help</code> </p></div></div><div class="refsect1"><a name="description"></a><h2>DESCRIPTION</h2><p> + The <span class="command"><strong>xmllint</strong></span> program parses one or more <acronym class="acronym">XML</acronym> files, + specified on the command line as <em class="replaceable"><code>XML-FILE</code></em> + (or the standard input if the filename provided + is <span class="bold"><strong>-</strong></span> ). It prints various types of + output, depending upon the options selected. It is useful for detecting + errors both in <acronym class="acronym">XML</acronym> code and in + the <acronym class="acronym">XML</acronym> parser itself. + </p><p><span class="command"><strong>xmllint</strong></span> is included in <span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span>.</p></div><div class="refsect1"><a name="options"></a><h2>OPTIONS</h2><p> + <span class="command"><strong>xmllint</strong></span> accepts the following options (in alphabetical order): + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">--auto</code></span></dt><dd><p>Generate a small document for testing purposes.</p></dd><dt><span class="term"><code class="option">--catalogs</code></span></dt><dd><p> + Use the <acronym class="acronym">SGML</acronym> catalog(s) from <code class="envar">SGML_CATALOG_FILES</code>. + Otherwise <acronym class="acronym">XML</acronym> catalogs starting + from <code class="filename">/etc/xml/catalog</code> or, more specifically, + <code class="filename">${sysconfdir}/xml/catalog</code> are used by default. + </p></dd><dt><span class="term"><code class="option">--chkregister</code></span></dt><dd><p> + Turn on node registration. Useful for developers testing <span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span> node tracking code. + </p></dd><dt><span class="term"><code class="option">--compress</code></span></dt><dd><p> + Turn on <span class="citerefentry"><span class="refentrytitle">gzip</span>(1)</span> compression of output. + </p></dd><dt><span class="term"><code class="option">--copy</code></span></dt><dd><p>Test the internal copy implementation.</p></dd><dt><span class="term"><code class="option">--c14n</code></span></dt><dd><p> + Use the W3C <acronym class="acronym">XML</acronym> Canonicalisation (<acronym class="acronym">C14N</acronym>) to + serialize the result of parsing to <code class="filename">stdout</code>. + It keeps comments in the result. + </p></dd><dt><span class="term"><code class="option">--dtdvalid <em class="replaceable"><code>URL</code></em></code></span></dt><dd><p> + Use the <acronym class="acronym">DTD</acronym> specified by + an <em class="replaceable"><code>URL</code></em> for validation. + </p></dd><dt><span class="term"><code class="option">--dtdvalidfpi <em class="replaceable"><code>FPI</code></em></code></span></dt><dd><p> + Use the <acronym class="acronym">DTD</acronym> specified by a Formal Public + Identifier <em class="replaceable"><code>FPI</code></em> for validation, note that this + will require a catalog exporting that Formal Public Identifier to work. + </p></dd><dt><span class="term"><code class="option">--debug</code></span></dt><dd><p> + Parse a file and output an annotated tree of the + in-memory version of the document. + </p></dd><dt><span class="term"><code class="option">--debugent</code></span></dt><dd><p>Debug the entities defined in the document.</p></dd><dt><span class="term"><code class="option">--dropdtd</code></span></dt><dd><p>Remove <acronym class="acronym">DTD</acronym> from output.</p></dd><dt><span class="term"><code class="option">--dtdattr</code></span></dt><dd><p> + Fetch external <acronym class="acronym">DTD</acronym> and populate the tree with + inherited attributes. + </p></dd><dt><span class="term"><code class="option">--encode <em class="replaceable"><code>ENCODING</code></em></code></span></dt><dd><p>Output in the given encoding. Note that this works for full document not fragments or result from XPath queries.</p></dd><dt><span class="term"><code class="option">--format</code></span></dt><dd><p> + Reformat and reindent the output. The <code class="envar">XMLLINT_INDENT</code> + environment variable controls the indentation. The default value is two + spaces " "). + </p></dd><dt><span class="term"><code class="option">--help</code></span></dt><dd><p>Print out a short usage summary for <span class="command"><strong>xmllint</strong></span>.</p></dd><dt><span class="term"><code class="option">--html</code></span></dt><dd><p>Use the <acronym class="acronym">HTML</acronym> parser.</p></dd><dt><span class="term"><code class="option">--htmlout</code></span></dt><dd><p> + Output results as an <acronym class="acronym">HTML</acronym> file. This + causes <span class="command"><strong>xmllint</strong></span> to output the necessary <acronym class="acronym">HTML</acronym> + tags surrounding the result tree output so the results can be + displayed/viewed in a browser. + </p></dd><dt><span class="term"><code class="option">--insert</code></span></dt><dd><p>Test for valid insertions.</p></dd><dt><span class="term"><code class="option">--loaddtd</code></span></dt><dd><p>Fetch an external <acronym class="acronym">DTD</acronym>.</p></dd><dt><span class="term"><code class="option">--load-trace</code></span></dt><dd><p> + Display all the documents loaded during the processing + to <code class="filename">stderr</code>. + </p></dd><dt><span class="term"><code class="option">--maxmem <em class="replaceable"><code>NNBYTES</code></em></code></span></dt><dd><p> + Test the parser memory support. <em class="replaceable"><code>NNBYTES</code></em> + is the maximum number of bytes the library is allowed to allocate. + This can also be used to make sure batch processing + of <acronym class="acronym">XML</acronym> files will not exhaust the virtual memory + of the server running them. + </p></dd><dt><span class="term"><code class="option">--memory</code></span></dt><dd><p>Parse from memory.</p></dd><dt><span class="term"><code class="option">--noblanks</code></span></dt><dd><p>Drop ignorable blank spaces.</p></dd><dt><span class="term"><code class="option">--nocatalogs</code></span></dt><dd><p>Do not use any catalogs.</p></dd><dt><span class="term"><code class="option">--nocdata</code></span></dt><dd><p>Substitute CDATA section by equivalent text nodes.</p></dd><dt><span class="term"><code class="option">--nodict</code></span></dt><dd><p> + Don't use dictionaries (parser option XML_PARSE_NODICT). + Only for debugging. + </p></dd><dt><span class="term"><code class="option">--noent</code></span></dt><dd><p> + Substitute entity values for entity references. By default, <span class="command"><strong>xmllint</strong></span> + leaves entity references in place. + </p></dd><dt><span class="term"><code class="option">--nonet</code></span></dt><dd><p> + Do not use the Internet to fetch <acronym class="acronym">DTD</acronym>s or entities. + </p></dd><dt><span class="term"><code class="option">--noout</code></span></dt><dd><p> + Suppress output. By default, <span class="command"><strong>xmllint</strong></span> outputs the result tree. + </p></dd><dt><span class="term"><code class="option">--nowarning</code></span></dt><dd><p>Do not emit warnings from the parser and/or validator.</p></dd><dt><span class="term"><code class="option">--nowrap</code></span></dt><dd><p>Do not output <acronym class="acronym">HTML</acronym> doc wrapper.</p></dd><dt><span class="term"><code class="option">--noxincludenode</code></span></dt><dd><p> + Do XInclude processing but do not generate XInclude start and end nodes. + </p></dd><dt><span class="term"><code class="option">--nsclean</code></span></dt><dd><p>Remove redundant namespace declarations.</p></dd><dt><span class="term"><code class="option">--output <em class="replaceable"><code>FILE</code></em></code></span></dt><dd><p> + Define a file path where <span class="command"><strong>xmllint</strong></span> will save the result of parsing. + Usually the programs build a tree and save it + on <code class="filename">stdout</code>, with this option + the result <acronym class="acronym">XML</acronym> instance will be saved onto a file. + </p></dd><dt><span class="term"><code class="option">--path "<em class="replaceable"><code>PATH(S)</code></em>"</code></span></dt><dd><p> + Use the (space- or colon-separated) list of filesystem paths specified + by <em class="replaceable"><code>PATHS</code></em> to load <acronym class="acronym">DTD</acronym>s or + entities. Enclose space-separated lists by quotation marks. + </p></dd><dt><span class="term"><code class="option">--pattern <em class="replaceable"><code>PATTERNVALUE</code></em></code></span></dt><dd><p> + Used to exercise the pattern recognition engine, which can be used + with the reader interface to the parser. It allows to select some + nodes in the document based on an XPath (subset) expression. Used + for debugging. + </p></dd><dt><span class="term"><code class="option">--pedantic</code></span></dt><dd><p>Enable additional warnings.</p></dd><dt><span class="term"><code class="option">--postvalid</code></span></dt><dd><p>Validate after parsing has completed.</p></dd><dt><span class="term"><code class="option">--push</code></span></dt><dd><p>Use the push mode of the parser.</p></dd><dt><span class="term"><code class="option">--quiet</code></span></dt><dd><p>Don't print informational messages to stderr.</p></dd><dt><span class="term"><code class="option">--recover</code></span></dt><dd><p>Output any parsable portions of an invalid document.</p></dd><dt><span class="term"><code class="option">--relaxng <em class="replaceable"><code>SCHEMA</code></em></code></span></dt><dd><p> + Use RelaxNG file named <em class="replaceable"><code>SCHEMA</code></em> + for validation. + </p></dd><dt><span class="term"><code class="option">--repeat</code></span></dt><dd><p>Repeat 100 times, for timing or profiling.</p></dd><dt><span class="term"><code class="option">--schema <em class="replaceable"><code>SCHEMA</code></em></code></span></dt><dd><p> + Use a W3C <acronym class="acronym">XML</acronym> Schema file + named <em class="replaceable"><code>SCHEMA</code></em> for validation. + </p></dd><dt><span class="term"><code class="option">--shell</code></span></dt><dd><p> + Run a navigating shell. Details on available commands in shell mode + are below (see <a class="xref" href="#shell" title="SHELL COMMANDS">the section called “SHELL COMMANDS”</a>). + </p></dd><dt><span class="term"><code class="option">--xpath "<em class="replaceable"><code>XPath_expression</code></em>"</code></span></dt><dd><p> + Run an XPath expression given as argument and print the + result. In case of a nodeset result, each node in the + node set is serialized in full in the output. In case + of an empty node set the "XPath set is empty" result + will be shown and an error exit code will be returned. + </p></dd><dt><span class="term"><code class="option">--stream</code></span></dt><dd><p> + Use streaming <acronym class="acronym">API</acronym> - useful when used in combination + with <code class="option">--relaxng</code> or <code class="option">--valid</code> options + for validation of files that are too large to be held in memory. + </p></dd><dt><span class="term"><code class="option">--testIO</code></span></dt><dd><p>Test user input/output support.</p></dd><dt><span class="term"><code class="option">--timing</code></span></dt><dd><p> + Output information about the time it takes <span class="command"><strong>xmllint</strong></span> to perform the + various steps. + </p></dd><dt><span class="term"><code class="option">--valid</code></span></dt><dd><p> + Determine if the document is a valid instance of the included + Document Type Definition (<acronym class="acronym">DTD</acronym>). + A <acronym class="acronym">DTD</acronym> to be validated against also can be + specified at the command line using the <code class="option">--dtdvalid</code> + option. By default, <span class="command"><strong>xmllint</strong></span> also checks to determine if the + document is well-formed. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Display the version of <span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span> used. + </p></dd><dt><span class="term"><code class="option">--walker</code></span></dt><dd><p> + Test the walker module, which is a reader interface but for a + document tree, instead of using the reader <acronym class="acronym">API</acronym> on + an unparsed document it works on an existing in-memory tree. Used for + debugging. + </p></dd><dt><span class="term"><code class="option">--xinclude</code></span></dt><dd><p>Do XInclude processing.</p></dd><dt><span class="term"><code class="option">--xmlout</code></span></dt><dd><p> + Used in conjunction with <code class="option">--html</code>. Usually + when <acronym class="acronym">HTML</acronym> is parsed the document is saved with + the <acronym class="acronym">HTML</acronym> serializer. But with this option the + resulting document is saved with the <acronym class="acronym">XML</acronym> + serializer. This is primarily used to + generate <acronym class="acronym">XHTML</acronym> from <acronym class="acronym">HTML</acronym> input. + </p></dd></dl></div></div><div class="refsect1"><a name="shell"></a><h2>SHELL COMMANDS</h2><p> + <span class="command"><strong>xmllint</strong></span> offers an interactive shell mode invoked with + the <code class="option">--shell</code> command. Available commands in shell mode + include (in alphabetical order): + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="command"><strong>base</strong></span></span></dt><dd><p>Display <acronym class="acronym">XML</acronym> base of the node.</p></dd><dt><span class="term"><span class="command"><strong>bye</strong></span></span></dt><dd><p>Leave the shell.</p></dd><dt><span class="term"><span class="command"><strong>cat <em class="replaceable"><code>NODE</code></em></strong></span></span></dt><dd><p>Display the given node or the current one.</p></dd><dt><span class="term"><span class="command"><strong>cd <em class="replaceable"><code>PATH</code></em></strong></span></span></dt><dd><p> + Change the current node to the given path (if unique) or root if no + argument is given. + </p></dd><dt><span class="term"><span class="command"><strong>dir <em class="replaceable"><code>PATH</code></em></strong></span></span></dt><dd><p> + Dumps information about the node (namespace, attributes, content). + </p></dd><dt><span class="term"><span class="command"><strong>du <em class="replaceable"><code>PATH</code></em></strong></span></span></dt><dd><p> + Show the structure of the subtree under the given path or the current node. + </p></dd><dt><span class="term"><span class="command"><strong>exit</strong></span></span></dt><dd><p>Leave the shell.</p></dd><dt><span class="term"><span class="command"><strong>help</strong></span></span></dt><dd><p>Show this help.</p></dd><dt><span class="term"><span class="command"><strong>free</strong></span></span></dt><dd><p>Display memory usage.</p></dd><dt><span class="term"><span class="command"><strong>load <em class="replaceable"><code>FILENAME</code></em></strong></span></span></dt><dd><p>Load a new document with the given filename.</p></dd><dt><span class="term"><span class="command"><strong>ls <em class="replaceable"><code>PATH</code></em></strong></span></span></dt><dd><p>List contents of the given path or the current directory.</p></dd><dt><span class="term"><span class="command"><strong>pwd</strong></span></span></dt><dd><p>Display the path to the current node.</p></dd><dt><span class="term"><span class="command"><strong>quit</strong></span></span></dt><dd><p>Leave the shell.</p></dd><dt><span class="term"><span class="command"><strong>save <em class="replaceable"><code>FILENAME</code></em></strong></span></span></dt><dd><p> + Save the current document to the given filename or to the original name. + </p></dd><dt><span class="term"><code class="option">validate</code></span></dt><dd><p>Check the document for errors.</p></dd><dt><span class="term"><span class="command"><strong>write <em class="replaceable"><code>FILENAME</code></em></strong></span></span></dt><dd><p>Write the current node to the given filename.</p></dd></dl></div></div><div class="refsect1"><a name="environment"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="envar">SGML_CATALOG_FILES</code></span></dt><dd><p><acronym class="acronym">SGML</acronym> catalog behavior can be changed by redirecting + queries to the user's own set of catalogs. This can be done by setting + the <code class="envar">SGML_CATALOG_FILES</code> environment variable to a list + of catalogs. An empty one should deactivate loading the + default catalog. + </p></dd><dt><span class="term"><code class="envar">XML_CATALOG_FILES</code></span></dt><dd><p><acronym class="acronym">XML</acronym> catalog behavior can be changed by redirecting + queries to the user's own set of catalogs. This can be done by setting + the <code class="envar">XML_CATALOG_FILES</code> environment variable to a space-separated + list of catalogs. Use percent-encoding to escape spaces or other characters. + An empty variable should deactivate loading the default catalog. + </p></dd><dt><span class="term"><code class="envar">XML_DEBUG_CATALOG</code></span></dt><dd><p>Setting the environment variable <code class="envar">XML_DEBUG_CATALOG</code> + to <em class="parameter"><code>non-zero</code></em> using the <span class="command"><strong>export</strong></span> + command outputs debugging information related to catalog operations. + </p></dd><dt><span class="term"><code class="envar">XMLLINT_INDENT</code></span></dt><dd><p>Setting the environment variable <code class="envar">XMLLINT_INDENT</code> + controls the indentation. The default value is two spaces " ". + </p></dd></dl></div></div><div class="refsect1"><a name="diagnostics"></a><h2>DIAGNOSTICS</h2><p> + <span class="command"><strong>xmllint</strong></span> return codes provide information that can be used when + calling it from scripts. + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="errorcode">0</span></span></dt><dd><p>No error</p></dd><dt><span class="term"><span class="errorcode">1</span></span></dt><dd><p>Unclassified</p></dd><dt><span class="term"><span class="errorcode">2</span></span></dt><dd><p>Error in <acronym class="acronym">DTD</acronym></p></dd><dt><span class="term"><span class="errorcode">3</span></span></dt><dd><p>Validation error</p></dd><dt><span class="term"><span class="errorcode">4</span></span></dt><dd><p>Validation error</p></dd><dt><span class="term"><span class="errorcode">5</span></span></dt><dd><p>Error in schema compilation</p></dd><dt><span class="term"><span class="errorcode">6</span></span></dt><dd><p>Error writing output</p></dd><dt><span class="term"><span class="errorcode">7</span></span></dt><dd><p> + Error in pattern (generated when <code class="option">--pattern</code> option is used) + </p></dd><dt><span class="term"><span class="errorcode">8</span></span></dt><dd><p> + Error in Reader registration (generated + when <code class="option">--chkregister</code> option is used) + </p></dd><dt><span class="term"><span class="errorcode">9</span></span></dt><dd><p>Out of memory error</p></dd><dt><span class="term"><span class="errorcode">10</span></span></dt><dd><p>XPath evaluation error</p></dd></dl></div></div><div class="refsect1"><a name="seealso"></a><h2>SEE ALSO</h2><p><span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span> + </p><p> + More information can be found at + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="citerefentry"><span class="refentrytitle">libxml</span>(3)</span> web page <a class="ulink" href="https://gitlab.gnome.org/GNOME/libxml2" target="_top">https://gitlab.gnome.org/GNOME/libxml2</a> + </p></li></ul></div><p> + </p></div></div></body></html> @@ -25770,23 +25770,23 @@ test_xmlValidateElement(void) { int n_ctxt; xmlDocPtr doc; /* a document instance */ int n_doc; - xmlNodePtr elem; /* an element instance */ - int n_elem; + xmlNodePtr root; /* */ + int n_root; for (n_ctxt = 0;n_ctxt < gen_nb_xmlValidCtxtPtr;n_ctxt++) { for (n_doc = 0;n_doc < gen_nb_xmlDocPtr;n_doc++) { - for (n_elem = 0;n_elem < gen_nb_xmlNodePtr;n_elem++) { + for (n_root = 0;n_root < gen_nb_xmlNodePtr;n_root++) { mem_base = xmlMemBlocks(); ctxt = gen_xmlValidCtxtPtr(n_ctxt, 0); doc = gen_xmlDocPtr(n_doc, 1); - elem = gen_xmlNodePtr(n_elem, 2); + root = gen_xmlNodePtr(n_root, 2); - ret_val = xmlValidateElement(ctxt, doc, elem); + ret_val = xmlValidateElement(ctxt, doc, root); desret_int(ret_val); call_tests++; des_xmlValidCtxtPtr(n_ctxt, ctxt, 0); des_xmlDocPtr(n_doc, doc, 1); - des_xmlNodePtr(n_elem, elem, 2); + des_xmlNodePtr(n_root, root, 2); xmlResetLastError(); if (mem_base != xmlMemBlocks()) { printf("Leak of %d blocks found in xmlValidateElement", @@ -25794,7 +25794,7 @@ test_xmlValidateElement(void) { test_ret++; printf(" %d", n_ctxt); printf(" %d", n_doc); - printf(" %d", n_elem); + printf(" %d", n_root); printf("\n"); } } @@ -34695,9 +34695,11 @@ test_xmlSchemaInitTypes(void) { int test_ret = 0; #if defined(LIBXML_SCHEMAS_ENABLED) + int ret_val; - xmlSchemaInitTypes(); + ret_val = xmlSchemaInitTypes(); + desret_int(ret_val); call_tests++; xmlResetLastError(); function_tests++; |