diff options
Diffstat (limited to 'doc/html/boost/property_tree')
47 files changed, 4470 insertions, 0 deletions
diff --git a/doc/html/boost/property_tree/basic_ptree.html b/doc/html/boost/property_tree/basic_ptree.html new file mode 100755 index 0000000000..10729fe9dc --- /dev/null +++ b/doc/html/boost/property_tree/basic_ptree.html @@ -0,0 +1,741 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class template basic_ptree</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.ptree_hpp" title="Header <boost/property_tree/ptree.hpp>"> +<link rel="prev" href="json_parser/write_json_id1071471.html" title="Function template write_json"> +<link rel="next" href="path.html" title="Type definition path"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="json_parser/write_json_id1071471.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="path.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.basic_ptree"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template basic_ptree</span></h2> +<p>boost::property_tree::basic_ptree</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.ptree_hpp" title="Header <boost/property_tree/ptree.hpp>">boost/property_tree/ptree.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> Data<span class="special">,</span> <span class="keyword">typename</span> KeyCompare<span class="special">></span> +<span class="keyword">class</span> <a class="link" href="basic_ptree.html" title="Class template basic_ptree">basic_ptree</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptreetypes">types</a></span> + <span class="keyword">typedef</span> <a class="link" href="basic_ptree.html" title="Class template basic_ptree">basic_ptree</a><span class="special"><</span> <span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Data</span><span class="special">,</span> <span class="identifier">KeyCompare</span> <span class="special">></span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type"><span class="identifier">self_type</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Key</span> <a name="boost.property_tree.basic_ptree.key_type"></a><span class="identifier">key_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Data</span> <a name="boost.property_tree.basic_ptree.data_type"></a><span class="identifier">data_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">KeyCompare</span> <a name="boost.property_tree.basic_ptree.key_compare"></a><span class="identifier">key_compare</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="keyword">const</span> <span class="identifier">Key</span><span class="special">,</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">></span> <a name="boost.property_tree.basic_ptree.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="boost.property_tree.basic_ptree.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">path_of</span><span class="special"><</span> <span class="identifier">Key</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a name="boost.property_tree.basic_ptree.path_type"></a><span class="identifier">path_type</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptreeconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="basic_ptree.html#id1076758-bb"><span class="identifier">basic_ptree</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="basic_ptree.html#id1076764-bb"><span class="identifier">basic_ptree</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">data_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_ptree.html#id1076777-bb"><span class="identifier">basic_ptree</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + basic_ptree& <a class="link" href="basic_ptree.html#id1076789-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_ptree.html#id1076788-bb"><span class="special">~</span><span class="identifier">basic_ptree</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_ptree.html#id1071668-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="basic_ptree.html#id1071671-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">size_type</span> <a class="link" href="basic_ptree.html#id1071692-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">size_type</span> <a class="link" href="basic_ptree.html#id1071703-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="basic_ptree.html#id1071711-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="basic_ptree.html#id1071723-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="basic_ptree.html#id1071730-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="basic_ptree.html#id1071738-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="basic_ptree.html#id1071746-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">reverse_iterator</span> <a class="link" href="basic_ptree.html#id1071754-bb"><span class="identifier">rbegin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_reverse_iterator</span> <a class="link" href="basic_ptree.html#id1156050-bb"><span class="identifier">rbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">reverse_iterator</span> <a class="link" href="basic_ptree.html#id1156058-bb"><span class="identifier">rend</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_reverse_iterator</span> <a class="link" href="basic_ptree.html#id1156066-bb"><span class="identifier">rend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">value_type</span> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1156074-bb"><span class="identifier">front</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1156082-bb"><span class="identifier">front</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">value_type</span> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1138588-bb"><span class="identifier">back</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1138596-bb"><span class="identifier">back</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="basic_ptree.html#id1138604-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">iterator</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> It<span class="special">></span> <span class="keyword">void</span> <a class="link" href="basic_ptree.html#id1138633-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">iterator</span><span class="special">,</span> <span class="identifier">It</span><span class="special">,</span> <span class="identifier">It</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="basic_ptree.html#id1138672-bb"><span class="identifier">erase</span></a><span class="special">(</span><span class="identifier">iterator</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="basic_ptree.html#id1138696-bb"><span class="identifier">erase</span></a><span class="special">(</span><span class="identifier">iterator</span><span class="special">,</span> <span class="identifier">iterator</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="basic_ptree.html#id787869-bb"><span class="identifier">push_front</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="basic_ptree.html#id787886-bb"><span class="identifier">push_back</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_ptree.html#id1144326-bb"><span class="identifier">pop_front</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_ptree.html#id1144338-bb"><span class="identifier">pop_back</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_ptree.html#id1144349-bb"><span class="identifier">reverse</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Compare<span class="special">></span> <span class="keyword">void</span> <a class="link" href="basic_ptree.html#id1144361-bb"><span class="identifier">sort</span></a><span class="special">(</span><span class="identifier">Compare</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_ptree.html#id1144387-bb"><span class="identifier">sort</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="basic_ptree.html#id1144399-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="basic_ptree.html#id1144422-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">assoc_iterator</span> <a class="link" href="basic_ptree.html#id1144439-bb"><span class="identifier">ordered_begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_assoc_iterator</span> <a class="link" href="basic_ptree.html#id1144451-bb"><span class="identifier">ordered_begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">assoc_iterator</span> <a class="link" href="basic_ptree.html#id1144463-bb"><span class="identifier">not_found</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_assoc_iterator</span> <a class="link" href="basic_ptree.html#id1144476-bb"><span class="identifier">not_found</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">assoc_iterator</span> <a class="link" href="basic_ptree.html#id1144489-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_assoc_iterator</span> <a class="link" href="basic_ptree.html#id788125-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">assoc_iterator</span><span class="special">,</span> <span class="identifier">assoc_iterator</span> <span class="special">></span> <a class="link" href="basic_ptree.html#id788144-bb"><span class="identifier">equal_range</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">const_assoc_iterator</span><span class="special">,</span> <span class="identifier">const_assoc_iterator</span> <span class="special">></span> + <a class="link" href="basic_ptree.html#id788163-bb"><span class="identifier">equal_range</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">size_type</span> <a class="link" href="basic_ptree.html#id788181-bb"><span class="identifier">count</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">size_type</span> <a class="link" href="basic_ptree.html#id788199-bb"><span class="identifier">erase</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="basic_ptree.html#id788217-bb"><span class="identifier">to_iterator</span></a><span class="special">(</span><span class="identifier">assoc_iterator</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="basic_ptree.html#id788242-bb"><span class="identifier">to_iterator</span></a><span class="special">(</span><span class="identifier">const_assoc_iterator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">data_type</span> <span class="special">&</span> <a class="link" href="basic_ptree.html#id788266-bb"><span class="identifier">data</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">data_type</span> <span class="special">&</span> <a class="link" href="basic_ptree.html#id788278-bb"><span class="identifier">data</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_ptree.html#id788290-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id788302-bb"><span class="identifier">get_child</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id788345-bb"><span class="identifier">get_child</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id788374-bb"><span class="identifier">get_child</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id788405-bb"><span class="identifier">get_child</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">optional</span><span class="special"><</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <span class="special">></span> <a class="link" href="basic_ptree.html#id788440-bb"><span class="identifier">get_child_optional</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">optional</span><span class="special"><</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <span class="special">></span> <a class="link" href="basic_ptree.html#id788462-bb"><span class="identifier">get_child_optional</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id788484-bb"><span class="identifier">put_child</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id788529-bb"><span class="identifier">add_child</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="basic_ptree.html#id788575-bb"><span class="identifier">get_value</span></a><span class="special">(</span><span class="identifier">Translator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="identifier">Type</span> <a class="link" href="basic_ptree.html#id788616-bb"><span class="identifier">get_value</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="identifier">Type</span> <a class="link" href="basic_ptree.html#id788645-bb"><span class="identifier">get_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="basic_ptree.html#id788688-bb"><span class="identifier">get_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Ch</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="basic_ptree.html#id788724-bb"><span class="identifier">get_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="basic_ptree.html#id788757-bb"><span class="identifier">get_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Ch</span> <span class="special">*</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="identifier">optional</span><span class="special"><</span> <span class="identifier">Type</span> <span class="special">></span> <a class="link" href="basic_ptree.html#id788783-bb"><span class="identifier">get_value_optional</span></a><span class="special">(</span><span class="identifier">Translator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="identifier">optional</span><span class="special"><</span> <span class="identifier">Type</span> <span class="special">></span> <a class="link" href="basic_ptree.html#id788817-bb"><span class="identifier">get_value_optional</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="keyword">void</span> <a class="link" href="basic_ptree.html#id788842-bb"><span class="identifier">put_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="keyword">void</span> <a class="link" href="basic_ptree.html#id1141134-bb"><span class="identifier">put_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="basic_ptree.html#id1141165-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="identifier">Type</span> <a class="link" href="basic_ptree.html#id1141201-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="identifier">Type</span> <a class="link" href="basic_ptree.html#id1141226-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="basic_ptree.html#id1147378-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Ch</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="basic_ptree.html#id1147420-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="basic_ptree.html#id1147453-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Ch</span> <span class="special">*</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="identifier">optional</span><span class="special"><</span> <span class="identifier">Type</span> <span class="special">></span> <a class="link" href="basic_ptree.html#id1147485-bb"><span class="identifier">get_optional</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> + <span class="identifier">optional</span><span class="special"><</span> <span class="identifier">Type</span> <span class="special">></span> <a class="link" href="basic_ptree.html#id1147526-bb"><span class="identifier">get_optional</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1147557-bb"><span class="identifier">put</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id780187-bb"><span class="identifier">put</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1076636-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1076704-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_ptree.html#id1076803-bb">private member functions</a></span> + <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">*</span> <a class="link" href="basic_ptree.html#id1076806-bb"><span class="identifier">walk_path</span></a><span class="special">(</span><span class="identifier">path_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1076822-bb"><span class="identifier">force_path</span></a><span class="special">(</span><span class="identifier">path_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2556527"></a><h2>Description</h2> +<p>Property tree main structure. A property tree is a hierarchical data structure which has one element of type <code class="computeroutput">Data</code> in each node, as well as an ordered sequence of sub-nodes, which are additionally identified by a non-unique key of type <code class="computeroutput">Key</code>.</p> +<p>Key equivalency is defined by <code class="computeroutput">KeyCompare</code>, a predicate defining a strict weak ordering.</p> +<p>Property tree defines a Container-like interface to the (key-node) pairs of its direct sub-nodes. The iterators are bidirectional. The sequence of nodes is held in insertion order, not key order. </p> +<div class="refsect2"> +<a name="id2556562"></a><h3> +<a name="boost.property_tree.basic_ptreetypes"></a><code class="computeroutput">basic_ptree</code> + public + types</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<p> +<span class="keyword">typedef</span> <a class="link" href="basic_ptree.html" title="Class template basic_ptree">basic_ptree</a><span class="special"><</span> <span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Data</span><span class="special">,</span> <span class="identifier">KeyCompare</span> <span class="special">></span> <a name="boost.property_tree.basic_ptree.self_type"></a><span class="identifier">self_type</span><span class="special">;</span></p> +<p>Simpler way to refer to this <a class="link" href="basic_ptree.html" title="Class template basic_ptree">basic_ptree</a><C,K,P,A> type. Note that this is private, and made public only for doxygen. </p> +</li></ol></div> +</div> +<div class="refsect2"> +<a name="id2556660"></a><h3> +<a name="boost.property_tree.basic_ptreeconstruct-copy-destruct"></a><code class="computeroutput">basic_ptree</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="id1076758-bb"></a><span class="identifier">basic_ptree</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Creates a node with no children and default-constructed data. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="id1076764-bb"></a><span class="identifier">basic_ptree</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">data_type</span> <span class="special">&</span> data<span class="special">)</span><span class="special">;</span></pre> +<p>Creates a node with no children and a copy of the given data. </p> +</li> +<li class="listitem"><pre class="literallayout"><a name="id1076777-bb"></a><span class="identifier">basic_ptree</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"> +<pre class="literallayout">basic_ptree& <a name="id1076789-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> +<p>Basic guarantee only. </p> +</li> +<li class="listitem"><pre class="literallayout"><a name="id1076788-bb"></a><span class="special">~</span><span class="identifier">basic_ptree</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id2556904"></a><h3> +<a name="id1071668-bb"></a><code class="computeroutput">basic_ptree</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="id1071671-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> +<p>Swap with other tree. Only constant-time and nothrow if the data type's swap is. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="id1071692-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>The number of direct children of this node. </p> +</li> +<li class="listitem"><pre class="literallayout"><span class="identifier">size_type</span> <a name="id1071703-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="id1071711-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Whether there are any direct children. </p> +</li> +<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="id1071723-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="id1071730-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="id1071738-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="id1071746-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">reverse_iterator</span> <a name="id1071754-bb"></a><span class="identifier">rbegin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">const_reverse_iterator</span> <a name="id1156050-bb"></a><span class="identifier">rbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">reverse_iterator</span> <a name="id1156058-bb"></a><span class="identifier">rend</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">const_reverse_iterator</span> <a name="id1156066-bb"></a><span class="identifier">rend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">value_type</span> <span class="special">&</span> <a name="id1156074-bb"></a><span class="identifier">front</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span> <a name="id1156082-bb"></a><span class="identifier">front</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">value_type</span> <span class="special">&</span> <a name="id1138588-bb"></a><span class="identifier">back</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span> <a name="id1138596-bb"></a><span class="identifier">back</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">iterator</span> <a name="id1138604-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">iterator</span> where<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre> +<p>Insert a copy of the given tree with its key just before the given position in this node. This operation invalidates no iterators. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>An iterator to the newly created child. </p></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> It<span class="special">></span> <span class="keyword">void</span> <a name="id1138633-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">iterator</span> where<span class="special">,</span> <span class="identifier">It</span> first<span class="special">,</span> <span class="identifier">It</span> last<span class="special">)</span><span class="special">;</span></pre> +<p>Range insert. Equivalent to: </p> +<pre class="programlisting"> for(; first != last; ++first) insert(where, *first); +</pre> +<p> </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">iterator</span> <a name="id1138672-bb"></a><span class="identifier">erase</span><span class="special">(</span><span class="identifier">iterator</span> where<span class="special">)</span><span class="special">;</span></pre> +<p>Erase the child pointed at by the iterator. This operation invalidates the given iterator, as well as its equivalent assoc_iterator. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>A valid iterator pointing to the element after the erased. </p></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">iterator</span> <a name="id1138696-bb"></a><span class="identifier">erase</span><span class="special">(</span><span class="identifier">iterator</span> first<span class="special">,</span> <span class="identifier">iterator</span> last<span class="special">)</span><span class="special">;</span></pre> +<p>Range erase. Equivalent to: </p> +<pre class="programlisting"> while(first != last;) first = erase(first); +</pre> +<p> </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">iterator</span> <a name="id787869-bb"></a><span class="identifier">push_front</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre> +<p>Equivalent to insert(begin(), value). </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">iterator</span> <a name="id787886-bb"></a><span class="identifier">push_back</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre> +<p>Equivalent to insert(end(), value). </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="id1144326-bb"></a><span class="identifier">pop_front</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Equivalent to erase(begin()). </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="id1144338-bb"></a><span class="identifier">pop_back</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Equivalent to erase(boost::prior(end())). </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="id1144349-bb"></a><span class="identifier">reverse</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Reverses the order of direct children in the property tree. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Compare<span class="special">></span> <span class="keyword">void</span> <a name="id1144361-bb"></a><span class="identifier">sort</span><span class="special">(</span><span class="identifier">Compare</span> comp<span class="special">)</span><span class="special">;</span></pre> +<p>Sorts the direct children of this node according to the predicate. The predicate is passed the whole pair of key and child. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="id1144387-bb"></a><span class="identifier">sort</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Sorts the direct children of this node according to key order. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="id1144399-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Two property trees are the same if they have the same data, the keys and order of their children are the same, and the children compare equal, recursively. </p> +</li> +<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="id1144422-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">assoc_iterator</span> <a name="id1144439-bb"></a><span class="identifier">ordered_begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Returns an iterator to the first child, in key order. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">const_assoc_iterator</span> <a name="id1144451-bb"></a><span class="identifier">ordered_begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Returns an iterator to the first child, in key order. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">assoc_iterator</span> <a name="id1144463-bb"></a><span class="identifier">not_found</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Returns the not-found iterator. Equivalent to end() in a real associative container. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">const_assoc_iterator</span> <a name="id1144476-bb"></a><span class="identifier">not_found</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Returns the not-found iterator. Equivalent to end() in a real associative container. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">assoc_iterator</span> <a name="id1144489-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre> +<p>Find a child with the given key, or not_found() if there is none. There is no guarantee about which child is returned if multiple have the same key. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">const_assoc_iterator</span> <a name="id788125-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Find a child with the given key, or not_found() if there is none. There is no guarantee about which child is returned if multiple have the same key. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">assoc_iterator</span><span class="special">,</span> <span class="identifier">assoc_iterator</span> <span class="special">></span> <a name="id788144-bb"></a><span class="identifier">equal_range</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre> +<p>Find the range of children that have the given key. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">const_assoc_iterator</span><span class="special">,</span> <span class="identifier">const_assoc_iterator</span> <span class="special">></span> +<a name="id788163-bb"></a><span class="identifier">equal_range</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Find the range of children that have the given key. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="id788181-bb"></a><span class="identifier">count</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Count the number of direct children with the given key. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="id788199-bb"></a><span class="identifier">erase</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre> +<p>Erase all direct children with the given key and return the count. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">iterator</span> <a name="id788217-bb"></a><span class="identifier">to_iterator</span><span class="special">(</span><span class="identifier">assoc_iterator</span> it<span class="special">)</span><span class="special">;</span></pre> +<p>Get the iterator that points to the same element as the argument. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>A valid assoc_iterator range (a, b) does not imply that (to_iterator(a), to_iterator(b)) is a valid range. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="id788242-bb"></a><span class="identifier">to_iterator</span><span class="special">(</span><span class="identifier">const_assoc_iterator</span> it<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Get the iterator that points to the same element as the argument. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>A valid const_assoc_iterator range (a, b) does not imply that (to_iterator(a), to_iterator(b)) is a valid range. </p></td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">data_type</span> <span class="special">&</span> <a name="id788266-bb"></a><span class="identifier">data</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Reference to the actual data in this node. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">data_type</span> <span class="special">&</span> <a name="id788278-bb"></a><span class="identifier">data</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Reference to the actual data in this node. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="id788290-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Clear this tree completely, of both data and children. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id788302-bb"></a><span class="identifier">get_child</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">)</span><span class="special">;</span></pre> +<p>Get the child at the given path, or throw <code class="computeroutput"><code class="computeroutput"><a class="link" href="ptree_bad_path.html" title="Class ptree_bad_path">ptree_bad_path</a></code></code>. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"> +<p>Depending on the path, the result at each level may not be completely determinate, i.e. if the same key appears multiple times, which child is chosen is not specified. This can lead to the path not being resolved even though there is a descendant with this path. Example: </p> +<pre class="programlisting"> a -> b -> c + -> b +</pre> +<p> The path "a.b.c" will succeed if the resolution of "b" chooses the first such node, but fail if it chooses the second. </p> +</td></tr> +</table></div> +<p> +</p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id788345-bb"></a><span class="identifier">get_child</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Get the child at the given path, or throw <code class="computeroutput"><code class="computeroutput"><a class="link" href="ptree_bad_path.html" title="Class ptree_bad_path">ptree_bad_path</a></code></code>. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id788374-bb"></a><span class="identifier">get_child</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> default_value<span class="special">)</span><span class="special">;</span></pre> +<p>Get the child at the given path, or return <code class="computeroutput">default_value</code>. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> +<a name="id788405-bb"></a><span class="identifier">get_child</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> default_value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Get the child at the given path, or return <code class="computeroutput">default_value</code>. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">optional</span><span class="special"><</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <span class="special">></span> <a name="id788440-bb"></a><span class="identifier">get_child_optional</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">)</span><span class="special">;</span></pre> +<p>Get the child at the given path, or return boost::null. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">optional</span><span class="special"><</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <span class="special">></span> <a name="id788462-bb"></a><span class="identifier">get_child_optional</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Get the child at the given path, or return boost::null. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id788484-bb"></a><span class="identifier">put_child</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre> +<p>Set the node at the given path to the given value. Create any missing parents. If the node at the path already exists, replace it. +</p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"> +<p>Because of the way paths work, it is not generally guaranteed that a node newly created can be accessed using the same path. </p> +<p>If the path could refer to multiple nodes, it is unspecified which one gets replaced. </p> +</td></tr> +</table></div> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>A reference to the inserted subtree. </p></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id788529-bb"></a><span class="identifier">add_child</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre> +<p>Add the node at the given path. Create any missing parents. If there already is a node at the path, add another one with the same key. + +</p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>Because of the way paths work, it is not generally guaranteed that a node newly created can be accessed using the same path. </p></td></tr> +</table></div> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><code class="computeroutput">path</code></span></p></td> +<td><p>Path to the child. The last fragment must not have an index. </p></td> +</tr></tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>A reference to the inserted subtree. </p></td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id788575-bb"></a><span class="identifier">get_value</span><span class="special">(</span><span class="identifier">Translator</span> tr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Take the value of this node and attempt to translate it to a <code class="computeroutput">Type</code> object using the supplied translator. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Throws:</span></p></td> +<td> +<a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> if the conversion fails. </td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="identifier">Type</span> <a name="id788616-bb"></a><span class="identifier">get_value</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Take the value of this node and attempt to translate it to a <code class="computeroutput">Type</code> object using the default translator. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Throws:</span></p></td> +<td> +<a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> if the conversion fails. </td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="identifier">Type</span> <a name="id788645-bb"></a><span class="identifier">get_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> default_value<span class="special">,</span> <span class="identifier">Translator</span> tr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Take the value of this node and attempt to translate it to a <code class="computeroutput">Type</code> object using the supplied translator. Return <code class="computeroutput">default_value</code> if this fails. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id788688-bb"></a><span class="identifier">get_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Ch</span> <span class="special">*</span> default_value<span class="special">,</span> <span class="identifier">Translator</span> tr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Make get_value do the right thing for string literals. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id788724-bb"></a><span class="identifier">get_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> default_value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Take the value of this node and attempt to translate it to a <code class="computeroutput">Type</code> object using the default translator. Return <code class="computeroutput">default_value</code> if this fails. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id788757-bb"></a><span class="identifier">get_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Ch</span> <span class="special">*</span> default_value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Make get_value do the right thing for string literals. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="identifier">optional</span><span class="special"><</span> <span class="identifier">Type</span> <span class="special">></span> <a name="id788783-bb"></a><span class="identifier">get_value_optional</span><span class="special">(</span><span class="identifier">Translator</span> tr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Take the value of this node and attempt to translate it to a <code class="computeroutput">Type</code> object using the supplied translator. Return boost::null if this fails. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="identifier">optional</span><span class="special"><</span> <span class="identifier">Type</span> <span class="special">></span> <a name="id788817-bb"></a><span class="identifier">get_value_optional</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Take the value of this node and attempt to translate it to a <code class="computeroutput">Type</code> object using the default translator. Return boost::null if this fails. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="keyword">void</span> <a name="id788842-bb"></a><span class="identifier">put_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> value<span class="special">,</span> <span class="identifier">Translator</span> tr<span class="special">)</span><span class="special">;</span></pre> +<p>Replace the value at this node with the given value, translated to the tree's data type using the supplied translator. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Throws:</span></p></td> +<td> +<a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> if the conversion fails. </td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="keyword">void</span> <a name="id1141134-bb"></a><span class="identifier">put_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre> +<p>Replace the value at this node with the given value, translated to the tree's data type using the default translator. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Throws:</span></p></td> +<td> +<a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> if the conversion fails. </td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id1141165-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="identifier">Translator</span> tr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Shorthand for get_child(path).get_value(tr). </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="identifier">Type</span> <a name="id1141201-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Shorthand for get_child(path).get_value<Type>(). </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="identifier">Type</span> <a name="id1141226-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> default_value<span class="special">,</span> <span class="identifier">Translator</span> tr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Shorthand for get_child(path, empty_ptree()) .get_value(default_value, tr). That is, return the translated value if possible, and the default value if the node doesn't exist or conversion fails. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id1147378-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Ch</span> <span class="special">*</span> default_value<span class="special">,</span> + <span class="identifier">Translator</span> tr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Make get do the right thing for string literals. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id1147420-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> default_value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Shorthand for get_child(path, empty_ptree()) .get_value(default_value). That is, return the translated value if possible, and the default value if the node doesn't exist or conversion fails. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">></span> + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id1147453-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Ch</span> <span class="special">*</span> default_value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Make get do the right thing for string literals. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <span class="identifier">optional</span><span class="special"><</span> <span class="identifier">Type</span> <span class="special">></span> <a name="id1147485-bb"></a><span class="identifier">get_optional</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="identifier">Translator</span> tr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Shorthand for: </p> +<pre class="programlisting"> if(optional\<self_type&\> node = get_child_optional(path)) + return node->get_value_optional(tr); + return boost::null; +</pre> +<p> That is, return the value if it exists and can be converted, or nil. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> + <span class="identifier">optional</span><span class="special"><</span> <span class="identifier">Type</span> <span class="special">></span> <a name="id1147526-bb"></a><span class="identifier">get_optional</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Shorthand for: </p> +<pre class="programlisting"> if(optional\<const self_type&\> node = get_child_optional(path)) + return node->get_value_optional(); + return boost::null; +</pre> +<p> That is, return the value if it exists and can be converted, or nil. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id1147557-bb"></a><span class="identifier">put</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> value<span class="special">,</span> <span class="identifier">Translator</span> tr<span class="special">)</span><span class="special">;</span></pre> +<p>Set the value of the node at the given path to the supplied value, translated to the tree's data type. If the node doesn't exist, it is created, including all its missing parents. + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>The node that had its value changed. </p></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td> +<a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> if the conversion fails. </td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> + <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id780187-bb"></a><span class="identifier">put</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre> +<p>Set the value of the node at the given path to the supplied value, translated to the tree's data type. If the node doesn't exist, it is created, including all its missing parents. + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>The node that had its value changed. </p></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td> +<a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> if the conversion fails. </td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> + <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id1076636-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> value<span class="special">,</span> <span class="identifier">Translator</span> tr<span class="special">)</span><span class="special">;</span></pre> +<p>If the node identified by the path does not exist, create it, including all its missing parents. If the node already exists, add a sibling with the same key. Set the newly created node's value to the given paremeter, translated with the supplied translator. + + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">path</code></span></p></td> +<td><p>Path to the child. The last fragment must not have an index. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">tr</code></span></p></td> +<td><p>The translator to use. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">value</code></span></p></td> +<td><p>The value to add. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>The node that was added. </p></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td> +<a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> if the conversion fails. </td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> + <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id1076704-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre> +<p>If the node identified by the path does not exist, create it, including all its missing parents. If the node already exists, add a sibling with the same key. Set the newly created node's value to the given paremeter, translated with the supplied translator. + + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">path</code></span></p></td> +<td><p>Path to the child. The last fragment must not have an index. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">value</code></span></p></td> +<td><p>The value to add. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>The node that was added. </p></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td> +<a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> if the conversion fails. </td> +</tr> +</tbody> +</table></div> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id2562474"></a><h3> +<a name="id1076803-bb"></a><code class="computeroutput">basic_ptree</code> private member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"><pre class="literallayout"><a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">*</span> <a name="id1076806-bb"></a><span class="identifier">walk_path</span><span class="special">(</span><span class="identifier">path_type</span> <span class="special">&</span> p<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id1076822-bb"></a><span class="identifier">force_path</span><span class="special">(</span><span class="identifier">path_type</span> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="json_parser/write_json_id1071471.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="path.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/customize_stream.html b/doc/html/boost/property_tree/customize_stream.html new file mode 100755 index 0000000000..76c055a6d8 --- /dev/null +++ b/doc/html/boost/property_tree/customize_stream.html @@ -0,0 +1,66 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct template customize_stream</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp" title="Header <boost/property_tree/stream_translator.hpp>"> +<link rel="prev" href="serialize_id1071206.html" title="Function template serialize"> +<link rel="next" href="customize_stream_Ch__Tr_id760253.html" title="Struct template customize_stream<Ch, Traits, Ch, void>"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="serialize_id1071206.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="customize_stream_Ch__Tr_id760253.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.customize_stream"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template customize_stream</span></h2> +<p>boost::property_tree::customize_stream</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp" title="Header <boost/property_tree/stream_translator.hpp>">boost/property_tree/stream_translator.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">,</span> <span class="keyword">typename</span> E<span class="special">,</span> <span class="keyword">typename</span> Enabler <span class="special">=</span> <span class="keyword">void</span><span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="customize_stream.html" title="Struct template customize_stream">customize_stream</a> <span class="special">{</span> + + <span class="comment">// <a class="link" href="customize_stream.html#id760211-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="customize_stream.html#id760214-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">E</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="customize_stream.html#id760234-bb"><span class="identifier">extract</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="identifier">E</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2566647"></a><h2>Description</h2> +<div class="refsect2"> +<a name="id2566651"></a><h3> +<a name="id760211-bb"></a><code class="computeroutput">customize_stream</code> public static functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="id760214-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> s<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">E</span> <span class="special">&</span> e<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="id760234-bb"></a><span class="identifier">extract</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> s<span class="special">,</span> <span class="identifier">E</span> <span class="special">&</span> e<span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="serialize_id1071206.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="customize_stream_Ch__Tr_id760253.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/customize_stream_Ch__Tr_id1140694.html b/doc/html/boost/property_tree/customize_stream_Ch__Tr_id1140694.html new file mode 100755 index 0000000000..9ff0a6c588 --- /dev/null +++ b/doc/html/boost/property_tree/customize_stream_Ch__Tr_id1140694.html @@ -0,0 +1,66 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct template customize_stream<Ch, Traits, unsigned char, void></title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp" title="Header <boost/property_tree/stream_translator.hpp>"> +<link rel="prev" href="customize_stream_Ch__Tr_id1154223.html" title="Struct template customize_stream<Ch, Traits, signed char, void>"> +<link rel="next" href="stream_translator.html" title="Class template stream_translator"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="customize_stream_Ch__Tr_id1154223.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="stream_translator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.customize_stream_Ch,_Tr_id1140694"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template customize_stream<Ch, Traits, unsigned char, void></span></h2> +<p>boost::property_tree::customize_stream<Ch, Traits, unsigned char, void></p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp" title="Header <boost/property_tree/stream_translator.hpp>">boost/property_tree/stream_translator.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="customize_stream_Ch__Tr_id1140694.html" title="Struct template customize_stream<Ch, Traits, unsigned char, void>">customize_stream</a><span class="special"><</span><span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span><span class="special">,</span> <span class="keyword">void</span><span class="special">></span> <span class="special">{</span> + + <span class="comment">// <a class="link" href="customize_stream_Ch__Tr_id1140694.html#id1140720-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="customize_stream_Ch__Tr_id1140694.html#id1140723-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="customize_stream_Ch__Tr_id1140694.html#id1140742-bb"><span class="identifier">extract</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2569845"></a><h2>Description</h2> +<div class="refsect2"> +<a name="id2569848"></a><h3> +<a name="id1140720-bb"></a><code class="computeroutput">customize_stream</code> public static functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="id1140723-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> s<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> e<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="id1140742-bb"></a><span class="identifier">extract</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> s<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <span class="special">&</span> e<span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="customize_stream_Ch__Tr_id1154223.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="stream_translator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/customize_stream_Ch__Tr_id1142738.html b/doc/html/boost/property_tree/customize_stream_Ch__Tr_id1142738.html new file mode 100755 index 0000000000..b5135bf259 --- /dev/null +++ b/doc/html/boost/property_tree/customize_stream_Ch__Tr_id1142738.html @@ -0,0 +1,66 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct template customize_stream<Ch, Traits, F, typename boost::enable_if< detail::is_inexact< F > >::type></title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp" title="Header <boost/property_tree/stream_translator.hpp>"> +<link rel="prev" href="customize_stream_Ch__Tr_id760253.html" title="Struct template customize_stream<Ch, Traits, Ch, void>"> +<link rel="next" href="customize_stream_Ch__Tr_id1142811.html" title="Struct template customize_stream<Ch, Traits, bool, void>"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="customize_stream_Ch__Tr_id760253.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="customize_stream_Ch__Tr_id1142811.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.customize_stream_Ch,_Tr_id1142738"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template customize_stream<Ch, Traits, F, typename boost::enable_if< detail::is_inexact< F > >::type></span></h2> +<p>boost::property_tree::customize_stream<Ch, Traits, F, typename boost::enable_if< detail::is_inexact< F > >::type></p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp" title="Header <boost/property_tree/stream_translator.hpp>">boost/property_tree/stream_translator.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">,</span> <span class="keyword">typename</span> F<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="customize_stream_Ch__Tr_id1142738.html" title="Struct template customize_stream<Ch, Traits, F, typename boost::enable_if< detail::is_inexact< F > >::type>">customize_stream</a><span class="special"><</span><span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">enable_if</span><span class="special"><</span> <span class="identifier">detail</span><span class="special">::</span><span class="identifier">is_inexact</span><span class="special"><</span> <span class="identifier">F</span> <span class="special">></span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span><span class="special">></span> <span class="special">{</span> + + <span class="comment">// <a class="link" href="customize_stream_Ch__Tr_id1142738.html#id1142769-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="customize_stream_Ch__Tr_id1142738.html#id1142772-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">F</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="customize_stream_Ch__Tr_id1142738.html#id1142792-bb"><span class="identifier">extract</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="identifier">F</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2567856"></a><h2>Description</h2> +<div class="refsect2"> +<a name="id2567860"></a><h3> +<a name="id1142769-bb"></a><code class="computeroutput">customize_stream</code> public static functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="id1142772-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> s<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">F</span> <span class="special">&</span> e<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="id1142792-bb"></a><span class="identifier">extract</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> s<span class="special">,</span> <span class="identifier">F</span> <span class="special">&</span> e<span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="customize_stream_Ch__Tr_id760253.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="customize_stream_Ch__Tr_id1142811.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/customize_stream_Ch__Tr_id1142811.html b/doc/html/boost/property_tree/customize_stream_Ch__Tr_id1142811.html new file mode 100755 index 0000000000..b30c6cf48e --- /dev/null +++ b/doc/html/boost/property_tree/customize_stream_Ch__Tr_id1142811.html @@ -0,0 +1,66 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct template customize_stream<Ch, Traits, bool, void></title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp" title="Header <boost/property_tree/stream_translator.hpp>"> +<link rel="prev" href="customize_stream_Ch__Tr_id1142738.html" title="Struct template customize_stream<Ch, Traits, F, typename boost::enable_if< detail::is_inexact< F > >::type>"> +<link rel="next" href="customize_stream_Ch__Tr_id1154223.html" title="Struct template customize_stream<Ch, Traits, signed char, void>"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="customize_stream_Ch__Tr_id1142738.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="customize_stream_Ch__Tr_id1154223.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.customize_stream_Ch,_Tr_id1142811"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template customize_stream<Ch, Traits, bool, void></span></h2> +<p>boost::property_tree::customize_stream<Ch, Traits, bool, void></p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp" title="Header <boost/property_tree/stream_translator.hpp>">boost/property_tree/stream_translator.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="customize_stream_Ch__Tr_id1142811.html" title="Struct template customize_stream<Ch, Traits, bool, void>">customize_stream</a><span class="special"><</span><span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="keyword">void</span><span class="special">></span> <span class="special">{</span> + + <span class="comment">// <a class="link" href="customize_stream_Ch__Tr_id1142811.html#id1076282-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="customize_stream_Ch__Tr_id1142811.html#id1076286-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="customize_stream_Ch__Tr_id1142811.html#id1076305-bb"><span class="identifier">extract</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2568421"></a><h2>Description</h2> +<div class="refsect2"> +<a name="id2568425"></a><h3> +<a name="id1076282-bb"></a><code class="computeroutput">customize_stream</code> public static functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="id1076286-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> s<span class="special">,</span> <span class="keyword">bool</span> e<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="id1076305-bb"></a><span class="identifier">extract</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> s<span class="special">,</span> <span class="keyword">bool</span> <span class="special">&</span> e<span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="customize_stream_Ch__Tr_id1142738.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="customize_stream_Ch__Tr_id1154223.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/customize_stream_Ch__Tr_id1154223.html b/doc/html/boost/property_tree/customize_stream_Ch__Tr_id1154223.html new file mode 100755 index 0000000000..232dc9f4a8 --- /dev/null +++ b/doc/html/boost/property_tree/customize_stream_Ch__Tr_id1154223.html @@ -0,0 +1,66 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct template customize_stream<Ch, Traits, signed char, void></title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp" title="Header <boost/property_tree/stream_translator.hpp>"> +<link rel="prev" href="customize_stream_Ch__Tr_id1142811.html" title="Struct template customize_stream<Ch, Traits, bool, void>"> +<link rel="next" href="customize_stream_Ch__Tr_id1140694.html" title="Struct template customize_stream<Ch, Traits, unsigned char, void>"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="customize_stream_Ch__Tr_id1142811.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="customize_stream_Ch__Tr_id1140694.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.customize_stream_Ch,_Tr_id1154223"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template customize_stream<Ch, Traits, signed char, void></span></h2> +<p>boost::property_tree::customize_stream<Ch, Traits, signed char, void></p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp" title="Header <boost/property_tree/stream_translator.hpp>">boost/property_tree/stream_translator.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="customize_stream_Ch__Tr_id1154223.html" title="Struct template customize_stream<Ch, Traits, signed char, void>">customize_stream</a><span class="special"><</span><span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span><span class="special">,</span> <span class="keyword">signed</span> <span class="keyword">char</span><span class="special">,</span> <span class="keyword">void</span><span class="special">></span> <span class="special">{</span> + + <span class="comment">// <a class="link" href="customize_stream_Ch__Tr_id1154223.html#id1154249-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="customize_stream_Ch__Tr_id1154223.html#id1154252-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">signed</span> <span class="keyword">char</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="customize_stream_Ch__Tr_id1154223.html#id1154272-bb"><span class="identifier">extract</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">signed</span> <span class="keyword">char</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2569262"></a><h2>Description</h2> +<div class="refsect2"> +<a name="id2569266"></a><h3> +<a name="id1154249-bb"></a><code class="computeroutput">customize_stream</code> public static functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="id1154252-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> s<span class="special">,</span> <span class="keyword">signed</span> <span class="keyword">char</span> e<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="id1154272-bb"></a><span class="identifier">extract</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> s<span class="special">,</span> <span class="keyword">signed</span> <span class="keyword">char</span> <span class="special">&</span> e<span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="customize_stream_Ch__Tr_id1142811.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="customize_stream_Ch__Tr_id1140694.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/customize_stream_Ch__Tr_id760253.html b/doc/html/boost/property_tree/customize_stream_Ch__Tr_id760253.html new file mode 100755 index 0000000000..ddc181989c --- /dev/null +++ b/doc/html/boost/property_tree/customize_stream_Ch__Tr_id760253.html @@ -0,0 +1,66 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct template customize_stream<Ch, Traits, Ch, void></title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp" title="Header <boost/property_tree/stream_translator.hpp>"> +<link rel="prev" href="customize_stream.html" title="Struct template customize_stream"> +<link rel="next" href="customize_stream_Ch__Tr_id1142738.html" title="Struct template customize_stream<Ch, Traits, F, typename boost::enable_if< detail::is_inexact< F > >::type>"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="customize_stream.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="customize_stream_Ch__Tr_id1142738.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.customize_stream_Ch,_Tr_id760253"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template customize_stream<Ch, Traits, Ch, void></span></h2> +<p>boost::property_tree::customize_stream<Ch, Traits, Ch, void></p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp" title="Header <boost/property_tree/stream_translator.hpp>">boost/property_tree/stream_translator.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="customize_stream_Ch__Tr_id760253.html" title="Struct template customize_stream<Ch, Traits, Ch, void>">customize_stream</a><span class="special"><</span><span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span><span class="special">,</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="keyword">void</span><span class="special">></span> <span class="special">{</span> + + <span class="comment">// <a class="link" href="customize_stream_Ch__Tr_id760253.html#id760279-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="customize_stream_Ch__Tr_id760253.html#id760282-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Ch</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="customize_stream_Ch__Tr_id760253.html#id760302-bb"><span class="identifier">extract</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Ch</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2567212"></a><h2>Description</h2> +<div class="refsect2"> +<a name="id2567216"></a><h3> +<a name="id760279-bb"></a><code class="computeroutput">customize_stream</code> public static functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="id760282-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> s<span class="special">,</span> <span class="identifier">Ch</span> e<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="id760302-bb"></a><span class="identifier">extract</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> s<span class="special">,</span> <span class="identifier">Ch</span> <span class="special">&</span> e<span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="customize_stream.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="customize_stream_Ch__Tr_id1142738.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/id_translator.html b/doc/html/boost/property_tree/id_translator.html new file mode 100755 index 0000000000..10b6dec638 --- /dev/null +++ b/doc/html/boost/property_tree/id_translator.html @@ -0,0 +1,69 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct template id_translator</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.id_translator_hpp" title="Header <boost/property_tree/id_translator.hpp>"> +<link rel="prev" href="ptree_bad_path.html" title="Class ptree_bad_path"> +<link rel="next" href="translator_between_T__T_id1160186.html" title="Struct template translator_between<T, T>"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="ptree_bad_path.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.id_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="translator_between_T__T_id1160186.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.id_translator"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template id_translator</span></h2> +<p>boost::property_tree::id_translator — Simple implementation of the Translator concept. It does no translation. </p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.id_translator_hpp" title="Header <boost/property_tree/id_translator.hpp>">boost/property_tree/id_translator.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="id_translator.html" title="Struct template id_translator">id_translator</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">T</span> <a name="boost.property_tree.id_translator.internal_type"></a><span class="identifier">internal_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">T</span> <a name="boost.property_tree.id_translator.external_type"></a><span class="identifier">external_type</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="id_translator.html#id1160160-bb">public member functions</a></span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <a class="link" href="id_translator.html#id1160162-bb"><span class="identifier">get_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <a class="link" href="id_translator.html#id1160174-bb"><span class="identifier">put_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2543845"></a><h2>Description</h2> +<div class="refsect2"> +<a name="id2543849"></a><h3> +<a name="id1160160-bb"></a><code class="computeroutput">id_translator</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"><pre class="literallayout"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <a name="id1160162-bb"></a><span class="identifier">get_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> v<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <a name="id1160174-bb"></a><span class="identifier">put_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> v<span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="ptree_bad_path.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.id_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="translator_between_T__T_id1160186.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/info_parser/read_info_id1070500.html b/doc/html/boost/property_tree/info_parser/read_info_id1070500.html new file mode 100755 index 0000000000..58f1430eb4 --- /dev/null +++ b/doc/html/boost/property_tree/info_parser/read_info_id1070500.html @@ -0,0 +1,73 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template read_info</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp" title="Header <boost/property_tree/info_parser.hpp>"> +<link rel="prev" href="read_info_id1160104.html" title="Function template read_info"> +<link rel="next" href="read_info_id1070548.html" title="Function template read_info"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_info_id1160104.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_info_id1070548.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.info_parser.read_info_id1070500"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template read_info</span></h2> +<p>boost::property_tree::info_parser::read_info</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp" title="Header <boost/property_tree/info_parser.hpp>">boost/property_tree/info_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">read_info</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> filename<span class="special">,</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="special">&</span> loc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2546151"></a><h2>Description</h2> +<p>Read INFO from a the given file and translate it to a property tree. The tree's key type must be a string type, i.e. it must have a nested value_type typedef that is a valid parameter for basic_ifstream. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>Replaces the existing contents. Strong exception guarantee. </p></td></tr> +</table></div> +<p> + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Throws:</span></p></td> +<td>info_parser_error If the file cannot be read, doesn't contain valid INFO, or a conversion fails. </td> +</tr></tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_info_id1160104.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_info_id1070548.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/info_parser/read_info_id1070548.html b/doc/html/boost/property_tree/info_parser/read_info_id1070548.html new file mode 100755 index 0000000000..6fb5de16e1 --- /dev/null +++ b/doc/html/boost/property_tree/info_parser/read_info_id1070548.html @@ -0,0 +1,80 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template read_info</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp" title="Header <boost/property_tree/info_parser.hpp>"> +<link rel="prev" href="read_info_id1070500.html" title="Function template read_info"> +<link rel="next" href="write_info_id1070597.html" title="Function template write_info"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_info_id1070500.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_info_id1070597.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.info_parser.read_info_id1070548"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template read_info</span></h2> +<p>boost::property_tree::info_parser::read_info</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp" title="Header <boost/property_tree/info_parser.hpp>">boost/property_tree/info_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">read_info</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> filename<span class="special">,</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">Ptree</span> <span class="special">&</span> default_ptree<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="special">&</span> loc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2546380"></a><h2>Description</h2> +<p>Read INFO from a the given file and translate it to a property tree. The tree's key type must be a string type, i.e. it must have a nested value_type typedef that is a valid parameter for basic_ifstream. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>Replaces the existing contents. Strong exception guarantee. </p></td></tr> +</table></div> +<p> + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><code class="computeroutput">default_ptree</code></span></p></td> +<td><p>If parsing fails, pt is set to a copy of this tree. </p></td> +</tr></tbody> +</table></div></td> +</tr></tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_info_id1070500.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_info_id1070597.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/info_parser/read_info_id1160062.html b/doc/html/boost/property_tree/info_parser/read_info_id1160062.html new file mode 100755 index 0000000000..84e17af1f4 --- /dev/null +++ b/doc/html/boost/property_tree/info_parser/read_info_id1160062.html @@ -0,0 +1,72 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template read_info</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp" title="Header <boost/property_tree/info_parser.hpp>"> +<link rel="prev" href="../translator_between_std__id1160010.html" title="Struct template translator_between<std::basic_string< Ch, Traits, Alloc >, std::basic_string< Ch, Traits, Alloc >>"> +<link rel="next" href="read_info_id1160104.html" title="Function template read_info"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../translator_between_std__id1160010.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_info_id1160104.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.info_parser.read_info_id1160062"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template read_info</span></h2> +<p>boost::property_tree::info_parser::read_info</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp" title="Header <boost/property_tree/info_parser.hpp>">boost/property_tree/info_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">,</span> <span class="keyword">typename</span> Ch<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">read_info</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">Ch</span> <span class="special">></span> <span class="special">&</span> stream<span class="special">,</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2545744"></a><h2>Description</h2> +<p>Read INFO from a the given stream and translate it to a property tree. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>Replaces the existing contents. Strong exception guarantee. </p></td></tr> +</table></div> +<p> + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Throws:</span></p></td> +<td>info_parser_error If the stream cannot be read, doesn't contain valid INFO, or a conversion fails. </td> +</tr></tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../translator_between_std__id1160010.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_info_id1160104.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/info_parser/read_info_id1160104.html b/doc/html/boost/property_tree/info_parser/read_info_id1160104.html new file mode 100755 index 0000000000..79b5682b66 --- /dev/null +++ b/doc/html/boost/property_tree/info_parser/read_info_id1160104.html @@ -0,0 +1,79 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template read_info</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp" title="Header <boost/property_tree/info_parser.hpp>"> +<link rel="prev" href="read_info_id1160062.html" title="Function template read_info"> +<link rel="next" href="read_info_id1070500.html" title="Function template read_info"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_info_id1160062.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_info_id1070500.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.info_parser.read_info_id1160104"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template read_info</span></h2> +<p>boost::property_tree::info_parser::read_info</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp" title="Header <boost/property_tree/info_parser.hpp>">boost/property_tree/info_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">,</span> <span class="keyword">typename</span> Ch<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">read_info</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">Ch</span> <span class="special">></span> <span class="special">&</span> stream<span class="special">,</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">Ptree</span> <span class="special">&</span> default_ptree<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2545934"></a><h2>Description</h2> +<p>Read INFO from a the given stream and translate it to a property tree. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>Replaces the existing contents. Strong exception guarantee. </p></td></tr> +</table></div> +<p> + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><code class="computeroutput">default_ptree</code></span></p></td> +<td><p>If parsing fails, pt is set to a copy of this tree. </p></td> +</tr></tbody> +</table></div></td> +</tr></tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_info_id1160062.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_info_id1070500.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/info_parser/write_info_id1069437.html b/doc/html/boost/property_tree/info_parser/write_info_id1069437.html new file mode 100755 index 0000000000..56cf93e8bf --- /dev/null +++ b/doc/html/boost/property_tree/info_parser/write_info_id1069437.html @@ -0,0 +1,78 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template write_info</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp" title="Header <boost/property_tree/info_parser.hpp>"> +<link rel="prev" href="write_info_id1070597.html" title="Function template write_info"> +<link rel="next" href="../ini_parser/ini_parser_error.html" title="Class ini_parser_error"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="write_info_id1070597.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../ini_parser/ini_parser_error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.info_parser.write_info_id1069437"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template write_info</span></h2> +<p>boost::property_tree::info_parser::write_info</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp" title="Header <boost/property_tree/info_parser.hpp>">boost/property_tree/info_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">write_info</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> filename<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="special">&</span> loc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">info_writer_settings</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Ptree</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">></span> <span class="special">&</span> settings <span class="special">=</span> <span class="identifier">info_writer_make_settings</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Ptree</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">></span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2546984"></a><h2>Description</h2> +<p>Writes a tree to the file in INFO format. The tree's key type must be a string type, i.e. it must have a nested value_type typedef that is a valid parameter for basic_ofstream. + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><code class="computeroutput">settings</code></span></p></td> +<td><p>The settings to use when writing the INFO data. </p></td> +</tr></tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>info_parser_error If the file cannot be written to, or a conversion fails. </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="write_info_id1070597.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../ini_parser/ini_parser_error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/info_parser/write_info_id1070597.html b/doc/html/boost/property_tree/info_parser/write_info_id1070597.html new file mode 100755 index 0000000000..da8ad5dba2 --- /dev/null +++ b/doc/html/boost/property_tree/info_parser/write_info_id1070597.html @@ -0,0 +1,77 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template write_info</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp" title="Header <boost/property_tree/info_parser.hpp>"> +<link rel="prev" href="read_info_id1070548.html" title="Function template read_info"> +<link rel="next" href="write_info_id1069437.html" title="Function template write_info"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_info_id1070548.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_info_id1069437.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.info_parser.write_info_id1070597"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template write_info</span></h2> +<p>boost::property_tree::info_parser::write_info</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp" title="Header <boost/property_tree/info_parser.hpp>">boost/property_tree/info_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">,</span> <span class="keyword">typename</span> Ch<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">write_info</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">Ch</span> <span class="special">></span> <span class="special">&</span> stream<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">info_writer_settings</span><span class="special"><</span> <span class="identifier">Ch</span> <span class="special">></span> <span class="special">&</span> settings <span class="special">=</span> <span class="identifier">info_writer_settings</span><span class="special"><</span> <span class="identifier">Ch</span> <span class="special">></span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2546640"></a><h2>Description</h2> +<p>Writes a tree to the stream in INFO format. + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><code class="computeroutput">settings</code></span></p></td> +<td><p>The settings to use when writing the INFO data. </p></td> +</tr></tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>info_parser_error If the stream cannot be written to, or a conversion fails. </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_info_id1070548.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_info_id1069437.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/ini_parser/ini_parser_error.html b/doc/html/boost/property_tree/ini_parser/ini_parser_error.html new file mode 100755 index 0000000000..7f3d436577 --- /dev/null +++ b/doc/html/boost/property_tree/ini_parser/ini_parser_error.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class ini_parser_error</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp" title="Header <boost/property_tree/ini_parser.hpp>"> +<link rel="prev" href="../info_parser/write_info_id1069437.html" title="Function template write_info"> +<link rel="next" href="validate_flags.html" title="Function validate_flags"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../info_parser/write_info_id1069437.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="validate_flags.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.ini_parser.ini_parser_error"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class ini_parser_error</span></h2> +<p>boost::property_tree::ini_parser::ini_parser_error</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp" title="Header <boost/property_tree/ini_parser.hpp>">boost/property_tree/ini_parser.hpp</a>> + +</span> +<span class="keyword">class</span> <a class="link" href="ini_parser_error.html" title="Class ini_parser_error">ini_parser_error</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// <a class="link" href="ini_parser_error.html#boost.property_tree.ini_parser.ini_parser_errorconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="ini_parser_error.html#id1074875-bb"><span class="identifier">ini_parser_error</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">long</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2547945"></a><h2>Description</h2> +<p>Indicates an error parsing INI formatted data. </p> +<div class="refsect2"> +<a name="id2547951"></a><h3> +<a name="boost.property_tree.ini_parser.ini_parser_errorconstruct-copy-destruct"></a><code class="computeroutput">ini_parser_error</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><a name="id1074875-bb"></a><span class="identifier">ini_parser_error</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> message<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> filename<span class="special">,</span> + <span class="keyword">unsigned</span> <span class="keyword">long</span> line<span class="special">)</span><span class="special">;</span></pre> +<p>Construct an <code class="computeroutput"><code class="computeroutput"><a class="link" href="ini_parser_error.html" title="Class ini_parser_error">ini_parser_error</a></code></code> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">filename</code></span></p></td> +<td><p>The name of the file being parsed containing the error. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">line</code></span></p></td> +<td><p>The line in the given file where an error was encountered. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">message</code></span></p></td> +<td><p>Message describing the parser error. </p></td> +</tr> +</tbody> +</table></div></td> +</tr></tbody> +</table></div> +</li></ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../info_parser/write_info_id1069437.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="validate_flags.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/ini_parser/read_ini_id1074940.html b/doc/html/boost/property_tree/ini_parser/read_ini_id1074940.html new file mode 100755 index 0000000000..c7bfe599f8 --- /dev/null +++ b/doc/html/boost/property_tree/ini_parser/read_ini_id1074940.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template read_ini</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp" title="Header <boost/property_tree/ini_parser.hpp>"> +<link rel="prev" href="validate_flags.html" title="Function validate_flags"> +<link rel="next" href="read_ini_id1074986.html" title="Function template read_ini"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="validate_flags.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_ini_id1074986.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.ini_parser.read_ini_id1074940"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template read_ini</span></h2> +<p>boost::property_tree::ini_parser::read_ini</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp" title="Header <boost/property_tree/ini_parser.hpp>">boost/property_tree/ini_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">read_ini</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Ptree</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">></span> <span class="special">&</span> stream<span class="special">,</span> + <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2548402"></a><h2>Description</h2> +<p>Read INI from a the given stream and translate it to a property tree. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>Clears existing contents of property tree. In case of error the property tree is not modified. </p></td></tr> +</table></div> +<p> + + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">pt</code></span></p></td> +<td><p>The property tree to populate. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">stream</code></span></p></td> +<td><p>Stream from which to read in the property tree. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td> +<a class="link" href="ini_parser_error.html" title="Class ini_parser_error">ini_parser_error</a> If a format violation is found. </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="validate_flags.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_ini_id1074986.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/ini_parser/read_ini_id1074986.html b/doc/html/boost/property_tree/ini_parser/read_ini_id1074986.html new file mode 100755 index 0000000000..bd6aacebaf --- /dev/null +++ b/doc/html/boost/property_tree/ini_parser/read_ini_id1074986.html @@ -0,0 +1,97 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template read_ini</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp" title="Header <boost/property_tree/ini_parser.hpp>"> +<link rel="prev" href="read_ini_id1074940.html" title="Function template read_ini"> +<link rel="next" href="write_ini_id1075043.html" title="Function template write_ini"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_ini_id1074940.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_ini_id1075043.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.ini_parser.read_ini_id1074986"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template read_ini</span></h2> +<p>boost::property_tree::ini_parser::read_ini</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp" title="Header <boost/property_tree/ini_parser.hpp>">boost/property_tree/ini_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">read_ini</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> filename<span class="special">,</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="special">&</span> loc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2548644"></a><h2>Description</h2> +<p>Read INI from a the given file and translate it to a property tree. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>Clears existing contents of property tree. In case of error the property tree unmodified. </p></td></tr> +</table></div> +<p> + + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">filename</code></span></p></td> +<td><p>Name of file from which to read in the property tree. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">loc</code></span></p></td> +<td><p>The locale to use when reading in the file contents. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">pt</code></span></p></td> +<td><p>The property tree to populate. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td> +<a class="link" href="ini_parser_error.html" title="Class ini_parser_error">ini_parser_error</a> In case of error deserializing the property tree. </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_ini_id1074940.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_ini_id1075043.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/ini_parser/validate_flags.html b/doc/html/boost/property_tree/ini_parser/validate_flags.html new file mode 100755 index 0000000000..22e7acbf57 --- /dev/null +++ b/doc/html/boost/property_tree/ini_parser/validate_flags.html @@ -0,0 +1,75 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function validate_flags</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp" title="Header <boost/property_tree/ini_parser.hpp>"> +<link rel="prev" href="ini_parser_error.html" title="Class ini_parser_error"> +<link rel="next" href="read_ini_id1074940.html" title="Function template read_ini"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="ini_parser_error.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_ini_id1074940.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.ini_parser.validate_flags"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function validate_flags</span></h2> +<p>boost::property_tree::ini_parser::validate_flags</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp" title="Header <boost/property_tree/ini_parser.hpp>">boost/property_tree/ini_parser.hpp</a>> + +</span> +<span class="keyword">bool</span> <span class="identifier">validate_flags</span><span class="special">(</span><span class="keyword">int</span> flags<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2548202"></a><h2>Description</h2> +<p>Determines whether the <code class="computeroutput">flags</code> are valid for use with the ini_parser. + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><code class="computeroutput">flags</code></span></p></td> +<td><p>value to check for validity as flags to ini_parser. </p></td> +</tr></tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>true if the flags are valid, false otherwise. </p></td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="ini_parser_error.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_ini_id1074940.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/ini_parser/write_ini_id1075043.html b/doc/html/boost/property_tree/ini_parser/write_ini_id1075043.html new file mode 100755 index 0000000000..985faebd36 --- /dev/null +++ b/doc/html/boost/property_tree/ini_parser/write_ini_id1075043.html @@ -0,0 +1,98 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template write_ini</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp" title="Header <boost/property_tree/ini_parser.hpp>"> +<link rel="prev" href="read_ini_id1074986.html" title="Function template read_ini"> +<link rel="next" href="write_ini_id1075120.html" title="Function template write_ini"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_ini_id1074986.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_ini_id1075120.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.ini_parser.write_ini_id1075043"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template write_ini</span></h2> +<p>boost::property_tree::ini_parser::write_ini</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp" title="Header <boost/property_tree/ini_parser.hpp>">boost/property_tree/ini_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">write_ini</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Ptree</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">></span> <span class="special">&</span> stream<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">,</span> <span class="keyword">int</span> flags <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2548899"></a><h2>Description</h2> +<p>Translates the property tree to INI and writes it the given output stream. + + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">flags</code></span></p></td> +<td><p>The flags to use when writing the INI file. No flags are currently supported. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">pt</code></span></p></td> +<td><p>The property tree to tranlsate to INI and output. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">stream</code></span></p></td> +<td><p>The stream to which to write the INI representation of the property tree. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Requires:</span></p></td> +<td> +<p><span class="emphasis"><em>pt</em></span> cannot have data in its root. </p> +<p><span class="emphasis"><em>pt</em></span> cannot have keys both data and children. </p> +<p><span class="emphasis"><em>pt</em></span> cannot be deeper than two levels. </p> +<p>There cannot be duplicate keys on any given level of <span class="emphasis"><em>pt</em></span>. </p> +</td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td> +<a class="link" href="ini_parser_error.html" title="Class ini_parser_error">ini_parser_error</a> In case of error translating the property tree to INI or writing to the output stream. </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_ini_id1074986.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_ini_id1075120.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/ini_parser/write_ini_id1075120.html b/doc/html/boost/property_tree/ini_parser/write_ini_id1075120.html new file mode 100755 index 0000000000..5145e9a395 --- /dev/null +++ b/doc/html/boost/property_tree/ini_parser/write_ini_id1075120.html @@ -0,0 +1,106 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template write_ini</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp" title="Header <boost/property_tree/ini_parser.hpp>"> +<link rel="prev" href="write_ini_id1075043.html" title="Function template write_ini"> +<link rel="next" href="../json_parser/read_json_id1140937.html" title="Function template read_json"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="write_ini_id1075043.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../json_parser/read_json_id1140937.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.ini_parser.write_ini_id1075120"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template write_ini</span></h2> +<p>boost::property_tree::ini_parser::write_ini</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp" title="Header <boost/property_tree/ini_parser.hpp>">boost/property_tree/ini_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">write_ini</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> filename<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">,</span> + <span class="keyword">int</span> flags <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="special">&</span> loc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2549200"></a><h2>Description</h2> +<p>Translates the property tree to INI and writes it the given file. + + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">filename</code></span></p></td> +<td><p>The name of the file to which to write the INI representation of the property tree. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">flags</code></span></p></td> +<td> +<p>The flags to use when writing the INI file. The following flags are supported: </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><code class="computeroutput">skip_ini_validity_check</code> -- Skip check if ptree is a valid ini. The validity check covers the preconditions but takes <code class="computeroutput">O(n log n)</code> time. </p></li></ul></div> +<p> +</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">loc</code></span></p></td> +<td><p>The locale to use when writing the file. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">pt</code></span></p></td> +<td><p>The property tree to tranlsate to INI and output. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Requires:</span></p></td> +<td> +<p><span class="emphasis"><em>pt</em></span> cannot have data in its root. </p> +<p><span class="emphasis"><em>pt</em></span> cannot have keys both data and children. </p> +<p><span class="emphasis"><em>pt</em></span> cannot be deeper than two levels. </p> +<p>There cannot be duplicate keys on any given level of <span class="emphasis"><em>pt</em></span>. </p> +</td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>info_parser_error In case of error translating the property tree to INI or writing to the file. </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="write_ini_id1075043.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../json_parser/read_json_id1140937.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/iptree.html b/doc/html/boost/property_tree/iptree.html new file mode 100755 index 0000000000..d202ff840e --- /dev/null +++ b/doc/html/boost/property_tree/iptree.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Type definition iptree</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp" title="Header <boost/property_tree/ptree_fwd.hpp>"> +<link rel="prev" href="ptree.html" title="Type definition ptree"> +<link rel="next" href="wpath.html" title="Type definition wpath"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="ptree.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="wpath.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.iptree"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Type definition iptree</span></h2> +<p>iptree</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp" title="Header <boost/property_tree/ptree_fwd.hpp>">boost/property_tree/ptree_fwd.hpp</a>> + +</span> +<span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="identifier">iptree</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2563493"></a><h2>Description</h2> +<p>A property tree with std::string for key and data, and case-insensitive comparison. </p> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="ptree.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="wpath.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/json_parser/read_json_id1071328.html b/doc/html/boost/property_tree/json_parser/read_json_id1071328.html new file mode 100755 index 0000000000..a7c0c71fdd --- /dev/null +++ b/doc/html/boost/property_tree/json_parser/read_json_id1071328.html @@ -0,0 +1,100 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template read_json</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp" title="Header <boost/property_tree/json_parser.hpp>"> +<link rel="prev" href="read_json_id1140937.html" title="Function template read_json"> +<link rel="next" href="write_json_id1071400.html" title="Function template write_json"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_json_id1140937.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_json_id1071400.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.json_parser.read_json_id1071328"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template read_json</span></h2> +<p>boost::property_tree::json_parser::read_json</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp" title="Header <boost/property_tree/json_parser.hpp>">boost/property_tree/json_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">read_json</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> filename<span class="special">,</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="special">&</span> loc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2550403"></a><h2>Description</h2> +<p>Read JSON from a the given file and translate it to a property tree. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"> +<p>Clears existing contents of property tree. In case of error the property tree unmodified. </p> +<p>Items of JSON arrays are translated into ptree keys with empty names. Members of objects are translated into named keys. </p> +<p>JSON data can be a string, a numeric value, or one of literals "null", "true" and "false". During parse, any of the above is copied verbatim into ptree data string. </p> +</td></tr> +</table></div> +<p> + + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">filename</code></span></p></td> +<td><p>Name of file from which to read in the property tree. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">loc</code></span></p></td> +<td><p>The locale to use when reading in the file contents. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">pt</code></span></p></td> +<td><p>The property tree to populate. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>json_parser_error In case of error deserializing the property tree. </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_json_id1140937.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_json_id1071400.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/json_parser/read_json_id1140937.html b/doc/html/boost/property_tree/json_parser/read_json_id1140937.html new file mode 100755 index 0000000000..427f7681b3 --- /dev/null +++ b/doc/html/boost/property_tree/json_parser/read_json_id1140937.html @@ -0,0 +1,96 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template read_json</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp" title="Header <boost/property_tree/json_parser.hpp>"> +<link rel="prev" href="../ini_parser/write_ini_id1075120.html" title="Function template write_ini"> +<link rel="next" href="read_json_id1071328.html" title="Function template read_json"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../ini_parser/write_ini_id1075120.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_json_id1071328.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.json_parser.read_json_id1140937"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template read_json</span></h2> +<p>boost::property_tree::json_parser::read_json</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp" title="Header <boost/property_tree/json_parser.hpp>">boost/property_tree/json_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">read_json</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Ptree</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">></span> <span class="special">&</span> stream<span class="special">,</span> + <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2550158"></a><h2>Description</h2> +<p>Read JSON from a the given stream and translate it to a property tree. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"> +<p>Clears existing contents of property tree. In case of error the property tree unmodified. </p> +<p>Items of JSON arrays are translated into ptree keys with empty names. Members of objects are translated into named keys. </p> +<p>JSON data can be a string, a numeric value, or one of literals "null", "true" and "false". During parse, any of the above is copied verbatim into ptree data string. </p> +</td></tr> +</table></div> +<p> + + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">pt</code></span></p></td> +<td><p>The property tree to populate. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">stream</code></span></p></td> +<td><p>Stream from which to read in the property tree. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>json_parser_error In case of error deserializing the property tree. </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../ini_parser/write_ini_id1075120.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_json_id1071328.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/json_parser/write_json_id1071400.html b/doc/html/boost/property_tree/json_parser/write_json_id1071400.html new file mode 100755 index 0000000000..0182a4e6ec --- /dev/null +++ b/doc/html/boost/property_tree/json_parser/write_json_id1071400.html @@ -0,0 +1,101 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template write_json</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp" title="Header <boost/property_tree/json_parser.hpp>"> +<link rel="prev" href="read_json_id1071328.html" title="Function template read_json"> +<link rel="next" href="write_json_id1071471.html" title="Function template write_json"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_json_id1071328.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_json_id1071471.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.json_parser.write_json_id1071400"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template write_json</span></h2> +<p>boost::property_tree::json_parser::write_json</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp" title="Header <boost/property_tree/json_parser.hpp>">boost/property_tree/json_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">write_json</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Ptree</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">></span> <span class="special">&</span> stream<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">,</span> <span class="keyword">bool</span> pretty <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2550660"></a><h2>Description</h2> +<p>Translates the property tree to JSON and writes it the given output stream. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>Any property tree key containing only unnamed subkeys will be rendered as JSON arrays. </p></td></tr> +</table></div> +<p> + + + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">pretty</code></span></p></td> +<td><p>Whether to pretty-print. Defaults to true for backward compatibility. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">pt</code></span></p></td> +<td><p>The property tree to tranlsate to JSON and output. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">stream</code></span></p></td> +<td><p>The stream to which to write the JSON representation of the property tree. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Requires:</span></p></td> +<td><p><span class="emphasis"><em>pt</em></span> cannot contain keys that have both subkeys and non-empty data. </p></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>json_parser_error In case of error translating the property tree to JSON or writing to the output stream. </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_json_id1071328.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_json_id1071471.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/json_parser/write_json_id1071471.html b/doc/html/boost/property_tree/json_parser/write_json_id1071471.html new file mode 100755 index 0000000000..d2e24f07ae --- /dev/null +++ b/doc/html/boost/property_tree/json_parser/write_json_id1071471.html @@ -0,0 +1,106 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template write_json</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp" title="Header <boost/property_tree/json_parser.hpp>"> +<link rel="prev" href="write_json_id1071400.html" title="Function template write_json"> +<link rel="next" href="../basic_ptree.html" title="Class template basic_ptree"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="write_json_id1071400.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../basic_ptree.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.json_parser.write_json_id1071471"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template write_json</span></h2> +<p>boost::property_tree::json_parser::write_json</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp" title="Header <boost/property_tree/json_parser.hpp>">boost/property_tree/json_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">write_json</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> filename<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="special">&</span> loc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> + <span class="keyword">bool</span> pretty <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2550945"></a><h2>Description</h2> +<p>Translates the property tree to JSON and writes it the given file. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>Any property tree key containing only unnamed subkeys will be rendered as JSON arrays. </p></td></tr> +</table></div> +<p> + + + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">filename</code></span></p></td> +<td><p>The name of the file to which to write the JSON representation of the property tree. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">loc</code></span></p></td> +<td><p>The locale to use when writing out to the output file. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">pretty</code></span></p></td> +<td><p>Whether to pretty-print. Defaults to true and last place for backward compatibility. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">pt</code></span></p></td> +<td><p>The property tree to translate to JSON and output. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Requires:</span></p></td> +<td><p><span class="emphasis"><em>pt</em></span> cannot contain keys that have both subkeys and non-empty data. </p></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>json_parser_error In case of error translating the property tree to JSON or writing to the file. </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="write_json_id1071400.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../basic_ptree.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/load.html b/doc/html/boost/property_tree/load.html new file mode 100755 index 0000000000..c82089cec1 --- /dev/null +++ b/doc/html/boost/property_tree/load.html @@ -0,0 +1,96 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template load</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_hpp" title="Header <boost/property_tree/ptree_serialization.hpp>"> +<link rel="prev" href="save.html" title="Function template save"> +<link rel="next" href="serialize_id1071206.html" title="Function template serialize"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="save.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="serialize_id1071206.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.load"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template load</span></h2> +<p>boost::property_tree::load</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_hpp" title="Header <boost/property_tree/ptree_serialization.hpp>">boost/property_tree/ptree_serialization.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Archive<span class="special">,</span> <span class="keyword">typename</span> K<span class="special">,</span> <span class="keyword">typename</span> D<span class="special">,</span> <span class="keyword">typename</span> C<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">load</span><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&</span> ar<span class="special">,</span> <a class="link" href="basic_ptree.html" title="Class template basic_ptree">basic_ptree</a><span class="special"><</span> <span class="identifier">K</span><span class="special">,</span> <span class="identifier">D</span><span class="special">,</span> <span class="identifier">C</span> <span class="special">></span> <span class="special">&</span> t<span class="special">,</span> + <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> file_version<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2565073"></a><h2>Description</h2> +<p>De-serialize the property tree to the given archive. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>In addition to de-serializing from regular archives, this supports loading from archives requiring name-value pairs, e.g. XML archives. The format should be that used by boost::property_tree::save. </p></td></tr> +</table></div> +<p> + + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">ar</code></span></p></td> +<td><p>The archive from which to load the serialized property tree. This archive should conform to the concept laid out by the Boost.Serialization library. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">file_version</code></span></p></td> +<td><p>file_version for the archive. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">t</code></span></p></td> +<td><p>The property tree to de-serialize. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Postconditions:</span></p></td> +<td><p><code class="computeroutput">t</code> will contain the de-serialized data from <code class="computeroutput">ar</code>. </p></td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="save.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="serialize_id1071206.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/path.html b/doc/html/boost/property_tree/path.html new file mode 100755 index 0000000000..8075456b5b --- /dev/null +++ b/doc/html/boost/property_tree/path.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Type definition path</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp" title="Header <boost/property_tree/ptree_fwd.hpp>"> +<link rel="prev" href="basic_ptree.html" title="Class template basic_ptree"> +<link rel="next" href="ptree.html" title="Type definition ptree"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="basic_ptree.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ptree.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.path"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Type definition path</span></h2> +<p>path</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp" title="Header <boost/property_tree/ptree_fwd.hpp>">boost/property_tree/ptree_fwd.hpp</a>> + +</span> +<span class="keyword">typedef</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">,</span> <a class="link" href="id_translator.html" title="Struct template id_translator">id_translator</a><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">></span> <span class="special">></span> <span class="identifier">path</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2563326"></a><h2>Description</h2> +<p>Implements a path using a std::string as the key. </p> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="basic_ptree.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ptree.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/path_of_std_basic_strin_id782647.html b/doc/html/boost/property_tree/path_of_std_basic_strin_id782647.html new file mode 100755 index 0000000000..95b9aae2c5 --- /dev/null +++ b/doc/html/boost/property_tree/path_of_std_basic_strin_id782647.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct template path_of<std::basic_string< Ch, Traits, Alloc >></title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.string_path_hpp" title="Header <boost/property_tree/string_path.hpp>"> +<link rel="prev" href="string_path.html" title="Class template string_path"> +<link rel="next" href="xml_parser/read_xml_id1145781.html" title="Function template read_xml"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="string_path.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.string_path_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="xml_parser/read_xml_id1145781.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.path_of_std_basic_strin_id782647"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template path_of<std::basic_string< Ch, Traits, Alloc >></span></h2> +<p>boost::property_tree::path_of<std::basic_string< Ch, Traits, Alloc >></p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.string_path_hpp" title="Header <boost/property_tree/string_path.hpp>">boost/property_tree/string_path.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="path_of_std_basic_strin_id782647.html" title="Struct template path_of<std::basic_string< Ch, Traits, Alloc >>">path_of</a><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span><span class="special">></span> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <a name="boost.property_tree.path_of_std_basic_strin_id782647._string"></a><span class="identifier">_string</span><span class="special">;</span> + <span class="keyword">typedef</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a><span class="special"><</span> <span class="identifier">_string</span><span class="special">,</span> <a class="link" href="id_translator.html" title="Struct template id_translator">id_translator</a><span class="special"><</span> <span class="identifier">_string</span> <span class="special">></span> <span class="special">></span> <a name="boost.property_tree.path_of_std_basic_strin_id782647.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="string_path.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.string_path_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="xml_parser/read_xml_id1145781.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/ptree.html b/doc/html/boost/property_tree/ptree.html new file mode 100755 index 0000000000..9abf829bbc --- /dev/null +++ b/doc/html/boost/property_tree/ptree.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Type definition ptree</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp" title="Header <boost/property_tree/ptree_fwd.hpp>"> +<link rel="prev" href="path.html" title="Type definition path"> +<link rel="next" href="iptree.html" title="Type definition iptree"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="path.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="iptree.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.ptree"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Type definition ptree</span></h2> +<p>ptree</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp" title="Header <boost/property_tree/ptree_fwd.hpp>">boost/property_tree/ptree_fwd.hpp</a>> + +</span> +<span class="keyword">typedef</span> <a class="link" href="basic_ptree.html" title="Class template basic_ptree">basic_ptree</a><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">></span> <span class="identifier">ptree</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2563431"></a><h2>Description</h2> +<p>A property tree with std::string for key and data, and default comparison. </p> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="path.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="iptree.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/ptree_bad_data.html b/doc/html/boost/property_tree/ptree_bad_data.html new file mode 100755 index 0000000000..e7900ff25d --- /dev/null +++ b/doc/html/boost/property_tree/ptree_bad_data.html @@ -0,0 +1,99 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class ptree_bad_data</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.exceptions_hpp" title="Header <boost/property_tree/exceptions.hpp>"> +<link rel="prev" href="ptree_error.html" title="Class ptree_error"> +<link rel="next" href="ptree_bad_path.html" title="Class ptree_bad_path"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="ptree_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.exceptions_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ptree_bad_path.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.ptree_bad_data"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class ptree_bad_data</span></h2> +<p>boost::property_tree::ptree_bad_data — Error indicating that translation from given value to the property tree data_type (or vice versa) failed. Derives from <a class="link" href="ptree_error.html" title="Class ptree_error">ptree_error</a>. </p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.exceptions_hpp" title="Header <boost/property_tree/exceptions.hpp>">boost/property_tree/exceptions.hpp</a>> + +</span> +<span class="keyword">class</span> <a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">property_tree</span><span class="special">::</span><span class="identifier">ptree_error</span> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// <a class="link" href="ptree_bad_data.html#boost.property_tree.ptree_bad_dataconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="ptree_bad_data.html#id1146236-bb"><span class="identifier">ptree_bad_data</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="ptree_bad_data.html#id1146274-bb"><span class="special">~</span><span class="identifier">ptree_bad_data</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="ptree_bad_data.html#id1146215-bb">public member functions</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">T</span> <a class="link" href="ptree_bad_data.html#id1146218-bb"><span class="identifier">data</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2542329"></a><h2>Description</h2> +<div class="refsect2"> +<a name="id2542332"></a><h3> +<a name="boost.property_tree.ptree_bad_dataconstruct-copy-destruct"></a><code class="computeroutput">ptree_bad_data</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a name="id1146236-bb"></a><span class="identifier">ptree_bad_data</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> what<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> data<span class="special">)</span><span class="special">;</span></pre>Instantiate a <code class="computeroutput"><a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a></code> instance with the given message and data. <p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">data</code></span></p></td> +<td><p>The value associated with this error that was the source of the translation failure. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">what</code></span></p></td> +<td><p>The message to associate with this error. </p></td> +</tr> +</tbody> +</table></div></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"><pre class="literallayout"><a name="id1146274-bb"></a><span class="special">~</span><span class="identifier">ptree_bad_data</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id2542534"></a><h3> +<a name="id1146215-bb"></a><code class="computeroutput">ptree_bad_data</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">T</span> <a name="id1146218-bb"></a><span class="identifier">data</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Retrieve the data associated with this error. This is the source value that failed to be translated. You need to explicitly specify its type. </li></ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="ptree_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.exceptions_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ptree_bad_path.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/ptree_bad_path.html b/doc/html/boost/property_tree/ptree_bad_path.html new file mode 100755 index 0000000000..a21ba9bdf1 --- /dev/null +++ b/doc/html/boost/property_tree/ptree_bad_path.html @@ -0,0 +1,99 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class ptree_bad_path</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.exceptions_hpp" title="Header <boost/property_tree/exceptions.hpp>"> +<link rel="prev" href="ptree_bad_data.html" title="Class ptree_bad_data"> +<link rel="next" href="id_translator.html" title="Struct template id_translator"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="ptree_bad_data.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.exceptions_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="id_translator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.ptree_bad_path"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class ptree_bad_path</span></h2> +<p>boost::property_tree::ptree_bad_path — Error indicating that specified path does not exist. Derives from <a class="link" href="ptree_error.html" title="Class ptree_error">ptree_error</a>. </p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.exceptions_hpp" title="Header <boost/property_tree/exceptions.hpp>">boost/property_tree/exceptions.hpp</a>> + +</span> +<span class="keyword">class</span> <a class="link" href="ptree_bad_path.html" title="Class ptree_bad_path">ptree_bad_path</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">property_tree</span><span class="special">::</span><span class="identifier">ptree_error</span> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// <a class="link" href="ptree_bad_path.html#boost.property_tree.ptree_bad_pathconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="ptree_bad_path.html#id1146311-bb"><span class="identifier">ptree_bad_path</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="ptree_bad_path.html#id1160853-bb"><span class="special">~</span><span class="identifier">ptree_bad_path</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="ptree_bad_path.html#id1146292-bb">public member functions</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">T</span> <a class="link" href="ptree_bad_path.html#id1146295-bb"><span class="identifier">path</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2542930"></a><h2>Description</h2> +<div class="refsect2"> +<a name="id2542934"></a><h3> +<a name="boost.property_tree.ptree_bad_pathconstruct-copy-destruct"></a><code class="computeroutput">ptree_bad_path</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a name="id1146311-bb"></a><span class="identifier">ptree_bad_path</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> what<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> path<span class="special">)</span><span class="special">;</span></pre>Instantiate a <code class="computeroutput"><a class="link" href="ptree_bad_path.html" title="Class ptree_bad_path">ptree_bad_path</a></code> with the given message and path data. <p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">path</code></span></p></td> +<td><p>The path that could not be found in the property_tree. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">what</code></span></p></td> +<td><p>The message to associate with this error. </p></td> +</tr> +</tbody> +</table></div></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"><pre class="literallayout"><a name="id1160853-bb"></a><span class="special">~</span><span class="identifier">ptree_bad_path</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id2543135"></a><h3> +<a name="id1146292-bb"></a><code class="computeroutput">ptree_bad_path</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">T</span> <a name="id1146295-bb"></a><span class="identifier">path</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Retrieve the invalid path. You need to explicitly specify the type of path. </li></ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="ptree_bad_data.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.exceptions_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="id_translator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/ptree_error.html b/doc/html/boost/property_tree/ptree_error.html new file mode 100755 index 0000000000..6c81d41fb4 --- /dev/null +++ b/doc/html/boost/property_tree/ptree_error.html @@ -0,0 +1,84 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class ptree_error</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.exceptions_hpp" title="Header <boost/property_tree/exceptions.hpp>"> +<link rel="prev" href="../../property_tree/reference.html" title="Reference"> +<link rel="next" href="ptree_bad_data.html" title="Class ptree_bad_data"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../../property_tree/reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.exceptions_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ptree_bad_data.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.ptree_error"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class ptree_error</span></h2> +<p>boost::property_tree::ptree_error — Base class for all property tree errors. Derives from <code class="computeroutput">std::runtime_error</code>. Call member function <code class="computeroutput">what</code> to get human readable message associated with the error. </p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.exceptions_hpp" title="Header <boost/property_tree/exceptions.hpp>">boost/property_tree/exceptions.hpp</a>> + +</span> +<span class="keyword">class</span> <a class="link" href="ptree_error.html" title="Class ptree_error">ptree_error</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// <a class="link" href="ptree_error.html#boost.property_tree.ptree_errorconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="ptree_error.html#id1146174-bb"><span class="identifier">ptree_error</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="ptree_error.html#id1146196-bb"><span class="special">~</span><span class="identifier">ptree_error</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2541863"></a><h2>Description</h2> +<div class="refsect2"> +<a name="id2541866"></a><h3> +<a name="boost.property_tree.ptree_errorconstruct-copy-destruct"></a><code class="computeroutput">ptree_error</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="id1146174-bb"></a><span class="identifier">ptree_error</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> what<span class="special">)</span><span class="special">;</span></pre>Instantiate a <code class="computeroutput"><a class="link" href="ptree_error.html" title="Class ptree_error">ptree_error</a></code> instance with the given message. <p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><code class="computeroutput">what</code></span></p></td> +<td><p>The message to associate with this error. </p></td> +</tr></tbody> +</table></div></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"><pre class="literallayout"><a name="id1146196-bb"></a><span class="special">~</span><span class="identifier">ptree_error</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../../property_tree/reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.exceptions_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ptree_bad_data.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/save.html b/doc/html/boost/property_tree/save.html new file mode 100755 index 0000000000..850e93334f --- /dev/null +++ b/doc/html/boost/property_tree/save.html @@ -0,0 +1,96 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template save</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_hpp" title="Header <boost/property_tree/ptree_serialization.hpp>"> +<link rel="prev" href="swap_id783350.html" title="Function template swap"> +<link rel="next" href="load.html" title="Function template load"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="swap_id783350.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="load.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.save"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template save</span></h2> +<p>boost::property_tree::save</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_hpp" title="Header <boost/property_tree/ptree_serialization.hpp>">boost/property_tree/ptree_serialization.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Archive<span class="special">,</span> <span class="keyword">typename</span> K<span class="special">,</span> <span class="keyword">typename</span> D<span class="special">,</span> <span class="keyword">typename</span> C<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">save</span><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&</span> ar<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html" title="Class template basic_ptree">basic_ptree</a><span class="special"><</span> <span class="identifier">K</span><span class="special">,</span> <span class="identifier">D</span><span class="special">,</span> <span class="identifier">C</span> <span class="special">></span> <span class="special">&</span> t<span class="special">,</span> + <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> file_version<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2564789"></a><h2>Description</h2> +<p>Serialize the property tree to the given archive. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>In addition to serializing to regular archives, this supports serializing to archives requiring name-value pairs, e.g. XML archives. However, the output format in the XML archive is not guaranteed to be the same as that when using the Boost.PropertyTree library's <code class="computeroutput">boost::property_tree::xml_parser::write_xml</code>. </p></td></tr> +</table></div> +<p> + + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">ar</code></span></p></td> +<td><p>The archive to which to save the serialized property tree. This archive should conform to the concept laid out by the Boost.Serialization library. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">file_version</code></span></p></td> +<td><p>file_version for the archive. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">t</code></span></p></td> +<td><p>The property tree to serialize. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Postconditions:</span></p></td> +<td><p><code class="computeroutput">ar</code> will contain the serialized form of <code class="computeroutput">t</code>. </p></td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="swap_id783350.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="load.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/serialize_id1071206.html b/doc/html/boost/property_tree/serialize_id1071206.html new file mode 100755 index 0000000000..62cedd2842 --- /dev/null +++ b/doc/html/boost/property_tree/serialize_id1071206.html @@ -0,0 +1,80 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template serialize</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_hpp" title="Header <boost/property_tree/ptree_serialization.hpp>"> +<link rel="prev" href="load.html" title="Function template load"> +<link rel="next" href="customize_stream.html" title="Struct template customize_stream"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="load.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="customize_stream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.serialize_id1071206"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template serialize</span></h2> +<p>boost::property_tree::serialize</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_hpp" title="Header <boost/property_tree/ptree_serialization.hpp>">boost/property_tree/ptree_serialization.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Archive<span class="special">,</span> <span class="keyword">typename</span> K<span class="special">,</span> <span class="keyword">typename</span> D<span class="special">,</span> <span class="keyword">typename</span> C<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">serialize</span><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&</span> ar<span class="special">,</span> <a class="link" href="basic_ptree.html" title="Class template basic_ptree">basic_ptree</a><span class="special"><</span> <span class="identifier">K</span><span class="special">,</span> <span class="identifier">D</span><span class="special">,</span> <span class="identifier">C</span> <span class="special">></span> <span class="special">&</span> t<span class="special">,</span> + <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> file_version<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2565349"></a><h2>Description</h2> +<p>Load or store the property tree using the given archive. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">ar</code></span></p></td> +<td><p>The archive from which to load or save the serialized property tree. The type of this archive will determine whether saving or loading is performed. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">file_version</code></span></p></td> +<td><p>file_version for the archive. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">t</code></span></p></td> +<td><p>The property tree to load or save. </p></td> +</tr> +</tbody> +</table></div></td> +</tr></tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="load.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="customize_stream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/stream_translator.html b/doc/html/boost/property_tree/stream_translator.html new file mode 100755 index 0000000000..93b3cc5cce --- /dev/null +++ b/doc/html/boost/property_tree/stream_translator.html @@ -0,0 +1,80 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class template stream_translator</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp" title="Header <boost/property_tree/stream_translator.hpp>"> +<link rel="prev" href="customize_stream_Ch__Tr_id1140694.html" title="Struct template customize_stream<Ch, Traits, unsigned char, void>"> +<link rel="next" href="translator_between_std__id782306.html" title="Struct template translator_between<std::basic_string< Ch, Traits, Alloc >, E>"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="customize_stream_Ch__Tr_id1140694.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="translator_between_std__id782306.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.stream_translator"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template stream_translator</span></h2> +<p>boost::property_tree::stream_translator — Implementation of Translator that uses the stream overloads. </p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp" title="Header <boost/property_tree/stream_translator.hpp>">boost/property_tree/stream_translator.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">,</span> <span class="keyword">typename</span> E<span class="special">></span> +<span class="keyword">class</span> <a class="link" href="stream_translator.html" title="Class template stream_translator">stream_translator</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <a name="boost.property_tree.stream_translator.internal_type"></a><span class="identifier">internal_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">E</span> <a name="boost.property_tree.stream_translator.external_type"></a><span class="identifier">external_type</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="stream_translator.html#boost.property_tree.stream_translatorconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="keyword">explicit</span> <a class="link" href="stream_translator.html#id782295-bb"><span class="identifier">stream_translator</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="stream_translator.html#id782264-bb">public member functions</a></span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><</span> <span class="identifier">E</span> <span class="special">></span> <a class="link" href="stream_translator.html#id782267-bb"><span class="identifier">get_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">internal_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><</span> <span class="identifier">internal_type</span> <span class="special">></span> <a class="link" href="stream_translator.html#id782281-bb"><span class="identifier">put_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">E</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2570545"></a><h2>Description</h2> +<div class="refsect2"> +<a name="id2570548"></a><h3> +<a name="boost.property_tree.stream_translatorconstruct-copy-destruct"></a><code class="computeroutput">stream_translator</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="id782295-bb"></a><span class="identifier">stream_translator</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> loc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> +</div> +<div class="refsect2"> +<a name="id2570645"></a><h3> +<a name="id782264-bb"></a><code class="computeroutput">stream_translator</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"><pre class="literallayout"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><</span> <span class="identifier">E</span> <span class="special">></span> <a name="id782267-bb"></a><span class="identifier">get_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">internal_type</span> <span class="special">&</span> v<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><</span> <span class="identifier">internal_type</span> <span class="special">></span> <a name="id782281-bb"></a><span class="identifier">put_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">E</span> <span class="special">&</span> v<span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="customize_stream_Ch__Tr_id1140694.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="translator_between_std__id782306.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/string_path.html b/doc/html/boost/property_tree/string_path.html new file mode 100755 index 0000000000..329973e33b --- /dev/null +++ b/doc/html/boost/property_tree/string_path.html @@ -0,0 +1,197 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class template string_path</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.string_path_hpp" title="Header <boost/property_tree/string_path.hpp>"> +<link rel="prev" href="translator_between_std__id782306.html" title="Struct template translator_between<std::basic_string< Ch, Traits, Alloc >, E>"> +<link rel="next" href="path_of_std_basic_strin_id782647.html" title="Struct template path_of<std::basic_string< Ch, Traits, Alloc >>"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="translator_between_std__id782306.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.string_path_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="path_of_std_basic_strin_id782647.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.string_path"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template string_path</span></h2> +<p>boost::property_tree::string_path — Default path class. A path is a sequence of values. Groups of values are separated by the separator value, which defaults to '.' cast to the sequence's value type. The group of values is then passed to the translator to get a key. </p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.string_path_hpp" title="Header <boost/property_tree/string_path.hpp>">boost/property_tree/string_path.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> String<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span> +<span class="keyword">class</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">Translator</span><span class="special">::</span><span class="identifier">external_type</span> <a name="boost.property_tree.string_path.key_type"></a><span class="identifier">key_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">String</span><span class="special">::</span><span class="identifier">value_type</span> <a name="boost.property_tree.string_path.char_type"></a><span class="identifier">char_type</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="string_path.html#boost.property_tree.string_pathconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="keyword">explicit</span> <a class="link" href="string_path.html#id782525-bb"><span class="identifier">string_path</span></a><span class="special">(</span><span class="identifier">char_type</span> <span class="special">=</span> <span class="identifier">char_type</span><span class="special">(</span><span class="char">'.'</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="string_path.html#id782539-bb"><span class="identifier">string_path</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">String</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">char_type</span> <span class="special">=</span> <span class="identifier">char_type</span><span class="special">(</span><span class="char">'.'</span><span class="special">)</span><span class="special">,</span> + <span class="identifier">Translator</span> <span class="special">=</span> <span class="identifier">Translator</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="string_path.html#id782582-bb"><span class="identifier">string_path</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">char_type</span> <span class="special">=</span> <span class="identifier">char_type</span><span class="special">(</span><span class="char">'.'</span><span class="special">)</span><span class="special">,</span> + <span class="identifier">Translator</span> <span class="special">=</span> <span class="identifier">Translator</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="string_path.html#id782626-bb"><span class="identifier">string_path</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + string_path& <a class="link" href="string_path.html#id782636-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="string_path.html#id782416-bb">private member functions</a></span> + <a class="link" href="string_path.html#id782420-bb"><span class="identifier">BOOST_STATIC_ASSERT</span></a><span class="special">(</span><span class="special">(</span><span class="identifier">is_same</span><span class="special"><</span> <span class="identifier">String</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">::</span><span class="identifier">internal_type</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">s_c_iter</span> <a class="link" href="string_path.html#id782433-bb"><span class="identifier">cstart</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="string_path.html#id782440-bb">public member functions</a></span> + <span class="identifier">key_type</span> <a class="link" href="string_path.html#id782444-bb"><span class="identifier">reduce</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="string_path.html#id782455-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="string_path.html#id782465-bb"><span class="identifier">single</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">char_type</span> <a class="link" href="string_path.html#id782476-bb"><span class="identifier">separator</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="string_path.html#id782487-bb"><span class="identifier">dump</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">&</span> <a class="link" href="string_path.html#id782495-bb"><span class="keyword">operator</span><span class="special">/=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2572757"></a><h2>Description</h2> +<p>If instantiated with std::string and <a class="link" href="id_translator.html" title="Struct template id_translator">id_translator</a><std::string>, it accepts paths of the form "one.two.three.four".</p> +<p> +</p> +<div class="refsect2"> +<a name="id2572777"></a><h3>Template Parameters</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">typename</span> String</pre> +<p>Any Sequence. If the sequence does not support random- access iteration, concatenation of paths assumes that insertions at the end preserve iterator validity. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">typename</span> Translator</pre> +<p>A translator with internal_type == String. </p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id2572821"></a><h3> +<a name="boost.property_tree.string_pathconstruct-copy-destruct"></a><code class="computeroutput">string_path</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="id782525-bb"></a><span class="identifier">string_path</span><span class="special">(</span><span class="identifier">char_type</span> separator <span class="special">=</span> <span class="identifier">char_type</span><span class="special">(</span><span class="char">'.'</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>Create an empty path. </li> +<li class="listitem"> +<pre class="literallayout"><a name="id782539-bb"></a><span class="identifier">string_path</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">String</span> <span class="special">&</span> value<span class="special">,</span> <span class="identifier">char_type</span> separator <span class="special">=</span> <span class="identifier">char_type</span><span class="special">(</span><span class="char">'.'</span><span class="special">)</span><span class="special">,</span> + <span class="identifier">Translator</span> tr <span class="special">=</span> <span class="identifier">Translator</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>Create a path by parsing the given string. <p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">separator</code></span></p></td> +<td><p>The separator used in parsing. Defaults to '.'. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">tr</code></span></p></td> +<td><p>The translator used by this path to convert the individual parts to keys. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">value</code></span></p></td> +<td><p>A sequence, possibly with separators, that describes the path, e.g. "one.two.three". </p></td> +</tr> +</tbody> +</table></div></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="id782582-bb"></a><span class="identifier">string_path</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span> value<span class="special">,</span> <span class="identifier">char_type</span> separator <span class="special">=</span> <span class="identifier">char_type</span><span class="special">(</span><span class="char">'.'</span><span class="special">)</span><span class="special">,</span> + <span class="identifier">Translator</span> tr <span class="special">=</span> <span class="identifier">Translator</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>Create a path by parsing the given string. <p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">separator</code></span></p></td> +<td><p>The separator used in parsing. Defaults to '.'. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">tr</code></span></p></td> +<td><p>The translator used by this path to convert the individual parts to keys. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">value</code></span></p></td> +<td><p>A zero-terminated array of values. Only use if zero- termination makes sense for your type, and your sequence supports construction from it. Intended for string literals. </p></td> +</tr> +</tbody> +</table></div></td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"><pre class="literallayout"><a name="id782626-bb"></a><span class="identifier">string_path</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">&</span> o<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout">string_path& <a name="id782636-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">&</span> o<span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id2573331"></a><h3> +<a name="id782416-bb"></a><code class="computeroutput">string_path</code> private member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"><pre class="literallayout"> <a name="id782420-bb"></a><span class="identifier">BOOST_STATIC_ASSERT</span><span class="special">(</span><span class="special">(</span><span class="identifier">is_same</span><span class="special"><</span> <span class="identifier">String</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">::</span><span class="identifier">internal_type</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">s_c_iter</span> <a name="id782433-bb"></a><span class="identifier">cstart</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id2573481"></a><h3> +<a name="id782440-bb"></a><code class="computeroutput">string_path</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">key_type</span> <a name="id782444-bb"></a><span class="identifier">reduce</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Take a single element off the path at the front and return it. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="id782455-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Test if the path is empty. </li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="id782465-bb"></a><span class="identifier">single</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Test if the path contains a single element, i.e. no separators. </li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">char_type</span> <a name="id782476-bb"></a><span class="identifier">separator</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get the separator used by this path. </li> +<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id782487-bb"></a><span class="identifier">dump</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">&</span> <a name="id782495-bb"></a><span class="keyword">operator</span><span class="special">/=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">&</span> o<span class="special">)</span><span class="special">;</span></pre>Append a second path to this one. <p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Requires:</span></p></td> +<td><p>o's separator is the same as this one's, or o has no separators </p></td> +</tr></tbody> +</table></div> +</li> +</ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="translator_between_std__id782306.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.string_path_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="path_of_std_basic_strin_id782647.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/swap_id783350.html b/doc/html/boost/property_tree/swap_id783350.html new file mode 100755 index 0000000000..1a715560b2 --- /dev/null +++ b/doc/html/boost/property_tree/swap_id783350.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template swap</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp" title="Header <boost/property_tree/ptree_fwd.hpp>"> +<link rel="prev" href="wiptree.html" title="Type definition wiptree"> +<link rel="next" href="save.html" title="Function template save"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="wiptree.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="save.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.swap_id783350"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template swap</span></h2> +<p>boost::property_tree::swap</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp" title="Header <boost/property_tree/ptree_fwd.hpp>">boost/property_tree/ptree_fwd.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> K<span class="special">,</span> <span class="keyword">typename</span> D<span class="special">,</span> <span class="keyword">typename</span> C<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_ptree.html" title="Class template basic_ptree">basic_ptree</a><span class="special"><</span> <span class="identifier">K</span><span class="special">,</span> <span class="identifier">D</span><span class="special">,</span> <span class="identifier">C</span> <span class="special">></span> <span class="special">&</span> pt1<span class="special">,</span> <a class="link" href="basic_ptree.html" title="Class template basic_ptree">basic_ptree</a><span class="special"><</span> <span class="identifier">K</span><span class="special">,</span> <span class="identifier">D</span><span class="special">,</span> <span class="identifier">C</span> <span class="special">></span> <span class="special">&</span> pt2<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2564012"></a><h2>Description</h2> +<p>Swap two property tree instances. </p> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="wiptree.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="save.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/translator_between_T__T_id1160186.html b/doc/html/boost/property_tree/translator_between_T__T_id1160186.html new file mode 100755 index 0000000000..f0702b3353 --- /dev/null +++ b/doc/html/boost/property_tree/translator_between_T__T_id1160186.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct template translator_between<T, T></title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.id_translator_hpp" title="Header <boost/property_tree/id_translator.hpp>"> +<link rel="prev" href="id_translator.html" title="Struct template id_translator"> +<link rel="next" href="translator_between_std__id1160010.html" title="Struct template translator_between<std::basic_string< Ch, Traits, Alloc >, std::basic_string< Ch, Traits, Alloc >>"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="id_translator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.id_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="translator_between_std__id1160010.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.translator_between_T,_T_id1160186"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template translator_between<T, T></span></h2> +<p>boost::property_tree::translator_between<T, T></p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.id_translator_hpp" title="Header <boost/property_tree/id_translator.hpp>">boost/property_tree/id_translator.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="translator_between_T__T_id1160186.html" title="Struct template translator_between<T, T>">translator_between</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">T</span><span class="special">></span> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="id_translator.html" title="Struct template id_translator">id_translator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <a name="boost.property_tree.translator_between_T,_T_id1160186.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="id_translator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.id_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="translator_between_std__id1160010.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/translator_between_std__id1160010.html b/doc/html/boost/property_tree/translator_between_std__id1160010.html new file mode 100755 index 0000000000..445076f203 --- /dev/null +++ b/doc/html/boost/property_tree/translator_between_std__id1160010.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct template translator_between<std::basic_string< Ch, Traits, Alloc >, std::basic_string< Ch, Traits, Alloc >></title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.id_translator_hpp" title="Header <boost/property_tree/id_translator.hpp>"> +<link rel="prev" href="translator_between_T__T_id1160186.html" title="Struct template translator_between<T, T>"> +<link rel="next" href="info_parser/read_info_id1160062.html" title="Function template read_info"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="translator_between_T__T_id1160186.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.id_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="info_parser/read_info_id1160062.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.translator_between_std__id1160010"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template translator_between<std::basic_string< Ch, Traits, Alloc >, std::basic_string< Ch, Traits, Alloc >></span></h2> +<p>boost::property_tree::translator_between<std::basic_string< Ch, Traits, Alloc >, std::basic_string< Ch, Traits, Alloc >></p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.id_translator_hpp" title="Header <boost/property_tree/id_translator.hpp>">boost/property_tree/id_translator.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="translator_between_std__id1160010.html" title="Struct template translator_between<std::basic_string< Ch, Traits, Alloc >, std::basic_string< Ch, Traits, Alloc >>">translator_between</a><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span><span class="special">></span> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="id_translator.html" title="Struct template id_translator">id_translator</a><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">></span> <a name="boost.property_tree.translator_between_std__id1160010.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="translator_between_T__T_id1160186.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.id_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="info_parser/read_info_id1160062.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/translator_between_std__id782306.html b/doc/html/boost/property_tree/translator_between_std__id782306.html new file mode 100755 index 0000000000..d48db39294 --- /dev/null +++ b/doc/html/boost/property_tree/translator_between_std__id782306.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct template translator_between<std::basic_string< Ch, Traits, Alloc >, E></title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp" title="Header <boost/property_tree/stream_translator.hpp>"> +<link rel="prev" href="stream_translator.html" title="Class template stream_translator"> +<link rel="next" href="string_path.html" title="Class template string_path"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="stream_translator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="string_path.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.translator_between_std__id782306"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template translator_between<std::basic_string< Ch, Traits, Alloc >, E></span></h2> +<p>boost::property_tree::translator_between<std::basic_string< Ch, Traits, Alloc >, E></p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp" title="Header <boost/property_tree/stream_translator.hpp>">boost/property_tree/stream_translator.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">,</span> <span class="keyword">typename</span> E<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="translator_between_std__id782306.html" title="Struct template translator_between<std::basic_string< Ch, Traits, Alloc >, E>">translator_between</a><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span><span class="special">,</span> <span class="identifier">E</span><span class="special">></span> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="stream_translator.html" title="Class template stream_translator">stream_translator</a><span class="special"><</span> <span class="identifier">Ch</span><span class="special">,</span> <span class="identifier">Traits</span><span class="special">,</span> <span class="identifier">Alloc</span><span class="special">,</span> <span class="identifier">E</span> <span class="special">></span> <a name="boost.property_tree.translator_between_std__id782306.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="stream_translator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.stream_translator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="string_path.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/wiptree.html b/doc/html/boost/property_tree/wiptree.html new file mode 100755 index 0000000000..dd6e6d1289 --- /dev/null +++ b/doc/html/boost/property_tree/wiptree.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Type definition wiptree</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp" title="Header <boost/property_tree/ptree_fwd.hpp>"> +<link rel="prev" href="wptree.html" title="Type definition wptree"> +<link rel="next" href="swap_id783350.html" title="Function template swap"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="wptree.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="swap_id783350.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.wiptree"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Type definition wiptree</span></h2> +<p>wiptree</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp" title="Header <boost/property_tree/ptree_fwd.hpp>">boost/property_tree/ptree_fwd.hpp</a>> + +</span> +<span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="identifier">wiptree</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2563793"></a><h2>Description</h2> +<p>A property tree with std::wstring for key and data, and case-insensitive comparison. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>The type only exists if the platform supports <code class="computeroutput">wchar_t</code>. </p></td></tr> +</table></div> +<p> +</p> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="wptree.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="swap_id783350.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/wpath.html b/doc/html/boost/property_tree/wpath.html new file mode 100755 index 0000000000..9ce3394c72 --- /dev/null +++ b/doc/html/boost/property_tree/wpath.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Type definition wpath</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp" title="Header <boost/property_tree/ptree_fwd.hpp>"> +<link rel="prev" href="iptree.html" title="Type definition iptree"> +<link rel="next" href="wptree.html" title="Type definition wptree"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="iptree.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="wptree.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.wpath"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Type definition wpath</span></h2> +<p>wpath</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp" title="Header <boost/property_tree/ptree_fwd.hpp>">boost/property_tree/ptree_fwd.hpp</a>> + +</span> +<span class="keyword">typedef</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span><span class="special">,</span> <a class="link" href="id_translator.html" title="Struct template id_translator">id_translator</a><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span> <span class="special">></span> <span class="special">></span> <span class="identifier">wpath</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2563616"></a><h2>Description</h2> +<p>Implements a path using a std::wstring as the key. </p> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="iptree.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="wptree.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/wptree.html b/doc/html/boost/property_tree/wptree.html new file mode 100755 index 0000000000..e1ccb3ef2d --- /dev/null +++ b/doc/html/boost/property_tree/wptree.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Type definition wptree</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp" title="Header <boost/property_tree/ptree_fwd.hpp>"> +<link rel="prev" href="wpath.html" title="Type definition wpath"> +<link rel="next" href="wiptree.html" title="Type definition wiptree"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="wpath.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="wiptree.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.wptree"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Type definition wptree</span></h2> +<p>wptree</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp" title="Header <boost/property_tree/ptree_fwd.hpp>">boost/property_tree/ptree_fwd.hpp</a>> + +</span> +<span class="keyword">typedef</span> <a class="link" href="basic_ptree.html" title="Class template basic_ptree">basic_ptree</a><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span> <span class="special">></span> <span class="identifier">wptree</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2563721"></a><h2>Description</h2> +<p>A property tree with std::wstring for key and data, and default comparison. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>The type only exists if the platform supports <code class="computeroutput">wchar_t</code>. </p></td></tr> +</table></div> +<p> +</p> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="wpath.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_fwd_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="wiptree.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/xml_parser/read_xml_id1145781.html b/doc/html/boost/property_tree/xml_parser/read_xml_id1145781.html new file mode 100755 index 0000000000..988054779a --- /dev/null +++ b/doc/html/boost/property_tree/xml_parser/read_xml_id1145781.html @@ -0,0 +1,108 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template read_xml</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.xml_parser_hpp" title="Header <boost/property_tree/xml_parser.hpp>"> +<link rel="prev" href="../path_of_std_basic_strin_id782647.html" title="Struct template path_of<std::basic_string< Ch, Traits, Alloc >>"> +<link rel="next" href="read_xml_id1145883.html" title="Function template read_xml"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../path_of_std_basic_strin_id782647.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.xml_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_xml_id1145883.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.xml_parser.read_xml_id1145781"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template read_xml</span></h2> +<p>boost::property_tree::xml_parser::read_xml</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.xml_parser_hpp" title="Header <boost/property_tree/xml_parser.hpp>">boost/property_tree/xml_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">read_xml</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Ptree</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">></span> <span class="special">&</span> stream<span class="special">,</span> + <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">,</span> <span class="keyword">int</span> flags <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2575203"></a><h2>Description</h2> +<p>Reads XML from an input stream and translates it to property tree. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"> +<p>Clears existing contents of property tree. In case of error the property tree unmodified. </p> +<p>XML attributes are placed under keys named <code class="computeroutput"><xmlattr></code>. </p> +</td></tr> +</table></div> +<p> + + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">flags</code></span></p></td> +<td> +<p>Flags controlling the behaviour of the parser. The following flags are supported: </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"><p><code class="computeroutput">no_concat_text</code> -- Prevents concatenation of text nodes into datastring of property tree. Puts them in separate <code class="computeroutput"><xmltext></code> strings instead. </p></li> +<li class="listitem"><p><code class="computeroutput">no_comments</code> -- Skip XML comments. </p></li> +<li class="listitem"><p><code class="computeroutput">trim_whitespace</code> -- Trim leading and trailing whitespace from text, and collapse sequences of whitespace. </p></li> +</ul></div> +<p> +</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">pt</code></span></p></td> +<td><p>The property tree to populate. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">stream</code></span></p></td> +<td><p>Stream from which to read in the property tree. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>xml_parser_error In case of error deserializing the property tree. </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../path_of_std_basic_strin_id782647.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.xml_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_xml_id1145883.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/xml_parser/read_xml_id1145883.html b/doc/html/boost/property_tree/xml_parser/read_xml_id1145883.html new file mode 100755 index 0000000000..e651bda098 --- /dev/null +++ b/doc/html/boost/property_tree/xml_parser/read_xml_id1145883.html @@ -0,0 +1,111 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template read_xml</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.xml_parser_hpp" title="Header <boost/property_tree/xml_parser.hpp>"> +<link rel="prev" href="read_xml_id1145781.html" title="Function template read_xml"> +<link rel="next" href="write_xml_id1154593.html" title="Function template write_xml"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_xml_id1145781.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.xml_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_xml_id1154593.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.xml_parser.read_xml_id1145883"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template read_xml</span></h2> +<p>boost::property_tree::xml_parser::read_xml</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.xml_parser_hpp" title="Header <boost/property_tree/xml_parser.hpp>">boost/property_tree/xml_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">read_xml</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> filename<span class="special">,</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">,</span> <span class="keyword">int</span> flags <span class="special">=</span> <span class="number">0</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="special">&</span> loc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2575519"></a><h2>Description</h2> +<p>Reads XML from a file using the given locale and translates it to property tree. </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"> +<p>Clears existing contents of property tree. In case of error the property tree unmodified. </p> +<p>XML attributes are placed under keys named <code class="computeroutput"><xmlattr></code>. </p> +</td></tr> +</table></div> +<p> + + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">filename</code></span></p></td> +<td><p>The file from which to read in the property tree. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">flags</code></span></p></td> +<td> +<p>Flags controlling the bahviour of the parser. The following flags are supported: </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"><p><code class="computeroutput">no_concat_text</code> -- Prevents concatenation of text nodes into datastring of property tree. Puts them in separate <code class="computeroutput"><xmltext></code> strings instead. </p></li> +<li class="listitem"><p><code class="computeroutput">no_comments</code> -- Skip XML comments. </p></li> +</ul></div> +<p> +</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">loc</code></span></p></td> +<td><p>The locale to use when reading in the file contents. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">pt</code></span></p></td> +<td><p>The property tree to populate. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>xml_parser_error In case of error deserializing the property tree. </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_xml_id1145781.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.xml_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_xml_id1154593.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/xml_parser/write_xml_id1154593.html b/doc/html/boost/property_tree/xml_parser/write_xml_id1154593.html new file mode 100755 index 0000000000..3fc634194a --- /dev/null +++ b/doc/html/boost/property_tree/xml_parser/write_xml_id1154593.html @@ -0,0 +1,88 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template write_xml</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.xml_parser_hpp" title="Header <boost/property_tree/xml_parser.hpp>"> +<link rel="prev" href="read_xml_id1145883.html" title="Function template read_xml"> +<link rel="next" href="write_xml_id1154652.html" title="Function template write_xml"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_xml_id1145883.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.xml_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_xml_id1154652.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.xml_parser.write_xml_id1154593"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template write_xml</span></h2> +<p>boost::property_tree::xml_parser::write_xml</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.xml_parser_hpp" title="Header <boost/property_tree/xml_parser.hpp>">boost/property_tree/xml_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">write_xml</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Ptree</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">></span> <span class="special">&</span> stream<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">xml_writer_settings</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Ptree</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">></span> <span class="special">&</span> settings <span class="special">=</span> <span class="identifier">xml_writer_settings</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Ptree</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">></span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2575915"></a><h2>Description</h2> +<p>Translates the property tree to XML and writes it the given output stream. + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">pt</code></span></p></td> +<td><p>The property tree to tranlsate to XML and output. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">settings</code></span></p></td> +<td><p>The settings to use when writing out the property tree as XML. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">stream</code></span></p></td> +<td><p>The stream to which to write the XML representation of the property tree. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>xml_parser_error In case of error translating the property tree to XML or writing to the output stream. </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="read_xml_id1145883.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.xml_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_xml_id1154652.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/property_tree/xml_parser/write_xml_id1154652.html b/doc/html/boost/property_tree/xml_parser/write_xml_id1154652.html new file mode 100755 index 0000000000..af778f6e90 --- /dev/null +++ b/doc/html/boost/property_tree/xml_parser/write_xml_id1154652.html @@ -0,0 +1,92 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template write_xml</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.xml_parser_hpp" title="Header <boost/property_tree/xml_parser.hpp>"> +<link rel="prev" href="write_xml_id1154593.html" title="Function template write_xml"> +<link rel="next" href="../../../proto.html" title="Chapter 20. Boost.Proto"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="write_xml_id1154593.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.xml_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../../proto.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.xml_parser.write_xml_id1154652"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template write_xml</span></h2> +<p>boost::property_tree::xml_parser::write_xml</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.xml_parser_hpp" title="Header <boost/property_tree/xml_parser.hpp>">boost/property_tree/xml_parser.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">></span> + <span class="keyword">void</span> <span class="identifier">write_xml</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> filename<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="special">&</span> loc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">xml_writer_settings</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Ptree</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">></span> <span class="special">&</span> settings <span class="special">=</span> <span class="identifier">xml_writer_settings</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Ptree</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">></span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2576282"></a><h2>Description</h2> +<p>Translates the property tree to XML and writes it the given file. + +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">filename</code></span></p></td> +<td><p>The file to which to write the XML representation of the property tree. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">loc</code></span></p></td> +<td><p>The locale to use when writing the output to file. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">pt</code></span></p></td> +<td><p>The property tree to tranlsate to XML and output. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">settings</code></span></p></td> +<td><p>The settings to use when writing out the property tree as XML. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>xml_parser_error In case of error translating the property tree to XML or writing to the output stream. </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="write_xml_id1154593.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.xml_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../../proto.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |