Daniel Veillard | 43d3f61 | 2001-11-10 11:57:23 +0000 | [diff] [blame] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd"> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 2 | <html> |
| 3 | <head> |
Daniel Veillard | 7216cfd | 2002-11-08 15:10:00 +0000 | [diff] [blame] | 4 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
Daniel Veillard | c332dab | 2002-03-29 14:08:27 +0000 | [diff] [blame] | 5 | <link rel="SHORTCUT ICON" href="/favicon.ico"> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 6 | <style type="text/css"><!-- |
Daniel Veillard | 373a475 | 2002-02-21 14:46:29 +0000 | [diff] [blame] | 7 | TD {font-family: Verdana,Arial,Helvetica} |
| 8 | BODY {font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em} |
| 9 | H1 {font-family: Verdana,Arial,Helvetica} |
| 10 | H2 {font-family: Verdana,Arial,Helvetica} |
| 11 | H3 {font-family: Verdana,Arial,Helvetica} |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 12 | A:link, A:visited, A:active { text-decoration: underline } |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 13 | --></style> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 14 | <title>The parser interfaces</title> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 15 | </head> |
| 16 | <body bgcolor="#8b7765" text="#000000" link="#000000" vlink="#000000"> |
| 17 | <table border="0" width="100%" cellpadding="5" cellspacing="0" align="center"><tr> |
| 18 | <td width="180"> |
Daniel Veillard | 8f40f1e | 2002-08-28 21:18:45 +0000 | [diff] [blame] | 19 | <a href="http://www.gnome.org/"><img src="gnome2.png" alt="Gnome2 Logo"></a><a href="http://www.w3.org/Status"><img src="w3c.png" alt="W3C Logo"></a><a href="http://www.redhat.com/"><img src="redhat.gif" alt="Red Hat Logo"></a><div align="left"><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-180x168.gif" alt="Made with Libxml2 Logo"></a></div> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 20 | </td> |
| 21 | <td><table border="0" width="90%" cellpadding="2" cellspacing="0" align="center" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3" bgcolor="#fffacd"><tr><td align="center"> |
| 22 | <h1>The XML C library for Gnome</h1> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 23 | <h2>The parser interfaces</h2> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 24 | </td></tr></table></td></tr></table></td> |
| 25 | </tr></table> |
| 26 | <table border="0" cellpadding="4" cellspacing="0" width="100%" align="center"><tr><td bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr> |
Daniel Veillard | 594cf0b | 2001-10-25 08:09:12 +0000 | [diff] [blame] | 27 | <td valign="top" width="200" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td> |
| 28 | <table width="100%" border="0" cellspacing="1" cellpadding="3"> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 29 | <tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Main Menu</b></center></td></tr> |
Daniel Veillard | 8acca11 | 2002-01-21 09:52:27 +0000 | [diff] [blame] | 30 | <tr><td bgcolor="#fffacd"><ul> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 31 | <li><a href="index.html">Home</a></li> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 32 | <li><a href="intro.html">Introduction</a></li> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 33 | <li><a href="FAQ.html">FAQ</a></li> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 34 | <li><a href="docs.html">Documentation</a></li> |
| 35 | <li><a href="bugs.html">Reporting bugs and getting help</a></li> |
| 36 | <li><a href="help.html">How to help</a></li> |
| 37 | <li><a href="downloads.html">Downloads</a></li> |
| 38 | <li><a href="news.html">News</a></li> |
Daniel Veillard | 7b602b4 | 2002-01-08 13:26:00 +0000 | [diff] [blame] | 39 | <li><a href="XMLinfo.html">XML</a></li> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 40 | <li><a href="XSLT.html">XSLT</a></li> |
Daniel Veillard | 6dbcaf8 | 2002-02-20 14:37:47 +0000 | [diff] [blame] | 41 | <li><a href="python.html">Python and bindings</a></li> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 42 | <li><a href="architecture.html">libxml architecture</a></li> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 43 | <li><a href="tree.html">The tree output</a></li> |
| 44 | <li><a href="interface.html">The SAX interface</a></li> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 45 | <li><a href="xmldtd.html">Validation & DTDs</a></li> |
| 46 | <li><a href="xmlmem.html">Memory Management</a></li> |
| 47 | <li><a href="encoding.html">Encodings support</a></li> |
| 48 | <li><a href="xmlio.html">I/O Interfaces</a></li> |
| 49 | <li><a href="catalog.html">Catalog support</a></li> |
| 50 | <li><a href="library.html">The parser interfaces</a></li> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 51 | <li><a href="entities.html">Entities or no entities</a></li> |
| 52 | <li><a href="namespaces.html">Namespaces</a></li> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 53 | <li><a href="upgrade.html">Upgrading 1.x code</a></li> |
Daniel Veillard | 52dcab3 | 2001-10-30 12:51:17 +0000 | [diff] [blame] | 54 | <li><a href="threads.html">Thread safety</a></li> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 55 | <li><a href="DOM.html">DOM Principles</a></li> |
| 56 | <li><a href="example.html">A real example</a></li> |
| 57 | <li><a href="contribs.html">Contributions</a></li> |
Daniel Veillard | 7b4b2f9 | 2003-01-06 13:11:20 +0000 | [diff] [blame^] | 58 | <li><a href="xmlreader.html">The Reader Interface</a></li> |
Daniel Veillard | fc59c09 | 2002-06-05 14:48:26 +0000 | [diff] [blame] | 59 | <li><a href="tutorial/index.html">Tutorial</a></li> |
Daniel Veillard | 7b4b2f9 | 2003-01-06 13:11:20 +0000 | [diff] [blame^] | 60 | <li><a href="guidelines.html">XML Guidelines</a></li> |
Daniel Veillard | 594cf0b | 2001-10-25 08:09:12 +0000 | [diff] [blame] | 61 | <li> |
| 62 | <a href="xml.html">flat page</a>, <a href="site.xsl">stylesheet</a> |
| 63 | </li> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 64 | </ul></td></tr> |
Daniel Veillard | 594cf0b | 2001-10-25 08:09:12 +0000 | [diff] [blame] | 65 | </table> |
| 66 | <table width="100%" border="0" cellspacing="1" cellpadding="3"> |
Daniel Veillard | 3bf65be | 2002-01-23 12:36:34 +0000 | [diff] [blame] | 67 | <tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>API Indexes</b></center></td></tr> |
Daniel Veillard | 5ede35e | 2002-10-01 11:37:35 +0000 | [diff] [blame] | 68 | <tr><td bgcolor="#fffacd"> |
Daniel Veillard | 595978c | 2002-10-09 18:46:35 +0000 | [diff] [blame] | 69 | <form action="search.php" enctype="application/x-www-form-urlencoded" method="GET"> |
Daniel Veillard | 5ede35e | 2002-10-01 11:37:35 +0000 | [diff] [blame] | 70 | <input name="query" type="TEXT" size="20" value=""><input name="submit" type="submit" value="Search ..."> |
| 71 | </form> |
| 72 | <ul> |
Daniel Veillard | f859256 | 2002-01-23 17:58:17 +0000 | [diff] [blame] | 73 | <li><a href="APIchunk0.html">Alphabetic</a></li> |
Daniel Veillard | 3bf65be | 2002-01-23 12:36:34 +0000 | [diff] [blame] | 74 | <li><a href="APIconstructors.html">Constructors</a></li> |
| 75 | <li><a href="APIfunctions.html">Functions/Types</a></li> |
| 76 | <li><a href="APIfiles.html">Modules</a></li> |
| 77 | <li><a href="APIsymbols.html">Symbols</a></li> |
Daniel Veillard | 5ede35e | 2002-10-01 11:37:35 +0000 | [diff] [blame] | 78 | </ul> |
| 79 | </td></tr> |
Daniel Veillard | 3bf65be | 2002-01-23 12:36:34 +0000 | [diff] [blame] | 80 | </table> |
| 81 | <table width="100%" border="0" cellspacing="1" cellpadding="3"> |
Daniel Veillard | 594cf0b | 2001-10-25 08:09:12 +0000 | [diff] [blame] | 82 | <tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr> |
Daniel Veillard | 8acca11 | 2002-01-21 09:52:27 +0000 | [diff] [blame] | 83 | <tr><td bgcolor="#fffacd"><ul> |
Daniel Veillard | 594cf0b | 2001-10-25 08:09:12 +0000 | [diff] [blame] | 84 | <li><a href="http://mail.gnome.org/archives/xml/">Mail archive</a></li> |
| 85 | <li><a href="http://xmlsoft.org/XSLT/">XSLT libxslt</a></li> |
Daniel Veillard | 4a85920 | 2002-01-08 11:49:22 +0000 | [diff] [blame] | 86 | <li><a href="http://phd.cs.unibo.it/gdome2/">DOM gdome2</a></li> |
Daniel Veillard | 2d347fa | 2002-03-17 10:34:11 +0000 | [diff] [blame] | 87 | <li><a href="http://www.aleksey.com/xmlsec/">XML-DSig xmlsec</a></li> |
Daniel Veillard | 594cf0b | 2001-10-25 08:09:12 +0000 | [diff] [blame] | 88 | <li><a href="ftp://xmlsoft.org/">FTP</a></li> |
Daniel Veillard | c84f8b5 | 2002-12-19 22:12:47 +0000 | [diff] [blame] | 89 | <li><a href="http://www.zlatkovic.com/projects/libxml/">Windows binaries</a></li> |
Daniel Veillard | db9dfd9 | 2001-11-26 17:25:02 +0000 | [diff] [blame] | 90 | <li><a href="http://garypennington.net/libxml2/">Solaris binaries</a></li> |
Daniel Veillard | cb7543b | 2002-09-09 10:54:06 +0000 | [diff] [blame] | 91 | <li><a href="http://www.zveno.com/open_source/libxml2xslt.html">MacOsX binaries</a></li> |
Daniel Veillard | e6d8e20 | 2002-05-02 06:11:10 +0000 | [diff] [blame] | 92 | <li><a href="http://sourceforge.net/projects/libxml2-pas/">Pascal bindings</a></li> |
Daniel Veillard | 2d347fa | 2002-03-17 10:34:11 +0000 | [diff] [blame] | 93 | <li><a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml&product=libxml2">Bug Tracker</a></li> |
Daniel Veillard | 594cf0b | 2001-10-25 08:09:12 +0000 | [diff] [blame] | 94 | </ul></td></tr> |
| 95 | </table> |
| 96 | </td></tr></table></td> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 97 | <td valign="top" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%"><tr><td><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table border="0" cellpadding="3" cellspacing="1" width="100%"><tr><td bgcolor="#fffacd"> |
| 98 | <p>This section is directly intended to help programmers getting bootstrapped |
| 99 | using the XML library from the C language. It is not intended to be |
| 100 | extensive. I hope the automatically generated documents will provide the |
| 101 | completeness required, but as a separate set of documents. The interfaces of |
| 102 | the XML library are by principle low level, there is nearly zero abstraction. |
| 103 | Those interested in a higher level API should <a href="#DOM">look at |
| 104 | DOM</a>.</p> |
| 105 | <p>The <a href="html/libxml-parser.html">parser interfaces for XML</a> are |
| 106 | separated from the <a href="html/libxml-htmlparser.html">HTML parser |
| 107 | interfaces</a>. Let's have a look at how the XML parser can be called:</p> |
| 108 | <h3><a name="Invoking">Invoking the parser : the pull method</a></h3> |
| 109 | <p>Usually, the first thing to do is to read an XML input. The parser accepts |
| 110 | documents either from in-memory strings or from files. The functions are |
| 111 | defined in "parser.h":</p> |
| 112 | <dl> |
| 113 | <dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt> |
Daniel Veillard | 0b28e88 | 2002-07-24 23:47:05 +0000 | [diff] [blame] | 114 | <dd> |
| 115 | <p>Parse a null-terminated string containing the document.</p> |
| 116 | </dd> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 117 | </dl> |
| 118 | <dl> |
| 119 | <dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt> |
Daniel Veillard | 0b28e88 | 2002-07-24 23:47:05 +0000 | [diff] [blame] | 120 | <dd> |
| 121 | <p>Parse an XML document contained in a (possibly compressed) |
| 122 | file.</p> |
| 123 | </dd> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 124 | </dl> |
| 125 | <p>The parser returns a pointer to the document structure (or NULL in case of |
| 126 | failure).</p> |
| 127 | <h3 id="Invoking1">Invoking the parser: the push method</h3> |
| 128 | <p>In order for the application to keep the control when the document is |
| 129 | being fetched (which is common for GUI based programs) libxml provides a push |
| 130 | interface, too, as of version 1.8.3. Here are the interface functions:</p> |
| 131 | <pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax, |
| 132 | void *user_data, |
| 133 | const char *chunk, |
| 134 | int size, |
| 135 | const char *filename); |
| 136 | int xmlParseChunk (xmlParserCtxtPtr ctxt, |
| 137 | const char *chunk, |
| 138 | int size, |
| 139 | int terminate);</pre> |
| 140 | <p>and here is a simple example showing how to use the interface:</p> |
| 141 | <pre> FILE *f; |
| 142 | |
| 143 | f = fopen(filename, "r"); |
| 144 | if (f != NULL) { |
| 145 | int res, size = 1024; |
| 146 | char chars[1024]; |
| 147 | xmlParserCtxtPtr ctxt; |
| 148 | |
| 149 | res = fread(chars, 1, 4, f); |
| 150 | if (res > 0) { |
| 151 | ctxt = xmlCreatePushParserCtxt(NULL, NULL, |
| 152 | chars, res, filename); |
| 153 | while ((res = fread(chars, 1, size, f)) > 0) { |
| 154 | xmlParseChunk(ctxt, chars, res, 0); |
| 155 | } |
| 156 | xmlParseChunk(ctxt, chars, 0, 1); |
| 157 | doc = ctxt->myDoc; |
| 158 | xmlFreeParserCtxt(ctxt); |
| 159 | } |
| 160 | }</pre> |
| 161 | <p>The HTML parser embedded into libxml also has a push interface; the |
| 162 | functions are just prefixed by "html" rather than "xml".</p> |
| 163 | <h3 id="Invoking2">Invoking the parser: the SAX interface</h3> |
| 164 | <p>The tree-building interface makes the parser memory-hungry, first loading |
| 165 | the document in memory and then building the tree itself. Reading a document |
| 166 | without building the tree is possible using the SAX interfaces (see SAX.h and |
| 167 | <a href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">James |
| 168 | Henstridge's documentation</a>). Note also that the push interface can be |
| 169 | limited to SAX: just use the two first arguments of |
| 170 | <code>xmlCreatePushParserCtxt()</code>.</p> |
| 171 | <h3><a name="Building">Building a tree from scratch</a></h3> |
| 172 | <p>The other way to get an XML tree in memory is by building it. Basically |
| 173 | there is a set of functions dedicated to building new elements. (These are |
| 174 | also described in <libxml/tree.h>.) For example, here is a piece of |
| 175 | code that produces the XML document used in the previous examples:</p> |
| 176 | <pre> #include <libxml/tree.h> |
| 177 | xmlDocPtr doc; |
| 178 | xmlNodePtr tree, subtree; |
| 179 | |
| 180 | doc = xmlNewDoc("1.0"); |
| 181 | doc->children = xmlNewDocNode(doc, NULL, "EXAMPLE", NULL); |
| 182 | xmlSetProp(doc->children, "prop1", "gnome is great"); |
| 183 | xmlSetProp(doc->children, "prop2", "& linux too"); |
| 184 | tree = xmlNewChild(doc->children, NULL, "head", NULL); |
| 185 | subtree = xmlNewChild(tree, NULL, "title", "Welcome to Gnome"); |
| 186 | tree = xmlNewChild(doc->children, NULL, "chapter", NULL); |
| 187 | subtree = xmlNewChild(tree, NULL, "title", "The Linux adventure"); |
| 188 | subtree = xmlNewChild(tree, NULL, "p", "bla bla bla ..."); |
| 189 | subtree = xmlNewChild(tree, NULL, "image", NULL); |
| 190 | xmlSetProp(subtree, "href", "linus.gif");</pre> |
| 191 | <p>Not really rocket science ...</p> |
| 192 | <h3><a name="Traversing">Traversing the tree</a></h3> |
| 193 | <p>Basically by <a href="html/libxml-tree.html">including "tree.h"</a> your |
| 194 | code has access to the internal structure of all the elements of the tree. |
| 195 | The names should be somewhat simple like <strong>parent</strong>, |
| 196 | <strong>children</strong>, <strong>next</strong>, <strong>prev</strong>, |
| 197 | <strong>properties</strong>, etc... For example, still with the previous |
| 198 | example:</p> |
| 199 | <pre><code>doc->children->children->children</code></pre> |
| 200 | <p>points to the title element,</p> |
| 201 | <pre>doc->children->children->next->children->children</pre> |
| 202 | <p>points to the text node containing the chapter title "The Linux |
| 203 | adventure".</p> |
| 204 | <p> |
| 205 | <strong>NOTE</strong>: XML allows <em>PI</em>s and <em>comments</em> to be |
| 206 | present before the document root, so <code>doc->children</code> may point |
| 207 | to an element which is not the document Root Element; a function |
| 208 | <code>xmlDocGetRootElement()</code> was added for this purpose.</p> |
| 209 | <h3><a name="Modifying">Modifying the tree</a></h3> |
| 210 | <p>Functions are provided for reading and writing the document content. Here |
| 211 | is an excerpt from the <a href="html/libxml-tree.html">tree API</a>:</p> |
| 212 | <dl> |
| 213 | <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const |
| 214 | xmlChar *value);</code></dt> |
Daniel Veillard | 0b28e88 | 2002-07-24 23:47:05 +0000 | [diff] [blame] | 215 | <dd> |
| 216 | <p>This sets (or changes) an attribute carried by an ELEMENT node. |
| 217 | The value can be NULL.</p> |
| 218 | </dd> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 219 | </dl> |
| 220 | <dl> |
| 221 | <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar |
| 222 | *name);</code></dt> |
Daniel Veillard | 0b28e88 | 2002-07-24 23:47:05 +0000 | [diff] [blame] | 223 | <dd> |
| 224 | <p>This function returns a pointer to new copy of the property |
| 225 | content. Note that the user must deallocate the result.</p> |
| 226 | </dd> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 227 | </dl> |
| 228 | <p>Two functions are provided for reading and writing the text associated |
| 229 | with elements:</p> |
| 230 | <dl> |
| 231 | <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar |
| 232 | *value);</code></dt> |
Daniel Veillard | 0b28e88 | 2002-07-24 23:47:05 +0000 | [diff] [blame] | 233 | <dd> |
| 234 | <p>This function takes an "external" string and converts it to one |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 235 | text node or possibly to a list of entity and text nodes. All |
| 236 | non-predefined entity references like &Gnome; will be stored |
| 237 | internally as entity nodes, hence the result of the function may not be |
Daniel Veillard | 0b28e88 | 2002-07-24 23:47:05 +0000 | [diff] [blame] | 238 | a single node.</p> |
| 239 | </dd> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 240 | </dl> |
| 241 | <dl> |
| 242 | <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int |
| 243 | inLine);</code></dt> |
Daniel Veillard | 0b28e88 | 2002-07-24 23:47:05 +0000 | [diff] [blame] | 244 | <dd> |
| 245 | <p>This function is the inverse of |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 246 | <code>xmlStringGetNodeList()</code>. It generates a new string |
| 247 | containing the content of the text and entity nodes. Note the extra |
| 248 | argument inLine. If this argument is set to 1, the function will expand |
| 249 | entity references. For example, instead of returning the &Gnome; |
| 250 | XML encoding in the string, it will substitute it with its value (say, |
Daniel Veillard | 0b28e88 | 2002-07-24 23:47:05 +0000 | [diff] [blame] | 251 | "GNU Network Object Model Environment").</p> |
| 252 | </dd> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 253 | </dl> |
| 254 | <h3><a name="Saving">Saving a tree</a></h3> |
| 255 | <p>Basically 3 options are possible:</p> |
| 256 | <dl> |
| 257 | <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int |
| 258 | *size);</code></dt> |
Daniel Veillard | 0b28e88 | 2002-07-24 23:47:05 +0000 | [diff] [blame] | 259 | <dd> |
| 260 | <p>Returns a buffer into which the document has been saved.</p> |
| 261 | </dd> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 262 | </dl> |
| 263 | <dl> |
| 264 | <dt><code>extern void xmlDocDump(FILE *f, xmlDocPtr doc);</code></dt> |
Daniel Veillard | 0b28e88 | 2002-07-24 23:47:05 +0000 | [diff] [blame] | 265 | <dd> |
| 266 | <p>Dumps a document to an open file descriptor.</p> |
| 267 | </dd> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 268 | </dl> |
| 269 | <dl> |
| 270 | <dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt> |
Daniel Veillard | 0b28e88 | 2002-07-24 23:47:05 +0000 | [diff] [blame] | 271 | <dd> |
| 272 | <p>Saves the document to a file. In this case, the compression |
| 273 | interface is triggered if it has been turned on.</p> |
| 274 | </dd> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 275 | </dl> |
| 276 | <h3><a name="Compressio">Compression</a></h3> |
| 277 | <p>The library transparently handles compression when doing file-based |
| 278 | accesses. The level of compression on saves can be turned on either globally |
| 279 | or individually for one file:</p> |
| 280 | <dl> |
| 281 | <dt><code>int xmlGetDocCompressMode (xmlDocPtr doc);</code></dt> |
Daniel Veillard | 0b28e88 | 2002-07-24 23:47:05 +0000 | [diff] [blame] | 282 | <dd> |
| 283 | <p>Gets the document compression ratio (0-9).</p> |
| 284 | </dd> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 285 | </dl> |
| 286 | <dl> |
| 287 | <dt><code>void xmlSetDocCompressMode (xmlDocPtr doc, int mode);</code></dt> |
Daniel Veillard | 0b28e88 | 2002-07-24 23:47:05 +0000 | [diff] [blame] | 288 | <dd> |
| 289 | <p>Sets the document compression ratio.</p> |
| 290 | </dd> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 291 | </dl> |
| 292 | <dl> |
| 293 | <dt><code>int xmlGetCompressMode(void);</code></dt> |
Daniel Veillard | 0b28e88 | 2002-07-24 23:47:05 +0000 | [diff] [blame] | 294 | <dd> |
| 295 | <p>Gets the default compression ratio.</p> |
| 296 | </dd> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 297 | </dl> |
| 298 | <dl> |
| 299 | <dt><code>void xmlSetCompressMode(int mode);</code></dt> |
Daniel Veillard | 0b28e88 | 2002-07-24 23:47:05 +0000 | [diff] [blame] | 300 | <dd> |
| 301 | <p>Sets the default compression ratio.</p> |
| 302 | </dd> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 303 | </dl> |
Daniel Veillard | 3f4c40f | 2002-02-13 09:19:28 +0000 | [diff] [blame] | 304 | <p><a href="bugs.html">Daniel Veillard</a></p> |
Daniel Veillard | c948420 | 2001-10-24 12:35:52 +0000 | [diff] [blame] | 305 | </td></tr></table></td></tr></table></td></tr></table></td> |
| 306 | </tr></table></td></tr></table> |
| 307 | </body> |
| 308 | </html> |