organicmaps/boost
13
Fork 0
mirror of https://github.com/boostorg/boost.git synced 2025-04-06 14:05:01 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions

Add BoostBook-generated HTML docs

Browse source 
[SVN r30339]
This commit is contained in:
Douglas Gregor 2005-07-31 16:29:54 +00:00
parent 242ff8fef1
commit 231e8e0e87
693 changed files with 88348 additions and 165 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

101
doc/html/Assignable.html Normal file
View file

@ -0,0 +1,101 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Concept Assignable</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="concepts/reference.html" title="Concept reference">
<link rel="prev" href="concepts/reference.html" title="Concept reference">
<link rel="next" href="InputIterator.html" title="Concept InputIterator">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="concepts/reference.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="InputIterator.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="Assignable"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Concept Assignable</span></h2>
<p>Assignable</p>
</div>
<div class="refsect1" lang="en">
<a name="id975234"></a><h2>Description</h2>
<p>Assignable types must have copy constructors,
<code class="computeroutput">operator=</code> for assignment, and the <code class="computeroutput">swap()</code>
function defined.</p>
</div>
<div class="refsect1" lang="en">
<a name="id975253"></a><h2>Refinement of</h2>
<div class="itemizedlist"><ul type="disc"><li><p><a href="CopyConstructible.html" title="Concept CopyConstructible">CopyConstructible</a></p></li></ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id975266"></a><h2>Notation</h2>
<div class="variablelist"><dl>
<dt><span class="term">X</span></dt>
<dd>A type playing the role of assignable-type in the <a href="Assignable.html" title="Concept Assignable">Assignable</a> concept.</dd>
<dt>
<span class="term"><code class="varname">x</code>, </span><span class="term"><code class="varname">y</code></span>
</dt>
<dd>Objects of type X</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id975296"></a><h2>Valid expressions</h2>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Name</th>
<th>Expression</th>
<th>Type</th>
<th>Semantics</th>
</tr></thead>
<tbody>
<tr>
<td><p>Assignment</p></td>
<td><p>x = y</p></td>
<td><p><span class="type">X &amp;</span></p></td>
<td><p>Require <code class="computeroutput">operator=</code></p></td>
</tr>
<tr>
<td><p>Swap</p></td>
<td><p>swap(x, y)</p></td>
<td><p><span class="type">void</span></p></td>
<td><p>Require <code class="computeroutput">swap()</code> function</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1" lang="en">
<a name="id975359"></a><h2>Models</h2>
<div class="itemizedlist"><ul type="disc"><li><span class="simplelist"><span class="type">int</span></span></li></ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id975371"></a><h2>See also</h2>
<div class="itemizedlist"><ul type="disc"><li><p><a href="CopyConstructible.html" title="Concept CopyConstructible">CopyConstructible</a></p></li></ul></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"><small>Copyright © 2001, 2002 Indiana University<br>Copyright © 2000, 2001 University of Notre Dame du Lac<br>Copyright © 2000 Jeremy Siek, Lie-Quan Lee, Andrew Lumsdaine<br>Copyright © 1996-1999 Silicon Graphics Computer Systems, Inc.<br>Copyright © 1994 Hewlett-Packard Company</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="concepts/reference.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="InputIterator.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

54
doc/html/BOOST_ONCE_INIT.html Normal file
View file

@ -0,0 +1,54 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Macro BOOST_ONCE_INIT</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="threads/reference.html#id718104" title="Header &lt;boost/thread/once.hpp&gt;">
<link rel="prev" href="timed_mutex.html" title="Class timed_mutex">
<link rel="next" href="call_once.html" title="Function call_once">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="timed_mutex.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="threads/reference.html#id718104"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="call_once.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="BOOST_ONCE_INIT"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Macro BOOST_ONCE_INIT</span></h2>
<p>BOOST_ONCE_INIT &#8212; The call_once function and
<code class="computeroutput">once_flag</code> type (statically initialized to
<a href="BOOST_ONCE_INIT.html" title="Macro BOOST_ONCE_INIT">BOOST_ONCE_INIT</a>) can be used to run a
routine exactly once. This can be used to initialize data in a
<a href="threads.html#threads.glossary.thread-safe">thread-safe</a>
manner.</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">BOOST_ONCE_INIT</pre></div>
<div class="refsect1" lang="en">
<a name="id1559796"></a><h2>Description</h2>The implementation-defined macro
<a href="BOOST_ONCE_INIT.html" title="Macro BOOST_ONCE_INIT">BOOST_ONCE_INIT</a> is a constant value used to
initialize <code class="computeroutput">once_flag</code> instances to indicate that the
logically associated routine has not been run yet. See
call_once for more details.</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"><small>Copyright © 2001-2003 William E. Kempf</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="timed_mutex.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="threads/reference.html#id718104"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="call_once.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

49
doc/html/BOOST_TRIBOOL_THIRD_STATE.html Normal file
View file

@ -0,0 +1,49 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Macro BOOST_TRIBOOL_THIRD_STATE</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="tribool/reference.html#id996838" title="Header &lt;boost/logic/tribool.hpp&gt;">
<link rel="prev" href="id1222476.html" title="Function operator!=">
<link rel="next" href="indeterminate_name.html" title="Class template indeterminate_name">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="id1222476.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="tribool/reference.html#id996838"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="indeterminate_name.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="BOOST_TRIBOOL_THIRD_STATE"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Macro BOOST_TRIBOOL_THIRD_STATE</span></h2>
<p>BOOST_TRIBOOL_THIRD_STATE &#8212; Declare a new name for the third state of a tribool. </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">BOOST_TRIBOOL_THIRD_STATE(Name)</pre></div>
<div class="refsect1" lang="en">
<a name="id1571265"></a><h2>Description</h2>
<p>Use this macro to declare a new name for the third state of a tribool. This state can have any number of new names (in addition to <code class="computeroutput">indeterminate</code> ), all of which will be equivalent. The new name will be placed in the namespace in which the macro is expanded.</p>
<p>Example: BOOST_TRIBOOL_THIRD_STATE(true_or_false)</p>
<p>tribool x(true_or_false); // potentially set x if (true_or_false(x)) { // don't know what x is } </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"><small>Copyright © 2002-2004 Douglas Gregor</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="id1222476.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="tribool/reference.html#id996838"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="indeterminate_name.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

59
doc/html/BOOST_VARIANT_ENUM_PARAMS.html Normal file
View file

@ -0,0 +1,59 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Macro BOOST_VARIANT_ENUM_PARAMS</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="variant/reference.html#id1283515" title="Header &lt;boost/variant/variant_fwd.hpp&gt;">
<link rel="prev" href="BOOST_VARIANT_LIMIT_TYPES.html" title="Macro BOOST_VARIANT_LIMIT_TYPES">
<link rel="next" href="id691834.html" title="Macro BOOST_VARIANT_ENUM_SHIFTED_PARAMS">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="BOOST_VARIANT_LIMIT_TYPES.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="variant/reference.html#id1283515"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="id691834.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="BOOST_VARIANT_ENUM_PARAMS"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Macro BOOST_VARIANT_ENUM_PARAMS</span></h2>
<p>BOOST_VARIANT_ENUM_PARAMS &#8212; <p>Enumerate parameters for use with
<code class="computeroutput"><a href="boost/variant.html" title="Class template variant">variant</a></code>.</p></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">BOOST_VARIANT_ENUM_PARAMS(param)</pre></div>
<div class="refsect1" lang="en">
<a name="id1662820"></a><h2>Description</h2>
<p>Expands to a comma-separated sequence of length
<code class="computeroutput"><a href="BOOST_VARIANT_LIMIT_TYPES.html" title="Macro BOOST_VARIANT_LIMIT_TYPES">BOOST_VARIANT_LIMIT_TYPES</a></code>, where
each element in the sequence consists of the concatenation of
<span class="emphasis"><em>param</em></span> with its zero-based index into the
sequence. That is,
<code class="computeroutput">param ## 0, param ## 1, ..., param ## BOOST_VARIANT_LIMIT_TYPES - 1</code>.</p>
<p><span class="bold"><strong>Rationale</strong></span>: This macro greatly
simplifies for the user the process of declaring
<code class="computeroutput"><a href="boost/variant.html" title="Class template variant">variant</a></code> types
in function templates or explicit partial specializations of class
templates, as shown in the
<a href="variant/tutorial.html#variant.tutorial.preprocessor" title="Preprocessor macros">tutorial</a>.</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"><small>Copyright © 2002, 2003 Eric Friedman, Itay Maman</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="BOOST_VARIANT_LIMIT_TYPES.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="variant/reference.html#id1283515"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="id691834.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

52
doc/html/BOOST_VARIANT_LIMIT_TYPES.html Normal file
View file

@ -0,0 +1,52 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Macro BOOST_VARIANT_LIMIT_TYPES</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="variant/reference.html#id1283515" title="Header &lt;boost/variant/variant_fwd.hpp&gt;">
<link rel="prev" href="variant/reference.html" title="Reference">
<link rel="next" href="BOOST_VARIANT_ENUM_PARAMS.html" title="Macro BOOST_VARIANT_ENUM_PARAMS">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="variant/reference.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="variant/reference.html#id1283515"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_VARIANT_ENUM_PARAMS.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="BOOST_VARIANT_LIMIT_TYPES"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Macro BOOST_VARIANT_LIMIT_TYPES</span></h2>
<p>BOOST_VARIANT_LIMIT_TYPES &#8212; <p>Expands to the length of the
template parameter list for
<code class="computeroutput"><a href="boost/variant.html" title="Class template variant">variant</a></code>.</p></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">BOOST_VARIANT_LIMIT_TYPES</pre></div>
<div class="refsect1" lang="en">
<a name="id1662761"></a><h2>Description</h2>
<p><span class="bold"><strong>Note</strong></span>: Conforming
implementations of <code class="computeroutput">variant</code> must allow at least ten
template arguments. That is, BOOST_VARIANT_LIMIT_TYPES must be greater
or equal to <code class="computeroutput">10</code>.</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"><small>Copyright © 2002, 2003 Eric Friedman, Itay Maman</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="variant/reference.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="variant/reference.html#id1283515"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_VARIANT_ENUM_PARAMS.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

165
doc/html/BidirectionalIterator.html Normal file
View file

@ -0,0 +1,165 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Concept BidirectionalIterator</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="concepts/reference.html" title="Concept reference">
<link rel="prev" href="ForwardIterator.html" title="Concept ForwardIterator">
<link rel="next" href="RandomAccessIterator.html" title="Concept RandomAccessIterator">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="ForwardIterator.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="RandomAccessIterator.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="BidirectionalIterator"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Concept BidirectionalIterator</span></h2>
<p>BidirectionalIterator</p>
</div>
<div class="refsect1" lang="en">
<a name="id976672"></a><h2>Description</h2>
<p>A bidirectional iterator is an iterator that can read through a sequence
of values. It can move in either direction through the sequence, and can
be either mutable (data pointed to by it can be changed) or not mutable.</p>
<p>An iterator represents a position in a sequence. Therefore, the
iterator can point into the sequence (returning a value when dereferenced
and being incrementable), or be off-the-end (and not dereferenceable or
incrementable).</p>
</div>
<div class="refsect1" lang="en">
<a name="id976688"></a><h2>Refinement of</h2>
<div class="itemizedlist"><ul type="disc"><li><p><a href="ForwardIterator.html" title="Concept ForwardIterator">ForwardIterator</a></p></li></ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id976700"></a><h2>Associated types</h2>
<div class="itemizedlist"><ul type="disc">
<li>
<p><span class="bold"><strong>value_type</strong></span></p>
<pre class="literallayout">std::iterator_traits&lt;Iter&gt;::value_type</pre>
<p>The value type of the iterator</p>
</li>
<li>
<p><span class="bold"><strong>category</strong></span></p>
<pre class="literallayout">std::iterator_traits&lt;Iter&gt;::iterator_category</pre>
<p>The category of the iterator</p>
</li>
</ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id976740"></a><h2>Notation</h2>
<div class="variablelist"><dl>
<dt><span class="term">Iter</span></dt>
<dd>A type playing the role of iterator-type in the <a href="BidirectionalIterator.html" title="Concept BidirectionalIterator">BidirectionalIterator</a> concept.</dd>
<dt>
<span class="term"><code class="varname">i</code>, </span><span class="term"><code class="varname">j</code></span>
</dt>
<dd>Objects of type Iter</dd>
<dt><span class="term"><code class="varname">x</code></span></dt>
<dd>Object of type value_type</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id976778"></a><h2>Type expressions</h2>
<div class="variablelist"><dl>
<dt><span class="term">Category tag</span></dt>
<dd><p><span class="type">category</span> must be
derived from <span class="type">std::bidirectional_iterator_tag</span>.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id976797"></a><h2>Valid expressions</h2>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Name</th>
<th>Expression</th>
<th>Type</th>
<th>Precondition</th>
<th>Semantics</th>
<th>Postcondition</th>
</tr></thead>
<tbody>
<tr>
<td><p>Predecrement</p></td>
<td><p>--i</p></td>
<td><p><span class="type">Iter &amp;</span></p></td>
<td><p><code class="computeroutput">i</code> is incrementable (not
off-the-end) and some dereferenceable iterator <code class="computeroutput">j</code> exists
such that <code class="computeroutput">i == ++j</code></p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td><p>Postdecrement</p></td>
<td><p>i--</p></td>
<td><p><span class="type">Iter</span></p></td>
<td><p>Same as for predecrement</p></td>
<td><p>Equivalent to <code class="computeroutput">{Iter j = i; --i; return j;}</code></p></td>
<td><p><code class="computeroutput">i</code> is dereferenceable or
off-the-end</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1" lang="en">
<a name="id976889"></a><h2>Complexity</h2>
<p>
All iterator operations must take amortized constant time.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id976896"></a><h2>Invariants</h2>
<div class="variablelist"><dl>
<dt><span class="term">Predecrement must return object</span></dt>
<dd><p><code class="computeroutput">&amp;i = &amp;(--i)</code></p></dd>
<dt><span class="term">Unique path through sequence</span></dt>
<dd><p><code class="computeroutput">i == j</code> implies <code class="computeroutput">--i == --j</code></p></dd>
<dt><span class="term">Increment and decrement are inverses</span></dt>
<dd><p><code class="computeroutput">++i; --i;</code> and <code class="computeroutput">--i; ++i;</code> must end up with the
value of <code class="computeroutput">i</code> unmodified, if <code class="computeroutput">i</code> both of the
operations in the pair are valid.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id976958"></a><h2>Models</h2>
<div class="itemizedlist"><ul type="disc">
<li><span class="simplelist"><span class="type">T *</span></span></li>
<li><span class="simplelist"><span class="type">std::list&lt;T&gt;::iterator</span></span></li>
</ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id976979"></a><h2>See also</h2>
<div class="itemizedlist"><ul type="disc"><li><p><a href="RandomAccessIterator.html" title="Concept RandomAccessIterator">RandomAccessIterator</a></p></li></ul></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"><small>Copyright © 2001, 2002 Indiana University<br>Copyright © 2000, 2001 University of Notre Dame du Lac<br>Copyright © 2000 Jeremy Siek, Lie-Quan Lee, Andrew Lumsdaine<br>Copyright © 1996-1999 Silicon Graphics Computer Systems, Inc.<br>Copyright © 1994 Hewlett-Packard Company</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="ForwardIterator.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="RandomAccessIterator.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

90
doc/html/CopyConstructible.html
View file

@ -1,10 +1,84 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="refresh" content="0; URL=http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/CopyConstructible.html">
</head>
<body>
Automatic redirection failed, please go to
<a href="http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/CopyConstructible.html">http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/CopyConstructible.html</a>
</body>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Concept CopyConstructible</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="concepts/reference.html" title="Concept reference">
<link rel="prev" href="DefaultConstructible.html" title="Concept DefaultConstructible">
<link rel="next" href="EqualityComparable.html" title="Concept EqualityComparable">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="DefaultConstructible.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="EqualityComparable.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="CopyConstructible"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Concept CopyConstructible</span></h2>
<p>CopyConstructible</p>
</div>
<div class="refsect1" lang="en">
<a name="id977733"></a><h2>Description</h2>
<p>Copy constructible types must be able to be constructed from another
member of the type.</p>
</div>
<div class="refsect1" lang="en">
<a name="id977740"></a><h2>Notation</h2>
<div class="variablelist"><dl>
<dt><span class="term">X</span></dt>
<dd>A type playing the role of copy-constructible-type in the <a href="CopyConstructible.html" title="Concept CopyConstructible">CopyConstructible</a> concept.</dd>
<dt>
<span class="term"><code class="varname">x</code>, </span><span class="term"><code class="varname">y</code></span>
</dt>
<dd>Objects of type X</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id977771"></a><h2>Valid expressions</h2>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Name</th>
<th>Expression</th>
<th>Type</th>
<th>Semantics</th>
</tr></thead>
<tbody><tr>
<td><p>Copy construction</p></td>
<td><p>X(x)</p></td>
<td><p><span class="type">X</span></p></td>
<td><p>Require copy constructor.</p></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1" lang="en">
<a name="id977808"></a><h2>Models</h2>
<div class="itemizedlist"><ul type="disc"><li><span class="simplelist"><span class="type">int</span></span></li></ul></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"><small>Copyright © 2001, 2002 Indiana University<br>Copyright © 2000, 2001 University of Notre Dame du Lac<br>Copyright © 2000 Jeremy Siek, Lie-Quan Lee, Andrew Lumsdaine<br>Copyright © 1996-1999 Silicon Graphics Computer Systems, Inc.<br>Copyright © 1994 Hewlett-Packard Company</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="DefaultConstructible.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="EqualityComparable.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

83
doc/html/DefaultConstructible.html Normal file
View file

@ -0,0 +1,83 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Concept DefaultConstructible</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="concepts/reference.html" title="Concept reference">
<link rel="prev" href="RandomAccessIterator.html" title="Concept RandomAccessIterator">
<link rel="next" href="CopyConstructible.html" title="Concept CopyConstructible">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="RandomAccessIterator.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="CopyConstructible.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="DefaultConstructible"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Concept DefaultConstructible</span></h2>
<p>DefaultConstructible</p>
</div>
<div class="refsect1" lang="en">
<a name="id977635"></a><h2>Description</h2>
<p>DefaultConstructible objects only need to have a default
constructor.</p>
</div>
<div class="refsect1" lang="en">
<a name="id977642"></a><h2>Notation</h2>
<div class="variablelist"><dl>
<dt><span class="term">X</span></dt>
<dd>A type playing the role of default-constructible-type in the <a href="DefaultConstructible.html" title="Concept DefaultConstructible">DefaultConstructible</a> concept.</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id977662"></a><h2>Valid expressions</h2>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Name</th>
<th>Expression</th>
<th>Type</th>
<th>Semantics</th>
</tr></thead>
<tbody><tr>
<td><p>Construction</p></td>
<td><p>X()</p></td>
<td><p><span class="type">X</span></p></td>
<td><p>Construct an instance of the type with default parameters.</p></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1" lang="en">
<a name="id977698"></a><h2>Models</h2>
<div class="itemizedlist"><ul type="disc">
<li><span class="simplelist"><span class="type">int</span></span></li>
<li><span class="simplelist"><span class="type">std::vector&lt;double&gt;</span></span></li>
</ul></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"><small>Copyright © 2001, 2002 Indiana University<br>Copyright © 2000, 2001 University of Notre Dame du Lac<br>Copyright © 2000 Jeremy Siek, Lie-Quan Lee, Andrew Lumsdaine<br>Copyright © 1996-1999 Silicon Graphics Computer Systems, Inc.<br>Copyright © 1994 Hewlett-Packard Company</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="RandomAccessIterator.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="CopyConstructible.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

91
doc/html/EqualityComparable.html Normal file
View file

@ -0,0 +1,91 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Concept EqualityComparable</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="concepts/reference.html" title="Concept reference">
<link rel="prev" href="CopyConstructible.html" title="Concept CopyConstructible">
<link rel="next" href="LessThanComparable.html" title="Concept LessThanComparable">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="CopyConstructible.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="LessThanComparable.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="EqualityComparable"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Concept EqualityComparable</span></h2>
<p>EqualityComparable</p>
</div>
<div class="refsect1" lang="en">
<a name="id977835"></a><h2>Description</h2>
<p>Equality Comparable types must have <code class="computeroutput">==</code> and
<code class="computeroutput">!=</code> operators.</p>
</div>
<div class="refsect1" lang="en">
<a name="id977852"></a><h2>Notation</h2>
<div class="variablelist"><dl>
<dt><span class="term">X</span></dt>
<dd>A type playing the role of comparable-type in the <a href="EqualityComparable.html" title="Concept EqualityComparable">EqualityComparable</a> concept.</dd>
<dt>
<span class="term"><code class="varname">x</code>, </span><span class="term"><code class="varname">y</code></span>
</dt>
<dd>Objects of type X</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id977883"></a><h2>Valid expressions</h2>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Name</th>
<th>Expression</th>
<th>Type</th>
</tr></thead>
<tbody>
<tr>
<td><p>Equality test</p></td>
<td><p>x == y</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
</tr>
<tr>
<td><p>Inequality test</p></td>
<td><p>x != y</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1" lang="en">
<a name="id977929"></a><h2>Models</h2>
<div class="itemizedlist"><ul type="disc">
<li><span class="simplelist"><span class="type">int</span></span></li>
<li><span class="simplelist"><span class="type">std::vector&lt;int&gt;</span></span></li>
</ul></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"><small>Copyright © 2001, 2002 Indiana University<br>Copyright © 2000, 2001 University of Notre Dame du Lac<br>Copyright © 2000 Jeremy Siek, Lie-Quan Lee, Andrew Lumsdaine<br>Copyright © 1996-1999 Silicon Graphics Computer Systems, Inc.<br>Copyright © 1994 Hewlett-Packard Company</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="CopyConstructible.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="LessThanComparable.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

58
doc/html/FinderConcept.html Normal file
View file

@ -0,0 +1,58 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Struct template FinderConcept</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="string_algo/reference.html#id907172" title="Header &lt;boost/algorithm/string/concept.hpp&gt;">
<link rel="prev" href="is_iequal.html" title="Struct is_iequal">
<link rel="next" href="FormatterConcept.html" title="Struct template FormatterConcept">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="is_iequal.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id907172"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="FormatterConcept.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="FinderConcept"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct template FinderConcept</span></h2>
<p>boost::algorithm::FinderConcept &#8212; Finder concept. </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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> FinderT, <span class="bold"><strong>typename</strong></span> IteratorT&gt;
<span class="bold"><strong>struct</strong></span> FinderConcept {
  <span class="emphasis"><em>// <a href="FinderConcept.html#id1000634-bb">public member functions</a></em></span>
  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="FinderConcept.html#id1069871-bb">constraints</a>() ;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1315117"></a><h2>Description</h2>
<p>Defines the Finder concept. Finder is a functor which selects an arbitrary part of a string. Search is performed on the range specified by starting and ending iterators.</p>
<p>Result of the find operation must be convertible to iterator_range. </p>
<div class="refsect2" lang="en">
<a name="id1315129"></a><h3>
<a name="id1000634-bb"></a><code class="computeroutput">FinderConcept</code> public member functions</h3>
<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id1069871-bb"></a>constraints() ;</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"><small>Copyright © 2002-2004 Pavol Droba</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="is_iequal.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id907172"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="FormatterConcept.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

58
doc/html/FormatterConcept.html Normal file
View file

@ -0,0 +1,58 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Struct template FormatterConcept</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="string_algo/reference.html#id907172" title="Header &lt;boost/algorithm/string/concept.hpp&gt;">
<link rel="prev" href="FinderConcept.html" title="Struct template FinderConcept">
<link rel="next" href="id1178955.html" title="Type token_compress_mode_type">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="FinderConcept.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id907172"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="id1178955.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="FormatterConcept"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct template FormatterConcept</span></h2>
<p>boost::algorithm::FormatterConcept &#8212; Formatter concept. </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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> FormatterT, <span class="bold"><strong>typename</strong></span> FinderT, <span class="bold"><strong>typename</strong></span> IteratorT&gt;
<span class="bold"><strong>struct</strong></span> FormatterConcept {
  <span class="emphasis"><em>// <a href="FormatterConcept.html#id801912-bb">public member functions</a></em></span>
  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="FormatterConcept.html#id768658-bb">constraints</a>() ;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1315246"></a><h2>Description</h2>
<p>Defines the Formatter concept. Formatter is a functor, which takes a result from a finder operation and transforms it in a specific way.</p>
<p>Result must be a container supported by container_traits, or a reference to it. </p>
<div class="refsect2" lang="en">
<a name="id1315257"></a><h3>
<a name="id801912-bb"></a><code class="computeroutput">FormatterConcept</code> public member functions</h3>
<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id768658-bb"></a>constraints() ;</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"><small>Copyright © 2002-2004 Pavol Droba</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="FinderConcept.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id907172"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="id1178955.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

182
doc/html/ForwardIterator.html Normal file
View file

@ -0,0 +1,182 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Concept ForwardIterator</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="concepts/reference.html" title="Concept reference">
<link rel="prev" href="OutputIterator.html" title="Concept OutputIterator">
<link rel="next" href="BidirectionalIterator.html" title="Concept BidirectionalIterator">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="OutputIterator.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BidirectionalIterator.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="ForwardIterator"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Concept ForwardIterator</span></h2>
<p>ForwardIterator</p>
</div>
<div class="refsect1" lang="en">
<a name="id976320"></a><h2>Description</h2>
<p>A forward iterator is an iterator that can read through a sequence of
values. It is multi-pass (old values of the iterator can be
re-used), and can be either mutable (data pointed to by it can be
changed) or not mutable.</p>
<p>An iterator represents a position in a sequence. Therefore, the
iterator can point into the sequence (returning a value when dereferenced
and being incrementable), or be off-the-end (and not dereferenceable or
incrementable).</p>
</div>
<div class="refsect1" lang="en">
<a name="id976335"></a><h2>Refinement of</h2>
<div class="itemizedlist"><ul type="disc">
<li><p><a href="InputIterator.html" title="Concept InputIterator">InputIterator</a></p></li>
<li><p><a href="OutputIterator.html" title="Concept OutputIterator">OutputIterator</a></p></li>
</ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id976355"></a><h2>Associated types</h2>
<div class="itemizedlist"><ul type="disc">
<li>
<p><span class="bold"><strong>value_type</strong></span></p>
<pre class="literallayout">std::iterator_traits&lt;Iter&gt;::value_type</pre>
<p>The value type of the iterator</p>
</li>
<li>
<p><span class="bold"><strong>category</strong></span></p>
<pre class="literallayout">std::iterator_traits&lt;Iter&gt;::iterator_category</pre>
<p>The category of the iterator</p>
</li>
</ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id976395"></a><h2>Notation</h2>
<div class="variablelist"><dl>
<dt><span class="term">Iter</span></dt>
<dd>A type playing the role of iterator-type in the <a href="ForwardIterator.html" title="Concept ForwardIterator">ForwardIterator</a> concept.</dd>
<dt>
<span class="term"><code class="varname">i</code>, </span><span class="term"><code class="varname">j</code></span>
</dt>
<dd>Objects of type Iter</dd>
<dt><span class="term"><code class="varname">x</code></span></dt>
<dd>Object of type value_type</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id976433"></a><h2>Type expressions</h2>
<div class="variablelist"><dl>
<dt><span class="term">Category tag</span></dt>
<dd><p><span class="type">category</span> must be
derived from <span class="type">std::forward_iterator_tag</span>.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id976452"></a><h2>Valid expressions</h2>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Name</th>
<th>Expression</th>
<th>Type</th>
<th>Precondition</th>
<th>Semantics</th>
<th>Postcondition</th>
</tr></thead>
<tbody>
<tr>
<td><p>Dereference</p></td>
<td><p>*i</p></td>
<td><p><span class="type">const-if-not-mutable value_type &amp;</span></p></td>
<td><p><code class="computeroutput">i</code> is incrementable (not
off-the-end)</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td><p>Member access</p></td>
<td><p>i-&gt;{member-name} (return type is pointer-to-object type)</p></td>
<td><p><span class="type">const-if-not-mutable value_type *</span></p></td>
<td><p><code class="computeroutput">i</code> is incrementable (not
off-the-end)</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td><p>Preincrement</p></td>
<td><p>++i</p></td>
<td><p><span class="type">Iter &amp;</span></p></td>
<td><p><code class="computeroutput">i</code> is incrementable (not
off-the-end)</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td><p>Postincrement</p></td>
<td><p>i++</p></td>
<td><p><span class="type">Iter</span></p></td>
<td><p><code class="computeroutput">i</code> is incrementable (not
off-the-end)</p></td>
<td><p>Equivalent to <code class="computeroutput">{Iter j = i; ++i; return j;}</code></p></td>
<td><p><code class="computeroutput">i</code> is dereferenceable or
off-the-end</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1" lang="en">
<a name="id976586"></a><h2>Complexity</h2>
<p>
All iterator operations must take amortized constant time.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id976593"></a><h2>Invariants</h2>
<div class="variablelist"><dl>
<dt><span class="term">Predecrement must return object</span></dt>
<dd><p><code class="computeroutput">&amp;i = &amp;(++i)</code></p></dd>
<dt><span class="term">Unique path through sequence</span></dt>
<dd><p><code class="computeroutput">i == j</code> implies <code class="computeroutput">++i == ++j</code></p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id976624"></a><h2>Models</h2>
<div class="itemizedlist"><ul type="disc">
<li><span class="simplelist"><span class="type">T *</span></span></li>
<li><span class="simplelist"><span class="type">std::hash_set&lt;T&gt;::iterator</span></span></li>
</ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id976644"></a><h2>See also</h2>
<div class="itemizedlist"><ul type="disc"><li><p><a href="BidirectionalIterator.html" title="Concept BidirectionalIterator">BidirectionalIterator</a></p></li></ul></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"><small>Copyright © 2001, 2002 Indiana University<br>Copyright © 2000, 2001 University of Notre Dame du Lac<br>Copyright © 2000 Jeremy Siek, Lie-Quan Lee, Andrew Lumsdaine<br>Copyright © 1996-1999 Silicon Graphics Computer Systems, Inc.<br>Copyright © 1994 Hewlett-Packard Company</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="OutputIterator.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BidirectionalIterator.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

190
doc/html/InputIterator.html Normal file
View file

@ -0,0 +1,190 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Concept InputIterator</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="concepts/reference.html" title="Concept reference">
<link rel="prev" href="Assignable.html" title="Concept Assignable">
<link rel="next" href="OutputIterator.html" title="Concept OutputIterator">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="Assignable.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="OutputIterator.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="InputIterator"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Concept InputIterator</span></h2>
<p>InputIterator</p>
</div>
<div class="refsect1" lang="en">
<a name="id975397"></a><h2>Description</h2>
<p>An input iterator is an iterator that can read through a sequence of
values. It is single-pass (old values of the iterator cannot be
re-used), and read-only.</p>
<p>An input iterator represents a position in a sequence. Therefore, the
iterator can point into the sequence (returning a value when dereferenced
and being incrementable), or be off-the-end (and not dereferenceable or
incrementable).</p>
</div>
<div class="refsect1" lang="en">
<a name="id975412"></a><h2>Refinement of</h2>
<div class="itemizedlist"><ul type="disc">
<li><p><a href="Assignable.html" title="Concept Assignable">Assignable</a></p></li>
<li><p><a href="DefaultConstructible.html" title="Concept DefaultConstructible">DefaultConstructible</a></p></li>
<li><p><a href="EqualityComparable.html" title="Concept EqualityComparable">EqualityComparable</a></p></li>
</ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id975441"></a><h2>Associated types</h2>
<div class="itemizedlist"><ul type="disc">
<li>
<p><span class="bold"><strong>value_type</strong></span></p>
<pre class="literallayout">std::iterator_traits&lt;Iter&gt;::value_type</pre>
<p>The value type of the iterator (not necessarily what
<code class="computeroutput">*i</code> returns)</p>
</li>
<li>
<p><span class="bold"><strong>difference_type</strong></span></p>
<pre class="literallayout">std::iterator_traits&lt;Iter&gt;::difference_type</pre>
<p>The difference type of the iterator</p>
</li>
<li>
<p><span class="bold"><strong>category</strong></span></p>
<pre class="literallayout">std::iterator_traits&lt;Iter&gt;::iterator_category</pre>
<p>The category of the iterator</p>
</li>
</ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id975504"></a><h2>Notation</h2>
<div class="variablelist"><dl>
<dt><span class="term">Iter</span></dt>
<dd>A type playing the role of iterator-type in the <a href="InputIterator.html" title="Concept InputIterator">InputIterator</a> concept.</dd>
<dt>
<span class="term"><code class="varname">i</code>, </span><span class="term"><code class="varname">j</code></span>
</dt>
<dd>Objects of type Iter</dd>
<dt><span class="term"><code class="varname">x</code></span></dt>
<dd>Object of type value_type</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id975542"></a><h2>Type expressions</h2>
<div class="variablelist"><dl>
<dt><span class="term">Category tag</span></dt>
<dd><p><span class="type">category</span> must be
derived from <span class="type">std::input_iterator_tag</span>, a model of <a href="DefaultConstructible.html" title="Concept DefaultConstructible">DefaultConstructible</a>, and a model of <a href="CopyConstructible.html" title="Concept CopyConstructible">CopyConstructible</a>.
</p></dd>
<dt><span class="term">Value type copy constructibility</span></dt>
<dd><p><span class="type">value_type</span> must be
a model of <a href="CopyConstructible.html" title="Concept CopyConstructible">CopyConstructible</a>.
</p></dd>
<dt><span class="term">Difference type properties</span></dt>
<dd><p><span class="type">difference_type</span> must be
a model of <a href="SignedInteger.html" title="Concept SignedInteger">SignedInteger</a>.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id975612"></a><h2>Valid expressions</h2>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Name</th>
<th>Expression</th>
<th>Type</th>
<th>Precondition</th>
<th>Semantics</th>
<th>Postcondition</th>
</tr></thead>
<tbody>
<tr>
<td><p>Dereference</p></td>
<td><p>*i</p></td>
<td><p>Convertible to <span class="type">value_type</span></p></td>
<td><p><code class="computeroutput">i</code> is incrementable (not
off-the-end)</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td><p>Preincrement</p></td>
<td><p>++i</p></td>
<td><p><span class="type">Iter &amp;</span></p></td>
<td><p><code class="computeroutput">i</code> is incrementable (not
off-the-end)</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td><p>Postincrement</p></td>
<td><p>i++</p></td>
<td><p></p></td>
<td><p><code class="computeroutput">i</code> is incrementable (not
off-the-end)</p></td>
<td><p>Equivalent to <code class="computeroutput">(void)(++i)</code></p></td>
<td><p><code class="computeroutput">i</code> is dereferenceable or
off-the-end</p></td>
</tr>
<tr>
<td><p>Postincrement and dereference</p></td>
<td><p>*i++</p></td>
<td><p>Convertible to <span class="type">value_type</span></p></td>
<td><p><code class="computeroutput">i</code> is incrementable (not
off-the-end)</p></td>
<td><p>Equivalent to <code class="computeroutput">{value_type t = *i; ++i; return t;}</code></p></td>
<td><p><code class="computeroutput">i</code> is dereferenceable or
off-the-end</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1" lang="en">
<a name="id975758"></a><h2>Complexity</h2>
<p>
All iterator operations must take amortized constant time.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id975765"></a><h2>Models</h2>
<div class="itemizedlist"><ul type="disc"><li><span class="simplelist"><span class="type">std::istream_iterator</span></span></li></ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id975777"></a><h2>See also</h2>
<div class="itemizedlist"><ul type="disc">
<li><p><a href="DefaultConstructible.html" title="Concept DefaultConstructible">DefaultConstructible</a></p></li>
<li><p><a href="EqualityComparable.html" title="Concept EqualityComparable">EqualityComparable</a></p></li>
<li><p><a href="ForwardIterator.html" title="Concept ForwardIterator">ForwardIterator</a></p></li>
<li><p><a href="OutputIterator.html" title="Concept OutputIterator">OutputIterator</a></p></li>
</ul></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"><small>Copyright © 2001, 2002 Indiana University<br>Copyright © 2000, 2001 University of Notre Dame du Lac<br>Copyright © 2000 Jeremy Siek, Lie-Quan Lee, Andrew Lumsdaine<br>Copyright © 1996-1999 Silicon Graphics Computer Systems, Inc.<br>Copyright © 1994 Hewlett-Packard Company</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="Assignable.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="OutputIterator.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

105
doc/html/LessThanComparable.html Normal file
View file

@ -0,0 +1,105 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Concept LessThanComparable</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="concepts/reference.html" title="Concept reference">
<link rel="prev" href="EqualityComparable.html" title="Concept EqualityComparable">
<link rel="next" href="SignedInteger.html" title="Concept SignedInteger">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="EqualityComparable.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="SignedInteger.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="LessThanComparable"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Concept LessThanComparable</span></h2>
<p>LessThanComparable</p>
</div>
<div class="refsect1" lang="en">
<a name="id977964"></a><h2>Description</h2>
<p>LessThanComparable types must have <code class="computeroutput">&lt;</code>,
<code class="computeroutput">&gt;</code>, <code class="computeroutput">&lt;=</code>, and <code class="computeroutput">&gt;=</code>
operators.</p>
</div>
<div class="refsect1" lang="en">
<a name="id977993"></a><h2>Notation</h2>
<div class="variablelist"><dl>
<dt><span class="term">X</span></dt>
<dd>A type playing the role of comparable-type in the <a href="LessThanComparable.html" title="Concept LessThanComparable">LessThanComparable</a> concept.</dd>
<dt>
<span class="term"><code class="varname">x</code>, </span><span class="term"><code class="varname">y</code></span>
</dt>
<dd>Objects of type X</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id978024"></a><h2>Valid expressions</h2>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Name</th>
<th>Expression</th>
<th>Type</th>
<th>Semantics</th>
</tr></thead>
<tbody>
<tr>
<td><p>Less than</p></td>
<td><p>x &lt; y</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
<td><p>Determine if one value is less than another.</p></td>
</tr>
<tr>
<td><p>Less than or equal</p></td>
<td><p>x &lt;= y</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
<td><p>Determine if one value is less than or equal to another.</p></td>
</tr>
<tr>
<td><p>Greater than</p></td>
<td><p>x &gt; y</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
<td><p>Determine if one value is greater than another.</p></td>
</tr>
<tr>
<td><p>Greater than or equal to</p></td>
<td><p>x &gt;= y</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
<td><p>Determine if one value is greater than or equal to another.</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1" lang="en">
<a name="id978117"></a><h2>Models</h2>
<div class="itemizedlist"><ul type="disc"><li><span class="simplelist"><span class="type">int</span></span></li></ul></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"><small>Copyright © 2001, 2002 Indiana University<br>Copyright © 2000, 2001 University of Notre Dame du Lac<br>Copyright © 2000 Jeremy Siek, Lie-Quan Lee, Andrew Lumsdaine<br>Copyright © 1996-1999 Silicon Graphics Computer Systems, Inc.<br>Copyright © 1994 Hewlett-Packard Company</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="EqualityComparable.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="SignedInteger.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

200
doc/html/OutputIterator.html Normal file
View file

@ -0,0 +1,200 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Concept OutputIterator</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="concepts/reference.html" title="Concept reference">
<link rel="prev" href="InputIterator.html" title="Concept InputIterator">
<link rel="next" href="ForwardIterator.html" title="Concept ForwardIterator">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="InputIterator.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="ForwardIterator.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="OutputIterator"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Concept OutputIterator</span></h2>
<p>OutputIterator</p>
</div>
<div class="refsect1" lang="en">
<a name="id975829"></a><h2>Description</h2>
<p>An output iterator is an iterator that can write a sequence of
values. It is single-pass (old values of the iterator cannot be
re-used), and write-only.</p>
<p>An output iterator represents a position in a (possibly infinite)
sequence. Therefore, the iterator can point into the sequence (returning
a value when dereferenced and being incrementable), or be off-the-end
(and not dereferenceable or incrementable).</p>
</div>
<div class="refsect1" lang="en">
<a name="id975844"></a><h2>Associated types</h2>
<div class="itemizedlist"><ul type="disc">
<li>
<p><span class="bold"><strong>value_type</strong></span></p>
<pre class="literallayout">std::iterator_traits&lt;Iter&gt;::value_type</pre>
<p>The stated value type of the iterator (should be
<code class="computeroutput">void</code> for an output iterator that does not model some other
iterator concept).</p>
</li>
<li>
<p><span class="bold"><strong>difference_type</strong></span></p>
<pre class="literallayout">std::iterator_traits&lt;Iter&gt;::difference_type</pre>
<p>The difference type of the iterator</p>
</li>
<li>
<p><span class="bold"><strong>category</strong></span></p>
<pre class="literallayout">std::iterator_traits&lt;Iter&gt;::iterator_category</pre>
<p>The category of the iterator</p>
</li>
</ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id975908"></a><h2>Notation</h2>
<div class="variablelist"><dl>
<dt><span class="term">Iter</span></dt>
<dd>A type playing the role of iterator-type in the <a href="OutputIterator.html" title="Concept OutputIterator">OutputIterator</a> concept.</dd>
<dt><span class="term">ValueType</span></dt>
<dd>A type playing the role of value-type in the <a href="OutputIterator.html" title="Concept OutputIterator">OutputIterator</a> concept.</dd>
<dt>
<span class="term"><code class="varname">i</code>, </span><span class="term"><code class="varname">j</code></span>
</dt>
<dd>Objects of type Iter</dd>
<dt><span class="term"><code class="varname">x</code></span></dt>
<dd>Object of type ValueType</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id975960"></a><h2>Type expressions</h2>
<div class="variablelist"><dl>
<dt><span class="term"></span></dt>
<dd><p>The type <span class="type">Iter</span> must be a model of <a href="Assignable.html" title="Concept Assignable">Assignable</a>.</p></dd>
<dt><span class="term"></span></dt>
<dd><p>The type <span class="type">ValueType</span> must be a model of <a href="Assignable.html" title="Concept Assignable">Assignable</a>.</p></dd>
<dt><span class="term"></span></dt>
<dd><p>The type <span class="type">Iter</span> must be a model of <a href="DefaultConstructible.html" title="Concept DefaultConstructible">DefaultConstructible</a>.</p></dd>
<dt><span class="term"></span></dt>
<dd><p>The type <span class="type">Iter</span> must be a model of
<a href="EqualityComparable.html" title="Concept EqualityComparable">EqualityComparable</a>.</p></dd>
<dt><span class="term">Category tag</span></dt>
<dd><p><span class="type">category</span> must be
derived from <span class="type">std::output_iterator_tag</span>, a model of <a href="DefaultConstructible.html" title="Concept DefaultConstructible">DefaultConstructible</a>, and a model of <a href="CopyConstructible.html" title="Concept CopyConstructible">CopyConstructible</a>.
</p></dd>
<dt><span class="term">Difference type properties</span></dt>
<dd><p><span class="type">difference_type</span> must be
a model of <a href="SignedInteger.html" title="Concept SignedInteger">SignedInteger</a>.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id976078"></a><h2>Valid expressions</h2>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Name</th>
<th>Expression</th>
<th>Type</th>
<th>Precondition</th>
<th>Semantics</th>
<th>Postcondition</th>
</tr></thead>
<tbody>
<tr>
<td><p>Dereference</p></td>
<td><p>*i</p></td>
<td><p></p></td>
<td><p><code class="computeroutput">i</code> is incrementable (not
off-the-end)</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td><p>Dereference and assign</p></td>
<td><p>*i = x</p></td>
<td><p></p></td>
<td><p><code class="computeroutput">i</code> is incrementable (not
off-the-end)</p></td>
<td> </td>
<td><p><code class="computeroutput">*i</code> may not be written to again until it has
been incremented.</p></td>
</tr>
<tr>
<td><p>Preincrement</p></td>
<td><p>++i</p></td>
<td><p><span class="type">Iter &amp;</span></p></td>
<td><p><code class="computeroutput">i</code> is incrementable (not
off-the-end)</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td><p>Postincrement</p></td>
<td><p>i++</p></td>
<td><p></p></td>
<td><p><code class="computeroutput">i</code> is incrementable (not
off-the-end)</p></td>
<td><p>Equivalent to <code class="computeroutput">(void)(++i)</code></p></td>
<td><p><code class="computeroutput">i</code> is dereferenceable or
off-the-end</p></td>
</tr>
<tr>
<td><p>Postincrement, dereference, and assign</p></td>
<td><p>*i++ = x</p></td>
<td><p></p></td>
<td><p><code class="computeroutput">i</code> is incrementable (not
off-the-end)</p></td>
<td><p>Equivalent to <code class="computeroutput">{*i = t; ++i;}</code></p></td>
<td><p><code class="computeroutput">i</code> is dereferenceable or
off-the-end</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1" lang="en">
<a name="id976245"></a><h2>Complexity</h2>
<p>
All iterator operations must take amortized constant time.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id976252"></a><h2>Models</h2>
<div class="itemizedlist"><ul type="disc">
<li><span class="simplelist"><span class="type">std::ostream_iterator</span>, <span class="type">...</span></span></li>
<li><span class="simplelist"><span class="type">std::insert_iterator</span>, <span class="type">...</span></span></li>
<li><span class="simplelist"><span class="type">std::front_insert_iterator</span>, <span class="type">...</span></span></li>
<li><span class="simplelist"><span class="type">std::back_insert_iterator</span>, <span class="type">...</span></span></li>
</ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id976301"></a><h2>See also</h2>
<div class="itemizedlist"><ul type="disc"></ul></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"><small>Copyright © 2001, 2002 Indiana University<br>Copyright © 2000, 2001 University of Notre Dame du Lac<br>Copyright © 2000 Jeremy Siek, Lie-Quan Lee, Andrew Lumsdaine<br>Copyright © 1996-1999 Silicon Graphics Computer Systems, Inc.<br>Copyright © 1994 Hewlett-Packard Company</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="InputIterator.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="ForwardIterator.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

230
doc/html/RandomAccessIterator.html Normal file
View file

@ -0,0 +1,230 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Concept RandomAccessIterator</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="concepts/reference.html" title="Concept reference">
<link rel="prev" href="BidirectionalIterator.html" title="Concept BidirectionalIterator">
<link rel="next" href="DefaultConstructible.html" title="Concept DefaultConstructible">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="BidirectionalIterator.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="DefaultConstructible.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="RandomAccessIterator"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Concept RandomAccessIterator</span></h2>
<p>RandomAccessIterator</p>
</div>
<div class="refsect1" lang="en">
<a name="id977006"></a><h2>Description</h2>
<p>A random access iterator is an iterator that can read through
a sequence of values. It can move in either direction through the
sequence (by any amount in constant time), and can be either mutable
(data pointed to by it can be changed) or not mutable.</p>
<p>An iterator represents a position in a sequence. Therefore,
the iterator can point into the sequence (returning a value when
dereferenced and being incrementable), or be off-the-end (and not
dereferenceable or incrementable).</p>
</div>
<div class="refsect1" lang="en">
<a name="id977022"></a><h2>Refinement of</h2>
<div class="itemizedlist"><ul type="disc">
<li><p><a href="BidirectionalIterator.html" title="Concept BidirectionalIterator">BidirectionalIterator</a></p></li>
<li><p><a href="LessThanComparable.html" title="Concept LessThanComparable">LessThanComparable</a></p></li>
</ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id977044"></a><h2>Associated types</h2>
<div class="itemizedlist"><ul type="disc">
<li>
<p><span class="bold"><strong>value_type</strong></span></p>
<pre class="literallayout">std::iterator_traits&lt;Iter&gt;::value_type</pre>
<p>The value type of the iterator</p>
</li>
<li>
<p><span class="bold"><strong>category</strong></span></p>
<pre class="literallayout">std::iterator_traits&lt;Iter&gt;::iterator_category</pre>
<p>The category of the iterator</p>
</li>
<li>
<p><span class="bold"><strong>difference_type</strong></span></p>
<pre class="literallayout">std::iterator_traits&lt;Iter&gt;::difference_type</pre>
<p>The difference type of the iterator (measure of the number
of steps between two iterators)</p>
</li>
</ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id977101"></a><h2>Notation</h2>
<div class="variablelist"><dl>
<dt><span class="term">Iter</span></dt>
<dd>A type playing the role of iterator-type in the <a href="RandomAccessIterator.html" title="Concept RandomAccessIterator">RandomAccessIterator</a> concept.</dd>
<dt>
<span class="term"><code class="varname">i</code>, </span><span class="term"><code class="varname">j</code></span>
</dt>
<dd>Objects of type Iter</dd>
<dt><span class="term"><code class="varname">x</code></span></dt>
<dd>Object of type value_type</dd>
<dt><span class="term"><code class="varname">n</code></span></dt>
<dd>Object of type difference_type</dd>
<dt><span class="term"><code class="varname">int_off</code></span></dt>
<dd>Object of type int</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id977156"></a><h2>Type expressions</h2>
<div class="variablelist"><dl>
<dt><span class="term">Category tag</span></dt>
<dd><p><span class="type">category</span> must be
derived from <span class="type">std::random_access_iterator_tag</span>.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id977175"></a><h2>Valid expressions</h2>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Name</th>
<th>Expression</th>
<th>Type</th>
<th>Semantics</th>
</tr></thead>
<tbody>
<tr>
<td><p>Motion</p></td>
<td><p>i += n</p></td>
<td><p><span class="type">Iter &amp;</span></p></td>
<td><p>Equivalent to applying <code class="computeroutput">i++</code><code class="computeroutput">n</code> times
if <code class="computeroutput">n</code> is positive, applying <code class="computeroutput">i--</code><code class="computeroutput">-n</code> times if <code class="computeroutput">n</code> is negative, and to a null
operation if <code class="computeroutput">n</code> is zero.</p></td>
</tr>
<tr>
<td><p>Motion (with integer offset)</p></td>
<td><p>i += int_off</p></td>
<td><p><span class="type">Iter &amp;</span></p></td>
<td><p>Equivalent to applying <code class="computeroutput">i++</code><code class="computeroutput">n</code> times
if <code class="computeroutput">n</code> is positive, applying <code class="computeroutput">i--</code><code class="computeroutput">-n</code> times if <code class="computeroutput">n</code> is negative, and to a null
operation if <code class="computeroutput">n</code> is zero.</p></td>
</tr>
<tr>
<td><p>Subtractive motion</p></td>
<td><p>i -= n</p></td>
<td><p><span class="type">Iter &amp;</span></p></td>
<td><p>Equivalent to <code class="computeroutput">i+=(-n)</code></p></td>
</tr>
<tr>
<td><p>Subtractive motion (with integer offset)</p></td>
<td><p>i -= int_off</p></td>
<td><p><span class="type">Iter &amp;</span></p></td>
<td><p>Equivalent to <code class="computeroutput">i+=(-n)</code></p></td>
</tr>
<tr>
<td><p>Addition</p></td>
<td><p>i + n</p></td>
<td><p><span class="type">Iter</span></p></td>
<td><p>Equivalent to <code class="computeroutput">{Iter j = i; j += n; return j;}</code></p></td>
</tr>
<tr>
<td><p>Addition with integer</p></td>
<td><p>i + int_off</p></td>
<td><p><span class="type">Iter</span></p></td>
<td><p>Equivalent to <code class="computeroutput">{Iter j = i; j += n; return j;}</code></p></td>
</tr>
<tr>
<td><p>Addition (count first)</p></td>
<td><p>n + i</p></td>
<td><p><span class="type">Iter</span></p></td>
<td><p>Equivalent to <code class="computeroutput">i + n</code></p></td>
</tr>
<tr>
<td><p>Addition with integer (count first)</p></td>
<td><p>int_off + i</p></td>
<td><p><span class="type">Iter</span></p></td>
<td><p>Equivalent to <code class="computeroutput">i + n</code></p></td>
</tr>
<tr>
<td><p>Subtraction</p></td>
<td><p>i - n</p></td>
<td><p><span class="type">Iter</span></p></td>
<td><p>Equivalent to <code class="computeroutput">i + (-n)</code></p></td>
</tr>
<tr>
<td><p>Subtraction with integer</p></td>
<td><p>i - int_off</p></td>
<td><p><span class="type">Iter</span></p></td>
<td><p>Equivalent to <code class="computeroutput">i + (-n)</code></p></td>
</tr>
<tr>
<td><p>Distance</p></td>
<td><p>i - j</p></td>
<td><p><span class="type">difference_type</span></p></td>
<td><p>The number of times <code class="computeroutput">i</code> must be incremented (or
decremented if the result is negative) to reach <code class="computeroutput">j</code>. Not
defined if <code class="computeroutput">j</code> is not reachable from
<code class="computeroutput">i</code>.</p></td>
</tr>
<tr>
<td><p>Element access</p></td>
<td><p>i[n]</p></td>
<td><p><span class="type">const-if-not-mutable value_type &amp;</span></p></td>
<td><p>Equivalent to <code class="computeroutput">*(i + n)</code></p></td>
</tr>
<tr>
<td><p>Element access with integer index</p></td>
<td><p>i[int_off]</p></td>
<td><p><span class="type">const-if-not-mutable value_type &amp;</span></p></td>
<td><p>Equivalent to <code class="computeroutput">*(i + n)</code></p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1" lang="en">
<a name="id977554"></a><h2>Complexity</h2>
<p>
All iterator operations must take amortized constant time.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id977561"></a><h2>Models</h2>
<div class="itemizedlist"><ul type="disc">
<li><span class="simplelist"><span class="type">T *</span></span></li>
<li><span class="simplelist"><span class="type">std::vector&lt;T&gt;::iterator</span></span></li>
<li><span class="simplelist"><span class="type">std::vector&lt;T&gt;::const_iterator</span></span></li>
<li><span class="simplelist"><span class="type">std::deque&lt;T&gt;::iterator</span></span></li>
<li><span class="simplelist"><span class="type">std::deque&lt;T&gt;::const_iterator</span></span></li>
</ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id977608"></a><h2>See also</h2>
<div class="itemizedlist"><ul type="disc"><li><p><a href="LessThanComparable.html" title="Concept LessThanComparable">LessThanComparable</a></p></li></ul></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"><small>Copyright © 2001, 2002 Indiana University<br>Copyright © 2000, 2001 University of Notre Dame du Lac<br>Copyright © 2000 Jeremy Siek, Lie-Quan Lee, Andrew Lumsdaine<br>Copyright © 1996-1999 Silicon Graphics Computer Systems, Inc.<br>Copyright © 1994 Hewlett-Packard Company</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="BidirectionalIterator.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="DefaultConstructible.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

256
doc/html/SignedInteger.html Normal file
View file

@ -0,0 +1,256 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Concept SignedInteger</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="concepts/reference.html" title="Concept reference">
<link rel="prev" href="LessThanComparable.html" title="Concept LessThanComparable">
<link rel="next" href="date_time.html" title="Chapter 3. Boost.Date_Time">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="LessThanComparable.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="date_time.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="SignedInteger"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Concept SignedInteger</span></h2>
<p>SignedInteger</p>
</div>
<div class="refsect1" lang="en">
<a name="id978143"></a><h2>Refinement of</h2>
<div class="itemizedlist"><ul type="disc">
<li><p><a href="CopyConstructible.html" title="Concept CopyConstructible">CopyConstructible</a></p></li>
<li><p><a href="Assignable.html" title="Concept Assignable">Assignable</a></p></li>
<li><p><a href="DefaultConstructible.html" title="Concept DefaultConstructible">DefaultConstructible</a></p></li>
<li><p><a href="EqualityComparable.html" title="Concept EqualityComparable">EqualityComparable</a></p></li>
<li><p><a href="LessThanComparable.html" title="Concept LessThanComparable">LessThanComparable</a></p></li>
</ul></div>
</div>
<div class="refsect1" lang="en">
<a name="id978189"></a><h2>Notation</h2>
<div class="variablelist"><dl>
<dt><span class="term">T</span></dt>
<dd>A type playing the role of integral-type in the <a href="SignedInteger.html" title="Concept SignedInteger">SignedInteger</a> concept.</dd>
<dt>
<span class="term"><code class="varname">x</code>, </span><span class="term"><code class="varname">y</code>, </span><span class="term"><code class="varname">z</code></span>
</dt>
<dd>Objects of type T</dd>
<dt>
<span class="term"><code class="varname">a</code>, </span><span class="term"><code class="varname">b</code></span>
</dt>
<dd>Objects of type int</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id978234"></a><h2>Type expressions</h2>
<div class="variablelist"><dl>
<dt><span class="term">Conversion to int</span></dt>
<dd><p><span class="type">T</span> must be
convertible to <span class="type">int</span>.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id978253"></a><h2>Valid expressions</h2>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Name</th>
<th>Expression</th>
<th>Type</th>
</tr></thead>
<tbody>
<tr>
<td><p>Conversion from int</p></td>
<td><p>T(a)</p></td>
<td><p><span class="type">T</span></p></td>
</tr>
<tr>
<td><p>Preincrement</p></td>
<td><p>++x</p></td>
<td><p><span class="type">T &amp;</span></p></td>
</tr>
<tr>
<td><p>Predecrement</p></td>
<td><p>--x</p></td>
<td><p><span class="type">T &amp;</span></p></td>
</tr>
<tr>
<td><p>Postincrement</p></td>
<td><p>x++</p></td>
<td><p><span class="type">T</span></p></td>
</tr>
<tr>
<td><p>Postdecrement</p></td>
<td><p>x--</p></td>
<td><p><span class="type">T</span></p></td>
</tr>
<tr>
<td><p>Sum</p></td>
<td><p>x + y</p></td>
<td><p><span class="type">T</span></p></td>
</tr>
<tr>
<td><p>Sum with int</p></td>
<td><p>x + a</p></td>
<td><p><span class="type">T</span></p></td>
</tr>
<tr>
<td><p>Sum-assignment</p></td>
<td><p>x += y</p></td>
<td><p><span class="type">T &amp;</span></p></td>
</tr>
<tr>
<td><p>Sum-assignment with int</p></td>
<td><p>x += a</p></td>
<td><p><span class="type">T &amp;</span></p></td>
</tr>
<tr>
<td><p>Difference</p></td>
<td><p>x - y</p></td>
<td><p><span class="type">T</span></p></td>
</tr>
<tr>
<td><p>Difference with int</p></td>
<td><p>x - a</p></td>
<td><p><span class="type">T</span></p></td>
</tr>
<tr>
<td><p>Product</p></td>
<td><p>x * y</p></td>
<td><p><span class="type">T</span></p></td>
</tr>
<tr>
<td><p>Product with int</p></td>
<td><p>x * a</p></td>
<td><p><span class="type">T</span></p></td>
</tr>
<tr>
<td><p>Product-assignment with int</p></td>
<td><p>x *= a</p></td>
<td><p><span class="type">T &amp;</span></p></td>
</tr>
<tr>
<td><p>Product with int on left</p></td>
<td><p>a * x</p></td>
<td><p><span class="type">T</span></p></td>
</tr>
<tr>
<td><p>Quotient</p></td>
<td><p>x / y</p></td>
<td><p><span class="type">T</span></p></td>
</tr>
<tr>
<td><p>Quotient with int</p></td>
<td><p>x / a</p></td>
<td><p><span class="type">T</span></p></td>
</tr>
<tr>
<td><p>Right-shift</p></td>
<td><p>x &gt;&gt; y</p></td>
<td><p><span class="type">T</span></p></td>
</tr>
<tr>
<td><p>Right-shift with int</p></td>
<td><p>x &gt;&gt; a</p></td>
<td><p><span class="type">T</span></p></td>
</tr>
<tr>
<td><p>Right-shift-assignment with int</p></td>
<td><p>x &gt;&gt;= a</p></td>
<td><p><span class="type">T &amp;</span></p></td>
</tr>
<tr>
<td><p>Less-than comparison</p></td>
<td><p>x &lt; y</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
</tr>
<tr>
<td><p>Less-than comparison with int</p></td>
<td><p>x &lt; a</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
</tr>
<tr>
<td><p>Less-than comparison with size_t</p></td>
<td><p>x &lt; boost::sample_value &lt; std::size_t &gt;()</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
</tr>
<tr>
<td><p>Greater-than comparison</p></td>
<td><p>x &gt; y</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
</tr>
<tr>
<td><p>Greater-than comparison with int</p></td>
<td><p>x &gt; a</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
</tr>
<tr>
<td><p>Less-than-or-equal comparison</p></td>
<td><p>x &lt;= y</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
</tr>
<tr>
<td><p>Less-than-or-equal comparison with int</p></td>
<td><p>x &lt;= a</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
</tr>
<tr>
<td><p>Greater-than-or-equal comparison</p></td>
<td><p>x &gt;= y</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
</tr>
<tr>
<td><p>Greater-than-or-equal comparison with int</p></td>
<td><p>x &gt;= a</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
</tr>
<tr>
<td><p>Greater-than-or-equal comparison with int on left</p></td>
<td><p>a &gt;= x</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
</tr>
<tr>
<td><p>Equality comparison</p></td>
<td><p>x == y</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
</tr>
<tr>
<td><p>Equality comparison with int</p></td>
<td><p>x == a</p></td>
<td><p>Convertible to <span class="type">bool</span></p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1" lang="en">
<a name="id996168"></a><h2>See also</h2>
<div class="itemizedlist"><ul type="disc"></ul></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"><small>Copyright © 2001, 2002 Indiana University<br>Copyright © 2000, 2001 University of Notre Dame du Lac<br>Copyright © 2000 Jeremy Siek, Lie-Quan Lee, Andrew Lumsdaine<br>Copyright © 1996-1999 Silicon Graphics Computer Systems, Inc.<br>Copyright © 1994 Hewlett-Packard Company</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="LessThanComparable.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts/reference.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="date_time.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

107
doc/html/abstract_variables_map.html Normal file
View file

@ -0,0 +1,107 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class abstract_variables_map</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="program_options/reference.html#id872805" title="Header &lt;boost/program_options/variables_map.hpp&gt;">
<link rel="prev" href="bool_switch.html" title="Function bool_switch">
<link rel="next" href="variable_value.html" title="Class variable_value">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="bool_switch.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id872805"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="variable_value.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="abstract_variables_map"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class abstract_variables_map</span></h2>
<p>boost::program_options::abstract_variables_map &#8212; </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="bold"><strong>class</strong></span> abstract_variables_map {
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// <a href="abstract_variables_map.html#abstract_variables_mapconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="abstract_variables_map.html#id1115586-bb">abstract_variables_map</a>();
  <a href="abstract_variables_map.html#id1115588-bb">abstract_variables_map</a>(<span class="bold"><strong>const</strong></span> <a href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> *);
  <a href="abstract_variables_map.html#id1118289-bb">~abstract_variables_map</a>();
  <span class="emphasis"><em>// <a href="abstract_variables_map.html#id1136283-bb">public member functions</a></em></span>
  <span class="type"><span class="bold"><strong>const</strong></span> <a href="variable_value.html" title="Class variable_value">variable_value</a> &amp;</span> <a href="abstract_variables_map.html#id1136288-bb"><span class="bold"><strong>operator</strong></span>[]</a>(<span class="bold"><strong>const</strong></span> std::string &amp;) <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="abstract_variables_map.html#id1115549-bb">next</a>(<a href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> *) ;
  <span class="emphasis"><em>// <a href="abstract_variables_map.html#id1118292-bb">private member functions</a></em></span>
  <span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>const</strong></span> <a href="variable_value.html" title="Class variable_value">variable_value</a> &amp;</span> <a href="abstract_variables_map.html#id1118297-bb">get</a>(<span class="bold"><strong>const</strong></span> std::string &amp;) <span class="bold"><strong>const</strong></span>;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1277263"></a><h2>Description</h2>
<p>Implements string-&gt;string mapping with convenient value casting facilities. </p>
<div class="refsect2" lang="en">
<a name="id1277273"></a><h3>
<a name="abstract_variables_mapconstruct-copy-destruct"></a><code class="computeroutput">abstract_variables_map</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><a name="id1115586-bb"></a>abstract_variables_map();</pre></li>
<li><pre class="literallayout"><a name="id1115588-bb"></a>abstract_variables_map(<span class="bold"><strong>const</strong></span> <a href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> * next);</pre></li>
<li><pre class="literallayout"><a name="id1118289-bb"></a>~abstract_variables_map();</pre></li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1277346"></a><h3>
<a name="id1136283-bb"></a><code class="computeroutput">abstract_variables_map</code> public member functions</h3>
<div class="orderedlist"><ol type="1">
<li>
<pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <a href="variable_value.html" title="Class variable_value">variable_value</a> &amp;</span> <a name="id1136288-bb"></a><span class="bold"><strong>operator</strong></span>[](<span class="bold"><strong>const</strong></span> std::string &amp; name) <span class="bold"><strong>const</strong></span>;</pre>
<p>Obtains the value of variable 'name', from *this and possibly from the chain of variable maps.</p>
<div class="itemizedlist"><ul type="disc"><li>
<p>if there's no value in *this.</p>
<div class="itemizedlist"><ul type="circle">
<li><p>if there's next variable map, returns value from it</p></li>
<li><p>otherwise, returns empty value</p></li>
</ul></div>
</li></ul></div>
<div class="itemizedlist"><ul type="disc"><li>
<p>if there's defaulted value</p>
<div class="itemizedlist"><ul type="circle">
<li><p>if there's next varaible map, which has a non-defauled value, return that</p></li>
<li><p>otherwise, return value from *this</p></li>
</ul></div>
</li></ul></div>
<div class="itemizedlist"><ul type="disc"><li><p>if there's a non-defauled value, returns it. </p></li></ul></div>
</li>
<li>
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id1115549-bb"></a>next(<a href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> * next) ;</pre>
<p>Sets next variable map, which will be used to find variables not found in *this. </p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1277481"></a><h3>
<a name="id1118292-bb"></a><code class="computeroutput">abstract_variables_map</code> private member functions</h3>
<div class="orderedlist"><ol type="1"><li>
<pre class="literallayout"><span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>const</strong></span> <a href="variable_value.html" title="Class variable_value">variable_value</a> &amp;</span> <a name="id1118297-bb"></a>get(<span class="bold"><strong>const</strong></span> std::string &amp; name) <span class="bold"><strong>const</strong></span>;</pre>
<p>Returns value of variable 'name' stored in *this, or empty value otherwise. </p>
</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"><small>Copyright © 2002-2004 Vladimir Prus</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="bool_switch.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id872805"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="variable_value.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

75
doc/html/acst_dst_trait.html Normal file
View file

@ -0,0 +1,75 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Struct template acst_dst_trait</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="date_time/doxy.html#id941196" title="Header &lt;boost/date_time/local_timezone_defs.hpp&gt;">
<link rel="prev" href="uk_dst_trait.html" title="Struct template uk_dst_trait">
<link rel="next" href="microsec_clock.html" title="Class template microsec_clock">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="uk_dst_trait.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id941196"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="microsec_clock.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="acst_dst_trait"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct template acst_dst_trait</span></h2>
<p>boost::date_time::acst_dst_trait &#8212; </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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> date_type&gt;
<span class="bold"><strong>struct</strong></span> acst_dst_trait {
  <span class="emphasis"><em>// types</em></span>
  <span class="bold"><strong>typedef</strong></span> date_type::day_of_week_type                day_of_week_type;  
  <span class="bold"><strong>typedef</strong></span> date_type::month_type                      month_type;        
  <span class="bold"><strong>typedef</strong></span> <a href="last_kday_of_month.html" title="Class template last_kday_of_month">date_time::last_kday_of_month</a>&lt; date_type &gt; start_rule_functor;
  <span class="bold"><strong>typedef</strong></span> <a href="last_kday_of_month.html" title="Class template last_kday_of_month">date_time::last_kday_of_month</a>&lt; date_type &gt; end_rule_functor;  
  <span class="emphasis"><em>// <a href="acst_dst_trait.html#id825387-bb">public static functions</a></em></span>
  <span class="type">day_of_week_type</span> <a href="acst_dst_trait.html#id825392-bb">start_day</a>() ;
  <span class="type">month_type</span> <a href="acst_dst_trait.html#id1107969-bb">start_month</a>() ;
  <span class="type">day_of_week_type</span> <a href="acst_dst_trait.html#id893157-bb">end_day</a>() ;
  <span class="type">month_type</span> <a href="acst_dst_trait.html#id936154-bb">end_month</a>() ;
  <span class="type"><span class="bold"><strong>int</strong></span></span> <a href="acst_dst_trait.html#id936167-bb">dst_start_offset_minutes</a>() ;
  <span class="type"><span class="bold"><strong>int</strong></span></span> <a href="acst_dst_trait.html#id832605-bb">dst_end_offset_minutes</a>() ;
  <span class="type"><span class="bold"><strong>int</strong></span></span> <a href="acst_dst_trait.html#id966084-bb">dst_shift_length_minutes</a>() ;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1110273"></a><h2>Description</h2>
<div class="refsect2" lang="en">
<a name="id1110276"></a><h3>
<a name="id825387-bb"></a><code class="computeroutput">acst_dst_trait</code> public static functions</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><span class="type">day_of_week_type</span> <a name="id825392-bb"></a>start_day() ;</pre></li>
<li><pre class="literallayout"><span class="type">month_type</span> <a name="id1107969-bb"></a>start_month() ;</pre></li>
<li><pre class="literallayout"><span class="type">day_of_week_type</span> <a name="id893157-bb"></a>end_day() ;</pre></li>
<li><pre class="literallayout"><span class="type">month_type</span> <a name="id936154-bb"></a>end_month() ;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>int</strong></span></span> <a name="id936167-bb"></a>dst_start_offset_minutes() ;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>int</strong></span></span> <a name="id832605-bb"></a>dst_end_offset_minutes() ;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>int</strong></span></span> <a name="id966084-bb"></a>dst_shift_length_minutes() ;</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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="uk_dst_trait.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id941196"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="microsec_clock.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

64
doc/html/all.html Normal file
View file

@ -0,0 +1,64 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Function template all</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="string_algo/reference.html#id1144873" title="Header &lt;boost/algorithm/string/predicate.hpp&gt;">
<link rel="prev" href="iequals.html" title="Function template iequals">
<link rel="next" href="find_regex.html" title="Function template find_regex">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="iequals.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id1144873"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="find_regex.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="all"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Function template all</span></h2>
<p>boost::algorithm::all &#8212; 'All' predicate </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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> RangeT, <span class="bold"><strong>typename</strong></span> PredicateT&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> all(<span class="bold"><strong>const</strong></span> RangeT &amp; Input, PredicateT Pred);</pre></div>
<div class="refsect1" lang="en">
<a name="id1327677"></a><h2>Description</h2>
<p>This predicate holds it all its elements satisfy a given condition, represented by the predicate.</p>
<p></p>
<div class="variablelist">
<p class="title"><b>Parameters</b></p>
<dl>
<dt><span class="term">Input</span></dt>
<dd><p>An input sequence </p></dd>
<dt><span class="term">Pred</span></dt>
<dd><p>A predicate </p></dd>
</dl>
</div>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
The result of the test<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Notes</span></b>:
This function provides the strong exception-safety guarantee </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"><small>Copyright © 2002-2004 Pavol Droba</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="iequals.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id1144873"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="find_regex.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

120
doc/html/all_date_names_put.html Normal file
View file

@ -0,0 +1,120 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class template all_date_names_put</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="date_time/doxy.html#id1072331" title="Header &lt;boost/date_time/date_names_put.hpp&gt;">
<link rel="prev" href="date_names_put.html" title="Class template date_names_put">
<link rel="next" href="dst_calculator.html" title="Class template dst_calculator">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="date_names_put.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id1072331"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="dst_calculator.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="all_date_names_put"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template all_date_names_put</span></h2>
<p>boost::date_time::all_date_names_put &#8212; A date name output facet that takes an array of char* to define strings. </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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Config, <span class="bold"><strong>typename</strong></span> charT = <span class="bold"><strong>char</strong></span>,
         <span class="bold"><strong>typename</strong></span> <a href="OutputIterator.html" title="Concept OutputIterator">OutputIterator</a> = std::ostreambuf_iterator&lt;charT&gt; &gt;
<span class="bold"><strong>class</strong></span> all_date_names_put : <span class="bold"><strong>public</strong></span> boost::date_time::date_names_put&lt; Config, charT, OutputIterator &gt;
{
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// types</em></span>
  <span class="bold"><strong>typedef</strong></span> OutputIterator             iter_type;         
  <span class="bold"><strong>typedef</strong></span> Config::month_enum         month_enum;        
  <span class="bold"><strong>typedef</strong></span> Config::weekday_enum       weekday_enum;      
  <span class="bold"><strong>typedef</strong></span> Config::special_value_enum special_value_enum;
  <span class="emphasis"><em>// <a href="all_date_names_put.html#all_date_names_putconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="all_date_names_put.html#id936796-bb">all_date_names_put</a>(<span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span>, <span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span>,
                     <span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span>, <span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span>,
                     <span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span>, charT = '-',
                     ymd_order_spec = ymd_order_iso,
                     month_format_spec = month_as_short_string);
  <span class="emphasis"><em>// <a href="all_date_names_put.html#id929560-bb">public member functions</a></em></span>
  <span class="type"><span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> *</span> <a href="all_date_names_put.html#id929565-bb">get_short_month_names</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> *</span> <a href="all_date_names_put.html#id1069945-bb">get_long_month_names</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> *</span> <a href="all_date_names_put.html#id801418-bb">get_special_value_names</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> *</span> <a href="all_date_names_put.html#id971730-bb">get_short_weekday_names</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> *</span> <a href="all_date_names_put.html#id822494-bb">get_long_weekday_names</a>() <span class="bold"><strong>const</strong></span>;
  <span class="emphasis"><em>// <a href="all_date_names_put.html#id825192-bb">protected member functions</a></em></span>
  <span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a href="all_date_names_put.html#id825197-bb">do_put_month_short</a>(iter_type &amp;, month_enum) <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a href="all_date_names_put.html#id933199-bb">do_put_month_long</a>(iter_type &amp;, month_enum) <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a href="all_date_names_put.html#id1075710-bb">do_put_special_value</a>(iter_type &amp;, special_value_enum) <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a href="all_date_names_put.html#id1104596-bb">do_put_weekday_short</a>(iter_type &amp;, weekday_enum) <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a href="all_date_names_put.html#id792600-bb">do_put_weekday_long</a>(iter_type &amp;, weekday_enum) <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a href="all_date_names_put.html#id838764-bb">do_month_sep_char</a>(iter_type &amp;) <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a href="all_date_names_put.html#id1045428-bb">do_day_sep_char</a>(iter_type &amp;) <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>virtual</strong></span> ymd_order_spec</span> <a href="all_date_names_put.html#id970879-bb">do_date_order</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>virtual</strong></span> month_format_spec</span> <a href="all_date_names_put.html#id1077877-bb">do_month_format</a>() <span class="bold"><strong>const</strong></span>;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1079994"></a><h2>Description</h2>
<div class="refsect2" lang="en">
<a name="id1079997"></a><h3>
<a name="all_date_names_putconstruct-copy-destruct"></a><code class="computeroutput">all_date_names_put</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><a name="id936796-bb"></a>all_date_names_put(<span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> month_short_names,
                   <span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> month_long_names,
                   <span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> special_value_names,
                   <span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> weekday_short_names,
                   <span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> weekday_long_names,
                   charT separator_char = '-',
                   ymd_order_spec order_spec = ymd_order_iso,
                   month_format_spec month_format = month_as_short_string);</pre></li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1080096"></a><h3>
<a name="id929560-bb"></a><code class="computeroutput">all_date_names_put</code> public member functions</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> *</span> <a name="id929565-bb"></a>get_short_month_names() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> *</span> <a name="id1069945-bb"></a>get_long_month_names() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> *</span> <a name="id801418-bb"></a>get_special_value_names() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> *</span> <a name="id971730-bb"></a>get_short_weekday_names() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> *</span> <a name="id822494-bb"></a>get_long_weekday_names() <span class="bold"><strong>const</strong></span>;</pre></li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1080280"></a><h3>
<a name="id825192-bb"></a><code class="computeroutput">all_date_names_put</code> protected member functions</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a name="id825197-bb"></a>do_put_month_short(iter_type &amp; oitr, month_enum moy) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a name="id933199-bb"></a>do_put_month_long(iter_type &amp; oitr, month_enum moy) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span>
<a name="id1075710-bb"></a>do_put_special_value(iter_type &amp; oitr, special_value_enum sv) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a name="id1104596-bb"></a>do_put_weekday_short(iter_type &amp; oitr, weekday_enum wd) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a name="id792600-bb"></a>do_put_weekday_long(iter_type &amp; oitr, weekday_enum wd) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a name="id838764-bb"></a>do_month_sep_char(iter_type &amp; oitr) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a name="id1045428-bb"></a>do_day_sep_char(iter_type &amp; oitr) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>virtual</strong></span> ymd_order_spec</span> <a name="id970879-bb"></a>do_date_order() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>virtual</strong></span> month_format_spec</span> <a name="id1077877-bb"></a>do_month_format() <span class="bold"><strong>const</strong></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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="date_names_put.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id1072331"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="dst_calculator.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

71
doc/html/ambiguous_option.html Normal file
View file

@ -0,0 +1,71 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class ambiguous_option</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="program_options/reference.html#id696710" title="Header &lt;boost/program_options/errors.hpp&gt;">
<link rel="prev" href="eof_iterator.html" title="Class template eof_iterator">
<link rel="next" href="error.html" title="Class error">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="eof_iterator.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id696710"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="error.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="ambiguous_option"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class ambiguous_option</span></h2>
<p>boost::program_options::ambiguous_option &#8212; </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="bold"><strong>class</strong></span> ambiguous_option : <span class="bold"><strong>public</strong></span> boost::program_options::error {
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// <a href="ambiguous_option.html#ambiguous_optionconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="ambiguous_option.html#id656261-bb">ambiguous_option</a>(<span class="bold"><strong>const</strong></span> std::string &amp;, <span class="bold"><strong>const</strong></span> std::vector&lt; std::string &gt; &amp;);
  <a href="ambiguous_option.html#id864630-bb">~ambiguous_option</a>();
  <span class="emphasis"><em>// <a href="ambiguous_option.html#id822608-bb">public member functions</a></em></span>
  std::vector&lt; std::string &gt; alternatives;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1249951"></a><h2>Description</h2>
<p>Class thrown when there's ambiguity amoung several possible options. </p>
<div class="refsect2" lang="en">
<a name="id1249958"></a><h3>
<a name="ambiguous_optionconstruct-copy-destruct"></a><code class="computeroutput">ambiguous_option</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><a name="id656261-bb"></a>ambiguous_option(<span class="bold"><strong>const</strong></span> std::string &amp; name,
                 <span class="bold"><strong>const</strong></span> std::vector&lt; std::string &gt; &amp; alternatives);</pre></li>
<li><pre class="literallayout"><a name="id864630-bb"></a>~ambiguous_option();</pre></li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1250018"></a><h3>
<a name="id822608-bb"></a><code class="computeroutput">ambiguous_option</code> public member functions</h3>
<div class="orderedlist"><ol type="1"></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"><small>Copyright © 2002-2004 Vladimir Prus</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="eof_iterator.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id696710"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="error.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

62
doc/html/ambiguous_result.html Normal file
View file

@ -0,0 +1,62 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Struct ambiguous_result</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="date_time/doxy.html#id1106303" title="Header &lt;boost/date_time/local_time/local_date_time.hpp&gt;">
<link rel="prev" href="nth_kday_rule_spec.html" title="Struct nth_kday_rule_spec">
<link rel="next" href="time_label_invalid.html" title="Struct time_label_invalid">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="nth_kday_rule_spec.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id1106303"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="time_label_invalid.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="ambiguous_result"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct ambiguous_result</span></h2>
<p>boost::local_time::ambiguous_result &#8212; simple exception for reporting when STD or DST cannot be determined </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="bold"><strong>struct</strong></span> ambiguous_result {
  <span class="emphasis"><em>// <a href="ambiguous_result.html#ambiguous_resultconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="ambiguous_result.html#id821403-bb">ambiguous_result</a>(std::string = "");
  <span class="emphasis"><em>// <a href="ambiguous_result.html#id821397-bb">public member functions</a></em></span>
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1181119"></a><h2>Description</h2>
<div class="refsect2" lang="en">
<a name="id1181122"></a><h3>
<a name="ambiguous_resultconstruct-copy-destruct"></a><code class="computeroutput">ambiguous_result</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><a name="id821403-bb"></a>ambiguous_result(std::string _msg = "");</pre></li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1181157"></a><h3>
<a name="id821397-bb"></a><code class="computeroutput">ambiguous_result</code> public member functions</h3>
<div class="orderedlist"><ol type="1"></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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="nth_kday_rule_spec.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id1106303"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="time_label_invalid.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

112
doc/html/any.html
View file

@ -1,10 +1,106 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="refresh" content="0; URL=http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/any.html">
</head>
<body>
Automatic redirection failed, please go to
<a href="http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/any.html">http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/any.html</a>
</body>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 1. Boost.Any</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="libraries.html" title="Part I. The Boost C++ Libraries">
<link rel="prev" href="libraries/s02.html" title="Libraries Listed by Category">
<link rel="next" href="any/s02.html" title="Examples">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="libraries/s02.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="libraries.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="any/s02.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="chapter" lang="en">
<div class="titlepage"><div>
<div><h2 class="title">
<a name="any"></a>Chapter 1. Boost.Any</h2></div>
<div><div class="author"><h3 class="author">
<span class="firstname">Kevlin</span> <span class="surname">Henney</span>
</h3></div></div>
<div><p class="copyright">Copyright © 2001 Kevlin Henney</p></div>
</div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="section"><a href="any.html#id969830">Introduction</a></span></dt>
<dt><span class="section"><a href="any/s02.html">Examples</a></span></dt>
<dt><span class="section"><a href="any/reference.html">Reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="any/reference.html#any.ValueType"><span class="emphasis"><em>ValueType</em></span> requirements</a></span></dt>
<dt><span class="section"><a href="any/reference.html#header.boost.any.hpp">Header &lt;boost/any.hpp&gt;</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="any/s04.html">Acknowledgements</a></span></dt>
</dl>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id969830"></a>Introduction</h3></div></div></div>
<p>There are times when a generic (in the sense of
<span class="emphasis"><em>general</em></span> as opposed to
<span class="emphasis"><em>template-based programming</em></span>) type is needed:
variables that are truly variable, accommodating values of many
other more specific types rather than C++'s normal strict and
static types. We can distinguish three basic kinds of generic
type:</p>
<div class="itemizedlist"><ul type="disc">
<li><p>Converting types that can hold one of a number of
possible value types, e.g. <code class="computeroutput">int</code> and
<code class="computeroutput">string</code>, and freely convert between them, for
instance interpreting <code class="computeroutput">5</code> as <code class="computeroutput">"5"</code> or
vice-versa. Such types are common in scripting and other
interpreted
languages.
<code class="computeroutput">boost::lexical_cast</code>
supports such conversion functionality.</p></li>
<li><p>
Discriminated types that contain values of different types but
do not attempt conversion between them, i.e. <code class="computeroutput">5</code> is
held strictly as an <code class="computeroutput">int</code> and is not implicitly
convertible either to <code class="computeroutput">"5"</code> or to
<code class="computeroutput">5.0</code>. Their indifference to interpretation but
awareness of type effectively makes them safe, generic
containers of single values, with no scope for surprises from
ambiguous conversions.</p></li>
<li><p>
Indiscriminate types that can refer to anything but are
oblivious to the actual underlying type, entrusting all forms
of access and interpretation to the programmer. This niche is
dominated by <code class="computeroutput">void *</code>, which offers plenty of scope
for surprising, undefined behavior.</p></li>
</ul></div>
<p>The <code class="computeroutput"><a href="boost/any.html" title="Class any">boost::any</a></code> class
(based on the class of the same name described in <a href="http://www.two-sdg.demon.co.uk/curbralan/papers/ValuedConversions.pdf" target="_top">"Valued
Conversions"</a> by Kevlin Henney, <span class="emphasis"><em>C++
Report</em></span> 12(7), July/August 2000) is a variant value type
based on the second category. It supports copying of any value
type and safe checked extraction of that value strictly against
its type. A similar design, offering more appropriate operators,
can be used for a generalized function adaptor,
<code class="computeroutput">any_function</code>, a generalized iterator adaptor,
<code class="computeroutput">any_iterator</code>, and other object types that need
uniform runtime treatment but support only compile-time template
parameter conformance.</p>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"><small><p>Last revised: March 15, 2003 at 23:12:35 GMT</p></small></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="libraries/s02.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="libraries.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="any/s02.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

86
doc/html/any/reference.html Normal file
View file

@ -0,0 +1,86 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Reference</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../any.html" title="Chapter 1. Boost.Any">
<link rel="prev" href="s02.html" title="Examples">
<link rel="next" href="../bad_any_cast.html" title="Class bad_any_cast">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="s02.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../any.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../bad_any_cast.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="any.reference"></a>Reference</h3></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="reference.html#any.ValueType"><span class="emphasis"><em>ValueType</em></span> requirements</a></span></dt>
<dt><span class="section"><a href="reference.html#header.boost.any.hpp">Header &lt;boost/any.hpp&gt;</a></span></dt>
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="any.ValueType"></a><span class="emphasis"><em>ValueType</em></span> requirements</h4></div></div></div>
<p>Values are strongly informational objects for which
identity is not significant, i.e. the focus is principally on
their state content and any behavior organized around
that. Another distinguishing feature of values is their
granularity: normally fine-grained objects representing simple
concepts in the system such as quantities.</p>
<p>As the emphasis of a value lies in its state not its
identity, values can be copied and typically assigned one to
another, requiring the explicit or implicit definition of a
public copy constructor and public assignment operator. Values
typically live within other scopes, i.e. within objects or
blocks, rather than on the heap. Values are therefore normally
passed around and manipulated directly as variables or through
references, but not as pointers that emphasize identity and
indirection.</p>
<p>The specific requirements on value types to be used in an
<code class="computeroutput"><a href="../boost/any.html" title="Class any">any</a></code>
are:</p>
<div class="itemizedlist"><ul type="disc" compact>
<li>A <span class="emphasis"><em>ValueType</em></span> is
<span class="emphasis"><em>CopyConstructible</em></span> [20.1.3].</li>
<li>A <span class="emphasis"><em>ValueType</em></span> is
optionally <span class="emphasis"><em>Assignable</em></span> [23.1]. The strong
exception-safety guarantee is required for all forms of
assignment.</li>
<li>The destructor for a
<span class="emphasis"><em>ValueType</em></span> upholds the no-throw
exception-safety guarantee.</li>
</ul></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="header.boost.any.hpp"></a>Header &lt;<a href="../../../boost/any.hpp" target="_top">boost/any.hpp</a>&gt;</h4></div></div></div>
<pre class="synopsis"><span class="bold"><strong>namespace</strong></span> boost {
  <span class="bold"><strong>class</strong></span> <a href="../bad_any_cast.html" title="Class bad_any_cast">bad_any_cast</a>;
  <span class="bold"><strong>class</strong></span> <a href="../boost/any.html" title="Class any">any</a>;
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> ValueType&gt; <span class="type">ValueType</span> <a href="../any_cast.html" title="Function any_cast">any_cast</a>(<span class="bold"><strong>const</strong></span> <a href="../boost/any.html" title="Class any">any</a> &amp;);
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> ValueType&gt; <span class="type"><span class="bold"><strong>const</strong></span> ValueType *</span> <a href="../any_cast.html" title="Function any_cast">any_cast</a>(<span class="bold"><strong>const</strong></span> <a href="../boost/any.html" title="Class any">any</a> *);
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> ValueType&gt; <span class="type">ValueType *</span> <a href="../any_cast.html" title="Function any_cast">any_cast</a>(<a href="../boost/any.html" title="Class any">any</a> *);
}</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"><small>Copyright © 2001 Kevlin Henney</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="s02.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../any.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../bad_any_cast.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

144
doc/html/any/s02.html Normal file
View file

@ -0,0 +1,144 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Examples</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../any.html" title="Chapter 1. Boost.Any">
<link rel="prev" href="../any.html" title="Chapter 1. Boost.Any">
<link rel="next" href="reference.html" title="Reference">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../any.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../any.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="reference.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id969978"></a>Examples</h3></div></div></div>
<p>The following code demonstrates the syntax for using
implicit conversions to and copying of any objects:</p>
<pre class="programlisting">
#include &lt;list&gt;
#include &lt;boost/any.hpp&gt;
using <code class="computeroutput"><a href="../any_cast.html" title="Function any_cast">boost::any_cast</a></code>;
typedef std::list&lt;<code class="computeroutput"><a href="../boost/any.html" title="Class any">boost::any</a></code>&gt; many;
void append_int(many &amp; values, int value)
{
<code class="computeroutput"><a href="../boost/any.html" title="Class any">boost::any</a></code> to_append = value;
values.push_back(to_append);
}
void append_string(many &amp; values, const std::string &amp; value)
{
values.push_back(value);
}
void append_char_ptr(many &amp; values, const char * value)
{
values.push_back(value);
}
void append_any(many &amp; values, const <code class="computeroutput"><a href="../boost/any.html" title="Class any">boost::any</a></code> &amp; value)
{
values.push_back(value);
}
void append_nothing(many &amp; values)
{
values.push_back(<code class="computeroutput"><a href="../boost/any.html" title="Class any">boost::any</a></code>());
}
</pre>
<p>The following predicates follow on from the previous
definitions and demonstrate the use of queries on any
objects:</p>
<pre class="programlisting">
bool is_empty(const <code class="computeroutput"><a href="../boost/any.html" title="Class any">boost::any</a></code> &amp; operand)
{
return operand.<code class="computeroutput"><a href="../boost/any.html#id761592-bb">empty</a></code>();
}
bool is_int(const <code class="computeroutput"><a href="../boost/any.html" title="Class any">boost::any</a></code> &amp; operand)
{
return operand.<code class="computeroutput"><a href="../boost/any.html#id761615-bb">type</a></code>() == typeid(int);
}
bool is_char_ptr(const <code class="computeroutput"><a href="../boost/any.html" title="Class any">boost::any</a></code> &amp; operand)
{
try
{
<code class="computeroutput"><a href="../any_cast.html" title="Function any_cast">any_cast</a></code>&lt;const char *&gt;(operand);
return true;
}
catch(const <code class="computeroutput"><a href="../bad_any_cast.html" title="Class bad_any_cast">boost::bad_any_cast</a></code> &amp;)
{
return false;
}
}
bool is_string(const <code class="computeroutput"><a href="../boost/any.html" title="Class any">boost::any</a></code> &amp; operand)
{
return <code class="computeroutput"><a href="../any_cast.html" title="Function any_cast">any_cast</a></code>&lt;std::string&gt;(&amp;operand);
}
void count_all(many &amp; values, std::ostream &amp; out)
{
out &lt;&lt; "#empty == "
&lt;&lt; std::count_if(values.begin(), values.end(), is_empty) &lt;&lt; std::endl;
out &lt;&lt; "#int == "
&lt;&lt; std::count_if(values.begin(), values.end(), is_int) &lt;&lt; std::endl;
out &lt;&lt; "#const char * == "
&lt;&lt; std::count_if(values.begin(), values.end(), is_char_ptr) &lt;&lt; std::endl;
out &lt;&lt; "#string == "
&lt;&lt; std::count_if(values.begin(), values.end(), is_string) &lt;&lt; std::endl;
}
</pre>
<p>The following type, patterned after the OMG's Property Service, defines name-value pairs for arbitrary value types:</p>
<pre class="programlisting">
struct property
{
property();
property(const std::string &amp;, const <code class="computeroutput"><a href="../boost/any.html" title="Class any">boost::any</a></code> &amp;);
std::string name;
<code class="computeroutput"><a href="../boost/any.html" title="Class any">boost::any</a></code> value;
};
typedef std::list&lt;property&gt; properties;
</pre>
<p>The following base class demonstrates one approach to
runtime polymorphism based callbacks that also require arbitrary
argument types. The absence of virtual member templates requires
that different solutions have different trade-offs in terms of
efficiency, safety, and generality. Using a checked variant type
offers one approach:</p>
<pre class="programlisting">
class consumer
{
public:
virtual void notify(const <code class="computeroutput"><a href="../boost/any.html" title="Class any">any</a></code> &amp;) = 0;
...
};
</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"><small>Copyright © 2001 Kevlin Henney</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../any.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../any.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="reference.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

39
doc/html/any/s04.html Normal file
View file

@ -0,0 +1,39 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Acknowledgements</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../any.html" title="Chapter 1. Boost.Any">
<link rel="prev" href="../any_cast.html" title="Function any_cast">
<link rel="next" href="../array.html" title="Chapter 2. Boost.Array">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../any_cast.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../any.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../array.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id971646"></a>Acknowledgements</h3></div></div></div>
<p>Doug Gregor ported the documentation to the BoostBook format.</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small>Copyright © 2001 Kevlin Henney</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../any_cast.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../any.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../array.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

69
doc/html/any_cast.html Normal file
View file

@ -0,0 +1,69 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Function any_cast</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="any/reference.html#header.boost.any.hpp" title="Header &lt;boost/any.hpp&gt;">
<link rel="prev" href="boost/any.html" title="Class any">
<link rel="next" href="any/s04.html" title="Acknowledgements">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost/any.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="any/reference.html#header.boost.any.hpp"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="any/s04.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="any_cast"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Function any_cast</span></h2>
<p>boost::any_cast &#8212; <p>Custom keyword cast for extracting a value
of a given type from an
<code class="computeroutput"><a href="boost/any.html" title="Class any">any</a></code>.</p></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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> ValueType&gt; <span class="type">ValueType</span> any_cast(<span class="bold"><strong>const</strong></span> <a href="boost/any.html" title="Class any">any</a> &amp; operand);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> ValueType&gt; <span class="type"><span class="bold"><strong>const</strong></span> ValueType *</span> any_cast(<span class="bold"><strong>const</strong></span> <a href="boost/any.html" title="Class any">any</a> * operand);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> ValueType&gt; <span class="type">ValueType *</span> any_cast(<a href="boost/any.html" title="Class any">any</a> * operand);</pre></div>
<div class="refsect1" lang="en">
<a name="id971581"></a><h2>Description</h2>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
If passed a pointer, it returns a
similarly qualified pointer to the value content if
successful, otherwise null is returned. If passed a value or
reference, it returns a copy of the value content if
successful.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Overloads taking an
<code class="computeroutput"><a href="boost/any.html" title="Class any">any</a></code> pointer do not
throw; the overload taking an
<code class="computeroutput"><a href="boost/any.html" title="Class any">any</a></code> value or reference
throws <code class="computeroutput"><a href="bad_any_cast.html" title="Class bad_any_cast">bad_any_cast</a></code> if
unsuccessful.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Rationale</span></b>:
The value/reference version returns a
copy because the C++ keyword casts return
copies.</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"><small>Copyright © 2001 Kevlin Henney</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost/any.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="any/reference.html#header.boost.any.hpp"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="any/s04.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

111
doc/html/apa.html Normal file
View file

@ -0,0 +1,111 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Appendix A. Rationale for some of the design decisions</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="lambda.html" title="Chapter 6. Boost.Lambda">
<link rel="prev" href="lambda/s09.html" title="Contributors">
<link rel="next" href="program_options.html" title="Chapter 7. Boost.Program_options">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="lambda/s09.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="lambda.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="program_options.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="appendix" lang="en">
<div class="titlepage"><div><div><h2 class="title">
<a name="id1246210"></a>Appendix A. Rationale for some of the design decisions</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl><dt><span class="section"><a href="apa.html#lambda.why_weak_arity">
Lambda functor arity
</a></span></dt></dl>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="lambda.why_weak_arity"></a>
Lambda functor arity
</h4></div></div></div>
<p>
The highest placeholder index in a lambda expression determines the arity of the resulting function object.
However, this is just the minimal arity, as the function object can take arbitrarily many arguments; those not needed are discarded.
Consider the two bind expressions and their invocations below:
</p>
<pre class="programlisting">
bind(g, _3, _3, _3)(x, y, z);
bind(g, _1, _1, _1)(x, y, z);
</pre>
<p>
This first line discards arguments <code class="literal">x</code> and
<code class="literal">y</code>, and makes the call:
</p>
<pre class="programlisting">
g(z, z, z)
</pre>
<p>
whereas the second line discards arguments <code class="literal">y</code> and
<code class="literal">z</code>, and calls:
</p>
<pre class="programlisting">
g(x, x, x)
</pre>
<p>
In earlier versions of the library, the latter line resulted in a compile
time error.
This is basically a tradeoff between safety and flexibility, and the issue
was extensively discussed during the Boost review period of the library.
The main points for the <span class="emphasis"><em>strict arity</em></span> checking
was that it might
catch a programming error at an earlier time and that a lambda expression that
explicitly discards its arguments is easy to write:
</p>
<pre class="programlisting">
(_3, bind(g, _1, _1, _1))(x, y, z);
</pre>
<p>
This lambda expression takes three arguments.
The left-hand argument of the comma operator does nothing, and as comma
returns the result of evaluating the right-hand argument we end up with
the call
<code class="literal">g(x, x, x)</code>
even with the strict arity.
</p>
<p>
The main points against the strict arity checking were that the need to
discard arguments is commonplace, and should therefore be straightforward,
and that strict arity checking does not really buy that much more safety,
particularly as it is not symmetric.
For example, if the programmer wanted to write the expression
<code class="literal">_1 + _2</code> but mistakenly wrote <code class="literal">_1 + 2</code>,
with strict arity checking, the complier would spot the error.
However, if the erroneous expression was <code class="literal">1 + _2</code> instead,
the error would go unnoticed.
Furthermore, weak arity checking simplifies the implementation a bit.
Following the recommendation of the Boost review, strict arity checking
was dropped.
</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"><small>Copyright © 1999-2004 Jaakko Järvi, Gary Powell</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="lambda/s09.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="lambda.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="program_options.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

103
doc/html/apply_visitor.html Normal file
View file

@ -0,0 +1,103 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Function apply_visitor</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="variant/reference.html#id872290" title="Header &lt;boost/variant/apply_visitor.hpp&gt;">
<link rel="prev" href="apply_visitor_delayed_t.html" title="Class template apply_visitor_delayed_t">
<link rel="next" href="bad_get.html" title="Class bad_get">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="apply_visitor_delayed_t.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="variant/reference.html#id872290"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="bad_get.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="apply_visitor"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Function apply_visitor</span></h2>
<p>boost::apply_visitor &#8212; <p>Allows compile-time checked type-safe application of the
given visitor to the content of the given variant, ensuring that all
types are handled by the visitor.</p></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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Visitor, <span class="bold"><strong>typename</strong></span> Variant&gt;
  <span class="type"><span class="bold"><strong>typename</strong></span> Visitor::result_type</span>
  apply_visitor(Visitor &amp; visitor, Variant &amp; operand);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Visitor, <span class="bold"><strong>typename</strong></span> Variant&gt;
  <span class="type"><span class="bold"><strong>typename</strong></span> Visitor::result_type</span>
  apply_visitor(<span class="bold"><strong>const</strong></span> Visitor &amp; visitor, Variant &amp; operand);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> BinaryVisitor, <span class="bold"><strong>typename</strong></span> Variant1, <span class="bold"><strong>typename</strong></span> Variant2&gt;
  <span class="type"><span class="bold"><strong>typename</strong></span> BinaryVisitor::result_type</span>
  apply_visitor(BinaryVisitor &amp; visitor, Variant1 &amp; operand1,
                Variant2 &amp; operand2);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> BinaryVisitor, <span class="bold"><strong>typename</strong></span> Variant1, <span class="bold"><strong>typename</strong></span> Variant2&gt;
  <span class="type"><span class="bold"><strong>typename</strong></span> BinaryVisitor::result_type</span>
  apply_visitor(<span class="bold"><strong>const</strong></span> BinaryVisitor &amp; visitor, Variant1 &amp; operand1,
                Variant2 &amp; operand2);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Visitor&gt;
  <span class="type"><a href="apply_visitor_delayed_t.html" title="Class template apply_visitor_delayed_t">apply_visitor_delayed_t</a>&lt;Visitor&gt;</span> apply_visitor(Visitor &amp; visitor);</pre></div>
<div class="refsect1" lang="en">
<a name="id1668869"></a><h2>Description</h2>
<p>The behavior of <code class="computeroutput">apply_visitor</code> is dependent on
the number of arguments on which it operates (i.e., other than the
visitor). The function behaves as follows:
<div class="itemizedlist"><ul type="disc">
<li>Overloads accepting one operand invoke the unary function
call operator of the given visitor on the content of the given
<code class="computeroutput"><a href="boost/variant.html" title="Class template variant">variant</a></code> operand.</li>
<li>Overloads accepting two operands invoke the binary
function call operator of the given visitor on the content of
the given <code class="computeroutput"><a href="boost/variant.html" title="Class template variant">variant</a></code>
operands.</li>
<li>The overload accepting only a visitor returns a
<code class="computeroutput"><a href="apply_visitor_delayed_t.html" title="Class template apply_visitor_delayed_t">generic function object</a></code>
that accepts either one or two arguments and invokes
<code class="computeroutput"><a href="apply_visitor.html" title="Function apply_visitor">apply_visitor</a></code> using
these arguments and <code class="computeroutput">visitor</code>, thus behaving as
specified above. (This behavior is particularly useful, for
example, when one needs to operate on each element of a sequence
of variant objects using a standard library
algorithm.)</li>
</ul></div></p>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
The overloads acccepting operands return the result of
applying the given visitor to the content of the given operands.
The overload accepting only a visitor return a function object, thus
delaying application of the visitor to any operands.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Requires</span></b>:
The given visitor must fulfill the
<a href="variant/reference.html#variant.concepts.static-visitor" title="StaticVisitor"><span class="emphasis"><em>StaticVisitor</em></span></a>
concept requirements with respect to each of the bounded types of the
given <code class="computeroutput">variant</code>.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
The overloads accepting operands throw only if the given
visitor throws when applied. The overload accepting only a visitor
will not throw. (Note, however, that the returned
<a href="apply_visitor_delayed_t.html" title="Class template apply_visitor_delayed_t">function object</a>
may throw when invoked.)</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"><small>Copyright © 2002, 2003 Eric Friedman, Itay Maman</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="apply_visitor_delayed_t.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="variant/reference.html#id872290"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="bad_get.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

91
doc/html/apply_visitor_delayed_t.html Normal file
View file

@ -0,0 +1,91 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class template apply_visitor_delayed_t</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="variant/reference.html#id872290" title="Header &lt;boost/variant/apply_visitor.hpp&gt;">
<link rel="prev" href="unwrap_recursive_wrapper.html" title="Class template unwrap_recursive_wrapper">
<link rel="next" href="apply_visitor.html" title="Function apply_visitor">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="unwrap_recursive_wrapper.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="variant/reference.html#id872290"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="apply_visitor.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="apply_visitor_delayed_t"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template apply_visitor_delayed_t</span></h2>
<p>boost::apply_visitor_delayed_t &#8212; Adapts a visitor for use as a function object.</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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Visitor&gt;
<span class="bold"><strong>class</strong></span> apply_visitor_delayed_t {
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// types</em></span>
  <span class="bold"><strong>typedef</strong></span> <span class="bold"><strong>typename</strong></span> Visitor::result_type result_type;
  <span class="emphasis"><em>// <a href="apply_visitor_delayed_t.html#apply_visitor_delayed_tconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <span class="bold"><strong>explicit</strong></span> <a href="apply_visitor_delayed_t.html#id1208233-bb">apply_visitor_delayed_t</a>(Visitor &amp;);
  <span class="emphasis"><em>// <a href="apply_visitor_delayed_t.html#id1314580-bb">function object interface</a></em></span>
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Variant&gt; <span class="type">result_type</span> <a href="apply_visitor_delayed_t.html#id1207026-bb"><span class="bold"><strong>operator</strong></span>()</a>(Variant &amp;);
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Variant1, <span class="bold"><strong>typename</strong></span> Variant2&gt;
    <span class="type">result_type</span> <a href="apply_visitor_delayed_t.html#id1251205-bb"><span class="bold"><strong>operator</strong></span>()</a>(Variant1 &amp;, Variant2 &amp;);
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1668496"></a><h2>Description</h2>
<p>Adapts the function given at construction for use as a
function object. This is useful, for example, when one needs to
operate on each element of a sequence of variant objects using a
standard library algorithm such as
<code class="computeroutput">std::for_each</code>.</p>
<p>See the "visitor-only" form of
<code class="computeroutput"><a href="apply_visitor.html" title="Function apply_visitor">apply_visitor</a></code> for a simple
way to create <code class="computeroutput">apply_visitor_delayed_t</code> objects.</p>
<div class="refsect2" lang="en">
<a name="id1668530"></a><h3>
<a name="apply_visitor_delayed_tconstruct-copy-destruct"></a><code class="computeroutput">apply_visitor_delayed_t</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1"><li>
<pre class="literallayout"><span class="bold"><strong>explicit</strong></span> <a name="id1208233-bb"></a>apply_visitor_delayed_t(Visitor &amp; visitor);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
Constructs the function object with the given
visitor.</p>
</li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1668581"></a><h3>
<a name="id1314580-bb"></a><code class="computeroutput">apply_visitor_delayed_t</code> function object interface</h3>
<div class="orderedlist"><ol type="1"><li>
<p><a name="id1314583-bb"></a></p>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Variant&gt; <span class="type">result_type</span> <a name="id1207026-bb"></a><span class="bold"><strong>operator</strong></span>()(Variant &amp; operand);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Variant1, <span class="bold"><strong>typename</strong></span> Variant2&gt;
  <span class="type">result_type</span> <a name="id1251205-bb"></a><span class="bold"><strong>operator</strong></span>()(Variant1 &amp; operand1, Variant2 &amp; operand2);</pre>
<p>Invokes
<code class="computeroutput"><a href="apply_visitor.html" title="Function apply_visitor">apply_visitor</a></code> on the
stored visitor using the given operands.</p>
</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"><small>Copyright © 2002, 2003 Eric Friedman, Itay Maman</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="unwrap_recursive_wrapper.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="variant/reference.html#id872290"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="apply_visitor.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

122
doc/html/array.html
View file

@ -1,10 +1,116 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="refresh" content="0; URL=http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/array.html">
</head>
<body>
Automatic redirection failed, please go to
<a href="http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/array.html">http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/array.html</a>
</body>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 2. Boost.Array</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="libraries.html" title="Part I. The Boost C++ Libraries">
<link rel="prev" href="any/s04.html" title="Acknowledgements">
<link rel="next" href="array/reference.html" title="Reference">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="any/s04.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="libraries.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="array/reference.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="chapter" lang="en">
<div class="titlepage"><div>
<div><h2 class="title">
<a name="array"></a>Chapter 2. Boost.Array</h2></div>
<div><div class="author"><h3 class="author">
<span class="firstname">Nicolai</span> <span class="surname">Josuttis</span>
</h3></div></div>
<div><p class="copyright">Copyright © 2001-2004 Nicolai M. Josuttis</p></div>
<div><div class="legalnotice">
<a name="id971681"></a><p>Permission to copy, use, modify, sell and distribute this
software is granted provided this copyright notice appears in
all copies. This software is provided "as is" without express or
implied warranty, and with no claim as to its suitability for
any purpose.</p>
</div></div>
</div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="section"><a href="array.html#array.intro">Introduction</a></span></dt>
<dt><span class="section"><a href="array/reference.html">Reference</a></span></dt>
<dd><dl><dt><span class="section"><a href="array/reference.html#header.boost.array.hpp">Header &lt;boost/array.hpp&gt;</a></span></dt></dl></dd>
<dt><span class="section"><a href="array/rationale.html">Design Rationale</a></span></dt>
<dt><span class="section"><a href="array/more/info.html">For more information...</a></span></dt>
<dt><span class="section"><a href="array/ack.html">Acknowledgements</a></span></dt>
</dl>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="array.intro"></a>Introduction</h3></div></div></div>
<p>The C++ Standard Template Library STL as part of the C++
Standard Library provides a framework for processing algorithms on
different kind of containers. However, ordinary arrays don't
provide the interface of STL containers (although, they provide
the iterator interface of STL containers).</p>
<p>As replacement for ordinary arrays, the STL provides class
<code class="computeroutput">std::vector</code>. However,
<code class="computeroutput">std::vector&lt;&gt;</code> provides
the semantics of dynamic arrays. Thus, it manages data to be able
to change the number of elements. This results in some overhead in
case only arrays with static size are needed.</p>
<p>In his book, <span class="emphasis"><em>Generic Programming and the
STL</em></span>, Matthew H. Austern introduces a useful wrapper
class for ordinary arrays with static size, called
<code class="computeroutput">block</code>. It is safer and has no worse performance than
ordinary arrays. In <span class="emphasis"><em>The C++ Programming
Language</em></span>, 3rd edition, Bjarne Stroustrup introduces a
similar class, called <code class="computeroutput">c_array</code>, which I (<a href="http://www.josuttis.com" target="_top">Nicolai Josuttis</a>) present
slightly modified in my book <span class="emphasis"><em>The C++ Standard Library -
A Tutorial and Reference</em></span>, called
<code class="computeroutput">carray</code>. This is the essence of these approaches
spiced with many feedback from <a href="http://www.boost.org" target="_top">boost</a>.</p>
<p>After considering different names, we decided to name this
class simply <code class="computeroutput"><a href="boost/array.html" title="Class template array">array</a></code>.</p>
<p>Note that this class is suggested to be part of the next
Technical Report, which will extend the C++ Standard (see
<a href="" target="_top">http://std.dkuug.dk/jtc1/sc22/wg21/docs/papers/2003/n1548.htm</a>).</p>
<p>Class <code class="computeroutput"><a href="boost/array.html" title="Class template array">array</a></code> fulfills most
but not all of the requirements of "reversible containers" (see
Section 23.1, [lib.container.requirements] of the C++
Standard). The reasons array is not an reversible STL container is
because:
</p>
<div class="itemizedlist"><ul type="disc" compact>
<li>No constructors are provided.</li>
<li>Elements may have an undetermined initial value (see <a href="array/rationale.html" title="Design Rationale">the section called &#8220;Design Rationale&#8221;</a>).</li>
<li>
<code class="computeroutput"><a href="boost/array.html#id763420">swap</a></code>() has no constant complexity.</li>
<li>
<code class="computeroutput"><a href="boost/array.html#id686133-bb">size</a></code>() is always constant, based on the second template argument of the type.</li>
<li>The container provides no allocator support.</li>
</ul></div>
<p>It doesn't fulfill the requirements of a "sequence" (see Section 23.1.1, [lib.sequence.reqmts] of the C++ Standard), except that:
</p>
<div class="itemizedlist"><ul type="disc" compact>
<li>
<code class="computeroutput"><a href="boost/array.html#id763241-bb">front</a></code>() and <code class="computeroutput"><a href="boost/array.html#id763273-bb">back</a></code>() are provided.</li>
<li>
<code class="computeroutput"><a href="boost/array.html#id685146-bb">operator[]</a></code> and <code class="computeroutput"><a href="boost/array.html#id726524-bb">at</a></code>() are provided.</li>
</ul></div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"><small><p>Last revised: January 30, 2004 at 03:51:06 GMT</p></small></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="any/s04.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="libraries.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="array/reference.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

39
doc/html/array/ack.html Normal file
View file

@ -0,0 +1,39 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Acknowledgements</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../array.html" title="Chapter 2. Boost.Array">
<link rel="prev" href="more/info.html" title="For more information...">
<link rel="next" href="../concepts/reference.html" title="Concept reference">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="more/info.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../array.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../concepts/reference.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="array.ack"></a>Acknowledgements</h3></div></div></div>
<p>Doug Gregor ported the documentation to the BoostBook format.</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small>Copyright © 2001-2004 Nicolai M. Josuttis</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="more/info.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../array.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../concepts/reference.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

48
doc/html/array/more/info.html Normal file
View file

@ -0,0 +1,48 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>For more information...</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../../array.html" title="Chapter 2. Boost.Array">
<link rel="prev" href="../rationale.html" title="Design Rationale">
<link rel="next" href="../ack.html" title="Acknowledgements">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../rationale.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../array.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../ack.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="array.more.info"></a>For more information...</h3></div></div></div>
<p>To find more details about using ordinary arrays in C++ and
the framework of the STL, see e.g.
</p>
<div class="literallayout"><p>The C++ Standard Library - A Tutorial and Reference<br>
by Nicolai M. Josuttis<br>
Addison Wesley Longman, 1999<br>
ISBN 0-201-37926-0</p></div>
<p><a href="http://www.josuttis.com/" target="_top">Home Page of Nicolai
Josuttis</a></p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small>Copyright © 2001-2004 Nicolai M. Josuttis</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../rationale.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../array.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../ack.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

74
doc/html/array/rationale.html Normal file
View file

@ -0,0 +1,74 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Design Rationale</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../array.html" title="Chapter 2. Boost.Array">
<link rel="prev" href="../boost/array.html" title="Class template array">
<link rel="next" href="more/info.html" title="For more information...">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../boost/array.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../array.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="more/info.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="array.rationale"></a>Design Rationale</h3></div></div></div>
<p>There was an important design tradeoff regarding the
constructors: We could implement array as an "aggregate" (see
Section 8.5.1, [dcl.init.aggr], of the C++ Standard). This would
mean:
</p>
<div class="itemizedlist"><ul type="disc"><li>
<p>An array can be initialized with a
brace-enclosing, comma-separated list of initializers for the
elements of the container, written in increasing subscript
order:</p>
<pre class="programlisting"><code class="computeroutput"><a href="../boost/array.html" title="Class template array">boost::array</a></code>&lt;int,4&gt; a = { { 1, 2, 3 } };</pre>
<p>Note that if there are fewer elements in the
initializer list, then each remaining element gets
default-initialized (thus, it has a defined value).</p>
</li></ul></div>
<p>However, this approach has its drawbacks: <span class="bold"><strong> passing no initializer list means that the elements
have an indetermined initial value</strong></span>, because the rule says
that aggregates may have:
</p>
<div class="itemizedlist"><ul type="disc">
<li>No user-declared constructors.</li>
<li>No private or protected non-static data members.</li>
<li>No base classes.</li>
<li>No virtual functions.</li>
</ul></div>
<p>Nevertheless, The current implementation uses this approach.</p>
<p>Note that for standard conforming compilers it is possible to
use fewer braces (according to 8.5.1 (11) of the Standard). That is,
you can initialize an array as follows:</p>
<pre class="programlisting"><code class="computeroutput"><a href="../boost/array.html" title="Class template array">boost::array</a></code>&lt;int,4&gt; a = { 1, 2, 3 };
</pre>
<p>I'd appreciate any constructive feedback. <span class="bold"><strong>Please note: I don't have time to read all boost
mails. Thus, to make sure that feedback arrives to me, please send
me a copy of each mail regarding this class.</strong></span></p>
<p>The code is provided "as is" without expressed or implied
warranty.</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small>Copyright © 2001-2004 Nicolai M. Josuttis</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../boost/array.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../array.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="more/info.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

59
doc/html/array/reference.html Normal file
View file

@ -0,0 +1,59 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Reference</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../array.html" title="Chapter 2. Boost.Array">
<link rel="prev" href="../array.html" title="Chapter 2. Boost.Array">
<link rel="next" href="../boost/array.html" title="Class template array">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../array.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../array.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../boost/array.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="array.reference"></a>Reference</h3></div></div></div>
<div class="toc"><dl><dt><span class="section"><a href="reference.html#header.boost.array.hpp">Header &lt;boost/array.hpp&gt;</a></span></dt></dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="header.boost.array.hpp"></a>Header &lt;<a href="../../../boost/array.hpp" target="_top">boost/array.hpp</a>&gt;</h4></div></div></div>
<pre class="synopsis"><span class="bold"><strong>namespace</strong></span> boost {
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt; <span class="bold"><strong>class</strong></span> <a href="../boost/array.html" title="Class template array">array</a>;
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt; <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="../boost/array.html#id763420">swap</a>(<a href="../boost/array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;, <a href="../boost/array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;);
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
    <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="../boost/array.html#id763478"><span class="bold"><strong>operator</strong></span>==</a>(<span class="bold"><strong>const</strong></span> <a href="../boost/array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;, <span class="bold"><strong>const</strong></span> <a href="../boost/array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;);
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
    <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="../boost/array.html#id763537"><span class="bold"><strong>operator</strong></span>!=</a>(<span class="bold"><strong>const</strong></span> <a href="../boost/array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;, <span class="bold"><strong>const</strong></span> <a href="../boost/array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;);
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
    <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="../boost/array.html#id763586"><span class="bold"><strong>operator</strong></span>&lt;</a>(<span class="bold"><strong>const</strong></span> <a href="../boost/array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;, <span class="bold"><strong>const</strong></span> <a href="../boost/array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;);
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
    <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="../boost/array.html#id763648"><span class="bold"><strong>operator</strong></span>&gt;</a>(<span class="bold"><strong>const</strong></span> <a href="../boost/array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;, <span class="bold"><strong>const</strong></span> <a href="../boost/array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;);
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
    <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="../boost/array.html#id763696"><span class="bold"><strong>operator</strong></span>&lt;=</a>(<span class="bold"><strong>const</strong></span> <a href="../boost/array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;, <span class="bold"><strong>const</strong></span> <a href="../boost/array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;);
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
    <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="../boost/array.html#id763744"><span class="bold"><strong>operator</strong></span>&gt;=</a>(<span class="bold"><strong>const</strong></span> <a href="../boost/array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;, <span class="bold"><strong>const</strong></span> <a href="../boost/array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;);
}</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"><small>Copyright © 2001-2004 Nicolai M. Josuttis</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../array.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../array.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../boost/array.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

62
doc/html/bad_adjustment.html Normal file
View file

@ -0,0 +1,62 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Struct bad_adjustment</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="date_time/doxy.html#id928390" title="Header &lt;boost/date_time/local_time/posix_time_zone.hpp&gt;">
<link rel="prev" href="bad_offset.html" title="Struct bad_offset">
<link rel="next" href="posix_time_zone.html" title="Class posix_time_zone">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="bad_offset.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id928390"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="posix_time_zone.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="bad_adjustment"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct bad_adjustment</span></h2>
<p>boost::local_time::bad_adjustment &#8212; simple exception for UTC daylight savings adjustment </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="bold"><strong>struct</strong></span> bad_adjustment {
  <span class="emphasis"><em>// <a href="bad_adjustment.html#bad_adjustmentconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="bad_adjustment.html#id1031899-bb">bad_adjustment</a>(std::string = "");
  <span class="emphasis"><em>// <a href="bad_adjustment.html#id1031894-bb">public member functions</a></em></span>
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1184122"></a><h2>Description</h2>
<div class="refsect2" lang="en">
<a name="id1184126"></a><h3>
<a name="bad_adjustmentconstruct-copy-destruct"></a><code class="computeroutput">bad_adjustment</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><a name="id1031899-bb"></a>bad_adjustment(std::string _msg = "");</pre></li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1184159"></a><h3>
<a name="id1031894-bb"></a><code class="computeroutput">bad_adjustment</code> public member functions</h3>
<div class="orderedlist"><ol type="1"></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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="bad_offset.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id928390"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="posix_time_zone.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

53
doc/html/bad_any_cast.html Normal file
View file

@ -0,0 +1,53 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class bad_any_cast</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="any/reference.html#header.boost.any.hpp" title="Header &lt;boost/any.hpp&gt;">
<link rel="prev" href="any/reference.html" title="Reference">
<link rel="next" href="boost/any.html" title="Class any">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="any/reference.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="any/reference.html#header.boost.any.hpp"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="boost/any.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="bad_any_cast"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class bad_any_cast</span></h2>
<p>boost::bad_any_cast &#8212; The exception thrown in the event of a failed
<code class="computeroutput"><a href="any_cast.html" title="Function any_cast">any_cast</a></code> of an
<code class="computeroutput"><a href="boost/any.html" title="Class any">any</a></code> value.</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="bold"><strong>class</strong></span> bad_any_cast : <span class="bold"><strong>public</strong></span> std::bad_cast {
<span class="bold"><strong>public</strong></span>:
  <span class="bold"><strong>virtual</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a href="bad_any_cast.html#id728128-bb">what</a>() <span class="bold"><strong>const</strong></span>;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id970542"></a><h2>Description</h2>
<pre class="literallayout"><span class="bold"><strong>virtual</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a name="id728128-bb"></a>what() <span class="bold"><strong>const</strong></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"><small>Copyright © 2001 Kevlin Henney</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="any/reference.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="any/reference.html#header.boost.any.hpp"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="boost/any.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

66
doc/html/bad_day_of_month.html Normal file
View file

@ -0,0 +1,66 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Struct bad_day_of_month</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="date_time/doxy.html#id906477" title="Header &lt;boost/date_time/gregorian/greg_day.hpp&gt;">
<link rel="prev" href="boost/gregorian/date.html" title="Class date">
<link rel="next" href="greg_day.html" title="Class greg_day">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost/gregorian/date.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id906477"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="greg_day.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="bad_day_of_month"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct bad_day_of_month</span></h2>
<p>boost::gregorian::bad_day_of_month &#8212; Exception type for gregorian day of month (1..31). </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="bold"><strong>struct</strong></span> bad_day_of_month {
  <span class="emphasis"><em>// <a href="bad_day_of_month.html#bad_day_of_monthconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="bad_day_of_month.html#id826911-bb">bad_day_of_month</a>();
  <a href="bad_day_of_month.html#id826913-bb">bad_day_of_month</a>(<span class="bold"><strong>const</strong></span> std::string &amp;);
  <span class="emphasis"><em>// <a href="bad_day_of_month.html#id1106058-bb">public member functions</a></em></span>
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1150646"></a><h2>Description</h2>
<div class="refsect2" lang="en">
<a name="id1150650"></a><h3>
<a name="bad_day_of_monthconstruct-copy-destruct"></a><code class="computeroutput">bad_day_of_month</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><a name="id826911-bb"></a>bad_day_of_month();</pre></li>
<li><pre class="literallayout"><a name="id826913-bb"></a>bad_day_of_month(<span class="bold"><strong>const</strong></span> std::string &amp; s);</pre></li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1150704"></a><h3>
<a name="id1106058-bb"></a><code class="computeroutput">bad_day_of_month</code> public member functions</h3>
<div class="orderedlist"><ol type="1"></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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost/gregorian/date.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id906477"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="greg_day.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

62
doc/html/bad_day_of_year.html Normal file
View file

@ -0,0 +1,62 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Struct bad_day_of_year</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="date_time/doxy.html#id862957" title="Header &lt;boost/date_time/gregorian/greg_day_of_year.hpp&gt;">
<link rel="prev" href="greg_day.html" title="Class greg_day">
<link rel="next" href="greg_durations_config.html" title="Struct greg_durations_config">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="greg_day.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id862957"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="greg_durations_config.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="bad_day_of_year"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct bad_day_of_year</span></h2>
<p>boost::gregorian::bad_day_of_year &#8212; Exception type for day of year (1..366). </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="bold"><strong>struct</strong></span> bad_day_of_year {
  <span class="emphasis"><em>// <a href="bad_day_of_year.html#bad_day_of_yearconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="bad_day_of_year.html#id1108640-bb">bad_day_of_year</a>();
  <span class="emphasis"><em>// <a href="bad_day_of_year.html#id1108635-bb">public member functions</a></em></span>
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1151132"></a><h2>Description</h2>
<div class="refsect2" lang="en">
<a name="id1151135"></a><h3>
<a name="bad_day_of_yearconstruct-copy-destruct"></a><code class="computeroutput">bad_day_of_year</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><a name="id1108640-bb"></a>bad_day_of_year();</pre></li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1151168"></a><h3>
<a name="id1108635-bb"></a><code class="computeroutput">bad_day_of_year</code> public member functions</h3>
<div class="orderedlist"><ol type="1"></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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="greg_day.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id862957"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="greg_durations_config.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

62
doc/html/bad_field_count.html Normal file
View file

@ -0,0 +1,62 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Struct bad_field_count</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="date_time/doxy.html#id1034888" title="Header &lt;boost/date_time/tz_db_base.hpp&gt;">
<link rel="prev" href="data_not_accessible.html" title="Struct data_not_accessible">
<link rel="next" href="tz_db_base.html" title="Class template tz_db_base">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="data_not_accessible.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id1034888"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="tz_db_base.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="bad_field_count"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct bad_field_count</span></h2>
<p>boost::date_time::bad_field_count &#8212; </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="bold"><strong>struct</strong></span> bad_field_count {
  <span class="emphasis"><em>// <a href="bad_field_count.html#bad_field_countconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="bad_field_count.html#id932728-bb">bad_field_count</a>(<span class="bold"><strong>const</strong></span> std::string &amp;);
  <span class="emphasis"><em>// <a href="bad_field_count.html#id932723-bb">public member functions</a></em></span>
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1147112"></a><h2>Description</h2>
<div class="refsect2" lang="en">
<a name="id1147115"></a><h3>
<a name="bad_field_countconstruct-copy-destruct"></a><code class="computeroutput">bad_field_count</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><a name="id932728-bb"></a>bad_field_count(<span class="bold"><strong>const</strong></span> std::string &amp; s);</pre></li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1147154"></a><h3>
<a name="id932723-bb"></a><code class="computeroutput">bad_field_count</code> public member functions</h3>
<div class="orderedlist"><ol type="1"></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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="data_not_accessible.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id1034888"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="tz_db_base.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

61
doc/html/bad_function_call.html Normal file
View file

@ -0,0 +1,61 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class bad_function_call</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="function/reference.html#header.boost.function.hpp" title="Header &lt;boost/function.hpp&gt;">
<link rel="prev" href="function/reference.html" title="Reference">
<link rel="next" href="function_base.html" title="Class function_base">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="function/reference.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="function/reference.html#header.boost.function.hpp"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="function_base.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="bad_function_call"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class bad_function_call</span></h2>
<p>boost::bad_function_call &#8212; An exception type thrown when an instance of a <code class="computeroutput">function</code> object is empty when invoked.</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="bold"><strong>class</strong></span> bad_function_call : <span class="bold"><strong>public</strong></span> std::runtime_error {
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// <a href="bad_function_call.html#bad_function_callconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="bad_function_call.html#id928551-bb">bad_function_call</a>();
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1206744"></a><h2>Description</h2>
<div class="refsect2" lang="en">
<a name="id1206748"></a><h3>
<a name="bad_function_callconstruct-copy-destruct"></a><code class="computeroutput">bad_function_call</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1"><li>
<pre class="literallayout"><a name="id928551-bb"></a>bad_function_call();</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
Constructs a <code class="computeroutput"><a href="bad_function_call.html" title="Class bad_function_call">bad_function_call</a></code> exception object.</p>
</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"><small>Copyright © 2001-2004 Douglas Gregor</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="function/reference.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="function/reference.html#header.boost.function.hpp"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="function_base.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

53
doc/html/bad_get.html Normal file
View file

@ -0,0 +1,53 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class bad_get</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="variant/reference.html#id894482" title="Header &lt;boost/variant/get.hpp&gt;">
<link rel="prev" href="apply_visitor.html" title="Function apply_visitor">
<link rel="next" href="get.html" title="Function get">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="apply_visitor.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="variant/reference.html#id894482"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="get.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="bad_get"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class bad_get</span></h2>
<p>boost::bad_get &#8212; <p>The exception thrown in the event of a failed application of
<code class="computeroutput"><a href="get.html" title="Function get">boost::get</a></code> on the given
operand value.</p></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="bold"><strong>class</strong></span> bad_get : <span class="bold"><strong>public</strong></span> std::exception {
<span class="bold"><strong>public</strong></span>:
  <span class="bold"><strong>virtual</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a href="bad_get.html#id801330-bb">what</a>() <span class="bold"><strong>const</strong></span>;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1669332"></a><h2>Description</h2>
<pre class="literallayout"><span class="bold"><strong>virtual</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a name="id801330-bb"></a>what() <span class="bold"><strong>const</strong></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"><small>Copyright © 2002, 2003 Eric Friedman, Itay Maman</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="apply_visitor.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="variant/reference.html#id894482"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="get.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

62
doc/html/bad_month.html Normal file
View file

@ -0,0 +1,62 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Struct bad_month</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="date_time/doxy.html#id871347" title="Header &lt;boost/date_time/gregorian/greg_month.hpp&gt;">
<link rel="prev" href="id792474.html" title="Function template operator&lt;&lt;">
<link rel="next" href="greg_month.html" title="Class greg_month">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="id792474.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id871347"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="greg_month.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="bad_month"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct bad_month</span></h2>
<p>boost::gregorian::bad_month &#8212; Exception thrown if a greg_month is constructed with a value out of range. </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="bold"><strong>struct</strong></span> bad_month {
  <span class="emphasis"><em>// <a href="bad_month.html#bad_monthconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="bad_month.html#id692487-bb">bad_month</a>();
  <span class="emphasis"><em>// <a href="bad_month.html#id692482-bb">public member functions</a></em></span>
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1152847"></a><h2>Description</h2>
<div class="refsect2" lang="en">
<a name="id1152850"></a><h3>
<a name="bad_monthconstruct-copy-destruct"></a><code class="computeroutput">bad_month</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><a name="id692487-bb"></a>bad_month();</pre></li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1152883"></a><h3>
<a name="id692482-bb"></a><code class="computeroutput">bad_month</code> public member functions</h3>
<div class="orderedlist"><ol type="1"></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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="id792474.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id871347"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="greg_month.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

62
doc/html/bad_offset.html Normal file
View file

@ -0,0 +1,62 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Struct bad_offset</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="date_time/doxy.html#id928390" title="Header &lt;boost/date_time/local_time/posix_time_zone.hpp&gt;">
<link rel="prev" href="local_date_time_base.html" title="Class template local_date_time_base">
<link rel="next" href="bad_adjustment.html" title="Struct bad_adjustment">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="local_date_time_base.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id928390"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="bad_adjustment.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="bad_offset"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct bad_offset</span></h2>
<p>boost::local_time::bad_offset &#8212; simple exception for UTC and Daylight savings start/end offsets </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="bold"><strong>struct</strong></span> bad_offset {
  <span class="emphasis"><em>// <a href="bad_offset.html#bad_offsetconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="bad_offset.html#id1001792-bb">bad_offset</a>(std::string = "");
  <span class="emphasis"><em>// <a href="bad_offset.html#id1002747-bb">public member functions</a></em></span>
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1184007"></a><h2>Description</h2>
<div class="refsect2" lang="en">
<a name="id1184010"></a><h3>
<a name="bad_offsetconstruct-copy-destruct"></a><code class="computeroutput">bad_offset</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><a name="id1001792-bb"></a>bad_offset(std::string _msg = "");</pre></li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1184044"></a><h3>
<a name="id1002747-bb"></a><code class="computeroutput">bad_offset</code> public member functions</h3>
<div class="orderedlist"><ol type="1"></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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="local_date_time_base.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id928390"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="bad_adjustment.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

52
doc/html/bad_visit.html Normal file
View file

@ -0,0 +1,52 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class bad_visit</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="variant/reference.html#id1561653" title="Header &lt;boost/variant/bad_visit.hpp&gt;">
<link rel="prev" href="get.html" title="Function get">
<link rel="next" href="static_visitor.html" title="Class template static_visitor">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="get.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="variant/reference.html#id1561653"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="static_visitor.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="bad_visit"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class bad_visit</span></h2>
<p>boost::bad_visit &#8212; <p>The exception thrown in the event of a visitor
unable to handle the visited value.</p></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="bold"><strong>class</strong></span> bad_visit : <span class="bold"><strong>public</strong></span> std::exception {
<span class="bold"><strong>public</strong></span>:
  <span class="bold"><strong>virtual</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a href="bad_visit.html#id1254309-bb">what</a>() <span class="bold"><strong>const</strong></span>;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1669929"></a><h2>Description</h2>
<pre class="literallayout"><span class="bold"><strong>virtual</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a name="id1254309-bb"></a>what() <span class="bold"><strong>const</strong></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"><small>Copyright © 2002, 2003 Eric Friedman, Itay Maman</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="get.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="variant/reference.html#id1561653"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="static_visitor.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

62
doc/html/bad_weekday.html Normal file
View file

@ -0,0 +1,62 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Struct bad_weekday</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="date_time/doxy.html#id973291" title="Header &lt;boost/date_time/gregorian/greg_weekday.hpp&gt;">
<link rel="prev" href="greg_month.html" title="Class greg_month">
<link rel="next" href="greg_weekday.html" title="Class greg_weekday">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="greg_month.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id973291"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="greg_weekday.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="bad_weekday"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct bad_weekday</span></h2>
<p>boost::gregorian::bad_weekday &#8212; Exception that flags that a weekday number is incorrect. </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="bold"><strong>struct</strong></span> bad_weekday {
  <span class="emphasis"><em>// <a href="bad_weekday.html#bad_weekdayconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="bad_weekday.html#id977285-bb">bad_weekday</a>();
  <span class="emphasis"><em>// <a href="bad_weekday.html#id977279-bb">public member functions</a></em></span>
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1171466"></a><h2>Description</h2>
<div class="refsect2" lang="en">
<a name="id1171470"></a><h3>
<a name="bad_weekdayconstruct-copy-destruct"></a><code class="computeroutput">bad_weekday</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><a name="id977285-bb"></a>bad_weekday();</pre></li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1171503"></a><h3>
<a name="id977279-bb"></a><code class="computeroutput">bad_weekday</code> public member functions</h3>
<div class="orderedlist"><ol type="1"></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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="greg_month.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id973291"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="greg_weekday.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

62
doc/html/bad_year.html Normal file
View file

@ -0,0 +1,62 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Struct bad_year</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="date_time/doxy.html#id866121" title="Header &lt;boost/date_time/gregorian/greg_year.hpp&gt;">
<link rel="prev" href="greg_weekday.html" title="Class greg_weekday">
<link rel="next" href="greg_year.html" title="Class greg_year">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="greg_weekday.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id866121"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="greg_year.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="bad_year"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct bad_year</span></h2>
<p>boost::gregorian::bad_year &#8212; Exception type for gregorian year. </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="bold"><strong>struct</strong></span> bad_year {
  <span class="emphasis"><em>// <a href="bad_year.html#bad_yearconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="bad_year.html#id933145-bb">bad_year</a>();
  <span class="emphasis"><em>// <a href="bad_year.html#id933140-bb">public member functions</a></em></span>
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1172170"></a><h2>Description</h2>
<div class="refsect2" lang="en">
<a name="id1172174"></a><h3>
<a name="bad_yearconstruct-copy-destruct"></a><code class="computeroutput">bad_year</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><a name="id933145-bb"></a>bad_year();</pre></li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1172206"></a><h3>
<a name="id933140-bb"></a><code class="computeroutput">bad_year</code> public member functions</h3>
<div class="orderedlist"><ol type="1"></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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="greg_weekday.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id866121"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="greg_year.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

117
doc/html/barrier.html Normal file
View file

@ -0,0 +1,117 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class barrier</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="threads/reference.html#id759234" title="Header &lt;boost/thread/barrier.hpp&gt;">
<link rel="prev" href="threads/reference.html" title="Reference">
<link rel="next" href="condition.html" title="Class condition">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="threads/reference.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="threads/reference.html#id759234"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="condition.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="barrier"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class barrier</span></h2>
<p>boost::barrier &#8212; <p>An object of class <a href="barrier.html" title="Class barrier">barrier</a> is a synchronization
primitive used to cause a set of threads to wait until they each perform a
certain function or each reach a particular point in their execution.</p></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="bold"><strong>class</strong></span> barrier : <span class="bold"><strong>private</strong></span> boost::noncopyable <span class="emphasis"><em>// Exposition only</em></span>
{
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// <a href="barrier.html#barrierconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="barrier.html#id1008465-bb">barrier</a>(size_t);
  <a href="barrier.html#id683382-bb">~barrier</a>();
  <span class="emphasis"><em>// <a href="barrier.html#id942530-bb">waiting</a></em></span>
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="barrier.html#id1178178-bb">wait</a>();
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1556579"></a><h2>Description</h2>
<p>When a barrier is created, it is initialized with a thread count N.
The first N-1 calls to <code class="computeroutput">wait()</code> will all cause their threads to be blocked.
The Nth call to <code class="computeroutput">wait()</code> will allow all of the waiting threads, including
the Nth thread, to be placed in a ready state. The Nth call will also "reset"
the barrier such that, if an additional N+1th call is made to <code class="computeroutput">wait()</code>,
it will be as though this were the first call to <code class="computeroutput">wait()</code>; in other
words, the N+1th to 2N-1th calls to <code class="computeroutput">wait()</code> will cause their
threads to be blocked, and the 2Nth call to <code class="computeroutput">wait()</code> will allow all of
the waiting threads, including the 2Nth thread, to be placed in a ready state
and reset the barrier. This functionality allows the same set of N threads to re-use
a barrier object to synchronize their execution at multiple points during their
execution.</p>
<p>See <a href="threads.html#threads.glossary" title="Glossary">Glossary</a> for definitions of thread
states <a href="threads.html#threads.glossary.thread-state">blocked</a>
and <a href="threads.html#threads.glossary.thread-state">ready</a>.
Note that "waiting" is a synonym for blocked.</p>
<div class="refsect2" lang="en">
<a name="id1556658"></a><h3>
<a name="barrierconstruct-copy-destruct"></a><code class="computeroutput">barrier</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1">
<li>
<pre class="literallayout"><a name="id1008465-bb"></a>barrier(size_t count);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
Constructs a <a href="barrier.html" title="Class barrier">barrier</a> object that
will cause <code class="computeroutput">count</code> threads to block on a call to <code class="computeroutput">wait()</code>.
</p>
</li>
<li>
<pre class="literallayout"><a name="id683382-bb"></a>~barrier();</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
Destroys <code class="computeroutput">*this</code>. If threads are still executing
their <code class="computeroutput">wait()</code> operations, the behavior for these threads is undefined.
</p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1556757"></a><h3>
<a name="id942530-bb"></a><code class="computeroutput">barrier</code> waiting</h3>
<div class="orderedlist"><ol type="1"><li>
<pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id1178178-bb"></a>wait();</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
Wait until N threads call <code class="computeroutput">wait()</code>, where
N equals the <code class="computeroutput">count</code> provided to the constructor for the
barrier object.<p><span class="bold"><strong>Note</strong></span> that if the barrier is
destroyed before <code class="computeroutput">wait()</code> can return, the behavior is
undefined.</p><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
Exactly one of the N threads will receive a return value
of <code class="computeroutput">true</code>, the others will receive a value of <code class="computeroutput">false</code>.
Precisely which thread receives the return value of <code class="computeroutput">true</code> will
be implementation-defined. Applications can use this value to designate one
thread as a leader that will take a certain action, and the other threads
emerging from the barrier can wait for that action to take place.</p>
</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"><small>Copyright © 2001-2003 William E. Kempf</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="threads/reference.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="threads/reference.html#id759234"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="condition.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

129
doc/html/base_time.html Normal file
View file

@ -0,0 +1,129 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class template base_time</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="date_time/doxy.html#id831553" title="Header &lt;boost/date_time/time.hpp&gt;">
<link rel="prev" href="gather_weekday_strings.html" title="Function template gather_weekday_strings">
<link rel="next" href="second_clock.html" title="Class template second_clock">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="gather_weekday_strings.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id831553"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="second_clock.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="base_time"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template base_time</span></h2>
<p>boost::date_time::base_time &#8212; Representation of a precise moment in time, including the date. </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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, <span class="bold"><strong>typename</strong></span> time_system&gt;
<span class="bold"><strong>class</strong></span> base_time {
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// types</em></span>
  <span class="bold"><strong>typedef</strong></span> T                               time_type;         
  <span class="bold"><strong>typedef</strong></span> time_system::time_rep_type      time_rep_type;     
  <span class="bold"><strong>typedef</strong></span> time_system::date_type          date_type;         
  <span class="bold"><strong>typedef</strong></span> time_system::date_duration_type date_duration_type;
  <span class="bold"><strong>typedef</strong></span> time_system::time_duration_type time_duration_type;
  <span class="emphasis"><em>// <a href="base_time.html#base_timeconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="base_time.html#id796514-bb">base_time</a>(<span class="bold"><strong>const</strong></span> date_type &amp;, <span class="bold"><strong>const</strong></span> time_duration_type &amp;,
            dst_flags = not_dst);
  <a href="base_time.html#id689610-bb">base_time</a>(special_values);
  <a href="base_time.html#id689624-bb">base_time</a>(<span class="bold"><strong>const</strong></span> time_rep_type &amp;);
  <span class="emphasis"><em>// <a href="base_time.html#id724655-bb">public member functions</a></em></span>
  <span class="type">date_type</span> <a href="base_time.html#id724660-bb">date</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">time_duration_type</span> <a href="base_time.html#id724673-bb">time_of_day</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">std::string</span> <a href="base_time.html#id724686-bb">zone_name</a>(<span class="bold"><strong>bool</strong></span> = false) <span class="bold"><strong>const</strong></span>;
  <span class="type">std::string</span> <a href="base_time.html#id828497-bb">zone_abbrev</a>(<span class="bold"><strong>bool</strong></span> = false) <span class="bold"><strong>const</strong></span>;
  <span class="type">std::string</span> <a href="base_time.html#id828535-bb">zone_as_posix_string</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="base_time.html#id828553-bb">is_not_a_date_time</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="base_time.html#id726580-bb">is_infinity</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="base_time.html#id718630-bb">is_pos_infinity</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="base_time.html#id718647-bb">is_neg_infinity</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="base_time.html#id795507-bb">is_special</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="base_time.html#id719180-bb"><span class="bold"><strong>operator</strong></span>==</a>(<span class="bold"><strong>const</strong></span> time_type &amp;) <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="base_time.html#id718223-bb"><span class="bold"><strong>operator</strong></span>&lt;</a>(<span class="bold"><strong>const</strong></span> time_type &amp;) <span class="bold"><strong>const</strong></span>;
  <span class="type">time_duration_type</span> <a href="base_time.html#id803846-bb"><span class="bold"><strong>operator</strong></span>-</a>(<span class="bold"><strong>const</strong></span> time_type &amp;) <span class="bold"><strong>const</strong></span>;
  <span class="type">time_type</span> <a href="base_time.html#id803874-bb"><span class="bold"><strong>operator</strong></span>+</a>(<span class="bold"><strong>const</strong></span> date_duration_type &amp;) <span class="bold"><strong>const</strong></span>;
  <span class="type">time_type</span> <a href="base_time.html#id803902-bb"><span class="bold"><strong>operator</strong></span>+=</a>(<span class="bold"><strong>const</strong></span> date_duration_type &amp;) ;
  <span class="type">time_type</span> <a href="base_time.html#id721757-bb"><span class="bold"><strong>operator</strong></span>-</a>(<span class="bold"><strong>const</strong></span> date_duration_type &amp;) <span class="bold"><strong>const</strong></span>;
  <span class="type">time_type</span> <a href="base_time.html#id796021-bb"><span class="bold"><strong>operator</strong></span>-=</a>(<span class="bold"><strong>const</strong></span> date_duration_type &amp;) ;
  <span class="type">time_type</span> <a href="base_time.html#id834553-bb"><span class="bold"><strong>operator</strong></span>+</a>(<span class="bold"><strong>const</strong></span> time_duration_type &amp;) <span class="bold"><strong>const</strong></span>;
  <span class="type">time_type</span> <a href="base_time.html#id834581-bb"><span class="bold"><strong>operator</strong></span>+=</a>(<span class="bold"><strong>const</strong></span> time_duration_type &amp;) ;
  <span class="type">time_type</span> <a href="base_time.html#id834605-bb"><span class="bold"><strong>operator</strong></span>-</a>(<span class="bold"><strong>const</strong></span> time_duration_type &amp;) <span class="bold"><strong>const</strong></span>;
  <span class="type">time_type</span> <a href="base_time.html#id796489-bb"><span class="bold"><strong>operator</strong></span>-=</a>(<span class="bold"><strong>const</strong></span> time_duration_type &amp;) ;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1117231"></a><h2>Description</h2>
<p>This class is a skeleton for the interface of a temporal type with a resolution that is higher than a day. It is intended that this class be the base class and that the actual time class be derived using the BN pattern. In this way, the derived class can make decisions such as 'should there be a default constructor' and what should it set its value to, should there be optional constructors say allowing only an time_durations that generate a time from a clock,etc. So, in fact multiple time types can be created for a time_system with different construction policies, and all of them can perform basic operations by only writing a copy constructor. Finally, compiler errors are also shorter.</p>
<p>The real behavior of the time class is provided by the time_system template parameter. This class must provide all the logic for addition, subtraction, as well as define all the interface types. </p>
<div class="refsect2" lang="en">
<a name="id1117242"></a><h3>
<a name="base_timeconstruct-copy-destruct"></a><code class="computeroutput">base_time</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><a name="id796514-bb"></a>base_time(<span class="bold"><strong>const</strong></span> date_type &amp; day, <span class="bold"><strong>const</strong></span> time_duration_type &amp; td,
          dst_flags dst = not_dst);</pre></li>
<li><pre class="literallayout"><a name="id689610-bb"></a>base_time(special_values sv);</pre></li>
<li><pre class="literallayout"><a name="id689624-bb"></a>base_time(<span class="bold"><strong>const</strong></span> time_rep_type &amp; rhs);</pre></li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1117309"></a><h3>
<a name="id724655-bb"></a><code class="computeroutput">base_time</code> public member functions</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><span class="type">date_type</span> <a name="id724660-bb"></a>date() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">time_duration_type</span> <a name="id724673-bb"></a>time_of_day() <span class="bold"><strong>const</strong></span>;</pre></li>
<li>
<pre class="literallayout"><span class="type">std::string</span> <a name="id724686-bb"></a>zone_name(<span class="bold"><strong>bool</strong></span> as_offset = false) <span class="bold"><strong>const</strong></span>;</pre>
<p>Optional bool parameter will return time zone as an offset (ie "+07:00"). Empty string is returned for classes that do not use a time_zone </p>
</li>
<li>
<pre class="literallayout"><span class="type">std::string</span> <a name="id828497-bb"></a>zone_abbrev(<span class="bold"><strong>bool</strong></span> as_offset = false) <span class="bold"><strong>const</strong></span>;</pre>
<p>Optional bool parameter will return time zone as an offset (ie "+07:00"). Empty string is returned for classes that do not use a time_zone </p>
</li>
<li><pre class="literallayout"><span class="type">std::string</span> <a name="id828535-bb"></a>zone_as_posix_string() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id828553-bb"></a>is_not_a_date_time() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id726580-bb"></a>is_infinity() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id718630-bb"></a>is_pos_infinity() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id718647-bb"></a>is_neg_infinity() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id795507-bb"></a>is_special() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id719180-bb"></a><span class="bold"><strong>operator</strong></span>==(<span class="bold"><strong>const</strong></span> time_type &amp; rhs) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id718223-bb"></a><span class="bold"><strong>operator</strong></span>&lt;(<span class="bold"><strong>const</strong></span> time_type &amp; rhs) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">time_duration_type</span> <a name="id803846-bb"></a><span class="bold"><strong>operator</strong></span>-(<span class="bold"><strong>const</strong></span> time_type &amp; rhs) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">time_type</span> <a name="id803874-bb"></a><span class="bold"><strong>operator</strong></span>+(<span class="bold"><strong>const</strong></span> date_duration_type &amp; dd) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">time_type</span> <a name="id803902-bb"></a><span class="bold"><strong>operator</strong></span>+=(<span class="bold"><strong>const</strong></span> date_duration_type &amp; dd) ;</pre></li>
<li><pre class="literallayout"><span class="type">time_type</span> <a name="id721757-bb"></a><span class="bold"><strong>operator</strong></span>-(<span class="bold"><strong>const</strong></span> date_duration_type &amp; dd) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">time_type</span> <a name="id796021-bb"></a><span class="bold"><strong>operator</strong></span>-=(<span class="bold"><strong>const</strong></span> date_duration_type &amp; dd) ;</pre></li>
<li><pre class="literallayout"><span class="type">time_type</span> <a name="id834553-bb"></a><span class="bold"><strong>operator</strong></span>+(<span class="bold"><strong>const</strong></span> time_duration_type &amp; td) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">time_type</span> <a name="id834581-bb"></a><span class="bold"><strong>operator</strong></span>+=(<span class="bold"><strong>const</strong></span> time_duration_type &amp; td) ;</pre></li>
<li><pre class="literallayout"><span class="type">time_type</span> <a name="id834605-bb"></a><span class="bold"><strong>operator</strong></span>-(<span class="bold"><strong>const</strong></span> time_duration_type &amp; rhs) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">time_type</span> <a name="id796489-bb"></a><span class="bold"><strong>operator</strong></span>-=(<span class="bold"><strong>const</strong></span> time_duration_type &amp; td) ;</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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="gather_weekday_strings.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id831553"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="second_clock.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

101
doc/html/basic_command_line_parser.html Normal file
View file

@ -0,0 +1,101 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class template basic_command_line_parser</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="program_options/reference.html#id730253" title="Header &lt;boost/program_options/parsers.hpp&gt;">
<link rel="prev" href="id1104430.html" title="Class options_description_easy_init">
<link rel="next" href="basic_parsed_options.html" title="Class template basic_parsed_options">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="id1104430.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id730253"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="basic_parsed_options.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="basic_command_line_parser"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template basic_command_line_parser</span></h2>
<p>boost::program_options::basic_command_line_parser &#8212; </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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> charT&gt;
<span class="bold"><strong>class</strong></span> basic_command_line_parser {
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// <a href="basic_command_line_parser.html#basic_command_line_parserconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="basic_command_line_parser.html#id1138166-bb">basic_command_line_parser</a>(<span class="bold"><strong>const</strong></span> std::vector&lt; std::basic_string&lt; charT &gt; &gt; &amp;);
  <a href="basic_command_line_parser.html#id1009768-bb">basic_command_line_parser</a>(<span class="bold"><strong>int</strong></span>, charT *);
  <span class="emphasis"><em>// <a href="basic_command_line_parser.html#id762142-bb">public member functions</a></em></span>
  <span class="type"><a href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &amp;</span> <a href="basic_command_line_parser.html#id762147-bb">options</a>(<span class="bold"><strong>const</strong></span> <a href="options_description.html" title="Class options_description">options_description</a> &amp;) ;
  <span class="type"><a href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &amp;</span>
  <a href="basic_command_line_parser.html#id663575-bb">positional</a>(<span class="bold"><strong>const</strong></span> <a href="id683292.html" title="Class positional_options_description">positional_options_description</a> &amp;) ;
  <span class="type"><a href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &amp;</span> <a href="basic_command_line_parser.html#id1031754-bb">style</a>(<span class="bold"><strong>int</strong></span>) ;
  <span class="type"><a href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &amp;</span> <a href="basic_command_line_parser.html#id1008745-bb">extra_parser</a>(ext_parser) ;
  <span class="type"><a href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a>&lt; charT &gt;</span> <a href="basic_command_line_parser.html#id1140268-bb">run</a>() ;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1255000"></a><h2>Description</h2>
<p>Command line parser.</p>
<p>The class allows one to specify all the information needed for parsing and to parser the parse the command line. It is primarily needed to emulate named function parameters -- a regular function with 5 parameters will be hard to use and creating overloads with a smaller nuber of parameters will be confusing.</p>
<p>For the most common case, the function parse_command_line is a better alternative. </p>
<div class="refsect2" lang="en">
<a name="id1255017"></a><h3>
<a name="basic_command_line_parserconstruct-copy-destruct"></a><code class="computeroutput">basic_command_line_parser</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1">
<li>
<pre class="literallayout"><a name="id1138166-bb"></a>basic_command_line_parser(<span class="bold"><strong>const</strong></span> std::vector&lt; std::basic_string&lt; charT &gt; &gt; &amp; args);</pre>
<p>Creates a command line parser for the specified arguments list. The 'args' parameter should not include program name. </p>
</li>
<li>
<pre class="literallayout"><a name="id1009768-bb"></a>basic_command_line_parser(<span class="bold"><strong>int</strong></span> argc, charT * argv);</pre>
<p>Creates a command line parser for the specified arguments list. The parameter should be the same as passes to 'main'. </p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1255088"></a><h3>
<a name="id762142-bb"></a><code class="computeroutput">basic_command_line_parser</code> public member functions</h3>
<div class="orderedlist"><ol type="1">
<li>
<pre class="literallayout"><span class="type"><a href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &amp;</span> <a name="id762147-bb"></a>options(<span class="bold"><strong>const</strong></span> <a href="options_description.html" title="Class options_description">options_description</a> &amp; desc) ;</pre>
<p>Sets options descriptions to use. </p>
</li>
<li>
<pre class="literallayout"><span class="type"><a href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &amp;</span>
<a name="id663575-bb"></a>positional(<span class="bold"><strong>const</strong></span> <a href="id683292.html" title="Class positional_options_description">positional_options_description</a> &amp; desc) ;</pre>
<p>Sets positional options description to use. </p>
</li>
<li>
<pre class="literallayout"><span class="type"><a href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &amp;</span> <a name="id1031754-bb"></a>style(<span class="bold"><strong>int</strong></span> ) ;</pre>
<p>Sets the command line style. </p>
</li>
<li>
<pre class="literallayout"><span class="type"><a href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &amp;</span> <a name="id1008745-bb"></a>extra_parser(ext_parser ) ;</pre>
<p>Sets the extra parsers. </p>
</li>
<li><pre class="literallayout"><span class="type"><a href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a>&lt; charT &gt;</span> <a name="id1140268-bb"></a>run() ;</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"><small>Copyright © 2002-2004 Vladimir Prus</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="id1104430.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id730253"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="basic_parsed_options.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

74
doc/html/basic_option.html Normal file
View file

@ -0,0 +1,74 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class template basic_option</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="program_options/reference.html#id864937" title="Header &lt;boost/program_options/option.hpp&gt;">
<link rel="prev" href="validation_error.html" title="Class validation_error">
<link rel="next" href="duplicate_option_error.html" title="Class duplicate_option_error">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="validation_error.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id864937"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="duplicate_option_error.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="basic_option"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template basic_option</span></h2>
<p>boost::program_options::basic_option &#8212; </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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> charT&gt;
<span class="bold"><strong>class</strong></span> basic_option {
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// <a href="basic_option.html#basic_optionconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="basic_option.html#id1114467-bb">basic_option</a>();
  <a href="basic_option.html#id1042744-bb">basic_option</a>(<span class="bold"><strong>const</strong></span> std::string &amp;, <span class="bold"><strong>const</strong></span> std::vector&lt; std::string &gt; &amp;);
  <span class="emphasis"><em>// <a href="basic_option.html#id1004663-bb">public member functions</a></em></span>
  std::string string_key;
  int position_key;
  std::vector&lt; std::basic_string&lt; charT &gt; &gt; value;
  bool unregistered;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1252076"></a><h2>Description</h2>
<p>Option found in input source. Contains a key and a value. The key, in turn, can be a string (name of an option), or an integer (position in input source) -- in case no name is specified. The latter is only possible for command line. The template parameter specifies the type of char used for storing the option's value. </p>
<div class="refsect2" lang="en">
<a name="id1252087"></a><h3>
<a name="basic_optionconstruct-copy-destruct"></a><code class="computeroutput">basic_option</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><a name="id1114467-bb"></a>basic_option();</pre></li>
<li><pre class="literallayout"><a name="id1042744-bb"></a>basic_option(<span class="bold"><strong>const</strong></span> std::string &amp; string_key,
             <span class="bold"><strong>const</strong></span> std::vector&lt; std::string &gt; &amp; value);</pre></li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1252147"></a><h3>
<a name="id1004663-bb"></a><code class="computeroutput">basic_option</code> public member functions</h3>
<div class="orderedlist"><ol type="1"></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"><small>Copyright © 2002-2004 Vladimir Prus</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="validation_error.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id864937"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="duplicate_option_error.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

71
doc/html/basic_parsed_options.html Normal file
View file

@ -0,0 +1,71 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class template basic_parsed_options</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="program_options/reference.html#id730253" title="Header &lt;boost/program_options/parsers.hpp&gt;">
<link rel="prev" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">
<link rel="next" href="id1002952-bb.html" title="Class basic_parsed_options&lt;wchar_t&gt;">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basic_command_line_parser.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id730253"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="id1002952-bb.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="basic_parsed_options"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template basic_parsed_options</span></h2>
<p>boost::program_options::basic_parsed_options &#8212; </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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> charT&gt;
<span class="bold"><strong>class</strong></span> basic_parsed_options {
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// <a href="basic_parsed_options.html#basic_parsed_optionsconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="basic_parsed_options.html#id1081818-bb">basic_parsed_options</a>(<span class="bold"><strong>const</strong></span> <a href="options_description.html" title="Class options_description">options_description</a> *);
  <span class="emphasis"><em>// <a href="basic_parsed_options.html#id1081812-bb">public member functions</a></em></span>
  std::vector&lt; <a href="basic_option.html" title="Class template basic_option">basic_option</a>&lt; charT &gt; &gt; options;
  const <a href="options_description.html" title="Class options_description">options_description</a> * description;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1255371"></a><h2>Description</h2>
<p>Results of parsing an input source. The primary use of this class is passing information from parsers component to value storage component. This class does not makes much sense itself. </p>
<div class="refsect2" lang="en">
<a name="id1255380"></a><h3>
<a name="basic_parsed_optionsconstruct-copy-destruct"></a><code class="computeroutput">basic_parsed_options</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><a name="id1081818-bb"></a>basic_parsed_options(<span class="bold"><strong>const</strong></span> <a href="options_description.html" title="Class options_description">options_description</a> * description);</pre></li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1255428"></a><h3>
<a name="id1081812-bb"></a><code class="computeroutput">basic_parsed_options</code> public member functions</h3>
<div class="orderedlist"><ol type="1"></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1255446"></a><h3>Specializations</h3>
<div class="itemizedlist"><ul type="disc"><li><p><a href="id1002952-bb.html" title="Class basic_parsed_options&lt;wchar_t&gt;">Class basic_parsed_options&lt;wchar_t&gt;</a></p></li></ul></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"><small>Copyright © 2002-2004 Vladimir Prus</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basic_command_line_parser.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id730253"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="id1002952-bb.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

124
doc/html/bbv2.html Normal file
View file

@ -0,0 +1,124 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Part III. Boost.Build v2 User Manual</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="index.html" title="The Boost C++ Libraries">
<link rel="prev" href="boostbook/dtd/rationale.html" title="
BoostBook element rationale">
<link rel="next" href="bbv2/howto.html" title="Chapter 21. How to use this document">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boostbook/dtd/rationale.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="index.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="bbv2/howto.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="part" lang="en">
<div class="titlepage"><div><div><h1 class="title">
<a name="bbv2"></a>Boost.Build v2 User Manual</h1></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="chapter"><a href="bbv2/howto.html">21. How to use this document</a></span></dt>
<dt><span class="chapter"><a href="bbv2/installation.html">22. Installation</a></span></dt>
<dt><span class="chapter"><a href="bbv2/tutorial.html">23. Tutorial</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="bbv2/tutorial.html#bbv2.tutorial.hello">Hello, world</a></span></dt>
<dt><span class="section"><a href="bbv2/tutorial/properties.html">Properties</a></span></dt>
<dt><span class="section"><a href="bbv2/tutorial/hierarchy.html">Project Hierarchies</a></span></dt>
<dt><span class="section"><a href="bbv2/tutorial/libs.html">Dependent Targets</a></span></dt>
<dt><span class="section"><a href="bbv2/tutorial/linkage.html">Static and shared libaries</a></span></dt>
<dt><span class="section"><a href="bbv2/tutorial/conditions.html">Conditions and alternatives</a></span></dt>
<dt><span class="section"><a href="bbv2/tutorial/prebuilt.html">Prebuilt targets</a></span></dt>
</dl></dd>
<dt><span class="chapter"><a href="bbv2/advanced.html">24. User documentation</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="bbv2/advanced.html#bbv2.advanced.configuration">Configuration</a></span></dt>
<dt><span class="section"><a href="bbv2/advanced/jamfiles.html">Writing Jamfiles</a></span></dt>
<dt><span class="section"><a href="bbv2/advanced/build_process.html">The Build Process</a></span></dt>
<dt><span class="section"><a href="bbv2/advanced/builtins/targets.html">Builtin target types</a></span></dt>
<dt><span class="section"><a href="bbv2/advanced/builtins/features.html">Builtin features</a></span></dt>
<dt><span class="section"><a href="bbv2/advanced/differences_to_v1.html">Differences to Boost.Build V1</a></span></dt>
</dl></dd>
<dt><span class="chapter"><a href="bbv2/extender.html">25. Extender Manual</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="bbv2/extender.html#bbv2.extender.intro">Introduction</a></span></dt>
<dt><span class="section"><a href="bbv2/extending/targets.html">Target types</a></span></dt>
<dt><span class="section"><a href="bbv2/extending/tools.html">Tools and generators</a></span></dt>
<dt><span class="section"><a href="bbv2/extending/features.html">Features</a></span></dt>
<dt><span class="section"><a href="bbv2/extending/rules.html">Main target rules</a></span></dt>
<dt><span class="section"><a href="bbv2/extending/toolset_modules.html">Toolset modules</a></span></dt>
</dl></dd>
<dt><span class="chapter"><a href="bbv2/reference.html">26. Detailed reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="bbv2/reference.html#bbv2.reference.general">General information</a></span></dt>
<dt><span class="section"><a href="bbv2/reference/jamfiles.html">Writing Jamfiles</a></span></dt>
<dt><span class="section"><a href="bbv2/reference/buildprocess.html">Build process</a></span></dt>
<dt><span class="section"><a href="bbv2/reference/definitions.html">Definitions</a></span></dt>
<dt><span class="section"><a href="bbv2/reference/generators.html">Generators</a></span></dt>
</dl></dd>
<dt><span class="chapter"><a href="bbv2/faq.html">27. Frequently Asked Questions</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="bbv2/faq.html#id1708877">
I'm getting "Duplicate name of actual target" error. What
does it mean?
</a></span></dt>
<dt><span class="section"><a href="bbv2/faq/envar.html">
Accessing environment variables
</a></span></dt>
<dt><span class="section"><a href="bbv2/faq/s03.html">
How to control properties order?
</a></span></dt>
<dt><span class="section"><a href="bbv2/faq/s04.html">
How to control the library order on Unix?
</a></span></dt>
<dt><span class="section"><a href="bbv2/faq/external.html">Can I get output of external program as a variable in a Jamfile?
</a></span></dt>
<dt><span class="section"><a href="bbv2/faq/s06.html">How to get the project-root location?
</a></span></dt>
<dt><span class="section"><a href="bbv2/faq/s07.html">How to change compilation flags for one file?
</a></span></dt>
<dt><span class="section"><a href="bbv2/faq/dll-path.html">Why are the <code class="computeroutput">dll-path</code> and
<code class="computeroutput">hardcode-dll-paths</code> properties useful?
</a></span></dt>
<dt><span class="section"><a href="bbv2/recipies/site-config.html">Targets in site-config.jam</a></span></dt>
</dl></dd>
<dt><span class="appendix"><a href="bbv2/arch.html">B. Boost.Build v2 architecture</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="bbv2/arch.html#bbv2.arch.overview">Overview</a></span></dt>
<dt><span class="section"><a href="bbv2/arch/build.html">The build layer</a></span></dt>
<dt><span class="section"><a href="bbv2/arch/tools.html">The tools layer</a></span></dt>
<dt><span class="section"><a href="bbv2/arch/targets.html">Targets</a></span></dt>
</dl></dd>
</dl>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"><small><p>Last revised: December 29, 2004 at 22:17:38 GMT</p></small></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boostbook/dtd/rationale.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="index.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="bbv2/howto.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

255
doc/html/bbv2/advanced.html Normal file
View file

@ -0,0 +1,255 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 24. User documentation</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../bbv2.html" title="Part III. Boost.Build v2 User Manual">
<link rel="prev" href="tutorial/prebuilt.html" title="Prebuilt targets">
<link rel="next" href="advanced/jamfiles.html" title="Writing Jamfiles">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="tutorial/prebuilt.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bbv2.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="advanced/jamfiles.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="chapter" lang="en">
<div class="titlepage"><div><div><h2 class="title">
<a name="bbv2.advanced"></a>Chapter 24. User documentation</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="section"><a href="advanced.html#bbv2.advanced.configuration">Configuration</a></span></dt>
<dt><span class="section"><a href="advanced/jamfiles.html">Writing Jamfiles</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="advanced/jamfiles.html#bbv2.advanced.overview">Overview</a></span></dt>
<dt><span class="section"><a href="advanced/jamfiles.html#bbv2.advanced.targets">Main targets</a></span></dt>
<dt><span class="section"><a href="advanced/jamfiles.html#bbv2.advanced.projects">Projects</a></span></dt>
<dt><span class="section"><a href="advanced/jamfiles.html#bbv2.advanced.other-rules">Jamfile Utility Rules</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="advanced/build_process.html">The Build Process</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="advanced/build_process.html#id1704308">Build request</a></span></dt>
<dt><span class="section"><a href="advanced/build_process.html#id1704350">Building a main target</a></span></dt>
<dt><span class="section"><a href="advanced/build_process.html#id1704448">Building a project</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="advanced/builtins/targets.html">Builtin target types</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="advanced/builtins/targets.html#id1704505">Programs</a></span></dt>
<dt><span class="section"><a href="advanced/builtins/targets.html#id1704568">Libraries</a></span></dt>
<dt><span class="section"><a href="advanced/builtins/targets.html#bbv2.builtins.alias">Alias</a></span></dt>
<dt><span class="section"><a href="advanced/builtins/targets.html#bbv2.builtins.stage">Installing</a></span></dt>
<dt><span class="section"><a href="advanced/builtins/targets.html#bbv2.builtins.testing">Testing</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="advanced/builtins/features.html">Builtin features</a></span></dt>
<dt><span class="section"><a href="advanced/differences_to_v1.html">Differences to Boost.Build V1</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="advanced/differences_to_v1.html#bbv2.advanced.differences_to_v1.configuration">Configuration</a></span></dt>
<dt><span class="section"><a href="advanced/differences_to_v1.html#bbv2.advanced.differences_to_v1.jamfiles">Writing Jamfiles</a></span></dt>
<dt><span class="section"><a href="advanced/differences_to_v1.html#bbv2.advanced.differences_to_v1.build_process">Build process</a></span></dt>
</dl></dd>
</dl>
</div>
<p>This section will provide the information necessary to create your own
projects using Boost.Build. The information provided here is relatively
high-level, and <a href="reference.html" title="Chapter 26. Detailed reference">Chapter 26, <i>Detailed reference</i></a> as
well as the on-line help system must be used to obtain
low-level documentation (see <a href="reference.html#bbv2.reference.init.options.help">???</a>).</p>
<p>Boost.Build actually consists of two parts - Boost.Jam, a
build engine with its own interpreted language, and Boost.Build itself,
implemented in Boost.Jam's language. The chain of events when
you type <span><strong class="command">bjam</strong></span> on the command line is:
</p>
<div class="orderedlist"><ol type="1">
<li><p>Boost.Jam tries to find Boost.Build and loads the top-level
module. The exact process is described in <a href="reference.html#bbv2.reference.init" title="Initialization">the section called &#8220;Initialization&#8221;</a></p></li>
<li><p>The top-level module loads user-defined configuration
files, <code class="filename">user-config.jam</code> and <code class="filename">site-config.jam</code>, which define
available toolsets.</p></li>
<li><p>The Jamfile in the current directory is read. That in turn
might cause reading of further Jamfiles. As a result, a tree of
projects is created, with targets inside projects.</p></li>
<li><p>Finally, using the build request specified on the command line,
Boost.Build decides which targets should be built, and how. That
information is passed back to Boost.Jam, which takes care of
actually running commands.</p></li>
</ol></div>
<p>So, to be able to successfully use Boost.Build, you need to know only
three things:
</p>
<div class="itemizedlist"><ul type="disc">
<li><p><a href="advanced.html#bbv2.advanced.configuration" title="Configuration">
How to configure Boost.Build</a></p></li>
<li><p><a href="advanced/jamfiles.html" title="Writing Jamfiles">
How to write Jamfiles</a></p></li>
<li><p><a href="advanced/build_process.html" title="The Build Process">
How the build process works</a></p></li>
<li><p>Some Basics about the Boost.Jam language. See the
<a href="http://www.boost.org/tools/build/jam_src/index.html#jam_fundamentals" target="_top">Boost.Jam</a>
and <a href="http://www.boost.org/tools/build/jam_src/jam.html" target="_top">Classic
Jam</a> documentation.
</p></li>
</ul></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.advanced.configuration"></a>Configuration</h2></div></div></div>
<p>The Boost.Build configuration is specified in the file
<code class="filename">user-config.jam</code>. You can edit the one that comes with Boost.Build, or
create a copy in your home directory and edit that. (See the <a href="reference.html#bbv2.reference.init.config" title="Table 26.1. Search paths for configuration files">reference</a> for the exact search
paths.) The primary function of that file is to declare which compilers
and other tools are available. The simplest syntax to configure a tool is:
</p>
<pre class="programlisting">
using <em class="replaceable"><code>tool-name</code></em> ;
</pre>
<p>
The <code class="computeroutput">using</code> rule is given a name of tool, and will make that tool
available to Boost.Build. For example, <code class="computeroutput">using gcc ;</code> will make the gcc compiler
available.
</p>
<p>
Since nothing but a tool name is specified, Boost.Build will
pick some default settings. For example, it will use the
<span><strong class="command">gcc</strong></span> executable found in the
<code class="envar">PATH</code>, or look in some known installation
locations. In most cases, this strategy works automatically. In
case you have several versions of a compiler, it's installed in
some unusual location, or you need to tweak its configuration,
you'll need to pass additional parameters to the
<code class="computeroutput">using</code> rule. The parameters to
<code class="computeroutput">using</code> can be different for each
tool. You can obtain specific documentation for any tool's
configuration parameters by invoking
</p>
<pre class="programlisting">
bjam --help <em class="replaceable"><code>tool-name</code></em>.init
</pre>
<p>
That said, for all the compiler toolsets Boost.Build supports
out-of-the-box, the list of parameters to
<code class="computeroutput">using</code> is the same: <em class="parameter"><code>toolset-name</code></em>, <em class="parameter"><code>version</code></em>, <em class="parameter"><code>invocation-command</code></em>, and <em class="parameter"><code>options</code></em>.
</p>
<p>The <em class="parameter"><code>version</code></em>
parameter identifies the toolset version, in case you have
several installed. It can have any form you like, but
it's recommended that you use a numeric identifier like
<code class="literal">7.1</code>.
</p>
<p>
The <em class="parameter"><code>invocation-command</code></em>
parameter is the command that must be executed to run the
compiler. This parameter can usually be omitted if the compiler
executable
</p>
<div class="itemizedlist"><ul type="disc">
<li><p>has its &#8220;usual
name&#8221; and is in the <code class="envar">PATH</code>,
or</p></li>
<li><p>was installed in a standard
&#8220;installation directory&#8221;,
or</p></li>
<li><p>can be found through a global mechanism like the
Windows registry.</p></li>
</ul></div>
<p>
For example:
</p>
<pre class="programlisting">
using msvc : 7.1 ;
using gcc ;
</pre>
<p>
If the compiler can be found in the <code class="envar">PATH</code> but only by a
nonstandard name, you can just supply that name:
</p>
<pre class="programlisting">
using gcc : : g++-3.2 ;
</pre>
<p>
Otherwise, it might be necessary to supply the complete path to the
compiler executable:
</p>
<pre class="programlisting">
using msvc : : Z:/Programs/Microsoft Visual Studio/vc98/bin/cl ;
</pre>
<p>
Some Boost.Build toolsets will use that path to take additional
actions required before invoking the compiler, such as calling
vendor-supplied scripts to set up its required environment variables.
</p>
<p>To configure several versions of a toolset, simply invoke
the <code class="computeroutput">using</code> rule multiple times:
</p>
<pre class="programlisting">
using gcc : 3.3 ;
using gcc : 3.4 : g++-3.4 ;
using gcc : 3.2 : g++-3.2 ;
</pre>
<p>
Note that in the first call to
<code class="computeroutput">using</code>, the compiler found in the
<code class="envar">PATH</code> will be used, and there's no need to
explicitly specify the command.
</p>
<p>As shown above, both the <em class="parameter"><code>version</code></em> and <em class="parameter"><code>invocation-command</code></em> parameters are
optional, but there's an important restriction: if you configure
the same toolset more than once, you must pass the <em class="parameter"><code>version</code></em>
parameter every time. For example, the following is not allowed:
</p>
<pre class="programlisting">
using gcc ;
using gcc : 3.4 : g++-3.4 ;
</pre>
<p>
because the first <code class="computeroutput">using</code> call does
not specify a <em class="parameter"><code>version</code></em>.
</p>
<p>The <em class="parameter"><code>options</code></em>
parameter is used to fine-tune the configuration. All of
Boost.Build's standard compiler toolsets accept properties of the
four builtin features <code class="varname">cflags</code>,
<code class="varname">cxxflags</code>, <code class="varname">compileflags</code> and
<code class="varname">linkflags</code> as <em class="parameter"><code>options</code></em> specifying flags that will be
always passed to the corresponding tools. Values of the
<code class="varname">cflags</code> feature are passed directly to the C
compiler, values of the <code class="varname">cxxflags</code> feature are
passed directly to the C++ compiler, and values of the
<code class="varname">compileflags</code> feature are passed to both. For
example, to configure a <span><strong class="command">gcc</strong></span> toolset so that it
always generates 64-bit code you could write:
</p>
<pre class="programlisting">
using gcc : 3.4 : : &lt;compileflags&gt;-m64 &lt;linkflags&gt;-m64 ;
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="tutorial/prebuilt.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bbv2.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="advanced/jamfiles.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

194
doc/html/bbv2/advanced/build_process.html Normal file
View file

@ -0,0 +1,194 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>The Build Process</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../advanced.html" title="Chapter 24. User documentation">
<link rel="prev" href="jamfiles.html" title="Writing Jamfiles">
<link rel="next" href="builtins/targets.html" title="Builtin target types">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="jamfiles.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../advanced.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="builtins/targets.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.advanced.build_process"></a>The Build Process</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="build_process.html#id1704308">Build request</a></span></dt>
<dt><span class="section"><a href="build_process.html#id1704350">Building a main target</a></span></dt>
<dt><span class="section"><a href="build_process.html#id1704448">Building a project</a></span></dt>
</dl></div>
<p>When you've described your targets, you want Boost.Build to run the
right tools and create the needed targets.
This section will describe
two things: how you specify what to build, and how the main targets are
actually constructed.
</p>
<p>The most important thing to note is that in Boost.Build, unlike
other build tools, the targets you declare do not correspond to specific
files. What you declare in a Jamfile is more like a &#8220;metatarget.&#8221;
Depending on the properties you specify on the command line,
each metatarget will produce a set of real targets corresponding
to the requested properties. It is quite possible that the same
metatarget is built several times with different properties,
producing different files.
</p>
<div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Tip</h3>
<p>
This means that for Boost.Build, you cannot directly obtain a build
variant from a Jamfile. There could be several variants requested by the
user, and each target can be built with different properties.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id1704308"></a>Build request</h3></div></div></div>
<p>
The command line specifies which targets to build and with which
properties. For example:
</p>
<pre class="programlisting">
bjam app1 lib1//lib1 toolset=gcc variant=debug optimization=full
</pre>
<p>
would build two targets, "app1" and "lib1//lib1" with the specified
properties. You can refer to any targets, using
<a href="../reference/definitions.html#bbv2.reference.ids" title="Target identifiers and references">target id</a> and specify arbitrary
properties. Some of the properties are very common, and for them the name
of the property can be omitted. For example, the above can be written as:
</p>
<pre class="programlisting">
bjam app1 lib1//lib1 gcc debug optimization=full
</pre>
<p>
The complete syntax, which has some additional shortcuts, is
described in <a href="../reference.html#bbv2.reference.commandline" title="Command line">the section called &#8220;Command line&#8221;</a>.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id1704350"></a>Building a main target</h3></div></div></div>
<p>When you request, directly or indirectly, a build of a main target
with specific requirements, the following steps are made. Some brief
explanation is provided, and more details are given in <a href="../reference/buildprocess.html" title="Build process">the section called &#8220;Build process&#8221;</a>.
</p>
<div class="orderedlist"><ol type="1">
<li><p>Applying default build. If the default-build
property of a target specifies a value of a feature that is not
present in the build request, that value is added.</p></li>
<li><p>Selecting the main target alternative to use. For
each alternative we look how many properties are present both in
alternative's requirements, and in build request. The
alternative with large number of matching properties is selected.
</p></li>
<li><p>Determining "common" properties.
The build request
is <a href="../reference/definitions.html#bbv2.reference.variants.proprefine" title="Property refinement">refined</a>
with target's requirements.
The conditional properties in
requirements are handled as well. Finally, default values of
features are added.
</p></li>
<li><p>Building targets referred by the sources list and
dependency properties. The list of sources and the properties
can refer to other target using <a href="../reference/definitions.html#bbv2.reference.ids" title="Target identifiers and references">target references</a>. For each
reference, we take all <a href="../reference/definitions.html#bbv2.reference.features.attributes.propagated">propagated</a>
properties, refine them by explicit properties specified in the
target reference, and pass the resulting properties as build
request to the other target.
</p></li>
<li><p>Adding the usage requirements produced when building
dependencies to the "common" properties. When dependencies are
built in the previous step, they return
both the set of created
"real" targets, and usage requirements. The usage requirements
are added to the common properties and the resulting property
set will be used for building the current target.
</p></li>
<li><p>Building the target using generators. To convert the
sources to the desired type, Boost.Build uses "generators" ---
objects that correspond to tools like compilers and
linkers. Each generator declares what type of targets it
can
produce and what type of sources it requires. Using this
information, Boost.Build determines which generators must be run
to produce a specific target from specific sources. When
generators are run, they return the "real" targets.
</p></li>
<li><p>Computing the usage requirements to be returned. The
conditional properties in usage requirements are expanded
and the
result is returned.</p></li>
</ol></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id1704448"></a>Building a project</h3></div></div></div>
<p>Often, a user builds a complete project, not just one main
target. In fact, invoking <span><strong class="command">bjam</strong></span> without
arguments
builds the project defined in the current
directory.</p>
<p>When a project is built, the build request is passed without
modification to all main targets in that project.
It's is possible to
prevent implicit building of a target in a project with the
<code class="computeroutput">explicit</code> rule:
</p>
<pre class="programlisting">
explicit hello_test ;
</pre>
<p>
would cause the <code class="computeroutput">hello_test</code> target to be built only if
explicitly requested by the user or by some other target.
</p>
<p>The Jamfile for a project can include a number of
<code class="computeroutput">build-project</code> rule calls
that specify additional projects
to be built.
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="jamfiles.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../advanced.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="builtins/targets.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

172
doc/html/bbv2/advanced/builtins/features.html Normal file
View file

@ -0,0 +1,172 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Builtin features</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../../advanced.html" title="Chapter 24. User documentation">
<link rel="prev" href="targets.html" title="Builtin target types">
<link rel="next" href="../differences_to_v1.html" title="Differences to Boost.Build V1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="targets.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../advanced.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../differences_to_v1.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.advanced.builtins.features"></a>Builtin features</h2></div></div></div>
<div class="variablelist"><dl>
<dt><span class="term"><code class="literal">variant</code></span></dt>
<dd>
<p>
A feature that combines several low-level features, making
it easy to request common build configurations.
</p>
<p><span class="bold"><strong>Allowed values:</strong></span><code class="literal">debug</code>, <code class="literal">release</code>,
<code class="literal">profile</code></p>
<p>The value <code class="literal">debug</code> expands to</p>
<pre class="programlisting">
&lt;optimization&gt;off &lt;debug-symbols&gt;on &lt;inlining&gt;off &lt;runtime-debugging&gt;on
</pre>
<p>The value <code class="literal">release</code> expands to</p>
<pre class="programlisting">
&lt;optimization&gt;speed &lt;debug-symbols&gt;off &lt;inlining&gt;full &lt;runtime-debugging&gt;off
</pre>
<p>The value <code class="literal">profile</code> expands to the same as
<code class="literal">release</code>, plus:</p>
<pre class="programlisting">
&lt;profiling&gt;on &lt;debug-symbols&gt;on
</pre>
<p><span class="bold"><strong>Rationale:</strong></span> Runtime
debugging is on in debug builds to suit the expectations of
people used to various IDEs.
It's assumed other folks don't
have any specific expectation in this point.
</p>
</dd>
<dt>
<a name="bbv2.advanced.builtins.features.link"></a><span class="term"><code class="literal">link</code></span>
</dt>
<dd>
<p>
A feature that controls how libraries are built.
</p>
<p><span class="bold"><strong>Allowed values:</strong></span><code class="literal">shared</code>,
<code class="literal">static</code></p>
</dd>
<dt><span class="term"><code class="literal">source</code></span></dt>
<dd>
The <code class="computeroutput">&lt;source&gt;X</code> feature has the same effect on building a target
as putting X in the list of sources. The feature
is sometimes more convenient:
you can put <code class="computeroutput">&lt;source&gt;X</code> in the
requirements for a project and <code class="filename">X</code> will
be included as a source in all of the project's main
targets.
</dd>
<dt><span class="term"><code class="literal">library</code></span></dt>
<dd>
This feature is equivalent to the &lt;source&gt; feature, and exists
for backward compatibility reasons.
</dd>
<dt><span class="term"><a name="bbv2.builtin.features.dependency"></a><code class="literal">dependency</code></span></dt>
<dd>
Introduces a dependency on the target named by the
value of this feature (so it will be brought
up-to-date whenever the target being declared is), and
adds its usage requirements to the build properties
of the target being declared. The dependency is not used
in any other way. The primary use case is when you want
the usage requirements (such as <code class="computeroutput">#include</code> paths) of some
library to be applied, but don't want to link to it.
</dd>
<dt><span class="term"><a name="bbv2.builtin.features.use"></a><code class="literal">use</code></span></dt>
<dd>
Introduces a dependency on the target named by the
value of this feature (so it will be brought
up-to-date whenever the target being declared is), and
adds its usage requirements to the build properties
of the target being declared. The dependency is not used
in any other way. The primary use case is when you want
the usage requirements (such as <code class="computeroutput">#include</code> paths) of some
library to be applied, but don't want to link to it.
</dd>
<dt><span class="term"><code class="literal">dll-path</code></span></dt>
<dd>
Specify an additional directory where the system should
look for shared libraries when the executable or shared
library is run. This feature only affects Unix
compilers. Plase see <a href="../../faq/dll-path.html" title="Why are the dll-path and
hardcode-dll-paths properties useful?
">the section called &#8220;Why are the <code class="computeroutput">dll-path</code> and
<code class="computeroutput">hardcode-dll-paths</code> properties useful?
&#8221;</a>
in <a href="../../faq.html" title="Chapter 27. Frequently Asked Questions">Chapter 27, <i>Frequently Asked Questions</i></a> for details.
</dd>
<dt><span class="term"><code class="literal">hardcode-dll-paths</code></span></dt>
<dd>
<p>
Controls automatic generation of dll-path properties.
</p>
<p><span class="bold"><strong>Allowed values:</strong></span><code class="literal">true</code>, <code class="literal">false</code>. This property
is specific to Unix systems. If an executable is built with
<code class="computeroutput">&lt;hardcode-dll-paths&gt;true</code>, the generated binary
will contain the list of all the paths to the used shared
libraries. As the result, the executable can be run without
changing system paths to shared libraries or installing the
libraries to system paths. This
is very convenient during
development. Plase see the <a href="../../faq/dll-path.html" title="Why are the dll-path and
hardcode-dll-paths properties useful?
">FAQ entry</a> for details.
Note that on Mac OSX, the paths are unconditionally hardcoded by
the linker, and it's not possible to disable that behaviour.
</p>
</dd>
<dt>
<span class="term"><code class="literal">cflags</code>, </span><span class="term"><code class="literal">cxxflags</code>, </span><span class="term"><code class="literal">linkflags</code></span>
</dt>
<dd>
The value of those features is passed without modification to the
corresponding tools. For <code class="computeroutput">cflags</code> that's both C and C++
compilers, for <code class="computeroutput">cxxflags</code> that's C++ compiler and for
<code class="computeroutput">linkflags</code> that's linker. The features are handy when
you're trying to do something special that cannot be achieved by
higher-level feature in Boost.Build.
</dd>
</dl></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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="targets.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../advanced.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../differences_to_v1.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

390
doc/html/bbv2/advanced/builtins/targets.html Normal file
View file

@ -0,0 +1,390 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Builtin target types</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../../advanced.html" title="Chapter 24. User documentation">
<link rel="prev" href="../build_process.html" title="The Build Process">
<link rel="next" href="features.html" title="Builtin features">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../build_process.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../advanced.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="features.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.advanced.builtins.targets"></a>Builtin target types</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="targets.html#id1704505">Programs</a></span></dt>
<dt><span class="section"><a href="targets.html#id1704568">Libraries</a></span></dt>
<dt><span class="section"><a href="targets.html#bbv2.builtins.alias">Alias</a></span></dt>
<dt><span class="section"><a href="targets.html#bbv2.builtins.stage">Installing</a></span></dt>
<dt><span class="section"><a href="targets.html#bbv2.builtins.testing">Testing</a></span></dt>
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id1704505"></a>Programs</h3></div></div></div>
<p>Programs are created using the <code class="computeroutput">exe</code> rule, which
follows the <a href="../jamfiles.html#bbv2.main-target-rule-syntax">common
syntax</a>. For example:
</p>
<pre class="programlisting">
exe hello : hello.cpp some_library.lib /some_project//library
: &lt;threading&gt;multi
;
</pre>
<p>
This will create an executable file from the sources -- in this case,
one C++ file, one library file present in the same directory, and
another library that is created by Boost.Build. Generally, sources
can include C and C++ files, object files and libraries. Boost.Build
will automatically try to convert targets of other types.
</p>
<div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Tip</h3>
<p>
On Windows, if an application uses dynamic libraries, and both
the application and the libraries are built by Boost.Build, its not
possible to immediately run the application, because the
<code class="literal">PATH</code> environment variable should include the path
to the libraries. It means you have to either add the paths
manually, or place the application and the libraries to the same
directory, for example using the <a href="targets.html#bbv2.builtins.stage" title="Installing">
stage</a> rule.
</p>
</div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id1704568"></a>Libraries</h3></div></div></div>
<p>Libraries are created using the <code class="computeroutput">lib</code> rule, which
follows the <a href="../jamfiles.html#bbv2.main-target-rule-syntax">common
syntax</a>. For example:
</p>
<pre class="programlisting">
lib helpers : helpers.cpp : &lt;include&gt;boost : : &lt;include&gt;. ;
</pre>
<p>In the most common case, the <code class="computeroutput">lib</code> creates a library
from the specified sources. Depending on the value of
&lt;link&gt; feature the library will be either static or
shared. There are two other cases. First is when the library is
installed somewhere in compiler's search paths, and should be
searched by the compiler (typically, using the <code class="option">-l</code>
option). The second case is where the library is available as a
prebuilt file and the full path is known.
</p>
<p>
The syntax for these case is given below:
</p>
<pre class="programlisting">
lib z : : &lt;name&gt;z &lt;search&gt;/home/ghost ;
lib compress : : &lt;file&gt;/opt/libs/compress.a ;
</pre>
<p>
The <code class="computeroutput">name</code> property specifies the name that should be
passed to the <code class="option">-l</code> option, and the <code class="computeroutput">file</code>
property specifies the file location. The <code class="varname">search</code> feature
specifies paths in which to search for the library. That feature can
be specified several times, or it can be omitted, in which case only
default compiler paths will be searched.
</p>
<p>The difference between using the <code class="varname">file</code> feature as
opposed to the <code class="varname">name</code> feature together with the
<code class="varname">search</code> feature is that <code class="varname">file</code> is more
precise. A specific file will be used. On the other hand, the
<code class="varname">search</code> feature only adds a library path, and the
<code class="varname">name</code> feature gives the basic name of the library. The
search rules are specific to the linker. For example, given these
definition:
</p>
<pre class="programlisting">
lib a : : &lt;variant&gt;release &lt;file&gt;/pool/release/a.so ;
lib a : : &lt;variant&gt;debug &lt;file&gt;/pool/debug/a.so ;
lib b : : &lt;variant&gt;release &lt;file&gt;/pool/release/b.so ;
lib b : : &lt;variant&gt;debug &lt;file&gt;/pool/debug/b.so ;
</pre>
<p>
It's possible to use release version of <code class="computeroutput">a</code> and debug
version of <code class="computeroutput">b</code>. Had we used the <code class="varname">name</code> and
<code class="varname">search</code> features, the linker would always pick either
release or debug versions.
</p>
<p>
For convenience, the following syntax is allowed:
</p>
<pre class="programlisting">
lib z ;
lib gui db aux ;
</pre>
<p>
and is does exactly the same as:
</p>
<pre class="programlisting">
lib z : : &lt;name&gt;z ;
lib gui : : &lt;name&gt;gui ;
lib db : : &lt;name&gt;db ;
lib aux : : &lt;name&gt;aux ;
</pre>
<p>When a library uses another library you should put that another
library in the list of sources. This will do the right thing in all
cases. For portability, you should specify library dependencies even
for searched and prebuilt libraries, othewise, static linking on
Unix won't work. For example:
</p>
<pre class="programlisting">
lib z ;
lib png : z : &lt;name&gt;png ;
</pre>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>When a library (say, <code class="computeroutput">a</code>), that has another
library, (say, <code class="computeroutput">b</code>)
is linked dynamically, the <code class="computeroutput">b</code>
library will be incorporated
in <code class="computeroutput">a</code>. (If <code class="computeroutput">b</code>
is dynamic library as well, then <code class="computeroutput">a</code> will only refer to
it, and not include any extra code.)
When the <code class="computeroutput">a</code>
library is linked statically, Boost.Build will assure that all
executables that link to <code class="computeroutput">a</code> will also link to
<code class="computeroutput">b</code>.
</p>
</div>
<p>One feature of Boost.Build that is very important for libraries
is usage requirements.
For example, if you write:
</p>
<pre class="programlisting">
lib helpers : helpers.cpp : : : &lt;include&gt;. ;
</pre>
<p>
then the compiler include path for all targets that use
<code class="computeroutput">helpers</code> will contain the directory
where the target is defined.path to "helpers.cpp". The user
only needs to add <code class="computeroutput">helpers</code> to the list of sources,
and needn't consider the requirements its use imposes on a
dependent target. This feature greatly simplifies Jamfiles.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>If you don't want shared libraries to include all libraries
that are specified in sources (especially statically linked ones),
you'd need to use the following:
</p>
<pre class="programlisting">
lib b : a.cpp ;
lib a : a.cpp : &lt;use&gt;b : : &lt;library&gt;b ;
</pre>
<p>
This specifies that <code class="computeroutput">a</code> uses <code class="computeroutput">b</code>, and causes
all executables that link to <code class="computeroutput">a</code> also link to
<code class="computeroutput">b</code>. In this case, even for shared linking, the
<code class="computeroutput">a</code> library won't even refer to <code class="computeroutput">b</code>.
</p>
</div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.builtins.alias"></a>Alias</h3></div></div></div>
<p>The <code class="computeroutput">alias</code> rule follows the <a href="../jamfiles.html#bbv2.main-target-rule-syntax">common syntax</a>. For
example:
</p>
<pre class="programlisting">
alias core : im reader writer ;
</pre>
<p>
will build the sources
and return
the generated source targets
without modification.
</p>
<p>
The <code class="computeroutput">alias</code> rule is a convenience tool. If you often build
the same group of targets at the same time, you can define an alias
to save typing.
</p>
<p>
Another use of the <code class="computeroutput">alias</code> rule is to change build
properties. For example, if you always want static linking for a
specific C++ Boost library, you can write the following:
</p>
<pre class="programlisting">
alias threads : /boost/thread//boost_thread : &lt;link&gt;static ;
</pre>
<p>
and use only the <code class="computeroutput">threads</code> alias in your Jamfiles.
</p>
<p>
You can also specify usage requirements for the
<code class="computeroutput">alias</code> target. If you write the following:
</p>
<pre class="programlisting">
alias header_only_library : : : : &lt;include&gt;/usr/include/header_only_library ;
</pre>
<p>
then using <code class="computeroutput">header_only_library</code> in sources will only add an
include path. Also note that when there are some sources, their usage
requirements are propagated, too. For example:
</p>
<pre class="programlisting">
lib lib : lib.cpp : : : &lt;include&gt;. ;
alias lib_alias ;
exe main : main.cpp lib_alias ;
</pre>
<p>
will compile <code class="filename">main.cpp</code> with the additional include.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.builtins.stage"></a>Installing</h3></div></div></div>
<p>For installing a built target you should use the
<code class="computeroutput">install</code> rule, which follows the <a href="../jamfiles.html#bbv2.main-target-rule-syntax">common syntax</a>. For
example:
</p>
<pre class="programlisting">
install dist : hello helpers ;
</pre>
<p>
will cause the targets <code class="computeroutput">hello</code> and <code class="computeroutput">helpers</code> to
be moved to the <code class="filename">dist</code> directory, relative to
Jamfile's directory. The directory can
be changed with the <code class="computeroutput">location</code> property:
</p>
<pre class="programlisting">
install dist : hello helpers : &lt;location&gt;/usr/bin ;
</pre>
<p>
While you can achieve the same effect by changing the target name to
<code class="filename">/usr/bin</code>, using the <code class="computeroutput">location</code>
property is better, because it allows you to use a memnonic target
name.
</p>
<p>The <code class="computeroutput">location</code> property is especially handy when the location
is not fixed, but depends on build variant or environment variables:
</p>
<pre class="programlisting">
install dist : hello helpers : &lt;variant&gt;release:&lt;location&gt;dist/release
&lt;variant&gt;debug:&lt;location&gt;dist/debug ;
install dist2 : hello helpers : &lt;location&gt;$(DIST) ;
</pre>
<p>
See also <a href="../../reference/definitions.html#bbv2.reference.variants.propcond" title="Conditional properties">conditional
properties</a> and <a href="../../faq/envar.html" title="
Accessing environment variables
">environment variables</a></p>
<p>
Specifying the names of all libraries to install can be boring. The
<code class="computeroutput">install</code> allows you to specify only the top-level executable
targets to install, and automatically install all dependencies:
</p>
<pre class="programlisting">
install dist : hello
: &lt;install-dependencies&gt;on &lt;install-type&gt;EXE
&lt;install-type&gt;LIB
;
</pre>
<p>
will find all targets that <code class="computeroutput">hello</code> depends on, and install
all of the which are either executables or libraries. More
specifically, for each target, other targets that were specified as
sources or as dependency properties, will be recursively found. One
exception is that targets referred with the <a href="features.html#bbv2.builtin.features.use"><code class="computeroutput">use</code></a> feature
are not considered, because that feature is typically used to refer to
header-only libraries.
If the set of target types is specified, only targets of that type
will be installed, otherwise, all found target will be installed.
</p>
<p>The <a href="targets.html#bbv2.builtins.alias" title="Alias"><code class="computeroutput">alias</code></a>
rule can be used when targets must be installed into several
directories:
</p>
<pre class="programlisting">
install install : install-bin install-lib ;
install install-bin : applications : /usr/bin ;
install install-lib : helper : /usr/lib ;
</pre>
<p>Because the <code class="computeroutput">install</code> rule just copies targets, most
free features <sup>[<a name="id1705185" href="#ftn.id1705185">6</a>]</sup>
have no effect when used in requirements of the <code class="computeroutput">install</code>.
The only two which matter are
<a href="features.html#bbv2.builtin.features.dependency"><code class="varname">dependency</code></a> and, on Unix,
<code class="varname">dll-path</code>.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
(Unix specific). On Unix, executables built with Boost.Build typically
contain the list of paths to all used dynamic libraries. For
installing, this is not desired, so Boost.Build relinks the executable
with an empty list of paths. You can also specify additional paths for
installed executables with the <code class="varname">dll-path</code> feature.
</p>
</div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.builtins.testing"></a>Testing</h3></div></div></div>
<p>Boost.Build has convenient support for running unit tests. The
simplest way is the <code class="computeroutput">unit-test</code> rule, which follows the
<a href="../jamfiles.html#bbv2.main-target-rule-syntax">common syntax</a>. For
example:
</p>
<pre class="programlisting">
unit-test helpers_test : helpers_test.cpp helpers ;
</pre>
<p>The <code class="computeroutput">unit-test</code> rule behaves like the
<code class="computeroutput">exe</code> rule, but after the executable is created it is
run. If the executable returns an error code, the build system will also
return an error and will try running the executable on the next
invocation until it runs successfully. This behaviour ensures that you
can't miss a unit test failure.
</p>
<p>There are rules for more elaborate testing: <code class="computeroutput">compile</code>,
<code class="computeroutput">compile-fail</code>, <code class="computeroutput">run</code> and
<code class="computeroutput">run-fail</code>. They are more suitable for automated testing, and
are not covered here.
</p>
</div>
<div class="footnotes">
<br><hr width="100" align="left">
<div class="footnote"><p><sup>[<a name="ftn.id1705185" href="#id1705185">6</a>] </sup>see the definition of "free" in <a href="../../reference/definitions.html#bbv2.reference.features.attributes" title="Feature Attributes">the section called &#8220;Feature Attributes&#8221;</a>.</p></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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../build_process.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../advanced.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="features.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

138
doc/html/bbv2/advanced/differences_to_v1.html Normal file
View file

@ -0,0 +1,138 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Differences to Boost.Build V1</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../advanced.html" title="Chapter 24. User documentation">
<link rel="prev" href="builtins/features.html" title="Builtin features">
<link rel="next" href="../extender.html" title="Chapter 25. Extender Manual">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="builtins/features.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../advanced.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../extender.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.advanced.differences_to_v1"></a>Differences to Boost.Build V1</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="differences_to_v1.html#bbv2.advanced.differences_to_v1.configuration">Configuration</a></span></dt>
<dt><span class="section"><a href="differences_to_v1.html#bbv2.advanced.differences_to_v1.jamfiles">Writing Jamfiles</a></span></dt>
<dt><span class="section"><a href="differences_to_v1.html#bbv2.advanced.differences_to_v1.build_process">Build process</a></span></dt>
</dl></div>
<p>While Boost.Build V2 is based on the same ideas as Boost.Build V1,
some of the syntax was changed, and some new important features were
added. This chapter describes most of the changes.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.advanced.differences_to_v1.configuration"></a>Configuration</h3></div></div></div>
<p>In V1, there were two methods to configure a toolset. One was to
set some environment variable, or use the <code class="option">-s</code> command line option to set
a variable inside BJam.
Another method was to create a new toolset module that would set
the variables and then invoke the base toolset. Neither method
is necessary now: the <code class="computeroutput">using</code> rule provides a consistent way to
initialize a toolset,
including several versions. See <a href="../advanced.html#bbv2.advanced.configuration" title="Configuration">the section called &#8220;Configuration&#8221;</a> for details.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.advanced.differences_to_v1.jamfiles"></a>Writing Jamfiles</h3></div></div></div>
<p>Probably one of the most important differences in V2 Jamfiles is
the use of project requirements. In V1, if several targets had the same
requirements (for example, a common <code class="computeroutput">#include</code> path), it was necessary to
manually write the requirements or use a helper rule or template target. In V2, the
common properties can be specified with the <code class="computeroutput">requirements</code> project
attribute, as documented in <a href="jamfiles.html#bbv2.advanced.projects" title="Projects">the section called &#8220;Projects&#8221;</a>.
</p>
<p><a href="../tutorial/libs.html" title="Dependent Targets">Usage requirements</a>
also help to simplify Jamfiles.
If a library requires
all clients to use specific <code class="computeroutput">#include</code> paths or macros when compiling
code that depends on the library, that information can be cleanly
represented.</p>
<p>The difference between <code class="computeroutput">lib</code> and <code class="computeroutput">dll</code> targets in V1 is completely
eliminated in V2. There's only one library target type, <code class="computeroutput">lib</code>, which can create
either static or shared libraries depending on the value of the
<a href="builtins/features.html#bbv2.advanced.builtins.features.link"><code class="varname">&lt;link&gt;</code>
feature</a>. If your target should be only built in one way, you
can add <code class="computeroutput">&lt;link&gt;shared</code> or <code class="computeroutput">&lt;link&gt;static</code> to its requirements.
</p>
<p>The syntax for referring to other targets was changed a bit. While
in V1 one would use:
</p>
<pre class="programlisting">
exe a : a.cpp &lt;lib&gt;../foo/bar ;
</pre>
<p>
the V2 syntax is:
</p>
<pre class="programlisting">
exe a : a.cpp ../foo//bar ;
</pre>
<p>
Note that you don't need to specify the type of other target, but the
last element should be separated from the others by a double slash to indicate that
you're referring to target <code class="filename">bar</code> in project <code class="filename">../foo</code>, and not to
project <code class="filename">../foo/bar</code>.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.advanced.differences_to_v1.build_process"></a>Build process</h3></div></div></div>
<p>The command line syntax in V2 is completely different. For example
</p>
<pre class="programlisting">
bjam -sTOOLS=msvc -sBUILD=release some_target
</pre>
<p>
now becomes:
</p>
<pre class="programlisting">
bjam toolset=msvc variant=release some_target
</pre>
<p>
or, using implicit features, just:
</p>
<pre class="programlisting">
bjam msvc release some_target
</pre>
<p>
See <a href="../reference.html#bbv2.reference.commandline" title="Command line">the reference</a> for a
complete description of the syntax.
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="builtins/features.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../advanced.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../extender.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

465
doc/html/bbv2/advanced/jamfiles.html Normal file
View file

@ -0,0 +1,465 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Writing Jamfiles</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../advanced.html" title="Chapter 24. User documentation">
<link rel="prev" href="../advanced.html" title="Chapter 24. User documentation">
<link rel="next" href="build_process.html" title="The Build Process">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../advanced.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../advanced.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="build_process.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.advanced.jamfiles"></a>Writing Jamfiles</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="jamfiles.html#bbv2.advanced.overview">Overview</a></span></dt>
<dt><span class="section"><a href="jamfiles.html#bbv2.advanced.targets">Main targets</a></span></dt>
<dt><span class="section"><a href="jamfiles.html#bbv2.advanced.projects">Projects</a></span></dt>
<dt><span class="section"><a href="jamfiles.html#bbv2.advanced.other-rules">Jamfile Utility Rules</a></span></dt>
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.advanced.overview"></a>Overview</h3></div></div></div>
<p>Jamfiles are the thing that is most important to the user,
bacause they declare the targets that should be built.
Jamfiles are also used for organizing targets&#8212;
each Jamfile is a separate project
that can be built independently from the other projects.
</p>
<p>Jamfiles mostly contain calls to Boost.Build functions that do
all the work, specifically:
</p>
<div class="itemizedlist"><ul type="disc">
<li><p><a href="jamfiles.html#bbv2.advanced.targets" title="Main targets">declare main
targets</a></p></li>
<li><p><a href="jamfiles.html#bbv2.advanced.projects" title="Projects">define
project properties</a></p></li>
<li><p><a href="jamfiles.html#bbv2.advanced.other-rules" title="Jamfile Utility Rules">do various other
things</a></p></li>
</ul></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.advanced.targets"></a>Main targets</h3></div></div></div>
<p><a name="bbv2.advanced.targets.main"></a>
A <em class="firstterm">Main target</em> is a user-defined named
entity that can be built, for example an executable file.
Declaring a main target is usually done using one of the main
target rules described in <a href="builtins/targets.html" title="Builtin target types">the section called &#8220;Builtin target types&#8221;</a>. The user can also declare
custom main target rules as shown in <a href="../extending/rules.html" title="Main target rules">the section called &#8220;Main target rules&#8221;</a>.
</p>
<p>Most main target rules in Boost.Build can be invoked with
a common syntax:</p>
<a name="bbv2.main-target-rule-syntax"></a><pre class="programlisting"><em class="replaceable"><code>rule-name</code></em>&#8194;<em class="replaceable"><code>main-target-name</code></em>
: <em class="replaceable"><code>sources...</code></em>
: <em class="replaceable"><code>requirements...</code></em>
: <em class="replaceable"><code>default-build...</code></em>
: <em class="replaceable"><code>usage-requirements...</code></em>
;
</pre>
<div class="itemizedlist"><ul type="disc">
<li>
<em class="parameter"><code>main-target-name</code></em> is the name used
to request the target on command line and to use it from
other main targets. A main target name may contain
alphanumeric characters, dashes
(&#8216;<code class="computeroutput">-</code>&#8217;), and underscores
(&#8216;<code class="computeroutput">_</code>&#8217;).
</li>
<li>
<em class="parameter"><code>sources</code></em> is the list of source files and other main
targets that must be combined.
</li>
<li>
<em class="parameter"><code>requirements</code></em> is the list of properties that must always
be present when this main target is built.
</li>
<li>
<em class="parameter"><code>default-build</code></em> is the list of properties that will be used
unless some other value of the same feature is already
specified, e.g. on the command line or by propogation from a dependent target.
</li>
<li>
<em class="parameter"><code>usage-requirements</code></em> is the list of properties that will be
propagated to all main targets that use this one, i.e. to all its
dependents.
</li>
</ul></div>
<p>
Some main target rules have a shorter list of parameters;
consult their documentation for details.
</p>
<p>Note that the actual requirements, default-build and
usage-requirements attributes for a target are obtained by
combining the explicitly specified ones with those specified for
the project where a target is declared.
</p>
<p>The list of sources specifies what should be processed to
get the resulting targets. Most of the time, it's just a list of
files. Sometimes, you'll want to automatically construct the
list of source files rather than having to spell it out
manually, in which case you can use the
<code class="computeroutput">glob</code> rule. Here are two examples:
</p>
<pre class="programlisting">
exe a : a.cpp ; # a.cpp is the only source file
exe b : [ glob *.cpp ] ; # all .cpp files in this directory are sources
</pre>
<p>
Unless you specify a files with absolute path, the name is
considered relative to the source directory -- which is typically
the directory where the Jamfile is located, but can be changed as
described in <a href="jamfiles.html#bbv2.advanced.projects.attributes.projectrule" title="">the section called &#8220;Projects&#8221;</a>.
</p>
<p>
The list of sources can also refer to other main targets.
Targets in the same project can be referred to by name, while
targets in other projects need to be qualified with a directory or a symbolic
project name. For example:
</p>
<pre class="programlisting">
lib helper : helper.cpp ;
exe a : a.cpp helper ;
exe b : b.cpp ..//utils ;
exe c : c.cpp /boost/program_options//program_options ;
</pre>
<p>
The first exe uses the library defined in the same
project. The second one uses some target (most likely library)
defined by Jamfile one level higher. Finally, the third target
uses some <a href="http://boost.org" target="_top">C++ Boost</a>
library, referring to it by its absolute symbolic name. More
information about it can be found in <a href="../tutorial/libs.html" title="Dependent Targets">the section called &#8220;Dependent Targets&#8221;</a> and <a href="../reference/definitions.html#bbv2.reference.ids" title="Target identifiers and references">the section called &#8220;Target identifiers and references&#8221;</a>.
</p>
<p>Requirements are the properties that should always be present when
building a target. Typically, they are includes and defines:
</p>
<pre class="programlisting">
exe hello : hello.cpp : &lt;include&gt;/opt/boost &lt;define&gt;MY_DEBUG ;
</pre>
<p>
In special circumstances,
other properties can be used, for example if
a library can only be built statically, or a file can't be compiled
with optimization due to a compiler bug, one can use
</p>
<pre class="programlisting">
lib util : util.cpp : &lt;link&gt;static ;
obj main : main.cpp : &lt;optimization&gt;off ;
</pre>
<p>Sometimes requirements are necessary only for a specific
compiler or build variant. <a href="../reference/definitions.html#bbv2.reference.variants.propcond" title="Conditional properties">Conditional
properties</a> can be used in that case:
</p>
<pre class="programlisting">
lib util : util.cpp : &lt;toolset&gt;msvc:&lt;link&gt;static ;
</pre>
<p>
Whenever <code class="computeroutput">&lt;toolset&gt;msvc</code> property is
in build properties, the <code class="computeroutput">&lt;link&gt;static</code> property will
be included as well. Conditional requirements can be &#8220;chained&#8221;:
</p>
<pre class="programlisting">
lib util : util.cpp : &lt;toolset&gt;msvc:&lt;link&gt;static
&lt;link&gt;static:&lt;define&gt;STATIC_LINK ;
</pre>
<p>
will set of static link
and the <code class="computeroutput">STATIC_LINK</code> define on the
<code class="computeroutput">msvc</code> toolset.
</p>
<p>The <code class="varname">default-build</code> parameter
is a set of properties to be used if the build request does
not otherwise specify a value for features in the set. For example:
</p>
<pre class="programlisting">
exe hello : hello.cpp : : &lt;threading&gt;multi ;
</pre>
<p>
would build a multi-threaded target in unless the user
explicitly requests a single-threaded version. The difference between
requirements and default-build is that requirements cannot be
overriden in any way.</p>
<p>A target of the same name can be declared several times, in which
case each declaration is called an
<em class="firstterm">alternative</em>. When the target is built, one of
the alternatives will be selected and used. Alternatives need not be
defined by the same main target rule. For example,
</p>
<pre class="programlisting">
lib helpers : helpers.hpp ; # a header-only library
alias helpers : helpers.lib : &lt;toolset&gt;msvc ; # except on msvc
</pre>
<p>The actual commands used to build any given main target can differ greatly from
platform to platform. For example, you might have different lists
of sources for different compilers, or different options for those
compilers. Two approaches to this are explained in the
<a href="../tutorial/conditions.html" title="Conditions and alternatives">tutorial</a>.
</p>
<p>Sometimes a main target is really needed only by some other main
target. For example, a rule that declares a test-suite uses a main
target
that represent test, but those main targets are rarely needed
by themselves.
</p>
<p>It is possible to declare a target inline, i.e. the "sources"
parameter may include calls to other main rules. For example:</p>
<pre class="programlisting">
exe hello : hello.cpp
[ obj helpers : helpers.cpp : &lt;optimization&gt;off ] ;
</pre>
<p>
Will cause "helpers.cpp" to be always compiled without
optimization.
When referring to an inline main target, its declared name
must be prefixed by its parent target's name and two dots. In
the example above, to build only helpers, one should run
<code class="computeroutput">bjam hello..helpers</code>.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.advanced.projects"></a>Projects</h3></div></div></div>
<p>As mentioned before, targets are grouped into projects,
and each Jamfile is a separate project. Projects are useful
because they allow us to group related targets together, define
properties common to all those targets, and assign a symbolic
name to the project that can be used in referring to its
targets.
</p>
<p>Projects are named using the
<code class="computeroutput">project</code> rule, which has the
following syntax:
</p>
<pre class="programlisting">
project <em class="replaceable"><code>id</code></em> : <em class="replaceable"><code>attributes</code></em> ;
</pre>
<p>
Here, <em class="replaceable"><code>attributes</code></em> is a sequence of
rule arguments, each of which begins with an attribute-name
and is followed by any number of build properties.
The list
of attribute names along with its handling is also shown in
the table below. For example, it is possible to write:
</p>
<pre class="programlisting">
project tennis
: requirements &lt;threading&gt;multi
: default-build release
;
</pre>
<p>The possible attributes are listed below.</p>
<p><span class="emphasis"><em>Project id</em></span> is a short way to denote a project, as
opposed to the Jamfile's pathname. It is a hierarchical path,
unrelated to filesystem, such as "boost/thread". <a href="../reference/definitions.html#bbv2.reference.ids" title="Target identifiers and references">Target references</a> make use of project ids to
specify a target.</p>
<p><span class="emphasis"><em>Source location</em></span> specifies the directory where sources
for the project are located.</p>
<p><span class="emphasis"><em>Project requirements</em></span> are requirements that apply to
all the targets in the projects as well as all subprojects.</p>
<p><span class="emphasis"><em>Default build</em></span> is the build request that should be
used when no build request is specified explicitly.</p>
<p><a name="bbv2.advanced.projects.attributes.projectrule"></a>
The default values for those attributes are
given in the table below.
</p>
<div class="table">
<a name="id1703973"></a><p class="title"><b>Table 24.1. </b></p>
<table class="table" summary="">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Attribute</th>
<th>Name for the 'project' rule</th>
<th>Default value</th>
<th>Handling by the 'project' rule</th>
</tr></thead>
<tbody>
<tr>
<td>Project id</td>
<td>none</td>
<td>none</td>
<td>Assigned from the first parameter of the 'project' rule.
It is assumed to denote absolute project id.</td>
</tr>
<tr>
<td>Source location</td>
<td><code class="literal">source-location</code></td>
<td>The location of jamfile for the project</td>
<td>Sets to the passed value</td>
</tr>
<tr>
<td>Requirements</td>
<td><code class="literal">requirements</code></td>
<td>The parent's requirements</td>
<td>The parent's requirements are refined with the passed
requirement and the result is used as the project
requirements.</td>
</tr>
<tr>
<td>Default build</td>
<td><code class="literal">default-build</code></td>
<td>none</td>
<td>Sets to the passed value</td>
</tr>
<tr>
<td>Build directory</td>
<td><code class="literal">build-dir</code></td>
<td>Empty if the parent has no build directory set.
Otherwise, the parent's build directory with with the
relative path from parent to the current project
appended to it.
</td>
<td>Sets to the passed value, interpreted as relative to the
project's location.</td>
</tr>
</tbody>
</table>
</div>
<p>Besides defining projects and main targets, Jamfiles
commonly invoke utility rules such as
<code class="computeroutput">constant</code> and
<code class="computeroutput">path-constant</code>, which inject a
specified Boost.Jam variable setting into this project's Jamfile
module and those of all its subprojects. See <a href="jamfiles.html#bbv2.advanced.other-rules" title="Jamfile Utility Rules">the section called &#8220;Jamfile Utility Rules&#8221;</a> for a complete description
of these utility rules. Jamfiles are regular Boost.Jam source
files and Boost.Build modules, so naturally they can contain any kind of Boost.Jam code,
including rule definitions.
</p>
<p>Each subproject inherits attributes, constants and rules
from its parent project, which is defined by the nearest
Jamfile in an ancestor directory above
the subproject. The top-level project is declared in a file
called <code class="filename">Jamroot</code> rather than
<code class="filename">Jamfile</code>. When loading a project,
Boost.Build looks for either <code class="filename">Jamroot</code> or
<code class="computeroutput">Jamfile</code>. They are handled indentically, except
that if the file is called <code class="filename">Jamroot</code>, the
search for a parent project is not performed.
</p>
<p>Even when building in a subproject directory, parent
project files are always loaded before those of their
subprojects, so that every definition made in a parent project
is always available to its children. The loading order of any
other projects is unspecified. Even if one project refers to
another via <a href="../../"><code class="computeroutput">use-project</code></a>,
or a target reference, no specific order should be assumed.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>Giving the root project the special name
&#8220;<code class="filename">Jamroot</code>&#8221; ensures that
Boost.Build won't misinterpret a directory above it as the
project root just because the directory contains a Jamfile.
</p>
</div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.advanced.other-rules"></a>Jamfile Utility Rules</h3></div></div></div>
<p>The following table describes utility rules that can be
used in Jamfiles. Detailed information for any of these rules can
be obtained by running:
</p>
<pre class="screen">
bjam --help project.<em class="replaceable"><code>rulename</code></em></pre>
<div class="table">
<a name="id1704194"></a><p class="title"><b>Table 24.2. </b></p>
<table class="table" summary="">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Rule</th>
<th>Semantics</th>
</tr></thead>
<tbody>
<tr>
<td><a href="jamfiles.html#bbv2.advanced.projects.attributes.projectrule">project</a></td>
<td>Define this project's symbolic ID or attributes.</td>
</tr>
<tr>
<td><a href="../../">use-project</a></td>
<td>Make another project known so that it can be referred to by symbolic ID.</td>
</tr>
<tr>
<td><a href="../../">build-project</a></td>
<td>Cause another project to be built when this one is built.</td>
</tr>
<tr>
<td><a href="../../">explicit</a></td>
<td>State that a target should be built only by explicit
request.</td>
</tr>
<tr>
<td>glob</td>
<td>Translate a list of shell-style wildcards into a
corresponding list of files.</td>
</tr>
<tr>
<td>constant</td>
<td>Injects a variable setting into this project's
Jamfile module and those of all its subprojects.</td>
</tr>
<tr>
<td>path-constant</td>
<td>Injects a variable set to a path value into
this project's Jamfile module and those of all its subprojects.
If the value is a relative path it will be adjusted for
each subproject so that it refers to the same
directory.</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../advanced.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../advanced.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="build_process.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

77
doc/html/bbv2/arch.html Normal file
View file

@ -0,0 +1,77 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Appendix B. Boost.Build v2 architecture</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../bbv2.html" title="Part III. Boost.Build v2 User Manual">
<link rel="prev" href="recipies/site-config.html" title="Targets in site-config.jam">
<link rel="next" href="arch/build.html" title="The build layer">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="recipies/site-config.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bbv2.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="arch/build.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="appendix" lang="en">
<div class="titlepage"><div><div><h2 class="title">
<a name="bbv2.arch"></a>Appendix B. Boost.Build v2 architecture</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="section"><a href="arch.html#bbv2.arch.overview">Overview</a></span></dt>
<dt><span class="section"><a href="arch/build.html">The build layer</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="arch/build.html#bbv2.arch.metatargets">Metatargets</a></span></dt>
<dt><span class="section"><a href="arch/build.html#bbv2.arch.virtual">Virtual targets</a></span></dt>
<dt><span class="section"><a href="arch/build.html#bbv2.arch.properties"></a></span></dt>
</dl></dd>
<dt><span class="section"><a href="arch/tools.html">The tools layer</a></span></dt>
<dt><span class="section"><a href="arch/targets.html">Targets</a></span></dt>
<dd><dl><dt><span class="section"><a href="arch/targets.html#bbv2.arch.depends">Dependency scanning</a></span></dt></dl></dd>
</dl>
</div>
<div class="sidebar"><p>This document is work-in progress. Don't expect much from it
yet.</p></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.arch.overview"></a>Overview</h2></div></div></div>
<p>The Boost.Build code is structured in four different components:
"kernel", "util", "build" and "tools". The first two are relatively
uninteresting, so we'll focus on the remaining pair. The "build" component
provides classes necessary to declare targets, determine which properties
should be used for their building, and for creating the dependency
graph. The "tools" component provides user-visible functionality. It
mostly allows to declare specific kind of main targets, and declare
avaiable tools, which are then used when creating the dependency graph.
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="recipies/site-config.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bbv2.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="arch/build.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

196
doc/html/bbv2/arch/build.html Normal file
View file

@ -0,0 +1,196 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>The build layer</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../arch.html" title="Appendix B. Boost.Build v2 architecture">
<link rel="prev" href="../arch.html" title="Appendix B. Boost.Build v2 architecture">
<link rel="next" href="tools.html" title="The tools layer">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../arch.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../arch.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="tools.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.arch.build"></a>The build layer</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="build.html#bbv2.arch.metatargets">Metatargets</a></span></dt>
<dt><span class="section"><a href="build.html#bbv2.arch.virtual">Virtual targets</a></span></dt>
<dt><span class="section"><a href="build.html#bbv2.arch.properties"></a></span></dt>
</dl></div>
<p>The build layer has just four main parts -- metatargets (abstract targets),
virtual targets, generators and properties.
</p>
<div class="itemizedlist"><ul type="disc">
<li><p>Metatargets (see the "targets.jam" module) represent
all the user-defined entities which can be built. The "meta" prefix
signify that they don't really corrspond to files -- depending of
build request, they can produce different set of
files. Metatargets are created when Jamfiles are loaded. Each
metagarget has a <code class="computeroutput">generate</code> method which is given a
property set and produces virtual targets for the passed properties.
</p></li>
<li><p>Virtual targets (see the "virtual-targets.jam"
module) correspond to the atomic things which can be updated --
most typically files.
</p></li>
<li><p>Properties are just (name, value) pairs, specified
by the user and describing how the targets should be
built. Properties are stored using the <code class="computeroutput">property-set</code> class.
</p></li>
<li><p>Generators are the objects which encapsulate tools
-- they can take a list of source virtual targets and produce new
virtual targets from them.
</p></li>
</ul></div>
<p>The build process includes those steps:
</p>
<div class="orderedlist"><ol type="1">
<li><p>Top-level code calls the <code class="computeroutput">generate</code>
method of a metatarget with some properties. </p></li>
<li><p>The metatarget combines the requested properties
with requirements and passes the result, together with the list
of sources, to the <code class="computeroutput">generators.construct</code>
function</p></li>
<li><p>A generator appropriate for the build properties is
selected and its <code class="computeroutput">run</code> method is
called. The method returns a list of virtual targets
</p></li>
<li><p>The targets are returned to the top level code. They
are converted into bjam targets (via
<code class="computeroutput">virtual-target.actualize</code>) and passed to bjam for building.
</p></li>
</ol></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.arch.metatargets"></a>Metatargets</h3></div></div></div>
<p>There are several classes derived from "abstract-target". The
"main-target" class represents top-level main target, the "project-target"
acts like container for all main targets, and "basic-target" class is a
base class for all further target types.
</p>
<p>Since each main target can have several alternatives, all top-level
target objects are just containers, referring to "real" main target
classes. The type is that container is "main-target". For example, given:
</p>
<pre class="programlisting">
alias a ;
lib a : a.cpp : &lt;toolset&gt;gcc ;
</pre>
<p>
we would have one-top level instance of "main-target-class", which will
contain one instance of "alias-target-class" and one instance of
"lib-target-class". The "generate" method of "main-target" decides
which of the alternative should be used, and call "generate" on the
corresponding instance.
</p>
<p>Each alternative is a instance of a class derived from
"basic-target". The "basic-target.generate" does several things that are
always should be done:
</p>
<div class="itemizedlist"><ul type="disc">
<li><p>Determines what properties should be used for building the
target. This includes looking at requested properties, requirements,
and usage requirements of all sources.</p></li>
<li><p>Builds all sources</p></li>
<li><p>Computes the usage requirements which should be passes back.</p></li>
</ul></div>
<p>
For the real work of constructing virtual target, a new method
"construct" is called.
</p>
<p>The "construct" method can be implemented in any way by classes
derived from "basic-target", but one specific derived class plays the
central role -- "typed-target". That class holds the desired type of file
to be produces, and calls the generators modules to do the job.
</p>
<p>This means that a specific metatarget subclass may avoid using
generators at all. However, this is deprecated and we're trying to
eliminate all such subsclasses at the moment.
</p>
<p>Note that the <code class="filename">build/targets.jam</code> file contains
an UML diagram which might help.</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.arch.virtual"></a>Virtual targets</h3></div></div></div>
<p>Virtual targets correspond to the atomic things which can be
updated. Each virtual target can be assigned an updating action --
instance of the <code class="computeroutput">action</code> class. The action class, in
turn, contains a list of source targets, properties, and a name of
bjam action block which should be executed.
</p>
<p>We try hard to never create equal instances of the
<code class="computeroutput">virtual-target</code> class. Each code which creates virtual
targets passes them though the <code class="computeroutput">virtual-target.register</code>
function, which detects if a target with the same name, sources, and
properties was created. In that case, existing target is returned.
</p>
<p>When all virtual targets are produced, they are
"actualized". This means that the real file names are computed, and
the commands that should be run are generated. This is done by the
<code class="computeroutput">virtual-target.actualize</code> method and the
<code class="computeroutput">action.actualize</code> methods. The first is conceptually
simple, while the second need additional explanation. The commands
in bjam are generated in two-stage process. First, a rule with the
appropriate name (for example
"gcc.compile") is called and is given the names of targets. The rule
sets some variables, like "OPTIONS". After that, the command string
is taken, and variable are substitutes, so use of OPTIONS inside the
command string become the real compile options.
</p>
<p>Boost.Build added a third stage to simplify things. It's now
possible to automatically convert properties to appropriate assignments to
variables. For example, &lt;debug-symbols&gt;on would add "-g" to the
OPTIONS variable, without requiring to manually add this logic to
gcc.compile. This functionality is part of the "toolset" module.
</p>
<p>Note that the <code class="filename">build/virtual-targets.jam</code> file
contains an UML diagram which might help.</p>
</div>
<div class="section" lang="en">
<div class="titlepage"></div>
<p>Above, we noted that metatargets are built with a set of
properties. That set is represented with the
<code class="computeroutput">property-set</code> class. An important point is that handling
of property sets can get very expensive. For that reason, we make
sure that for each set of (name, value) pairs only one
<code class="computeroutput">property-set</code> instance is created. The
<code class="computeroutput">property-set</code> uses extensive caching for all operation,
so most work is avoided. The <code class="computeroutput">property-set.create</code> is the
factory function which should be used to create instances of the
<code class="computeroutput">property-set</code> class.
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../arch.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../arch.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="tools.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

396
doc/html/bbv2/arch/targets.html Normal file
View file

@ -0,0 +1,396 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Targets</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../arch.html" title="Appendix B. Boost.Build v2 architecture">
<link rel="prev" href="tools.html" title="The tools layer">
<link rel="next" href="../../who_s_using_boost_.html" title="Who's Using Boost?">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="tools.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../arch.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../who_s_using_boost_.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.arch.targets"></a>Targets</h2></div></div></div>
<div class="toc"><dl><dt><span class="section"><a href="targets.html#bbv2.arch.depends">Dependency scanning</a></span></dt></dl></div>
<p>NOTE: THIS SECTION IS NOT EXPECTED TO BE READ!
There are two user-visible kinds of targets in Boost.Build.
First are "abstract" &#8212; they correspond to things declared
by user, for example, projects and executable files. The primary
thing about abstract target is that it's possible to request them
to be build with a particular values of some properties. Each
combination of properties may possible yield different set of
real file, so abstract target do not have a direct correspondence
with files.</p>
<p>File targets, on the contary, are associated with concrete
files. Dependency graphs for abstract targets with specific
properties are constructed from file targets. User has no was to
create file targets, however it can specify rules that detect
file type for sources, and also rules for transforming between
file targets of different types. That information is used in
constructing dependency graph, as desribed in the "next section".
[ link? ] <span class="bold"><strong>Note:</strong></span>File targets are not
the same as targets in Jam sense; the latter are created from
file targets at the latest possible moment. <span class="bold"><strong>Note:</strong></span>"File
target" is a proposed name for what we call virtual targets. It
it more understandable by users, but has one problem: virtual
targets can potentially be "phony", and not correspond to any
file.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.arch.depends"></a>Dependency scanning</h3></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="targets.html#id1709744">Support for different scanning algorithms</a></span></dt>
<dt><span class="section"><a href="targets.html#id1709753">Ability to scan the same file several times</a></span></dt>
<dt><span class="section"><a href="targets.html#id1709788">Proper detection of dependencies on generated files.</a></span></dt>
<dt><span class="section"><a href="targets.html#id1709921">Proper detection of dependencies from generated files</a></span></dt>
</dl></div>
<p>Dependency scanning is the process of finding implicit
dependencies, like "#include" statements in C++. The requirements
for right dependency scanning mechanism are:</p>
<div class="itemizedlist"><ul type="disc">
<li>
Support for different scanning algorithms. C++ and XML have
quite different syntax for includes and rules for looking up
included files.
</li>
<li>
Ability to scan the same file several times. For example,
single C++ file can be compiled with different include
paths.
</li>
<li>
Proper detection of dependencies on generated files.
</li>
<li>
Proper detection of dependencies from generated file.
</li>
</ul></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="id1709744"></a>Support for different scanning algorithms</h4></div></div></div>
<p>Different scanning algorithm are encapsulated by objects
called "scanners". Please see the documentation for "scanner"
module for more details.</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="id1709753"></a>Ability to scan the same file several times</h4></div></div></div>
<p>As said above, it's possible to compile a C++ file twice, with
different include paths. Therefore, include dependencies for
those compilations can be different. The problem is that bjam
does not allow several scans of the same target.</p>
<p>The solution in Boost.Build is straigtforward. When a virtual
target is converted to bjam target (via
<code class="literal">virtual-target.actualize</code> method), we specify the scanner
object to be used. The actualize method will create different
bjam targets for different scanners.</p>
<p>All targets with specific scanner are made dependent on target
without scanner, which target is always created. This is done in
case the target is updated. The updating action will be
associated with target without scanner, but if sources for that
action are touched, all targets &#8212; with scanner and without
should be considered outdated.</p>
<p>For example, assume that "a.cpp" is compiled by two compilers
with different include path. It's also copied into some install
location. In turn, it's produced from "a.verbatim". The
dependency graph will look like:</p>
<pre class="programlisting">
a.o (&lt;toolset&gt;gcc) &lt;--(compile)-- a.cpp (scanner1) ----+
a.o (&lt;toolset&gt;msvc) &lt;--(compile)-- a.cpp (scanner2) ----|
a.cpp (installed copy) &lt;--(copy) ----------------------- a.cpp (no scanner)
^
|
a.verbose --------------------------------+
</pre>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="id1709788"></a>Proper detection of dependencies on generated files.</h4></div></div></div>
<p>This requirement breaks down to the following ones.</p>
<div class="orderedlist"><ol type="1">
<li>
If when compiling "a.cpp" there's include of "a.h", the
"dir" directory is in include path, and a target called "a.h"
will be generated to "dir", then bjam should discover the
include, and create "a.h" before compiling "a.cpp".
</li>
<li>
Since almost always Boost.Build generates targets to a
"bin" directory, it should be supported as well. I.e. in the
scanario above, Jamfile in "dir" might create a main target,
which generates "a.h". The file will be generated to "dir/bin"
directory, but we still have to recornize the dependency.
</li>
</ol></div>
<p>The first requirement means that when determining what "a.h"
means, when found in "a.cpp", we have to iterate over all
directories in include paths, checking for each one:</p>
<div class="orderedlist"><ol type="1">
<li>
If there's file "a.h" in that directory, or
</li>
<li>
If there's a target called "a.h", which will be generated
to that directory.
</li>
</ol></div>
<p>Classic Jam has built-in facilities for point (1) above, but
that's not enough. It's hard to implement the right semantic
without builtin support. For example, we could try to check if
there's targer called "a.h" somewhere in dependency graph, and
add a dependency to it. The problem is that without search in
include path, the semantic may be incorrect. For example, one can
have an action which generated some "dummy" header, for system
which don't have the native one. Naturally, we don't want to
depend on that generated header on platforms where native one is
included.</p>
<p>There are two design choices for builtin support. Suppose we
have files a.cpp and b.cpp, and each one includes header.h,
generated by some action. Dependency graph created by classic jam
would look like:</p>
<pre class="programlisting">
a.cpp -----&gt; &lt;scanner1&gt;header.h [search path: d1, d2, d3]
&lt;d2&gt;header.h --------&gt; header.y
[generated in d2]
b.cpp -----&gt; &lt;scanner2&gt;header.h [ search path: d1, d2, d4]
</pre>
<p>
In this case, Jam thinks all header.h target are not
realated. The right dependency graph might be:
</p>
<pre class="programlisting">
a.cpp ----
\
\
&gt;----&gt; &lt;d2&gt;header.h --------&gt; header.y
/ [generated in d2]
/
b.cpp ----
</pre>
<p>
or
</p>
<pre class="programlisting">
a.cpp -----&gt; &lt;scanner1&gt;header.h [search path: d1, d2, d3]
|
(includes)
V
&lt;d2&gt;header.h --------&gt; header.y
[generated in d2]
^
(includes)
|
b.cpp -----&gt; &lt;scanner2&gt;header.h [ search path: d1, d2, d4]
</pre>
<p>
The first alternative was used for some time. The problem
however is: what include paths should be used when scanning
header.h? The second alternative was suggested by Matt Armstrong.
It has similiar effect: add targets which depend on
&lt;scanner1&gt;header.h will also depend on &lt;d2&gt;header.h.
But now we have two different target with two different scanners,
and those targets can be scanned independently. The problem of
first alternative is avoided, so the second alternative is
implemented now.
</p>
<p>The second sub-requirements is that targets generated to "bin"
directory are handled as well. Boost.Build implements
semi-automatic approach. When compiling C++ files the process
is:</p>
<div class="orderedlist"><ol type="1">
<li>
The main target to which compiled file belongs is found.
</li>
<li>
All other main targets that the found one depends on are
found. Those include main target which are used as sources, or
present as values of "dependency" features.
</li>
<li>
All directories where files belonging to those main target
will be generated are added to the include path.
</li>
</ol></div>
<p>After this is done, dependencies are found by the approach
explained previously.</p>
<p>Note that if a target uses generated headers from other main
target, that main target should be explicitly specified as
dependency property. It would be better to lift this requirement,
but it seems not very problematic in practice.</p>
<p>For target types other than C++, adding of include paths must
be implemented anew.</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="id1709921"></a>Proper detection of dependencies from generated files</h4></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="targets.html#id1710022">File targets</a></span></dt>
<dt><span class="section"><a href="targets.html#id1710055">Target paths</a></span></dt>
</dl></div>
<p>Suppose file "a.cpp" includes "a.h" and both are generated by
some action. Note that classic jam has two stages. In first stage
dependency graph graph is build and actions which should be run
are determined. In second stage the actions are executed.
Initially, neither file exists, so the include is not found. As
the result, jam might attempt to compile a.cpp before creating
a.h, and compilation will fail.</p>
<p>The solution in Boost.Jam is to perform additional dependency
scans after targets are updated. This break separation between
build stages in jam &#8212; which some people consider a good
thing &#8212; but I'm not aware of any better solution.</p>
<p>In order to understand the rest of this section, you better
read some details about jam dependency scanning, available
<a href="http://public.perforce.com:8080/@md=d&amp;cd=//public/jam/src/&amp;ra=s&amp;c=kVu@//2614?ac=10" target="_top">
at this link</a>.</p>
<p>Whenever a target is updated, Boost.Jam rescans it for
includes. Consider this graph, created before any actions are
run.</p>
<pre class="programlisting">
A -------&gt; C ----&gt; C.pro
/
B --/ C-includes ---&gt; D
</pre>
<p>
Both A and B have dependency on C and C-includes (the latter
dependency is not shown). Say during building we've tried to create
A, then tried to create C and successfully created C.
</p>
<p>In that case, the set of includes in C might well have
changed. We do not bother to detect precisely which includes were
added or removed. Instead we create another internal node
C-includes-2. Then we determine what actions should be run to
update the target. In fact this mean that we perform logic of
first stage while already executing stage.</p>
<p>After actions for C-includes-2 are determined, we add
C-includes-2 to the list of A's dependents, and stage 2 proceeds
as usual. Unfortunately, we can't do the same with target B,
since when it's not visited, C target does not know B depends on
it. So, we add a flag to C which tells and it was rescanned. When
visiting B target, the flag is notices and C-includes-2 will be
added to the list of B's dependencies.</p>
<p>Note also that internal nodes are sometimes updated too.
Consider this dependency graph:</p>
<pre class="programlisting">
a.o ---&gt; a.cpp
a.cpp-includes --&gt; a.h (scanned)
a.h-includes ------&gt; a.h (generated)
|
|
a.pro &lt;-------------------------------------------+
</pre>
<p>Here, out handling of generated headers come into play. Say
that a.h exists but is out of date with respect to "a.pro", then
"a.h (generated)" and "a.h-includes" will be marking for
updating, but "a.h (scanned)" won't be marked. We have to rescan
"a.h" file after it's created, but since "a.h (generated)" has no
scanner associated with it, it's only possible to rescan "a.h"
after "a.h-includes" target was updated.</p>
<p>Tbe above consideration lead to decision that we'll rescan a
target whenever it's updated, no matter if this target is
internal or not.</p>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p>
The remainder of this document is not indended to be read at
all. This will be rearranged in future.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
<a name="id1710022"></a>File targets</h5></div></div></div>
<p>
As described above, file targets corresponds
to files that Boost.Build manages. User's may be concerned about
file targets in three ways: when declaring file target types,
when declaring transformations between types, and when
determining where file target will be placed. File targets can
also be connected with actions, that determine how the target is
created. Both file targets and actions are implemented in the
<code class="literal">virtual-target</code> module.
</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h6 class="title">
<a name="id1710041"></a>Types</h6></div></div></div>
<p>A file target can be given a file, which determines
what transformations can be applied to the file. The
<code class="literal">type.register</code> rule declares new types. File type can
also be assigned a scanner, which is used to find implicit
dependencies. See "dependency scanning" [ link? ] below.</p>
</div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
<a name="id1710055"></a>Target paths</h5></div></div></div>
<p>To distinguish targets build with different properties, they
are put in different directories. Rules for determining target
paths are given below:</p>
<div class="orderedlist"><ol type="1">
<li>
All targets are placed under directory corresponding to the
project where they are defined.
</li>
<li>
Each non free, non incidental property cause an additional
element to be added to the target path. That element has the
form <code class="literal">&lt;feature-name&gt;-&lt;feature-value&gt;</code> for
ordinary features and <code class="literal">&lt;feature-value&gt;</code> for
implicit ones. [Note about composite features].
</li>
<li>
If the set of free, non incidental properties is different
from the set of free, non incidental properties for the project
in which the main target that uses the target is defined, a
part of the form <code class="literal">main_target-&lt;name&gt;</code> is added to
the target path. <span class="bold"><strong>Note:</strong></span>It would be nice to completely
track free features also, but this appears to be complex and
not extremely needed.
</li>
</ol></div>
<p>For example, we might have these paths:</p>
<pre class="programlisting">
debug/optimization-off
debug/main-target-a
</pre>
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="tools.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../arch.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../who_s_using_boost_.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

48
doc/html/bbv2/arch/tools.html Normal file
View file

@ -0,0 +1,48 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>The tools layer</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../arch.html" title="Appendix B. Boost.Build v2 architecture">
<link rel="prev" href="build.html" title="The build layer">
<link rel="next" href="targets.html" title="Targets">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="build.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../arch.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="targets.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.arch.tools"></a>The tools layer</h2></div></div></div>
<p>Write me!</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="build.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../arch.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="targets.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

139
doc/html/bbv2/extender.html Normal file
View file

@ -0,0 +1,139 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 25. Extender Manual</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../bbv2.html" title="Part III. Boost.Build v2 User Manual">
<link rel="prev" href="advanced/differences_to_v1.html" title="Differences to Boost.Build V1">
<link rel="next" href="extending/targets.html" title="Target types">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="advanced/differences_to_v1.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bbv2.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="extending/targets.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="chapter" lang="en">
<div class="titlepage"><div><div><h2 class="title">
<a name="bbv2.extender"></a>Chapter 25. Extender Manual</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="section"><a href="extender.html#bbv2.extender.intro">Introduction</a></span></dt>
<dt><span class="section"><a href="extending/targets.html">Target types</a></span></dt>
<dd><dl><dt><span class="section"><a href="extending/targets.html#bbv2.extending.scanners">Scanners</a></span></dt></dl></dd>
<dt><span class="section"><a href="extending/tools.html">Tools and generators</a></span></dt>
<dt><span class="section"><a href="extending/features.html">Features</a></span></dt>
<dt><span class="section"><a href="extending/rules.html">Main target rules</a></span></dt>
<dt><span class="section"><a href="extending/toolset_modules.html">Toolset modules</a></span></dt>
</dl>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.extender.intro"></a>Introduction</h2></div></div></div>
<p>This document explains how to extend Boost.Build to accomodate
your local requirements. Let's start with a simple but
realistic example.</p>
<p>Say you're writing an application that generates C++ code. If
you ever did this, you know that it's not nice. Embedding large
portions of C++ code in string literals is very awkward. A much
better solution is:</p>
<div class="orderedlist"><ol type="1">
<li>
Write the template of the code to be generated, leaving
placeholders at the points that will change
</li>
<li>
Access the template in your application and replace
placeholders with appropriate text.
</li>
<li>Write the result.</li>
</ol></div>
<p>It's quite easy to achieve. You write special verbatim files
that are just C++, except that the very first line of the file
contains the name of a variable that should be generated. A simple tool
is created that takes a verbatim file and creates a cpp file with
a single <code class="computeroutput">char*</code> variable whose name is taken from the first line
of the verbatim file and whose value is the file's properly quoted content.</p>
<p>Let's see what Boost.Build can do.</p>
<p>First off, Boost.Build has no idea about "verbatim files". So,
you must register a new target type. The following code does
it:</p>
<pre class="programlisting">
import type ;
type.register VERBATIM : vrb ;
</pre>
<p>The first parameter to
<code class="computeroutput">type.register</code> gives the name of the
declared type. By convention, it's uppercase. The second parameter
is the suffix for files of this type. So, if Boost.Build sees
<code class="filename">code.vrb</code> in a list of sources, it knows that it's of type
<code class="computeroutput">VERBATIM</code>.</p>
<p>Next, you tell Boost.Build that the verbatim files can be
transformed into C++ files in one build step. A
<em class="firstterm">generator</em> is a template for a build step that
transforms targets of one type (or set of types) into another. Our
generator will be called <code class="computeroutput">verbatim.inline-file</code>; it
transforms <code class="computeroutput">VERBATIM</code> files into <code class="computeroutput">CPP</code> files:
</p>
<pre class="programlisting">
import generators ;
generators.register-standard verbatim.inline-file : VERBATIM : CPP ;
</pre>
<p>Lastly, you have to inform Boost.Build about the shell
commands used to make that transformation. That's done with an
<code class="computeroutput">actions</code> declaration.
</p>
<pre class="programlisting">
actions inline-file
{
"./inline-file.py" $(&lt;) $(&gt;)
}
</pre>
<p>Now, we're ready to tie it all together. Put all the code
above in file <code class="filename">verbatim.jam</code>, add <code class="computeroutput">import verbatim ;</code>
to <code class="filename">project-root.jam</code>, and it's possible to write
the following in Jamfile:</p>
<pre class="programlisting">
exe codegen : codegen.cpp class_template.verbatim usage.verbatim ;
</pre>
<p>
The verbatim files will be automatically converted into C++
and linked it.
</p>
<p>In the subsequent sections, we will extend this example, and review
all the mechanisms in detail. The complete code is available in <a href="../../../tools/build/v2/example/customization" target="_top">example/customization</a>
directory.
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="advanced/differences_to_v1.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bbv2.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="extending/targets.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

262
doc/html/bbv2/extending/features.html Normal file
View file

@ -0,0 +1,262 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Features</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../extender.html" title="Chapter 25. Extender Manual">
<link rel="prev" href="tools.html" title="Tools and generators">
<link rel="next" href="rules.html" title="Main target rules">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="tools.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../extender.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="rules.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.extending.features"></a>Features</h2></div></div></div>
<p>
Often, we need to control the options passed the invoked tools. This
is done with features. Consider an example:
</p>
<pre class="programlisting">
# Declare a new free feature
import feature : feature ;
feature verbatim-options : : free ;
# Cause the value of the 'verbatim-options' feature to be
# available as 'OPTIONS' variable inside verbatim.inline-file
import toolset : flags ;
flags verbatim.inline-file OPTIONS &lt;verbatim-options&gt; ;
# Use the "OPTIONS" variable
actions inline-file
{
"./inline-file.py" $(OPTIONS) $(&lt;) $(&gt;)
}
</pre>
<p>
We first define a new feature. Then, the <code class="computeroutput">flags</code> invocation
says that whenever verbatin.inline-file action is run, the value of
the <code class="computeroutput">verbatim-options</code> feature will be added to the
<code class="computeroutput">OPTIONS</code> variable, an can be used inside the action body.
You'd need to consult online help (--help) to find all the features of
the <code class="computeroutput">toolset.flags</code> rule.
</p>
<p>
Although you can define any set of features and interpret their values
in any way, Boost.Build suggests the following coding standard for
designing features.
</p>
<p>Most features should have a fixed set of values that is portable
(tool neutral) across the class of tools they are designed to work
with. The user does not have to adjust the values for a exact tool. For
example, <code class="computeroutput">&lt;optimization&gt;speed</code> has the same meaning for
all C++ compilers and the user does not have to worry about the exact
options passed to the compiler's command line.
</p>
<p>
Besides such portable features there are special 'raw' features that
allow the user to pass any value to the command line parameters for a
particular tool, if so desired. For example, the
<code class="computeroutput">&lt;cxxflags&gt;</code> feature allows you to pass any command line
options to a C++ compiler. The <code class="computeroutput">&lt;include&gt;</code> feature
allows you to pass any string preceded by <code class="computeroutput">-I</code> and the interpretation
is tool-specific. (See <a href="../faq/external.html" title="Can I get output of external program as a variable in a Jamfile?
">the section called &#8220;Can I get output of external program as a variable in a Jamfile?
&#8221;</a> for an example of very smart usage of that
feature). Of course one should always strive to use portable
features, but these are still be provided as a backdoor just to make
sure Boost.Build does not take away any control from the user.
</p>
<p>
Using portable features is a good idea because:
</p>
<div class="itemizedlist"><ul type="disc">
<li><p>When a portable feature is given a fixed set of
values, you can build your project with two different
settings of the feature and Boost.Build will automatically
use two different directories for generated files.
Boost.Build does not try to separate targets built with
different raw options.
</p></li>
<li><p>Unlike with &#8220;raw&#8221; features, you don't need to use
specific command-line flags in your Jamfile, and it will be
more likely to work with other tools.
</p></li>
</ul></div>
<h3>
<a name="id1706749"></a>Steps for adding a feauture</h3>
<p>Adding a feature requires three steps:
</p>
<div class="orderedlist"><ol type="1">
<li>
<p>Declaring a feature. For that, the "feature.feature"
rule is used. You have to decide on the set of <a href="../reference/definitions.html#bbv2.reference.features.attributes" title="Feature Attributes">feature
attributes</a>:
</p>
<div class="itemizedlist"><ul type="disc">
<li><p>if a feature has several values and
significally affects the build, make it &#8220;propagated,&#8221; so that the
whole project is built with the same value by
default</p></li>
<li><p>if a feature does not have a fixed
list of values, it must be &#8220;free.&#8221; For example, the
<code class="computeroutput">include</code> feature is a free
feature.</p></li>
<li><p>if a feature is used to refer to a
path relative to the Jamfile, it must be a &#8220;path&#8221;
feature. <code class="computeroutput">include</code> is also a path
feature.</p></li>
<li><p>if feature is used to refer to some target, it
must be a &#8220;dependency&#8221; feature. </p></li>
</ul></div>
</li>
<li><p>Representing the feature value in a
target-specific variable. Build actions are command
templates modified by Boost.Jam variable expansions. The
<code class="computeroutput">toolset.flags</code> rule sets a target-specific
variable to the value of a feature.</p></li>
<li><p>Using the variable. The variable set in step 2 can
be used in a build action to form command parameters or
files.</p></li>
</ol></div>
<h3>
<a name="id1706828"></a>Another example</h3>
<p>Here's another example.
Let's see how we can make a feature that refers to a target. For example,
when linking dynamic libraries on windows, one sometimes needs to specify
"DEF file", telling what functions should be exported. It would be nice to
use this file like this:
</p>
<pre class="programlisting">
lib a : a.cpp : &lt;def-file&gt;a.def ;
</pre>
<p>
Actually, this feature is already supported, but anyway...
</p>
<div class="orderedlist"><ol type="1">
<li>
<p>Since the feature refers to a target, it must be "dependency".
</p>
<pre class="programlisting">
feature def-file : : free dependency ;
</pre>
</li>
<li>
<p>One of the toolsets that cares about
DEF files is msvc. The following line should be added to it.
</p>
<pre class="programlisting">
flags msvc.link DEF_FILE &lt;def-file&gt; ;
</pre>
</li>
<li>
<p>Since the DEF_FILE variable is not used by the
msvc.link action,
we need to modify it to be:
</p>
<pre class="programlisting">
actions link bind DEF_FILE
{
$(.LD) .... /DEF:$(DEF_FILE) ....
}
</pre>
<p> Note the <code class="computeroutput">bind DEF_FILE</code> part. It tells
bjam to translate the internal target name in
<code class="varname">DEF_FILE</code> to a corresponding filename in
the <code class="computeroutput">link</code> action. Without it the expansion of
<code class="computeroutput">$(DEF_FILE)</code> would be a strange symbol that is
not likely to make sense for the linker.
</p>
<p>
We've almost done, but should stop for a small workaround. Add the following
code to msvc.jam
</p>
<pre class="programlisting">
rule link
{
DEPENDS $(&lt;) : [ on $(&lt;) return $(DEF_FILE) ] ;
}
</pre>
<p>
This is needed to accomodate some bug in bjam, which hopefully
will be fixed one day.
</p>
</li>
</ol></div>
<h3>
<a name="id1706925"></a>Variants and composite features.</h3>
<p>Sometimes you want to create a shorcut for some set of
features. For example, <code class="computeroutput">release</code> is a value of
<code class="computeroutput">&lt;variant&gt;</code> and is a shortcut for a set of features.
</p>
<p>It is possible to define your own build variants. For example:
</p>
<pre class="programlisting">
variant crazy : &lt;optimization&gt;speed &lt;inlining&gt;off
&lt;debug-symbols&gt;on &lt;profiling&gt;on ;
</pre>
<p>
will define a new variant with the specified set of properties. You
can also extend an existing variant:
</p>
<pre class="programlisting">
variant super_release : release : &lt;define&gt;USE_ASM ;
</pre>
<p>
In this case, <code class="computeroutput">super_release</code> will expand to all properties
specified by <code class="computeroutput">release</code>, and the additional one you've specified.
</p>
<p>You are not restricted to using the <code class="computeroutput">variant</code> feature
only.
Here's example that defines a brand new feature:
</p>
<pre class="programlisting">
feature parallelism : mpi fake none : composite link-incompatible ;
feature.compose &lt;parallelism&gt;mpi : &lt;library&gt;/mpi//mpi/&lt;parallelism&gt;none ;
feature.compose &lt;parallelism&gt;fake : &lt;library&gt;/mpi//fake/&lt;parallelism&gt;none ;
</pre>
<p>
This will allow you to specify value of feature
<code class="computeroutput">parallelism</code>, which will expand to link to the necessary
library.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="tools.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../extender.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="rules.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

109
doc/html/bbv2/extending/rules.html Normal file
View file

@ -0,0 +1,109 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Main target rules</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../extender.html" title="Chapter 25. Extender Manual">
<link rel="prev" href="features.html" title="Features">
<link rel="next" href="toolset_modules.html" title="Toolset modules">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="features.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../extender.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="toolset_modules.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.extending.rules"></a>Main target rules</h2></div></div></div>
<p>
A main target rule (e.g &#8220;<code class="computeroutput">exe</code>&#8221;
Or &#8220;<code class="computeroutput">lib</code>&#8221;) creates a top-level target. It's quite likely that you'll want to declare your own and
there are two ways to do that.
</p>
<p><a name="bbv2.extending.rules.main-type"></a>The first way applies when
your target rule should just produce a target of specific type. In that case, a
rule is already defined for you! When you define a new type, Boost.Build
automatically defines a corresponding rule. The name of the rule is
obtained from the name of the type, by downcasing all letters and
replacing underscores with dashes.
For example, if you create a module
<code class="filename">obfuscate.jam</code> containing:
</p>
<pre class="programlisting">
import type ;
type.register OBFUSCATED_CPP : ocpp ;
import generators ;
generators.register-standard obfuscate.file : CPP : OBFUSCATED_CPP ;
</pre>
<p>
and import that module, you'll be able to use the rule "obfuscated-cpp"
in Jamfiles, which will convert source to the OBFUSCATED_CPP type.
</p>
<p>The second way is to write a wrapper rule that calls
any of the existing rules. For example, suppose you have only one library per
directory and want all cpp files in the directory to be compiled into that library. You
can achieve this effect with:
</p>
<pre class="programlisting">
lib codegen : [ glob *.cpp ] ;
</pre>
<p>
but if you want to make it even simpler, you could add the following
definition to the <code class="filename">project-root.jam</code> file:
</p>
<pre class="programlisting">
rule glib ( name : extra-sources * : requirements * )
{
lib $(name) : [ glob *.cpp ] $(extra-sources) : $(requirements) ;
}
</pre>
<p>
which would allow you to reduce the Jamfile to
</p>
<pre class="programlisting">
glib codegen ;
</pre>
<p>
Note that because you can associate a custom generator with a target
type, the logic of building can be rather compiler.
For example, the
<code class="computeroutput">boostbook</code> module declares a target type
<code class="computeroutput">BOOSTBOOK_MAIN</code> and a custom generator for that
type. You can use that as example if your main target rule is
non-trivial.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="features.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../extender.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="toolset_modules.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

148
doc/html/bbv2/extending/targets.html Normal file
View file

@ -0,0 +1,148 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Target types</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../extender.html" title="Chapter 25. Extender Manual">
<link rel="prev" href="../extender.html" title="Chapter 25. Extender Manual">
<link rel="next" href="tools.html" title="Tools and generators">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../extender.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../extender.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="tools.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.extending.targets"></a>Target types</h2></div></div></div>
<div class="toc"><dl><dt><span class="section"><a href="targets.html#bbv2.extending.scanners">Scanners</a></span></dt></dl></div>
<p>The first thing we did in the <a href="../extender.html#bbv2.extender.intro" title="Introduction">intruduction</a> was declaring a
new target type:
</p>
<pre class="programlisting">
import type ;
type.register VERBATIM : verbatim ;
</pre>
<p>
The type is the most important property of a target. Boost.Build can
automatically generate necessary build actions only because you
specify the desired type (using the different main target rules), and
because Boost.Build can guess the type of sources from their
extensions.
</p>
<p>The first two parameters for the <code class="computeroutput">type.register</code> rule
are the name of new type and the list of extensions associated with
it. A file with an extension from the list will have the given target
type. In the case where a target of the declared type is generated
from other sources, the first specified extension will be used.
</p>
<p>Sometimes you want to change the suffix used for generated targets
depending on build properties, such as toolset. For example, some compiler
uses extension <code class="literal">elf</code> for executable files. You can use the
<code class="computeroutput">type.set-generated-target-suffix</code> rule:
</p>
<pre class="programlisting">
type.set-generated-target-suffix EXE : &lt;toolset&gt;elf : elf ;
</pre>
<p>A new target type can be inherited from an existing one.
</p>
<pre class="programlisting">
type.register PLUGIN : : SHARED_LIB ;
</pre>
<p>
The above code defines a new type derived from
<code class="computeroutput">SHARED_LIB</code>. Initially, the new type inherits all the
properties of the base type - in particular generators and suffix.
Typically, you'll change the new type in some way. For example, using
<code class="computeroutput">type.set-generated-target-suffix</code> you can set the suffix for
the new type. Or you can write special generator for the new type. For
example, it can generate additional metainformation for plugin.
In either way, the <code class="computeroutput">PLUGIN</code> type can be used whenever
<code class="computeroutput">SHARED_LIB</code> can. For example, you can directly link plugins
to an application.
</p>
<p>A type can be defined as "main", in which case Boost.Build will
automatically declare a main target rule for building targets of that
type. More details can be found <a href="rules.html#bbv2.extending.rules.main-type">later</a>.
</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.extending.scanners"></a>Scanners</h3></div></div></div>
<p>
Sometimes, a file can refer to other files via some include
mechanism. To make Boost.Build track dependencies to the included
files, you need to provide a scanner. The primary limitation is that
only one scanner can be assigned to a target type.
</p>
<p>First, we need to declare a new class for the scanner:
</p>
<pre class="programlisting">
class verbatim-scanner : common-scanner
{
rule pattern ( )
{
return "//###include[ ]*\"([^\"]*)\"" ;
}
}
</pre>
<p>
All the complex logic is in the <code class="computeroutput">common-scanner</code>
class, and you only need to override the method that returns
the regular expression to be used for scanning. The
paranthethis in the regular expression indicate which part
of the string is the name of the included file. Only the
first parenthesized group in the regular expression will be
recognized; if you can't express everything you want that
way, you can return multiple regular expressions, each of
which contains a parenthesized group to be matched.
</p>
<p>After that, we need to register our scanner class:
</p>
<pre class="programlisting">
scanner.register verbatim-scanner : include ;
</pre>
<p>
The value of the second parameter, in this case
<code class="computeroutput">include</code>, specifies the properties that contain the list
of paths that should be searched for the included files.
</p>
<p>Finally, we assign the new scaner to the <code class="computeroutput">VERBATIM</code>
target type:
</p>
<pre class="programlisting">
type.set-scanner VERBATIM : verbatim-scanner ;
</pre>
<p>
That's enough for scanning include dependencies.
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../extender.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../extender.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="tools.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

247
doc/html/bbv2/extending/tools.html Normal file
View file

@ -0,0 +1,247 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Tools and generators</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../extender.html" title="Chapter 25. Extender Manual">
<link rel="prev" href="targets.html" title="Target types">
<link rel="next" href="features.html" title="Features">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="targets.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../extender.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="features.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.extending.tools"></a>Tools and generators</h2></div></div></div>
<p>
This section will describe how Boost.Build can be extended to support
new tools.
</p>
<p>For each additional tool, a Boost.Build object called generator
must be created. That object has specific types of targets that it
accepts an produces. Using that information, Boost.Build is able
to automatically invoke the generator. For example, if you declare a
generator that takes a target of the type <code class="literal">D</code> and
produces a target of the type <code class="literal">OBJ</code>, when placing a
file with extention <code class="literal">.d</code> in a list of sources will
cause Boost.Build to invoke your generator, and then to link the
resulting object file into an application. (Of course, this requires
that you specify that the <code class="literal">.d</code> extension corresponds
to the <code class="literal">D</code> type.)
</p>
<p>Each generator should be an instance of a class derived from the
<code class="computeroutput">generator</code> class. In the simplest case, you don't need to
create a derived class, but simply create an instance of the
<code class="computeroutput">generator</code> class. Let's review the example we've seen in the
<a href="../extender.html#bbv2.extender.intro" title="Introduction">introduction</a>.
</p>
<pre class="programlisting">
import generators ;
generators.register-standard verbatim.inline-file : VERBATIM : CPP ;
actions inline-file
{
"./inline-file.py" $(&lt;) $(&gt;)
}
</pre>
<p>We declare a standard generator, specifying its id, the source type
and the target type. When invoked, the generator will create a target
of type <code class="literal">CPP</code> with a source target of
type <code class="literal">VERBATIM</code> as the only source. But what command
will be used to actually generate the file? In bjam, actions are
specified using named "actions" blocks and the name of the action
block should be specified when creating targets. By convention,
generators use the same name of the action block as their own id. So,
in above example, the "inline-file" actions block will be use to
convert the source into the target.
</p>
<p>
There are two primary kinds of generators: standard and composing,
which are registered with the
<code class="computeroutput">generators.register-standard</code> and the
<code class="computeroutput">generators.register-composing</code> rules, respectively. For
example:
</p>
<pre class="programlisting">
generators.register-standard verbatim.inline-file : VERBATIM : CPP ;
generators.register-composing mex.mex : CPP LIB : MEX ;
</pre>
<p>
Standard generators take a <span class="emphasis"><em>single</em></span> source of type
<code class="computeroutput">VERBATIM</code> and produces a result. The second generator
takes any number of sources, which can have either the
<code class="computeroutput">CPP</code> or the <code class="computeroutput">LIB</code> type. Composing generators
are typically used for generating top-level target type. For example,
the first generator invoked when building an <code class="computeroutput">exe</code> target
is a composing generator corresponding to the proper linker.
</p>
<p>You should also know about two specific function for registering
generators: <code class="computeroutput">generators.register-c-compiler</code> and
<code class="computeroutput">generators.register-linker</code>. The first sets up header
dependecy scanning for C files, and the seconds handles various
complexities like searched libraries. For that reason, you should always
use those functions when adding support for compilers and linkers.
</p>
<p>(Need a note about UNIX)</p>
<h3>
<a name="id1706493"></a>Custom generator classes</h3>
<p>The standard generators allows you to specify source and target
types, action, and a set of flags. If you need anything more complex,
you need to create a new generator class with your own logic. Then,
you have to create an instance of that class and register it. Here's
an example how you can create your own generator class:
</p>
<pre class="programlisting">
class custom-generator : generator
{
rule __init__ ( * : * )
{
generator.__init__ $(1) : $(2) : $(3) : $(4) : $(5) : $(6) : $(7) : $(8) : $(9) ;
}
}
generators.register
[ new custom-generator verbatim.inline-file : VERBATIM : CPP ] ;
</pre>
<p>
This generator will work exactly like the
<code class="computeroutput">verbatim.inline-file</code> generator we've defined above, but
it's possible to customize the behaviour by overriding methods of the
<code class="computeroutput">generator</code> class.
</p>
<p>There are two methods of interest. The <code class="computeroutput">run</code> method is
responsible for the overall process - it takes a number of source targets,
converts them the the right types, and creates the result. The
<code class="computeroutput">generated-targets</code> method is called when all sources are
converted to the right types to actually create the result.
</p>
<p>The <code class="computeroutput">generated-target</code>
method can be overridden
when you want to add additional properties to the generated
targets or use additional sources. For a real-life example,
suppose you have a program analysis tool that should be given a
name of executable and the list of all sources. Naturally, you
don't want to list all source files manually. Here's how the
<code class="computeroutput">generated-target</code> method can find the list of
sources automatically:
</p>
<pre class="programlisting">
class itrace-generator : generator {
....
rule generated-targets ( sources + : property-set : project name ? )
{
local leaves ;
local temp = [ virtual-target.traverse $(sources[1]) : : include-sources ] ;
for local t in $(temp)
{
if ! [ $(t).action ]
{
leaves += $(t) ;
}
}
return [ generator.generated-targets $(sources) $(leafs)
: $(property-set) : $(project) $(name) ] ;
}
}
generators.register [ new itrace-generator nm.itrace : EXE : ITRACE ] ;
</pre>
<p>
The <code class="computeroutput">generated-targets</code> method will be called with a single
source target of type <code class="literal">EXE</code>. The call to
<code class="computeroutput">virtual-target.traverse</code> will return all targets the
executable depends on, and we further find files that are not
produced from anything.
The found targets are added to the sources.
</p>
<p>The <code class="computeroutput">run</code> method can be overriden to completely
customize the way generator works. In particular, the conversion of
sources to the desired types can be completely customized. Here's
another real example. Tests for the Boost Python library usually
consist of two parts: a Python program and a C++ file. The C++ file is
compiled to Python extension that is loaded by the Python
program. But in the likely case that both files have the same name,
the created Python extension must be renamed. Otherwise, Python
program will import itself, not the extension. Here's how it can be
done:
</p>
<pre class="programlisting">
rule run ( project name ? : property-set : sources * : multiple ? )
{
local python ;
for local s in $(sources)
{
if [ $(s).type ] = PY
{
python = $(s) ;
}
}
local libs ;
for local s in $(sources)
{
if [ type.is-derived [ $(s).type ] LIB ]
{
libs += $(s) ;
}
}
local new-sources ;
for local s in $(sources)
{
if [ type.is-derived [ $(s).type ] CPP ]
{
local name = [ $(s).name ] ; # get the target's basename
if $(name) = [ $(python).name ]
{
name = $(name)_ext ; # rename the target
}
new-sources += [ generators.construct $(project) $(name) :
PYTHON_EXTENSION : $(property-set) : $(s) $(libs) ] ;
}
}
result = [ construct-result $(python) $(new-sources) : $(project) $(name)
: $(property-set) ] ;
}
</pre>
<p>
First, we separate all source into python files, libraries and C++
sources. For each C++ source we create a separate Python extension by
calling <code class="computeroutput">generators.construct</code> and passing the C++ source
and the libraries. At this point, we also change the extension's name,
if necessary.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="targets.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../extender.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="features.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

124
doc/html/bbv2/extending/toolset_modules.html Normal file
View file

@ -0,0 +1,124 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Toolset modules</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../extender.html" title="Chapter 25. Extender Manual">
<link rel="prev" href="rules.html" title="Main target rules">
<link rel="next" href="../reference.html" title="Chapter 26. Detailed reference">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="rules.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../extender.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../reference.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.extending.toolset_modules"></a>Toolset modules</h2></div></div></div>
<p>If your extensions will be used only on one project, they can be
placed in a separate <code class="filename">.jam</code> file that will be
imported by your <code class="filename">project-root.jam</code>. If the
extensions will be used on many projects, users will thank you for
a finishing touch.
</p>
<p>The <code class="computeroutput">using</code> rule provides a standard mechanism
for loading and configuring extensions. To make it work, your module
should provide an <code class="computeroutput">init</code> rule. The rule will be called
with the same parameters that were passed to the
<code class="computeroutput">using</code> rule. The set of allowed parameters is
determined by you. For example, you can allow the user to specify
paths, tool versions, and other options.
</p>
<p>Here are some guidelines that help to make Boost.Build more
consistent:
</p>
<div class="itemizedlist"><ul type="disc">
<li><p>The <code class="computeroutput">init</code> rule should never fail. Even if
the user provided an incorrect path, you should emit a warning and go
on. Configuration may be shared between different machines, and
wrong values on one machine can be OK on another.
</p></li>
<li>
<p>Prefer specifying the command to be executed
to specifying the tool's installation path. First of all, this
gives more control: it's possible to specify
</p>
<pre class="programlisting">
/usr/bin/g++-snapshot
time g++
</pre>
<p>
as the command. Second, while some tools have a logical
"installation root", it's better if user doesn't have to remember whether
a specific tool requires a full command or a path.
</p>
</li>
<li>
<p>Check for multiple initialization. A user can try to
initialize the module several times. You need to check for this
and decide what to do. Typically, unless you support several
versions of a tool, duplicate initialization is a user error.
If the
tool's version can be specified during initialization, make sure the
version is either always specified, or never specified (in which
case the tool is initialied only once). For example, if you allow:
</p>
<pre class="programlisting">
using yfc ;
using yfc : 3.3 ;
using yfc : 3.4 ;
</pre>
<p>
Then it's not clear if the first initialization corresponds to
version 3.3 of the tool, version 3.4 of the tool, or some other
version. This can lead to building twice with the same version.
</p>
</li>
<li>
<p>If possible, <code class="computeroutput">init</code> must be callable
with no parameters. In which case, it should try to autodetect all
the necessary information, for example, by looking for a tool in
<code class="envar">PATH</code> or in common installation locations. Often this
is possible and allows the user to simply write:
</p>
<pre class="programlisting">
using yfc ;
</pre>
</li>
<li><p>Consider using facilities in the
<code class="computeroutput">tools/common</code> module. You can take a look at how
<code class="computeroutput">tools/gcc.jam</code> uses that module in the <code class="computeroutput">init</code> rule.
</p></li>
</ul></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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="rules.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../extender.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../reference.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

149
doc/html/bbv2/faq.html Normal file
View file

@ -0,0 +1,149 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 27. Frequently Asked Questions</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../bbv2.html" title="Part III. Boost.Build v2 User Manual">
<link rel="prev" href="reference/generators.html" title="Generators">
<link rel="next" href="faq/envar.html" title="
Accessing environment variables
">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="reference/generators.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bbv2.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="faq/envar.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="chapter" lang="en">
<div class="titlepage"><div><div><h2 class="title">
<a name="bbv2.faq"></a>Chapter 27. Frequently Asked Questions</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="section"><a href="faq.html#id1708877">
I'm getting "Duplicate name of actual target" error. What
does it mean?
</a></span></dt>
<dt><span class="section"><a href="faq/envar.html">
Accessing environment variables
</a></span></dt>
<dt><span class="section"><a href="faq/s03.html">
How to control properties order?
</a></span></dt>
<dt><span class="section"><a href="faq/s04.html">
How to control the library order on Unix?
</a></span></dt>
<dt><span class="section"><a href="faq/external.html">Can I get output of external program as a variable in a Jamfile?
</a></span></dt>
<dt><span class="section"><a href="faq/s06.html">How to get the project-root location?
</a></span></dt>
<dt><span class="section"><a href="faq/s07.html">How to change compilation flags for one file?
</a></span></dt>
<dt><span class="section"><a href="faq/dll-path.html">Why are the <code class="computeroutput">dll-path</code> and
<code class="computeroutput">hardcode-dll-paths</code> properties useful?
</a></span></dt>
<dt><span class="section"><a href="recipies/site-config.html">Targets in site-config.jam</a></span></dt>
</dl>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="id1708877"></a>
I'm getting "Duplicate name of actual target" error. What
does it mean?
</h2></div></div></div>
<p>
The most likely case is that you're trying to
compile the same file twice, with almost the same,
but differing properties. For example:
</p>
<pre class="programlisting">
exe a : a.cpp : &lt;include&gt;/usr/local/include ;
exe b : a.cpp ;
</pre>
<p>
The above snippet requires two different compilations
of 'a.cpp', which differ only in 'include' property.
Since the 'include' property is free, Boost.Build
can't generate two objects files into different directories.
On the other hand, it's dangerous to compile the file only
once -- maybe you really want to compile with different
includes.
</p>
<p>
To solve this issue, you need to decide if file should
be compiled once or twice.</p>
<div class="orderedlist"><ol type="1">
<li>
<p>Two compile file only once, make sure that properties
are the same:
</p>
<pre class="programlisting">
exe a : a.cpp : &lt;include&gt;/usr/local/include ;
exe b : a.cpp : &lt;include&gt;/usr/local/include ;
</pre>
</li>
<li>
<p>
If changing the properties is not desirable, for example
if 'a' and 'b' target have other sources which need
specific properties, separate 'a.cpp' into it's own target:
</p>
<pre class="programlisting">
obj a_obj : a.cpp : &lt;include&gt;/usr/local/include ;
exe a : a_obj ;
</pre>
</li>
<li>
<p>
To compile file twice, you can make the object file local
to the main target:
</p>
<pre class="programlisting">
exe a : [ obj a_obj : a.cpp ] : &lt;include&gt;/usr/local/include ;
exe b : [ obj a_obj : a.cpp ] ;
</pre>
</li>
</ol></div>
<p>
A good question is why Boost.Build can't use some of the above
approaches automatically. The problem is that such magic would
require additional implementation complexities and would only
help in half of the cases, while in other half we'd be silently
doing the wrong thing. It's simpler and safe to ask user to
clarify his intention in such cases.
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="reference/generators.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bbv2.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="faq/envar.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

110
doc/html/bbv2/faq/dll-path.html Normal file
View file

@ -0,0 +1,110 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Why are the dll-path and
hardcode-dll-paths properties useful?
</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../faq.html" title="Chapter 27. Frequently Asked Questions">
<link rel="prev" href="s07.html" title="How to change compilation flags for one file?
">
<link rel="next" href="../recipies/site-config.html" title="Targets in site-config.jam">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="s07.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../faq.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../recipies/site-config.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.faq.dll-path"></a>Why are the <code class="computeroutput">dll-path</code> and
<code class="computeroutput">hardcode-dll-paths</code> properties useful?
</h2></div></div></div>
<p>(This entry is specific to Unix system.)Before answering the
questions, let's recall a few points about shared libraries. Shared
libraries can be used by several applications, or other libraries,
without phisycally including the library in the application. This can
greatly decrease the total size of applications. It's also possible to
upgrade a shared library when the application is already
installed. Finally, shared linking can be faster.
</p>
<p>However, the shared library must be found when the application is
started. The dynamic linker will search in a system-defined list of
paths, load the library and resolve the symbols. Which means that you
should either change the system-defined list, given by the
<code class="envar">LD_LIBRARY_PATH</code> environment variable, or install the
libraries to a system location. This can be inconvenient when
developing, since the libraries are not yet ready to be installed, and
cluttering system paths is undesirable. Luckily, on Unix there's another
way.
</p>
<p>An executable can include a list of additional library paths, which
will be searched before system paths. This is excellent for development,
because the build system knows the paths to all libraries and can include
them in executables. That's done when the <code class="computeroutput">hardcode-dll-paths</code>
feature has the <code class="literal">true</code> value, which is the
default. When the executables should be installed, the story is
different.
</p>
<p>
Obviously, installed executable should not hardcode paths to your
development tree. (The <code class="computeroutput">stage</code> rule explicitly disables the
<code class="computeroutput">hardcode-dll-paths</code> feature for that reason.) However, you
can use the <code class="computeroutput">dll-path</code> feature to add explicit paths
manually. For example:
</p>
<pre class="programlisting">
stage installed : application : &lt;dll-path&gt;/usr/lib/snake
&lt;location&gt;/usr/bin ;
</pre>
<p>
will allow the application to find libraries placed to
<code class="filename">/usr/lib/snake</code>.
</p>
<p>If you install libraries to a nonstandard location and add an
explicit path, you get more control over libraries which will be used. A
library of the same name in a system location will not be inadvertently
used. If you install libraries to a system location and do not add any
paths, the system administrator will have more control. Each library can
be individually upgraded, and all applications will use the new library.
</p>
<p>Which approach is best depends on your situation. If the libraries
are relatively standalone and can be used by third party applications,
they should be installed in the system location. If you have lots of
libraries which can be used only by your application, it makes sense to
install it to a nonstandard directory and add an explicit path, like the
example above shows. Please also note that guidelines for different
systems differ in this respect. The Debian guidelines prohibit any
additional search paths, and Solaris guidelines suggest that they should
always be used.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="s07.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../faq.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../recipies/site-config.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

72
doc/html/bbv2/faq/envar.html Normal file
View file

@ -0,0 +1,72 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>
Accessing environment variables
</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../faq.html" title="Chapter 27. Frequently Asked Questions">
<link rel="prev" href="../faq.html" title="Chapter 27. Frequently Asked Questions">
<link rel="next" href="s03.html" title="
How to control properties order?
">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../faq.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../faq.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="s03.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.faq.envar"></a>
Accessing environment variables
</h2></div></div></div>
<p>
Many users would like to use environment variables in Jamfiles, for
example, to control location of external libraries. In many cases you
better declare those external libraries in the site-config.jam file, as
documented in the <a href="../recipies/site-config.html" title="Targets in site-config.jam">recipes
section</a>. However, if the users already have the environment variables set
up, it's not convenient to ask them to set up site-config.jam files as
well, and using environment variables might be reasonable.
</p>
<p>In Boost.Build V2, each Jamfile is a separate namespace, and the
variables defined in environment is imported into the global
namespace. Therefore, to access environment variable from Jamfile, you'd
need the following code:
</p>
<pre class="programlisting">
import modules ;
local SOME_LIBRARY_PATH = [ modules.peek : SOME_LIBRARY_PATH ] ;
exe a : a.cpp : &lt;include&gt;$(SOME_LIBRARY_PATH) ;
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../faq.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../faq.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="s03.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

77
doc/html/bbv2/faq/external.html Normal file
View file

@ -0,0 +1,77 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Can I get output of external program as a variable in a Jamfile?
</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../faq.html" title="Chapter 27. Frequently Asked Questions">
<link rel="prev" href="s04.html" title="
How to control the library order on Unix?
">
<link rel="next" href="s06.html" title="How to get the project-root location?
">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="s04.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../faq.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="s06.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.faq.external"></a>Can I get output of external program as a variable in a Jamfile?
</h2></div></div></div>
<p>From time to time users ask how to run an external program and save
the result in Jamfile variable, something like:
</p>
<pre class="programlisting">
local gtk_includes = [ RUN_COMMAND gtk-config ] ;
</pre>
<p>
Unfortunately, this is not possible at the moment. However, if the
result of command invocation is to be used in a command to some tool,
and you're working on Unix, the following workaround is possible.
</p>
<pre class="programlisting">
alias gtk+-2.0 : : : :
&lt;cflags&gt;"`pkg-config --cflags gtk+-2.0`"
&lt;inkflags&gt;"`pkg-config --libs gtk+-2.0`"
;
</pre>
<p>
If you use the "gtk+-2.0" target in sources, then the properties
specified above will be added to the build properties and eventually
will appear in the command line. Unix command line shell processes
the backticks quoting by running the tool and using its output --
which is what's desired in that case. Thanks to Daniel James for
sharing this approach.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="s04.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../faq.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="s06.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

80
doc/html/bbv2/faq/s03.html Normal file
View file

@ -0,0 +1,80 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>
How to control properties order?
</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../faq.html" title="Chapter 27. Frequently Asked Questions">
<link rel="prev" href="envar.html" title="
Accessing environment variables
">
<link rel="next" href="s04.html" title="
How to control the library order on Unix?
">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="envar.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../faq.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="s04.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="id1709000"></a>
How to control properties order?
</h2></div></div></div>
<p>For internal reasons, Boost.Build sorts all the properties
alphabetically. This means that if you write:
</p>
<pre class="programlisting">
exe a : a.cpp : &lt;include&gt;b &lt;include&gt;a ;
</pre>
<p>
then the command line with first mention the "a" include directory, and
then "b", even though they are specified in the opposite order. In most
cases, the user doesn't care. But sometimes the order of includes, or
other properties, is important. For example, if one uses both the C++
Boost library and the "boost-sandbox" (libraries in development), then
include path for boost-sandbox must come first, because some headers may
override ones in C++ Boost. For such cases, a special syntax is
provided:
</p>
<pre class="programlisting">
exe a : a.cpp : &lt;include&gt;a&amp;&amp;b ;
</pre>
<p>The <code class="computeroutput">&amp;&amp;</code> symbols separate values of an
property, and specify that the order of the values should be preserved. You
are advised to use this feature only when the order of properties really
matters, and not as a convenient shortcut. Using it everywhere might
negatively affect performance.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="envar.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../faq.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="s04.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

82
doc/html/bbv2/faq/s04.html Normal file
View file

@ -0,0 +1,82 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>
How to control the library order on Unix?
</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../faq.html" title="Chapter 27. Frequently Asked Questions">
<link rel="prev" href="s03.html" title="
How to control properties order?
">
<link rel="next" href="external.html" title="Can I get output of external program as a variable in a Jamfile?
">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="s03.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../faq.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="external.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="id1709033"></a>
How to control the library order on Unix?
</h2></div></div></div>
<p>On the Unix-like operating systems, the order in which static
libraries are specified when invoking the linker is important, because by
default, the linker uses one pass though the libraries list. Passing the
libraries in the incorrect order will lead to a link error. Further, this
behaviour is often used to make one library override symbols from
another. So, sometimes it's necessary to force specific order of
libraries.
</p>
<p>Boost.Build tries to automatically compute the right order. The
primary rule is that if library a "uses" library b, then library a will
appear on the command line before library b. Library a is considered to
use b is b is present either in the sources of a or in its
requirements. To explicitly specify the use relationship one can use the
&lt;use&gt; feature. For example, both of the following lines will cause
a to appear before b on the command line:
</p>
<pre class="programlisting">
lib a : a.cpp b ;
lib a : a.cpp : &lt;use&gt;b ;
</pre>
<p>
The same approach works for searched libraries, too:
</p>
<pre class="programlisting">
lib z ;
lib png : : &lt;use&gt;z ;
exe viewer : viewer png z ;
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="s03.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../faq.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="external.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

61
doc/html/bbv2/faq/s06.html Normal file
View file

@ -0,0 +1,61 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>How to get the project-root location?
</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../faq.html" title="Chapter 27. Frequently Asked Questions">
<link rel="prev" href="external.html" title="Can I get output of external program as a variable in a Jamfile?
">
<link rel="next" href="s07.html" title="How to change compilation flags for one file?
">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="external.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../faq.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="s07.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="id1709107"></a>How to get the project-root location?
</h2></div></div></div>
<p>You might want to use the location of the project-root in your
Jamfiles. To do it, you'd need to declare path constant in your
project-root.jam:
</p>
<pre class="programlisting">
path-constant TOP : . ;
</pre>
<p>
After that, the <code class="computeroutput">TOP</code> variable can be used in every Jamfile.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="external.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../faq.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="s07.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

76
doc/html/bbv2/faq/s07.html Normal file
View file

@ -0,0 +1,76 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>How to change compilation flags for one file?
</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../faq.html" title="Chapter 27. Frequently Asked Questions">
<link rel="prev" href="s06.html" title="How to get the project-root location?
">
<link rel="next" href="dll-path.html" title="Why are the dll-path and
hardcode-dll-paths properties useful?
">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="s06.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../faq.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="dll-path.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="id1709127"></a>How to change compilation flags for one file?
</h2></div></div></div>
<p>If one file must be compiled with special options, you need to
explicitly declare an <code class="computeroutput">obj</code> target for that file and then use
that target in your <code class="computeroutput">exe</code> or <code class="computeroutput">lib</code> target:
</p>
<pre class="programlisting">
exe a : a.cpp b ;
obj b : b.cpp : &lt;optimization&gt;off ;
</pre>
<p>
Of course you can use other properties, for example to specify specific
compiler options:
</p>
<pre class="programlisting">
exe a : a.cpp b ;
obj b : b.cpp : &lt;cflags&gt;-g ;
</pre>
<p>
You can also use <a href="../tutorial/conditions.html" title="Conditions and alternatives">conditional
properties</a> for finer control:
</p>
<pre class="programlisting">
exe a : a.cpp b ;
obj b : b.cpp : &lt;variant&gt;release:&lt;optimization&gt;off ;
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="s06.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../faq.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="dll-path.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

66
doc/html/bbv2/howto.html Normal file
View file

@ -0,0 +1,66 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 21. How to use this document</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../bbv2.html" title="Part III. Boost.Build v2 User Manual">
<link rel="prev" href="../bbv2.html" title="Part III. Boost.Build v2 User Manual">
<link rel="next" href="installation.html" title="Chapter 22. Installation">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../bbv2.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bbv2.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="installation.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="chapter" lang="en">
<div class="titlepage"><div><div><h2 class="title">
<a name="bbv2.howto"></a>Chapter 21. How to use this document</h2></div></div></div>
<p>
If you've just found out about Boost.Build V2 and want to know
if it will work for you, start with <a href="tutorial.html" title="Chapter 23. Tutorial">Chapter 23, <i>Tutorial</i></a>. You can continue with the <a href="advanced.html" title="Chapter 24. User documentation">Chapter 24, <i>User documentation</i></a>. When you're ready to try Boost.Build
in practice, go to <a href="installation.html" title="Chapter 22. Installation">Chapter 22, <i>Installation</i></a>.
</p>
<p>
If you are about to use Boost.Build on your project, or already
using it and have a problem, look at <a href="advanced.html" title="Chapter 24. User documentation">Chapter 24, <i>User documentation</i></a>.
</p>
<p>
If you're trying to build a project which uses Boost.Build,
look at <a href="installation.html" title="Chapter 22. Installation">Chapter 22, <i>Installation</i></a> and then read about
<a href="reference.html#bbv2.reference.commandline" title="Command line">the section called &#8220;Command line&#8221;</a>.
</p>
<p>
If you have questions, please post them to our <a href="http://boost.org/more/mailing_lists.htm#jamboost" target="_top">mailing
list</a>, and be sure to indicate in the subject line that
you're asking about Boost.Build <span class="bold"><strong>V2</strong></span>.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../bbv2.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bbv2.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="installation.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

170
doc/html/bbv2/installation.html Normal file
View file

@ -0,0 +1,170 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 22. Installation</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../bbv2.html" title="Part III. Boost.Build v2 User Manual">
<link rel="prev" href="howto.html" title="Chapter 21. How to use this document">
<link rel="next" href="tutorial.html" title="Chapter 23. Tutorial">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="howto.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bbv2.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="tutorial.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="chapter" lang="en">
<div class="titlepage"><div><div><h2 class="title">
<a name="bbv2.installation"></a>Chapter 22. Installation</h2></div></div></div>
<p>
This section describes how to install Boost.Build from a
released <a href="http://sourceforge.net/project/showfiles.php?group_id=7586&amp;package_id=8041" target="_top">Boost
source distribution</a>
or <a href="http://sourceforge.net/cvs/?group_id=7586" target="_top">CVS
image</a>.
<sup>[<a name="id1701106" href="#ftn.id1701106">2</a>]</sup>
All paths are given relative to
the <em class="firstterm">Boost.Build v2 root directory</em>, which is
located in the <code class="filename">tools/build/v2</code> subdirectory
of a full Boost <a href="http://sourceforge.net/project/showfiles.php?group_id=7586&amp;package_id=8041" target="_top">distribution</a>.
<sup>[<a name="id1701143" href="#ftn.id1701143">3</a>]</sup></p>
<div class="orderedlist"><ol type="1">
<li>
Boost.Build uses <a href="../../../tools/build/jam_src/index.html" target="_top">Boost.Jam</a>, an
extension of the <a href="http://www.perforce.com/jam/jam.html" target="_top">Perforce
Jam</a> portable <span><strong class="command">make</strong></span> replacement. The
recommended way to get Boost.Jam is to <span class="bold"><strong><a href="http://sourceforge.net/project/showfiles.php?group_id=7586&amp;package_id=72941" target="_top">download
a prebuilt executable</a></strong></span> from SourceForge.
If a prebuilt executable is not provided for your platform
or you are using Boost's sources in an unreleased state, it
may be necessary to <a href="../../../tools/build/jam_src/index.html#building_bjam" target="_top">build <span><strong class="command">bjam</strong></span>
from sources</a> included in the Boost source tree.
</li>
<li>
<p>
To install Boost.Jam, copy the executable,
called <span><strong class="command">bjam</strong></span>
or <span><strong class="command">bjam.exe</strong></span> to a location accessible in
your <code class="envar">PATH</code>. Go to the Boost.Build root
directory and
run <span><strong class="command">bjam <code class="option">--version</code></strong></span>. You
should see:
</p>
<pre class="screen">
Boost.Build V2 (Milestone N)
Boost.Jam xx.xx.xx
</pre>
<p>
where N is the version of Boost.Build you're using.
</p>
</li>
<li>
Configure Boost.Build to recognize the build resources (such
as compilers and libraries) you have installed on your
system. Open the
<code class="filename">user-config.jam</code> file in the Boost.Build
root directory and follow the instructions there to describe
your toolsets and libraries, and, if necessary, where they
are located.
</li>
<li>
You should now be able to go to the
<code class="filename">example/hello/</code> directory and run
<span><strong class="command">bjam</strong></span> there. A simple application will be
built. You can also play with other projects in the
<code class="filename">example/</code> directory.
</li>
</ol></div>
<p>
If you are using Boost's CVS state, be sure to
rebuild <span><strong class="command">bjam</strong></span> even if you have a previous
version. The CVS version of Boost.Build requires the CVS
version of Boost.Jam.
</p>
<p>
When <span><strong class="command">bjam</strong></span> is invoked, it always needs to be
able to find the Boost.Build root directory, where the
interpreted source code of Boost.Build is located. There are
two ways to tell <span><strong class="command">bjam</strong></span> about the root directory:
</p>
<div class="itemizedlist"><ul type="disc">
<li>
Set the environment variable <code class="envar">BOOST_BUILD_PATH</code>
to the absolute path of the Boost.Build root directory.
</li>
<li>
<p>
At the root directory of your project or in any of its
parent directories, create a file called
<code class="filename">boost-build.jam</code>, with a single line:
</p>
<pre class="programlisting">
boost-build <em class="replaceable"><code>/path/to/boost.build</code></em> ;
</pre>
</li>
</ul></div>
<p><span class="bold"><strong>N.B.</strong></span>
When <span><strong class="command">bjam</strong></span> is invoked from anywhere in the Boost
directory tree <span class="emphasis"><em>other than</em></span> the Boost.Build root
and its subdirectories, <a href="../../../tools/build" target="_top">Boost.Build
v1</a> is used by default. To override the default and use
Boost.Build v2, you have to add the <code class="option">--v2</code> command
line option to all <span><strong class="command">bjam</strong></span> invocations.</p>
<div class="footnotes">
<br><hr width="100" align="left">
<div class="footnote"><p><sup>[<a name="ftn.id1701106" href="#id1701106">2</a>] </sup>Note that packages prepared for
Unix/Linux systems usually make their own choices about where to
put things and even which parts of Boost to include. When we
say &#8220;released source distribution&#8221; we mean a
distribution of Boost as released on its SourceForge
<a href="http://sourceforge.net/project/showfiles.php?group_id=7586&amp;package_id=8041" target="_top">project
page</a>.
</p></div>
<div class="footnote"><p><sup>[<a name="ftn.id1701143" href="#id1701143">3</a>] </sup>The Boost.Build subset of boost is also distributed
separately, for those who are only interested in getting a
build tool. The top-level directory of a <a href="http://sourceforge.net/project/showfiles.php?group_id=7586&amp;package_id=80982" target="_top">Boost.Build
distribution</a> contains all the subdirectories of the
<code class="filename">tools/build/v2</code> subdirectory from a full
Boost distribution, so it is itself a valid Boost.Build root
directory. It also contains the
<code class="filename">tools/build/jam_src</code> subdirectory of a
full Boost distribution, so you can rebuild Boost.Jam from
source.
</p></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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="howto.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bbv2.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="tutorial.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

69
doc/html/bbv2/recipies/site-config.html Normal file
View file

@ -0,0 +1,69 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Targets in site-config.jam</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../faq.html" title="Chapter 27. Frequently Asked Questions">
<link rel="prev" href="../faq/dll-path.html" title="Why are the dll-path and
hardcode-dll-paths properties useful?
">
<link rel="next" href="../arch.html" title="Appendix B. Boost.Build v2 architecture">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../faq/dll-path.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../faq.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../arch.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.recipies.site-config"></a>Targets in site-config.jam</h2></div></div></div>
<p>It is desirable to declare standard libraries available on a
given system. Putting target declaration in Jamfile is not really
good, since locations of the libraries can vary. The solution is
to put the following to site-config.jam.</p>
<pre class="programlisting">
import project ;
project.initialize $(__name__) ;
project site-config ;
lib zlib : : &lt;name&gt;z ;
</pre>
<p>The second line allows this module to act as project. The
third line gives id to this project &#8212; it really has no location
and cannot be used otherwise. The fourth line just declares a
target. Now, one can write:
</p>
<pre class="programlisting">
exe hello : hello.cpp /site-config//zlib ;
</pre>
<p>
in any Jamfile.</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../faq/dll-path.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../faq.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../arch.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

337
doc/html/bbv2/reference.html Normal file
View file

@ -0,0 +1,337 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 26. Detailed reference</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../bbv2.html" title="Part III. Boost.Build v2 User Manual">
<link rel="prev" href="extending/toolset_modules.html" title="Toolset modules">
<link rel="next" href="reference/jamfiles.html" title="Writing Jamfiles">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="extending/toolset_modules.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bbv2.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="reference/jamfiles.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="chapter" lang="en">
<div class="titlepage"><div><div><h2 class="title">
<a name="bbv2.reference"></a>Chapter 26. Detailed reference</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="section"><a href="reference.html#bbv2.reference.general">General information</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="reference.html#bbv2.reference.init">Initialization</a></span></dt>
<dt><span class="section"><a href="reference.html#bbv2.reference.commandline">Command line</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="reference/jamfiles.html">Writing Jamfiles</a></span></dt>
<dd><dl><dt><span class="section"><a href="reference/jamfiles.html#bbv2.reference.headers">Generated headers</a></span></dt></dl></dd>
<dt><span class="section"><a href="reference/buildprocess.html">Build process</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="reference/buildprocess.html#bbv2.reference.buildprocess.alternatives">Alternative selection</a></span></dt>
<dt><span class="section"><a href="reference/buildprocess.html#bbv2.reference.buildprocess.common">Determining common properties</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="reference/definitions.html">Definitions</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="reference/definitions.html#bbv2.reference.features">Features and properties</a></span></dt>
<dt><span class="section"><a href="reference/definitions.html#bbv2.reference.variants">Build Variants</a></span></dt>
<dt><span class="section"><a href="reference/definitions.html#bbv2.reference.variants.proprefine">Property refinement</a></span></dt>
<dt><span class="section"><a href="reference/definitions.html#bbv2.reference.variants.propcond">Conditional properties</a></span></dt>
<dt><span class="section"><a href="reference/definitions.html#bbv2.reference.ids">Target identifiers and references</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="reference/generators.html">Generators</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="reference/generators.html#id1708734">Selecting and ranking viable generators</a></span></dt>
<dt><span class="section"><a href="reference/generators.html#id1708774">Running generators</a></span></dt>
<dt><span class="section"><a href="reference/generators.html#id1708800">Selecting dependency graph</a></span></dt>
<dt><span class="section"><a href="reference/generators.html#id1708811">Property adjustment</a></span></dt>
<dt><span class="section"><a href="reference/generators.html#id1708854">Transformations cache</a></span></dt>
</dl></dd>
</dl>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.reference.general"></a>General information</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="reference.html#bbv2.reference.init">Initialization</a></span></dt>
<dt><span class="section"><a href="reference.html#bbv2.reference.commandline">Command line</a></span></dt>
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.reference.init"></a>Initialization</h3></div></div></div>
<p>bjam's first job upon startup is to load the Jam code that
implements the build system. To do this, it searches for a file
called <code class="filename">boost-build.jam</code>, first in the invocation directory, then
in its parent and so forth up to the filesystem root, and finally
in the directories specified by the environment variable
BOOST_BUILD_PATH. When found, the file is interpreted, and should
specify the build system location by calling the boost-build
rule:</p>
<pre class="programlisting">
rule boost-build ( location ? )
</pre>
<p>
If location is a relative path, it is treated as relative to
the directory of <code class="filename">boost-build.jam</code>. The directory specified by
that location and the directories in BOOST_BUILD_PATH are then searched for
a file called <code class="filename">bootstrap.jam</code>, which is expected to
bootstrap the build system. This arrangement allows the build
system to work without any command-line or environment variable
settings. For example, if the build system files were located in a
directory "build-system/" at your project root, you might place a
<code class="filename">boost-build.jam</code> at the project root containing:
</p>
<pre class="programlisting">
boost-build build-system ;
</pre>
<p>
In this case, running bjam anywhere in the project tree will
automatically find the build system.</p>
<p>The default <code class="filename">bootstrap.jam</code>, after loading some standard
definitions, loads two files, which can be provided/customised by
user: <code class="filename">site-config.jam</code> and <code class="filename">user-config.jam</code>.</p>
<p>Locations where those files a search are summarized below:</p>
<div class="table">
<a name="bbv2.reference.init.config"></a><p class="title"><b>Table 26.1. Search paths for configuration files</b></p>
<table class="table" summary="Search paths for configuration files">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th> </th>
<th>site-config.jam</th>
<th>user-config.jam</th>
</tr></thead>
<tbody>
<tr>
<td>Linux</td>
<td>
<p><code class="computeroutput">/etc</code></p>
<p><code class="computeroutput">$HOME</code></p>
<p><code class="computeroutput">$BOOST_BUILD_PATH</code></p>
</td>
<td>
<p><code class="computeroutput">$HOME</code></p>
<p><code class="computeroutput">$BOOST_BUILD_PATH</code></p>
</td>
</tr>
<tr>
<td>Windows</td>
<td>
<p><code class="computeroutput">%SystemRoot%</code></p>
<p><code class="computeroutput">%HOMEDRIVE%%HOMEPATH%</code></p>
<p><code class="computeroutput">%HOME%</code></p>
<p><code class="computeroutput">%BOOST_BUILD_PATH%</code></p>
</td>
<td>
<p><code class="computeroutput">%HOMEDRIVE%%HOMEPATH%</code></p>
<p><code class="computeroutput">%HOME%</code></p>
<p><code class="computeroutput">%BOOST_BUILD_PATH%</code></p>
</td>
</tr>
</tbody>
</table>
</div>
<p>
Boost.Build comes with default versions of those files,
which can serve as templates for customized versions.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.reference.commandline"></a>Command line</h3></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="reference.html#bbv2.reference.init.args">Command line arguments</a></span></dt>
<dt><span class="section"><a href="reference.html#bbv2.reference.init.options">Command line options</a></span></dt>
</dl></div>
<p>The command line may contain:</p>
<div class="itemizedlist"><ul type="disc">
<li>Jam options,</li>
<li>Boost.Build <a href="reference.html#bbv2.reference.init.options" title="Command line options">options</a>,</li>
<li>Command line arguments</li>
</ul></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="bbv2.reference.init.args"></a>Command line arguments</h4></div></div></div>
<p>
Command line arguments specify targets and build
request using the following rules.
</p>
<div class="itemizedlist"><ul type="disc">
<li>
An argument that does not contain slashes or the <code class="computeroutput">=</code>
symbol is either a value of an implicit feature or of a target to
be built. It is taken to be value of a feature if an appropriate
feature exists. Otherwise, it is considered a <a href="reference/definitions.html#bbv2.reference.ids" title="Target identifiers and references">target id</a>. Building the
special target name &#8220;clean&#8221; has the same effect as
using the <code class="computeroutput">--clean</code> option.
</li>
<li>
<p>
An argument containing either slashes or
the <code class="computeroutput">=</code> symbol specifies a number of build
request elements (see ???). In its simplest
form, it's just a set of properties, separated by
slashes, which become a single build request element,
for example:
</p>
<pre class="programlisting">
borland/&lt;runtime-link&gt;static
</pre>
<p>
A more complex form can be used to save typing. For example,
instead of
</p>
<pre class="programlisting">
borland/runtime-link=static borland/runtime-link=dynamic
</pre>
<p>
one can use
</p>
<pre class="programlisting">
borland/runtime-link=static,dynamic
</pre>
<p>
Exactly, the conversion from argument to build request
elements is performed by (1) splitting the argument at each slash,
(2) converting each split part into a set of properties and (3)
taking all possible combinations
of the property sets. Each split
part should have the either the form
</p>
<pre class="programlisting"><span class="emphasis"><em>feature-name</em></span>=<span class="emphasis"><em>feature-value1</em></span>[","<span class="emphasis"><em>feature-valueN</em></span>]*
</pre>
<p>
or, in case of implicit features
</p>
<pre class="programlisting"><span class="emphasis"><em>feature-value1</em></span>[","<span class="emphasis"><em>feature-valueN</em></span>;]*
</pre>
<p>
will be converted into the property set
</p>
<pre class="programlisting">
&lt;feature-name&gt;feature-value1 .... &lt;feature-name&gt;feature-valueN
</pre>
</li>
</ul></div>
<p>
For example, the command line
</p>
<pre class="programlisting">
target1 debug gcc/runtime-link=dynamic,static
</pre>
<p>
would cause target called <code class="literal">target1</code> to be rebuilt in
debug mode, except that for gcc, both dynamically and statically
linked binaries would be created.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="bbv2.reference.init.options"></a>Command line options</h4></div></div></div>
<p>All of the Boost.Build options start with the "--" prefix.
They are described in the following table.</p>
<div class="table">
<a name="id1707672"></a><p class="title"><b>Table 26.2. Command line options</b></p>
<table class="table" summary="Command line options">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Option</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td><code class="literal">--version</code></td>
<td>Prints information on Boost.Build and Boost.Jam
versions.</td>
</tr>
<tr>
<td>
<a name="bbv2.reference.init.options.help"></a><code class="literal">--help</code>
</td>
<td>Access to the online help system. This prints general
information on how to use the help system with additional
--help* options.</td>
</tr>
<tr>
<td><code class="literal">--clean</code></td>
<td>Removes everything instead of building. Unlike
<code class="literal">clean</code> target in make, it is possible to clean only
some targets.</td>
</tr>
<tr>
<td><code class="literal">--debug</code></td>
<td>Enables internal checks.</td>
</tr>
<tr>
<td><code class="literal">--dump-projects</code></td>
<td>Cause the project structure to be output.</td>
</tr>
<tr>
<td><code class="literal">--no-error-backtrace</code></td>
<td>Don't print backtrace on errors. Primary useful for
testing.</td>
</tr>
<tr>
<td><code class="literal">--ignore-config</code></td>
<td>Do not load <code class="literal">site-config.jam</code> and
<code class="literal">user-config.jam</code>
</td>
</tr>
</tbody>
</table>
</div>
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="extending/toolset_modules.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bbv2.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="reference/jamfiles.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

141
doc/html/bbv2/reference/buildprocess.html Normal file
View file

@ -0,0 +1,141 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Build process</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../reference.html" title="Chapter 26. Detailed reference">
<link rel="prev" href="jamfiles.html" title="Writing Jamfiles">
<link rel="next" href="definitions.html" title="Definitions">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="jamfiles.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="definitions.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.reference.buildprocess"></a>Build process</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="buildprocess.html#bbv2.reference.buildprocess.alternatives">Alternative selection</a></span></dt>
<dt><span class="section"><a href="buildprocess.html#bbv2.reference.buildprocess.common">Determining common properties</a></span></dt>
</dl></div>
<p>The general overview of the build process was given in the
<a href="../advanced/build_process.html" title="The Build Process">user documentation</a>.
This section provides additional details, and some specific rules.
</p>
<p>To recap, building a target with specific properties includes the
following steps:
</p>
<div class="orderedlist"><ol type="1">
<li><p>applying default build,</p></li>
<li><p>selecting the main target alternative to use,
</p></li>
<li><p>determining "common" properties</p></li>
<li><p>building targets referred by the sources list and
dependency properties</p></li>
<li><p>adding the usage requirements produces when building
dependencies to the "common" properties</p></li>
<li><p>building the target using generators</p></li>
<li><p>computing the usage requirements to be returned</p></li>
</ol></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.reference.buildprocess.alternatives"></a>Alternative selection</h3></div></div></div>
<p>When there are several alternatives, one of them must be
selected. The process is as follows:</p>
<div class="orderedlist"><ol type="1">
<li>
For each alternative <span class="emphasis"><em>condition</em></span> is defined
as the set of base properies in requirements. [Note: it might be
better to specify the condition explicitly, as in
conditional requirements].
</li>
<li>
An alternative is viable only if all properties in condition
are present in build request.
</li>
<li>
If there's one viable alternative, it's choosen. Otherwise,
an attempt is made to find one best alternative. An alternative
a is better than another alternative b, iff set of properties
in b's condition is strict subset of the set of properities of
'a's condition. If there's one viable alternative, which is
better than all other, it's selected. Otherwise, an error is
reported.
</li>
</ol></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.reference.buildprocess.common"></a>Determining common properties</h3></div></div></div>
<p>The "common" properties is a somewhat artificial term. Those are
the intermediate property set from which both the build request for
dependencies and properties for building the target are derived.
</p>
<p>Since default build and alternatives are already handled, we have
only two inputs: build requests and requirements. Here are the rules
about common properties.
</p>
<div class="orderedlist"><ol type="1">
<li><p>Non-free feature can have only one
value</p></li>
<li><p>A non-conditional property in requirement in always
present in common properties.</p></li>
<li><p>A property in build request is present in
common properties, unless (2) tells otherwise.</p></li>
<li><p>If either build request, or requirements (non-conditional
or conditional) include an expandable property (either composite,
or property with specified subfeature value), the behaviour is
equivalent to explicitly adding all expanded properties to build
request or requirements.</p></li>
<li><p>If requirements include a conditional property, and
condiiton of this property is true in context of common
properties, then the conditional property should be in common
properties as well.</p></li>
<li><p>If no value for a feature is given by other rules
here, it has default value in common properties.</p></li>
</ol></div>
<p>Those rules are declarative, they don't specify how to compute the
common properties. However, they provide enough information for the
user. The important point is the handling of conditional
requirements. The condition can be satisfied either by property in
build request, by non-conditional requirements, or even by another
conditional property. For example, the following example works as
expected:
</p>
<pre class="programlisting">
exe a : a.cpp
: &lt;toolset&gt;gcc:&lt;variant&gt;release
&lt;variant&gt;release:&lt;define&gt;FOO ;
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="jamfiles.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="definitions.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

379
doc/html/bbv2/reference/definitions.html Normal file
View file

@ -0,0 +1,379 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Definitions</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../reference.html" title="Chapter 26. Detailed reference">
<link rel="prev" href="buildprocess.html" title="Build process">
<link rel="next" href="generators.html" title="Generators">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="buildprocess.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="generators.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.reference.definitions"></a>Definitions</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="definitions.html#bbv2.reference.features">Features and properties</a></span></dt>
<dt><span class="section"><a href="definitions.html#bbv2.reference.variants">Build Variants</a></span></dt>
<dt><span class="section"><a href="definitions.html#bbv2.reference.variants.proprefine">Property refinement</a></span></dt>
<dt><span class="section"><a href="definitions.html#bbv2.reference.variants.propcond">Conditional properties</a></span></dt>
<dt><span class="section"><a href="definitions.html#bbv2.reference.ids">Target identifiers and references</a></span></dt>
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.reference.features"></a>Features and properties</h3></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="definitions.html#bbv2.reference.features.validity">Property Validity</a></span></dt>
<dt><span class="section"><a href="definitions.html#bbv2.reference.features.attributes">Feature Attributes</a></span></dt>
<dt><span class="section"><a href="definitions.html#bbv2.reference.features.declaration">Feature Declaration</a></span></dt>
</dl></div>
<p>A <span class="emphasis"><em>feature</em></span> is a normalized (toolset-independent)
aspect of a build configuration, such as whether inlining is
enabled. Feature names may not contain the '<code class="literal">&gt;</code>'
character.</p>
<p>Each feature in a build configuration has one or more
associated <span class="emphasis"><em>value</em></span>s. Feature values for non-free features
may not contain the '<code class="literal">&lt;</code>', '<code class="literal">:</code>', or
'<code class="literal">=</code>' characters. Feature values for free features may not
contain the '<code class="literal">&lt;</code>' character.</p>
<p>A <span class="emphasis"><em>property</em></span> is a (feature,value) pair, expressed as
&lt;feature&gt;value.</p>
<p>A <span class="emphasis"><em>subfeature</em></span> is a feature that only exists in the
presence of its parent feature, and whose identity can be derived
(in the context of its parent) from its value. A subfeature's
parent can never be another subfeature. Thus, features and their
subfeatures form a two-level hierarchy.</p>
<p>A <span class="emphasis"><em>value-string</em></span> for a feature <span class="bold"><strong>F</strong></span> is a string of
the form
<code class="literal">value-subvalue1-subvalue2</code>...<code class="literal">-subvalueN</code>, where
<code class="literal">value</code> is a legal value for <span class="bold"><strong>F</strong></span> and
<code class="literal">subvalue1</code>...<code class="literal">subvalueN</code> are legal values of some
of <span class="bold"><strong>F</strong></span>'s subfeatures. For example, the properties
<code class="literal">&lt;toolset&gt;gcc &lt;toolset-version&gt;3.0.1</code> can be
expressed more conscisely using a value-string, as
<code class="literal">&lt;toolset&gt;gcc-3.0.1</code>.</p>
<p>A <span class="emphasis"><em>property set</em></span> is a set of properties (i.e. a
collection without duplicates), for instance:
<code class="literal">&lt;toolset&gt;gcc &lt;runtime-link&gt;static</code>.</p>
<p>A <span class="emphasis"><em>property path</em></span> is a property set whose elements have
been joined into a single string separated by slashes. A property
path representation of the previous example would be
<code class="literal">&lt;toolset&gt;gcc/&lt;runtime-link&gt;static</code>.</p>
<p>A <span class="emphasis"><em>build specification</em></span> is a property set that fully
describes the set of features used to build a target.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="bbv2.reference.features.validity"></a>Property Validity</h4></div></div></div>
<p>
For <a href="definitions.html#bbv2.reference.features.attributes.free">free</a>
features, all values are valid. For all other features,
the valid values are explicitly specified, and the build
system will report an error for the use of an invalid
feature-value. Subproperty validity may be restricted so
that certain values are valid only in the presence of
certain other subproperties. For example, it is possible
to specify that the <code class="computeroutput">&lt;gcc-target&gt;mingw</code>
property is only valid in the presence of
<code class="computeroutput">&lt;gcc-version&gt;2.95.2</code>.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="bbv2.reference.features.attributes"></a>Feature Attributes</h4></div></div></div>
<p>Each feature has a collection of zero or more of the following
attributes. Feature attributes are low-level descriptions of how the
build system should interpret a feature's values when they appear in
a build request. We also refer to the attributes of properties, so
that an <span class="emphasis"><em>incidental</em></span> property, for example, is
one whose feature has the <span class="emphasis"><em>incidental</em></span>
attribute.</p>
<div class="itemizedlist"><ul type="disc">
<li>
<p><span class="emphasis"><em>incidental</em></span></p>
<p>Incidental features are assumed not to affect build
products at all. As a consequence, the build system may use
the same file for targets whose build specification differs
only in incidental features. A feature that controls a
compiler's warning level is one example of a likely
incidental feature.</p>
<p>Non-incidental features are assumed to affect build
products, so the files for targets whose build specification
differs in non-incidental features are placed in different
directories as described in "target paths" below. [ where? ]
</p>
</li>
<li>
<p><a name="bbv2.reference.features.attributes.propagated"></a><span class="emphasis"><em>propagated</em></span></p>
<p>Features of this kind are
propagated to dependencies. That is, if a <a href="../advanced/jamfiles.html#bbv2.advanced.targets.main">main target</a> is built using a
propagated
property, the build systems attempts to use the same property
when building any of its dependencies as part of that main
target. For instance, when an optimized exectuable is
requested, one usually wants it to be linked with optimized
libraries. Thus, the <code class="literal">&lt;optimization&gt;</code> feature is
propagated.</p>
</li>
<li>
<p><a name="bbv2.reference.features.attributes.free"></a><span class="emphasis"><em>free</em></span></p>
<p>Most features have a finite set of allowed values, and can
only take on a single value from that set in a given build
specification. Free features, on the other hand, can have
several values at a time and each value can be an arbitrary
string. For example, it is possible to have several
preprocessor symbols defined simultaneously:</p>
<pre class="programlisting">
&lt;define&gt;NDEBUG=1 &lt;define&gt;HAS_CONFIG_H=1
</pre>
</li>
<li>
<p><span class="emphasis"><em>optional</em></span></p>
<p>An optional feature is a feature that is not required to
appear in a build specification. Every non-optional non-free
feature has a default value that is used when a value for
the feature is not otherwise specified, either in a target's
requirements or in the user's build request. [A feature's
default value is given by the first value listed in the
feature's declaration. -- move this elsewhere - dwa]</p>
</li>
<li>
<p><span class="emphasis"><em>symmetric</em></span></p>
<p>A symmetric feature's default value is not automatically
included in <a href="definitions.html#bbv2.reference.variants" title="Build Variants">build variants</a>. Normally
a feature only generates a subvariant directory when its
value differs from the value specified by the build variant,
leading to an assymmetric subvariant directory structure for
certain values of the feature. A symmetric feature, when
relevant to the toolset, always generates a corresponding
subvariant directory.</p>
</li>
<li>
<p><span class="emphasis"><em>path</em></span></p>
<p>The value of a path feature specifies a path. The path is
treated as relative to the directory of Jamfile where path
feature is used and is translated appropriately by the build
system when the build is invoked from a different
directory</p>
</li>
<li>
<p><span class="emphasis"><em>implicit</em></span></p>
<p>Values of implicit features alone identify the feature.
For example, a user is not required to write
"&lt;toolset&gt;gcc", but can simply write "gcc". Implicit
feature names also don't appear in variant paths, although
the values do. Thus: bin/gcc/... as opposed to
bin/toolset-gcc/.... There should typically be only a few
such features, to avoid possible name clashes.</p>
</li>
<li>
<p><span class="emphasis"><em>composite</em></span></p>
<p>Composite features actually correspond to groups of
properties. For example, a build variant is a composite
feature. When generating targets from a set of build
properties, composite features are recursively expanded and
<span class="emphasis"><em>added</em></span> to the build property set, so rules can find
them if necessary. Non-composite non-free features override
components of composite features in a build property set.</p>
</li>
<li>
<p><span class="emphasis"><em>dependency</em></span></p>
<p>The value of dependency feature if a target reference.
When used for building of a main target, the value of
dependency feature is treated as additional dependency.</p>
<p>For example, dependency features allow to state that
library A depends on library B. As the result, whenever an
application will link to A, it will also link to B.
Specifying B as dependency of A is different from adding B to
the sources of A. </p>
</li>
</ul></div>
<p>Features that are neither free nor incidental are called
<span class="emphasis"><em>base</em></span> features.</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="bbv2.reference.features.declaration"></a>Feature Declaration</h4></div></div></div>
<p>The low-level feature declaration interface is the
<code class="literal">feature</code> rule from the
<code class="literal">feature</code> module:
</p>
<pre class="programlisting">
rule feature ( name : allowed-values * : attributes * )
</pre>
<p>
A feature's allowed-values may be extended with the
<code class="computeroutput">feature.extend</code> rule.
</p>
</div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.reference.variants"></a>Build Variants</h3></div></div></div>
<p>
A build variant, or (simply variant) is a special kind of composite
feature that automatically incorporates the default values of
features that . Typically you'll want at least two separate
variants: one for debugging, and one for your release code. [
Volodya says: "Yea, we'd need to mention that it's a composite
feature and describe how they are declared, in pacticular that
default values of non-optional features are incorporated into
build variant automagically. Also, do we wan't some variant
inheritance/extension/templates. I don't remember how it works in
V1, so can't document this for V2.". Will clean up soon -DWA ]
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.reference.variants.proprefine"></a>Property refinement</h3></div></div></div>
<p>When a target with certain properties is requested, and that
target requires some set of properties, it is needed to find the
set of properties to use for building. This process is called
<span class="emphasis"><em>property refinement</em></span> and is performed by these rules</p>
<div class="orderedlist"><ol type="1">
<li>
Each property in the required set is added to the original
property set
</li>
<li>
If the original property set includes property with a different
value of non free feature, that property is removed.
</li>
</ol></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.reference.variants.propcond"></a>Conditional properties</h3></div></div></div>
<p>Sometime it's desirable to apply certain requirements only for
a specific combination of other properties. For example, one of
compilers that you use issues a pointless warning that you want to
suppress by passing a command line option to it. You would not
want to pass that option to other compilers. Conditional
properties allow you to do just that. Their syntax is:</p>
<pre class="programlisting">
property ( "," property ) * ":" property
</pre>
<p>
For example, the problem above would be solved by:
</p>
<pre class="programlisting">
exe hello : hello.cpp : &lt;toolset&gt;yfc:&lt;cxxflags&gt;-disable-pointless-warning ;
</pre>
<p>The syntax also allows several properties in the condition, for
example:
</p>
<pre class="programlisting">
exe hello : hello.cpp : &lt;os&gt;NT,&lt;toolset&gt;gcc:&lt;link&gt;static ;
</pre>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.reference.ids"></a>Target identifiers and references</h3></div></div></div>
<p><span class="emphasis"><em>Target identifier</em></span> is used to denote a
target. The syntax is:</p>
<pre class="programlisting">
target-id -&gt; (project-id | target-name | file-name )
| (project-id | directory-name) "//" target-name
project-id -&gt; path
target-name -&gt; path
file-name -&gt; path
directory-name -&gt; path
</pre>
<p>
This grammar allows some elements to be recognized as either
</p>
<div class="itemizedlist"><ul type="disc">
<li>
project id (at this point, all project ids start with slash).
</li>
<li>
name of target declared in current Jamfile (note that target
names may include slash).
</li>
<li>
a regular file, denoted by absolute name or name relative to
project's sources location.
</li>
</ul></div>
<p>
To determine the real meaning a check is made if project-id
by the specified name exists, and then if main target of that
name exists. For example, valid target ids might be:
</p>
<pre class="screen">
a -- target in current project
lib/b.cpp -- regular file
/boost/thread -- project "/boost/thread"
/home/ghost/build/lr_library//parser -- target in specific project
</pre>
<p><span class="bold"><strong>Rationale:</strong></span>Target is separated from project by special
separator (not just slash), because:</p>
<div class="itemizedlist"><ul type="disc">
<li>
It emphasises that projects and targets are different things.
</li>
<li>
It allows to have main target names with slashes.
</li>
</ul></div>
<p><a name="bbv2.reference.targets.references"></a><span class="emphasis"><em>Target reference</em></span> is used to
specify a source target, and may additionally specify desired
properties for that target. It has this syntax:</p>
<pre class="programlisting">
target-reference -&gt; target-id [ "/" requested-properties ]
requested-properties -&gt; property-path
</pre>
<p>
For example,
</p>
<pre class="programlisting">
exe compiler : compiler.cpp libs/cmdline/&lt;optimization&gt;space ;
</pre>
<p>
would cause the version of <code class="literal">cmdline</code> library,
optimized for space, to be linked in even if the
<code class="literal">compiler</code> executable is build with optimization for
speed.
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="buildprocess.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="generators.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

196
doc/html/bbv2/reference/generators.html Normal file
View file

@ -0,0 +1,196 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Generators</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../reference.html" title="Chapter 26. Detailed reference">
<link rel="prev" href="definitions.html" title="Definitions">
<link rel="next" href="../faq.html" title="Chapter 27. Frequently Asked Questions">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="definitions.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../faq.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.reference.generators"></a>Generators</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="generators.html#id1708734">Selecting and ranking viable generators</a></span></dt>
<dt><span class="section"><a href="generators.html#id1708774">Running generators</a></span></dt>
<dt><span class="section"><a href="generators.html#id1708800">Selecting dependency graph</a></span></dt>
<dt><span class="section"><a href="generators.html#id1708811">Property adjustment</a></span></dt>
<dt><span class="section"><a href="generators.html#id1708854">Transformations cache</a></span></dt>
</dl></div>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p>The information is this section is likely to be outdated
and misleading.
</p>
</div>
<p>To construct a main target with given properties from sources,
it is required to create a dependency graph for that main target,
which will also include actions to be run. The algorithm for
creating the dependency graph is described here.</p>
<p>The fundamental concept is <span class="emphasis"><em>generator</em></span>. If encapsulates
the notion of build tool and is capable to converting a set of
input targets into a set of output targets, with some properties.
Generator matches a build tool as closely as possible: it works
only when the tool can work with requested properties (for
example, msvc compiler can't work when requested toolset is gcc),
and should produce exactly the same targets as the tool (for
example, if Borland's linker produces additional files with debug
information, generator should also).</p>
<p>Given a set of generators, the fundamental operation is to
construct a target of a given type, with given properties, from a
set of targets. That operation is performed by rule
<code class="literal">generators.construct</code> and the used algorithm is described
below.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id1708734"></a>Selecting and ranking viable generators</h3></div></div></div>
<p>Each generator, in addition to target types that it can
produce, have attribute that affects its applicability in
particular sitiation. Those attributes are:</p>
<div class="orderedlist"><ol type="1">
<li>
Required properties, which are properties absolutely
necessary for the generator to work. For example, generator
encapsulating the gcc compiler would have &lt;toolset&gt;gcc as
required property.
</li>
<li>
Optional properties, which increase the generators
suitability for a particual build.
</li>
</ol></div>
<p>
Generator's required and optional properties may not include
either free or incidental properties. (Allowing this would
greatly complicate caching targets).
</p>
<p>When trying to construct a target, the first step is to select
all possible generators for the requested target type, which
required properties are a subset of requested properties.
Generators that were already selected up the call stack are
excluded. In addition, if any composing generators were selected
up the call stack, all other composing generators are ignored
(TODO: define composing generators). The found generators
are assigned a rank, which is the number of optional properties
present in requested properties. Finally, generators with highest
rank are selected for futher processing.</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id1708774"></a>Running generators</h3></div></div></div>
<p>When generators are selected, each is run to produce a list of
created targets. This list might include targets that are not of
requested types, because generators create the same targets as
some tool, and tool's behaviour is fixed. (Note: should specify
that in some cases we actually want extra targets). If generator
fails, it returns an empty list. Generator is free to call
'construct' again, to convert sources to the types it can handle.
It also can pass modified properties to 'construct'. However, a
generator is not allowed to modify any propagated properties,
otherwise when actually consuming properties we might discover
that the set of propagated properties is different from what was
used for building sources.</p>
<p>For all targets that are not of requested types, we try to
convert them to requested type, using a second call to
<code class="literal">construct</code>. This is done in order to support
transformation sequences where single source file expands to
several later. See <a href="http://groups.yahoo.com/group/jamboost/message/1667" target="_top">this
message</a> for details.</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id1708800"></a>Selecting dependency graph</h3></div></div></div>
<p>
After all generators are run,
it is necessary to decide which of successfull invocation will be
taken as final result. At the moment, this is not done. Instead,
it is checked whether all successfull generator invocation
returned the same target list. Error is issued otherwise.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id1708811"></a>Property adjustment</h3></div></div></div>
<p>Because target location is determined by the build system, it
is sometimes necessary to adjust properties, in order to not
break actions. For example, if there's an action that generates
a header, say "a_parser.h", and a source file "a.cpp" which
includes that file, we must make everything work as if a_parser.h
is generated in the same directory where it would be generated
without any subvariants.</p>
<p>Correct property adjustment can be done only after all targets
are created, so the approach taken is:</p>
<div class="orderedlist"><ol type="1">
<li><p>
When dependency graph is constructed, each action can be
assigned a rule for property adjustment.
</p></li>
<li><p>
When virtual target is actualized, that rule is run and
return the final set of properties. At this stage it can use
information of all created virtual targets.
</p></li>
</ol></div>
<p>In case of quoted includes, no adjustment can give 100% correct
results. If target dirs are not changed by build system, quoted
includes are searched in "." and then in include path, while angle
includes are searched only in include path. When target dirs are
changed, we'd want to make quoted includes to be search in "." then in
additional dirs and then in the include path and make angle includes
be searched in include path, probably with additional paths added at
some position. Unless, include path already has "." as the first
element, this is not possible. So, either generated headers should not
be included with quotes, or first element of include path should be
".", which essentially erases the difference between quoted and angle
includes. <span class="bold"><strong>Note:</strong></span> the only way to get
"." as include path into compiler command line is via verbatim
compiler option. In all other case, Boost.Build will convert "." into
directory where it occurs.</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id1708854"></a>Transformations cache</h3></div></div></div>
<p>
Under certain conditions, an
attempt is made to cache results of transformation search. First,
the sources are replaced with targets with special name and the
found target list is stored. Later, when properties, requested
type, and source type are the same, the store target list is
retrieved and cloned, with appropriate change in names.
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="definitions.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../faq.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

79
doc/html/bbv2/reference/jamfiles.html Normal file
View file

@ -0,0 +1,79 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Writing Jamfiles</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../reference.html" title="Chapter 26. Detailed reference">
<link rel="prev" href="../reference.html" title="Chapter 26. Detailed reference">
<link rel="next" href="buildprocess.html" title="Build process">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../reference.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="buildprocess.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.reference.jamfiles"></a>Writing Jamfiles</h2></div></div></div>
<div class="toc"><dl><dt><span class="section"><a href="jamfiles.html#bbv2.reference.headers">Generated headers</a></span></dt></dl></div>
<p>This section describes specific information about writing Jamfiles.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.reference.headers"></a>Generated headers</h3></div></div></div>
<p>Usually, Boost.Build handles implicit dependendies completely
automatically. For example, for C++ files, all <code class="literal">#include</code>
statements are found and handled. The only aspect where user help
might be needed is implicit dependency on generated files.</p>
<p>By default, Boost.Build handles such dependencies within one
main target. For example, assume that main target "app" has two
sources, "app.cpp" and "parser.y". The latter source is converted
into "parser.c" and "parser.h". Then, if "app.cpp" includes
"parser.h", Boost.Build will detect this dependency. Moreover,
since "parser.h" will be generated into a build directory, the
path to that directory will automatically added to include
path.</p>
<p>Making this mechanism work across main target boundaries is
possible, but imposes certain overhead. For that reason, if
there's implicit dependency on files from other main targets, the
<code class="literal">&lt;implicit-dependency&gt;</code> [ link ] feature must
be used, for example:</p>
<pre class="programlisting">
lib parser : parser.y ;
exe app : app.cpp : &lt;implicit-dependency&gt;parser ;
</pre>
<p>
The above example tells the build system that when scanning
all sources of "app" for implicit-dependencies, it should consider
targets from "parser" as potential dependencies.
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../reference.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="buildprocess.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

135
doc/html/bbv2/tutorial.html Normal file
View file

@ -0,0 +1,135 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 23. Tutorial</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../bbv2.html" title="Part III. Boost.Build v2 User Manual">
<link rel="prev" href="installation.html" title="Chapter 22. Installation">
<link rel="next" href="tutorial/properties.html" title="Properties">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="installation.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bbv2.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="tutorial/properties.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="chapter" lang="en">
<div class="titlepage"><div><div><h2 class="title">
<a name="bbv2.tutorial"></a>Chapter 23. Tutorial</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="section"><a href="tutorial.html#bbv2.tutorial.hello">Hello, world</a></span></dt>
<dt><span class="section"><a href="tutorial/properties.html">Properties</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="tutorial/properties.html#bbv2.tutorial.properties.requirements">Build Requests and Target Requirements</a></span></dt>
<dt><span class="section"><a href="tutorial/properties.html#bbv2.tutorial.properties.project_attributes">Project Attributes</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="tutorial/hierarchy.html">Project Hierarchies</a></span></dt>
<dt><span class="section"><a href="tutorial/libs.html">Dependent Targets</a></span></dt>
<dt><span class="section"><a href="tutorial/linkage.html">Static and shared libaries</a></span></dt>
<dt><span class="section"><a href="tutorial/conditions.html">Conditions and alternatives</a></span></dt>
<dt><span class="section"><a href="tutorial/prebuilt.html">Prebuilt targets</a></span></dt>
</dl>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.tutorial.hello"></a>Hello, world</h2></div></div></div>
<p>The simplest project that Boost.Build can construct is
stored in <code class="filename">example/hello/</code> directory. The
project is described by a file
called <code class="filename">Jamroot</code> that contains:
</p>
<pre class="programlisting">
exe hello : hello.cpp ;
</pre>
<p>
Even with this simple setup, you can do some interesting
things. First of all, just invoking <span><strong class="command">bjam</strong></span> will
build the <code class="filename">hello</code>
executable by compiling and
linking <code class="filename">hello.cpp</code>. By default, debug variant
is built. Now, to build the
release variant of <code class="filename">hello</code>, invoke
</p>
<pre class="screen">
bjam release
</pre>
<p>
Note that debug and release variants are created in different
directories, so you can switch between variants or even build
multiple variants at once, without any unnecessary
recompilation. Let's extend the example by adding another line
to our project's <code class="filename">Jamroot</code>:
</p>
<pre class="programlisting">
exe hello2 : hello.cpp ;
</pre>
<p>
Now let us build both the debug and release variants of our project
again:
</p>
<pre class="screen">
bjam debug release
</pre>
<p>
Note that two variants of <code class="filename">hello2</code> are linked.
Since we have already built both variants
of <code class="filename">hello</code>, hello.cpp won't be recompiled;
instead the existing object files will just be linked into the
corresponding variants of <code class="filename">hello2</code>. Now
let's remove all the built products:
</p>
<pre class="screen">
bjam --clean debug release
</pre>
<p>
It's also possible to build or clean specific targets. The
following two commands, respectively, build or clean only the
debug version of <code class="filename">hello2</code>.
</p>
<pre class="screen">
bjam hello2
bjam --clean hello2
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="installation.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bbv2.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="tutorial/properties.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

88
doc/html/bbv2/tutorial/conditions.html Normal file
View file

@ -0,0 +1,88 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Conditions and alternatives</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../tutorial.html" title="Chapter 23. Tutorial">
<link rel="prev" href="linkage.html" title="Static and shared libaries">
<link rel="next" href="prebuilt.html" title="Prebuilt targets">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="linkage.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="prebuilt.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.tutorial.conditions"></a>Conditions and alternatives</h2></div></div></div>
<p>Sometimes, particular relationships need to be maintained
among a target's build properties. This can be achieved with
<em class="firstterm">conditional
requirement</em>. For example, you might want to set
specific <code class="computeroutput">#defines</code> when a library is built as shared,
or when a target's <code class="computeroutput">release</code> variant is built in
release mode.
</p>
<pre class="programlisting">
lib network : network.cpp
: <span class="bold"><strong>&lt;link&gt;shared:&lt;define&gt;NEWORK_LIB_SHARED</strong></span>
&lt;variant&gt;release:&lt;define&gt;EXTRA_FAST
;
</pre>
<p>
In the example above, whenever <code class="filename">network</code> is
built with <code class="computeroutput">&lt;link&gt;shared</code>,
<code class="computeroutput">&lt;define&gt;NEWORK_LIB_SHARED</code> will be in its
properties, too.
</p>
<p>
Sometimes the ways a target is built are so different that
describing them using conditional requirements would be
hard. For example, imagine that a library actually uses
different source files depending on the toolset used to build
it. We can express this situation using <em class="firstterm">target
alternatives</em>:
</p>
<pre class="programlisting">
lib demangler : dummy_demangler.cpp ; # alternative 1
lib demangler : demangler_gcc.cpp : &lt;toolset&gt;gcc ; # alternative 2
lib demangler : demangler_msvc.cpp : &lt;toolset&gt;msvc ; # alternative 3
</pre>
<p>
In the example above, when built with <code class="literal">gcc</code>
or <code class="literal">msvc</code>, <code class="filename">demangler</code>
will use a source file specific to the toolset. Otherwise, it
will use a generic source file,
<code class="filename">dummy_demangler.cpp</code>.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="linkage.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="prebuilt.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

144
doc/html/bbv2/tutorial/hierarchy.html Normal file
View file

@ -0,0 +1,144 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Project Hierarchies</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../tutorial.html" title="Chapter 23. Tutorial">
<link rel="prev" href="properties.html" title="Properties">
<link rel="next" href="libs.html" title="Dependent Targets">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="properties.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="libs.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.tutorial.hierarchy"></a>Project Hierarchies</h2></div></div></div>
<p>So far we've only considered examples with one project
(i.e. with one user-written Boost.Jam file,
<code class="filename">Jamroot</code>). A typical large codebase would be
composed of many projects organized into a tree. The top of the
tree is called the <em class="firstterm">project root</em>. Every
subproject is defined by a file called
<code class="filename">Jamfile</code> in a descendant directory of the
project root. The parent project of a subproject is defined by
the nearest <code class="filename">Jamfile</code> or
<code class="filename">Jamroot</code> file in an ancestor directory. For
example, in the following directory layout:
</p>
<pre class="screen">
top/
|
+-- Jamroot
|
+-- app/
| |
| +-- Jamfile
| `-- app.cpp
|
`-- util/
|
+-- foo/
. |
. +-- Jamfile
. `-- bar.cpp
</pre>
<p>
the project root is <code class="filename">top/</code>. Because there is
no <code class="filename">Jamfile</code> in
<code class="filename">top/util/</code>, the projects in
<code class="filename">top/app/</code> and
<code class="filename">top/util/foo/</code> are immediate children of the
root project.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
When we refer to a &#8220;Jamfile,&#8221; set in normal
type, we mean a file called either
<code class="filename">Jamfile</code> or
<code class="filename">Jamroot</code>. When we need to be more
specific, the filename will be set as
&#8220;<code class="filename">Jamfile</code>&#8221; or
&#8220;<code class="filename">Jamroot</code>.&#8221;
</p>
</div>
<p>
Projects inherit all attributes (such as requirements)
from their parents. Inherited requirements are combined with
any requirements specified by the sub-project.
For example, if <code class="filename">top/Jamroot</code> has
</p>
<pre class="programlisting">
&lt;include&gt;/home/ghost/local
</pre>
<p>
in its requirements, then all of its sub-projects will have it
in their requirements, too. Of course, any project can add
include paths to those specified by its parents. <sup>[<a name="id1701983" href="#ftn.id1701983">5</a>]</sup>
More details can be found in
<a href="../advanced/jamfiles.html#bbv2.advanced.projects" title="Projects">the section called &#8220;Projects&#8221;</a>.
</p>
<p>
Invoking <span><strong class="command">bjam</strong></span> without explicitly specifying
any targets on the command-line builds the project rooted in the
current directory. Building a project does not automatically
cause its sub-projects to be built unless the parent project's
Jamfile explicitly requests it. In our example,
<code class="filename">top/Jamroot</code> might contain:
</p>
<pre class="programlisting">
build-project app ;
</pre>
<p>
which would cause the project in <code class="filename">top/app/</code>
to be built whenever the project in <code class="filename">top/</code> is
built. However, targets in <code class="filename">top/util/foo/</code>
will be built only if they are needed by targets in
<code class="filename">top/</code> or <code class="filename">top/app/</code>.
</p>
<div class="footnotes">
<br><hr width="100" align="left">
<div class="footnote"><p><sup>[<a name="ftn.id1701983" href="#id1701983">5</a>] </sup>Many
features will be overridden,
rather than added-to, in sub-projects. See <a href="../reference/definitions.html#bbv2.reference.features.attributes" title="Feature Attributes">the section called &#8220;Feature Attributes&#8221;</a> for more
information</p></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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="properties.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="libs.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

170
doc/html/bbv2/tutorial/libs.html Normal file
View file

@ -0,0 +1,170 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Dependent Targets</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../tutorial.html" title="Chapter 23. Tutorial">
<link rel="prev" href="hierarchy.html" title="Project Hierarchies">
<link rel="next" href="linkage.html" title="Static and shared libaries">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="hierarchy.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="linkage.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.tutorial.libs"></a>Dependent Targets</h2></div></div></div>
<p>
Targets that are &#8220;needed&#8221; by other targets are called
<em class="firstterm">dependencies</em> of those other targets. The
targets that need the other targets are called
<em class="firstterm">dependent</em> targets.
</p>
<p>To get a feeling of target dependencies, let's continue the
above example and see how <code class="filename">top/app/Jamfile</code> can
use libraries from <code class="filename">top/util/foo</code>. If
<code class="filename">top/util/foo/Jamfile</code> contains
</p>
<pre class="programlisting">
lib bar : bar.cpp ;
</pre>
<p>
then to use this library in <code class="filename">top/app/Jamfile</code>, we can
write:
</p>
<pre class="programlisting">
exe app : app.cpp ../util/foo//bar ;
</pre>
<p>
While <code class="computeroutput">app.cpp</code> refers to a regular source file,
<code class="computeroutput">../util/foo//bar</code> is a reference to another target:
a library <code class="filename">bar</code> declared in the Jamfile at
<code class="filename">../util/foo</code>.
</p>
<div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Tip</h3>
<p>Some other build system have special syntax for listing dependent
libraries, for example <code class="varname">LIBS</code> variable. In Boost.Build,
you just add the library to the list of sources.
</p>
</div>
<p>Suppose we build <code class="filename">app</code> with:
</p>
<pre class="screen">
bjam app optimization=full define=USE_ASM
</pre>
<p>
Which properties will be used to build <code class="computeroutput">foo</code>? The answer is
that some features are
<em class="firstterm">propagated</em>&#8212;Boost.Build attempts to use
dependencies with the same value of propagated features. The
<code class="varname">&lt;optimization&gt;</code> feature is propagated, so both
<code class="filename">app</code> and <code class="filename">foo</code> will be compiled
with full optimization. But <code class="varname">&lt;define&gt;</code> is not
propagated: its value will be added as-is to the compiler flags for
<code class="filename">a.cpp</code>, but won't affect <code class="filename">foo</code>.
</p>
<p>Let's improve this project further.
The library
probably has some headers that must be used when compiling
<code class="filename">app.cpp</code>. We could manually add the necessary
<code class="computeroutput">#include</code> paths to <code class="filename">app</code>'s
requirements as values of the
<code class="varname">&lt;include&gt;</code> feature, but then this work will
be repeated for all programs
that use <code class="filename">foo</code>. A better solution is to modify
<code class="filename">util/foo/Jamfile</code> in this way:
</p>
<pre class="programlisting">
project
: usage-requirements &lt;include&gt;.
;
lib foo : foo.cpp ;
</pre>
<p>
Usage requirements are applied not to the target being declared
but to its
dependents. In this case, <code class="literal">&lt;include&gt;.</code> will be applied to all
targets that directly depend on <code class="filename">foo</code>.
</p>
<p>Another improvement is using symbolic identifiers to refer to
the library, as opposed to <code class="filename">Jamfile</code> location.
In a large project, a library can be used by many targets, and if
they all use <code class="filename">Jamfile</code> location,
a change in directory organization entails much work.
The solution is to use project ids&#8212;symbolic names
not tied to directory layout. First, we need to assign a project id by
adding this code to
<code class="filename">Jamroot</code>:</p>
<pre class="programlisting">
use-project /library-example/foo : util/foo ;
</pre>
<p>Second, we modify <code class="filename">app/Jamfile</code> to use the
project id:
</p>
<pre class="programlisting">
exe app : app.cpp /library-example/foo//bar ;
</pre>
<p>
The <code class="filename">/library-example/foo//bar</code> syntax is used
to refer to the target <code class="filename">bar</code> in
the project with id <code class="filename">/library-example/foo</code>.
We've achieved our goal&#8212;if the library is moved to a different
directory, only <code class="filename">Jamroot</code> must be modified.
Note that project ids are global&#8212;two Jamfiles are not
allowed to assign the same project id to different directories.
</p>
<div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Tip</h3>
<p>If you want all applications in some project to link
to a certain library, you can avoid having to specify it directly the sources of every
target by using the
<code class="varname">&lt;source&gt;</code> property. For example, if <code class="filename">/boost/filesystem//fs</code>
should be linked to all applications in your project, you can add
<code class="computeroutput">&lt;source&gt;/boost/filesystem//fs</code> to the project's requirements, like this:</p>
<pre class="programlisting">
project
: requirements &lt;source&gt;/boost/filesystem//fs
;
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="hierarchy.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="linkage.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

149
doc/html/bbv2/tutorial/linkage.html Normal file
View file

@ -0,0 +1,149 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Static and shared libaries</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../tutorial.html" title="Chapter 23. Tutorial">
<link rel="prev" href="libs.html" title="Dependent Targets">
<link rel="next" href="conditions.html" title="Conditions and alternatives">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="libs.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="conditions.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.tutorial.linkage"></a>Static and shared libaries</h2></div></div></div>
<p>Libraries can be either
<span class="emphasis"><em>static</em></span>, which means they are included in executable
files that use them, or <span class="emphasis"><em>shared</em></span> (a.k.a.
<span class="emphasis"><em>dynamic</em></span>), which are only referred to from executables,
and must be available at run time. Boost.Build can create and use both kinds.
</p>
<p>The kind of library produced from a <code class="computeroutput">lib</code> target is
determined by the value of the <code class="varname">link</code> feature. Default
value is <code class="literal">shared</code>, and to build static library, the value
should be <code class="literal">static</code>. You can either requiest static build
on the command line:
</p>
<pre class="screen">
bjam link=static
</pre>
<p>
or in the library's requirements:
</p>
<pre class="programlisting">
lib l : l.cpp : &lt;link&gt;static ;
</pre>
<p>
We can also use the <code class="varname">&lt;link&gt;</code> property
to express linking requirements on a per-target basis.
For example, if a particular executable can be correctly built
only with the static version of a library, we can qualify the
executable's <a href="../reference/definitions.html#bbv2.reference.targets.references">target
reference</a> to the library as follows:
</p>
<pre class="programlisting">
exe important : main.cpp helpers/&lt;link&gt;static ;</pre>
<p>
No matter what arguments are specified on the <span><strong class="command">bjam</strong></span>
command-line, <code class="filename">important</code> will only be linked with
the static version of <code class="filename">helpers</code>.
</p>
<p>
Specifying properties in target references is especially useful if you
use a library defined in some other project (one you can't
change) but you still want static (or dynamic) linking to that library
in all cases. If that library is used by many targets,
you <span class="emphasis"><em>could</em></span> use target references
everywhere:
</p>
<pre class="programlisting">
exe e1 : e1.cpp /other_project//bar/&lt;link&gt;static ;
exe e10 : e10.cpp /other_project//bar/&lt;link&gt;static ;</pre>
<p>
but that's far from being convenient. A better approach is
to introduce a level of indirection. Create a local
<span class="type">alias</span> target that refers to the static (or
dynamic) version of <code class="filename">foo</code>:
</p>
<pre class="programlisting">
alias foo : /other_project//bar/&lt;link&gt;static ;
exe e1 : e1.cpp foo ;
exe e10 : e10.cpp foo ;</pre>
<p>
The <a href="../advanced/builtins/targets.html#bbv2.builtins.alias" title="Alias"><code class="computeroutput">alias</code></a>
rule is specifically used to rename a reference to a target and possibly
change the properties.
</p>
<div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Tip</h3>
<p>
When one library uses another, you put the second library is
the source list of the first. For example:
</p>
<pre class="programlisting">
lib utils : utils.cpp /boost/filesystem//fs ;
lib core : core.cpp utils ;
exe app : app.cpp core ;</pre>
<p>
This works no matter what kind of linking is used. When
<code class="filename">core</code> is built as a shared library, it is linked
directly into <code class="filename">utils</code>. Static libraries can't
link to other libraries, so when <code class="filename">core</code> is built
as a static library, its dependency on <code class="filename">utils</code> is passed along to
<code class="filename">core</code>'s dependents, causing
<code class="filename">app</code> to be linked with both
<code class="filename">core</code> and <code class="filename">utils</code>."
</p>
</div>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>(Note for non-UNIX system). Typically, shared libraries must be
installed to a directory in the dynamic linker's search
path. Otherwise, applications that use shared libraries can't be
started. On Windows, the dynamic linker's search path is given by the
<code class="envar">PATH</code> environment variable. This restriction is lifted
when you use Boost.Build testing facilities&#8212;the
<code class="envar">PATH</code> variable will be automatically adjusted before
running executable.
</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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="libs.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="conditions.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

124
doc/html/bbv2/tutorial/prebuilt.html Normal file
View file

@ -0,0 +1,124 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Prebuilt targets</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../tutorial.html" title="Chapter 23. Tutorial">
<link rel="prev" href="conditions.html" title="Conditions and alternatives">
<link rel="next" href="../advanced.html" title="Chapter 24. User documentation">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="conditions.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../advanced.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.tutorial.prebuilt"></a>Prebuilt targets</h2></div></div></div>
<p>
To link to libraries whose build instructions aren't given in a Jamfile,
you need to create <code class="computeroutput">lib</code> targets with an appropriate
<code class="varname">file</code> property. Target alternatives can be used to
associate multiple library files with a single conceptual target. For
example:
</p>
<pre class="programlisting">
# util/lib2/Jamfile
lib lib2
:
: &lt;file&gt;lib2_release.a &lt;variant&gt;release
;
lib lib2
:
: &lt;file&gt;lib2_debug.a &lt;variant&gt;debug
;
</pre>
<p>
This example defines two alternatives for <code class="filename">lib2</code>, and
for each one names a prebuilt file. Naturally, there are no sources.
Instead, the <code class="varname">&lt;file&gt;</code> feature is used to specify
the file name.
</p>
<p>
Once a prebuilt target has been declared, it can be used just like any other target:
</p>
<pre class="programlisting">
exe app : app.cpp ../util/lib2//lib2 ;
</pre>
<p>
As with any target, the alternative selected depends on the
properties propagated from <code class="filename">lib2</code>'s dependents.
If we build the the release and debug versions of <code class="filename">app</code> will be linked
with <code class="filename">lib2_release.a</code> and <code class="filename">lib2_debug.a</code>, respectively.
</p>
<p>
System libraries&#8212;those that are automatically found by
the toolset by searching through some set of predetermined
paths&#8212;should be declared almost like regular ones:
</p>
<pre class="programlisting">
lib pythonlib : : &lt;name&gt;python22 ;
</pre>
<p>
We again don't specify any sources, but give a
<code class="varname">name</code> that should be passed to the
compiler. If the gcc toolset were used to link an executable
target to <code class="filename">pythonlib</code>, <code class="option">-lpython22</code>
would appear in the command line (other compilers may use
different options).
</p>
<p>
We can also specify where the toolset should look for the library:
</p>
<pre class="programlisting">
lib pythonlib : : &lt;name&gt;python22 &lt;search&gt;/opt/lib ;
</pre>
<p>
And, of course, target alternatives can be used in the usual way:
</p>
<pre class="programlisting">
lib pythonlib : : &lt;name&gt;python22 &lt;variant&gt;release ;
lib pythonlib : : &lt;name&gt;python22_d &lt;variant&gt;debug ;
</pre>
<p>A more advanced use of prebuilt targets is described in <a href="../recipies/site-config.html" title="Targets in site-config.jam">the section called &#8220;Targets in site-config.jam&#8221;</a>.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="conditions.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../advanced.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

173
doc/html/bbv2/tutorial/properties.html Normal file
View file

@ -0,0 +1,173 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Properties</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<style type="text/css">
body { background-image: url('http://docbook.sourceforge.net/release/images/draft.png');
background-repeat: no-repeat;
background-position: top left;
/* The following properties make the watermark "fixed" on the page. */
/* I think that's just a bit too distracting for the reader... */
/* background-attachment: fixed; */
/* background-position: center center; */
}</style>
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../tutorial.html" title="Chapter 23. Tutorial">
<link rel="prev" href="../tutorial.html" title="Chapter 23. Tutorial">
<link rel="next" href="hierarchy.html" title="Project Hierarchies">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../tutorial.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="hierarchy.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bbv2.tutorial.properties"></a>Properties</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="properties.html#bbv2.tutorial.properties.requirements">Build Requests and Target Requirements</a></span></dt>
<dt><span class="section"><a href="properties.html#bbv2.tutorial.properties.project_attributes">Project Attributes</a></span></dt>
</dl></div>
<p>
To portably represent aspects of target configuration such as
debug and release variants, or single- and multi-threaded
builds, Boost.Build uses <em class="firstterm">features</em> with
associated <em class="firstterm">values</em>. For
example, the <code class="computeroutput">debug-symbols</code> feature can have a value of <code class="computeroutput">on</code> or
<code class="computeroutput">off</code>. A <em class="firstterm">property</em> is just a (feature,
value) pair. When a user initiates a build, Boost.Build
automatically translates the requested properties into appropriate
command-line flags for invoking toolset components like compilers
and linkers.</p>
<p>There are many built-in features that can be combined to
produce arbitrary build configurations. The following command
builds the project's <code class="computeroutput">release</code> variant with inlining
disabled and debug symbols enabled:
</p>
<pre class="screen">
bjam release inlining=off debug-symbols=on
</pre>
<p>Properties on the command-line are specified with the syntax:
</p>
<pre class="screen"><em class="replaceable"><code>feature-name</code></em>=<em class="replaceable"><code>feature-value</code></em></pre>
<p>The <code class="option">release</code> and <code class="option">debug</code> that we've seen
in <span><strong class="command">bjam</strong></span> invocations are just a shorthand way to
specify values of the <code class="varname">variant</code> feature. For example, the command
above could also have been written this way:
</p>
<pre class="screen">
bjam variant=release inlining=off debug-symbols=on
</pre>
<p><code class="varname">variant</code> is so commonly-used that it has
been given special status as an <em class="firstterm">implicit</em>
feature&#8212;Boost.Build will deduce the its identity just
from the name of one of its values.
</p>
<p>
A complete description of features can be found in <a href="../reference/definitions.html#bbv2.reference.features" title="Features and properties">the section called &#8220;Features and properties&#8221;</a>.
</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.tutorial.properties.requirements"></a>Build Requests and Target Requirements</h3></div></div></div>
<p>
The set of properties specified on the command line constitute
a <em class="firstterm">build request</em>&#8212;a description of
the desired properties for building the requested targets (or,
if no targets were explicitly requested, the project in the
current directory). The <span class="emphasis"><em>actual</em></span>
properties used for building targets are typically a
combination of the build request and properties derived from
the project's <code class="filename">Jamroot</code> (and its other
Jamfiles, as described in <a href="hierarchy.html" title="Project Hierarchies">the section called &#8220;Project Hierarchies&#8221;</a>). For example, the
locations of <code class="computeroutput">#include</code>d header files are normally
not specified on the command-line, but described in
Jamfiles as <em class="firstterm">target
requirements</em> and automatically combined with the
build request for those targets. Multithread-enabled
compilation is another example of a typical target
requirement. The Jamfile fragment below
illustrates how these requirements might be specified.
</p>
<pre class="programlisting">
exe hello
: hello.cpp
: &lt;include&gt;boost &lt;threading&gt;multi
;
</pre>
<p>
When <code class="filename">hello</code> is built, the two
requirements specified above will always be present.
If the build request given on the <span><strong class="command">bjam</strong></span>
command-line explictly contradicts a target's requirements,
the target requirements usually override (or, in the case of
&#8220;free&#8221; features like
<code class="varname">&lt;include&gt;</code>,
<sup>[<a name="id1701753" href="#ftn.id1701753">4</a>]</sup>
augments) the build request.
</p>
<div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Tip</h3>
<p>The value of the <code class="varname">&lt;include&gt;</code> feature is
relative to the location of <code class="filename">Jamroot</code> where it's
used.
</p>
</div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="bbv2.tutorial.properties.project_attributes"></a>Project Attributes</h3></div></div></div>
<p>
If we want the same requirements for our other
target, <code class="filename">hello2</code>, we could simply duplicate
them. However, as projects grow, that approach leads to a great
deal of repeated boilerplate in Jamfiles.
Fortunately, there's a better way. Each project can specify a
set of <em class="firstterm">attributes</em>, including
requirements:
</p>
<pre class="programlisting">
project
: requirements &lt;include&gt;/home/ghost/Work/boost &lt;threading&gt;multi
;
exe hello : hello.cpp ;
exe hello2 : hello.cpp ;
</pre>
<p>
The effect would be as if we specified the same requirement for
both <code class="filename">hello</code> and <code class="filename">hello2</code>.
</p>
</div>
<div class="footnotes">
<br><hr width="100" align="left">
<div class="footnote"><p><sup>[<a name="ftn.id1701753" href="#id1701753">4</a>] </sup>
See <a href="../reference/definitions.html#bbv2.reference.features.attributes" title="Feature Attributes">the section called &#8220;Feature Attributes&#8221;</a></p></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"><small></small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../tutorial.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorial.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="hierarchy.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

49
doc/html/bool_switch.html Normal file
View file

@ -0,0 +1,49 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Function bool_switch</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="program_options/reference.html#id857530" title="Header &lt;boost/program_options/value_semantic.hpp&gt;">
<link rel="prev" href="wvalue.html" title="Function wvalue">
<link rel="next" href="abstract_variables_map.html" title="Class abstract_variables_map">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="wvalue.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id857530"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="abstract_variables_map.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="bool_switch"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Function bool_switch</span></h2>
<p>boost::program_options::bool_switch &#8212; </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="type">BOOST_PROGRAM_OPTIONS_DECL <a href="typed_value.html" title="Class template typed_value">typed_value</a>&lt; <span class="bold"><strong>bool</strong></span> &gt; *</span> bool_switch();
<span class="type">BOOST_PROGRAM_OPTIONS_DECL <a href="typed_value.html" title="Class template typed_value">typed_value</a>&lt; <span class="bold"><strong>bool</strong></span> &gt; *</span> bool_switch(<span class="bold"><strong>bool</strong></span> * v);</pre></div>
<div class="refsect1" lang="en">
<a name="id1276862"></a><h2>Description</h2>
<p>Works the same way as the 'value' function, but the created value_semantic won't accept any explicit value. So, if the option is present on the command line, the value will be 'true'. </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"><small>Copyright © 2002-2004 Vladimir Prus</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="wvalue.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id857530"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="abstract_variables_map.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

186
doc/html/boost/any.html Normal file
View file

@ -0,0 +1,186 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class any</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../any/reference.html#header.boost.any.hpp" title="Header &lt;boost/any.hpp&gt;">
<link rel="prev" href="../bad_any_cast.html" title="Class bad_any_cast">
<link rel="next" href="../any_cast.html" title="Function any_cast">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../bad_any_cast.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../any/reference.html#header.boost.any.hpp"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../any_cast.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="boost.any"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class any</span></h2>
<p>boost::any &#8212; A class whose instances can hold instances of any
type that satisfies <a href="../any/reference.html#any.ValueType" title="ValueType requirements">ValueType</a>
requirements.</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="bold"><strong>class</strong></span> any {
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// <a href="any.html#boost.anyconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="any.html#id691864-bb">any</a>();
  <a href="any.html#id691852-bb">any</a>(<span class="bold"><strong>const</strong></span> <a href="any.html" title="Class any">any</a> &amp;);
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> ValueType&gt; <a href="any.html#id759379-bb">any</a>(<span class="bold"><strong>const</strong></span> ValueType &amp;);
  <span class="type"><a href="any.html" title="Class any">any</a> &amp;</span> <a href="any.html#id755290-bb"><span class="bold"><strong>operator</strong></span>=</a>(<span class="bold"><strong>const</strong></span> <a href="any.html" title="Class any">any</a> &amp;);
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> ValueType&gt; <span class="type"><a href="any.html" title="Class any">any</a> &amp;</span> <a href="any.html#id591278-bb"><span class="bold"><strong>operator</strong></span>=</a>(<span class="bold"><strong>const</strong></span> ValueType &amp;);
  <a href="any.html#id756388-bb">~any</a>();
  <span class="emphasis"><em>// <a href="any.html#id720717-bb">modifiers</a></em></span>
  <span class="type"><a href="any.html" title="Class any">any</a> &amp;</span> <a href="any.html#id722843-bb">swap</a>(<a href="any.html" title="Class any">any</a> &amp;);
  <span class="emphasis"><em>// <a href="any.html#id761589-bb">queries</a></em></span>
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="any.html#id761592-bb">empty</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>const</strong></span> std::type_info &amp;</span> <a href="any.html#id761615-bb">type</a>() <span class="bold"><strong>const</strong></span>;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id970852"></a><h2>Description</h2>
<div class="refsect2" lang="en">
<a name="id970855"></a><h3>
<a name="boost.anyconstruct-copy-destruct"></a><code class="computeroutput">any</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1">
<li>
<pre class="literallayout"><a name="id691864-bb"></a>any();</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Postconditions</span></b>:
<code class="computeroutput">this-&gt;<a href="any.html#id761592-bb">empty</a>()</code></p>
</li>
<li>
<pre class="literallayout"><a name="id691852-bb"></a>any(<span class="bold"><strong>const</strong></span> <a href="any.html" title="Class any">any</a> &amp; other);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
Copy constructor that copies content of
<code class="computeroutput">other</code> into new instance, so that any content
is equivalent in both type and value to the content of
<code class="computeroutput">other</code>, or empty if <code class="computeroutput">other</code> is
empty. <br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
May fail with a
<code class="computeroutput">std::bad_alloc</code>
exception or any exceptions arising from the copy
constructor of the contained type.</p>
</li>
<li>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> ValueType&gt; <a name="id759379-bb"></a>any(<span class="bold"><strong>const</strong></span> ValueType &amp; value);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
Makes a copy of <code class="computeroutput">value</code>, so
that the initial content of the new instance is equivalent
in both type and value to
<code class="computeroutput">value</code>.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
<code class="computeroutput">std::bad_alloc</code>
or any exceptions arising from the copy constructor of the
contained type.</p>
</li>
<li>
<pre class="literallayout"><span class="type"><a href="any.html" title="Class any">any</a> &amp;</span> <a name="id755290-bb"></a><span class="bold"><strong>operator</strong></span>=(<span class="bold"><strong>const</strong></span> <a href="any.html" title="Class any">any</a> &amp; rhs);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
Copies content of <code class="computeroutput">rhs</code> into
current instance, discarding previous content, so that the
new content is equivalent in both type and value to the
content of <code class="computeroutput">rhs</code>, or empty if
<code class="computeroutput">rhs.<a href="any.html#id761592-bb">empty</a>()</code>.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
<code class="computeroutput">std::bad_alloc</code>
or any exceptions arising from the copy constructor of the
contained type. Assignment satisfies the strong guarantee
of exception safety.</p>
</li>
<li>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> ValueType&gt; <span class="type"><a href="any.html" title="Class any">any</a> &amp;</span> <a name="id591278-bb"></a><span class="bold"><strong>operator</strong></span>=(<span class="bold"><strong>const</strong></span> ValueType &amp; rhs);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
Makes a copy of <code class="computeroutput">rhs</code>,
discarding previous content, so that the new content of is
equivalent in both type and value to
<code class="computeroutput">rhs</code>.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
<code class="computeroutput">std::bad_alloc</code>
or any exceptions arising from the copy constructor of the
contained type. Assignment satisfies the strong guarantee
of exception safety.</p>
</li>
<li>
<pre class="literallayout"><a name="id756388-bb"></a>~any();</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
Releases any and all resources used in
management of instance.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Nothing.</p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id971249"></a><h3>
<a name="id720717-bb"></a><code class="computeroutput">any</code> modifiers</h3>
<div class="orderedlist"><ol type="1"><li>
<pre class="literallayout"><span class="type"><a href="any.html" title="Class any">any</a> &amp;</span> <a name="id722843-bb"></a>swap(<a href="any.html" title="Class any">any</a> &amp; rhs);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
Exchange of the contents of
<code class="computeroutput">*this</code> and
<code class="computeroutput">rhs</code>.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<code class="computeroutput">*this</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Nothing.</p>
</li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id971335"></a><h3>
<a name="id761589-bb"></a><code class="computeroutput">any</code> queries</h3>
<div class="orderedlist"><ol type="1">
<li>
<pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id761592-bb"></a>empty() <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<code class="computeroutput">true</code> if instance is
empty, otherwise <code class="computeroutput">false</code>.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Will not throw.</p>
</li>
<li>
<pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> std::type_info &amp;</span> <a name="id761615-bb"></a>type() <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
the <code class="computeroutput">typeid</code> of the
contained value if instance is non-empty, otherwise
<code class="computeroutput">typeid(void)</code>.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Notes</span></b>:
Useful for querying against types known
either at compile time or only at
runtime.</p>
</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"><small>Copyright © 2001 Kevlin Henney</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../bad_any_cast.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../any/reference.html#header.boost.any.hpp"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../any_cast.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

351
doc/html/boost/array.html Normal file
View file

@ -0,0 +1,351 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class template array</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../array/reference.html#header.boost.array.hpp" title="Header &lt;boost/array.hpp&gt;">
<link rel="prev" href="../array/reference.html" title="Reference">
<link rel="next" href="../array/rationale.html" title="Design Rationale">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../array/reference.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../array/reference.html#header.boost.array.hpp"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../array/rationale.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="boost.array"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template array</span></h2>
<p>boost::array &#8212; <p>STL compliant container wrapper for arrays of constant size</p></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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
<span class="bold"><strong>class</strong></span> array {
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// types</em></span>
  <span class="bold"><strong>typedef</strong></span> T                                     value_type;            
  <span class="bold"><strong>typedef</strong></span> T*                                    iterator;              
  <span class="bold"><strong>typedef</strong></span> <span class="bold"><strong>const</strong></span> T*                              const_iterator;        
  <span class="bold"><strong>typedef</strong></span> std::reverse_iterator&lt;iterator&gt;       reverse_iterator;      
  <span class="bold"><strong>typedef</strong></span> std::reverse_iterator&lt;const_iterator&gt; const_reverse_iterator;
  <span class="bold"><strong>typedef</strong></span> T&amp;                                    reference;             
  <span class="bold"><strong>typedef</strong></span> <span class="bold"><strong>const</strong></span> T&amp;                              const_reference;       
  <span class="bold"><strong>typedef</strong></span> std::size_t                           size_type;             
  <span class="bold"><strong>typedef</strong></span> std::ptrdiff_t                        difference_type;       
  <span class="emphasis"><em>// static constants</em></span>
  <span class="bold"><strong>static</strong></span> <span class="bold"><strong>const</strong></span> size_type static_size = N;
  <span class="emphasis"><em>// <a href="array.html#boost.arrayconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> U&gt; array&amp; <a href="array.html#id697625-bb"><span class="bold"><strong>operator</strong></span>=</a>(<span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;U, N&gt;&amp;);
  <span class="emphasis"><em>// <a href="array.html#id689734-bb">iterator support</a></em></span>
  <span class="type">iterator</span> <a href="array.html#id725473-bb">begin</a>();
  <span class="type">const_iterator</span> <a href="array.html#id656084-bb">begin</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">iterator</span> <a href="array.html#id684939-bb">end</a>();
  <span class="type">const_iterator</span> <a href="array.html#id721093-bb">end</a>() <span class="bold"><strong>const</strong></span>;
  <span class="emphasis"><em>// <a href="array.html#id661089-bb">reverse iterator support</a></em></span>
  <span class="type">reverse_iterator</span> <a href="array.html#id733347-bb">rbegin</a>();
  <span class="type">const_reverse_iterator</span> <a href="array.html#id759984-bb">rbegin</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">reverse_iterator</span> <a href="array.html#id728793-bb">rend</a>();
  <span class="type">const_reverse_iterator</span> <a href="array.html#id692037-bb">rend</a>() <span class="bold"><strong>const</strong></span>;
  <span class="emphasis"><em>// <a href="array.html#id727882-bb">capacity</a></em></span>
  <span class="type">size_type</span> <a href="array.html#id686133-bb">size</a>();
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="array.html#id751779-bb">empty</a>();
  <span class="type">size_type</span> <a href="array.html#id686623-bb">max_size</a>();
  <span class="emphasis"><em>// <a href="array.html#id379518-bb">element access</a></em></span>
  <span class="type">reference</span> <a href="array.html#id686789-bb"><span class="bold"><strong>operator</strong></span>[]</a>(size_type);
  <span class="type">const_reference</span> <a href="array.html#id752140-bb"><span class="bold"><strong>operator</strong></span>[]</a>(size_type) <span class="bold"><strong>const</strong></span>;
  <span class="type">reference</span> <a href="array.html#id689442-bb">at</a>(size_type);
  <span class="type">const_reference</span> <a href="array.html#id682666-bb">at</a>(size_type) <span class="bold"><strong>const</strong></span>;
  <span class="type">reference</span> <a href="array.html#id763244-bb">front</a>();
  <span class="type">const_reference</span> <a href="array.html#id763251-bb">front</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">reference</span> <a href="array.html#id763276-bb">back</a>();
  <span class="type">const_reference</span> <a href="array.html#id763283-bb">back</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>const</strong></span> T*</span> <a href="array.html#id763305-bb">data</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">T*</span> <a href="array.html#id763323-bb">c_array</a>();
  <span class="emphasis"><em>// <a href="array.html#id763341-bb">modifiers</a></em></span>
  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="array.html#id763345-bb">swap</a>(<a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;);
  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="array.html#id763383-bb">assign</a>(<span class="bold"><strong>const</strong></span> T&amp;);
  T elems[N];
};
<span class="emphasis"><em>// <a href="array.html#id763417-bb">specialized algorithms</a></em></span>
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt; <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="array.html#id763420">swap</a>(<a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;, <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;);
<span class="emphasis"><em>// <a href="array.html#id763475-bb">comparisons</a></em></span>
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="array.html#id763478"><span class="bold"><strong>operator</strong></span>==</a>(<span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;, <span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="array.html#id763537"><span class="bold"><strong>operator</strong></span>!=</a>(<span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;, <span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="array.html#id763586"><span class="bold"><strong>operator</strong></span>&lt;</a>(<span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;, <span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="array.html#id763648"><span class="bold"><strong>operator</strong></span>&gt;</a>(<span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;, <span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="array.html#id763696"><span class="bold"><strong>operator</strong></span>&lt;=</a>(<span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;, <span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="array.html#id763744"><span class="bold"><strong>operator</strong></span>&gt;=</a>(<span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;, <span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp;);</pre></div>
<div class="refsect1" lang="en">
<a name="id973340"></a><h2>Description</h2>
<div class="refsect2" lang="en">
<a name="id973343"></a><h3>
<a name="boost.arrayconstruct-copy-destruct"></a><code class="computeroutput">array</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1"><li>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> U&gt; array&amp; <a name="id697625-bb"></a><span class="bold"><strong>operator</strong></span>=(<span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;U, N&gt;&amp; other);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
<code class="computeroutput">std::copy(rhs.<a href="array.html#id685681-bb">begin</a>(),rhs.<a href="array.html#id732428-bb">end</a>(), <a href="array.html#id685681-bb">begin</a>())</code></p>
</li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id973441"></a><h3>
<a name="id689734-bb"></a><code class="computeroutput">array</code> iterator support</h3>
<div class="orderedlist"><ol type="1">
<li>
<p><a name="id685681-bb"></a></p>
<pre class="literallayout"><span class="type">iterator</span> <a name="id725473-bb"></a>begin();
<span class="type">const_iterator</span> <a name="id656084-bb"></a>begin() <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
iterator for the first element<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
will not throw</p>
</li>
<li>
<p><a name="id732428-bb"></a></p>
<pre class="literallayout"><span class="type">iterator</span> <a name="id684939-bb"></a>end();
<span class="type">const_iterator</span> <a name="id721093-bb"></a>end() <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
iterator for position after the last element<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
will not throw</p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id973564"></a><h3>
<a name="id661089-bb"></a><code class="computeroutput">array</code> reverse iterator support</h3>
<div class="orderedlist"><ol type="1">
<li>
<p><a name="id727479-bb"></a></p>
<pre class="literallayout"><span class="type">reverse_iterator</span> <a name="id733347-bb"></a>rbegin();
<span class="type">const_reverse_iterator</span> <a name="id759984-bb"></a>rbegin() <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
reverse iterator for the first element of reverse iteration</p>
</li>
<li>
<p><a name="id662500-bb"></a></p>
<pre class="literallayout"><span class="type">reverse_iterator</span> <a name="id728793-bb"></a>rend();
<span class="type">const_reverse_iterator</span> <a name="id692037-bb"></a>rend() <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
reverse iterator for position after the last element in reverse iteration</p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id973674"></a><h3>
<a name="id727882-bb"></a><code class="computeroutput">array</code> capacity</h3>
<div class="orderedlist"><ol type="1">
<li>
<pre class="literallayout"><span class="type">size_type</span> <a name="id686133-bb"></a>size();</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<code class="computeroutput">N</code></p>
</li>
<li>
<pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id751779-bb"></a>empty();</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<code class="computeroutput">N==0</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
will not throw</p>
</li>
<li>
<pre class="literallayout"><span class="type">size_type</span> <a name="id686623-bb"></a>max_size();</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<code class="computeroutput">N</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
will not throw</p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id973798"></a><h3>
<a name="id379518-bb"></a><code class="computeroutput">array</code> element access</h3>
<div class="orderedlist"><ol type="1">
<li>
<p><a name="id685146-bb"></a></p>
<pre class="literallayout"><span class="type">reference</span> <a name="id686789-bb"></a><span class="bold"><strong>operator</strong></span>[](size_type i);
<span class="type">const_reference</span> <a name="id752140-bb"></a><span class="bold"><strong>operator</strong></span>[](size_type i) <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Requires</span></b>:
<code class="computeroutput">i &lt; N</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
element with index <code class="computeroutput">i</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
will not throw.</p>
</li>
<li>
<p><a name="id726524-bb"></a></p>
<pre class="literallayout"><span class="type">reference</span> <a name="id689442-bb"></a>at(size_type i);
<span class="type">const_reference</span> <a name="id682666-bb"></a>at(size_type i) <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
element with index <code class="computeroutput">i</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
<code class="computeroutput">std::range_error</code> if <code class="computeroutput">i &gt;= N</code></p>
</li>
<li>
<p><a name="id763241-bb"></a></p>
<pre class="literallayout"><span class="type">reference</span> <a name="id763244-bb"></a>front();
<span class="type">const_reference</span> <a name="id763251-bb"></a>front() <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Requires</span></b>:
<code class="computeroutput">N &gt; 0</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
the first element<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
will not throw</p>
</li>
<li>
<p><a name="id763273-bb"></a></p>
<pre class="literallayout"><span class="type">reference</span> <a name="id763276-bb"></a>back();
<span class="type">const_reference</span> <a name="id763283-bb"></a>back() <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Requires</span></b>:
<code class="computeroutput">N &gt; 0</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
the last element<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
will not throw</p>
</li>
<li>
<pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> T*</span> <a name="id763305-bb"></a>data() <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<code class="computeroutput">elems</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
will not throw</p>
</li>
<li>
<pre class="literallayout"><span class="type">T*</span> <a name="id763323-bb"></a>c_array();</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<code class="computeroutput">elems</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
will not throw</p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id974166"></a><h3>
<a name="id763341-bb"></a><code class="computeroutput">array</code> modifiers</h3>
<div class="orderedlist"><ol type="1">
<li>
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id763345-bb"></a>swap(<a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp; other);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
<code class="computeroutput">std::swap_ranges(<a href="array.html#id685681-bb">begin</a>(), <a href="array.html#id732428-bb">end</a>(), other.<a href="array.html#id685681-bb">begin</a>())</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Complexity</span></b>:
linear in <code class="computeroutput">N</code></p>
</li>
<li>
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id763383-bb"></a>assign(<span class="bold"><strong>const</strong></span> T&amp; value);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
<code class="computeroutput">std::fill_n(<a href="array.html#id685681-bb">begin</a>(), N, value)</code></p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id974302"></a><h3>
<a name="id763417-bb"></a><code class="computeroutput">array</code> specialized algorithms</h3>
<div class="orderedlist"><ol type="1"><li>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt; <span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id763420"></a>swap(<a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp; x, <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp; y);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
<code class="computeroutput">x.<a href="array.html#id763345-bb">swap</a>(y)</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
will not throw.</p>
</li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id974394"></a><h3>
<a name="id763475-bb"></a><code class="computeroutput">array</code> comparisons</h3>
<div class="orderedlist"><ol type="1">
<li>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id763478"></a><span class="bold"><strong>operator</strong></span>==(<span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp; x, <span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp; y);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<code class="computeroutput">std::equal(x.<a href="array.html#id685681-bb">begin</a>(), x.<a href="array.html#id732428-bb">end</a>(), y.<a href="array.html#id685681-bb">begin</a>())</code></p>
</li>
<li>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id763537"></a><span class="bold"><strong>operator</strong></span>!=(<span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp; x, <span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp; y);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<code class="computeroutput">!(x == y)</code></p>
</li>
<li>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id763586"></a><span class="bold"><strong>operator</strong></span>&lt;(<span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp; x, <span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp; y);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<code class="computeroutput">std::lexicographical_compare(x.<a href="array.html#id685681-bb">begin</a>(), x.<a href="array.html#id732428-bb">end</a>(), y.<a href="array.html#id685681-bb">begin</a>(), y.<a href="array.html#id732428-bb">end</a>())</code></p>
</li>
<li>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id763648"></a><span class="bold"><strong>operator</strong></span>&gt;(<span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp; x, <span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp; y);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<code class="computeroutput">y &lt; x</code></p>
</li>
<li>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id763696"></a><span class="bold"><strong>operator</strong></span>&lt;=(<span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp; x, <span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp; y);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<code class="computeroutput">!(y &lt; x)</code></p>
</li>
<li>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, std::size_t N&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id763744"></a><span class="bold"><strong>operator</strong></span>&gt;=(<span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp; x, <span class="bold"><strong>const</strong></span> <a href="array.html" title="Class template array">array</a>&lt;T, N&gt;&amp; y);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<code class="computeroutput">!(x &lt; y)</code></p>
</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"><small>Copyright © 2001-2004 Nicolai M. Josuttis</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../array/reference.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../array/reference.html#header.boost.array.hpp"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../array/rationale.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

137
doc/html/boost/date_time/date.html Normal file
View file

@ -0,0 +1,137 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class template date</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../../date_time/doxy.html#id823767" title="Header &lt;boost/date_time/date.hpp&gt;">
<link rel="prev" href="../../simple_exception_policy.html" title="Class template simple_exception_policy">
<link rel="next" href="../../day_clock.html" title="Class template day_clock">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../simple_exception_policy.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#id823767"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../day_clock.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="boost.date_time.date"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template date</span></h2>
<p>boost::date_time::date &#8212; Representation of timepoint at the one day level resolution. </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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, <span class="bold"><strong>typename</strong></span> calendar, <span class="bold"><strong>typename</strong></span> duration_type_&gt;
<span class="bold"><strong>class</strong></span> date {
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// types</em></span>
  <span class="bold"><strong>typedef</strong></span> T                          date_type;       
  <span class="bold"><strong>typedef</strong></span> calendar                   calendar_type;   
  <span class="bold"><strong>typedef</strong></span> calendar::date_traits_type traits_type;     
  <span class="bold"><strong>typedef</strong></span> duration_type_             duration_type;   
  <span class="bold"><strong>typedef</strong></span> calendar::year_type        year_type;       
  <span class="bold"><strong>typedef</strong></span> calendar::month_type       month_type;      
  <span class="bold"><strong>typedef</strong></span> calendar::day_type         day_type;        
  <span class="bold"><strong>typedef</strong></span> calendar::ymd_type         ymd_type;        
  <span class="bold"><strong>typedef</strong></span> calendar::date_rep_type    date_rep_type;   
  <span class="bold"><strong>typedef</strong></span> calendar::date_int_type    date_int_type;   
  <span class="bold"><strong>typedef</strong></span> calendar::day_of_week_type day_of_week_type;
  <span class="emphasis"><em>// <a href="date.html#boost.date_time.dateconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="date.html#id802112-bb">date</a>(year_type, month_type, day_type);
  <a href="date.html#id800062-bb">date</a>(<span class="bold"><strong>const</strong></span> ymd_type &amp;);
  <a href="date.html#id824446-bb">date</a>(date_int_type);
  <a href="date.html#id1047138-bb">date</a>(date_rep_type);
  <span class="emphasis"><em>// <a href="date.html#id798032-bb">public member functions</a></em></span>
  <span class="type">year_type</span> <a href="date.html#id906201-bb">year</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">month_type</span> <a href="date.html#id872745-bb">month</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">day_type</span> <a href="date.html#id860779-bb">day</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">day_of_week_type</span> <a href="date.html#id908468-bb">day_of_week</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">ymd_type</span> <a href="date.html#id825616-bb">year_month_day</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="date.html#id697902-bb"><span class="bold"><strong>operator</strong></span>&lt;</a>(<span class="bold"><strong>const</strong></span> date_type &amp;) <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="date.html#id865087-bb"><span class="bold"><strong>operator</strong></span>==</a>(<span class="bold"><strong>const</strong></span> date_type &amp;) <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="date.html#id939432-bb">is_special</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="date.html#id834537-bb">is_not_a_date</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="date.html#id1070079-bb">is_infinity</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="date.html#id833077-bb">is_pos_infinity</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="date.html#id801744-bb">is_neg_infinity</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">special_values</span> <a href="date.html#id822819-bb">as_special</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">duration_type</span> <a href="date.html#id827653-bb"><span class="bold"><strong>operator</strong></span>-</a>(<span class="bold"><strong>const</strong></span> date_type &amp;) <span class="bold"><strong>const</strong></span>;
  <span class="type">date_type</span> <a href="date.html#id831065-bb"><span class="bold"><strong>operator</strong></span>-</a>(<span class="bold"><strong>const</strong></span> duration_type &amp;) <span class="bold"><strong>const</strong></span>;
  <span class="type">date_type</span> <a href="date.html#id1080637-bb"><span class="bold"><strong>operator</strong></span>-=</a>(<span class="bold"><strong>const</strong></span> duration_type &amp;) ;
  <span class="type">date_rep_type</span> <a href="date.html#id1104862-bb">day_count</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">date_type</span> <a href="date.html#id863577-bb"><span class="bold"><strong>operator</strong></span>+</a>(<span class="bold"><strong>const</strong></span> duration_type &amp;) <span class="bold"><strong>const</strong></span>;
  <span class="type">date_type</span> <a href="date.html#id1102041-bb"><span class="bold"><strong>operator</strong></span>+=</a>(<span class="bold"><strong>const</strong></span> duration_type &amp;) ;
  <span class="emphasis"><em>// <a href="date.html#id824441-bb">protected member functions</a></em></span>
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1041062"></a><h2>Description</h2>
<p>The date template represents an interface shell for a date class that is based on a year-month-day system such as the gregorian or iso systems. It provides basic operations to enable calculation and comparisons.</p>
<p><span class="bold"><strong>Theory</strong></span></p>
<p>This date representation fundamentally departs from the C tm struct approach. The goal for this type is to provide efficient date operations (add, subtract) and storage (minimize space to represent) in a concrete class. Thus, the date uses a count internally to represent a particular date. The calendar parameter defines the policies for converting the the year-month-day and internal counted form here. Applications that need to perform heavy formatting of the same date repeatedly will perform better by using the year-month-day representation.</p>
<p>Internally the date uses a day number to represent the date. This is a monotonic time representation. This representation allows for fast comparison as well as simplifying the creation of writing numeric operations. Essentially, the internal day number is like adjusted julian day. The adjustment is determined by the Epoch date which is represented as day 1 of the calendar. Day 0 is reserved for negative infinity so that any actual date is automatically greater than negative infinity. When a date is constructed from a date or formatted for output, the appropriate conversions are applied to create the year, month, day representations. </p>
<div class="refsect2" lang="en">
<a name="id1041081"></a><h3>
<a name="boost.date_time.dateconstruct-copy-destruct"></a><code class="computeroutput">date</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><a name="id802112-bb"></a>date(year_type y, month_type m, day_type d);</pre></li>
<li><pre class="literallayout"><a name="id800062-bb"></a>date(<span class="bold"><strong>const</strong></span> ymd_type &amp; ymd);</pre></li>
<li>
<pre class="literallayout"><a name="id824446-bb"></a>date(date_int_type days);</pre>
<p>This is a private constructor which allows for the creation of new dates. It is not exposed to users since that would require class users to understand the inner workings of the date class. </p>
</li>
<li><pre class="literallayout"><a name="id1047138-bb"></a>date(date_rep_type days);</pre></li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1041167"></a><h3>
<a name="id798032-bb"></a><code class="computeroutput">date</code> public member functions</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><span class="type">year_type</span> <a name="id906201-bb"></a>year() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">month_type</span> <a name="id872745-bb"></a>month() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">day_type</span> <a name="id860779-bb"></a>day() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">day_of_week_type</span> <a name="id908468-bb"></a>day_of_week() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">ymd_type</span> <a name="id825616-bb"></a>year_month_day() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id697902-bb"></a><span class="bold"><strong>operator</strong></span>&lt;(<span class="bold"><strong>const</strong></span> date_type &amp; rhs) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id865087-bb"></a><span class="bold"><strong>operator</strong></span>==(<span class="bold"><strong>const</strong></span> date_type &amp; rhs) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id939432-bb"></a>is_special() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id834537-bb"></a>is_not_a_date() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id1070079-bb"></a>is_infinity() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id833077-bb"></a>is_pos_infinity() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id801744-bb"></a>is_neg_infinity() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">special_values</span> <a name="id822819-bb"></a>as_special() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">duration_type</span> <a name="id827653-bb"></a><span class="bold"><strong>operator</strong></span>-(<span class="bold"><strong>const</strong></span> date_type &amp; d) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">date_type</span> <a name="id831065-bb"></a><span class="bold"><strong>operator</strong></span>-(<span class="bold"><strong>const</strong></span> duration_type &amp; dd) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">date_type</span> <a name="id1080637-bb"></a><span class="bold"><strong>operator</strong></span>-=(<span class="bold"><strong>const</strong></span> duration_type &amp; dd) ;</pre></li>
<li><pre class="literallayout"><span class="type">date_rep_type</span> <a name="id1104862-bb"></a>day_count() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">date_type</span> <a name="id863577-bb"></a><span class="bold"><strong>operator</strong></span>+(<span class="bold"><strong>const</strong></span> duration_type &amp; dd) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">date_type</span> <a name="id1102041-bb"></a><span class="bold"><strong>operator</strong></span>+=(<span class="bold"><strong>const</strong></span> duration_type &amp; dd) ;</pre></li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1041700"></a><h3>
<a name="id824441-bb"></a><code class="computeroutput">date</code> protected member functions</h3>
<div class="orderedlist"><ol type="1"></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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../simple_exception_policy.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#id823767"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../day_clock.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

402
doc/html/boost/function.html Normal file
View file

@ -0,0 +1,402 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class template function</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../function/reference.html#header.boost.function.hpp" title="Header &lt;boost/function.hpp&gt;">
<link rel="prev" href="../functionN.html" title="Class template functionN">
<link rel="next" href="../function_equal.html" title="Function template function_equal">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../functionN.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../function/reference.html#header.boost.function.hpp"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../function_equal.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="boost.function"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template function</span></h2>
<p>boost::function &#8212; A generalized function pointer that can be used for
callbacks or wrapping function objects.</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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="emphasis"><em> // Function type R (T1, T2, ..., TN)</em></span>
         <span class="bold"><strong>typename</strong></span> Allocator = std::allocator&lt;<span class="bold"><strong>void</strong></span>&gt; &gt;
<span class="bold"><strong>class</strong></span> function : <span class="bold"><strong>public</strong></span> <a href="../functionN.html" title="Class template functionN">functionN</a>&lt;R, T1, T2, ..., TN, Allocator&gt; {
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// types</em></span>
  <span class="bold"><strong>typedef</strong></span> R         result_type;         
  <span class="bold"><strong>typedef</strong></span> Allocator allocator_type;      
  <span class="bold"><strong>typedef</strong></span> T1        argument_type;        <span class="emphasis"><em>// If N == 1</em></span>
  <span class="bold"><strong>typedef</strong></span> T1        first_argument_type;  <span class="emphasis"><em>// If N == 2</em></span>
  <span class="bold"><strong>typedef</strong></span> T2        second_argument_type; <span class="emphasis"><em>// If N == 2</em></span>
  <span class="bold"><strong>typedef</strong></span> T1        arg1_type;           
  <span class="bold"><strong>typedef</strong></span> T2        arg2_type;           
     .
     .
     .
  <span class="bold"><strong>typedef</strong></span> TN        argN_type;           
  <span class="emphasis"><em>// static constants</em></span>
  <span class="bold"><strong>static</strong></span> <span class="bold"><strong>const</strong></span> <span class="bold"><strong>int</strong></span> arity = N;
  <span class="emphasis"><em>// <a href="../lambda.html" title="Chapter 6. Boost.Lambda">Lambda</a> library support</em></span>
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Args&gt;
  <span class="bold"><strong>struct</strong></span> sig {
    <span class="emphasis"><em>// types</em></span>
    <span class="bold"><strong>typedef</strong></span> result_type type;
  };
  <span class="emphasis"><em>// <a href="function.html#boost.functionconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="function.html#id1031759-bb">function</a>();
  <a href="function.html#id1046556-bb">function</a>(<span class="bold"><strong>const</strong></span> <a href="../functionN.html" title="Class template functionN">functionN</a>&amp;);
  <a href="function.html#id1070102-bb">function</a>(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&amp;);
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> F&gt; <a href="function.html#id835586-bb">function</a>(F);
  function&amp; <a href="function.html#id800435-bb"><span class="bold"><strong>operator</strong></span>=</a>(<span class="bold"><strong>const</strong></span> <a href="../functionN.html" title="Class template functionN">functionN</a>&amp;);
  function&amp; <a href="function.html#id1077825-bb"><span class="bold"><strong>operator</strong></span>=</a>(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&amp;);
  <a href="function.html#id870390-bb">~function</a>();
  <span class="emphasis"><em>// <a href="function.html#id1073652-bb">modifiers</a></em></span>
  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="function.html#id801534-bb">swap</a>(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&amp;);
  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="function.html#id903961-bb">clear</a>();
  <span class="emphasis"><em>// <a href="function.html#id1112252-bb">capacity</a></em></span>
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="function.html#id972567-bb">empty</a>() <span class="bold"><strong>const</strong></span>;
  <a href="function.html#id1106579-bb"><span class="bold"><strong>operator</strong></span> safe_bool</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="function.html#id1106977-bb"><span class="bold"><strong>operator</strong></span>!</a>() <span class="bold"><strong>const</strong></span>;
  <span class="emphasis"><em>// <a href="function.html#id970210-bb">target access</a></em></span>
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Functor&gt; <span class="type">Functor*</span> <a href="function.html#id1037337-bb">target</a>();
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Functor&gt; <span class="type"><span class="bold"><strong>const</strong></span> Functor*</span> <a href="function.html#id1003205-bb">target</a>() <span class="bold"><strong>const</strong></span>;
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Functor&gt; <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="function.html#id899187-bb">contains</a>(<span class="bold"><strong>const</strong></span> Functor&amp;) <span class="bold"><strong>const</strong></span>;
  <span class="emphasis"><em>// <a href="function.html#id1000460-bb">invocation</a></em></span>
  <span class="type">result_type</span> <a href="function.html#id966548-bb"><span class="bold"><strong>operator</strong></span>()</a>(arg1_type, arg2_type, ..., argN_type) <span class="bold"><strong>const</strong></span>;
};
<span class="emphasis"><em>// <a href="function.html#id996764-bb">specialized algorithms</a></em></span>
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator&gt;
  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="function.html#id999224">swap</a>(<a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp;, <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp;);
<span class="emphasis"><em>// <a href="function.html#id894643-bb">comparison operators</a></em></span>
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator, <span class="bold"><strong>typename</strong></span> Functor&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="function.html#id1012910-bb"><span class="bold"><strong>operator</strong></span>==</a>(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp;, Functor);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator, <span class="bold"><strong>typename</strong></span> Functor&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="function.html#id827744-bb"><span class="bold"><strong>operator</strong></span>==</a>(Functor, <span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp;);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator, <span class="bold"><strong>typename</strong></span> Functor&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="function.html#id937738-bb"><span class="bold"><strong>operator</strong></span>==</a>(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp;,
                  <a href="../reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a>&lt;Functor&gt;);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator, <span class="bold"><strong>typename</strong></span> Functor&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="function.html#id1107517-bb"><span class="bold"><strong>operator</strong></span>==</a>(<a href="../reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a>&lt;Functor&gt;,
                  <span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp;);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature1, <span class="bold"><strong>typename</strong></span> Allocator1, <span class="bold"><strong>typename</strong></span> Signature2,
         <span class="bold"><strong>typename</strong></span> Allocator2&gt;
  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="function.html#id835486-bb"><span class="bold"><strong>operator</strong></span>==</a>(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature1, Allocator1&gt;&amp;,
                  <span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature2, Allocator2&gt;&amp;);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator, <span class="bold"><strong>typename</strong></span> Functor&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="function.html#id834162-bb"><span class="bold"><strong>operator</strong></span>!=</a>(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp;, Functor);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator, <span class="bold"><strong>typename</strong></span> Functor&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="function.html#id961954-bb"><span class="bold"><strong>operator</strong></span>!=</a>(Functor, <span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp;);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator, <span class="bold"><strong>typename</strong></span> Functor&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="function.html#id867993-bb"><span class="bold"><strong>operator</strong></span>!=</a>(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp;,
                  <a href="../reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a>&lt;Functor&gt;);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator, <span class="bold"><strong>typename</strong></span> Functor&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="function.html#id1066866-bb"><span class="bold"><strong>operator</strong></span>!=</a>(<a href="../reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a>&lt;Functor&gt;,
                  <span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp;);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature1, <span class="bold"><strong>typename</strong></span> Allocator1, <span class="bold"><strong>typename</strong></span> Signature2,
         <span class="bold"><strong>typename</strong></span> Allocator2&gt;
  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="function.html#id966586-bb"><span class="bold"><strong>operator</strong></span>!=</a>(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature1, Allocator1&gt;&amp;,
                  <span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature2, Allocator2&gt;&amp;);</pre></div>
<div class="refsect1" lang="en">
<a name="id1212219"></a><h2>Description</h2>
<p>Class template <a href="function.html" title="Class template function">function</a> is a thin
wrapper around the numbered class templates <a href="../functionN.html" title="Class template functionN">function0</a>, <a href="../functionN.html" title="Class template functionN">function1</a>, etc. It accepts a
function type with N arguments and will will derive from
<a href="../functionN.html" title="Class template functionN">functionN</a> instantiated with the arguments
it receives.</p>
<p>The semantics of all operations in class template
<a href="function.html" title="Class template function">function</a> are equivalent to that of the
underlying <a href="../functionN.html" title="Class template functionN">functionN</a> object, although
additional member functions are required to allow proper copy
construction and copy assignment of function objects.</p>
<div class="refsect2" lang="en">
<a name="id1212276"></a><h3>
<a name="boost.functionconstruct-copy-destruct"></a><code class="computeroutput">function</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1">
<li>
<pre class="literallayout"><a name="id1031759-bb"></a>function();</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Postconditions</span></b>:
<code class="computeroutput">this-&gt;<a href="function.html#id972567-bb">empty</a>()</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Will not throw.</p>
</li>
<li>
<pre class="literallayout"><a name="id1046556-bb"></a>function(<span class="bold"><strong>const</strong></span> <a href="../functionN.html" title="Class template functionN">functionN</a>&amp; f);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Postconditions</span></b>:
Contains a copy of the <code class="computeroutput">f</code>'s target, if it has one, or is empty if <code class="computeroutput">f.<a href="function.html#id972567-bb">empty</a>()</code>.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Will not throw unless copying the target of <code class="computeroutput">f</code> throws.</p>
</li>
<li>
<pre class="literallayout"><a name="id1070102-bb"></a>function(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&amp; f);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Postconditions</span></b>:
Contains a copy of the <code class="computeroutput">f</code>'s target, if it has one, or is empty if <code class="computeroutput">f.<a href="function.html#id972567-bb">empty</a>()</code>.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Will not throw unless copying the target of <code class="computeroutput">f</code> throws.</p>
</li>
<li>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> F&gt; <a name="id835586-bb"></a>function(F f);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Requires</span></b>:
F is a function object Callable from <code class="computeroutput">this</code>.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Postconditions</span></b>:
<code class="computeroutput">*this</code> targets a copy of <code class="computeroutput">f</code> if <code class="computeroutput">f</code> is nonempty, or <code class="computeroutput">this-&gt;<a href="function.html#id972567-bb">empty</a>()</code> if <code class="computeroutput">f</code> is empty.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Will not throw when <code class="computeroutput">f</code> is a stateless function object.</p>
</li>
<li>
<pre class="literallayout">function&amp; <a name="id800435-bb"></a><span class="bold"><strong>operator</strong></span>=(<span class="bold"><strong>const</strong></span> <a href="../functionN.html" title="Class template functionN">functionN</a>&amp; f);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Postconditions</span></b>:
<code class="computeroutput">*this</code> targets a copy of <code class="computeroutput">f</code>'s target, if it has one, or is empty if <code class="computeroutput">f.<a href="function.html#id972567-bb">empty</a>()</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Will not throw when the target of <code class="computeroutput">f</code> is a stateless function object or a reference to the function object.</p>
</li>
<li>
<pre class="literallayout">function&amp; <a name="id1077825-bb"></a><span class="bold"><strong>operator</strong></span>=(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&amp; f);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Postconditions</span></b>:
<code class="computeroutput">*this</code> targets a copy of <code class="computeroutput">f</code>'s target, if it has one, or is empty if <code class="computeroutput">f.<a href="function.html#id972567-bb">empty</a>()</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Will not throw when the target of <code class="computeroutput">f</code> is a stateless function object or a reference to the function object.</p>
</li>
<li>
<pre class="literallayout"><a name="id870390-bb"></a>~function();</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
If <code class="computeroutput">!this-&gt;<a href="function.html#id972567-bb">empty</a>()</code>, destroys the target of <code class="computeroutput">this</code>.</p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1212765"></a><h3>
<a name="id1073652-bb"></a><code class="computeroutput">function</code> modifiers</h3>
<div class="orderedlist"><ol type="1">
<li>
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id801534-bb"></a>swap(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&amp; f);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
Interchanges the targets of <code class="computeroutput">*this</code> and <code class="computeroutput">f</code>.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Will not throw.</p>
</li>
<li>
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id903961-bb"></a>clear();</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Postconditions</span></b>:
<code class="computeroutput">this-&gt;<a href="function.html#id972567-bb">empty</a>()</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Will not throw.</p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1212892"></a><h3>
<a name="id1112252-bb"></a><code class="computeroutput">function</code> capacity</h3>
<div class="orderedlist"><ol type="1">
<li>
<pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id972567-bb"></a>empty() <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<code class="computeroutput">false</code> if <code class="computeroutput">this</code> has a target, and <code class="computeroutput">true</code> otherwise.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Will not throw.</p>
</li>
<li>
<pre class="literallayout"><a name="id1106579-bb"></a><span class="bold"><strong>operator</strong></span> safe_bool() <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
A <code class="computeroutput">safe_bool</code> that evaluates <code class="computeroutput">false</code> in a boolean context when <code class="computeroutput">this-&gt;<a href="function.html#id972567-bb">empty</a>()</code>, and <code class="computeroutput">true</code> otherwise.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Will not throw.</p>
</li>
<li>
<pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id1106977-bb"></a><span class="bold"><strong>operator</strong></span>!() <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<code class="computeroutput">this-&gt;<a href="function.html#id972567-bb">empty</a>()</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Will not throw.</p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1213098"></a><h3>
<a name="id970210-bb"></a><code class="computeroutput">function</code> target access</h3>
<div class="orderedlist"><ol type="1">
<li>
<p><a name="id692435-bb"></a></p>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Functor&gt; <span class="type">Functor*</span> <a name="id1037337-bb"></a>target();
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Functor&gt; <span class="type"><span class="bold"><strong>const</strong></span> Functor*</span> <a name="id1003205-bb"></a>target() <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
If <code class="computeroutput">this</code> stores a target of type
<code class="computeroutput">Functor</code>, returns the address of the
target. Otherwise, returns the NULL
pointer.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Will not throw.</p>
</li>
<li>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Functor&gt; <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id899187-bb"></a>contains(<span class="bold"><strong>const</strong></span> Functor&amp; f) <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<code class="computeroutput">true</code> if <code class="computeroutput">this-&gt;<a href="function.html#id692435-bb">target</a>&lt;Functor&gt;()</code> is non-NULL and <code class="computeroutput"><a href="../function_equal.html" title="Function template function_equal">function_equal</a>(*(this-&gt;target&lt;Functor&gt;()), f)</code></p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1213293"></a><h3>
<a name="id1000460-bb"></a><code class="computeroutput">function</code> invocation</h3>
<div class="orderedlist"><ol type="1"><li>
<pre class="literallayout"><span class="type">result_type</span> <a name="id966548-bb"></a><span class="bold"><strong>operator</strong></span>()(arg1_type a1, arg2_type a2, ... , argN_type aN) <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
<code class="computeroutput">f(a1, a2, ..., aN)</code>, where <code class="computeroutput">f</code> is the target of <code class="computeroutput">*this</code>.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
if <code class="computeroutput">R</code> is <code class="computeroutput">void</code>, nothing is returned; otherwise, the return value of the call to <code class="computeroutput">f</code> is returned.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
<code class="computeroutput"><a href="../bad_function_call.html" title="Class bad_function_call">bad_function_call</a></code> if <code class="computeroutput">!this-&gt;<a href="function.html#id972567-bb">empty</a>()</code>. Otherwise, may through any exception thrown by the target function <code class="computeroutput">f</code>.</p>
</li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1213425"></a><h3>
<a name="id996764-bb"></a><code class="computeroutput">function</code> specialized algorithms</h3>
<div class="orderedlist"><ol type="1"><li>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator&gt;
  <span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id999224"></a>swap(<a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp; f1,
            <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp; f2);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
<code class="computeroutput">f1.<a href="function.html#id801534-bb">swap</a>(f2)</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Will not throw.</p>
</li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1213524"></a><h3>
<a name="id894643-bb"></a><code class="computeroutput">function</code> comparison operators</h3>
<div class="orderedlist"><ol type="1">
<li>
<p><a name="id1075930"></a></p>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator, <span class="bold"><strong>typename</strong></span> Functor&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id1012910-bb"></a><span class="bold"><strong>operator</strong></span>==(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp; f, Functor g);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator, <span class="bold"><strong>typename</strong></span> Functor&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id827744-bb"></a><span class="bold"><strong>operator</strong></span>==(Functor g, <span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp; f);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator, <span class="bold"><strong>typename</strong></span> Functor&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id937738-bb"></a><span class="bold"><strong>operator</strong></span>==(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp; f,
                  <a href="../reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a>&lt;Functor&gt; g);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator, <span class="bold"><strong>typename</strong></span> Functor&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id1107517-bb"></a><span class="bold"><strong>operator</strong></span>==(<a href="../reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a>&lt;Functor&gt; g,
                  <span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp; f);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature1, <span class="bold"><strong>typename</strong></span> Allocator1, <span class="bold"><strong>typename</strong></span> Signature2,
         <span class="bold"><strong>typename</strong></span> Allocator2&gt;
  <span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id835486-bb"></a><span class="bold"><strong>operator</strong></span>==(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature1, Allocator1&gt;&amp; f1,
                  <span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature2, Allocator2&gt;&amp; f2);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
True when <code class="computeroutput">f</code> stores an object of
type <code class="computeroutput">Functor</code> and one of the following conditions applies:
<div class="itemizedlist"><ul type="disc">
<li>
<code class="computeroutput">g</code> is of type
<code class="computeroutput"><a href="../reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a>&lt;Functor&gt;</code>
and <code class="computeroutput">f.target&lt;Functor&gt;() == g.<a href="../reference_wrapper.html#id656887-bb">get_pointer</a>()</code>.</li>
<li>
<code class="computeroutput">g</code> is not of type
<code class="computeroutput"><a href="../reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a>&lt;Functor&gt;</code>
and <code class="computeroutput">function_equals(*(f.target&lt;Functor&gt;()), g)</code>.</li>
</ul></div><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Notes</span></b>:
<code class="computeroutput"><a href="function.html" title="Class template function">function</a></code>
objects are not
<a href="../EqualityComparable.html" title="Concept EqualityComparable">EqualityComparable</a>.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Rationale</span></b>:
The <code class="computeroutput">safe_bool</code> conversion
opens a loophole whereby two <code class="computeroutput">function</code>
instances can be compared via <code class="computeroutput">==</code>, although this
is not feasible to implement. The undefined <code class="computeroutput">void
operator==</code> closes the loophole and ensures a
compile-time or link-time error.</p>
</li>
<li>
<p><a name="id1066261"></a></p>
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator, <span class="bold"><strong>typename</strong></span> Functor&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id834162-bb"></a><span class="bold"><strong>operator</strong></span>!=(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp; f, Functor g);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator, <span class="bold"><strong>typename</strong></span> Functor&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id961954-bb"></a><span class="bold"><strong>operator</strong></span>!=(Functor g, <span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp; f);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator, <span class="bold"><strong>typename</strong></span> Functor&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id867993-bb"></a><span class="bold"><strong>operator</strong></span>!=(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp; f,
                  <a href="../reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a>&lt;Functor&gt; g);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="bold"><strong>typename</strong></span> Allocator, <span class="bold"><strong>typename</strong></span> Functor&gt;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id1066866-bb"></a><span class="bold"><strong>operator</strong></span>!=(<a href="../reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a>&lt;Functor&gt; g,
                  <span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature, Allocator&gt;&amp; f);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature1, <span class="bold"><strong>typename</strong></span> Allocator1, <span class="bold"><strong>typename</strong></span> Signature2,
         <span class="bold"><strong>typename</strong></span> Allocator2&gt;
  <span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id966586-bb"></a><span class="bold"><strong>operator</strong></span>!=(<span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature1, Allocator1&gt;&amp; f1,
                  <span class="bold"><strong>const</strong></span> <a href="function.html" title="Class template function">function</a>&lt;Signature2, Allocator2&gt;&amp; f2);</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
True when <code class="computeroutput">f</code> does not store an
object of type <code class="computeroutput">Functor</code> or it stores an object of
type <code class="computeroutput">Functor</code> and one of the following conditions
applies:
<div class="itemizedlist"><ul type="disc">
<li>
<code class="computeroutput">g</code> is of type
<code class="computeroutput"><a href="../reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a>&lt;Functor&gt;</code>
and <code class="computeroutput">f.target&lt;Functor&gt;() != g.<a href="../reference_wrapper.html#id656887-bb">get_pointer</a>()</code>.</li>
<li>
<code class="computeroutput">g</code> is not of type
<code class="computeroutput"><a href="../reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a>&lt;Functor&gt;</code>
and <code class="computeroutput">!function_equals(*(f.target&lt;Functor&gt;()), g)</code>.</li>
</ul></div><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Notes</span></b>:
<code class="computeroutput"><a href="function.html" title="Class template function">function</a></code>
objects are not
<a href="../EqualityComparable.html" title="Concept EqualityComparable">EqualityComparable</a>.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Rationale</span></b>:
The <code class="computeroutput">safe_bool</code> conversion
opens a loophole whereby two <code class="computeroutput">function</code>
instances can be compared via <code class="computeroutput">!=</code>, although this
is not feasible to implement. The undefined <code class="computeroutput">void
operator!=</code> closes the loophole and ensures a
compile-time or link-time error.</p>
</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"><small>Copyright © 2001-2004 Douglas Gregor</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../functionN.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../function/reference.html#header.boost.function.hpp"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../function_equal.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

99
doc/html/boost/gregorian/date.html Normal file
View file

@ -0,0 +1,99 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class date</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../../date_time/doxy.html#id836108" title="Header &lt;boost/date_time/gregorian/greg_date.hpp&gt;">
<link rel="prev" href="../../gregorian_calendar.html" title="Class gregorian_calendar">
<link rel="next" href="../../bad_day_of_month.html" title="Struct bad_day_of_month">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../gregorian_calendar.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#id836108"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../bad_day_of_month.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="boost.gregorian.date"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class date</span></h2>
<p>boost::gregorian::date &#8212; A date type based on gregorian_calendar. </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="bold"><strong>class</strong></span> date {
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// types</em></span>
  <span class="bold"><strong>typedef</strong></span> gregorian_calendar::year_type        year_type;       
  <span class="bold"><strong>typedef</strong></span> gregorian_calendar::month_type       month_type;      
  <span class="bold"><strong>typedef</strong></span> gregorian_calendar::day_type         day_type;        
  <span class="bold"><strong>typedef</strong></span> gregorian_calendar::day_of_year_type day_of_year_type;
  <span class="bold"><strong>typedef</strong></span> gregorian_calendar::ymd_type         ymd_type;        
  <span class="bold"><strong>typedef</strong></span> gregorian_calendar::date_rep_type    date_rep_type;   
  <span class="bold"><strong>typedef</strong></span> gregorian_calendar::date_int_type    date_int_type;   
  <span class="bold"><strong>typedef</strong></span> date_duration                        duration_type;   
  <span class="emphasis"><em>// <a href="date.html#boost.gregorian.dateconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="date.html#id965039-bb">date</a>();
  <a href="date.html#id1108828-bb">date</a>(year_type, month_type, day_type);
  <a href="date.html#id837863-bb">date</a>(<span class="bold"><strong>const</strong></span> ymd_type &amp;);
  <a href="date.html#id936851-bb">date</a>(<span class="bold"><strong>const</strong></span> date_int_type &amp;);
  <a href="date.html#id835710-bb">date</a>(date_rep_type);
  <a href="date.html#id835729-bb">date</a>(special_values);
  <span class="emphasis"><em>// <a href="date.html#id1109300-bb">public member functions</a></em></span>
  <span class="type">date_int_type</span> <a href="date.html#id868803-bb">julian_day</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">day_of_year_type</span> <a href="date.html#id868820-bb">day_of_year</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>long</strong></span></span> <a href="date.html#id798683-bb">modjulian_day</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>int</strong></span></span> <a href="date.html#id1036065-bb">week_number</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">date_int_type</span> <a href="date.html#id1031184-bb">day_number</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><a href="date.html" title="Class date">date</a></span> <a href="date.html#id908610-bb">end_of_month</a>() <span class="bold"><strong>const</strong></span>;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1150185"></a><h2>Description</h2>
<p>This class is the primary interface for programming with greogorian dates. The is a lightweight type that can be freely passed by value. All comparison operators are supported. </p>
<div class="refsect2" lang="en">
<a name="id1150194"></a><h3>
<a name="boost.gregorian.dateconstruct-copy-destruct"></a><code class="computeroutput">date</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><a name="id965039-bb"></a>date();</pre></li>
<li><pre class="literallayout"><a name="id1108828-bb"></a>date(year_type y, month_type m, day_type d);</pre></li>
<li><pre class="literallayout"><a name="id837863-bb"></a>date(<span class="bold"><strong>const</strong></span> ymd_type &amp; ymd);</pre></li>
<li><pre class="literallayout"><a name="id936851-bb"></a>date(<span class="bold"><strong>const</strong></span> date_int_type &amp; rhs);</pre></li>
<li><pre class="literallayout"><a name="id835710-bb"></a>date(date_rep_type rhs);</pre></li>
<li><pre class="literallayout"><a name="id835729-bb"></a>date(special_values sv);</pre></li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1150306"></a><h3>
<a name="id1109300-bb"></a><code class="computeroutput">date</code> public member functions</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><span class="type">date_int_type</span> <a name="id868803-bb"></a>julian_day() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">day_of_year_type</span> <a name="id868820-bb"></a>day_of_year() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>long</strong></span></span> <a name="id798683-bb"></a>modjulian_day() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>int</strong></span></span> <a name="id1036065-bb"></a>week_number() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">date_int_type</span> <a name="id1031184-bb"></a>day_number() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><a href="date.html" title="Class date">date</a></span> <a name="id908610-bb"></a>end_of_month() <span class="bold"><strong>const</strong></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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../gregorian_calendar.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#id836108"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../bad_day_of_month.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

64
doc/html/boost/hash.html Normal file
View file

@ -0,0 +1,64 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Struct template hash</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../index.html" title="The Boost C++ Libraries">
<link rel="up" href="../hash/reference_.html#id1082064" title="Header &lt;boost/functional/hash/hash.hpp&gt;">
<link rel="prev" href="../hash/reference_.html" title=" Reference">
<link rel="next" href="../hash_combine.html" title="Function template hash_combine">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.htm">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../hash/reference_.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../hash/reference_.html#id1082064"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../hash_combine.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="boost.hash"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct template hash</span></h2>
<p>boost::hash &#8212; An STL compliant hash function object.</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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T&gt;
<span class="bold"><strong>struct</strong></span> hash : <span class="bold"><strong>public</strong></span> std::unary_function&lt;T, std::size_t&gt; {
  <span class="type">std::size_t</span> <a href="hash.html#id1074553-bb"><span class="bold"><strong>operator</strong></span>()</a>(T <span class="bold"><strong>const</strong></span>&amp;) <span class="bold"><strong>const</strong></span>;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1219961"></a><h2>Description</h2>
<pre class="literallayout"><span class="type">std::size_t</span> <a name="id1074553-bb"></a><span class="bold"><strong>operator</strong></span>()(T <span class="bold"><strong>const</strong></span>&amp; val) <span class="bold"><strong>const</strong></span>;</pre>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
<pre class="programlisting"><a href="../id1042434.html" title="Function hash_value">hash_value</a>(val)</pre><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Notes</span></b>:
The call to <code class="computeroutput"><a href="../id1042434.html" title="Function hash_value">hash_value</a></code>
is unqualified, so that custom overloads can be
found via argument dependent lookup.
<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:
Only throws if
<code class="computeroutput"><a href="../id1042434.html" title="Function hash_value">hash_value</a>(T)</code> throws.
</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"><small>Copyright © 2005 Daniel James</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../hash/reference_.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../hash/reference_.html#id1082064"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../hash_combine.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

Some files were not shown because too many files have changed in this diff Show more