Compare commits

...

44 Commits

Author SHA1 Message Date
e668760ccd This commit was manufactured by cvs2svn to create tag 'minmax'.
[SVN r22393]
2004-02-26 10:35:28 +00:00
e80a00545c Added FAQ entry from Matt Hurd about boost::function overhead.
[SVN r22309]
2004-02-18 06:37:13 +00:00
1a142a2f94 Fix on GCC 2.9x from Ralf
[SVN r22249]
2004-02-12 22:48:22 +00:00
f0c5e5e95b Work around a GCC 2.95.3 bug triggered by the workaround to a VC++ 7.1 bug...
[SVN r22242]
2004-02-11 18:16:55 +00:00
2fb242eae1 Work around CLR bug in .NET 2003
[SVN r22234]
2004-02-11 04:26:53 +00:00
03c7fdcf37 Fix the documentation of empty() (Angus Leeming)
[SVN r22193]
2004-02-08 00:11:22 +00:00
b7608dff24 type_info::operator== fixes (Peter Dimov)
[SVN r22083]
2004-01-30 17:15:03 +00:00
5f0426a80d Stupid deprecated XInclude namespace
[SVN r22013]
2004-01-28 01:31:00 +00:00
fdb37c35ff Some aesthetic tweaks
[SVN r21905]
2004-01-25 01:17:35 +00:00
b7650282df tutorial.xml: Add short discussion of the comparison of Boost.Function
objects to function objects.


[SVN r21904]
2004-01-25 01:15:57 +00:00
c5d8d03b76 libs/function/doc/reference.xml:
- Document target() member function
  - Documented new comparison operators

libs/function/doc/tests.xml: Include contains_test.cpp
libs/function/doc/function.xml: Use the new XInclude name


[SVN r21903]
2004-01-25 00:38:26 +00:00
746676d274 Fix semantics for comparison against reference_wrappers
[SVN r21901]
2004-01-24 23:31:40 +00:00
c31ad8700e Cast pointers, not lvalues
[SVN r21897]
2004-01-24 18:29:18 +00:00
cb1bcd5410 "contains" -> "target"
[SVN r21845]
2004-01-20 18:07:13 +00:00
7d30d98efd boost/function/function_template.hpp, boost/function/function_base.hpp:
- Added "contains" member function to extract a pointer to the target
    function object if you know its type
  - Added operator== that can compare a Boost.Function object against a
    function object

libs/function/test/Jamfile, libs/function/test/contains_test.cpp:
  - Test contains() and equality comparison operators


[SVN r21844]
2004-01-20 18:02:02 +00:00
50ff886c81 MSVC 7.1 can handle Function, preferred syntax
[SVN r21333]
2003-12-19 03:33:25 +00:00
44e986afe3 Switch over to the new enable_if library
[SVN r21143]
2003-12-04 22:31:09 +00:00
4bb90aae7a Metrowerks CodeWarrior 8.3 doesn't seem to support SFINAE
[SVN r21141]
2003-12-04 22:06:56 +00:00
04eb767238 Possible fix for Metrowerks
[SVN r21126]
2003-12-03 19:55:57 +00:00
8abd32bd81 Clean up warnings on Borland C++ 5.5
[SVN r21095]
2003-12-03 01:21:32 +00:00
3f753feb4d Use the "minimal" test tools, to simplify my life a bit
[SVN r20924]
2003-11-23 16:17:24 +00:00
b09e7f3d3d Fix & regenerate sum_avg_portable.cpp
[SVN r20402]
2003-10-17 16:25:51 +00:00
2c708069e8 Answer the eternal operator== question.
[SVN r20356]
2003-10-12 16:02:26 +00:00
b8d943ec27 Move to the "new" function<> syntax. He he.
[SVN r20320]
2003-10-09 05:00:38 +00:00
8c8f072d09 Update license to the new Boost license (yay!)
[SVN r20235]
2003-10-01 04:10:37 +00:00
fad40732a9 function_template.hpp: Works around an annoying bug in one of Apple's
3.3 compilers.


[SVN r20233]
2003-10-01 03:40:35 +00:00
5314836215 Add V2 Jamfile
[SVN r20210]
2003-09-29 16:09:15 +00:00
66cd32b565 NULL pointers can be of any integral type, not just int (Howard Hinnant)
[SVN r19989]
2003-09-10 04:16:17 +00:00
043d0236a7 Use the import rule
[SVN r19968]
2003-09-08 17:38:49 +00:00
4b830024f3 Die, foo, die
[SVN r19205]
2003-07-19 06:53:21 +00:00
40c9bb204e Me commit bad code
[SVN r19195]
2003-07-18 16:18:16 +00:00
5347683c8e Remove return statement from operator new to see who screams about it
[SVN r19178]
2003-07-18 04:17:30 +00:00
1ef5f459e2 sig needs to be a friend of functionN
[SVN r19174]
2003-07-18 03:48:17 +00:00
cb3c1b0d1e doc/tutorial.xml: fix a typo in the example code (thanks Jens!)
test/sum_avg_portable.cpp: regenerated.


[SVN r19136]
2003-07-16 04:40:25 +00:00
1a6d95733a Get rid of a warning in GCC 3.3.
[SVN r19069]
2003-07-11 17:42:12 +00:00
2c8fc1b31f add macro BOOST_FUNCTION_NO_FUNCTION_TYPE_SYNTAX
[SVN r19056]
2003-07-11 16:00:29 +00:00
fa73a61fcc VC++ 7.1 has same bug as 7.0. Reported to Microsoft
[SVN r18697]
2003-06-06 11:48:50 +00:00
a753dbc048 Jamfile.v2: Jamfile for Boost.Function documentation
[SVN r18244]
2003-04-13 14:51:26 +00:00
ce00e49978 Newer Borland compiler still does not handle enable_if
[SVN r18064]
2003-03-23 16:58:05 +00:00
eeb15caff2 Document nested class template "sig"
[SVN r17946]
2003-03-16 02:00:20 +00:00
ade6c96d5c Updated to reflect BoostBook changes
[SVN r17941]
2003-03-15 23:12:35 +00:00
b54e9df555 Lots of cleanups as BoostBook becomes more strict
[SVN r17871]
2003-03-13 00:29:57 +00:00
eb14b70c9c Move away from attributes, toward elements
[SVN r17869]
2003-03-13 00:08:34 +00:00
48e2bc0bdb Import of BoostBook documentation for any, array, bind, function, ref, and
signals libraries.


[SVN r17866]
2003-03-12 23:27:25 +00:00
50 changed files with 2653 additions and 515 deletions

5
doc/Jamfile.v2 Normal file
View File

@ -0,0 +1,5 @@
project boost/doc ;
import boostbook : boostbook ;
boostbook function-doc : function.xml ;

156
doc/faq.xml Normal file
View File

@ -0,0 +1,156 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<section id="function.faq" last-revision="$Date$">
<title>Frequently Asked Questions</title>
<qandaset>
<qandaentry>
<question><para>Why can't I compare
<classname>boost::function</classname> objects with
<code>operator==</code> or
<code>operator!=</code>?</para></question>
<answer>
<para>Comparison between <classname>boost::function</classname>
objects cannot be implemented "well", and therefore will not be
implemented. The typical semantics requested for <code>f ==
g</code> given <classname>boost::function</classname> objects
<code>f</code> and <code>g</code> are:</para>
<itemizedlist>
<listitem><simpara>If <code>f</code> and <code>g</code>
store function objects of the same type, use that type's
<code>operator==</code> to compare
them.</simpara></listitem>
<listitem><simpara>If <code>f</code> and <code>g</code>
store function objects of different types, return
<code>false</code>.</simpara></listitem>
</itemizedlist>
<para>The problem occurs when the type of the function objects
stored by both <code>f</code> and <code>g</code> doesn't have an
<code>operator==</code>: we would like the expression <code>f ==
g</code> to fail to compile, as occurs with, e.g., the standard
containers. However, this is not implementable for
<classname>boost::function</classname> because it necessarily
"erases" some type information after it has been assigned a
function object, so it cannot try to call
<code>operator==</code> later: it must either find a way to call
<code>operator==</code> now, or it will never be able to call it
later. Note, for instance, what happens if you try to put a
<code>float</code> value into a
<classname>boost::function</classname> object: you will get an
error at the assignment operator or constructor, not in
<code>operator()</code>, because the function-call expression
must be bound in the constructor or assignment operator.</para>
<para>The most promising approach is to find a method of
determining if <code>operator==</code> can be called for a
particular type, and then supporting it only when it is
available; in other situations, an exception would be
thrown. However, to date there is no known way to detect if an
arbitrary operator expression <code>f == g</code> is suitably
defined. The best solution known has the following undesirable
qualities:</para>
<orderedlist>
<listitem><simpara>Fails at compile-time for objects where
<code>operator==</code> is not accessible (e.g., because it is
<code>private</code>).</simpara></listitem>
<listitem><simpara>Fails at compile-time if calling
<code>operator==</code> is ambiguous.</simpara></listitem>
<listitem><simpara>Appears to be correct if the
<code>operator==</code> declaration is correct, even though
<code>operator==</code> may not compile.</simpara></listitem>
</orderedlist>
<para>All of these problems translate into failures in the
<classname>boost::function</classname> constructors or
assignment operator, <emphasis>even if the user never invokes
operator==</emphasis>. We can't do that to users.</para>
<para>The other option is to place the burden on users that want
to use <code>operator==</code>, e.g., by providing an
<code>is_equality_comparable</code> trait they may
specialize. This is a workable solution, but is dangerous in
practice, because forgetting to specialize the trait will result
in unexpected exceptions being thrown from
<classname>boost::function</classname>'s
<code>operator==</code>. This essentially negates the usefulness
of <code>operator==</code> in the context in which it is most
desired: multitarget callbacks. The
<libraryname>Signals</libraryname> library has a way around
this.</para>
</answer>
</qandaentry>
<qandaentry>
<question><para>I see void pointers; is this [mess] type safe?</para></question>
<answer>
<para>Yes, <computeroutput>boost::function</computeroutput> is type
safe even though it uses void pointers and pointers to functions
returning void and taking no arguments. Essentially, all type
information is encoded in the functions that manage and invoke
function pointers and function objects. Only these functions are
instantiated with the exact type that is pointed to by the void
pointer or pointer to void function. The reason that both are required
is that one may cast between void pointers and object pointers safely
or between different types of function pointers (provided you don't
invoke a function pointer with the wrong type). </para>
</answer>
</qandaentry>
<qandaentry>
<question><para>Why are there workarounds for void returns? C++ allows them!</para></question>
<answer><para>Void returns are permitted by the C++ standard, as in this code snippet:
<programlisting>void f();
void g() { return f(); }</programlisting>
</para>
<para> This is a valid usage of <computeroutput>boost::function</computeroutput> because void returns are not used. With void returns, we would attempting to compile ill-formed code similar to:
<programlisting>int f();
void g() { return f(); }</programlisting>
</para>
<para> In essence, not using void returns allows
<computeroutput>boost::function</computeroutput> to swallow a return value. This is
consistent with allowing the user to assign and invoke functions and
function objects with parameters that don't exactly match.</para>
</answer>
</qandaentry>
<qandaentry>
<question><para>Why (function) cloning?</para></question>
<answer>
<para>In November and December of 2000, the issue of cloning
vs. reference counting was debated at length and it was decided
that cloning gave more predictable semantics. I won't rehash the
discussion here, but if it cloning is incorrect for a particular
application a reference-counting allocator could be used.</para>
</answer>
</qandaentry>
<qandaentry>
<question><para>How much overhead does a call through <code><classname>boost::function</classname></code> incur?</para></question>
<answer>
<para>The cost of <code>boost::function</code> can be reasonably
consistently measured at around 20ns +/- 10 ns on a modern >2GHz
platform versus directly inlining the code.</para>
<para>However, the performance of your application may benefit
from or be disadvantaged by <code>boost::function</code>
depending on how your C++ optimiser optimises. Similar to a
standard function pointer, differences of order of 10% have been
noted to the benefit or disadvantage of using
<code>boost::function</code> to call a function that contains a
tight loop depending on your compilation circumstances.</para>
<para>[Answer provided by Matt Hurd. See <ulink url="http://article.gmane.org/gmane.comp.lib.boost.devel/33278"/>]</para>
</answer>
</qandaentry>
</qandaset>
</section>

60
doc/function.xml Normal file
View File

