diff options
Diffstat (limited to 'docs/html/namespacepugi.html')
-rw-r--r-- | docs/html/namespacepugi.html | 668 |
1 files changed, 668 insertions, 0 deletions
diff --git a/docs/html/namespacepugi.html b/docs/html/namespacepugi.html new file mode 100644 index 0000000..30b9247 --- /dev/null +++ b/docs/html/namespacepugi.html @@ -0,0 +1,668 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>pugixml: pugi Namespace Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.6-NO --> +<div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li id="current"><a href="namespaces.html"><span>Namespaces</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + </ul></div> +<div class="tabs"> + <ul> + <li><a href="namespaces.html"><span>Namespace List</span></a></li> + <li><a href="namespacemembers.html"><span>Namespace Members</span></a></li> + </ul></div> +<h1>pugi Namespace Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> +The PugiXML Parser namespace. +<p> + +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Classes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xpath__query.html">xpath_query</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A class that holds compiled XPath query and allows to evaluate query result. <a href="classpugi_1_1xpath__query.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xml__attribute.html">xml_attribute</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A light-weight wrapper for manipulating attributes in DOM tree. <a href="classpugi_1_1xml__attribute.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xml__node.html">xml_node</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A light-weight wrapper for manipulating nodes in DOM tree. <a href="classpugi_1_1xml__node.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xml__node__iterator.html">xml_node_iterator</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Child node iterator. <a href="classpugi_1_1xml__node__iterator.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xml__attribute__iterator.html">xml_attribute_iterator</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Attribute iterator. <a href="classpugi_1_1xml__attribute__iterator.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xml__tree__walker.html">xml_tree_walker</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Abstract tree walker class. <a href="classpugi_1_1xml__tree__walker.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>xml_memory_block</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structpugi_1_1transfer__ownership__tag.html">transfer_ownership_tag</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Struct used to distinguish parsing with ownership transfer from parsing without it. <a href="structpugi_1_1transfer__ownership__tag.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xml__document.html">xml_document</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Document class (DOM tree root). <a href="classpugi_1_1xml__document.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xpath__exception.html">xpath_exception</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">XPath exception class. <a href="classpugi_1_1xpath__exception.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xpath__node.html">xpath_node</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">XPath node class. <a href="classpugi_1_1xpath__node.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xpath__node__set.html">xpath_node_set</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Not necessarily ordered constant collection of XPath nodes. <a href="classpugi_1_1xpath__node__set.html#_details">More...</a><br></td></tr> +<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#137e94a038e4ab0ada6477cf7f6153a9">xml_node_type</a> { <br> + <a class="el" href="namespacepugi.html#137e94a038e4ab0ada6477cf7f6153a9d58c55e810076e076318cc2268191b1f">node_null</a>, +<a class="el" href="namespacepugi.html#137e94a038e4ab0ada6477cf7f6153a9ab42ba83cf941f7297325eade205bf80">node_document</a>, +<a class="el" href="namespacepugi.html#137e94a038e4ab0ada6477cf7f6153a96d223e3a0d8ce8e4ee6f4a2697b8bcd1">node_element</a>, +<a class="el" href="namespacepugi.html#137e94a038e4ab0ada6477cf7f6153a95c0042693a8b8b6b54c191b4403fca21">node_pcdata</a>, +<br> + <a class="el" href="namespacepugi.html#137e94a038e4ab0ada6477cf7f6153a9df13d60a4dfd047be0700e1711aeb1ea">node_cdata</a>, +<a class="el" href="namespacepugi.html#137e94a038e4ab0ada6477cf7f6153a9445fef674a66777dfd28dbd6bab14fed">node_comment</a>, +<a class="el" href="namespacepugi.html#137e94a038e4ab0ada6477cf7f6153a9cd772b12b3d5442b9771151f45134440">node_pi</a> +<br> + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tree node classification. <a href="namespacepugi.html#137e94a038e4ab0ada6477cf7f6153a9">More...</a><br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#55c7bb5900e82254aa1b9671c61030fd">as_utf8</a> (const wchar_t *str)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert utf16 to utf8. <a href="#55c7bb5900e82254aa1b9671c61030fd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">std::wstring </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#557d234d14b2da1cf7ad9b72a05d2698">as_utf16</a> (const char *str)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert utf8 to utf16. <a href="#557d234d14b2da1cf7ad9b72a05d2698"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Variables</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#bdec38e04651950fe8f585c912143a27">memory_block_size</a> = 32768</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Memory block size, used for fast allocator. <a href="#bdec38e04651950fe8f585c912143a27"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#e5058761cfd25d6cdb7e092659dae1fd">parse_minimal</a> = 0x0000</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Minimal parsing mode. <a href="#e5058761cfd25d6cdb7e092659dae1fd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#8fb7ea408d60b4f2ca79dd30b651f545">parse_pi</a> = 0x0001</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This flag determines if processing instructions (nodes with type node_pi; such nodes have the form of <? target content ?> or <? target ?> in XML) are to be put in DOM tree. <a href="#8fb7ea408d60b4f2ca79dd30b651f545"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#dcab316176bfaf69158339962fb4ad38">parse_comments</a> = 0x0002</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This flag determines if comments (nodes with type node_comment; such nodes have the form of in XML) are to be put in DOM tree. <a href="#dcab316176bfaf69158339962fb4ad38"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#47b679897f8bc15e4e152978fc88c208">parse_cdata</a> = 0x0004</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This flag determines if CDATA sections (nodes with type node_cdata; such nodes have the form of <![CDATA[[content]]> in XML) are to be put in DOM tree. <a href="#47b679897f8bc15e4e152978fc88c208"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#e492a24302294f1ce3fbd56f2edbf131">parse_ws_pcdata</a> = 0x0008</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This flag determines if nodes with PCDATA (regular text) that consist only of whitespace characters are to be put in DOM tree. <a href="#e492a24302294f1ce3fbd56f2edbf131"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#b5ef8454110599611900ff48012c8ad6">parse_escapes</a> = 0x0010</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This flag determines if character and entity references are to be expanded during the parsing process. <a href="#b5ef8454110599611900ff48012c8ad6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#d4e017365d2ff3ee04e226c35129b475">parse_eol</a> = 0x0020</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This flag determines if EOL handling (that is, replacing sequences 0x0d 0x0a by a single 0x0a character, and replacing all standalone 0x0d characters by 0x0a) is to be performed on input data (that is, comments contents, PCDATA/CDATA contents and attribute values). <a href="#d4e017365d2ff3ee04e226c35129b475"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#8617ea5ba78c676aff8b7af960cb2f4b">parse_wnorm_attribute</a> = 0x0040</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This flag determines if attribute value normalization should be performed for all attributes, assuming that their type is not CDATA. <a href="#8617ea5ba78c676aff8b7af960cb2f4b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#1e943812f2de36fc3ee14f7756afdbd7">parse_wconv_attribute</a> = 0x0080</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This flag determines if attribute value normalization should be performed for all attributes, assuming that their type is CDATA. <a href="#1e943812f2de36fc3ee14f7756afdbd7"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#d7c927d1c1752330637c3318b0d7b366">parse_default</a> = <a class="el" href="namespacepugi.html#47b679897f8bc15e4e152978fc88c208">parse_cdata</a> | <a class="el" href="namespacepugi.html#b5ef8454110599611900ff48012c8ad6">parse_escapes</a> | <a class="el" href="namespacepugi.html#1e943812f2de36fc3ee14f7756afdbd7">parse_wconv_attribute</a> | <a class="el" href="namespacepugi.html#d4e017365d2ff3ee04e226c35129b475">parse_eol</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This is the default set of flags. <a href="#d7c927d1c1752330637c3318b0d7b366"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#ce12e8dee65c5bae8ee42a64be7421d3">format_indent</a> = 0x01</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Indent the nodes that are written to output stream with as many indentation strings as deep the node is in DOM tree. <a href="#ce12e8dee65c5bae8ee42a64be7421d3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#9d81ecddcd68e273aa6bcf3864a0e3ee">format_utf8</a> = 0x02</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This flag determines how the non-printable symbols are written to output stream - they are either considered UTF-8 and are written as UTF-8 character, escaped with &#. <a href="#9d81ecddcd68e273aa6bcf3864a0e3ee"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#b863bcafd203aeaa98953df3a998243f">format_write_bom</a> = 0x04</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This flag determines if UTF-8 BOM is to be written to output stream. <a href="#b863bcafd203aeaa98953df3a998243f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#2dd811716b1c0a6a2431ceca43bc649e">format_raw</a> = 0x08</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">If this flag is on, no indentation is performed and no line breaks are written to output file. <a href="#2dd811716b1c0a6a2431ceca43bc649e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepugi.html#325f48a35abbaeacdfd8b7fc9ed1713c">format_default</a> = <a class="el" href="namespacepugi.html#ce12e8dee65c5bae8ee42a64be7421d3">format_indent</a> | <a class="el" href="namespacepugi.html#9d81ecddcd68e273aa6bcf3864a0e3ee">format_utf8</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This is the default set of formatting flags. <a href="#325f48a35abbaeacdfd8b7fc9ed1713c"></a><br></td></tr> +</table> +<hr><h2>Enumeration Type Documentation</h2> +<a class="anchor" name="137e94a038e4ab0ada6477cf7f6153a9"></a><!-- doxytag: member="pugi::xml_node_type" ref="137e94a038e4ab0ada6477cf7f6153a9" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">enum <a class="el" href="namespacepugi.html#137e94a038e4ab0ada6477cf7f6153a9">pugi::xml_node_type</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Tree node classification. +<p> +<dl compact><dt><b>Enumerator: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="137e94a038e4ab0ada6477cf7f6153a9d58c55e810076e076318cc2268191b1f"></a><!-- doxytag: member="node_null" ref="137e94a038e4ab0ada6477cf7f6153a9d58c55e810076e076318cc2268191b1f" args="" -->node_null</em> </td><td> +Undifferentiated entity. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="137e94a038e4ab0ada6477cf7f6153a9ab42ba83cf941f7297325eade205bf80"></a><!-- doxytag: member="node_document" ref="137e94a038e4ab0ada6477cf7f6153a9ab42ba83cf941f7297325eade205bf80" args="" -->node_document</em> </td><td> +A document tree's absolute root. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="137e94a038e4ab0ada6477cf7f6153a96d223e3a0d8ce8e4ee6f4a2697b8bcd1"></a><!-- doxytag: member="node_element" ref="137e94a038e4ab0ada6477cf7f6153a96d223e3a0d8ce8e4ee6f4a2697b8bcd1" args="" -->node_element</em> </td><td> +E.g. '<...>'. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="137e94a038e4ab0ada6477cf7f6153a95c0042693a8b8b6b54c191b4403fca21"></a><!-- doxytag: member="node_pcdata" ref="137e94a038e4ab0ada6477cf7f6153a95c0042693a8b8b6b54c191b4403fca21" args="" -->node_pcdata</em> </td><td> +E.g. '>...<'. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="137e94a038e4ab0ada6477cf7f6153a9df13d60a4dfd047be0700e1711aeb1ea"></a><!-- doxytag: member="node_cdata" ref="137e94a038e4ab0ada6477cf7f6153a9df13d60a4dfd047be0700e1711aeb1ea" args="" -->node_cdata</em> </td><td> +E.g. '<![CDATA[...]]>'. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="137e94a038e4ab0ada6477cf7f6153a9445fef674a66777dfd28dbd6bab14fed"></a><!-- doxytag: member="node_comment" ref="137e94a038e4ab0ada6477cf7f6153a9445fef674a66777dfd28dbd6bab14fed" args="" -->node_comment</em> </td><td> +E.g. ''. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="137e94a038e4ab0ada6477cf7f6153a9cd772b12b3d5442b9771151f45134440"></a><!-- doxytag: member="node_pi" ref="137e94a038e4ab0ada6477cf7f6153a9cd772b12b3d5442b9771151f45134440" args="" -->node_pi</em> </td><td> +E.g. '<?...?>'. </td></tr> +</table> +</dl> + </td> + </tr> +</table> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="55c7bb5900e82254aa1b9671c61030fd"></a><!-- doxytag: member="pugi::as_utf8" ref="55c7bb5900e82254aa1b9671c61030fd" args="(const wchar_t *str)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">std::string pugi::as_utf8 </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const wchar_t * </td> + <td class="mdname1" valign="top" nowrap> <em>str</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Convert utf16 to utf8. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>- input UTF16 string </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>output UTF8 string </dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="557d234d14b2da1cf7ad9b72a05d2698"></a><!-- doxytag: member="pugi::as_utf16" ref="557d234d14b2da1cf7ad9b72a05d2698" args="(const char *str)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">std::wstring pugi::as_utf16 </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname1" valign="top" nowrap> <em>str</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Convert utf8 to utf16. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>- input UTF8 string </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>output UTF16 string </dd></dl> + </td> + </tr> +</table> +<hr><h2>Variable Documentation</h2> +<a class="anchor" name="bdec38e04651950fe8f585c912143a27"></a><!-- doxytag: member="pugi::memory_block_size" ref="bdec38e04651950fe8f585c912143a27" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const size_t <a class="el" href="namespacepugi.html#bdec38e04651950fe8f585c912143a27">pugi::memory_block_size</a> = 32768 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Memory block size, used for fast allocator. +<p> +Memory for DOM tree is allocated in blocks of memory_block_size + 4. This value affects size of xml_memory class. </td> + </tr> +</table> +<a class="anchor" name="e5058761cfd25d6cdb7e092659dae1fd"></a><!-- doxytag: member="pugi::parse_minimal" ref="e5058761cfd25d6cdb7e092659dae1fd" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const unsigned int <a class="el" href="namespacepugi.html#e5058761cfd25d6cdb7e092659dae1fd">pugi::parse_minimal</a> = 0x0000 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Minimal parsing mode. +<p> +Equivalent to turning all other flags off. This set of flags means that pugixml does not add pi/cdata sections or comments to DOM tree and does not perform any conversions for input data, meaning fastest parsing. </td> + </tr> +</table> +<a class="anchor" name="8fb7ea408d60b4f2ca79dd30b651f545"></a><!-- doxytag: member="pugi::parse_pi" ref="8fb7ea408d60b4f2ca79dd30b651f545" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const unsigned int <a class="el" href="namespacepugi.html#8fb7ea408d60b4f2ca79dd30b651f545">pugi::parse_pi</a> = 0x0001 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +This flag determines if processing instructions (nodes with type node_pi; such nodes have the form of <? target content ?> or <? target ?> in XML) are to be put in DOM tree. +<p> +If this flag is off, they are not put in the tree, but are still parsed and checked for correctness.<p> +The corresponding node in DOM tree will have type node_pi, name "target" and value "content", if any.<p> +Note that <?xml ...?> (document declaration) is not considered to be a PI.<p> +This flag is off by default. </td> + </tr> +</table> +<a class="anchor" name="dcab316176bfaf69158339962fb4ad38"></a><!-- doxytag: member="pugi::parse_comments" ref="dcab316176bfaf69158339962fb4ad38" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const unsigned int <a class="el" href="namespacepugi.html#dcab316176bfaf69158339962fb4ad38">pugi::parse_comments</a> = 0x0002 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +This flag determines if comments (nodes with type node_comment; such nodes have the form of in XML) are to be put in DOM tree. +<p> +If this flag is off, they are not put in the tree, but are still parsed and checked for correctness.<p> +The corresponding node in DOM tree will have type node_comment, empty name and value "content".<p> +This flag is off by default. </td> + </tr> +</table> +<a class="anchor" name="47b679897f8bc15e4e152978fc88c208"></a><!-- doxytag: member="pugi::parse_cdata" ref="47b679897f8bc15e4e152978fc88c208" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const unsigned int <a class="el" href="namespacepugi.html#47b679897f8bc15e4e152978fc88c208">pugi::parse_cdata</a> = 0x0004 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +This flag determines if CDATA sections (nodes with type node_cdata; such nodes have the form of <![CDATA[[content]]> in XML) are to be put in DOM tree. +<p> +If this flag is off, they are not put in the tree, but are still parsed and checked for correctness.<p> +The corresponding node in DOM tree will have type node_cdata, empty name and value "content".<p> +This flag is on by default. </td> + </tr> +</table> +<a class="anchor" name="e492a24302294f1ce3fbd56f2edbf131"></a><!-- doxytag: member="pugi::parse_ws_pcdata" ref="e492a24302294f1ce3fbd56f2edbf131" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const unsigned int <a class="el" href="namespacepugi.html#e492a24302294f1ce3fbd56f2edbf131">pugi::parse_ws_pcdata</a> = 0x0008 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +This flag determines if nodes with PCDATA (regular text) that consist only of whitespace characters are to be put in DOM tree. +<p> +Often whitespace-only data is not significant for the application, and the cost of allocating and storing such nodes (both memory and speed-wise) can be significant. For example, after parsing XML string "<node> <a/> </node>", <node> element will have 3 children when parse_ws_pcdata is set (child with type node_pcdata and value=" ", child with type node_element and name "a", and another child with type node_pcdata and value=" "), and only 1 child when parse_ws_pcdata is not set.<p> +This flag is off by default. </td> + </tr> +</table> +<a class="anchor" name="b5ef8454110599611900ff48012c8ad6"></a><!-- doxytag: member="pugi::parse_escapes" ref="b5ef8454110599611900ff48012c8ad6" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const unsigned int <a class="el" href="namespacepugi.html#b5ef8454110599611900ff48012c8ad6">pugi::parse_escapes</a> = 0x0010 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +This flag determines if character and entity references are to be expanded during the parsing process. +<p> +Character references are &#...; or &x...; (... is Unicode numeric representation of character in either decimal (&#...;) or hexadecimal (&x...;) form), entity references are &...; Note that as pugixml does not handle DTD, the only allowed entities are predefined ones - &lt;, &gt;, &amp;, &apos; and &quot;. If character/entity reference can not be expanded, it is leaved as is, so you can do additional processing later. Reference expansion is performed in attribute values and PCDATA content.<p> +This flag is on by default. </td> + </tr> +</table> +<a class="anchor" name="d4e017365d2ff3ee04e226c35129b475"></a><!-- doxytag: member="pugi::parse_eol" ref="d4e017365d2ff3ee04e226c35129b475" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const unsigned int <a class="el" href="namespacepugi.html#d4e017365d2ff3ee04e226c35129b475">pugi::parse_eol</a> = 0x0020 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +This flag determines if EOL handling (that is, replacing sequences 0x0d 0x0a by a single 0x0a character, and replacing all standalone 0x0d characters by 0x0a) is to be performed on input data (that is, comments contents, PCDATA/CDATA contents and attribute values). +<p> +This flag is on by default. </td> + </tr> +</table> +<a class="anchor" name="8617ea5ba78c676aff8b7af960cb2f4b"></a><!-- doxytag: member="pugi::parse_wnorm_attribute" ref="8617ea5ba78c676aff8b7af960cb2f4b" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const unsigned int <a class="el" href="namespacepugi.html#8617ea5ba78c676aff8b7af960cb2f4b">pugi::parse_wnorm_attribute</a> = 0x0040 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +This flag determines if attribute value normalization should be performed for all attributes, assuming that their type is not CDATA. +<p> +This means, that: 1. Whitespace characters (new line, tab and space) are replaced with space (' ') 2. Afterwards sequences of spaces are replaced with a single space 3. Leading/trailing whitespace characters are trimmed<p> +This flag is off by default. </td> + </tr> +</table> +<a class="anchor" name="1e943812f2de36fc3ee14f7756afdbd7"></a><!-- doxytag: member="pugi::parse_wconv_attribute" ref="1e943812f2de36fc3ee14f7756afdbd7" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const unsigned int <a class="el" href="namespacepugi.html#1e943812f2de36fc3ee14f7756afdbd7">pugi::parse_wconv_attribute</a> = 0x0080 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +This flag determines if attribute value normalization should be performed for all attributes, assuming that their type is CDATA. +<p> +This means, that whitespace characters (new line, tab and space) are replaced with space (' '). Note, that the actions performed while this flag is on are also performed if parse_wnorm_attribute is on, so this flag has no effect if parse_wnorm_attribute flag is set.<p> +This flag is on by default. </td> + </tr> +</table> +<a class="anchor" name="d7c927d1c1752330637c3318b0d7b366"></a><!-- doxytag: member="pugi::parse_default" ref="d7c927d1c1752330637c3318b0d7b366" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const unsigned int <a class="el" href="namespacepugi.html#d7c927d1c1752330637c3318b0d7b366">pugi::parse_default</a> = <a class="el" href="namespacepugi.html#47b679897f8bc15e4e152978fc88c208">parse_cdata</a> | <a class="el" href="namespacepugi.html#b5ef8454110599611900ff48012c8ad6">parse_escapes</a> | <a class="el" href="namespacepugi.html#1e943812f2de36fc3ee14f7756afdbd7">parse_wconv_attribute</a> | <a class="el" href="namespacepugi.html#d4e017365d2ff3ee04e226c35129b475">parse_eol</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +This is the default set of flags. +<p> +It includes parsing CDATA sections (comments/PIs are not parsed), performing character and entity reference expansion, replacing whitespace characters with spaces in attribute values and performing EOL handling. Note, that PCDATA sections consisting only of whitespace characters are not parsed (by default) for performance reasons. </td> + </tr> +</table> +<a class="anchor" name="ce12e8dee65c5bae8ee42a64be7421d3"></a><!-- doxytag: member="pugi::format_indent" ref="ce12e8dee65c5bae8ee42a64be7421d3" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const unsigned int <a class="el" href="namespacepugi.html#ce12e8dee65c5bae8ee42a64be7421d3">pugi::format_indent</a> = 0x01 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Indent the nodes that are written to output stream with as many indentation strings as deep the node is in DOM tree. +<p> +This flag is on by default. </td> + </tr> +</table> +<a class="anchor" name="9d81ecddcd68e273aa6bcf3864a0e3ee"></a><!-- doxytag: member="pugi::format_utf8" ref="9d81ecddcd68e273aa6bcf3864a0e3ee" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const unsigned int <a class="el" href="namespacepugi.html#9d81ecddcd68e273aa6bcf3864a0e3ee">pugi::format_utf8</a> = 0x02 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +This flag determines how the non-printable symbols are written to output stream - they are either considered UTF-8 and are written as UTF-8 character, escaped with &#. +<p> +..;, or they are considered to be ASCII and each ASCII character is escaped separately.<p> +This flag is on by default. </td> + </tr> +</table> +<a class="anchor" name="b863bcafd203aeaa98953df3a998243f"></a><!-- doxytag: member="pugi::format_write_bom" ref="b863bcafd203aeaa98953df3a998243f" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const unsigned int <a class="el" href="namespacepugi.html#b863bcafd203aeaa98953df3a998243f">pugi::format_write_bom</a> = 0x04 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +This flag determines if UTF-8 BOM is to be written to output stream. +<p> +This flag is off by default. </td> + </tr> +</table> +<a class="anchor" name="2dd811716b1c0a6a2431ceca43bc649e"></a><!-- doxytag: member="pugi::format_raw" ref="2dd811716b1c0a6a2431ceca43bc649e" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const unsigned int <a class="el" href="namespacepugi.html#2dd811716b1c0a6a2431ceca43bc649e">pugi::format_raw</a> = 0x08 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +If this flag is on, no indentation is performed and no line breaks are written to output file. +<p> +This means that the data is written to output stream as is.<p> +This flag is off by default. </td> + </tr> +</table> +<a class="anchor" name="325f48a35abbaeacdfd8b7fc9ed1713c"></a><!-- doxytag: member="pugi::format_default" ref="325f48a35abbaeacdfd8b7fc9ed1713c" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const unsigned int <a class="el" href="namespacepugi.html#325f48a35abbaeacdfd8b7fc9ed1713c">pugi::format_default</a> = <a class="el" href="namespacepugi.html#ce12e8dee65c5bae8ee42a64be7421d3">format_indent</a> | <a class="el" href="namespacepugi.html#9d81ecddcd68e273aa6bcf3864a0e3ee">format_utf8</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +This is the default set of formatting flags. +<p> +It includes indenting nodes depending on their depth in DOM tree and considering input data to be UTF-8. </td> + </tr> +</table> +<hr size="1"><address style="align: right;"><small>Generated on Wed Feb 21 22:19:50 2007 for pugixml by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> +</body> +</html> |