Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r56258 - in sandbox/explore/libs/explore/doc: . html html/boost_explore html/boost_explore/tutorial
From: jmcintyre_at_[hidden]
Date: 2009-09-16 23:37:00

Next message: hartmut.kaiser_at_[hidden]: "[Boost-commit] svn:boost r56259 - in trunk/boost/spirit/home: qi/char support"
Previous message: hartmut.kaiser_at_[hidden]: "[Boost-commit] svn:boost r56257 - trunk/boost/spirit/home/qi/char"

Author: jared
Date: 2009-09-16 23:36:59 EDT (Wed, 16 Sep 2009)
New Revision: 56258
URL: http://svn.boost.org/trac/boost/changeset/56258

Log:
Explore - Update documentation

Text files modified:
   sandbox/explore/libs/explore/doc/custom_delimeters.qbk | 34 +++++
   sandbox/explore/libs/explore/doc/dependencies_platforms.qbk | 2
   sandbox/explore/libs/explore/doc/explore.qbk | 3
   sandbox/explore/libs/explore/doc/html/boost_explore/dependencies_platforms.html | 32 +++---
   sandbox/explore/libs/explore/doc/html/boost_explore/design.html | 22 ++--
   sandbox/explore/libs/explore/doc/html/boost_explore/tutorial.html | 64 +++++-------
   sandbox/explore/libs/explore/doc/html/boost_explore/tutorial/custom_containers.html | 85 +++++++++++-----
   sandbox/explore/libs/explore/doc/html/boost_explore/tutorial/custom_delimeters.html | 208 +++++++++++++++++++++++++++++++++++----
   sandbox/explore/libs/explore/doc/html/index.html | 52 ++++-----
   9 files changed, 350 insertions(+), 152 deletions(-)

Modified: sandbox/explore/libs/explore/doc/custom_delimeters.qbk
==============================================================================
--- sandbox/explore/libs/explore/doc/custom_delimeters.qbk (original)
+++ sandbox/explore/libs/explore/doc/custom_delimeters.qbk 2009-09-16 23:36:59 EDT (Wed, 16 Sep 2009)
@@ -9,9 +9,6 @@

Explore provides the ability to change the strings used in the container streaming process through the use of several new stream manipulators.

-TODO: deal with wchar_t
-TODO: deal with sticky value getters (get_start)
-
[table Explore Stream Manipulators
 [[Manipulator] [Default][Description]]
 [[start(char*)] ['\['] [Changes the string output at the beginning of a container.]]
@@ -20,10 +17,13 @@
 [[assoc_item_start(char*)] [''] [Changes the string output at the front of an association item.]]
 [[assoc_item_end(char*)] [''] [Changes the string output at the end of an association item.]]
 [[assoc_item_seperator(char*)] [':'] [Changes the string output in between elements of an association item.]]
- [[rows] [???] [???]]
- [[item_wdth] [???] [???]]
+ [[rows(size_t)] [???] [???]]
+ [[item_wdth(size_t)] [???] [???]]
]

+[important There are both char* and wchar_t* versions of all string manipulator functions. However, you can only use char manipulators with ostreams and
+wchar_t manipulators with wostreams. Using the wrong type with the wrong stream will cause a compile error.]
+
For example, to change the beginning and end output of a container to be the greater and less than symbols, you would do the following.

 std::vector<int> vi;
@@ -35,6 +35,22 @@
prints

 <1, 2, 3>
+
+[heading Manipulator Helper Functions]
+
+There are several helper functions that will set multiple manipulators with one call.
+
+[table Explore Stream Manipulator Helpers
+ [[Manipulator] [Description]]
+ [[begin_end(char* begin, char* end)] [Changes the string output of the beginning and end of a container.]]
+ [[delimeters(char* begin, char* separator, char* end)] [Changes the string output of the beginning, eseparator, and end of a container.]]
+ [[assoc_item_begin_end(char* begin, char* end)] [Changes the string output of the beginning and end of an association item.]]
+ [[assoc_item_delimeters(char* begin, char* separator, char* end)] [Changes the string output of the beginning, eseparator, and end of an association item.]]
+]
+
+The previous code could have been written
+
+ std::cout << explore::begin_end("<", ">") << vi;

[heading Delimeters by Level]