@ -0,0 +1,60 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<library name="Function" dirname="function" id="function"
last-revision="$Date$"
xmlns:xi="http://www.w3.org/2001/XInclude">
<libraryinfo>
<author>
<firstname>Douglas</firstname>
<surname>Gregor</surname>
<email>gregod@cs.rpi.edu</email>
</author>
<copyright>
<year>2001</year>
<year>2002</year>
<year>2003</year>
<holder>Douglas Gregor</holder>
</copyright>
<legalnotice>
<para>Use, modification and distribution is subject to the Boost
Software License, Version 1.0. (See accompanying file
<filename>LICENSE_1_0.txt</filename> or copy at <ulink
url="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</ulink>)</para>
</legalnotice>
<librarypurpose>Function object wrappers for deferred calls or callbacks</librarypurpose>
<librarycategory name="category:higher-order"/>
</libraryinfo>
<title>Boost.Function</title>
<section id="function.intro">
<title>Introduction</title>
<para>The Boost.Function library contains a family of class templates
that are function object wrappers. The notion is similar to a
generalized callback. It shares features with function pointers in
that both define a call interface (e.g., a function taking two integer
arguments and returning a floating-point value) through which some
implementation can be called, and the implementation that is invoked
may change throughout the course of the program.</para>
<para> Generally, any place in which a function pointer would be used
to defer a call or make a callback, Boost.Function can be used instead
to allow the user greater flexibility in the implementation of the
target. Targets can be any 'compatible' function object (or function
pointer), meaning that the arguments to the interface designated by
Boost.Function can be converted to the arguments of the target
function object.</para>
</section>
<xi:include href="history.xml"/>
<xi:include href="tutorial.xml"/>
<xi:include href="reference.xml"/>
<xi:include href="faq.xml"/>
<xi:include href="misc.xml"/>
<xi:include href="tests.xml"/>
</library>

87
doc/history.xml Normal file
View File

@ -0,0 +1,87 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<section id="function.history" last-revision="$Date$">
<title>History &amp; Compatibility Notes</title>
<itemizedlist spacing="compact">
<listitem><para><emphasis role="bold">Version 1.30.0</emphasis>: </para>
<itemizedlist spacing="compact">
<listitem><para>All features deprecated in version 1.29.0 have
been removed from Boost.Function.</para></listitem>
<listitem><para><code><classname>boost::function</classname></code>
and <code><classname>boost::functionN</classname></code> objects
can be assigned to 0 (semantically equivalent to calling
<code><methodname
alt="boost::function::clear">clear</methodname>()</code>) and
compared against 0 (semantically equivalent to calling
<code><methodname
alt="boost::function::empty">empty</methodname>()</code>).</para></listitem>
<listitem><para>The Boost.Function code is now generated
entirely by the <libraryname>Preprocessor</libraryname> library,
so it is now possible to generate
<code><classname>boost::function</classname></code> and
<code><classname>boost::functionN</classname></code> class
templates for any number of arguments.</para></listitem>
<listitem><para>The
<classname>boost::bad_function_call</classname> exception class
was introduced.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para><emphasis role="bold">Version 1.29.0</emphasis>:
Boost.Function has been partially redesigned to minimize the
interface and make it cleaner. Several seldom- or never-used
features of the older Boost.Function have been deprecated and will
be removed in the near future. Here is a list of features that have
been deprecated, the likely impact of the deprecations, and how to
adjust your code:
<itemizedlist spacing="compact">
<listitem><para>The <computeroutput>boost::function</computeroutput> class template syntax has
changed. The old syntax, e.g., <computeroutput>boost::function&lt;int, float,
double, std::string&gt;</computeroutput>, has been changed to a more natural
syntax <computeroutput>boost::function&lt;int (float, double,
std::string)&gt;</computeroutput>, where all return and argument types are
encoded in a single function type parameter. Any other template
parameters (e.g., the <computeroutput>Allocator</computeroutput>) follow this single
parameter.</para>
<para> The resolution to this change depends on the
abilities of your compiler: if your compiler supports template
partial specialization and can parse function types (most do), modify
your code to use the newer
syntax (preferable) or directly use one of the
<computeroutput>functionN</computeroutput> classes whose syntax has not
changed. If your compiler does not support template partial
specialization or function types, you must take the latter option and
use the numbered Boost.Function classes. This option merely requires
changing types such as <computeroutput>boost::function&lt;void, int, int&gt;</computeroutput>
to <computeroutput>boost::function2&lt;void, int, int&gt;</computeroutput> (adding the number of
function arguments to the end of the class name).</para>
<para> Support for the old syntax with the
<computeroutput>boost::function</computeroutput> class template will persist for a short
while, but will eventually be removed so that we can provide better
error messages and link compatibility. </para></listitem>
<listitem><para>The invocation
policy template parameter (<computeroutput>Policy</computeroutput>) has been deprecated
and will be removed. There is no direct equivalent to this rarely
used feature.</para></listitem>
<listitem><para>The mixin template parameter
(<computeroutput>Mixin</computeroutput>) has been deprecated and will be removed. There
is not direct equivalent to this rarely used feature.</para></listitem>
<listitem><para>The
<computeroutput>set</computeroutput> methods have been deprecated and will be
removed. Use the assignment operator instead.</para></listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</section>

65
doc/misc.xml Normal file
View File

@ -0,0 +1,65 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<section id="function.misc" last-revision="$Date$">
<title>Miscellaneous Notes</title>
<section>
<title>Boost.Function vs. Function Pointers</title>
<para>Boost.Function has several advantages over function pointers, namely:
<itemizedlist spacing="compact">
<listitem><para>Boost.Function allows arbitrary compatible function objects to be targets (instead of requiring an exact function signature).</para></listitem>
<listitem><para>Boost.Function may be used with argument-binding and other function object construction libraries.</para></listitem>
<listitem><para>Boost.Function has predictible behavior when an empty function object is called. </para></listitem>
</itemizedlist></para>
<para> And, of course, function pointers have several advantages over Boost.Function:
<itemizedlist spacing="compact">
<listitem><para> Function pointers are smaller (the size of one pointer instead of three) </para></listitem>
<listitem><para> Function pointers are faster (Boost.Function may require two calls through function pointers) </para></listitem>
<listitem><para> Function pointers are backward-compatible with C libraries.</para></listitem>
<listitem><para> More readable error messages. </para></listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Performance</title>
<section>
<title>Function object wrapper size</title>
<para> Function object wrappers will be the size of two function pointers plus one function pointer or data pointer (whichever is larger). On common 32-bit platforms, this amounts to 12 bytes per wrapper. Additionally, the function object target will be allocated on the heap.</para>
</section>
<section>
<title>Copying efficiency</title>
<para> Copying function object wrappers may require allocating memory for a copy of the function object target. The default allocator may be replaced with a faster custom allocator or one may choose to allow the function object wrappers to only store function object targets by reference (using <computeroutput>ref</computeroutput>) if the cost of this cloning becomes prohibitive.</para>
</section>
<section>
<title>Invocation efficiency</title>
<para> With a properly inlining compiler, an invocation of a function object requires one call through a function pointer. If the call is to a free function pointer, an additional call must be made to that function pointer (unless the compiler has very powerful interprocedural analysis).</para>
</section>
</section>
<section>
<title>Combatting virtual function "bloat"</title>
<para> The use of virtual functions tends to cause 'code bloat' on many compilers. When a class contains a virtual function, it is necessary to emit an additional function that classifies the type of the object. It has been our experience that these auxiliary functions increase the size of the executable significantly when many <computeroutput>boost::function</computeroutput> objects are used. </para>
<para> In Boost.Function, an alternative but equivalent approach was taken using free functions instead of virtual functions. The Boost.Function object essentially holds two pointers to make a valid target call: a void pointer to the function object it contains and a void pointer to an "invoker" that can call the function object, given the function pointer. This invoker function performs the argument and return value conversions Boost.Function provides. A third pointer points to a free function called the "manager", which handles the cloning and destruction of function objects. The scheme is typesafe because the only functions that actually handle the function object, the invoker and the manager, are instantiated given the type of the function object, so they can safely cast the incoming void pointer (the function object pointer) to the appropriate type.</para>
</section>
<section>
<title>Acknowledgements</title>
<para> Many people were involved in the construction of this
library. William Kempf, Jesse Jones and Karl Nelson were all
extremely helpful in isolating an interface and scope for the
library. John Maddock managed the formal review, and many
reviewers gave excellent comments on interface, implementation,
and documentation. Peter Dimov led us to the function
declarator-based syntax.</para>
</section>
</section>

874
doc/reference.xml Normal file
View File

@ -0,0 +1,874 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<library-reference id="function.reference" last-revision="$Date$">
<section id="function.definitions">
<title>Definitions</title>
<para>
<itemizedlist>
<listitem>
<para>A function object <computeroutput>f</computeroutput> is
<emphasis>compatible</emphasis> if for the given set of argument
types <computeroutput>Arg1</computeroutput>,
<computeroutput>Arg2</computeroutput>, ...,
<computeroutput>ArgN</computeroutput> and a
return type <computeroutput>ResultType</computeroutput>, the
appropriate following function is well-formed:
<programlisting>
<emphasis>// if ResultType is not <emphasis role="bold">void</emphasis></emphasis>
ResultType foo(Arg1 arg1, Arg2 arg2, ..., Arg<emphasis>N</emphasis> arg<emphasis>N</emphasis>)
{
<emphasis role="bold">return</emphasis> f(arg1, arg2, ..., arg<emphasis>N</emphasis>);
}
<emphasis>// if ResultType is <emphasis role="bold">void</emphasis></emphasis>
ResultType foo(Arg1 arg1, Arg2 arg2, ..., Arg<emphasis>N</emphasis> arg<emphasis>N</emphasis>)
{
f(arg1, arg2, ..., arg<emphasis>N</emphasis>);
}
</programlisting></para>
<para> A special provision is made for pointers to member
functions. Though they are not function objects, Boost.Function
will adapt them internally to function objects. This requires
that a pointer to member function of the form <code>R
(X::*mf)(Arg1, Arg2, ..., ArgN)
cv-quals</code> be adapted to a
function object with the following function call operator
overloads:
<programlisting>
<emphasis role="bold">template</emphasis>&lt;<emphasis role="bold">typename P</emphasis>&gt;
R <emphasis role="bold">operator</emphasis>()(<emphasis>cv-quals</emphasis> P&amp; x, Arg1 arg1, Arg2 arg2, ..., Arg<emphasis>N</emphasis> arg<emphasis>N</emphasis>) <emphasis role="bold">const</emphasis>
{
<emphasis role="bold">return</emphasis> (*x).*mf(arg1, arg2, ..., arg<emphasis>N</emphasis>);
}
</programlisting>
</para>
</listitem>
<listitem>
<para>A function object <code>f</code> of
type <code>F</code> is
<emphasis>stateless</emphasis> if it is a function pointer or if
<code><classname>boost::is_stateless</classname>&lt;T&gt;</code>
is true. The construction of or copy to a Boost.Function object
from a stateless function object will not cause exceptions to be
thrown and will not allocate any storage.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<header name="boost/function.hpp">
<namespace name="boost">
<class name="bad_function_call">
<inherit access="public"><classname>std::runtime_error</classname></inherit>
<purpose>An exception type thrown when an instance of a <code>function</code> object is empty when invoked.</purpose>
<constructor>
<effects><simpara>Constructs a <code><classname>bad_function_call</classname></code> exception object.</simpara></effects>
</constructor>
</class>
<class name="function_base">
<purpose>The common base class for all Boost.Function
objects. Objects of type function_base may not be created
directly.</purpose>
<method-group name="capacity">
<method name="empty" cv="const">
<type>bool</type>
<returns><simpara><code>false</code> if <code>this</code> has a target, and <code>true</code> otherwise.</simpara></returns>
<throws><simpara>Will not throw.</simpara></throws>
</method>
</method-group>
<method-group name="target access">
<overloaded-method name="target">
<signature>
<template>
<template-type-parameter name="Functor"/>
</template>
<type>Functor*</type>
</signature>
<signature cv="const">
<template>
<template-type-parameter name="Functor"/>
</template>
<type>const Functor*</type>
</signature>
<returns><simpara>If <code>this</code> stores a target of type
<code>Functor</code>, returns the address of the
target. Otherwise, returns the NULL
pointer.</simpara></returns>
<throws><simpara>Will not throw.</simpara></throws>
</overloaded-method>
</method-group>
</class>
<class name="functionN">
<template>
<template-type-parameter name="R"/>
<template-type-parameter name="T1"/>
<template-type-parameter name="T2"/>
<template-varargs/>
<template-type-parameter name="TN"/>
<template-type-parameter name="Allocator">
<default><classname>std::allocator</classname>&lt;void&gt;</default>
</template-type-parameter>
</template>
<inherit access="public"><classname>function_base</classname></inherit>
<purpose>A set of generalized function pointers that can be used for callbacks or wrapping function objects.</purpose>
<description>
<para>Class template <classname>functionN</classname> is
actually a family of related classes <classname
alt="functionN">function0</classname>, <classname
alt="functionN">function1</classname>, etc., up to some
implementation-defined maximum. In this context, <code>N</code>
refers to the number of parameters.</para>
</description>
<typedef name="result_type"><type>R</type></typedef>
<typedef name="allocator_type"><type>Allocator</type></typedef>
<typedef name="argument_type">
<type>T1</type><purpose>If N == 1</purpose>
</typedef>
<typedef name="first_argument_type">
<type>T1</type>
<purpose>If N == 2</purpose>
</typedef>
<typedef name="second_argument_type">
<type>T2</type>
<purpose>If N == 2</purpose>
</typedef>
<typedef name="arg1_type"><type>T1</type></typedef>
<typedef name="arg2_type"><type>T2</type></typedef>
<typedef name="..."><type/></typedef>
<typedef name="argN_type"><type>TN</type></typedef>
<static-constant name="arity">
<type>int</type>
<default>N</default>
</static-constant>
<struct name="sig">
<template>
<template-type-parameter name="Args"/>
</template>
<purpose>
<simpara><libraryname>Lambda</libraryname> library support</simpara>
</purpose>
<typedef name="type"><type>result_type</type></typedef>
</struct>
<constructor>
<postconditions><simpara><code>this-><methodname>empty</methodname>()</code></simpara></postconditions>
<throws><simpara>Will not throw.</simpara></throws>
</constructor>
<constructor>
<parameter name="f">
<paramtype>const <classname>functionN</classname>&amp;</paramtype>
</parameter>
<postconditions><simpara>Contains a copy of the <code>f</code>'s target, if it has one, or is empty if <code>f.<methodname>empty</methodname>()</code>.</simpara></postconditions>
<throws><simpara>Will not throw unless copying the target of <code>f</code> throws.</simpara></throws>
</constructor>
<constructor>
<template>
<template-type-parameter name="F"/>
</template>
<parameter name="f"><paramtype>F</paramtype></parameter>
<requires><simpara>F is a function object Callable from <code>this</code>.</simpara></requires>
<postconditions><simpara><code>*this</code> targets a copy of <code>f</code> if <code>f</code> is nonempty, or <code>this-&gt;<methodname>empty</methodname>()</code> if <code>f</code> is empty.</simpara></postconditions>
<throws><simpara>Will not throw when <code>f</code> is a stateless function object.</simpara></throws>
</constructor>
<destructor>
<effects><simpara>If <code>!this-><methodname>empty</methodname>()</code>, destroys the target of this.</simpara></effects>
</destructor>
<copy-assignment>
<parameter name="f">
<paramtype>const <classname>functionN</classname>&amp;</paramtype>
</parameter>
<postconditions><simpara><code>*this</code> targets a copy of <code>f</code>'s target, if it has one, or is empty if <code>f.<methodname>empty</methodname>()</code>.</simpara></postconditions>
<throws><simpara>Will not throw when the target of <code>f</code> is a stateless function object or a reference to the function object.</simpara></throws>
</copy-assignment>
<method-group name="modifiers">
<method name="swap">
<type>void</type>
<parameter name="f"><paramtype>const <classname>functionN</classname>&amp;</paramtype></parameter>
<effects><simpara>Interchanges the targets of <code>*this</code> and <code>f</code>.</simpara></effects>
<throws><simpara>Will not throw.</simpara></throws>
</method>
<method name="clear">
<type>void</type>
<postconditions><simpara>this-&gt;<methodname>empty</methodname>()</simpara></postconditions>
<throws><simpara>Will not throw.</simpara></throws>
</method>
</method-group>
<method-group name="capacity">
<method name="empty" cv="const">
<type>bool</type>
<returns><simpara><code>false</code> if <code>this</code> has a target, and <code>true</code> otherwise.</simpara></returns>
<throws><simpara>Will not throw.</simpara></throws>
</method>
<method name="conversion-operator" cv="const">
<type>safe_bool</type>
<returns><simpara>A <code>safe_bool</code> that evaluates <code>false</code> in a boolean context when <code>this-&gt;<methodname>empty</methodname>()</code>, and <code>true</code> otherwise.</simpara></returns>
<throws><simpara>Will not throw.</simpara></throws>
</method>
<method name="operator!" cv="const">
<type>bool</type>
<returns><simpara><code>this-&gt;<methodname>empty</methodname>()</code></simpara></returns>
<throws><simpara>Will not throw.</simpara></throws>
</method>
</method-group>
<method-group name="target access">
<overloaded-method name="target">
<signature>
<template>
<template-type-parameter name="Functor"/>
</template>
<type>Functor*</type>
</signature>
<signature cv="const">
<template>
<template-type-parameter name="Functor"/>
</template>
<type>const Functor*</type>
</signature>
<returns><simpara>If <code>this</code> stores a target of type
<code>Functor</code>, returns the address of the
target. Otherwise, returns the NULL
pointer.</simpara></returns>
<throws><simpara>Will not throw.</simpara></throws>
</overloaded-method>
</method-group>
<method-group name="invocation">
<method name="operator()" cv="const">
<type>result_type</type>
<parameter name="a1"><paramtype>arg1_type</paramtype></parameter>
<parameter name="a2"><paramtype>arg2_type</paramtype></parameter>
<parameter><paramtype>...</paramtype></parameter>
<parameter name="aN"><paramtype>argN_type</paramtype></parameter>
<effects><simpara><code>f(a1, a2, ..., aN)</code>, where <code>f</code> is the target of <code>*this</code>.</simpara></effects>
<returns><simpara>if <code>R</code> is <code>void</code>, nothing is returned; otherwise, the return value of the call to <code>f</code> is returned.</simpara></returns>
<throws><simpara><code><classname>bad_function_call</classname></code> if <code>!this-&gt;<methodname>empty</methodname>()</code>. Otherwise, may through any exception thrown by the target function <code>f</code>.</simpara></throws>
</method>
</method-group>
<free-function-group name="specialized algorithms">
<function name="swap">
<template>
<template-type-parameter name="T1"/>
<template-type-parameter name="T2"/>
<template-varargs/>
<template-type-parameter name="TN"/>
<template-type-parameter name="Allocator"/>
</template>
<type>void</type>
<parameter name="f1"><paramtype><classname>functionN</classname>&lt;T1, T2, ..., TN, Allocator&gt;&amp;</paramtype></parameter>
<parameter name="f2"><paramtype><classname>functionN</classname>&lt;T1, T2, ..., TN, Allocator&gt;&amp;</paramtype></parameter>
<effects><simpara><code>f1.<methodname>swap</methodname>(f2)</code></simpara></effects>
<throws><simpara>Will not throw.</simpara></throws>
</function>
</free-function-group>
<free-function-group name="comparison operators">
<overloaded-function name="operator==">
<signature>
<template>
<template-type-parameter name="T1"/>
<template-type-parameter name="T2"/>
<template-varargs/>
<template-type-parameter name="TN"/>
<template-type-parameter name="Allocator"/>
<template-type-parameter name="Functor"/>
</template>
<type>bool</type>
<parameter name="f"><paramtype>const <classname>functionN</classname>&lt;T1, T2, ..., TN, Allocator&gt;&amp;</paramtype></parameter>
<parameter name="g"><paramtype>Functor</paramtype></parameter>
</signature>
<signature>
<template>
<template-type-parameter name="T1"/>
<template-type-parameter name="T2"/>
<template-varargs/>
<template-type-parameter name="TN"/>
<template-type-parameter name="Allocator"/>
<template-type-parameter name="Functor"/>
</template>
<type>bool</type>
<parameter name="g"><paramtype>Functor</paramtype></parameter>
<parameter name="f"><paramtype>const <classname>functionN</classname>&lt;T1, T2, ..., TN, Allocator&gt;&amp;</paramtype></parameter>
</signature>
<signature>
<template>
<template-type-parameter name="T1"/>
<template-type-parameter name="T2"/>
<template-varargs/>
<template-type-parameter name="TN"/>
<template-type-parameter name="Allocator"/>
<template-type-parameter name="Functor"/>
</template>
<type>bool</type>
<parameter name="f"><paramtype>const <classname>functionN</classname>&lt;T1, T2, ..., TN, Allocator&gt;&amp;</paramtype></parameter>
<parameter name="g"><paramtype><classname>reference_wrapper</classname>&lt;Functor&gt;</paramtype></parameter>
</signature>
<signature>
<template>
<template-type-parameter name="T1"/>
<template-type-parameter name="T2"/>
<template-varargs/>
<template-type-parameter name="TN"/>
<template-type-parameter name="Allocator"/>
<template-type-parameter name="Functor"/>
</template>
<type>bool</type>
<parameter name="g"><paramtype><classname>reference_wrapper</classname>&lt;Functor&gt;</paramtype></parameter>
<parameter name="f"><paramtype>const <classname>functionN</classname>&lt;T1, T2, ..., TN, Allocator&gt;&amp;</paramtype></parameter>
</signature>
<signature>
<template>
<template-type-parameter name="T1"/>
<template-type-parameter name="T2"/>
<template-varargs/>
<template-type-parameter name="TN"/>
<template-type-parameter name="Allocator1"/>
<template-type-parameter name="U1"/>
<template-type-parameter name="U2"/>
<template-varargs/>
<template-type-parameter name="UN"/>
<template-type-parameter name="Allocator2"/>
</template>
<type>void</type>
<parameter name="f1"><paramtype>const <classname>functionN</classname>&lt;T1, T2, ..., TN, Allocator1&gt;&amp;</paramtype></parameter>
<parameter name="f2"><paramtype>const <classname>functionN</classname>&lt;U1, U2, ..., UN, Allocator2&gt;&amp;</paramtype></parameter>
</signature>
<returns><simpara>True when <code>f</code> stores an object of
type <code>Functor</code> and one of the following conditions applies:
<itemizedlist>
<listitem><simpara><code>g</code> is of type
<code><classname>reference_wrapper</classname>&lt;Functor&gt;</code>
and <code>f.target&lt;Functor&gt;() == g.<methodname
alt="reference_wrapper::get_pointer">get_pointer</methodname>()</code>.</simpara></listitem>
<listitem><simpara><code>g</code> is not of type
<code><classname>reference_wrapper</classname>&lt;Functor&gt;</code>
and <code>*(f.target&lt;Functor&gt;()) ==
g</code>.</simpara></listitem>
</itemizedlist>
</simpara></returns>
<notes><simpara><code><classname>functionN</classname></code>
objects are not
<conceptname>EqualityComparable</conceptname>.</simpara></notes>
<rationale><simpara>The <code>safe_bool</code> conversion
opens a loophole whereby two <code>functionN</code>
instances can be compared via <code>==</code>, although this
is not feasible to implement. The undefined <code>void
operator==</code> closes the loophole and ensures a
compile-time or link-time error.</simpara></rationale>
</overloaded-function>
<overloaded-function name="operator!=">
<signature>
<template>
<template-type-parameter name="T1"/>
<template-type-parameter name="T2"/>
<template-varargs/>
<template-type-parameter name="TN"/>
<template-type-parameter name="Allocator"/>
<template-type-parameter name="Functor"/>
</template>
<type>bool</type>
<parameter name="f"><paramtype>const <classname>functionN</classname>&lt;T1, T2, ..., TN, Allocator&gt;&amp;</paramtype></parameter>
<parameter name="g"><paramtype>Functor</paramtype></parameter>
</signature>
<signature>
<template>
<template-type-parameter name="T1"/>
<template-type-parameter name="T2"/>
<template-varargs/>
<template-type-parameter name="TN"/>
<template-type-parameter name="Allocator"/>
<template-type-parameter name="Functor"/>
</template>
<type>bool</type>
<parameter name="g"><paramtype>Functor</paramtype></parameter>
<parameter name="f"><paramtype>const <classname>functionN</classname>&lt;T1, T2, ..., TN, Allocator&gt;&amp;</paramtype></parameter>
</signature>
<signature>
<template>
<template-type-parameter name="T1"/>
<template-type-parameter name="T2"/>
<template-varargs/>
<template-type-parameter name="TN"/>
<template-type-parameter name="Allocator"/>
<template-type-parameter name="Functor"/>
</template>
<type>bool</type>
<parameter name="f"><paramtype>const <classname>functionN</classname>&lt;T1, T2, ..., TN, Allocator&gt;&amp;</paramtype></parameter>
<parameter name="g"><paramtype><classname>reference_wrapper</classname>&lt;Functor&gt;</paramtype></parameter>
</signature>
<signature>
<template>
<template-type-parameter name="T1"/>
<template-type-parameter name="T2"/>
<template-varargs/>
<template-type-parameter name="TN"/>
<template-type-parameter name="Allocator"/>
<template-type-parameter name="Functor"/>
</template>
<type>bool</type>
<parameter name="g"><paramtype><classname>reference_wrapper</classname>&lt;Functor&gt;</paramtype></parameter>
<parameter name="f"><paramtype>const <classname>functionN</classname>&lt;T1, T2, ..., TN, Allocator&gt;&amp;</paramtype></parameter>
</signature>
<signature>
<template>
<template-type-parameter name="T1"/>
<template-type-parameter name="T2"/>
<template-varargs/>
<template-type-parameter name="TN"/>
<template-type-parameter name="Allocator1"/>
<template-type-parameter name="U1"/>
<template-type-parameter name="U2"/>
<template-varargs/>
<template-type-parameter name="UN"/>
<template-type-parameter name="Allocator2"/>
</template>
<type>void</type>
<parameter name="f1"><paramtype>const <classname>functionN</classname>&lt;T1, T2, ..., TN, Allocator1&gt;&amp;</paramtype></parameter>
<parameter name="f2"><paramtype>const <classname>functionN</classname>&lt;U1, U2, ..., UN, Allocator2&gt;&amp;</paramtype></parameter>
</signature>
<returns><simpara>True when <code>f</code> does not store an
object of type <code>Functor</code> or it stores an object of
type <code>Functor</code> and one of the following conditions
applies:
<itemizedlist>
<listitem><simpara><code>g</code> is of type
<code><classname>reference_wrapper</classname>&lt;Functor&gt;</code>
and <code>f.target&lt;Functor&gt;() != g.<methodname
alt="reference_wrapper::get_pointer">get_pointer</methodname>()</code>.</simpara></listitem>
<listitem><simpara><code>g</code> is not of type
<code><classname>reference_wrapper</classname>&lt;Functor&gt;</code>
and <code>*(f.target&lt;Functor&gt;()) !=
g</code>.</simpara></listitem>
</itemizedlist>
</simpara></returns>
<notes><simpara><code><classname>functionN</classname></code>
objects are not
<conceptname>EqualityComparable</conceptname>.</simpara></notes>
<rationale><simpara>The <code>safe_bool</code> conversion
opens a loophole whereby two <code>functionN</code>
instances can be compared via <code>!=</code>, although this
is not feasible to implement. The undefined <code>void
operator!=</code> closes the loophole and ensures a
compile-time or link-time error.</simpara></rationale>
</overloaded-function>
</free-function-group>
</class>
<class name="function">
<template>
<template-type-parameter name="Signature">
<purpose>Function type R (T1, T2, ..., TN)</purpose>
</template-type-parameter>
<template-type-parameter name="Allocator">
<default><classname>std::allocator</classname>&lt;void&gt;</default>
</template-type-parameter>
</template>
<inherit access="public"><classname>functionN</classname>&lt;R, T1, T2, ..., TN, Allocator&gt;</inherit>
<purpose>A generalized function pointer that can be used for
callbacks or wrapping function objects.</purpose>
<description>
<para>Class template <classname>function</classname> is a thin
wrapper around the numbered class templates <classname
alt="functionN">function0</classname>, <classname
alt="functionN">function1</classname>, etc. It accepts a
function type with N arguments and will will derive from
<classname>functionN</classname> instantiated with the arguments
it receives.</para>
<para>The semantics of all operations in class template
<classname>function</classname> are equivalent to that of the
underlying <classname>functionN</classname> object, although
additional member functions are required to allow proper copy
construction and copy assignment of function objects.</para>
</description>
<typedef name="result_type"><type>R</type></typedef>
<typedef name="allocator_type"><type>Allocator</type></typedef>
<typedef name="argument_type">
<type>T1</type><purpose>If N == 1</purpose>
</typedef>
<typedef name="first_argument_type">
<type>T1</type>
<purpose>If N == 2</purpose>
</typedef>
<typedef name="second_argument_type">
<type>T2</type>
<purpose>If N == 2</purpose>
</typedef>
<typedef name="arg1_type"><type>T1</type></typedef>
<typedef name="arg2_type"><type>T2</type></typedef>
<typedef name="..."><type/></typedef>
<typedef name="argN_type"><type>TN</type></typedef>
<static-constant name="arity">
<type>int</type>
<default>N</default>
</static-constant>
<struct name="sig">
<template>
<template-type-parameter name="Args"/>
</template>
<purpose>
<simpara><libraryname>Lambda</libraryname> library support</simpara>
</purpose>
<typedef name="type"><type>result_type</type></typedef>
</struct>
<constructor>
<postconditions><simpara><code>this-><methodname>empty</methodname>()</code></simpara></postconditions>
<throws><simpara>Will not throw.</simpara></throws>
</constructor>
<constructor>
<parameter name="f">
<paramtype>const <classname>functionN</classname>&amp;</paramtype>
</parameter>
<postconditions><simpara>Contains a copy of the <code>f</code>'s target, if it has one, or is empty if <code>f.<methodname>empty</methodname>()</code>.</simpara></postconditions>
<throws><simpara>Will not throw unless copying the target of <code>f</code> throws.</simpara></throws>
</constructor>
<constructor>
<parameter name="f">
<paramtype>const <classname>function</classname>&amp;</paramtype>
</parameter>
<postconditions><simpara>Contains a copy of the <code>f</code>'s target, if it has one, or is empty if <code>f.<methodname>empty</methodname>()</code>.</simpara></postconditions>
<throws><simpara>Will not throw unless copying the target of <code>f</code> throws.</simpara></throws>
</constructor>
<constructor>
<template>
<template-type-parameter name="F"/>
</template>
<parameter name="f"><paramtype>F</paramtype></parameter>
<requires><simpara>F is a function object Callable from <code>this</code>.</simpara></requires>
<postconditions><simpara><code>*this</code> targets a copy of <code>f</code> if <code>f</code> is nonempty, or <code>this-&gt;<methodname>empty</methodname>()</code> if <code>f</code> is empty.</simpara></postconditions>
<throws><simpara>Will not throw when <code>f</code> is a stateless function object.</simpara></throws>
</constructor>
<destructor>
<effects><simpara>If <code>!this-><methodname>empty</methodname>()</code>, destroys the target of <code>this</code>.</simpara></effects>
</destructor>
<copy-assignment>
<parameter name="f">
<paramtype>const <classname>functionN</classname>&amp;</paramtype>
</parameter>
<postconditions><simpara><code>*this</code> targets a copy of <code>f</code>'s target, if it has one, or is empty if <code>f.<methodname>empty</methodname>()</code></simpara></postconditions>
<throws><simpara>Will not throw when the target of <code>f</code> is a stateless function object or a reference to the function object.</simpara></throws>
</copy-assignment>
<copy-assignment>
<parameter name="f">
<paramtype>const <classname>function</classname>&amp;</paramtype>
</parameter>
<postconditions><simpara><code>*this</code> targets a copy of <code>f</code>'s target, if it has one, or is empty if <code>f.<methodname>empty</methodname>()</code></simpara></postconditions>
<throws><simpara>Will not throw when the target of <code>f</code> is a stateless function object or a reference to the function object.</simpara></throws>
</copy-assignment>
<method-group name="modifiers">
<method name="swap">
<type>void</type>
<parameter name="f"><paramtype>const <classname>function</classname>&amp;</paramtype></parameter>
<effects><simpara>Interchanges the targets of <code>*this</code> and <code>f</code>.</simpara></effects>
<throws><simpara>Will not throw.</simpara></throws>
</method>
<method name="clear">
<type>void</type>
<postconditions><simpara><code>this-&gt;<methodname>empty</methodname>()</code></simpara></postconditions>
<throws><simpara>Will not throw.</simpara></throws>
</method>
</method-group>
<method-group name="capacity">
<method name="empty" cv="const">
<type>bool</type>
<returns><simpara><code>false</code> if <code>this</code> has a target, and <code>true</code> otherwise.</simpara></returns>
<throws><simpara>Will not throw.</simpara></throws>
</method>
<method name="conversion-operator" cv="const">
<type>safe_bool</type>
<returns><simpara>A <code>safe_bool</code> that evaluates <code>false</code> in a boolean context when <code>this-&gt;<methodname>empty</methodname>()</code>, and <code>true</code> otherwise.</simpara></returns>
<throws><simpara>Will not throw.</simpara></throws>
</method>
<method name="operator!" cv="const">
<type>bool</type>
<returns><simpara><code>this-&gt;<methodname>empty</methodname>()</code></simpara></returns>
<throws><simpara>Will not throw.</simpara></throws>
</method>
</method-group>
<method-group name="target access">
<overloaded-method name="target">
<signature>
<template>
<template-type-parameter name="Functor"/>
</template>
<type>Functor*</type>
</signature>
<signature cv="const">
<template>
<template-type-parameter name="Functor"/>
</template>
<type>const Functor*</type>
</signature>
<returns><simpara>If <code>this</code> stores a target of type
<code>Functor</code>, returns the address of the
target. Otherwise, returns the NULL
pointer.</simpara></returns>
<throws><simpara>Will not throw.</simpara></throws>
</overloaded-method>
</method-group>
<method-group name="invocation">
<method name="operator()" cv="const">
<type>result_type</type>
<parameter name="a1"><paramtype>arg1_type</paramtype></parameter>
<parameter name="a2"><paramtype>arg2_type</paramtype></parameter>
<parameter><paramtype>...</paramtype></parameter>
<parameter name="aN"><paramtype>argN_type</paramtype></parameter>
<effects><simpara><code>f(a1, a2, ..., aN)</code>, where <code>f</code> is the target of <code>*this</code>.</simpara></effects>
<returns><simpara>if <code>R</code> is <code>void</code>, nothing is returned; otherwise, the return value of the call to <code>f</code> is returned.</simpara></returns>
<throws><simpara><code><classname>bad_function_call</classname></code> if <code>!this-&gt;<methodname>empty</methodname>()</code>. Otherwise, may through any exception thrown by the target function <code>f</code>.</simpara></throws>
</method>
</method-group>
<free-function-group name="specialized algorithms">
<function name="swap">
<template>
<template-type-parameter name="Signature"/>
<template-type-parameter name="Allocator"/>
</template>
<type>void</type>
<parameter name="f1"><paramtype><classname>function</classname>&lt;Signature, Allocator&gt;&amp;</paramtype></parameter>
<parameter name="f2"><paramtype><classname>function</classname>&lt;Signature, Allocator&gt;&amp;</paramtype></parameter>
<effects><simpara><code>f1.<methodname>swap</methodname>(f2)</code></simpara></effects>
<throws><simpara>Will not throw.</simpara></throws>
</function>
</free-function-group>
<free-function-group name="comparison operators">
<overloaded-function name="operator==">
<signature>
<template>
<template-type-parameter name="Signature"/>
<template-type-parameter name="Allocator"/>
<template-type-parameter name="Functor"/>
</template>
<type>bool</type>
<parameter name="f"><paramtype>const <classname>function</classname>&lt;Signature, Allocator&gt;&amp;</paramtype></parameter>
<parameter name="g"><paramtype>Functor</paramtype></parameter>
</signature>
<signature>
<template>
<template-type-parameter name="Signature"/>
<template-type-parameter name="Allocator"/>
<template-type-parameter name="Functor"/>
</template>
<type>bool</type>
<parameter name="g"><paramtype>Functor</paramtype></parameter>
<parameter name="f"><paramtype>const <classname>function</classname>&lt;Signature, Allocator&gt;&amp;</paramtype></parameter>
</signature>
<signature>
<template>
<template-type-parameter name="Signature"/>
<template-type-parameter name="Allocator"/>
<template-type-parameter name="Functor"/>
</template>
<type>bool</type>
<parameter name="f"><paramtype>const <classname>function</classname>&lt;Signature, Allocator&gt;&amp;</paramtype></parameter>
<parameter name="g"><paramtype><classname>reference_wrapper</classname>&lt;Functor&gt;</paramtype></parameter>
</signature>
<signature>
<template>
<template-type-parameter name="Signature"/>
<template-type-parameter name="Allocator"/>
<template-type-parameter name="Functor"/>
</template>
<type>bool</type>
<parameter name="g"><paramtype><classname>reference_wrapper</classname>&lt;Functor&gt;</paramtype></parameter>
<parameter name="f"><paramtype>const <classname>function</classname>&lt;Signature, Allocator&gt;&amp;</paramtype></parameter>
</signature>
<signature>
<template>
<template-type-parameter name="Signature1"/>
<template-type-parameter name="Allocator1"/>
<template-type-parameter name="Signature2"/>
<template-type-parameter name="Allocator2"/>
</template>
<type>void</type>
<parameter name="f1"><paramtype>const <classname>function</classname>&lt;Signature1, Allocator1&gt;&amp;</paramtype></parameter>
<parameter name="f2"><paramtype>const <classname>function</classname>&lt;Signature2, Allocator2&gt;&amp;</paramtype></parameter>
</signature>
<returns><simpara>True when <code>f</code> stores an object of
type <code>Functor</code> and one of the following conditions applies:
<itemizedlist>
<listitem><simpara><code>g</code> is of type
<code><classname>reference_wrapper</classname>&lt;Functor&gt;</code>
and <code>f.target&lt;Functor&gt;() == g.<methodname
alt="reference_wrapper::get_pointer">get_pointer</methodname>()</code>.</simpara></listitem>
<listitem><simpara><code>g</code> is not of type
<code><classname>reference_wrapper</classname>&lt;Functor&gt;</code>
and <code>*(f.target&lt;Functor&gt;()) ==
g</code>.</simpara></listitem>
</itemizedlist>
</simpara></returns>
<notes><simpara><code><classname>function</classname></code>
objects are not
<conceptname>EqualityComparable</conceptname>.</simpara></notes>
<rationale><simpara>The <code>safe_bool</code> conversion
opens a loophole whereby two <code>function</code>
instances can be compared via <code>==</code>, although this
is not feasible to implement. The undefined <code>void
operator==</code> closes the loophole and ensures a
compile-time or link-time error.</simpara></rationale>
</overloaded-function>
<overloaded-function name="operator!=">
<signature>
<template>
<template-type-parameter name="Signature"/>
<template-type-parameter name="Allocator"/>
<template-type-parameter name="Functor"/>
</template>
<type>bool</type>
<parameter name="f"><paramtype>const <classname>function</classname>&lt;Signature, Allocator&gt;&amp;</paramtype></parameter>
<parameter name="g"><paramtype>Functor</paramtype></parameter>
</signature>
<signature>
<template>
<template-type-parameter name="Signature"/>
<template-type-parameter name="Allocator"/>
<template-type-parameter name="Functor"/>
</template>
<type>bool</type>
<parameter name="g"><paramtype>Functor</paramtype></parameter>
<parameter name="f"><paramtype>const <classname>function</classname>&lt;Signature, Allocator&gt;&amp;</paramtype></parameter>
</signature>
<signature>
<template>
<template-type-parameter name="Signature"/>
<template-type-parameter name="Allocator"/>
<template-type-parameter name="Functor"/>
</template>
<type>bool</type>
<parameter name="f"><paramtype>const <classname>function</classname>&lt;Signature, Allocator&gt;&amp;</paramtype></parameter>
<parameter name="g"><paramtype><classname>reference_wrapper</classname>&lt;Functor&gt;</paramtype></parameter>
</signature>
<signature>
<template>
<template-type-parameter name="Signature"/>
<template-type-parameter name="Allocator"/>
<template-type-parameter name="Functor"/>
</template>
<type>bool</type>
<parameter name="g"><paramtype><classname>reference_wrapper</classname>&lt;Functor&gt;</paramtype></parameter>
<parameter name="f"><paramtype>const <classname>function</classname>&lt;Signature, Allocator&gt;&amp;</paramtype></parameter>
</signature>
<signature>
<template>
<template-type-parameter name="Signature1"/>
<template-type-parameter name="Allocator1"/>
<template-type-parameter name="Signature2"/>
<template-type-parameter name="Allocator2"/>
</template>
<type>void</type>
<parameter name="f1"><paramtype>const <classname>function</classname>&lt;Signature1, Allocator1&gt;&amp;</paramtype></parameter>
<parameter name="f2"><paramtype>const <classname>function</classname>&lt;Signature2, Allocator2&gt;&amp;</paramtype></parameter>
</signature>
<returns><simpara>True when <code>f</code> does not store an
object of type <code>Functor</code> or it stores an object of
type <code>Functor</code> and one of the following conditions
applies:
<itemizedlist>
<listitem><simpara><code>g</code> is of type
<code><classname>reference_wrapper</classname>&lt;Functor&gt;</code>
and <code>f.target&lt;Functor&gt;() != g.<methodname
alt="reference_wrapper::get_pointer">get_pointer</methodname>()</code>.</simpara></listitem>
<listitem><simpara><code>g</code> is not of type
<code><classname>reference_wrapper</classname>&lt;Functor&gt;</code>
and <code>*(f.target&lt;Functor&gt;()) !=
g</code>.</simpara></listitem>
</itemizedlist>
</simpara></returns>
<notes><simpara><code><classname>function</classname></code>
objects are not
<conceptname>EqualityComparable</conceptname>.</simpara></notes>
<rationale><simpara>The <code>safe_bool</code> conversion
opens a loophole whereby two <code>function</code>
instances can be compared via <code>!=</code>, although this
is not feasible to implement. The undefined <code>void
operator!=</code> closes the loophole and ensures a
compile-time or link-time error.</simpara></rationale>
</overloaded-function>
</free-function-group>
</class>
</namespace>
</header>
</library-reference>

251
doc/tests.xml Normal file
View File

@ -0,0 +1,251 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<testsuite id="function.testsuite" last-revision="$Date$">
<run-test filename="function_test.cpp" name="lib_function_test">
<purpose><para>Test the capabilities of the <classname>boost::function</classname> class template.</para></purpose>
<if-fails><para>The <classname>boost::function</classname> class template may not be usable on your compiler. However, the library may still be usable via the <classname>boost::functionN</classname> class templates.</para></if-fails>
</run-test>
<run-test filename="function_n_test.cpp">
<purpose><para>Test the capabilities of the <classname>boost::functionN</classname> class templates.</para></purpose>
</run-test>
<run-test filename="allocator_test.cpp">
<purpose><para>Test the use of custom allocators.</para></purpose>
<if-fails><para>Allocators are ignored by the implementation.</para></if-fails>
</run-test>
<run-test filename="stateless_test.cpp">
<purpose><para>Test the optimization of stateless function objects in the Boost.Function library.</para></purpose>
<if-fails><para>The exception-safety and performance guarantees given for stateless function objects may not be met by the implementation.</para></if-fails>
</run-test>
<run-test filename="lambda_test.cpp">
<purpose><para>Test the interaction between Boost.Function and Boost.Lambda.</para></purpose>
<if-fails><para>Either Boost.Lambda does not work on the platform, or Boost.Function cannot safely be applied without the use of <functionname>boost::unlambda</functionname>.</para></if-fails>
</run-test>
<run-test filename="contains_test.cpp">
<purpose><para>Test the operation of the
<code><methodname>target</methodname></code> member function and the
equality operators.</para></purpose>
</run-test>
<compile-fail-test filename="function_test_fail1.cpp">
<purpose><para>Test the (incorrect!) use of comparisons between Boost.Function function objects.</para></purpose>
<if-fails><para>Intuitive (but incorrect!) code may compile and will give meaningless results.</para></if-fails>
</compile-fail-test>
<compile-fail-test filename="function_test_fail2.cpp">
<purpose><para>Test the use of an incompatible function object with Boost.Function</para></purpose>
<if-fails><para>Incorrect code may compile (with potentially unexpected results).</para></if-fails>
</compile-fail-test>
<compile-test filename="function_30.cpp">
<purpose><para>Test the generation of a Boost.Function function object adaptor accepting 30 arguments.</para></purpose>
<if-fails><para>The Boost.Function library may work for function object adaptors of up to 10 parameters, but will be unable to generate adaptors for an arbitrary number of parameters. Failure often indicates an error in the compiler's preprocessor.</para></if-fails>
</compile-test>
<run-test filename="function_arith_cxx98.cpp">
<source>
<![CDATA[
#include <boost/function.hpp>
#include <iostream>
]]>
<snippet name="function.tutorial.mul_ints"/>
<snippet name="function.tutorial.int_div"/>
int main()
{
<snippet name="function.tutorial.arith.cxx98"/>
<snippet name="function.tutorial.use_int_div"/>
<snippet name="function.tutorial.call_int_div"/>
<snippet name="function.tutorial.check_empty"/>
<snippet name="function.tutorial.clear"/>
<snippet name="function.tutorial.use_mul_ints"/>
return 0;
}
</source>
<purpose><para>Test the first tutorial example.</para></purpose>
</run-test>
<run-test filename="function_arith_portable.cpp">
<source>
<![CDATA[
#include <boost/function.hpp>
#include <iostream>
]]>
<snippet name="function.tutorial.mul_ints"/>
<snippet name="function.tutorial.int_div"/>
int main()
{
<snippet name="function.tutorial.arith.portable"/>
<snippet name="function.tutorial.use_int_div"/>
<snippet name="function.tutorial.call_int_div"/>
<snippet name="function.tutorial.check_empty"/>
<snippet name="function.tutorial.clear"/>
<snippet name="function.tutorial.use_mul_ints"/>
return 0;
}
</source>
<purpose><para>Test the first tutorial example.</para></purpose>
</run-test>
<run-test filename="sum_avg_cxx98.cpp">
<source>
<![CDATA[
#include <boost/function.hpp>
#include <iostream>
]]>
<snippet name="function.tutorial.sum_avg"/>
int main()
{
<snippet name="function.tutorial.sum_avg_decl.cxx98"/>
<snippet name="function.tutorial.use_sum_avg"/>
return 0;
}
</source>
<purpose><para>Test the second tutorial example.</para></purpose>
</run-test>
<run-test filename="sum_avg_portable.cpp">
<source>
<![CDATA[
#include <boost/function.hpp>
#include <iostream>
]]>
<snippet name="function.tutorial.sum_avg"/>
int main()
{
<snippet name="function.tutorial.sum_avg_decl.portable"/>
<snippet name="function.tutorial.use_sum_avg"/>
return 0;
}
</source>
<purpose><para>Test the second tutorial example.</para></purpose>
</run-test>
<run-test filename="mem_fun_cxx98.cpp">
<source>
<![CDATA[
#include <boost/function.hpp>
#include <iostream>
#include <functional>
]]>
<snippet name="function.tutorial.X"/>
int X::foo(int x) { return -x; }
int main()
{
<snippet name="function.tutorial.mem_fun.cxx98"/>
return 0;
}
</source>
<purpose><para>Test member function example from tutorial.</para></purpose>
</run-test>
<run-test filename="mem_fun_portable.cpp">
<source>
<![CDATA[
#include <boost/function.hpp>
#include <iostream>
#include <functional>
]]>
<snippet name="function.tutorial.X"/>
int X::foo(int x) { return -x; }
int main()
{
<snippet name="function.tutorial.mem_fun.portable"/>
return 0;
}
</source>
<purpose><para>Test member function example from tutorial.</para></purpose>
</run-test>
<run-test filename="std_bind_cxx98.cpp">
<source>
<![CDATA[
#include <boost/function.hpp>
#include <iostream>
#include <functional>
]]>
<snippet name="function.tutorial.X"/>
int X::foo(int x) { return -x; }
int main()
{
<snippet name="function.tutorial.std_bind.cxx98"/>
return 0;
}
</source>
<purpose><para>Test standard binders example from tutorial.</para></purpose>
</run-test>
<run-test filename="std_bind_portable.cpp">
<source>
<![CDATA[
#include <boost/function.hpp>
#include <iostream>
#include <functional>
]]>
<snippet name="function.tutorial.X"/>
int X::foo(int x) { return -x; }
int main()
{
<snippet name="function.tutorial.std_bind.portable"/>
return 0;
}
</source>
<purpose><para>Test standard binders example from tutorial.</para></purpose>
</run-test>
<run-test filename="function_ref_cxx98.cpp">
<source>
<![CDATA[
#include <boost/function.hpp>
#include <iostream>
]]>
struct stateful_type { int operator()(int) const { return 0; } };
int main()
{
<snippet name="function.tutorial.ref.cxx98"/>
return 0;
}
</source>
<purpose><para>Test <functionname>boost::ref</functionname> example from tutorial.</para></purpose>
</run-test>
<run-test filename="function_ref_portable.cpp">
<source>
<![CDATA[
#include <boost/function.hpp>
#include <iostream>
]]>
struct stateful_type { int operator()(int) const { return 0; } };
int main()
{
<snippet name="function.tutorial.ref.portable"/>
return 0;
}
</source>
<purpose><para>Test <functionname>boost::ref</functionname> example from tutorial.</para></purpose>
</run-test>
</testsuite>

357
doc/tutorial.xml Normal file
View File

@ -0,0 +1,357 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<section xmlns:xi="http://www.w3.org/2001/XInclude" id="function.tutorial"
last-revision="$Date$">
<title>Tutorial</title>
<using-namespace name="boost"/>
<para> Boost.Function has two syntactical forms: the preferred form
and the portable form. The preferred form fits more closely with the
C++ language and reduces the number of separate template parameters
that need to be considered, often improving readability; however, the
preferred form is not supported on all platforms due to compiler
bugs. The compatible form will work on all compilers supported by
Boost.Function. Consult the table below to determine which syntactic
form to use for your compiler.
<informaltable>
<tgroup cols="2" align="left">
<thead>
<row>
<entry>Preferred syntax</entry>
<entry>Portable syntax</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<itemizedlist spacing="compact">
<listitem><simpara>GNU C++ 2.95.x, 3.0.x, 3.1.x</simpara></listitem>
<listitem><simpara>Comeau C++ 4.2.45.2</simpara></listitem>
<listitem><simpara>SGI MIPSpro 7.3.0</simpara></listitem>
<listitem><simpara>Intel C++ 5.0, 6.0</simpara></listitem>
<listitem><simpara>Compaq's cxx 6.2</simpara></listitem>
<listitem><simpara>Microsoft Visual C++ 7.1</simpara></listitem>
</itemizedlist>
</entry>
<entry>
<itemizedlist spacing="compact">
<listitem><simpara><emphasis>Any compiler supporting the preferred syntax</emphasis></simpara></listitem>
<listitem><simpara>Microsoft Visual C++ 6.0, 7.0</simpara></listitem>
<listitem><simpara>Borland C++ 5.5.1</simpara></listitem>
<listitem><simpara>Sun WorkShop 6 update 2 C++ 5.3</simpara></listitem>
<listitem><simpara>Metrowerks CodeWarrior 8.1</simpara></listitem>
</itemizedlist>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<para> If your compiler does not appear in this list, please try the preferred syntax and report your results to the Boost list so that we can keep this table up-to-date.</para>
<using-class name="boost::function"/>
<section>
<title>Basic Usage</title> <para> A function wrapper is defined simply
by instantiating the <computeroutput>function</computeroutput> class
template with the desired return type and argument types, formulated
as a C++ function type. Any number of arguments may be supplied, up to
some implementation-defined limit (10 is the default maximum). The
following declares a function object wrapper
<computeroutput>f</computeroutput> that takes two
<computeroutput>int</computeroutput> parameters and returns a
<computeroutput>float</computeroutput>:
<informaltable>
<tgroup cols="2" align="left">
<thead>
<row>
<entry>Preferred syntax</entry>
<entry>Portable syntax</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<programlisting name="function.tutorial.arith.cxx98"><classname>boost::function</classname>&lt;float (int x, int y)&gt; f;</programlisting>
</entry>
<entry>
<programlisting name="function.tutorial.arith.portable"><classname alt="functionN">boost::function2</classname>&lt;float, int, int&gt; f;</programlisting>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<para> By default, function object wrappers are empty, so we can create a
function object to assign to <computeroutput>f</computeroutput>:
<programlisting name="function.tutorial.int_div">struct int_div {
float operator()(int x, int y) const { return ((float)x)/y; };
};</programlisting>
<programlisting name="function.tutorial.use_int_div">f = int_div();</programlisting>
</para>
<para> Now we can use <computeroutput>f</computeroutput> to execute
the underlying function object
<computeroutput>int_div</computeroutput>:
<programlisting name="function.tutorial.call_int_div">std::cout &lt;&lt; f(5, 3) &lt;&lt; std::endl;</programlisting>
</para>
<para> We are free to assign any compatible function object to
<computeroutput>f</computeroutput>. If
<computeroutput>int_div</computeroutput> had been declared to take two
<computeroutput>long</computeroutput> operands, the implicit
conversions would have been applied to the arguments without any user
interference. The only limit on the types of arguments is that they be
CopyConstructible, so we can even use references and arrays:
<informaltable>
<tgroup cols="1" align="left">
<thead><row><entry>Preferred syntax</entry></row></thead>
<tbody>
<row>
<entry>
<programlisting name="function.tutorial.sum_avg_decl.cxx98"><classname>boost::function</classname>&lt;void (int values[], int n, int&amp; sum, float&amp; avg)&gt; sum_avg;</programlisting>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<informaltable>
<tgroup cols="1" align="left">
<thead><row><entry>Portable syntax</entry></row></thead>
<tbody>
<row>
<entry>
<programlisting name="function.tutorial.sum_avg_decl.portable"><classname alt="functionN">boost::function4</classname>&lt;void, int*, int, int&amp;, float&amp;&gt; sum_avg;</programlisting>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<programlisting name="function.tutorial.sum_avg">void do_sum_avg(int values[], int n, int&amp; sum, float&amp; avg)
{
sum = 0;
for (int i = 0; i &lt; n; i++)
sum += values[i];
avg = (float)sum / n;
}</programlisting>
<programlisting name="function.tutorial.use_sum_avg">sum_avg = &amp;do_sum_avg;</programlisting>
</para>
<para> Invoking a function object wrapper that does not actually
contain a function object is a precondition violation, much like
trying to call through a null function pointer, and will throw a <classname>bad_function_call</classname> exception). We can check for an
empty function object wrapper by using it in a boolean context (it evaluates <computeroutput>true</computeroutput> if the wrapper is not empty) or compare it against <computeroutput>0</computeroutput>. For instance:
<programlisting name="function.tutorial.check_empty">if (f)
std::cout &lt;&lt; f(5, 3) &lt;&lt; std::endl;
else
std::cout &lt;&lt; "f has no target, so it is unsafe to call" &lt;&lt; std::endl;</programlisting>
</para>
<para> Alternatively,
<computeroutput><methodname>empty</methodname>()</computeroutput>
method will return whether or not the wrapper is empty. </para>
<para> Finally, we can clear out a function target by assigning it to <computeroutput>0</computeroutput> or by calling the <computeroutput><methodname>clear</methodname>()</computeroutput> member function, e.g.,
<programlisting name="function.tutorial.clear">f = 0;</programlisting>
</para>
</section>
<section>
<title>Free functions</title>
<para> Free function pointers can be considered singleton function objects with const function call operators, and can therefore be directly used with the function object wrappers:
<programlisting name="function.tutorial.mul_ints">float mul_ints(int x, int y) { return ((float)x) * y; }</programlisting>
<programlisting name="function.tutorial.use_mul_ints">f = &amp;mul_ints;</programlisting>
</para>
<para> Note that the <computeroutput>&amp;</computeroutput> isn't really necessary unless you happen to be using Microsoft Visual C++ version 6. </para>
</section>
<section>
<title>Member functions</title>
<para> In many systems, callbacks often call to member functions of a
particular object. This is often referred to as "argument binding",
and is beyond the scope of Boost.Function. The use of member functions
directly, however, is supported, so the following code is valid:
<programlisting name="function.tutorial.X">struct X {
int foo(int);
};</programlisting>
<informaltable>
<tgroup cols="2" align="left">
<thead>
<row>
<entry>Preferred syntax</entry>
<entry>Portable syntax</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<programlisting name="function.tutorial.mem_fun.cxx98"><classname>boost::function</classname>&lt;int (X*, int)&gt; f;
f = &amp;X::foo;
X x;
f(&amp;x, 5);</programlisting>
</entry>
<entry>
<programlisting name="function.tutorial.mem_fun.portable"><classname alt="functionN">boost::function2</classname>&lt;int, X*, int&gt; f;
f = &amp;X::foo;
X x;
f(&amp;x, 5);</programlisting>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<para> Several libraries exist that support argument binding. Three such libraries are summarized below:
<itemizedlist>
<listitem> <para><libraryname>Bind</libraryname>. This library allows binding of
arguments for any function object. It is lightweight and very
portable.</para></listitem>
<listitem> <para>The C++ Standard library. Using
<computeroutput>std::bind1st</computeroutput> and
<computeroutput>std::mem_fun</computeroutput> together one can bind
the object of a pointer-to-member function for use with
Boost.Function:
<informaltable>
<tgroup cols="2" align="left">
<thead>
<row>
<entry>Preferred syntax</entry>
<entry>Portable syntax</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<programlisting name="function.tutorial.std_bind.cxx98"> <classname>boost::function</classname>&lt;int (int)&gt; f;
X x;
f = std::bind1st(
std::mem_fun(&amp;X::foo), &amp;x);
f(5); // Call x.foo(5)</programlisting>
</entry>
<entry>
<programlisting name="function.tutorial.std_bind.portable"> <classname alt="functionN">boost::function1</classname>&lt;int, int&gt; f;
X x;
f = std::bind1st(
std::mem_fun(&amp;X::foo), &amp;x);
f(5); // Call x.foo(5)</programlisting>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
<listitem><para>The <libraryname>Lambda</libraryname> library. This library provides a powerful composition mechanism to construct function objects that uses very natural C++ syntax. Lambda requires a compiler that is reasonably conformant to the C++ standard. </para></listitem>
</itemizedlist>
</para>
</section>
<section>
<title>References to Function Objects</title> <para> In some cases it is
expensive (or semantically incorrect) to have Boost.Function clone a
function object. In such cases, it is possible to request that
Boost.Function keep only a reference to the actual function
object. This is done using the <computeroutput>ref</computeroutput>
and <computeroutput>cref</computeroutput> functions to wrap a
reference to a function object:
<informaltable>
<tgroup cols="2" align="left">
<thead>
<row>
<entry>Preferred syntax</entry>
<entry>Portable syntax</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<programlisting name="function.tutorial.ref.cxx98">stateful_type a_function_object;
<classname>boost::function</classname>&lt;int (int)&gt; f;
f = <functionname>boost::ref</functionname>(a_function_object);
<classname>boost::function</classname>&lt;int (int)&gt; f2(f);</programlisting>
</entry>
<entry>
<programlisting name="function.tutorial.ref.portable">stateful_type a_function_object;
<classname alt="functionN">boost::function1</classname>&lt;int, int&gt; f;
f = <functionname>boost::ref</functionname>(a_function_object);
<classname alt="functionN">boost::function1</classname>&lt;int, int&gt; f2(f);</programlisting>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<para> Here, <computeroutput>f</computeroutput> will not make a copy
of <computeroutput>a_function_object</computeroutput>, nor will
<computeroutput>f2</computeroutput> when it is targeted to
<computeroutput>f</computeroutput>'s reference to
<computeroutput>a_function_object</computeroutput>. Additionally, when
using references to function objects, Boost.Function will not throw
exceptions during assignment or construction.
</para>
</section>
<section>
<title>Comparing Boost.Function function objects</title>
<para>Function object wrappers can be compared via <code>==</code>
or <code>!=</code> against any function object that can be stored
within the wrapper. If the function object wrapper contains a
function object of that type, it will be compared against the given
function object (which must be
<conceptname>EqualityComparable</conceptname>). For instance:</para>
<programlisting name="function.tutorial.compare">int compute_with_X(X*, int);
f = &amp;X::foo;
assert(f == &amp;X::foo);
assert(&amp;compute_with_X != f);</programlisting>
<para>When comparing against an instance of
<code><classname>reference_wrapper</classname></code>, the address
of the object in the
<code><classname>reference_wrapper</classname></code> is compared
against the address of the object stored by the function object
wrapper:</para>
<programlisting name="function.tutorial.compare-ref">a_stateful_object so1, so2;
f = <functionname>boost::ref</functionname>(so1);
assert(f == <functionname>boost::ref</functionname>(so1));
assert(f == so1); <emphasis>// Only if a_stateful_object is <conceptname>EqualityComparable</conceptname></emphasis>
assert(f != <functionname>boost::ref</functionname>(so2));</programlisting>
</section>
</section>

