blob: 0d2f63254a5f55608ace84ebd61dc5993bdb1985 [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>
27<body>
28<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
29<div id="topbanner"><a href="https://github.com/miloyip/rapidjson" title="RapidJSON GitHub"><i class="githublogo"></i></a></div>
30 <div id="MSearchBox" class="MSearchBoxInactive">
31 <span class="left">
32 <img id="MSearchSelect" src="search/mag_sel.png"
33 onmouseover="return searchBox.OnSearchSelectShow()"
34 onmouseout="return searchBox.OnSearchSelectHide()"
35 alt=""/>
36 <input type="text" id="MSearchField" value="Search" accesskey="S"
37 onfocus="searchBox.OnSearchFieldFocus(true)"
38 onblur="searchBox.OnSearchFieldFocus(false)"
39 onkeyup="searchBox.OnSearchFieldChange(event)"/>
40 </span><span class="right">
41 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
42 </span>
43 </div>
44<!-- end header part -->
45<!-- Generated by Doxygen 1.8.7 -->
46<script type="text/javascript">
47var searchBox = new SearchBox("searchBox", "search",false,'Search');
48</script>
49</div><!-- top -->
50<div id="side-nav" class="ui-resizable side-nav-resizable">
51 <div id="nav-tree">
52 <div id="nav-tree-contents">
53 <div id="nav-sync" class="sync"></div>
54 </div>
55 </div>
56 <div id="splitbar" style="-moz-user-select:none;"
57 class="ui-resizable-handle">
58 </div>
59</div>
60<script type="text/javascript">
61$(document).ready(function(){initNavTree('document_8h.html','');});
62</script>
63<div id="doc-content">
64<!-- window showing the filter options -->
65<div id="MSearchSelectWindow"
66 onmouseover="return searchBox.OnSearchSelectShow()"
67 onmouseout="return searchBox.OnSearchSelectHide()"
68 onkeydown="return searchBox.OnSearchSelectKey(event)">
69<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>
70
71<!-- iframe showing the search results (closed by default) -->
72<div id="MSearchResultsWindow">
73<iframe src="javascript:void(0)" frameborder="0"
74 name="MSearchResults" id="MSearchResults">
75</iframe>
76</div>
77
78<div class="header">
79 <div class="summary">
80<a href="#nested-classes">Classes</a> &#124;
81<a href="#namespaces">Namespaces</a> &#124;
82<a href="#define-members">Macros</a> &#124;
83<a href="#typedef-members">Typedefs</a> &#124;
84<a href="#func-members">Functions</a> </div>
85 <div class="headertitle">
86<div class="title">document.h File Reference</div> </div>
87</div><!--header-->
88<div class="contents">
89<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 +000090<code>#include &quot;internal/meta.h&quot;</code><br />
miloyip8b488a82014-08-20 07:23:21 +000091<code>#include &quot;internal/strfunc.h&quot;</code><br />
92<code>#include &lt;new&gt;</code><br />
93<code>#include &lt;string&gt;</code><br />
miloyip8b488a82014-08-20 07:23:21 +000094<code>#include &lt;iterator&gt;</code><br />
95</div>
96<p><a href="document_8h_source.html">Go to the source code of this file.</a></p>
97<table class="memberdecls">
98<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
99Classes</h2></td></tr>
100<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>
101<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>
102<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
103<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>
104<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>
105<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
106<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>
107<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>
108<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
109<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>
110<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>
111<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
112<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>
113<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>
114<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
115<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>
116<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
117<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>
118<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
119<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>
120<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>
121<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
122</table><table class="memberdecls">
123<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
124Namespaces</h2></td></tr>
125<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>
126<tr class="memdesc:namespacerapidjson"><td class="mdescLeft">&#160;</td><td class="mdescRight">main RapidJSON namespace <br /></td></tr>
127<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
128</table><table class="memberdecls">
129<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
130Macros</h2></td></tr>
131<tr class="memitem:ga2f2eef0ee4477f3fe5874703a66e997f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_p_i_d_j_s_o_n___c_o_n_f_i_g.html#ga2f2eef0ee4477f3fe5874703a66e997f">RAPIDJSON_HAS_STDSTRING</a></td></tr>
132<tr class="memdesc:ga2f2eef0ee4477f3fe5874703a66e997f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable RapidJSON support for <code>std::string</code>. <a href="group___r_a_p_i_d_j_s_o_n___c_o_n_f_i_g.html#ga2f2eef0ee4477f3fe5874703a66e997f">More...</a><br /></td></tr>
133<tr class="separator:ga2f2eef0ee4477f3fe5874703a66e997f"><td class="memSeparator" colspan="2">&#160;</td></tr>
134</table><table class="memberdecls">
135<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
136Typedefs</h2></td></tr>
137<tr class="memitem:afb3fa116c66d834b6f4289d648cc8d6d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb3fa116c66d834b6f4289d648cc8d6d"></a>
138typedef GenericValue&lt; UTF8&lt;&gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacerapidjson.html#afb3fa116c66d834b6f4289d648cc8d6d">rapidjson::Value</a></td></tr>
139<tr class="memdesc:afb3fa116c66d834b6f4289d648cc8d6d"><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>
140<tr class="separator:afb3fa116c66d834b6f4289d648cc8d6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
141<tr class="memitem:a660c934c2959121babf799b6cb206659"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a660c934c2959121babf799b6cb206659"></a>
142typedef GenericDocument&lt; UTF8&lt;&gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacerapidjson.html#a660c934c2959121babf799b6cb206659">rapidjson::Document</a></td></tr>
143<tr class="memdesc:a660c934c2959121babf799b6cb206659"><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>
144<tr class="separator:a660c934c2959121babf799b6cb206659"><td class="memSeparator" colspan="2">&#160;</td></tr>
145</table><table class="memberdecls">
146<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
147Functions</h2></td></tr>
148<tr class="memitem:aa6b9fd9f6aa49405a574c362ba9af6b5"><td class="memTemplParams" colspan="2">template&lt;typename CharType &gt; </td></tr>
149<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>
150<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>
151<tr class="separator:aa6b9fd9f6aa49405a574c362ba9af6b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
152<tr class="memitem:a578c51ab574a50a9c760b9da7c7562f2"><td class="memTemplParams" colspan="2">template&lt;typename CharType &gt; </td></tr>
153<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>
154<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>
155<tr class="separator:a578c51ab574a50a9c760b9da7c7562f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
156<tr class="memitem:af94951529a5d51e8c4e6e770bb707c1f"><td class="memTemplParams" colspan="2">template&lt;typename CharType &gt; </td></tr>
157<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>
158<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>
159<tr class="separator:af94951529a5d51e8c4e6e770bb707c1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
160</table>
161</div><!-- contents -->
162</div><!-- doc-content -->
163<!-- HTML footer for doxygen 1.8.7-->
164<!-- start footer part -->
165<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
166 <ul>
167 <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>
168 </ul>
169</div>
miloyip6ea4c182015-04-07 09:25:04 +0000170<script type="text/javascript">
171 /* * * CONFIGURATION VARIABLES * * */
172 var disqus_shortname = 'rapidjson-doc';
173 /* * * DON'T EDIT BELOW THIS LINE * * */
174 (function() {
175 var dt = document.createElement('div');
176 dt.id = "disqus_thread";
177 (document.getElementsByClassName('contents')[0]).appendChild(dt);
178 var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
179 dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
180 (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
181 })();
182</script>
183</body>
184</html>