@@ -82,5 +98,13 @@
 << separator("\n <li>")
 << end("\n</ul>");
 }
+
+[heading Item Width]
+
+TODO: finish this section
+
+[heading Retrieving Manipulator Values]
+
+TODO: finish this section

[endsect]

Modified: sandbox/explore/libs/explore/doc/dependencies_platforms.qbk
==============================================================================
--- sandbox/explore/libs/explore/doc/dependencies_platforms.qbk (original)
+++ sandbox/explore/libs/explore/doc/dependencies_platforms.qbk 2009-09-16 23:36:59 EDT (Wed, 16 Sep 2009)
@@ -23,6 +23,6 @@

* g++-4.0 Linux
* vc7.1, 8.0 WinXp
-
+ * darwin-4.0.1 MacOS X 10.5 (PPC and Intel)

[endsect]

Modified: sandbox/explore/libs/explore/doc/explore.qbk
==============================================================================
--- sandbox/explore/libs/explore/doc/explore.qbk (original)
+++ sandbox/explore/libs/explore/doc/explore.qbk 2009-09-16 23:36:59 EDT (Wed, 16 Sep 2009)
@@ -7,7 +7,7 @@

[library Boost.explore
     [quickbook 1.4]
- [copyright 2007 Jeff Garland, 2008 Jared McIntyre]
+ [copyright 2007 Jeff Garland, 2008-2009 Jared McIntyre]
     [purpose Library to output Collections]
     [license
         Distributed under the Boost Software License, Version 1.0.
@@ -88,7 +88,6 @@
* std::vector
* boost::array
* boost::range
-* boost::tuple

[link boost_explore.tutorial.custom_containers Custom containers] can also be made to work with explore.

Modified: sandbox/explore/libs/explore/doc/html/boost_explore/dependencies_platforms.html
==============================================================================
--- sandbox/explore/libs/explore/doc/html/boost_explore/dependencies_platforms.html (original)
+++ sandbox/explore/libs/explore/doc/html/boost_explore/dependencies_platforms.html 2009-09-16 23:36:59 EDT (Wed, 16 Sep 2009)
@@ -3,8 +3,8 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Dependencies and Platforms</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<link rel="start" href="../index.html" title="Boost.explore">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Boost.explore">
<link rel="up" href="../index.html" title="Boost.explore">
<link rel="prev" href="tutorial/custom_containers.html" title="Custom Containers">
<link rel="next" href="design.html" title="Design Notes">
@@ -14,59 +14,59 @@
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="tutorial/custom_containers.html"><img src="../../../../../doc/html/images/%20prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/%20up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/%20home.png" alt="Home"></a><a accesskey="n" href="design.html"><img src="../../../../../doc/html/images/%20next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section" title="Dependencies and Platforms">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_explore.dependencies_platforms"></a><a class="link" href="dependencies_platforms.html" title="Dependencies and Platforms"> Dependencies and
 Platforms</a>
</h2></div></div></div>
<a name="boost_explore.dependencies_platforms.dependencies"></a><h3>
-<a name="id535576"></a>
+<a name="id558213"></a>
 <a class="link" href="dependencies_platforms.html#boost_explore.dependencies_platforms.dependencies">Dependencies</a>
 </h3>

 The following libraries must be available in order to use Boost.explore
 
-<div class="itemizedlist"><ul type="disc">
-<li>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
 mpl - various meta programming tools
 </li>
-<li>
+<li class="listitem">
 utility - for enable_if
 </li>
-<li>
+<li class="listitem">
 foreach
 </li>
-<li>
+<li class="listitem">
 range - for range iterator
 </li>
-<li>
+<li class="listitem">
 parameter (tbd in future for parameter based interface)
 </li>
</ul></div>
<a name="boost_explore.dependencies_platforms.supported_platforms"></a><h3>
-<a name="id535623"></a>
+<a name="id558260"></a>
 <a class="link" href="dependencies_platforms.html#boost_explore.dependencies_platforms.supported_platforms">Supported
 Platforms</a>
 </h3>

 The following platforms and compilers have been tested:
 
-<pre class="programlisting">
-* g++-4.0 Linux
+<pre class="programlisting">* g++-4.0 Linux
* vc7.1, 8.0 WinXp
+* darwin-4.0.1 MacOS X 10.5 (PPC and Intel)
</pre>
</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 © 2007 Jeff Garland, 2008 Jared McIntyre
+<td align="right"><div class="copyright-footer">Copyright © 2007 Jeff Garland, 2008-2009 Jared McIntyre
 Distributed under the Boost Software License, Version 1.0. (See accompanying
 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

Modified: sandbox/explore/libs/explore/doc/html/boost_explore/design.html
==============================================================================
--- sandbox/explore/libs/explore/doc/html/boost_explore/design.html (original)
+++ sandbox/explore/libs/explore/doc/html/boost_explore/design.html 2009-09-16 23:36:59 EDT (Wed, 16 Sep 2009)
@@ -3,8 +3,8 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Design Notes</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<link rel="start" href="../index.html" title="Boost.explore">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Boost.explore">
<link rel="up" href="../index.html" title="Boost.explore">
<link rel="prev" href="dependencies_platforms.html" title="Dependencies and Platforms">
</head>
@@ -13,20 +13,20 @@
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="dependencies_platforms.html"><img src="../../../../../doc/html/images/%20prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/%20up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/%20home.png" alt="Home"></a>
</div>
-<div class="section" lang="en">
+<div class="section" title="Design Notes">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_explore.design"></a><a class="link" href="design.html" title="Design Notes"> Design Notes</a>
</h2></div></div></div>
<a name="boost_explore.design.rationale"></a><h3>
-<a name="id535715"></a>
+<a name="id558416"></a>
 <a class="link" href="design.html#boost_explore.design.rationale">Rationale</a>
 </h3>

@@ -34,18 +34,18 @@
 cases it may prove sufficiently capable to provide output good enough for other
 applications.
 
-<div class="itemizedlist"><ul type="disc">
-<li>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
Ease of use. The interfaces to the library
 should be as simple as possible reflecting good defaults while allowing more
 sophisticated options with a small amount of customization.
 </li>
-<li>
+<li class="listitem">
Support user defined types. Since collections
 can support user defined types explore should be capable of printing containers
 with thoes types.
 </li>
-<li>
+<li class="listitem">
Portability. The library should work with
 a variety of compilers and platforms.
 </li>
@@ -53,7 +53,7 @@
</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 © 2007 Jeff Garland, 2008 Jared McIntyre
+<td align="right"><div class="copyright-footer">Copyright © 2007 Jeff Garland, 2008-2009 Jared McIntyre
 Distributed under the Boost Software License, Version 1.0. (See accompanying
 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

Modified: sandbox/explore/libs/explore/doc/html/boost_explore/tutorial.html
==============================================================================
--- sandbox/explore/libs/explore/doc/html/boost_explore/tutorial.html (original)
+++ sandbox/explore/libs/explore/doc/html/boost_explore/tutorial.html 2009-09-16 23:36:59 EDT (Wed, 16 Sep 2009)
@@ -3,8 +3,8 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Tutorial</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<link rel="start" href="../index.html" title="Boost.explore">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Boost.explore">
<link rel="up" href="../index.html" title="Boost.explore">
<link rel="prev" href="../index.html" title="Boost.explore">
<link rel="next" href="tutorial/custom_delimeters.html" title="Custom Delimiters">
@@ -14,15 +14,15 @@
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../index.html"><img src="../../../../../doc/html/images/%20prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/%20up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/%20home.png" alt="Home"></a><a accesskey="n" href="tutorial/custom_delimeters.html"><img src="../../../../../doc/html/images/%20next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section" title="Tutorial">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_explore.tutorial"></a><a class="link" href="tutorial.html" title="Tutorial"> Tutorial</a>
</h2></div></div></div>
@@ -34,19 +34,18 @@
</dl>
</div>
<a name="boost_explore.tutorial.basic_container_printing"></a><h4>
-<a name="id532304"></a>
+<a name="id553958"></a>
 <a class="link" href="tutorial.html#boost_explore.tutorial.basic_container_printing">Basic Container
 Printing</a>
 </h4>

 All of the explore library can be used by simply including the <code class="computeroutput">"explore.hpp"</code> header file.
 
-<pre class="programlisting">
-#include <boost/explore.hpp>
+<pre class="programlisting">#include <boost/explore.hpp>
using namespace boost::explore;
</pre>
<a name="boost_explore.tutorial.printing_of_contained_items"></a><h4>
-<a name="id532400"></a>
+<a name="id554053"></a>
 <a class="link" href="tutorial.html#boost_explore.tutorial.printing_of_contained_items">Printing
 of Contained Items</a>
 </h4>
@@ -54,8 +53,7 @@
 Basic printing of containers requires the inclusing of explore.hpp. Once included,
 containers can be be streamed in a formated manner.
 
-<pre class="programlisting">
-std::vector<int> vi;
+<pre class="programlisting">std::vector<int> vi;
vi.push_back(1);
vi.push_back(2);
vi.push_back(3);
@@ -64,8 +62,7 @@

 prints
 
-<pre class="programlisting">
-[1, 2, 3]
+<pre class="programlisting">[1, 2, 3]
</pre>

 The beginning of the container will be marked with a '[' and the end will be
@@ -77,8 +74,7 @@
 the same format for the parent, their children, their children's children,
 etc.
 
-<pre class="programlisting">
-std::vector<std::vector<int> > vvi;
+<pre class="programlisting">std::vector<std::vector<int> > vvi;
vvi.push_back(vi);
vvi.push_back(vi);
std::cout << vvi;
@@ -86,11 +82,10 @@

 prints
 
-<pre class="programlisting">
-[[1, 2, 3], [1, 2, 3]]
+<pre class="programlisting">[[1, 2, 3], [1, 2, 3]]
</pre>
<a name="boost_explore.tutorial.c_style_arrays"></a><h4>
-<a name="id532828"></a>
+<a name="id554477"></a>
 <a class="link" href="tutorial.html#boost_explore.tutorial.c_style_arrays">C Style Arrays</a>
 </h4>

@@ -98,26 +93,23 @@
 explore.hpp, you override this default streaming format with the explore streaming
 format and all the abilities of it.
 
-<pre class="programlisting">
-int arr[3] = {1,2,3};
+<pre class="programlisting">int arr[3] = {1,2,3};
std::cout << arr;
</pre>

 prints
 
-<pre class="programlisting">
-[1, 2, 3]
+<pre class="programlisting">[1, 2, 3]
</pre>
<a name="boost_explore.tutorial.associative_containers"></a><h4>
-<a name="id532980"></a>
+<a name="id554627"></a>
 <a class="link" href="tutorial.html#boost_explore.tutorial.associative_containers">Associative Containers</a>
 </h4>

 Associate containers are typically implemented using some form of pair-like
 container. So you might expect the following
 
-<pre class="programlisting">
-std::map<int,std::string> mis;
+<pre class="programlisting">std::map<int,std::string> mis;
mis.insert(std::make_pair(1, "first"));
mis.insert(std::make_pair(2, "second"));
mis.insert(std::make_pair(3, "third"));
@@ -126,25 +118,23 @@

 would print this way
 
-<pre class="programlisting">
-[[1, first], [2, second], [3, third]]
+<pre class="programlisting">[[1, first], [2, second], [3, third]]
</pre>

 But this format doesn't describe the associative nature of the elements well.
 So, explore uses special delimeters for the associations within associative
 containers, and the above code prints in a clearer format.
 
-<pre class="programlisting">
-[1:first, 2:second, 3:third]
+<pre class="programlisting">[1:first, 2:second, 3:third]
</pre>

 Currently, the only containers that explore recognizes as associative are:
 
-<div class="itemizedlist"><ul type="disc">
-<li>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
 std::map
 </li>
-<li>
+<li class="listitem">
 std::multimap
 </li>
</ul></div>
@@ -153,7 +143,7 @@
 can be handled as associative containers.
 
<a name="boost_explore.tutorial.lexical_cast"></a><h4>
-<a name="id533404"></a>
+<a name="id555048"></a>
 <a class="link" href="tutorial.html#boost_explore.tutorial.lexical_cast">lexical_cast</a>
 </h4>

@@ -161,8 +151,7 @@
 with the explore library to allow you to create strings with the printed output
 of explore for cases when you don't want to use streaming directly.
 
-<pre class="programlisting">
-std::vector<int> vi;
+<pre class="programlisting">std::vector<int> vi;
vi.push_back(1);
vi.push_back(2);
vi.push_back(3);
@@ -171,13 +160,12 @@

 outVal equals
 
-<pre class="programlisting">
-[1, 2, 3]
+<pre class="programlisting">[1, 2, 3]
</pre>
</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 © 2007 Jeff Garland, 2008 Jared McIntyre
+<td align="right"><div class="copyright-footer">Copyright © 2007 Jeff Garland, 2008-2009 Jared McIntyre
 Distributed under the Boost Software License, Version 1.0. (See accompanying
 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

Modified: sandbox/explore/libs/explore/doc/html/boost_explore/tutorial/custom_containers.html
==============================================================================
--- sandbox/explore/libs/explore/doc/html/boost_explore/tutorial/custom_containers.html (original)
+++ sandbox/explore/libs/explore/doc/html/boost_explore/tutorial/custom_containers.html 2009-09-16 23:36:59 EDT (Wed, 16 Sep 2009)
@@ -3,8 +3,8 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Custom Containers</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<link rel="start" href="../../index.html" title="Boost.explore">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Boost.explore">
<link rel="up" href="../tutorial.html" title="Tutorial">
<link rel="prev" href="custom_delimeters.html" title="Custom Delimiters">
<link rel="next" href="../dependencies_platforms.html" title="Dependencies and Platforms">
@@ -14,15 +14,15 @@
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="custom_delimeters.html"><img src="../../../../../../doc/html/images/%20prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../../../../../doc/html/images/%20up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/%20home.png" alt="Home"></a><a accesskey="n" href="../dependencies_platforms.html"><img src="../../../../../../doc/html/images/%20next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section" title="Custom Containers">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_explore.tutorial.custom_containers"></a><a class="link" href="custom_containers.html" title="Custom Containers"> Custom Containers</a>
</h3></div></div></div>
@@ -34,8 +34,7 @@
 The following is a very simple class that contains a 1, 2, and 3 along with
 the begin and end functions to access the iterators for the container.
 
-<pre class="programlisting">
-class user_vector
+<pre class="programlisting">class user_vector
{
public:
 user_vector()
@@ -45,15 +44,7 @@
 m_vec.push_back(3);
 }

- std::vector<int>::const_iterator begin() const
- {
- return m_vec.begin();
- }
-
- std::vector<int>::const_iterator end() const
- {
- return m_vec.end();
- }
+ friend std::ostream& operator<<(std::ostream& ostr, const user_vector& u);

private:
 std::vector<int> m_vec;
@@ -67,39 +58,81 @@
 passes into stream_container the result of the begin and end functions, and
 allows stream_container to process the contents for it.
 
-<pre class="programlisting">
-std::ostream& operator<<(std::ostream& ostr, const user_vector& u)
+<pre class="programlisting">std::ostream& operator<<(std::ostream& ostr, const user_vector& u)
{
- return explore::stream_container(ostr, u.begin(), u.end());
+ return explore::stream_container(ostr, u.m_vec.begin(), u.m_vec.end());
}
</pre>

 With our new overloaded operator<<, the following code
 
-<pre class="programlisting">
-user_vector v;
+<pre class="programlisting">user_vector v;
std::cout << v;
</pre>

 prints
 
-<pre class="programlisting">
-[1, 2, 3]
+<pre class="programlisting">[1, 2, 3]
</pre>

 If the container had been an associative container of pairs, then the operator<<
 code would have looked like this:
 
-<pre class="programlisting">
-std::ostream& operator<<(std::ostream& ostr, const user_vector& u)
+<pre class="programlisting">std::ostream& operator<<(std::ostream& ostr, const user_vector& u)
{
 return explore::stream_container(ostr, u.begin(), u.end(), explore::stream_associative_value());
}
</pre>
+
+ If the custom container has a stream operator that defines manipulators that
+ should always be in effect for that container, then it becomes necessary
+ to use the custom() manipulator. For example:
+ 
+<pre class="programlisting">ostream& operator<<(ostream& ostr, const user_vector& u)
+{
+ return ostr << explore::custom() << explore::delimiters("/", "::", "/") << u.m_vec.m_data;
+}
+</pre>
+
+ The desire here is to use the delimiters "/" for begin/end and
+ "::" for the separator, independent of what depth the container
+ is streamed at. The "custom" manipulator allows this to work. If
+ this is not specified, you will receive a debug assertion. With this new
+ overload, the code:
+ 
+<pre class="programlisting">user_vector v;
+std::cout << v;
+</pre>
+
+ prints
+ 
+<pre class="programlisting">/1::2::3/
+</pre>
+
+ But more interestingly:
+ 
+<pre class="programlisting">std::vector<user_vector> v;
+v.push_back(user_vector());
+v.push_back(user_vector());
+
+std::cout << explore::delimiters("{\n ", "\n ", "\n}") << v;
+</pre>
+
+ prints
+ 
+<pre class="programlisting">{
+ /1::2::3/
+ /1::2::3/
+}
+</pre>
+
+ So the same delimiters are always used for the custom container, even when
+ that container is nested in another.
+ 
</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 © 2007 Jeff Garland, 2008 Jared McIntyre
+<td align="right"><div class="copyright-footer">Copyright © 2007 Jeff Garland, 2008-2009 Jared McIntyre
 Distributed under the Boost Software License, Version 1.0. (See accompanying
 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

Modified: sandbox/explore/libs/explore/doc/html/boost_explore/tutorial/custom_delimeters.html
==============================================================================
--- sandbox/explore/libs/explore/doc/html/boost_explore/tutorial/custom_delimeters.html (original)
+++ sandbox/explore/libs/explore/doc/html/boost_explore/tutorial/custom_delimeters.html 2009-09-16 23:36:59 EDT (Wed, 16 Sep 2009)
@@ -3,8 +3,8 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Custom Delimiters</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<link rel="start" href="../../index.html" title="Boost.explore">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Boost.explore">
<link rel="up" href="../tutorial.html" title="Tutorial">
<link rel="prev" href="../tutorial.html" title="Tutorial">
<link rel="next" href="custom_containers.html" title="Custom Containers">
@@ -14,15 +14,15 @@
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../tutorial.html"><img src="../../../../../../doc/html/images/%20prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../../../../../doc/html/images/%20up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/%20home.png" alt="Home"></a><a accesskey="n" href="custom_containers.html"><img src="../../../../../../doc/html/images/%20next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section" title="Custom Delimiters">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_explore.tutorial.custom_delimeters"></a><a class="link" href="custom_delimeters.html" title="Custom Delimiters"> Custom Delimiters</a>
</h3></div></div></div>
@@ -31,7 +31,7 @@
 streaming process through the use of several new stream manipulators.
 
<div class="table">
-<a name="id533665"></a>Table 1. Explore Stream Manipulators
+<a name="id555307"></a>Table 1. Explore Stream Manipulators
<div class="table-contents"><table class="table" summary="Explore Stream Manipulators">
<colgroup>
<col>
@@ -110,7 +110,7 @@
<tr>
<td>
 
- assoc_start(char*)
+ assoc_item_start(char*)
 
 </td>
<td>
@@ -120,14 +120,14 @@
 </td>
<td>
 
- Changes the string output at the front of an association.
+ Changes the string output at the front of an association item.
 
 </td>
</tr>
<tr>
<td>
 
- assoc_end(char*)
+ assoc_item_end(char*)
 
 </td>
<td>
@@ -137,14 +137,14 @@
 </td>
<td>
 
- Changes the string output at the end of an association.
+ Changes the string output at the end of an association item.
 
 </td>
</tr>
<tr>
<td>
 
- assoc_seperator(char*)
+ assoc_item_seperator(char*)
 
 </td>
<td>
@@ -154,19 +154,64 @@
 </td>
<td>
 
- Changes the string output in between elements of an association.
+ Changes the string output in between elements of an association item.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ rows(size_t)
+ 
+ </td>
+<td>
+ 
+ ???
+ 
+ </td>
+<td>
+ 
+ ???
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ item_wdth(size_t)
+ 
+ </td>
+<td>
+ 
+ ???
+ 
+ </td>
+<td>
+ 
+ ???
 
 </td>
</tr>
</tbody>
</table></div>
</div>
- 
+ <div class="important" title="Important"><table border="0" summary="Important">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../../../../../doc/html/images/important.png"></td>
+<th align="left">Important</th>
+</tr>
+<tr><td align="left" valign="top">
+ There are both char* and wchar_t* versions of all string manipulator functions.
+ However, you can only use char manipulators with ostreams and wchar_t manipulators
+ with wostreams. Using the wrong type with the wrong stream will cause a
+ compile error.
+ </td></tr>
+</table></div>
+
 For example, to change the beginning and end output of a container to be
 the greater and less than symbols, you would do the following.
 
-<pre class="programlisting">
-std::vector<int> vi;
+<pre class="programlisting">std::vector<int> vi;
vvi.push_back(1);
vvi.push_back(2);
vvi.push_back(3);
@@ -175,11 +220,98 @@

 prints
 
-<pre class="programlisting">
-<1, 2, 3>
+<pre class="programlisting"><1, 2, 3>
+</pre>
+<a name="boost_explore.tutorial.custom_delimeters.manipulator_helper_functions"></a><h5>
+<a name="id555793"></a>
+ <a class="link" href="custom_delimeters.html#boost_explore.tutorial.custom_delimeters.manipulator_helper_functions">Manipulator
+ Helper Functions</a>
+ </h5>
+
+ There are several helper functions that will set multiple manipulators with
+ one call.
+ 
+<div class="table">
+<a name="id555811"></a>Table 2. Explore Stream Manipulator Helpers
+<div class="table-contents"><table class="table" summary="Explore Stream Manipulator Helpers">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Manipulator
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ begin_end(char* begin, char* end)
+ 
+ </td>
+<td>
+ 
+ Changes the string output of the beginning and end of a container.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ delimeters(char* begin, char* separator, char* end)
+ 
+ </td>
+<td>
+ 
+ Changes the string output of the beginning, eseparator, and end of
+ a container.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ assoc_item_begin_end(char* begin, char* end)
+ 
+ </td>
+<td>
+ 
+ Changes the string output of the beginning and end of an association
+ item.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ assoc_item_delimeters(char* begin, char* separator, char* end)
+ 
+ </td>
+<td>
+ 
+ Changes the string output of the beginning, eseparator, and end of
+ an association item.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+ 
+ The previous code could have been written
+ 
+<pre class="programlisting">std::cout << explore::begin_end("<", ">") << vi;
</pre>
<a name="boost_explore.tutorial.custom_delimeters.delimeters_by_level"></a><h5>
-<a name="id534097"></a>
+<a name="id556001"></a>
 <a class="link" href="custom_delimeters.html#boost_explore.tutorial.custom_delimeters.delimeters_by_level">Delimeters
 by Level</a>
 </h5>
@@ -189,8 +321,7 @@
 for different levels. The following formatter prints all child containers
 on a new line, and those child containers have custom delimeters.
 
-<pre class="programlisting">
-std::ostream& format_2d(std::ostream& ostr)
+<pre class="programlisting">std::ostream& format_2d(std::ostream& ostr)
{
 using namespace explore;

@@ -207,8 +338,7 @@
 The following example uses the above formatter against a vector containing
 a vector of int.
 
-<pre class="programlisting">
-std::vector<int> vi;
+<pre class="programlisting">std::vector<int> vi;
vi.push_back(1);
vi.push_back(2);
vi.push_back(3);
@@ -221,15 +351,43 @@

 This prints
 
-<pre class="programlisting">
-|1 2 3|
+<pre class="programlisting">|1 2 3|
|1 2 3|
|1 2 3|
</pre>
+
+ TODO: HTML list output example:
+ 
+<pre class="programlisting">// manipulator
+template<typename Elem, typename Tr>
+std::basic_ostream<Elem, Tr>& format_html_list(std::basic_ostream<Elem, Tr>& ostr)
+{
+ return ostr
+ << start("<ul>\n <li>")
+ << separator("\n <li>")
+ << end("\n</ul>");
+}
+</pre>
+<a name="boost_explore.tutorial.custom_delimeters.item_width"></a><h5>
+<a name="id556907"></a>
+ <a class="link" href="custom_delimeters.html#boost_explore.tutorial.custom_delimeters.item_width">Item
+ Width</a>
+ </h5>
+
+ TODO: finish this section
+ 
+<a name="boost_explore.tutorial.custom_delimeters.retrieving_manipulator_values"></a><h5>
+<a name="id556931"></a>
+ <a class="link" href="custom_delimeters.html#boost_explore.tutorial.custom_delimeters.retrieving_manipulator_values">Retrieving
+ Manipulator Values</a>
+ </h5>
+
+ TODO: finish this section
+ 
</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 © 2007 Jeff Garland, 2008 Jared McIntyre
+<td align="right"><div class="copyright-footer">Copyright © 2007 Jeff Garland, 2008-2009 Jared McIntyre
 Distributed under the Boost Software License, Version 1.0. (See accompanying
 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

Modified: sandbox/explore/libs/explore/doc/html/index.html
==============================================================================
--- sandbox/explore/libs/explore/doc/html/index.html (original)
+++ sandbox/explore/libs/explore/doc/html/index.html 2009-09-16 23:36:59 EDT (Wed, 16 Sep 2009)
@@ -3,8 +3,8 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Boost.explore</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<link rel="start" href="index.html" title="Boost.explore">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="index.html" title="Boost.explore">
<link rel="next" href="boost_explore/tutorial.html" title="Tutorial">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -12,19 +12,19 @@
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
<div class="spirit-nav"><a accesskey="n" href="boost_explore/tutorial.html"><img src="../../../../doc/html/images/%20next.png" alt="Next"></a></div>
-<div class="chapter" lang="en">
+<div class="chapter" title="Boost.explore">
<div class="titlepage"><div>
<div><h2 class="title">
<a name="boost_explore"></a>Boost.explore</h2></div>
-<div>Copyright © 2007 Jeff Garland, 2008 Jared McIntyre</div>
-<div><div class="legalnotice">
-<a name="id532272"></a>
+<div>Copyright © 2007 Jeff Garland, 2008-2009 Jared McIntyre</div>
+<div><div class="legalnotice" title="Legal Notice">
+<a name="id553924"></a>
 Distributed under the Boost Software License, Version 1.0. (See accompanying
 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 
@@ -47,7 +47,7 @@
 Boost.explore is a cross-platform C++ library for printing of containers.
 
<a name="boost_explore..getting_started"></a><h3>
-<a name="id535777"></a>
+<a name="id558478"></a>
 <a class="link" href="index.html#boost_explore..getting_started">Getting Started</a>
 </h3>

@@ -57,8 +57,7 @@

 The following are some simple usage examples:
 
-<pre class="programlisting">
-#include <boost/explore.hpp>
+<pre class="programlisting">#include <boost/explore.hpp>

// simple vector example
std::vector<int> vi;
@@ -102,53 +101,50 @@
 be considered.
 
<a name="boost_explore..supported_containers"></a><h3>
-<a name="id536629"></a>
+<a name="id559600"></a>
 <a class="link" href="index.html#boost_explore..supported_containers">Supported Containers</a>
 </h3>
-<div class="itemizedlist"><ul type="disc">
-<li>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
 C style array
 </li>
-<li>
+<li class="listitem">
 std::deque
 </li>
-<li>
+<li class="listitem">
 std::list
 </li>
-<li>
+<li class="listitem">
 std::map
 </li>
-<li>
+<li class="listitem">
 std::multimap
 </li>
-<li>
+<li class="listitem">
 std::pair
 </li>
-<li>
+<li class="listitem">
 std::set
 </li>
-<li>
+<li class="listitem">
 std::multiset
 </li>
-<li>
+<li class="listitem">
 std::vector
 </li>
-<li>
+<li class="listitem">
 boost::array
 </li>
-<li>
+<li class="listitem">
 boost::range
 </li>
-<li>
- boost::tuple
- </li>
</ul></div>

 <a class="link" href="boost_explore/tutorial/custom_containers.html" title="Custom Containers">Custom containers</a>
 can also be made to work with explore.
 
<a name="boost_explore..acknowledgements"></a><h3>
-<a name="id536697"></a>
+<a name="id559664"></a>
 <a class="link" href="index.html#boost_explore..acknowledgements">Acknowledgements</a>
 </h3>

Next message: hartmut.kaiser_at_[hidden]: "[Boost-commit] svn:boost r56259 - in trunk/boost/spirit/home: qi/char support"
Previous message: hartmut.kaiser_at_[hidden]: "[Boost-commit] svn:boost r56257 - trunk/boost/spirit/home/qi/char"

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk