Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r54638 - in sandbox/cloneable/libs/cloneable/doc/html: cloneable cloneable/containers cloneable/tutorial images
From: christian.schladetsch_at_[hidden]
Date: 2009-07-04 05:42:00

Author: cschladetsch
Date: 2009-07-04 05:41:59 EDT (Sat, 04 Jul 2009)
New Revision: 54638
URL: http://svn.boost.org/trac/boost/changeset/54638

Log:
added new pages

Added:
   sandbox/cloneable/libs/cloneable/doc/html/cloneable/containers/container_method_names.html (contents, props changed)
   sandbox/cloneable/libs/cloneable/doc/html/cloneable/containers/extended_object_hierarhcy.html (contents, props changed)
   sandbox/cloneable/libs/cloneable/doc/html/cloneable/heterogenous_containers.html (contents, props changed)
   sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/cloneable_traits.html (contents, props changed)
   sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/controlling_construction.html (contents, props changed)
   sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/dealing_with_muliple_sub_objects.html (contents, props changed)
   sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/dealing_with_muliple_subobjects.html (contents, props changed)
Removed:
   sandbox/cloneable/libs/cloneable/doc/html/images/

Added: sandbox/cloneable/libs/cloneable/doc/html/cloneable/containers/container_method_names.html
==============================================================================
--- (empty file)
+++ sandbox/cloneable/libs/cloneable/doc/html/cloneable/containers/container_method_names.html 2009-07-04 05:41:59 EDT (Sat, 04 Jul 2009)
@@ -0,0 +1,108 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Container Method Names</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
+<link rel="home" href="../../index.html" title="Cloneable 0.1">
+<link rel="up" href="../containers.html" title="Containers">
+<link rel="prev" href="extended_object_hierarhcy.html" title="Extended Object Hierarhcy">
+<link rel="next" href="list.html" title="List">
+</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">Home</td>
+<td align="center">Libraries</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="extended_object_hierarhcy.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../containers.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="list.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" title="Container Method Names">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="cloneable.containers.container_method_names"></a><a class="link" href="container_method_names.html" title="Container Method Names">Container
+ Method Names</a>
+</h3></div></div></div>
+
+ To add an element of type <code class="computeroutput">Ty</code>
+ to any heterogenous container such as a <code class="computeroutput">list</code>,
+ <code class="computeroutput">vector</code> or <code class="computeroutput">set</code>
+ we use the following syntax:
+ 
+
+
+
+<pre class="programlisting">container.add_method_name<Ty>(a0, a1,..., an);
+</pre>
+
+ 
+
+ Specifically, we do not directly add an object to a heterogenous container.
+ Rather, we specify the type of thing to add, and provide any construction
+ arguments. This is true as well for specifying objects to search for in associative
+ containers:
+ 
+
+
+
+<pre class="programlisting">container.find<Ty>(a0, a1,..., an);
+</pre>
+
+ 
+
+ This creates a new object of type <code class="computeroutput">Ty</code>,
+ constructed with the provided arguments, and searches for it in the container.
+ But, I'm getting a little ahead of ourselves here - more on associative containers
+ later; let's look at that syntax again.
+ 
+
+ The name for the method to add new objects to heterogenous sequence containers
+ has gone from being called <code class="computeroutput">push_back</code>
+ to <code class="computeroutput">emplace_back</code> to <code class="computeroutput">push_emplace_back</code> and back to <code class="computeroutput">push_back</code>. Similarly for associative containers
+ the names have varied from <code class="computeroutput">insert</code>
+ to <code class="computeroutput">emplace</code> to <code class="computeroutput">emplace_insert</code> and back to <code class="computeroutput">insert</code>.
+ 
+
+ The C++0x containers have emplace methods that insert a new object after
+ a given iterator location, by passing construction arguments. These are called
+ <code class="computeroutput">emplace</code> methods.
+ 
+
+ This is similar to the way that objects are added to heterogenous containers,
+ but not the same. For all heterogenous containers, the process is to specify
+ the type of thing and any creation arguments. There is no need to specify
+ an iterator, but there is a need to specify the type explicitly. This is
+ different to the C++0x containers, which do not require the type.
+ 
+
+ For this reason the names have changed and are yet to be settled. All suggestions
+ for the names of the methods, or namespaces, are welcome. I am sure they'll
+ end up being called something like <code class="computeroutput">emplace_back</code>
+ rather than <code class="computeroutput">push_back</code>; but
+ the difference is that there is no <code class="computeroutput">push_back</code>
+ in a heterogenous container: everything is always emplaced,
+ so this is one reason why I've been vasilating over the naming conventions
+ to use.
+ 
+
+ With this in mind, let's visit the first container: the faithful list.
+ 
+</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 © 2009 Christian Schladetsch
+ 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="extended_object_hierarhcy.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../containers.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="list.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/cloneable/libs/cloneable/doc/html/cloneable/containers/extended_object_hierarhcy.html
==============================================================================
--- (empty file)
+++ sandbox/cloneable/libs/cloneable/doc/html/cloneable/containers/extended_object_hierarhcy.html 2009-07-04 05:41:59 EDT (Sat, 04 Jul 2009)
@@ -0,0 +1,142 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Extended Object Hierarhcy</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
+<link rel="home" href="../../index.html" title="Cloneable 0.1">
+<link rel="up" href="../containers.html" title="Containers">
+<link rel="prev" href="../containers.html" title="Containers">
+<link rel="next" href="container_method_names.html" title="Container Method Names">
+</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">Home</td>
+<td align="center">Libraries</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="../containers.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../containers.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="container_method_names.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" title="Extended Object Hierarhcy">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="cloneable.containers.extended_object_hierarhcy"></a><a class="link" href="extended_object_hierarhcy.html" title="Extended Object Hierarhcy">Extended
+ Object Hierarhcy</a>
+</h3></div></div></div>
+
+ This is the definitions we will use in the following examples. First, let's
+ look an a slightly extended base type for our Animal collection:
+ 
+
+
+
+<pre class="programlisting">struct Animal
+{
+ double age;
+ string name;
+
+ Animal(double years_old = 0) : age(years_old) { }
+ Animal(string n, double years_old = 0) : age(years_old), name(n) { }
+
+ friend bool operator==(const Animal &left, const Animal &right) const
+ {
+ return left.age == right.age;
+ }
+ friend bool operator<(const Animal &left, const Animal &right) const
+ {
+ return left.age < right.age;
+ }
+ struct CompareNames
+ {
+ friend bool operator<(const Animal &left, const Animal &right) const
+ {
+ return left.name < right.name;
+ }
+ };
+};
+</pre>
+
+ 
+
+ This is just a little more elaborate than the previous example hierarchy
+ we used earlier in the tutorial. We have added an <code class="computeroutput">age</code>
+ field for all animals, which is how old it is in years. Animals have relational
+ operators for testing equivalence and sorting. Another functor named <code class="computeroutput">CompareNames</code> is provided, which sorts by
+ the name field of animals rather than age.
+ 
+
+ You are aware that getting your base class right is very important to the
+ strength and efficacy of the hierarchy as a whole. At a minimum, you must
+ of course use a virtual destructor. Getting the comparison operators right
+ is very important as well, but of course we can always add more sorting predicates
+ such as <code class="computeroutput">CompareNames</code> as needed.
+ 
+
+ What we would like to avoid is having a so-called fat interface
+ as the base class, which has a lot of extra information that is only relevant
+ to one or more derived types. Some of these issues can be addressed with
+ further use of interfaces and virtual methods to obtain sorting criteria.
+ 
+
+ A full discussion on object-oriented design is beyond the scope of this brief
+ tutorial - and I'm sure you're very aware of the issues in any case. Suffice
+ to say that you should pay attention to how you design your base types. Always
+ use a virtual destructor, try to keep state to a minimum, and bear in mind
+ how you will want to compare objects.
+ 
+
+ Moving on, we define our derived types:
+ 
+
+
+
+<pre class="programlisting">struct Cat : cloneable::base<Cat, Animal>
+{
+ Cat(string name, double age = 10) : Animal(name, age) { }
+};
+
+struct Dog : cloneable::base<Dog, Animal>
+{
+ Dog(string name, double age = 0) : Animal(name, age) { }
+};
+
+struct Labrador : Dog, cloneable::base<Labrador, Animal>
+{
+ bool is_guide_dog;
+ Labrador(string name, bool can_lead, double age = 0) : Dog(name, age), is_guide_dog(can_lead) { }
+};
+</pre>
+
+ 
+
+ Labradors now have an extra field indicating that a given instance has been
+ trained as a guide dog, and each Animal type can be constructed by passing
+ its name and age. Note that there are no default constructors for any of
+ the Animal types.
+ 
+
+ Feel free to return to this page to refresh your memory as we walk through
+ some examples that use these definitions.
+ 
+
+ First, a preamble on names and semantics.
+ 
+</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 © 2009 Christian Schladetsch
+ 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../containers.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../containers.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="container_method_names.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/cloneable/libs/cloneable/doc/html/cloneable/heterogenous_containers.html
==============================================================================
--- (empty file)
+++ sandbox/cloneable/libs/cloneable/doc/html/cloneable/heterogenous_containers.html 2009-07-04 05:41:59 EDT (Sat, 04 Jul 2009)
@@ -0,0 +1,133 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Heterogenous Containers</title>
+<link rel="stylesheet" href="../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
+<link rel="home" href="../index.html" title="Cloneable 0.1">
+<link rel="up" href="../index.html" title="Cloneable 0.1">
+<link rel="prev" href="tutorial/cloneable_traits.html" title="Cloneable Traits">
+<link rel="next" href="heterogenous_containers/extended_object_hierarhcy.html" title="Extended Object Hierarhcy">
+</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">Home</td>
+<td align="center">Libraries</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/cloneable_traits.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="heterogenous_containers/extended_object_hierarhcy.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" title="Heterogenous Containers">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="cloneable.heterogenous_containers"></a><a class="link" href="heterogenous_containers.html" title="Heterogenous Containers">Heterogenous Containers</a>
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt><a href="heterogenous_containers/extended_object_hierarhcy.html">Extended
+ Object Hierarhcy</a></dt>
+<dt><a href="heterogenous_containers/container_method_names.html">Container
+ Method Names</a></dt>
+<dt>List</dt>
+<dt>Vector</dt>
+<dt>Set</dt>
+<dt>Map</dt>
+<dt><a href="heterogenous_containers/hashmap_and_hashset.html">HashMap
+ and HashSet</a></dt>
+</dl></div>
+
+ This section of the tutorial presents the first glimpse of the so-called heterogenous
+ containers provided by the Cloneable library. These are:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem"><code class="computeroutput">list<Base, Allocator></code></li>
+<li class="listitem"><code class="computeroutput">vector<Base, Allocator></code></li>
+<li class="listitem"><code class="computeroutput">deque<Base, Allocator></code></li>
+<li class="listitem"><code class="computeroutput">chain<Base, LinkLength, Allocator></code></li>
+<li class="listitem"><code class="computeroutput">map<Base, Predicate, Allocator></code></li>
+<li class="listitem"><code class="computeroutput">set<Base, Predicate, Allocator></code></li>
+<li class="listitem"><code class="computeroutput">multimap<Base, Pred, Alloc></code></li>
+<li class="listitem"><code class="computeroutput">multiset<Base, Pred, Alloc></code></li>
+<li class="listitem"><code class="computeroutput">hash_map<Base, Predicate, Hash, Allocator></code></li>
+<li class="listitem"><code class="computeroutput">hash_set<Base, Predicate, Hash, Allocator></code></li>
+<li class="listitem">
+<code class="computeroutput">hash_multimap<Base, Pred, Hash, Alloc></code>.
+ </li>
+<li class="listitem"><code class="computeroutput">hash_multiset<Base, Pred, Hash, Alloc></code></li>
+</ul></div>
+
+ All of these containers store pointers to objects. However, they each expose
+ their contained objects using value semantics. If this seems similar to Boost.PtrContainer, that is not coincidental, as these
+ containers are based on a modified implementation of that library.
+ 
+
+ You will have noted that each container is specialised over a <code class="computeroutput">Base</code> type, rather than a concrete derived
+ type. This is because they are intended to store base pointers.
+ 
+
+ It may be surprising that <code class="computeroutput">map<></code> takes only one type - the <code class="computeroutput">Base</code> type - of objects to store, rather than
+ the more familiar key and mapped
+ types. This is because a heterogenous map provides an association between objects
+ with the same base type.
+ 
+
+ All heterogenous containers create objects to be added 'in place', in storage
+ created by the containers allocator. As such, to add a new object to a heterogenous
+ container, you provide the type and the construction arguments. Allocation
+ and construction is dealt with by the container, and, importantly, objects
+ are not copied into the container:
+ 
+
+
+
+<pre class="programlisting">container.add_method<Type>(construction args..);
+</pre>
+
+ 
+
+ This means, for instance, that you can use non-default-constructable objects
+ in heterogenous vectors.
+ 
+
+ It also means that you can use objects that do not or cannot have assignment
+ defined.
+ 
+
+ Basically, as long as you can construct the object at all, you can use it in
+ a heterogenous container.
+ 
+
+ Importantly, clones are guaranteed to be created using the same allocator as
+ that used to make the original objects.
+ 
+
+ This is why it is important that you overload <code class="computeroutput">make_copy(abstract_allocator
+ &) const</code>,
+ rather than the <code class="computeroutput">make_copy()
+ const</code> method that does not take an allocator.
+ (Indeed, there is a good case to be made for removing this second
+ method from the library completely - CJS).
+ 
+
+ These containers will be presented in order, with some motivational examples
+ which combines them. First, we shall extend our little Animal hierarchy to
+ include an age member, and comparison operators.
+ 
+</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 © 2009 Christian Schladetsch
+ 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tutorial/cloneable_traits.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="heterogenous_containers/extended_object_hierarhcy.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/cloneable_traits.html
==============================================================================
--- (empty file)
+++ sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/cloneable_traits.html 2009-07-04 05:41:59 EDT (Sat, 04 Jul 2009)
@@ -0,0 +1,73 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Cloneable Traits</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
+<link rel="home" href="../../index.html" title="Cloneable 0.1">
+<link rel="up" href="../tutorial.html" title="Tutorial">
+<link rel="prev" href="using_custom_allocators.html" title="Using Custom Allocators">
+<link rel="next" href="../heterogenous_containers.html" title="Heterogenous Containers">
+</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">Home</td>
+<td align="center">Libraries</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="using_custom_allocators.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../heterogenous_containers.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" title="Cloneable Traits">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="cloneable.tutorial.cloneable_traits"></a><a class="link" href="cloneable_traits.html" title="Cloneable Traits">Cloneable Traits</a>
+</h3></div></div></div>
+
+ This is mostly relevant to library maintainers and is not important otherwise.
+ 
+
+ To assist with dealing with cloneable objects in other systems, the following
+ traits are provided:
+ 
+
+
+
+<pre class="programlisting">class Base { virtual ~Base() { } };
+struct T : base<T, Base> { };
+struct U : base<T, Base, no_default_construction> { };
+struct V { };
+
+BOOST_STATIC_ASSERT(cloneable::is_cloneable<T>::value);
+BOOST_STATIC_ASSERT(cloneable::is_cloneable<U>::value);
+BOOST_STATIC_ASSERT(!cloneable::is_cloneable<V>::value);
+BOOST_STATIC_ASSERT(cloneable::has_base<T,Base>::value);
+
+//BOOST_STATIC_ASSERT(cloneable::is_default_constructable<V>::value); compile-time error: no traits
+BOOST_STATIC_ASSERT(cloneable::is_default_constructable<T>::value);
+BOOST_STATIC_ASSERT(!cloneable::is_default_constructable<T>::value);
+</pre>
+
+ 
+
+ More details are in the <code class="computeroutput">clonable::traits<T></code>
+ structure.
+ 
+</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 © 2009 Christian Schladetsch
+ 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="using_custom_allocators.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../heterogenous_containers.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/controlling_construction.html
==============================================================================
--- (empty file)
+++ sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/controlling_construction.html 2009-07-04 05:41:59 EDT (Sat, 04 Jul 2009)
@@ -0,0 +1,106 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Controlling Construction</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
+<link rel="home" href="../../index.html" title="Cloneable 0.1">
+<link rel="up" href="../tutorial.html" title="Tutorial">
+<link rel="prev" href="simple_hierarchical_cloning.html" title="Simple Hierarchical Cloning">
+<link rel="next" href="using_external_types.html" title="Using External Types">
+</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">Home</td>
+<td align="center">Libraries</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="simple_hierarchical_cloning.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="using_external_types.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" title="Controlling Construction">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="cloneable.tutorial.controlling_construction"></a><a class="link" href="controlling_construction.html" title="Controlling Construction">Controlling
+ Construction</a>
+</h3></div></div></div>
+
+ We sometimes work with objects that cannot be default constructed. The Cloneable
+ system works with these types safely:
+ 
+
+
+
+<pre class="programlisting">struct Base { virtual ~Base() {} };
+
+struct T0 : cloneable::base<T0, Base, no_default_construction_tag>
+{
+ string &str;
+ T0(string &s) : str(s) { }
+};
+</pre>
+
+ 
+
+ <code class="computeroutput">T0</code> has a member that is a
+ reference and as such doesn't have a default constructor. To avoid compile-time
+ errors when using this type in the Cloneable libray, you must indicate that
+ it is not default-constructible by passing the <code class="computeroutput">no_default_construction_tag</code>
+ type as a parameter to cloneable::base<>. The order that you give the
+ base-type or tag-types to cloneable::base<> is not important and is
+ dealt with be the library.
+ 
+
+ Putting this type to use:
+ 
+
+
+
+<pre class="programlisting">int main()
+{
+ string str = "foo";
+ T0 *p = new T0(str);
+ T0 *q = p->clone_as<T0>();
+ assert(&q->str == &str);
+
+ // demonstrate that attempting to create
+ // a new T0 instance without parameters
+ // results in an exception of type no_default_construction
+ bool caught = false;
+ try
+ {
+ p->create_new();
+ }
+ catch (no_default_construction)
+ {
+ caught = true;
+ }
+ assert(caught);
+ return 0;
+}
+</pre>
+
+ 
+
+ A <code class="computeroutput">no_default_construction</code>
+ exception is thrown if you attempt to default-construct a type that has no
+ default constructor.
+ 
+</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 © 2009 Christian Schladetsch
+ 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="simple_hierarchical_cloning.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="using_external_types.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/dealing_with_muliple_sub_objects.html
==============================================================================
--- (empty file)
+++ sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/dealing_with_muliple_sub_objects.html 2009-07-04 05:41:59 EDT (Sat, 04 Jul 2009)
@@ -0,0 +1,87 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Dealing with Muliple Sub-Objects</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
+<link rel="home" href="../../index.html" title="Cloneable 0.1">
+<link rel="up" href="../tutorial.html" title="Tutorial">
+<link rel="prev" href="using_external_types.html" title="Using External Types">
+<link rel="next" href="customising_the_cloning_process.html" title="Customising the Cloning Process">
+</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">Home</td>
+<td align="center">Libraries</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="using_external_types.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="customising_the_cloning_process.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" title="Dealing with Muliple Sub-Objects">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="cloneable.tutorial.dealing_with_muliple_sub_objects"></a><a class="link" href="dealing_with_muliple_sub_objects.html" title="Dealing with Muliple Sub-Objects">Dealing
+ with Muliple Sub-Objects</a>
+</h3></div></div></div>
+
+ When working with types that have multiple cloneable sub-objects, we must
+ use the <code class="computeroutput">clone_as<T></code> and
+ <code class="computeroutput">create_as<T></code> methods
+ to disambiguate which sub-type to clone or create.
+ 
+
+ This is demonstrated below:
+ 
+
+
+
+<pre class="programlisting">struct Base { virtual ~Base() { } };
+struct T0 : base<T0, Base> { };
+struct T1 : T0, base<T1, Base> { };
+struct W : base<W, Base> { };
+struct T2 : W, T1, base<T2, Base> { };
+
+int main()
+{
+ T2 *t2 = new T2();
+
+ // clone sub-objects
+ W *t2_w = t2->clone_as<W>();
+ T1 *t2_t1 = t2->clone_as<T1>();
+ T0 *t2_t0 = t2->clone_as<T0>();
+
+ // create sub-objects
+ W *t2_w_new = t2->create_as<W>();
+ T1 *t2_t1_new = t2->create_as<T1>();
+ T0 *t2_t0_new = t2->create_as<T0>();
+
+
+ return 0;
+}
+</pre>
+
+ 
+
+ Note that if a sub-type S in type T is not default-constructabe, an exception
+ of type no_default_construction will be thrown if you attempt to default-create
+ a new S instance from a T instance.
+ 
+</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 © 2009 Christian Schladetsch
+ 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="using_external_types.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="customising_the_cloning_process.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/dealing_with_muliple_subobjects.html
==============================================================================
--- (empty file)
+++ sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/dealing_with_muliple_subobjects.html 2009-07-04 05:41:59 EDT (Sat, 04 Jul 2009)
@@ -0,0 +1,87 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Dealing with Muliple SubObjects</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
+<link rel="home" href="../../index.html" title="Cloneable 0.1">
+<link rel="up" href="../tutorial.html" title="Tutorial">
+<link rel="prev" href="using_external_types.html" title="Using External Types">
+<link rel="next" href="customising_the_cloning_process.html" title="Customising the Cloning Process">
+</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">Home</td>
+<td align="center">Libraries</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="using_external_types.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="customising_the_cloning_process.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" title="Dealing with Muliple SubObjects">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="cloneable.tutorial.dealing_with_muliple_subobjects"></a><a class="link" href="dealing_with_muliple_subobjects.html" title="Dealing with Muliple SubObjects">Dealing
+ with Muliple SubObjects</a>
+</h3></div></div></div>
+
+ When dealing with types that have multiple cloneable sub-objects, we must
+ use the <code class="computeroutput">clone_as<T></code> and
+ <code class="computeroutput">create_as<T></code> methods
+ to disambiguate which sub-type to clone or create.
+ 
+
+ This is demonstrated below:
+ 
+
+
+
+<pre class="programlisting">struct Base { virtual ~Base() { } };
+struct T0 : base<T0, Base> { };
+struct T1 : T0, base<T1, Base> { };
+struct W : base<W, Base> { };
+struct T2 : W, T1, base<T2, Base> { };
+
+int main()
+{
+ T2 *t2 = new T2();
+
+ // clone sub-objects
+ W *t2_w = t2->clone_as<W>();
+ T1 *t2_t1 = t2->clone_as<T1>();
+ T0 *t2_t0 = t2->clone_as<T0>();
+
+ // create sub-objects
+ W *t2_w_new = t2->create_as<W>();
+ T1 *t2_t1_new = t2->create_as<T1>();
+ T0 *t2_t0_new = t2->create_as<T0>();
+
+
+ return 0;
+}
+</pre>
+
+ 
+
+ Note that if a sub-type S in type T is not default-constructabe, an exception
+ of type no_default_construction will be thrown if you attempt to default-create
+ a new S instance from a T instance.
+ 
+</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 © 2009 Christian Schladetsch
+ 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="using_external_types.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="customising_the_cloning_process.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

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