blob: 416ad8ab25c4d383184ade451d1138ecc8678e3d [file] [log] [blame]
miloyip8b488a82014-08-20 07:23:21 +00001<!-- HTML header for doxygen 1.8.7-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.7"/>
8<title>RapidJSON: include/rapidjson/document.h File Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="navtree.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="resize.js"></script>
14<script type="text/javascript" src="navtree.js"></script>
15<script type="text/javascript">
16 $(document).ready(initResizable);
17 $(window).load(resizeHeight);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/search.js"></script>
21<script type="text/javascript">
22 $(document).ready(function() { searchBox.OnSelectItem(0); });
23</script>
24<link href="doxygen.css" rel="stylesheet" type="text/css" />
25<link href="doxygenextra.css" rel="stylesheet" type="text/css"/>
26</head>
miloyip59ba9ab2015-06-10 09:51:39 +000027<script>
28 (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
29 (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
30 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
31 })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
32 ga('create', 'UA-63929386-1', 'auto');
33 ga('send', 'pageview');
34</script>
miloyip8b488a82014-08-20 07:23:21 +000035<body>
36<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37<div id="topbanner"><a href="https://github.com/miloyip/rapidjson" title="RapidJSON GitHub"><i class="githublogo"></i></a></div>
38 <div id="MSearchBox" class="MSearchBoxInactive">
39 <span class="left">
40 <img id="MSearchSelect" src="search/mag_sel.png"
41 onmouseover="return searchBox.OnSearchSelectShow()"
42 onmouseout="return searchBox.OnSearchSelectHide()"
43 alt=""/>
44 <input type="text" id="MSearchField" value="Search" accesskey="S"
45 onfocus="searchBox.OnSearchFieldFocus(true)"
46 onblur="searchBox.OnSearchFieldFocus(false)"
47 onkeyup="searchBox.OnSearchFieldChange(event)"/>
48 </span><span class="right">
49 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
50 </span>
51 </div>
52<!-- end header part -->
53<!-- Generated by Doxygen 1.8.7 -->
54<script type="text/javascript">
55var searchBox = new SearchBox("searchBox", "search",false,'Search');
56</script>
57</div><!-- top -->
58<div id="side-nav" class="ui-resizable side-nav-resizable">
59 <div id="nav-tree">
60 <div id="nav-tree-contents">
61 <div id="nav-sync" class="sync"></div>
62 </div>
63 </div>
64 <div id="splitbar" style="-moz-user-select:none;"
65 class="ui-resizable-handle">
66 </div>
67</div>
68<script type="text/javascript">
69$(document).ready(function(){initNavTree('document_8h.html','');});
70</script>
71<div id="doc-content">
72<!-- window showing the filter options -->
73<div id="MSearchSelectWindow"
74 onmouseover="return searchBox.OnSearchSelectShow()"
75 onmouseout="return searchBox.OnSearchSelectHide()"
76 onkeydown="return searchBox.OnSearchSelectKey(event)">
77<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Pages</a></div>
78
79<!-- iframe showing the search results (closed by default) -->
80<div id="MSearchResultsWindow">
81<iframe src="javascript:void(0)" frameborder="0"
82 name="MSearchResults" id="MSearchResults">
83</iframe>
84</div>
85
86<div class="header">
87 <div class="summary">
88<a href="#nested-classes">Classes</a> &#124;
89<a href="#namespaces">Namespaces</a> &#124;
miloyip8b488a82014-08-20 07:23:21 +000090<a href="#typedef-members">Typedefs</a> &#124;
91<a href="#func-members">Functions</a> </div>
92 <div class="headertitle">
93<div class="title">document.h File Reference</div> </div>
94</div><!--header-->
95<div class="contents">
96<div class="textblock"><code>#include &quot;<a class="el" href="reader_8h_source.html">reader.h</a>&quot;</code><br />
miloyipbed133e2014-09-03 01:43:26 +000097<code>#include &quot;internal/meta.h&quot;</code><br />
miloyip8b488a82014-08-20 07:23:21 +000098<code>#include &quot;internal/strfunc.h&quot;</code><br />
miloyip6dee2ec2016-02-20 13:47:23 +000099<code>#include &quot;memorystream.h&quot;</code><br />
100<code>#include &quot;encodedstream.h&quot;</code><br />
miloyip8b488a82014-08-20 07:23:21 +0000101<code>#include &lt;new&gt;</code><br />
miloyip8b488a82014-08-20 07:23:21 +0000102<code>#include &lt;iterator&gt;</code><br />
103</div>
104<p><a href="document_8h_source.html">Go to the source code of this file.</a></p>
105<table class="memberdecls">
106<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
107Classes</h2></td></tr>
108<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_value.html">rapidjson::GenericValue&lt; Encoding, Allocator &gt;</a></td></tr>
109<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a JSON value. Use Value for <a class="el" href="structrapidjson_1_1_u_t_f8.html" title="UTF-8 encoding. ">UTF8</a> encoding and default allocator. <a href="classrapidjson_1_1_generic_value.html#details">More...</a><br /></td></tr>
110<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyip85916f42015-07-20 09:01:07 +0000111<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_document.html">rapidjson::GenericDocument&lt; Encoding, Allocator, StackAllocator &gt;</a></td></tr>
112<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A document for parsing JSON text as DOM. <a href="classrapidjson_1_1_generic_document.html#details">More...</a><br /></td></tr>
113<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyip8b488a82014-08-20 07:23:21 +0000114<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrapidjson_1_1_generic_member.html">rapidjson::GenericMember&lt; Encoding, Allocator &gt;</a></td></tr>
115<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name-value pair in a JSON object value. <a href="structrapidjson_1_1_generic_member.html#details">More...</a><br /></td></tr>
116<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
117<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_member_iterator.html">rapidjson::GenericMemberIterator&lt; Const, Encoding, Allocator &gt;</a></td></tr>
118<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">(Constant) member iterator for a JSON object value <a href="classrapidjson_1_1_generic_member_iterator.html#details">More...</a><br /></td></tr>
119<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
120<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrapidjson_1_1_generic_string_ref.html">rapidjson::GenericStringRef&lt; CharType &gt;</a></td></tr>
121<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference to a constant string (not taking a copy) <a href="structrapidjson_1_1_generic_string_ref.html#details">More...</a><br /></td></tr>
122<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyip0c8e6ea2016-02-19 14:35:24 +0000123<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_array.html">rapidjson::GenericArray&lt; bool, typename &gt;</a></td></tr>
124<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper class for accessing Value of array type. <a href="classrapidjson_1_1_generic_array.html#details">More...</a><br /></td></tr>
125<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
126<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_object.html">rapidjson::GenericObject&lt; bool, typename &gt;</a></td></tr>
127<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper class for accessing Value of array type. <a href="classrapidjson_1_1_generic_object.html#details">More...</a><br /></td></tr>
128<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyip8b488a82014-08-20 07:23:21 +0000129<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_value.html">rapidjson::GenericValue&lt; Encoding, Allocator &gt;</a></td></tr>
130<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a JSON value. Use Value for <a class="el" href="structrapidjson_1_1_u_t_f8.html" title="UTF-8 encoding. ">UTF8</a> encoding and default allocator. <a href="classrapidjson_1_1_generic_value.html#details">More...</a><br /></td></tr>
131<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
132<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrapidjson_1_1_generic_value_1_1_number_1_1_i.html">rapidjson::GenericValue&lt; Encoding, Allocator &gt;::Number::I</a></td></tr>
133<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
134<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrapidjson_1_1_generic_value_1_1_number_1_1_u.html">rapidjson::GenericValue&lt; Encoding, Allocator &gt;::Number::U</a></td></tr>
135<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
136<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_document.html">rapidjson::GenericDocument&lt; Encoding, Allocator, StackAllocator &gt;</a></td></tr>
137<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A document for parsing JSON text as DOM. <a href="classrapidjson_1_1_generic_document.html#details">More...</a><br /></td></tr>
138<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyip0c8e6ea2016-02-19 14:35:24 +0000139<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_array.html">rapidjson::GenericArray&lt; bool, typename &gt;</a></td></tr>
140<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper class for accessing Value of array type. <a href="classrapidjson_1_1_generic_array.html#details">More...</a><br /></td></tr>
141<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
142<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_object.html">rapidjson::GenericObject&lt; bool, typename &gt;</a></td></tr>
143<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper class for accessing Value of array type. <a href="classrapidjson_1_1_generic_object.html#details">More...</a><br /></td></tr>
144<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyip8b488a82014-08-20 07:23:21 +0000145</table><table class="memberdecls">
146<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
147Namespaces</h2></td></tr>
148<tr class="memitem:namespacerapidjson"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacerapidjson.html">rapidjson</a></td></tr>
149<tr class="memdesc:namespacerapidjson"><td class="mdescLeft">&#160;</td><td class="mdescRight">main RapidJSON namespace <br /></td></tr>
150<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
151</table><table class="memberdecls">
miloyip8b488a82014-08-20 07:23:21 +0000152<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
153Typedefs</h2></td></tr>
miloyip82f40732016-02-02 10:23:26 +0000154<tr class="memitem:aa65fc9fb381b2cbc54f98673eadd6505"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa65fc9fb381b2cbc54f98673eadd6505"></a>
155typedef GenericValue&lt; UTF8&lt;&gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacerapidjson.html#aa65fc9fb381b2cbc54f98673eadd6505">rapidjson::Value</a></td></tr>
156<tr class="memdesc:aa65fc9fb381b2cbc54f98673eadd6505"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classrapidjson_1_1_generic_value.html" title="Represents a JSON value. Use Value for UTF8 encoding and default allocator. ">GenericValue</a> with <a class="el" href="structrapidjson_1_1_u_t_f8.html" title="UTF-8 encoding. ">UTF8</a> encoding. <br /></td></tr>
157<tr class="separator:aa65fc9fb381b2cbc54f98673eadd6505"><td class="memSeparator" colspan="2">&#160;</td></tr>
158<tr class="memitem:ace11b5b575baf1cccd5ba5f8586dcdc8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace11b5b575baf1cccd5ba5f8586dcdc8"></a>
159typedef GenericDocument&lt; UTF8&lt;&gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacerapidjson.html#ace11b5b575baf1cccd5ba5f8586dcdc8">rapidjson::Document</a></td></tr>
160<tr class="memdesc:ace11b5b575baf1cccd5ba5f8586dcdc8"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classrapidjson_1_1_generic_document.html" title="A document for parsing JSON text as DOM. ">GenericDocument</a> with <a class="el" href="structrapidjson_1_1_u_t_f8.html" title="UTF-8 encoding. ">UTF8</a> encoding. <br /></td></tr>
161<tr class="separator:ace11b5b575baf1cccd5ba5f8586dcdc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyip8b488a82014-08-20 07:23:21 +0000162</table><table class="memberdecls">
163<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
164Functions</h2></td></tr>
165<tr class="memitem:aa6b9fd9f6aa49405a574c362ba9af6b5"><td class="memTemplParams" colspan="2">template&lt;typename CharType &gt; </td></tr>
166<tr class="memitem:aa6b9fd9f6aa49405a574c362ba9af6b5"><td class="memTemplItemLeft" align="right" valign="top">GenericStringRef&lt; CharType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacerapidjson.html#aa6b9fd9f6aa49405a574c362ba9af6b5">rapidjson::StringRef</a> (const CharType *str)</td></tr>
167<tr class="memdesc:aa6b9fd9f6aa49405a574c362ba9af6b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark a character pointer as constant string. <a href="#aa6b9fd9f6aa49405a574c362ba9af6b5">More...</a><br /></td></tr>
168<tr class="separator:aa6b9fd9f6aa49405a574c362ba9af6b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
169<tr class="memitem:a578c51ab574a50a9c760b9da7c7562f2"><td class="memTemplParams" colspan="2">template&lt;typename CharType &gt; </td></tr>
170<tr class="memitem:a578c51ab574a50a9c760b9da7c7562f2"><td class="memTemplItemLeft" align="right" valign="top">GenericStringRef&lt; CharType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacerapidjson.html#a578c51ab574a50a9c760b9da7c7562f2">rapidjson::StringRef</a> (const CharType *str, size_t length)</td></tr>
171<tr class="memdesc:a578c51ab574a50a9c760b9da7c7562f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark a character pointer as constant string. <a href="#a578c51ab574a50a9c760b9da7c7562f2">More...</a><br /></td></tr>
172<tr class="separator:a578c51ab574a50a9c760b9da7c7562f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
173<tr class="memitem:af94951529a5d51e8c4e6e770bb707c1f"><td class="memTemplParams" colspan="2">template&lt;typename CharType &gt; </td></tr>
174<tr class="memitem:af94951529a5d51e8c4e6e770bb707c1f"><td class="memTemplItemLeft" align="right" valign="top">GenericStringRef&lt; CharType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacerapidjson.html#af94951529a5d51e8c4e6e770bb707c1f">rapidjson::StringRef</a> (const std::basic_string&lt; CharType &gt; &amp;str)</td></tr>
175<tr class="memdesc:af94951529a5d51e8c4e6e770bb707c1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark a string object as constant string. <a href="#af94951529a5d51e8c4e6e770bb707c1f">More...</a><br /></td></tr>
176<tr class="separator:af94951529a5d51e8c4e6e770bb707c1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
177</table>
178</div><!-- contents -->
179</div><!-- doc-content -->
180<!-- HTML footer for doxygen 1.8.7-->
181<!-- start footer part -->
182<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
183 <ul>
184 <li class="navelem"><a class="el" href="dir_2e777bb85672ca91d8484c1593fb1d89.html">include</a></li><li class="navelem"><a class="el" href="dir_0b07344794a20f8375311f92e90cd9a3.html">rapidjson</a></li><li class="navelem"><a class="el" href="document_8h.html">document.h</a></li>
185 </ul>
186</div>
miloyip6ea4c182015-04-07 09:25:04 +0000187<script type="text/javascript">
188 /* * * CONFIGURATION VARIABLES * * */
189 var disqus_shortname = 'rapidjson-doc';
190 /* * * DON'T EDIT BELOW THIS LINE * * */
191 (function() {
192 var dt = document.createElement('div');
193 dt.id = "disqus_thread";
194 (document.getElementsByClassName('contents')[0]).appendChild(dt);
195 var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
miloyip52826762015-04-26 13:43:32 +0000196 dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
miloyip6ea4c182015-04-07 09:25:04 +0000197 (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
198 })();
199</script>
200</body>
miloyip52826762015-04-26 13:43:32 +0000201</html>