View File

@ -1,15 +1,9 @@
// Boost.Function library examples
// Copyright (C) 2001 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2001-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org
@ -29,7 +23,7 @@ struct X {
int
main()
{
boost::function<int, int> f;
boost::function<int (int)> f;
X x(7);
f = std::bind1st(std::mem_fun(&X::foo), &x);

View File

@ -1,29 +1,23 @@
// Boost.Function library examples
// Copyright (C) 2001 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2001-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org
#include <iostream>
#include <boost/function.hpp>
struct int_div {
float operator()(int x, int y) const { return ((float)x)/y; };
struct int_div {
float operator()(int x, int y) const { return ((float)x)/y; };
};
int
main()
{
boost::function<float, int, int> f;
boost::function<float (int, int)> f;
f = int_div();
std::cout << f(5, 3) << std::endl; // 1.66667

View File

@ -1,15 +1,9 @@
// Boost.Function library examples
// Copyright (C) 2001 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2001-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org
@ -28,8 +22,8 @@ int
main()
{
// The second parameter should be int[], but some compilers (e.g., GCC)
// complain about this
boost::function<void, int*, int, int&, float&> sum_avg;
// complain about this
boost::function<void (int*, int, int&, float&)> sum_avg;
sum_avg = &do_sum_avg;

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2001, 2002 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2001-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org/libs/function

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2002-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org
#if !defined(BOOST_PP_IS_ITERATING)

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2002-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2002-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org
@ -21,7 +15,7 @@
# include <boost/config.hpp>
# include <boost/function/function_base.hpp>
# include <boost/mem_fn.hpp>
# include <boost/type_traits/is_same.hpp>
# include <boost/type_traits/is_integral.hpp>
# include <boost/preprocessor/enum.hpp>
# include <boost/preprocessor/enum_params.hpp>
# include <boost/preprocessor/cat.hpp>

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2002-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2002-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2002-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2002-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2002-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2002-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2002-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2002-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2002-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2002-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2002-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2002-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2002-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2002-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2002-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2002-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2002-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2002-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2002-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2002-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2002-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2002-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2001-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2001-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org
@ -20,14 +14,32 @@
#include <string>
#include <memory>
#include <new>
#include <typeinfo>
#include <boost/config.hpp>
#include <boost/assert.hpp>
#include <boost/type_traits/arithmetic_traits.hpp>
#include <boost/type_traits/is_integral.hpp>
#include <boost/type_traits/composite_traits.hpp>
#include <boost/type_traits/is_stateless.hpp>
#include <boost/ref.hpp>
#include <boost/pending/ct_if.hpp>
#include <boost/detail/workaround.hpp>
#ifndef BOOST_NO_SFINAE
# include "boost/utility/enable_if.hpp"
#else
# include "boost/mpl/bool.hpp"
#endif
// Borrowed from Boost.Python library: determines the cases where we
// need to use std::type_info::name to compare instead of operator==.
# if (defined(__GNUC__) && __GNUC__ >= 3) \
|| defined(_AIX) \
|| ( defined(__sgi) && defined(__host_mips))
# include <cstring>
# define BOOST_FUNCTION_COMPARE_TYPE_ID(X,Y) \
(std::strcmp((X).name(),(Y).name()) == 0)
# else
# define BOOST_FUNCTION_COMPARE_TYPE_ID(X,Y) ((X)==(Y))
#endif
#if defined(BOOST_MSVC) && BOOST_MSVC <= 1300 || defined(__ICL) && __ICL <= 600 || defined(__MWERKS__) && __MWERKS__ < 0x2406 && !defined(BOOST_STRICT_CONFIG)
# define BOOST_FUNCTION_TARGET_FIX(x) x
@ -44,36 +56,13 @@ namespace boost { namespace python { namespace objects {
}}}
#endif
// GCC 2.95.3 (or earlier) doesn't support enable_if
#if BOOST_WORKAROUND(__GNUC__, < 3)
# define BOOST_FUNCTION_NO_ENABLE_IF
#if defined (BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION) \
|| defined(BOOST_BCB_PARTIAL_SPECIALIZATION_BUG) \
|| !(BOOST_STRICT_CONFIG || !defined(__SUNPRO_CC) || __SUNPRO_CC > 0x540)
# define BOOST_FUNCTION_NO_FUNCTION_TYPE_SYNTAX
#endif
// MIPSpro 7.3.1.3m doesn't support enable_if
#if defined(__sgi) && defined(_COMPILER_VERSION) && _COMPILER_VERSION <= 730 && !defined(BOOST_STRICT_CONFIG)
# define BOOST_FUNCTION_NO_ENABLE_IF
#endif
// MSVC 7.0 doesn't support enable_if
#if defined(BOOST_MSVC) && BOOST_MSVC <= 1300 && !defined(BOOST_STRICT_CONFIG)
# define BOOST_FUNCTION_NO_ENABLE_IF
#endif
// Borland C++ 5.6.0 doesn't support enable_if
#if BOOST_WORKAROUND(__BORLANDC__, <= 0x562)
# define BOOST_FUNCTION_NO_ENABLE_IF
#endif
// Metrowerks 7.2 doesn't support enable_if
#if BOOST_WORKAROUND(__MWERKS__, <= 0x2407)
# define BOOST_FUNCTION_NO_ENABLE_IF
#endif
#if BOOST_WORKAROUND(__SUNPRO_CC, <= 0x540)
# define BOOST_FUNCTION_NO_ENABLE_IF
#endif
#if !defined(BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION)
#if !defined(BOOST_FUNCTION_NO_FUNCTION_TYPE_SYNTAX)
namespace boost {
#if defined(__sgi) && defined(_COMPILER_VERSION) && _COMPILER_VERSION <= 730 && !defined(BOOST_STRICT_CONFIG)
@ -164,7 +153,8 @@ namespace boost {
// The operation type to perform on the given functor/function pointer
enum functor_manager_operation_type {
clone_functor_tag,
destroy_functor_tag
destroy_functor_tag,
check_functor_type_tag
};
// Tags used to decide between different types of functions
@ -197,14 +187,31 @@ namespace boost {
// The trivial manager does nothing but return the same pointer (if we
// are cloning) or return the null pointer (if we are deleting).
inline any_pointer trivial_manager(any_pointer f,
functor_manager_operation_type op)
template<typename F>
struct trivial_manager
{
if (op == clone_functor_tag)
return f;
else
static inline any_pointer
get(any_pointer f, functor_manager_operation_type op)
{
switch (op) {
case clone_functor_tag: return f;
case destroy_functor_tag:
return make_any_pointer(reinterpret_cast<void*>(0));
case check_functor_type_tag:
{
std::type_info* t = static_cast<std::type_info*>(f.obj_ptr);
return BOOST_FUNCTION_COMPARE_TYPE_ID(typeid(F), *t)?
f
: make_any_pointer(reinterpret_cast<void*>(0));
}
}
// Clears up a warning with GCC 3.2.3
return make_any_pointer(reinterpret_cast<void*>(0));
}
}
};
/**
* The functor_manager class contains a static function "manage" which
@ -289,43 +296,81 @@ namespace boost {
static any_pointer
manage(any_pointer functor_ptr, functor_manager_operation_type op)
{
typedef typename get_function_tag<functor_type>::type tag_type;
return manager(functor_ptr, op, tag_type());
if (op == check_functor_type_tag) {
std::type_info* type =
static_cast<std::type_info*>(functor_ptr.obj_ptr);
return (BOOST_FUNCTION_COMPARE_TYPE_ID(typeid(Functor), *type)?
functor_ptr
: make_any_pointer(reinterpret_cast<void*>(0)));
}
else {
typedef typename get_function_tag<functor_type>::type tag_type;
return manager(functor_ptr, op, tag_type());
}
}
};
#ifndef BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION
template<bool cond, typename T> struct enable_if;
template<typename T> struct enable_if<true, T> { typedef T type; };
template<typename T> struct enable_if<false, T> {};
template<bool x>
struct enabled
{
template<typename T>
struct base
{
typedef T type;
};
};
template<>
struct enabled<false>
{
template<typename T>
struct base
{
};
};
template<bool Enabled, typename T>
struct enable_if : public enabled<Enabled>::template base<T>
{
};
#endif
// A type that is only used for comparisons against zero
struct useless_clear_type {};
#ifdef BOOST_NO_SFINAE
// These routines perform comparisons between a Boost.Function
// object and an arbitrary function object (when the last
// parameter is mpl::bool_<false>) or against zero (when the
// last parameter is mpl::bool_<true>). They are only necessary
// for compilers that don't support SFINAE.
template<typename Function, typename Functor>
bool
compare_equal(const Function& f, const Functor&, int, mpl::bool_<true>)
{ return f.empty(); }
template<typename Function, typename Functor>
bool
compare_not_equal(const Function& f, const Functor&, int,
mpl::bool_<true>)
{ return !f.empty(); }
template<typename Function, typename Functor>
bool
compare_equal(const Function& f, const Functor& g, long,
mpl::bool_<false>)
{
if (const Functor* fp = f.template target<Functor>())
return *fp == g;
else return false;
}
template<typename Function, typename Functor>
bool
compare_equal(const Function& f, const reference_wrapper<Functor>& g,
int, mpl::bool_<false>)
{
if (const Functor* fp = f.template target<Functor>())
return fp == g.get_pointer();
else return false;
}
template<typename Function, typename Functor>
bool
compare_not_equal(const Function& f, const Functor& g, long,
mpl::bool_<false>)
{
if (const Functor* fp = f.template target<Functor>())
return *fp != g;
else return true;
}
template<typename Function, typename Functor>
bool
compare_not_equal(const Function& f,
const reference_wrapper<Functor>& g, int,
mpl::bool_<false>)
{
if (const Functor* fp = f.template target<Functor>())
return fp != g.get_pointer();
else return true;
}
#endif // BOOST_NO_SFINAE
} // end namespace function
} // end namespace detail
@ -346,11 +391,59 @@ public:
// Is this function empty?
bool empty() const { return !manager; }
template<typename Functor>
Functor* target()
{
if (!manager) return 0;
detail::function::any_pointer result =
manager(detail::function::make_any_pointer(&typeid(Functor)),
detail::function::check_functor_type_tag);
if (!result.obj_ptr) return false;
else {
typedef typename detail::function::get_function_tag<Functor>::type tag;
return get_functor_pointer<Functor>(tag(), 0);
}
}
template<typename Functor>
const Functor* target() const
{
if (!manager) return 0;
detail::function::any_pointer result =
manager(detail::function::make_any_pointer(&typeid(Functor)),
detail::function::check_functor_type_tag);
if (!result.obj_ptr) return false;
else {
typedef typename detail::function::get_function_tag<Functor>::type tag;
return get_functor_pointer<Functor>(tag(), 0);
}
}
public: // should be protected, but GCC 2.95.3 will fail to allow access
detail::function::any_pointer (*manager)(
detail::function::any_pointer,
detail::function::functor_manager_operation_type);
detail::function::any_pointer functor;
private:
template<typename Functor>
Functor* get_functor_pointer(detail::function::function_ptr_tag, int)
{ return reinterpret_cast<Functor*>(&functor.func_ptr); }
template<typename Functor, typename Tag>
Functor* get_functor_pointer(Tag, long)
{ return static_cast<Functor*>(functor.obj_ptr); }
template<typename Functor>
const Functor*
get_functor_pointer(detail::function::function_ptr_tag, int) const
{ return reinterpret_cast<const Functor*>(&functor.func_ptr); }
template<typename Functor, typename Tag>
const Functor* get_functor_pointer(Tag, long) const
{ return static_cast<const Functor*>(functor.const_obj_ptr); }
};
/**
@ -363,16 +456,7 @@ public:
bad_function_call() : std::runtime_error("call to empty boost::function") {}
};
/* Poison comparison between Boost.Function objects (because it is
* meaningless). The comparisons would otherwise be allowed because of the
* conversion required to allow syntax such as:
* boost::function<int, int> f;
* if (f) { f(5); }
*/
void operator==(const function_base&, const function_base&);
void operator!=(const function_base&, const function_base&);
#if BOOST_WORKAROUND(BOOST_MSVC, <= 1300)
#ifndef BOOST_NO_SFINAE
inline bool operator==(const function_base& f,
detail::function::useless_clear_type*)
{
@ -405,12 +489,21 @@ namespace detail {
return f->empty();
}
#if BOOST_WORKAROUND(BOOST_MSVC, <= 1310)
inline bool has_empty_target(const void*)
{
return false;
}
#else
inline bool has_empty_target(...)
{
return false;
}
#endif
} // end namespace function
} // end namespace detail
} // end namespace boost
#undef BOOST_FUNCTION_COMPARE_TYPE_ID
#endif // BOOST_FUNCTION_BASE_HEADER

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2001-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2001-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org
@ -240,9 +234,11 @@ namespace boost {
>
class BOOST_FUNCTION_FUNCTION : public function_base
{
public:
typedef typename detail::function::function_return_type<R>::type
internal_result_type;
private:
struct clear_type {};
public:
@ -280,12 +276,12 @@ namespace boost {
// one with a default parameter.
template<typename Functor>
BOOST_FUNCTION_FUNCTION(Functor BOOST_FUNCTION_TARGET_FIX(const &) f
#ifndef BOOST_FUNCTION_NO_ENABLE_IF
,typename detail::function::enable_if<
#ifndef BOOST_NO_SFINAE
,typename enable_if_c<
(::boost::type_traits::ice_not<
(is_same<Functor, int>::value)>::value),
(is_integral<Functor>::value)>::value),
int>::type = 0
#endif // BOOST_FUNCTION_NO_ENABLE_IF
#endif // BOOST_NO_SFINAE
) :
function_base(),
invoker(0)
@ -293,7 +289,7 @@ namespace boost {
this->assign_to(f);
}
#ifndef BOOST_FUNCTION_NO_ENABLE_IF
#ifndef BOOST_NO_SFINAE
BOOST_FUNCTION_FUNCTION(clear_type*) : function_base(), invoker(0) {}
#else
BOOST_FUNCTION_FUNCTION(int zero) : function_base(), invoker(0)
@ -316,7 +312,7 @@ namespace boost {
if (this->empty())
boost::throw_exception(bad_function_call());
internal_result_type result = invoker(function_base::functor
internal_result_type result = invoker(this->functor
BOOST_FUNCTION_COMMA
BOOST_FUNCTION_ARGS);
@ -333,10 +329,10 @@ namespace boost {
// handle BOOST_FUNCTION_FUNCTION as the type of the temporary to
// construct.
template<typename Functor>
#ifndef BOOST_FUNCTION_NO_ENABLE_IF
typename detail::function::enable_if<
#ifndef BOOST_NO_SFINAE
typename enable_if_c<
(::boost::type_traits::ice_not<
(is_same<Functor, int>::value)>::value),
(is_integral<Functor>::value)>::value),
BOOST_FUNCTION_FUNCTION&>::type
#else
BOOST_FUNCTION_FUNCTION&
@ -347,7 +343,7 @@ namespace boost {
return *this;
}
#ifndef BOOST_FUNCTION_NO_ENABLE_IF
#ifndef BOOST_NO_SFINAE
BOOST_FUNCTION_FUNCTION& operator=(clear_type*)
{
this->clear();
@ -377,21 +373,20 @@ namespace boost {
if (&other == this)
return;
std::swap(function_base::manager, other.manager);
std::swap(function_base::functor, other.functor);
std::swap(this->manager, other.manager);
std::swap(this->functor, other.functor);
std::swap(invoker, other.invoker);
}
// Clear out a target, if there is one
void clear()
{
if (function_base::manager) {
if (this->manager) {
function_base::functor =
function_base::manager(function_base::functor,
detail::function::destroy_functor_tag);
this->manager(this->functor, detail::function::destroy_functor_tag);
}
function_base::manager = 0;
this->manager = 0;
invoker = 0;
}
@ -419,8 +414,8 @@ namespace boost {
{
if (!f.empty()) {
invoker = f.invoker;
function_base::manager = f.manager;
function_base::functor =
this->manager = f.manager;
this->functor =
f.manager(f.functor, detail::function::clone_functor_tag);
}
}
@ -446,10 +441,10 @@ namespace boost {
invoker_type;
invoker = &invoker_type::invoke;
function_base::manager =
this->manager =
&detail::function::functor_manager<FunctionPtr, Allocator>::manage;
function_base::functor =
function_base::manager(detail::function::make_any_pointer(
this->functor =
this->manager(detail::function::make_any_pointer(
// should be a reinterpret cast, but some compilers
// insist on giving cv-qualifiers to free functions
(void (*)())(f)
@ -479,7 +474,7 @@ namespace boost {
invoker_type;
invoker = &invoker_type::invoke;
function_base::manager = &detail::function::functor_manager<
this->manager = &detail::function::functor_manager<
FunctionObj, Allocator>::manage;
#ifndef BOOST_NO_STD_ALLOCATOR
typedef typename Allocator::template rebind<FunctionObj>::other
@ -494,7 +489,7 @@ namespace boost {
#else
FunctionObj* new_f = new FunctionObj(f);
#endif // BOOST_NO_STD_ALLOCATOR
function_base::functor =
this->functor =
detail::function::make_any_pointer(static_cast<void*>(new_f));
}
}
@ -513,9 +508,9 @@ namespace boost {
invoker_type;
invoker = &invoker_type::invoke;
function_base::manager = &detail::function::trivial_manager;
function_base::functor =
function_base::manager(
this->manager = &detail::function::trivial_manager<FunctionObj>::get;
this->functor =
this->manager(
detail::function::make_any_pointer(
const_cast<FunctionObj*>(f.get_pointer())),
detail::function::clone_functor_tag);
@ -534,8 +529,8 @@ namespace boost {
>::type
invoker_type;
invoker = &invoker_type::invoke;
function_base::manager = &detail::function::trivial_manager;
function_base::functor = detail::function::make_any_pointer(this);
this->manager = &detail::function::trivial_manager<FunctionObj>::get;
this->functor = detail::function::make_any_pointer(this);
}
typedef internal_result_type (*invoker_type)(detail::function::any_pointer
@ -561,9 +556,200 @@ namespace boost {
f1.swap(f2);
}
#if !defined (BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION) \
&& !defined(BOOST_BCB_PARTIAL_SPECIALIZATION_BUG) \
&& (BOOST_STRICT_CONFIG || !defined(__SUNPRO_CC) || __SUNPRO_CC > 0x540)
// Poison comparisons between boost::function objects of the same type.
template<typename R BOOST_FUNCTION_COMMA BOOST_FUNCTION_TEMPLATE_PARMS ,
typename Allocator>
void operator==(const BOOST_FUNCTION_FUNCTION<
R BOOST_FUNCTION_COMMA
BOOST_FUNCTION_TEMPLATE_ARGS ,
Allocator>&,
const BOOST_FUNCTION_FUNCTION<
R BOOST_FUNCTION_COMMA
BOOST_FUNCTION_TEMPLATE_ARGS ,
Allocator>&);
template<typename R BOOST_FUNCTION_COMMA BOOST_FUNCTION_TEMPLATE_PARMS ,
typename Allocator>
void operator!=(const BOOST_FUNCTION_FUNCTION<
R BOOST_FUNCTION_COMMA
BOOST_FUNCTION_TEMPLATE_ARGS ,
Allocator>&,
const BOOST_FUNCTION_FUNCTION<
R BOOST_FUNCTION_COMMA
BOOST_FUNCTION_TEMPLATE_ARGS ,
Allocator>&);
#ifdef BOOST_NO_SFINAE
// Comparisons between boost::function objects and arbitrary function objects
template<typename R BOOST_FUNCTION_COMMA BOOST_FUNCTION_TEMPLATE_PARMS ,
typename Allocator, typename Functor>
inline bool
operator==(const BOOST_FUNCTION_FUNCTION<
R BOOST_FUNCTION_COMMA
BOOST_FUNCTION_TEMPLATE_ARGS ,
Allocator>& f,
Functor g)
{
typedef mpl::bool_<(is_integral<Functor>::value)> integral;
return detail::function::compare_equal(f, g, 0, integral());
}
template<typename R BOOST_FUNCTION_COMMA BOOST_FUNCTION_TEMPLATE_PARMS ,
typename Allocator, typename Functor>
inline bool
operator==(Functor g,
const BOOST_FUNCTION_FUNCTION<
R BOOST_FUNCTION_COMMA
BOOST_FUNCTION_TEMPLATE_ARGS ,
Allocator>& f)
{
typedef mpl::bool_<(is_integral<Functor>::value)> integral;
return detail::function::compare_equal(f, g, 0, integral());
}
template<typename R BOOST_FUNCTION_COMMA BOOST_FUNCTION_TEMPLATE_PARMS ,
typename Allocator, typename Functor>
inline bool
operator!=(const BOOST_FUNCTION_FUNCTION<
R BOOST_FUNCTION_COMMA
BOOST_FUNCTION_TEMPLATE_ARGS ,
Allocator>& f,
Functor g)
{
typedef mpl::bool_<(is_integral<Functor>::value)> integral;
return detail::function::compare_not_equal(f, g, 0, integral());
}
template<typename R BOOST_FUNCTION_COMMA BOOST_FUNCTION_TEMPLATE_PARMS ,
typename Allocator, typename Functor>
inline bool
operator!=(Functor g,
const BOOST_FUNCTION_FUNCTION<
R BOOST_FUNCTION_COMMA
BOOST_FUNCTION_TEMPLATE_ARGS ,
Allocator>& f)
{
typedef mpl::bool_<(is_integral<Functor>::value)> integral;
return detail::function::compare_not_equal(f, g, 0, integral());
}
#else
#define BOOST_FUNCTION_ENABLE_IF_NOT_INTEGRAL(Functor,Type) \
typename enable_if_c<(::boost::type_traits::ice_not< \
(is_integral<Functor>::value)>::value), \
Type>::type
// Comparisons between boost::function objects and arbitrary function objects
template<typename R BOOST_FUNCTION_COMMA BOOST_FUNCTION_TEMPLATE_PARMS ,
typename Allocator, typename Functor>
BOOST_FUNCTION_ENABLE_IF_NOT_INTEGRAL(Functor, bool)
operator==(const BOOST_FUNCTION_FUNCTION<
R BOOST_FUNCTION_COMMA
BOOST_FUNCTION_TEMPLATE_ARGS ,
Allocator>& f,
Functor g)
{
if (const Functor* fp = f.template target<Functor>()) return *fp == g;
else return false;
}
template<typename R BOOST_FUNCTION_COMMA BOOST_FUNCTION_TEMPLATE_PARMS ,
typename Allocator, typename Functor>
BOOST_FUNCTION_ENABLE_IF_NOT_INTEGRAL(Functor, bool)
operator==(Functor g,
const BOOST_FUNCTION_FUNCTION<
R BOOST_FUNCTION_COMMA
BOOST_FUNCTION_TEMPLATE_ARGS ,
Allocator>& f)
{
if (const Functor* fp = f.template target<Functor>()) return g == *fp;
else return false;
}
template<typename R BOOST_FUNCTION_COMMA BOOST_FUNCTION_TEMPLATE_PARMS ,
typename Allocator, typename Functor>
BOOST_FUNCTION_ENABLE_IF_NOT_INTEGRAL(Functor, bool)
operator!=(const BOOST_FUNCTION_FUNCTION<
R BOOST_FUNCTION_COMMA
BOOST_FUNCTION_TEMPLATE_ARGS ,
Allocator>& f,
Functor g)
{
if (const Functor* fp = f.template target<Functor>()) return *fp != g;
else return true;
}
template<typename R BOOST_FUNCTION_COMMA BOOST_FUNCTION_TEMPLATE_PARMS ,
typename Allocator, typename Functor>
BOOST_FUNCTION_ENABLE_IF_NOT_INTEGRAL(Functor, bool)
operator!=(Functor g,
const BOOST_FUNCTION_FUNCTION<
R BOOST_FUNCTION_COMMA
BOOST_FUNCTION_TEMPLATE_ARGS ,
Allocator>& f)
{
if (const Functor* fp = f.template target<Functor>()) return g != *fp;
else return true;
}
template<typename R BOOST_FUNCTION_COMMA BOOST_FUNCTION_TEMPLATE_PARMS ,
typename Allocator, typename Functor>
BOOST_FUNCTION_ENABLE_IF_NOT_INTEGRAL(Functor, bool)
operator==(const BOOST_FUNCTION_FUNCTION<
R BOOST_FUNCTION_COMMA
BOOST_FUNCTION_TEMPLATE_ARGS ,
Allocator>& f,
reference_wrapper<Functor> g)
{
if (const Functor* fp = f.template target<Functor>())
return fp == g.get_pointer();
else return false;
}
template<typename R BOOST_FUNCTION_COMMA BOOST_FUNCTION_TEMPLATE_PARMS ,
typename Allocator, typename Functor>
BOOST_FUNCTION_ENABLE_IF_NOT_INTEGRAL(Functor, bool)
operator==(reference_wrapper<Functor> g,
const BOOST_FUNCTION_FUNCTION<
R BOOST_FUNCTION_COMMA
BOOST_FUNCTION_TEMPLATE_ARGS ,
Allocator>& f)
{
if (const Functor* fp = f.template target<Functor>())
return g.get_pointer() == fp;
else return false;
}
template<typename R BOOST_FUNCTION_COMMA BOOST_FUNCTION_TEMPLATE_PARMS ,
typename Allocator, typename Functor>
BOOST_FUNCTION_ENABLE_IF_NOT_INTEGRAL(Functor, bool)
operator!=(const BOOST_FUNCTION_FUNCTION<
R BOOST_FUNCTION_COMMA
BOOST_FUNCTION_TEMPLATE_ARGS ,
Allocator>& f,
reference_wrapper<Functor> g)
{
if (const Functor* fp = f.template target<Functor>())
return fp != g.get_pointer();
else return true;
}
template<typename R BOOST_FUNCTION_COMMA BOOST_FUNCTION_TEMPLATE_PARMS ,
typename Allocator, typename Functor>
BOOST_FUNCTION_ENABLE_IF_NOT_INTEGRAL(Functor, bool)
operator!=(reference_wrapper<Functor> g,
const BOOST_FUNCTION_FUNCTION<
R BOOST_FUNCTION_COMMA
BOOST_FUNCTION_TEMPLATE_ARGS ,
Allocator>& f)
{
if (const Functor* fp = f.template target<Functor>())
return g.get_pointer() != fp;
else return true;
}
#undef BOOST_FUNCTION_ENABLE_IF_NOT_INTEGRAL
#endif // Compiler supporting SFINAE
#if !defined(BOOST_FUNCTION_NO_FUNCTION_TYPE_SYNTAX)
#if BOOST_FUNCTION_NUM_ARGS == 0
#define BOOST_FUNCTION_PARTIAL_SPEC R (void)
@ -591,10 +777,10 @@ public:
template<typename Functor>
function(Functor f
#ifndef BOOST_FUNCTION_NO_ENABLE_IF
,typename detail::function::enable_if<
#ifndef BOOST_NO_SFINAE
,typename enable_if_c<
(::boost::type_traits::ice_not<
(is_same<Functor, int>::value)>::value),
(is_integral<Functor>::value)>::value),
int>::type = 0
#endif
) :
@ -602,7 +788,7 @@ public:
{
}
#ifndef BOOST_FUNCTION_NO_ENABLE_IF
#ifndef BOOST_NO_SFINAE
function(clear_type*) : base_type() {}
#endif
@ -617,10 +803,10 @@ public:
}
template<typename Functor>
#ifndef BOOST_FUNCTION_NO_ENABLE_IF
typename detail::function::enable_if<
#ifndef BOOST_NO_SFINAE
typename enable_if_c<
(::boost::type_traits::ice_not<
(is_same<Functor, int>::value)>::value),
(is_integral<Functor>::value)>::value),
self_type&>::type
#else
self_type&
@ -631,7 +817,7 @@ public:
return *this;
}
#ifndef BOOST_FUNCTION_NO_ENABLE_IF
#ifndef BOOST_NO_SFINAE
self_type& operator=(clear_type*)
{
this->clear();

View File

@ -2,16 +2,10 @@
#
# Boost.Function library
#
# Copyright (C) 2001-2003 Doug Gregor (gregod@cs.rpi.edu)
#
# Permission to copy, use, sell and distribute this software is granted
# provided this copyright notice appears in all copies.
# Permission to modify the code and to distribute modified code is granted
# provided this copyright notice appears in all copies, and a notice
# that the code was modified is included with the copyright notice.
#
# This software is provided "as is" without express or implied warranty,
# and with no claim as to its suitability for any purpose.
# Copyright Doug Gregor 2001-2003. Use, modification and
# distribution is subject to the Boost Software License, Version
# 1.0. (See accompanying file LICENSE_1_0.txt or copy at
# http://www.boost.org/LICENSE_1_0.txt)
#
# For more information, see http://www.boost.org
use English;

View File

@ -2,13 +2,9 @@
# Copyright (C) 2001-2003 Douglas Gregor
# Permission to copy, use, sell and distribute this software is granted
# provided this copyright notice appears in all copies. Permission to modify
# the code and to distribute modified code is granted provided this copyright
# notice appears in all copies, and a notice that the code was modified is
# included with the copyright notice. This software is provided "as is"
# without express or implied warranty, and with no claim as to its suitability
# for any purpose.
# Use, modification and distribution is subject to the Boost Software License,
# Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
# http://www.boost.org/LICENSE_1_0.txt)
# For more information, see http://www.boost.org/
@ -33,11 +29,11 @@ DEPENDS all : test ;
[ run libs/function/test/function_n_test.cpp : : : : ]
[ run libs/function/test/allocator_test.cpp <lib>../../../libs/test/build/boost_test_exec_monitor : : : : ]
[ run libs/function/test/allocator_test.cpp : : : : ]
[ run libs/function/test/stateless_test.cpp <lib>../../../libs/test/build/boost_test_exec_monitor : : : : ]
[ run libs/function/test/stateless_test.cpp : : : : ]
[ run libs/function/test/lambda_test.cpp <lib>../../../libs/test/build/boost_test_exec_monitor : : : : ]
[ run libs/function/test/lambda_test.cpp : : : : ]
[ compile-fail libs/function/test/function_test_fail1.cpp : : : : ]
@ -64,6 +60,8 @@ DEPENDS all : test ;
[ run libs/function/test/function_ref_cxx98.cpp : : : : ]
[ run libs/function/test/function_ref_portable.cpp : : : : ]
[ run libs/function/test/contains_test.cpp : : : : ]
;
}

58
test/Jamfile.v2 Normal file
View File

@ -0,0 +1,58 @@
# Function library
# Copyright Doug Gregor 2001-2003. Use, modification and
# distribution is subject to the Boost Software License, Version
# 1.0. (See accompanying file LICENSE_1_0.txt or copy at
# http://www.boost.org/LICENSE_1_0.txt)
# For more information, see http://www.boost.org/
project
: source-location $(BOOST_ROOT)
;
# bring in rules for testing
import testing ;
{
test-suite function
:
[ run libs/function/test/function_test.cpp : : : : lib_function_test ]
[ run libs/function/test/function_n_test.cpp : : : : ]
[ run libs/function/test/allocator_test.cpp ../../../libs/test/build//boost_test_exec_monitor : : : : ]
[ run libs/function/test/stateless_test.cpp ../../../libs/test/build//boost_test_exec_monitor : : : : ]
[ run libs/function/test/lambda_test.cpp ../../../libs/test/build//boost_test_exec_monitor : : : : ]
[ compile-fail libs/function/test/function_test_fail1.cpp : : : : ]
[ compile-fail libs/function/test/function_test_fail2.cpp : : : : ]
[ compile libs/function/test/function_30.cpp : : : : ]
[ run libs/function/test/function_arith_cxx98.cpp : : : : ]
[ run libs/function/test/function_arith_portable.cpp : : : : ]
[ run libs/function/test/sum_avg_cxx98.cpp : : : : ]
[ run libs/function/test/sum_avg_portable.cpp : : : : ]
[ run libs/function/test/mem_fun_cxx98.cpp : : : : ]
[ run libs/function/test/mem_fun_portable.cpp : : : : ]
[ run libs/function/test/std_bind_cxx98.cpp : : : : ]
[ run libs/function/test/std_bind_portable.cpp : : : : ]
[ run libs/function/test/function_ref_cxx98.cpp : : : : ]
[ run libs/function/test/function_ref_portable.cpp : : : : ]
;
}

View File

@ -1,20 +1,13 @@
// Boost.Function library
// Copyright (C) 2001 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2001-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org
#define BOOST_INCLUDE_MAIN
#include <boost/test/test_tools.hpp>
#include <boost/test/minimal.hpp>
#include <cassert>
#include <functional>
#include <boost/function.hpp>
@ -34,7 +27,7 @@ struct counting_allocator : public std::allocator<T>
typedef counting_allocator<U> other;
};
T* allocate(std::size_t n)
{
alloc_count++;
@ -60,7 +53,7 @@ static void do_nothing() {}
int
test_main(int, char*[])
{
function2<int, int, int, counting_allocator<int> > f;
function2<int, int, int, counting_allocator<int> > f;
f = plus<int>();
f.clear();
BOOST_TEST(alloc_count == 1);
@ -78,7 +71,7 @@ test_main(int, char*[])
fv.clear();
BOOST_TEST(alloc_count == 1);
BOOST_TEST(dealloc_count == 1);
alloc_count = 0;
dealloc_count = 0;
fv = &do_nothing;

154
test/contains_test.cpp Normal file
View File

@ -0,0 +1,154 @@
// Boost.Function library
// Copyright Doug Gregor 2004. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
#include <boost/test/minimal.hpp>
#include <boost/function.hpp>
#include <boost/ref.hpp>
static int forty_two() { return 42; }
struct Seventeen
{
int operator()() const { return 17; }
};
struct ReturnInt
{
explicit ReturnInt(int value) : value(value) {}
int operator()() const { return value; }
int value;
};
bool operator==(const ReturnInt& x, const ReturnInt& y)
{ return x.value == y.value; }
bool operator!=(const ReturnInt& x, const ReturnInt& y)
{ return x.value != y.value; }
static void target_test()
{
boost::function0<int> f;
f = &forty_two;
BOOST_TEST(*f.target<int (*)()>() == &forty_two);
BOOST_TEST(!f.target<Seventeen>());
f = Seventeen();
BOOST_TEST(!f.target<int (*)()>());
BOOST_TEST(f.target<Seventeen>());
Seventeen this_seventeen;
f = boost::ref(this_seventeen);
BOOST_TEST(!f.target<int (*)()>());
BOOST_TEST(f.target<Seventeen>());
BOOST_TEST(f.target<Seventeen>() == &this_seventeen);
}
static void equal_test()
{
boost::function0<int> f;
f = &forty_two;
BOOST_TEST(f == &forty_two);
BOOST_TEST(&forty_two == f);
BOOST_TEST(f != ReturnInt(17));
BOOST_TEST(ReturnInt(17) != f);
f = ReturnInt(17);
BOOST_TEST(f != &forty_two);
BOOST_TEST(&forty_two != f);
BOOST_TEST(f == ReturnInt(17));
BOOST_TEST(ReturnInt(17) == f);
BOOST_TEST(f != ReturnInt(16));
BOOST_TEST(ReturnInt(16) != f);
#if !defined(BOOST_FUNCTION_NO_FUNCTION_TYPE_SYNTAX)
boost::function<int(void)> g;
g = &forty_two;
BOOST_TEST(g == &forty_two);
BOOST_TEST(&forty_two == g);
BOOST_TEST(g != ReturnInt(17));
BOOST_TEST(ReturnInt(17) != g);
g = ReturnInt(17);
BOOST_TEST(g != &forty_two);
BOOST_TEST(&forty_two != g);
BOOST_TEST(g == ReturnInt(17));
BOOST_TEST(ReturnInt(17) == g);
BOOST_TEST(g != ReturnInt(16));
BOOST_TEST(ReturnInt(16) != g);
#endif
}
static void ref_equal_test()
{
{
ReturnInt ri(17);
boost::function0<int> f = boost::ref(ri);
// References and values are equal
BOOST_TEST(f == boost::ref(ri));
BOOST_TEST(f == ri);
BOOST_TEST(boost::ref(ri) == f);
BOOST_TEST(ri == f);
BOOST_TEST(!(f != boost::ref(ri)));
BOOST_TEST(!(f != ri));
BOOST_TEST(!(boost::ref(ri) != f));
BOOST_TEST(!(ri != f));
// Values equal, references inequal
ReturnInt ri2(17);
BOOST_TEST(f == ri2);
BOOST_TEST(f != boost::ref(ri2));
BOOST_TEST(ri2 == f);
BOOST_TEST(boost::ref(ri2) != f);
BOOST_TEST(!(f != ri2));
BOOST_TEST(!(f == boost::ref(ri2)));
BOOST_TEST(!(ri2 != f));
BOOST_TEST(!(boost::ref(ri2) == f));
}
#if !defined(BOOST_FUNCTION_NO_FUNCTION_TYPE_SYNTAX)
{
ReturnInt ri(17);
boost::function<int(void)> f = boost::ref(ri);
// References and values are equal
BOOST_TEST(f == boost::ref(ri));
BOOST_TEST(f == ri);
BOOST_TEST(boost::ref(ri) == f);
BOOST_TEST(ri == f);
BOOST_TEST(!(f != boost::ref(ri)));
BOOST_TEST(!(f != ri));
BOOST_TEST(!(boost::ref(ri) != f));
BOOST_TEST(!(ri != f));
// Values equal, references inequal
ReturnInt ri2(17);
BOOST_TEST(f == ri2);
BOOST_TEST(f != boost::ref(ri2));
BOOST_TEST(ri2 == f);
BOOST_TEST(boost::ref(ri2) != f);
BOOST_TEST(!(f != ri2));
BOOST_TEST(!(f == boost::ref(ri2)));
BOOST_TEST(!(ri2 != f));
BOOST_TEST(!(boost::ref(ri2) == f));
}
#endif
}
int test_main(int, char*[])
{
target_test();
equal_test();
ref_equal_test();
return 0;
}

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2002-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2002-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org

View File

@ -2,13 +2,9 @@
// Copyright (C) 2001-2003 Douglas Gregor
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies. Permission to modify
// the code and to distribute modified code is granted provided this copyright
// notice appears in all copies, and a notice that the code was modified is
// included with the copyright notice. This software is provided "as is"
// without express or implied warranty, and with no claim as to its
// suitability for any purpose.
// Use, modification and distribution is subject to the Boost Software
// License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org/

View File

@ -2,13 +2,9 @@
// Copyright (C) 2001-2003 Douglas Gregor
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies. Permission to modify
// the code and to distribute modified code is granted provided this copyright
// notice appears in all copies, and a notice that the code was modified is
// included with the copyright notice. This software is provided "as is"
// without express or implied warranty, and with no claim as to its
// suitability for any purpose.
// Use, modification and distribution is subject to the Boost Software
// License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org/

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2001, 2002 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2001-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org
@ -57,8 +51,8 @@ test_zero_args()
{
typedef function0<void> func_void_type;
write_five_obj five;
write_three_obj three;
write_five_obj five = write_five_obj(); // Initialization for Borland C++ 5.5
write_three_obj three = write_three_obj(); // Ditto
// Default construction
func_void_type v1;
@ -478,7 +472,8 @@ test_zero_args()
BOOST_TEST(global_int == 5);
// Const vs. non-const
write_const_1_nonconst_2 one_or_two;
// Initialization for Borland C++ 5.5
write_const_1_nonconst_2 one_or_two = write_const_1_nonconst_2();
const function0<void> v7(one_or_two);
function0<void> v8(one_or_two);
@ -501,9 +496,9 @@ test_zero_args()
// Test return values
typedef function0<int> func_int_type;
generate_five_obj gen_five;
generate_three_obj gen_three;
// Initialization for Borland C++ 5.5
generate_five_obj gen_five = generate_five_obj();
generate_three_obj gen_three = generate_three_obj();
func_int_type i0(gen_five);
BOOST_TEST(i0() == 5);
@ -536,7 +531,7 @@ test_zero_args()
static void
test_one_arg()
{
negate<int> neg;
negate<int> neg = negate<int>(); // Initialization for Borland C++ 5.5
function1<int, int> f1(neg);
BOOST_TEST(f1(5) == -5);

View File

@ -2,13 +2,9 @@
// Copyright (C) 2001-2003 Douglas Gregor
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies. Permission to modify
// the code and to distribute modified code is granted provided this copyright
// notice appears in all copies, and a notice that the code was modified is
// included with the copyright notice. This software is provided "as is"
// without express or implied warranty, and with no claim as to its
// suitability for any purpose.
// Use, modification and distribution is subject to the Boost Software
// License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org/

View File

@ -2,13 +2,9 @@
// Copyright (C) 2001-2003 Douglas Gregor
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies. Permission to modify
// the code and to distribute modified code is granted provided this copyright
// notice appears in all copies, and a notice that the code was modified is
// included with the copyright notice. This software is provided "as is"
// without express or implied warranty, and with no claim as to its
// suitability for any purpose.
// Use, modification and distribution is subject to the Boost Software
// License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org/

View File

@ -1,15 +1,9 @@
// Boost.Function library
// Copyright (C) 2001, 2002 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2001-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org

View File

@ -1,20 +1,13 @@
// Boost.Function library
// Copyright (C) 2001 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2001-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org
#define BOOST_INCLUDE_MAIN
#include <boost/test/test_tools.hpp>
#include <boost/test/minimal.hpp>
#include <boost/function.hpp>
using namespace std;

View File

@ -1,20 +1,13 @@
// Boost.Function library
// Copyright (C) 2001 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2001-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org
#define BOOST_INCLUDE_MAIN
#include <boost/test/test_tools.hpp>
#include <boost/test/minimal.hpp>
#include <boost/function.hpp>
using namespace std;

View File

@ -1,22 +1,16 @@
// Boost.Function library
// Copyright (C) 2002-2003 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2002-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org
#include <iostream>
#include <cstdlib>
#include <boost/test/test_tools.hpp>
#include <boost/test/minimal.hpp>
#include <boost/lambda/lambda.hpp>
#include <boost/lambda/bind.hpp>
#include <boost/function.hpp>

View File

@ -2,13 +2,9 @@
// Copyright (C) 2001-2003 Douglas Gregor
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies. Permission to modify
// the code and to distribute modified code is granted provided this copyright
// notice appears in all copies, and a notice that the code was modified is
// included with the copyright notice. This software is provided "as is"
// without express or implied warranty, and with no claim as to its
// suitability for any purpose.
// Use, modification and distribution is subject to the Boost Software
// License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org/

View File

@ -2,13 +2,9 @@
// Copyright (C) 2001-2003 Douglas Gregor
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies. Permission to modify
// the code and to distribute modified code is granted provided this copyright
// notice appears in all copies, and a notice that the code was modified is
// included with the copyright notice. This software is provided "as is"
// without express or implied warranty, and with no claim as to its
// suitability for any purpose.
// Use, modification and distribution is subject to the Boost Software
// License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org/

View File

@ -1,20 +1,13 @@
// Boost.Function library
// Copyright (C) 2001 Doug Gregor (gregod@cs.rpi.edu)
//
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies.
// Permission to modify the code and to distribute modified code is granted
// provided this copyright notice appears in all copies, and a notice
// that the code was modified is included with the copyright notice.
//
// This software is provided "as is" without express or implied warranty,
// and with no claim as to its suitability for any purpose.
// Copyright Doug Gregor 2001-2003. Use, modification and
// distribution is subject to the Boost Software License, Version
// 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org
#define BOOST_INCLUDE_MAIN
#include <boost/test/test_tools.hpp>
#include <boost/test/minimal.hpp>
#include <boost/function.hpp>
#include <stdexcept>
@ -24,7 +17,6 @@ struct stateless_integer_add {
void* operator new(std::size_t, stateless_integer_add*)
{
throw std::runtime_error("Cannot allocate a stateless_integer_add");
return 0; // suppress warnings
}
void operator delete(void*, stateless_integer_add*) throw()

View File

@ -2,13 +2,9 @@
// Copyright (C) 2001-2003 Douglas Gregor
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies. Permission to modify
// the code and to distribute modified code is granted provided this copyright
// notice appears in all copies, and a notice that the code was modified is
// included with the copyright notice. This software is provided "as is"
// without express or implied warranty, and with no claim as to its
// suitability for any purpose.
// Use, modification and distribution is subject to the Boost Software
// License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org/

View File

@ -2,13 +2,9 @@
// Copyright (C) 2001-2003 Douglas Gregor
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies. Permission to modify
// the code and to distribute modified code is granted provided this copyright
// notice appears in all copies, and a notice that the code was modified is
// included with the copyright notice. This software is provided "as is"
// without express or implied warranty, and with no claim as to its
// suitability for any purpose.
// Use, modification and distribution is subject to the Boost Software
// License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org/

View File

@ -2,13 +2,9 @@
// Copyright (C) 2001-2003 Douglas Gregor
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies. Permission to modify
// the code and to distribute modified code is granted provided this copyright
// notice appears in all copies, and a notice that the code was modified is
// included with the copyright notice. This software is provided "as is"
// without express or implied warranty, and with no claim as to its
// suitability for any purpose.
// Use, modification and distribution is subject to the Boost Software
// License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org/

View File

@ -2,13 +2,9 @@
// Copyright (C) 2001-2003 Douglas Gregor
// Permission to copy, use, sell and distribute this software is granted
// provided this copyright notice appears in all copies. Permission to modify
// the code and to distribute modified code is granted provided this copyright
// notice appears in all copies, and a notice that the code was modified is
// included with the copyright notice. This software is provided "as is"
// without express or implied warranty, and with no claim as to its
// suitability for any purpose.
// Use, modification and distribution is subject to the Boost Software
// License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// For more information, see http://www.boost.org/
@ -25,7 +21,7 @@ void do_sum_avg(int values[], int n, int& sum, float& avg)
}
int main()
{
boost::function4<void, int[], int, int&, float> sum_avg;
boost::function4<void, int*, int, int&, float&> sum_avg;
sum_avg = &do_sum_avg;
return 0;