Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r77020 - in trunk/libs/local_function/doc: . html html/boost_localfunction
From: lorcaminiti_at_[hidden]
Date: 2012-02-14 19:34:29

Author: lcaminiti
Date: 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
New Revision: 77020
URL: http://svn.boost.org/trac/boost/changeset/77020

Log:
Added LocalFunction docs.
Added:
   trunk/libs/local_function/doc/Jamfile.v2 (contents, props changed)
   trunk/libs/local_function/doc/acknowledgements.qbk (contents, props changed)
   trunk/libs/local_function/doc/advanced_topics.qbk (contents, props changed)
   trunk/libs/local_function/doc/alternatives.qbk (contents, props changed)
   trunk/libs/local_function/doc/bibliography.qbk (contents, props changed)
   trunk/libs/local_function/doc/examples.qbk (contents, props changed)
   trunk/libs/local_function/doc/getting_started.qbk (contents, props changed)
   trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION.html (contents, props changed)
   trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX.html (contents, props changed)
   trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX.html (contents, props changed)
   trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION_NAME.html (contents, props changed)
   trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION_TPL.html (contents, props changed)
   trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION_TYPEOF.html (contents, props changed)
   trunk/libs/local_function/doc/html/boost_localfunction/Acknowledgments.html (contents, props changed)
   trunk/libs/local_function/doc/html/boost_localfunction/Advanced_Topics.html (contents, props changed)
   trunk/libs/local_function/doc/html/boost_localfunction/Alternatives.html (contents, props changed)
   trunk/libs/local_function/doc/html/boost_localfunction/Bibliography.html (contents, props changed)
   trunk/libs/local_function/doc/html/boost_localfunction/Examples.html (contents, props changed)
   trunk/libs/local_function/doc/html/boost_localfunction/Getting_Started.html (contents, props changed)
   trunk/libs/local_function/doc/html/boost_localfunction/Implementation.html (contents, props changed)
   trunk/libs/local_function/doc/html/boost_localfunction/No_Variadic_Macros.html (contents, props changed)
   trunk/libs/local_function/doc/html/boost_localfunction/Release_Notes.html (contents, props changed)
   trunk/libs/local_function/doc/html/boost_localfunction/Tutorial.html (contents, props changed)
   trunk/libs/local_function/doc/html/index.html (contents, props changed)
   trunk/libs/local_function/doc/html/reference.html (contents, props changed)
   trunk/libs/local_function/doc/implementation.qbk (contents, props changed)
   trunk/libs/local_function/doc/introduction.qbk (contents, props changed)
   trunk/libs/local_function/doc/local_function.qbk (contents, props changed)
   trunk/libs/local_function/doc/no_variadic_macros.qbk (contents, props changed)
   trunk/libs/local_function/doc/release_notes.qbk (contents, props changed)
   trunk/libs/local_function/doc/tutorial.qbk (contents, props changed)
Properties modified:
   trunk/libs/local_function/doc/ (props changed)
   trunk/libs/local_function/doc/html/ (props changed)

Added: trunk/libs/local_function/doc/Jamfile.v2
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/Jamfile.v2 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,43 @@
+
+# Copyright (C) 2009-2012 Lorenzo Caminiti
+# Distributed under the Boost Software License, Version 1.0
+# (see accompanying file LICENSE_1_0.txt or a copy at
+# http://www.boost.org/LICENSE_1_0.txt)
+# Home at http://www.boost.org/libs/local_function
+
+import quickbook ;
+using boostbook ;
+
+doxygen reference
+ : ../../../boost/local_function.hpp
+ ../../../boost/local_function/config.hpp
+ : <reftitle>"Reference"
+ <doxygen:param>PREDEFINED="DOXYGEN"
+ <doxygen:param>QUIET=YES
+ <doxygen:param>WARN_IF_UNDOCUMENTED=NO
+ <doxygen:param>HIDE_UNDOC_MEMBERS=YES
+ <doxygen:param>HIDE_UNDOC_CLASSES=YES
+ <doxygen:param>ALIASES=" Params=\"Parameters: <table border="0">\" Param{2}=\"<tr><td><tt>\\1</tt></td><td>\\2</td></tr>\" EndParams=\"</table>\" Returns=\"Returns:\" Note=\"Note:\" Warning=\"Warning:\" See=\"See:\" RefSect{1}=\"\\xmlonly<link linkend='boost_localfunction.\\1'>\\1</link>\\endxmlonly\" RefSectId{2}=\"\\xmlonly<link linkend='boost_localfunction.\\1'>\\2</link>\\endxmlonly\" RefClass{1}=\"\\xmlonly<computeroutput><classname alt='\\1'>\\1</classname></computeroutput>\\endxmlonly\" RefFunc{1}=\"\\xmlonly<computeroutput><functionname alt='\\1'>\\1</functionname></computeroutput>\\endxmlonly\" RefMacro{1}=\"\\xmlonly<computeroutput><macroname alt='\\1'>\\1</macroname></computeroutput>\\endxmlonly\" "
+ ;
+
+xml qbk : local_function.qbk
+ : <dependency>introduction.qbk
+ <dependency>getting_started.qbk
+ <dependency>tutorial.qbk
+ <dependency>advanced_topics.qbk
+ <dependency>examples.qbk
+ <dependency>reference
+ <dependency>alternatives.qbk
+ <dependency>no_variadic_macros.qbk
+ <dependency>implementation.qbk
+ <dependency>release_notes.qbk
+ <dependency>bibliography.qbk
+ <dependency>acknowledgements.qbk
+ ;
+
+boostbook doc : qbk
+ : <xsl:param>boost.root=../../../..
+ <xsl:param>boost.defaults=Boost
+ <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/libs/local_function/doc/html
+ ;
+

Added: trunk/libs/local_function/doc/acknowledgements.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/acknowledgements.qbk 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,35 @@
+
+[/ Copyright (C) 2009-2012 Lorenzo Caminiti ]
+[/ Distributed under the Boost Software License, Version 1.0 ]
+[/ (see accompanying file LICENSE_1_0.txt or a copy at ]
+[/ http://www.boost.org/LICENSE_1_0.txt) ]
+[/ Home at http://www.boost.org/libs/local_function ]
+
+[section:Acknowledgments Acknowledgments]
+
+This section aims to recognize the contributions of /all/ the different people that participated directly or indirectly to the design and development of this library.
+
+Many thanks to Steven Watanabe and Vicente Botet for suggesting to me to use __Boost_ScopeExit__ binding to [@http://boost.2283326.n4.nabble.com/contract-diff-n1962-tt2671482.html#none emulate local functions].
+Many thanks to Alexander Nasonov for clarifying how __Boost_ScopeExit__ binding could be used to implement local functions and for some [@http://thread.gmane.org/gmane.comp.lib.boost.devel/168612 early work] in this direction.
+
+Many thanks to Gregory Crosswhite for using an early version of this library in [@https://github.com/gcross/CodeSearch one of his projects].
+
+Thanks to David Abrahams, Vicente Botet, et al. for suggesting to provide the [@http://lists.boost.org/Archives/boost/2011/02/176712.php variadic macro syntax] on compilers that support variadic macros.
+
+Thanks to Pierre Morcello for sharing some code that experimented with implementing local functions using __Boost_ScopeExit__ binding (even if this library is not based on such a code).
+
+Thanks to John Bytheway for checking the authors' virtual functor technique that originally allowed this library to pass local functions as template parameters.
+
+Thanks to Jeffrey Lee Hellrung for suggesting the use of the "keyword" `bind` to bind variables in scope and for suggesting to use [^bind(/type/)] to optionally specify the bound variable type.
+Thanks to Vicente Botet for suggesting to provide a macro to expose the bound variable type to the public API.
+
+Thanks to Steven Watanabe, Vicente Botet, Michael Caisse, Yechezkel Mett, Joel de Guzman, Thomas Heller, et al. for helping with the __Alternatives__ section and with the profiling of the different alternatives.
+
+Many thanks to the library's [@http://lists.boost.org/boost-announce/2011/12/0340.php Boost review] manager: Jeffrey Lee Hellrung.
+Thanks also to all the people that submitted a (positive and negative) review: Andrzej Krzemienski, Edward Diener, Gregory Crosswhite, John Bytheway, Hartmut Kaiser, Krzysztof Czainski, Nat Lindon, Pierre Morcello, Thomas Heller, and Vicente J. Botet.
+Thanks to everyone else that commented (positively and negatively) on the library during its Boost review.
+
+Finally, many thanks to the entire __Boost__ community and [@http://lists.boost.org mailing list] for providing valuable comments about this library and great insights on the C++ programming language.
+
+[endsect]
+

Added: trunk/libs/local_function/doc/advanced_topics.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/advanced_topics.qbk 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,464 @@
+
+[/ Copyright (C) 2009-2012 Lorenzo Caminiti ]
+[/ Distributed under the Boost Software License, Version 1.0 ]
+[/ (see accompanying file LICENSE_1_0.txt or a copy at ]
+[/ http://www.boost.org/LICENSE_1_0.txt) ]
+[/ Home at http://www.boost.org/libs/local_function ]
+
+[section:Advanced_Topics Advanced Topics]
+
+This section illustrates advanced usages of this library (at the bottom there is also a list of known limitations of the library).
+
+[section Default Parameters]
+
+This library also allows to specify default values for the local function parameters.
+However, the usual C++ syntax for default parameters that uses the assignment symbol `=` cannot be used.
+[footnote
+*Rationale.*
+The assignment symbol `=` cannot be used to specify default parameter values because default values are not part of the parameter type so they cannot be handled using template meta-programming.
+Default parameter values need to be separated from the rest of the parameter declaration using the preprocessor.
+Specifically, this library needs to use preprocessor meta-programming to remove default values when constructing the local function type and then to count the number of default values to provide the correct set of call operators for the local functor.
+Therefore, the symbol `=` cannot be used because it cannot be handled by preprocessor meta-programming (non-alphanumeric symbols cannot be detected by preprocessor meta-programming because they cannot be concatenated by the preprocessor).
+]
+The keyword `default` is used instead:
+
+ ``[^/parameter-type parameter-name/]``, default`` [^/parameter-default-value/]``, ...
+
+For example, let's program a local function `add(x, y)` where the second parameter `y` is optional and has a default value of `2` (see also [@../../test/add_default.cpp =add_default.cpp=]):
+
+[add_default]
+
+Programmers can define a `WITH_DEFAULT` macro similar to the following if they think it improves readability over the syntax above (see also [@../../test/add_with_default.cpp =add_with_default.cpp=]):
+[footnote
+The authors do not personally find the use of the `WITH_DEFAULT` macro more readable and they prefer to use the `default` keyword directly.
+Furthermore, `WITH_DEFAULT` needs to be defined differently for compilers without variadic macros `#define WITH_DEFAULT (default)` so it can only be defined by programmers based on the syntax they decide to use.
+]
+
+[add_with_default_macro]
+[add_with_default]
+
+[endsect]
+
+[section Commas and Symbols in Macros]
+
+The C++ preprocessor does not allow commas `,` within macro parameters unless they are wrapped by round parenthesis `()` (see the __Boost_Utility_IdentityType__ documentation for details).
+Therefore, using commas within the local function parameters and bindings will generate (cryptic) preprocessor errors unless they are wrapped with an extra set of round parenthesis `()` as explained here.
+
+[note
+Also macro parameters with commas wrapped by angular parenthesis `<>` (templates, etc) or square parenthesis `[]` (multidimensional array access, etc) need to be wrapped by the extra round parenthesis `()` as explained here (this is because the preprocessor only recognizes the round parenthesis and it does not recognize angular, square, or any other type of parenthesis).
+However, macro parameters with commas which are already wrapped by round parenthesis `()` are fine (function calls, some value expressions, etc).
+]
+
+In addition, local function parameter types cannot start with non-alphanumeric symbols (alphanumeric symbols are `A-Z`, `a-z`, and `0-9`).
+[footnote
+*Rationale.*
+This limitation is because this library uses preprocessor token concatenation [^##] to inspect the macro parameters (to distinguish between function parameters, bound variables, etc) and the C++ preprocessor does not allow to concatenate non-alphanumeric tokens.
+]
+The library will generate (cryptic) preprocessor errors if a parameter type starts with a non-alphanumeric symbol.
+
+Let's consider the following example:
+
+ void BOOST_LOCAL_FUNCTION(
+ const std::map<std::string, size_t>& m, // (1) Error.
+ ::sign_t sign, // (2) Error.
+ const size_t& factor,
+ default key_sizeof<std::string, size_t>::value, // (3) Error.
+ const std::string& separator, default cat(":", " ") // (4) OK.
+ ) {
+ ...
+ } BOOST_LOCAL_FUNCTION_NAME(f)
+
+[*(1)] The parameter type `const std::map<std::string, size_t>&` contains a comma `,` after the first template parameter `std::string`.
+This comma is not wrapped by any round parenthesis `()` thus it will cause a preprocessor error.
+[footnote
+The preprocessor always interprets unwrapped commas as separating macro parameters.
+Thus in this case the comma will indicate to the preprocessor that the first macro parameter is `const std::map<std::tring`, the second macro parameter is `size_t>& m`, etc instead of passing `const std::map<std::string, size_t>& m` as a single macro parameter.
+]
+The __Boost_Utility_IdentityType__ macro `BOOST_IDENTITY_TYPE(`[^['parenthesized-type]]`)` from the header =boost/utility/identity_type.hpp= can be used to wrap a type within extra parenthesis `()` so to overcome the problem:
+
+ #include <boost/utility/identity_type.hpp>
+
+ void BOOST_LOCAL_FUNCTION(
+ BOOST_IDENTITY_TYPE((const std::map<std::string, size_t>&)) m, // OK.
+ ...
+ ) {
+ ...
+ } BOOST_LOCAL_FUNCTION_NAME(f)
+
+This macro expands to an expression that evaluates (at compile-time) exactly to the specified type.
+Note that a total of two set of parenthesis `()` are needed: The parenthesis to invoke the `BOOST_IDENTITY_TYPE(...)` macro plus the parenthesis to wrap the type expression (and therefore any comma `,` that it contains) passed as parameter to the `BOOST_IDENTITY_TYPE((...))` macro.
+Finally, the `BOOST_IDENTITY_TYPE` macro must be prefixed by the `typename` keyword `typename BOOST_IDENTITY_TYPE(`[^['parenthesized-type]]`)` when used together with the [macroref BOOST_LOCAL_FUNCTION_TPL] macro within templates.
+
+[note
+Often, there might be better ways to overcome this limitation that lead to code which is more readable than the one using the `BOOST_IDENTITY_TYPE` macro.
+]
+
+For example, in this case a `typedef` from the enclosing scope could have been used to obtain the following valid and perhaps more readable code:
+
+ typedef std::map<std::string, size_t> map_type;
+ void BOOST_LOCAL_FUNCTION(
+ const map_type& m, // OK (and more readable).
+ ...
+ ) BOOST_LOCAL_FUNCTION_NAME(f)
+
+[*(2)] The parameter type `::sign_t` starts with the non-alphanumeric symbols `::` thus it will generate preprocessor errors if used as a local function parameter type.
+The macros `BOOST_IDENTITY_TYPE` can also be used to overcome this issue:
+
+ void BOOST_LOCAL_FUNCTION(
+ ...
+ BOOST_IDENTITY_TYPE((::sign_t)) sign, // OK.
+ ...
+ ) {
+ ...
+ } BOOST_LOCAL_FUNCTION_NAME(f)
+
+[note
+Often, there might be better ways to overcome this limitation that lead to code which is more readable than the one using the `BOOST_IDENTITY_TYPE` macro.
+]
+
+For example, in this case the symbols `::` could have been simply dropped to obtain the following valid and perhaps more readable code:
+
+ void BOOST_LOCAL_FUNCTION(
+ ...
+ sign_t sign, // OK (and more readable).
+ ...
+ ) {
+ ...
+ } BOOST_LOCAL_FUNCTION_NAME(f)
+
+[*(3)] The default parameter value `key_sizeof<std::string, size_t>::value` contains a comma `,` after the first template parameter `std::string`.
+Again, this comma is not wrapped by any parenthesis `()` so it will cause a preprocessor error.
+Because this is a value expression (and not a type expression), it can be simply wrapped within an extra set of round parenthesis `()`:
+
+ void BOOST_LOCAL_FUNCTION(
+ ...
+ const size_t& factor,
+ default (key_sizeof<std::string, size_t>::value), // OK.
+ ...
+ ) {
+ ...
+ } BOOST_LOCAL_FUNCTION_NAME(f)
+
+[*(4)] The default parameter value `cat(":", " ")` is instead fine because it contains a comma `,` which is already wrapped by the parenthesis `()` of the function call `cat(...)`.
+
+Consider the following complete example (see also [@../../test/macro_commas.cpp =macro_commas.cpp=]):
+
+[macro_commas]
+
+[endsect]
+
+[section Assigning and Returning]
+
+Local functions are function objects so it is possible to assign them to other functors like __Boost_Function__ `boost::function` in order to store the local function into a variable, pass it as a parameter to another function, or return it from the enclosing function.
+
+For example (see also [@../../test/return_assign.cpp =return_assign.cpp=]):
+
+[return_assign]
+
+Note that:
+
+[important
+As with __CPP11_lambda__ functions, programmers are responsible to ensure that bound references are valid in any scope where the local function object is called.
+(This might be tricky to verify in a program when local functions are returned and called outside the local scope of their declaration.)
+]
+
+In addition, a local function can bind and call another local function.
+Local functions should always be bound by constant reference `const bind&` to avoid unnecessary copies.
+For example, the following local function `inc_sum` binds the local function `inc` so `inc_sum` can call `inc` (see aslo [@../../test/transform.cpp =transform.cpp=]):
+
+[transform]
+
+[endsect]
+
+[section Nesting]
+
+It is possible to nest local functions into one another.
+For example (see also [@../../test/nesting.cpp =nesting.cpp=]):
+
+[nesting]
+
+[endsect]
+
+[section Accessing Types (concepts, etc)]
+
+This library never requires to explicitly specify the type of bound variables.
+From within local functions, programmers can access the type of a bound variable using the following macro:
+
+ BOOST_LOCAL_FUNCTION_TYPEOF(``/bound-variable-name/``)
+
+The [macroref BOOST_LOCAL_FUNCTION_TYPEOF] macro expands to a type expression that evaluates (at compile-time) to the fully qualified type of the bound variable with the specified name.
+This type expression is fully qualified in the sense that it will be constant if the variable is bound by constant `const bind[&]` and it will also be a reference if the variable is bound by reference `[const] bind&` (if needed, programmers can remove the `const` and `&` qualifiers using `boost::remove_const` and `boost::remove_reference`, see __Boost_TypeTraits__).
+
+The deduced bound type can be used within the body to check concepts, declare local variables, etc.
+For example (see also [@../../test/typeof.cpp =typeof.cpp=] and [@../../test/addable.hpp =addable.hpp=]):
+
+[typeof]
+
+Within templates, [macroref BOOST_LOCAL_FUNCTION_TYPEOF] should not be prefixed by the `typename` keyword but eventual type manipulations need the `typename` prefix as usual (see also [@../../test/typeof_template.cpp =typeof_template.cpp=] and [@../../test/addable.hpp =addable.hpp=]):
+
+[typeof_template]
+
+It is best to use the [macroref BOOST_LOCAL_FUNCTION_TYPEOF] macro instead of using __Boost_Typeof__ so to reduce the number of times that __Boost_Typeof__ is invoked:
+
+# Either the library already internally used __Boost_Typeof__ once, in which case using this macro will not use __Boost_Typeof__ again.
+# Or, the bound variable type is explicitly specified by programmers (see below), in which case using this macro will not use __Boost_Typeof__ at all.
+
+Furthermore, within the local function body it possible to access the result type using `result_type`, the type of the first parameter using `arg1_type`, the type of the second parameter using `arg2_type`, etc.
+[footnote
+*Rationale.*
+The type names `result_type` and `arg`[^['N]]`_type` follow the __Boost_TypeTraits__ naming conventions for function traits.
+]
+
+[endsect]
+
+[section Specifying Types]
+
+While not required, it is possible to explicitly specify the type of a bound variable so the library will not internally use __Boost_Typeof__ to automatically deduce such a type.
+When specified, the bound variable type must follow the `bind` "keyword" and it must be wrapped within round parenthesis `()`:
+
+ bind(``/variable-type/``) ``/variable-name/`` // Bind by value with explicit type.
+ bind(``/variable-type/``)& ``/variable-name/`` // Bind by reference with explicit type.
+ const bind(``/variable-type/``) ``/variable-name/`` // Bind by constant value with explicit type.
+ const bind(``/variable-type/``)& ``/variable-name/`` // Bind by constant reference with explicit type.
+ bind(``/class-type/``*) this_ // Bind object `this` with explicit type.
+ const bind(``/class-type/``*) this_ // Bind object `this` by constant with explicit type.
+
+Note that within the local function body it is always possible to abstract the access to the type of a bound variable using [macroref BOOST_LOCAL_FUNCTION_TYPEOF] (even when the bound variable type is explicitly specified in the local function declaration).
+
+The library also uses __Boost_Typeof__ to determine the local function result type (because this type is specified outside the [macroref BOOST_LOCAL_FUNCTION] macro).
+Thus it is also possible to specify the local function result type as one of the [macroref BOOST_LOCAL_FUNCTION] macro parameters prefixing it by `return` so the library will not use __Boost_Typeof__ to deduce the result type:
+
+ BOOST_LOCAL_FUNCTION_TYPE(return ``[^/result-type/]``, ...)
+
+Note that the result type must be specified only once either before the macro (without the `return` prefix) or as one of the macro parameters (with the `return` prefix).
+As usual, the result type can always be `void` to declare a function returning nothing (so `return void` is allowed when the result type is specified as one of the macro parameters).
+
+The following example specifies all bound variables and result types (see also [@../../test/add_typed.cpp =add_typed.cpp=]):
+[footnote
+In the examples of this documentation, we specify bound variables, function parameters, and result type in this order because this is the order used by __CPP11_lambda__ functions.
+However, the library accepts bound variables, function parameters, and the result type in any order.
+]
+
+[add_typed]
+
+Unless necessary, it is recommended to not specify the bound variable and result types.
+Let the library deduce these types so the local function syntax will be more concise and the local function declaration will not have to change if a bound variable type changes (facilitating maintenance).
+
+[note
+Unfortunately, even when all bound variables and result types are explicitly specified, the currently library implementation still has to use __Boost_Typeof__ once (to deduce the local function object type, see the __Implementation__ section).
+]
+
+
+[endsect]
+
+[section Inlining]
+
+Local functions can be declared inline to increase the chances that the compiler will be able to reduce the run-time of the local function call by inlining the generated assembly code.
+A local function is declared inline by prefixing its name with the keyword `inline`:
+
+ ``/result-type/`` BOOST_LOCAL_FUNCTION(``/parameters/``) {
+ ... // Body.
+ } BOOST_LOCAL_FUNCTION_NAME(inline ``/name/``) // Inlining.
+
+When inlining a local function, note the following:
+
+* On __CPP03__ compliant compilers, inlined local functions always have a run-time comparable to their equivalent implementation that uses local functors (see the __Alternatives__ section).
+However, inlined local functions have the important limitation that they cannot be assigned to other functors (like `boost::function`) and they cannot be passed as template parameters.
+* On __CPP11__ compilers, `inline` has no effect because this library will automatically generate code that uses __CPP11__ specific features to inline the local function calls whenever possible even if the local function is not declared inline.
+Furthermore, non __CPP11__ local functions can always be passes as template parameters even when they are declared inline.
+[footnote
+*Rationale.*
+This library uses an indirect function call via a function pointer in order to pass the local function as a template parameter (see the __Implementation__ section).
+No compiler has yet been observed to be able to inline function calls when they use such indirect function pointer calls.
+Therefore, inlined local functions do not use such indirect function pointer call (so they are more likely to be optimized) but because of that they cannot be passed as template parameters.
+The indirect function pointer call is needed on __CPP03__ but it is not needed on __CPP11__ (see __N2657__) thus this library automatically generates local function calls that can be inlined on __CPP11__ compilers (even when the local function is not declared inline).
+]
+
+[important
+It is recommended to not declare a local function inline unless it is strictly necessary for optimizing pure __CPP03__ compliant code (because in all other cases this library will automatically take advantage of __CPP11__ features to optimize the local function calls while always allowing to pass the local function as a template parameter).
+]
+
+For example, the following local function is declared inline (thus a for-loop needs to be used for portability instead of passing the local function as a template parameter to the `std::for_each` algorithm, see also [@../../test/add_inline.cpp =add_inline.cpp=]):
+
+[add_inline]
+
+[endsect]
+
+[section Recursion]
+
+Local functions can be declared [@http://en.wikipedia.org/wiki/Recursion_(computer_science)#Recursive_procedures recursive] so a local function can recursively call itself from its body (as usual with C++ functions).
+A local function is declared recursive by prefixing its name with the "keyword" `recursive` (thus `recursive` cannot be used as a local function name):
+
+ ``/result-type/`` BOOST_LOCAL_FUNCTION(``/parameters/``) {
+ ... // Body.
+ } BOOST_LOCAL_FUNCTION_NAME(recursive ``/name/``) // Recursive.
+
+For example, the following local function is used to recursively calculate the factorials of all the numbers in the specified vector (see also [@../../test/factorial.cpp =factorial.cpp=]):
+
+[factorial]
+
+Compilers have not been observed to be able to inline recursive local function calls (not even when the recursive local function is also declared inline as in `BOOST_LOCAL_FUNCTION_NAME(inline recursive factorial)`).
+
+[warning
+Recursive local functions should never be called outside their declaration scope.
+If a local function is returned from the enclosing function and called in a different scope, the behaviour is undefined (and it will likely result in a run-time error).
+[footnote
+*Rationale.*
+This limitation comes from the fact that the global functor used to pass the local function as a template parameter (and eventually returned outside the declarations scope) does not know the local function name so the local function name used for recursive call cannot be set in the global functor.
+This limitation together with preventing the possibility for inlining are the reasons why local functions are not recursive unless programmers explicitly declare them `recursive`.
+]
+This is not a limitation with respect to __CPP11_lambda__ functions because lambdas can never call themselves recursively (in other words, there is no recursive lambda function that can successfully be called outside its declaration scope because there is no recursive lambda function at all).
+]
+
+[endsect]
+
+[section Overloading]
+
+It is possible to overload local functions using the `boost::overloaded_function` functor of __Boost_Functional_OverloadedFunction__ from the header =boost/functional/overloaded_function.hpp= (see the __Boost_Functional_OverloadedFunction__ documentation for details).
+
+In the following example, the overloaded function object `add` can be called with signatures from either the local function `add_s`, or the local function `add_d`, or the local function `add_d` with its extra default parameter, or the function pointer `add_i` (see also [@../../test/overload.cpp =overload.cpp=]):
+
+[overload]
+
+[endsect]
+
+[section Exception Specifications]
+
+It is possible to program exception specifications for local functions by specifying them after the [macroref BOOST_LOCAL_FUNCTION] macro and before the body code block `{ ... }`.
+
+[important
+Note that the exception specifications only apply to the body code specified by programmers and they do not apply to the rest of the code automatically generated by the macro expansions to implement local functions.
+For example, even if the body code is specified to throw no exception using `throw () { ... }`, the execution of the library code automatically generated by the macros could still throw (if there is no memory, etc).
+]
+
+For example (see also [@../../test/add_except.cpp =add_except.cpp=]):
+
+[add_except]
+
+[endsect]
+
+[section Storage Classifiers (`auto` and `register`)]
+
+Local function parameters support the storage classifiers as usual in __CPP03__.
+The `auto` storage classifier is specified as:
+[footnote
+The `auto` storage classifier is part of the __CPP03__ standard and therefore supported by this library.
+However, the meaning and usage of the `auto` keyword changed in __CPP11__.
+Therefore, use the `auto` storage classifier with the usual care in order to avoid writing __CPP03__ code that might not work on __CPP11__.
+]
+
+ auto ``/parameter-type parameter-name/``
+
+The `register` storage classifier is specified as:
+
+ register ``/parameter-type parameter-name/``
+
+For example (see also [@../../test/add_classifiers.cpp =add_classifiers.cpp=]):
+
+[add_classifiers]
+
+[endsect]
+
+[section Limitations (operators, etc)]
+
+The following table summarizes all C++ function features indicating those features that are not supported by this library for local functions.
+
+[table
+[
+ [ C++ Function Feature ]
+ [ Local Function Support ]
+ [ Comment ]
+]
+[
+ [ `export` ]
+ [ No ]
+ [ This is not supported because local functions cannot be templates (plus most C++ compilers do not implement `export` at all). ]
+]
+[
+ [ `template<`[^['template-parameter-list]]`>` ]
+ [ No ]
+ [ This is not supported because local functions are implemented using local classes and __CPP03__ local classes cannot be templates. ]
+]
+[
+ [ `explicit` ]
+ [ No ]
+ [ This is not supported because local functions are not constructors. ]
+]
+[
+ [ `inline` ]
+ [ Yes ]
+ [ Local functions can be specified `inline` to improve the chances that __CPP03__ standard compilers can optimize the local function call run-time (but `inline` local functions cannot be passed as template parameters on __CPP03__ standard compilers, see the __Advanced_Topics__ section). ]
+]
+[
+ [ `extern` ]
+ [ No ]
+ [ This is not supported because local functions are always defined locally within the enclosing scope and together with their declarations. ]
+]
+[
+ [ `static` ]
+ [ No ]
+ [ This is not supported because local functions are not member functions. ]
+]
+[
+ [ `virtual` ]
+ [ No ]
+ [ This is not supported because local functions are not member functions.
+[footnote
+*Rationale.*
+It would be possible to make a local function class inherit from another local function class.
+However, this "inheritance" feature is not implemented because it seemed of [@http://lists.boost.org/Archives/boost/2010/09/170895.php no use] given that local functions can be bound to one another thus they can simply call each other directly without recurring to dynamic binding or base function call.
+]
+ ]
+]
+[
+ [ [^/result-type/] ]
+ [ Yes ]
+ [ This is supported (see the __Tutorial__ section). ]
+]
+[
+ [ [^/function-name/] ]
+ [ Yes ]
+ [ Local functions are named and they can call themselves recursively but they cannot be operators (see the __Tutorial__ and __Advanced_Topics__ sections). ]
+]
+[
+ [ [^/parameter-list/] ]
+ [ Yes ]
+ [ This is supported and it also supports the `auto` and `register` storage classifiers, default parameters, and binding of variables in scope (see the __Tutorial__ and __Advanced_Topics__ sections). ]
+]
+[
+ [ Trailing `const` qualifier ]
+ [ No ]
+ [ This is not supported because local functions are not member functions. ]
+]
+[
+ [ Trailing `volatile` qualifier ]
+ [ No ]
+ [ This is not supported because local functions are not member functions. ]
+]
+]
+
+[h5 Operators]
+
+Local functions cannot be operators.
+Naming a local function `operator...` will generate a compile-time error.
+[footnote
+*Rationale.*
+This is the because a local function name must be a valid local variable name (the local variable used to hold the local functor) and operators cannot be used as local variable names.
+]
+
+For example, the following code will not compile:
+
+[operator_err]
+
+[h5 Goto]
+
+It is not possible to jump with a `goto` from within a local function to a label defined in the enclosing scope.
+
+For example, the following will not compile:
+
+[goto_err]
+
+[endsect]
+
+[endsect]
+

Added: trunk/libs/local_function/doc/alternatives.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/alternatives.qbk 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,262 @@
+
+[/ Copyright (C) 2009-2012 Lorenzo Caminiti ]
+[/ Distributed under the Boost Software License, Version 1.0 ]
+[/ (see accompanying file LICENSE_1_0.txt or a copy at ]
+[/ http://www.boost.org/LICENSE_1_0.txt) ]
+[/ Home at http://www.boost.org/libs/local_function ]
+
+[section:Alternatives Annex: Alternatives]
+
+This section compares the features offered by this library with similar features offered by C++ and by other libraries.
+
+[h5 Features]
+
+The following table compares local function features.
+
+[table
+[
+ [ Local Function Feature ]
+ [ Boost.LocalFunction ]
+ [ C++11 Lambda Function (Not C++03) ]
+ [ Local Functor ]
+ [ Global Functor (Not Local) ]
+ [ Boost.Phoenix ]
+]
+[
+ [ ['Can be defined locally] ]
+ [ Yes. ]
+ [ Yes. ]
+ [ Yes. ]
+ [ No.
+Therefore this not really an alternative implementation of local functions but it is listed here just for comparison. ]
+ [ Yes. ]
+]
+[
+ [ ['Can be defined using C++ statement syntax] ]
+ [ Yes.
+Plus eventual compiler errors and debugging follow the usual format of C++ statement errors. ]
+ [ Yes.
+Plus eventual compiler errors and debugging follow the usual format of C++ statement errors. ]
+ [ Yes.
+Plus eventual compiler errors and debugging follow the usual format of C++ statement errors. ]
+ [ Yes.
+Plus eventual compiler errors and debugging follow the usual format of C++ statement errors. ]
+ [ No (it uses C++ __expression_template__ syntax). ]
+]
+[
+ [ ['Can be defined within expressions] ]
+ [ No. It can be defined only within declarations. ]
+ [ Yes (plus the local function can be unnamed). ]
+ [ No. It can be defined only within declarations. ]
+ [ No. It can be defined only within declarations. ]
+ [ Yes (plus the local function can be unnamed). ]
+]
+[
+ [ ['Can be passed as template parameter (e.g., to STL algorithms)] ]
+ [ Yes.
+The __CPP03__ standard does not allow to pass local types as template parameters (see __N2657__) but this library implements a "trick" to get around this limitation (see the __Implementation__ section). ]
+ [ Yes. ]
+ [ No on __CPP03__ compilers (but yes on __CPP11__ compilers and some compilers like MSVC 8.0, see __N2657__). ]
+ [ Yes. ]
+ [ Yes. ]
+]
+[
+ [ ['Access variables in scope] ]
+ [ Yes.
+The variable names are repeated in the function declaration so they can be bound by value, by constant value, by reference, and by constant reference (the object `this` can also be bound). ]
+ [ Yes.
+The variable names are repeated in the function declaration (plus there is a short-hand syntax to bind all variables in scope at once) so they can be bound by constant value and by reference (the object `this` can also be bound).
+However, variables cannot be bound by constant references and non-constant value (see below). ]
+ [ No.
+Programmers must manually program functor data members and explicitly specify their types to access variables in scope. ]
+ [ No.
+Programmers must manually program functor data members and explicitly specify their types to access variables in scope. ]
+ [ Yes.
+Variables in scope are accessible as usual within expressions (plus `boost::phoenix::let` can be used to bind variables by constant reference). ]
+]
+[
+ [ ['[@http://en.wikipedia.org/wiki/Type_polymorphism#Parametric_polymorphism Polymorphic] in the unbound parameter types] ]
+ [ No (local functions cannot be function templates). ]
+ [ No (__CPP11__ lambdas cannot be function templates). ]
+ [ No (local classes cannot have member function templates). ]
+ [ Yes. ]
+ [ Yes. ]
+]
+]
+
+[*C++11 Lambda Function]
+
+__CPP11_lambda__ functions have most of the features of this library (see also the example in the __Introduction__ section):
+
+* __CPP11_lambda__ functions can be defined within expressions while this library local functions can only be defined at declaration scope.
+* __CPP11_lambda__ functions are only supported by the __CPP11__ standard so they are not supported by all C++ compilers.
+This library local functions can be programmed also on __CPP03__ compilers (and they have performances comparable to __CPP11_lambda__ functions on __CPP11__ compilers).
+* __CPP11_lambda__ functions do not allow to bind variables in scope by constant reference or by non-constant value.
+Because a variable cannot be bound by constant reference, __CPP11_lambda__ functions can bind a variable by constant only if the variable is `CopyConstructible` and the binding requires a (potentially expensive) extra copy operation.
+Both constant reference and non-constant value binding are instead supported by this library.
+However, __CPP11_lambda__ functions provide a short-hand syntax to bind all variables in scope at once (`&` or `=`).
+
+For example, for non-copyable objects (see also [@../../example/noncopyable_lambda_err.cpp =noncopyable_lambda_err.cpp=] and [@../../example/noncopyable_local_function.cpp =noncopyable_local_function.cpp=]):
+
+[table
+ [ [C++11 Lambda] [Boost.LocalFunction] ]
+ [ [[noncopyable_lambda_err]] [[noncopyable_local_function]] ]
+]
+
+Or, for objects with expensive copy operations (see also [@../../example/expensive_copy_lambda.cpp =expensive_copy_lambda.cpp=] and [@../../example/expensive_copy_local_function.cpp =expensive_copy_local_function.cpp=]):
+
+[table
+ [ [C++11 Lambda] [Boost.LocalFunction] ]
+ [ [[expensive_copy_lambda]] [[expensive_copy_local_function]] ]
+]
+
+When constant binding functionality is needed for __CPP11_lambda__ functions, the best alternative might be to bind an extra local variable declared constant and initialized to the original variable (for example, `const n& const_x = x` and then bind `const_x` instead of `x` to the lambda function).
+In many cases the use of the extra constant variable `const_x` can be acceptable but in other cases (e.g., /constant blocks/ presented in the __Examples__ section) it might be preferable to maintain the same variable name `x` within the function body.
+
+[*Local Functor]
+
+The following example compares local functions with C++ local functors (see also [@../../example/add_local_functor.cpp =add_local_functor.cpp=] and [@../../test/add.cpp =add.cpp=]):
+
+[table
+ [ [Local Functor] [Boost.LocalFunction] ]
+ [ [[add_local_functor]] [[add]] ]
+]
+
+[*Global Functor]
+
+The following example compares local functions with C++ global functors (see also [@../../example/add_global_functor.cpp =add_global_functor.cpp=] and [@../../test/add.cpp =add.cpp=]):
+
+[table
+ [ [Global Functor] [Boost.LocalFunction] ]
+ [ [[add_global_functor]] [[add]] ]
+]
+
+However, note that global functors do not allow to define the function locally so they are not a real alternative implementation of local functions.
+
+[*Boost.Phoenix]
+
+The following example compares local functions with __Boost_Phoenix__ (see also [@../../example/add_phoenix.cpp =add_phoenix.cpp=] and [@../../test/add.cpp =add.cpp=]):
+
+[table
+ [ [Boost.Phoenix] [Boost.LocalFunction] ]
+ [ [[add_phoenix]] [[add]] ]
+]
+
+The comparison in this section does not include the __Boost_Lambda__ library because that library is obsolete and it was replaced by __Boost_Phoenix__.
+The __Boost_Phoenix__ library version 3.0 is used for this comparison.
+
+[h5 Performances]
+
+The following tables compare run-times, compile-times, and binary sizes for the different alternatives presented here for local functions.
+
+Overall, this library has compile-times and generates binary sizes similar to the ones of the other approaches.
+This library run-times on __CPP03__ compilers were measured to be larger than other approaches when compiler optimization is enabled (using `bjam release ...`).
+However, on compilers that allow to pass local types as template parameters (e.g., MSVC 8.0 or GCC 4.5.3 with __CPP11__ features enabled [^-std=c++0x], see also __N2657__) this library automatically generates optimized code that runs as fast as the fastest of the other approaches (see the "Boost.LocalFunction" approach below).
+When this library local function is specified `inline` (see the "Boost.LocalFunction Inline" approach below and the __Advanced_Topics__ section) its run-times are always comparable to both the "Local Functor" and "Global Functor" approaches.
+However, in these cases the local function cannot be portably passed as template parameter (see __N2657__) so `std::for_each` is replaced by a for-loop (on MSVC the for-loop, and not the local function in fact the same applies to local functors, was measured to have worst performances than using `std::for_each`).
+Finally, this library run-times are always among the fastest when no compiler optimization is enabled (using `bjam debug ...`).
+
+[note
+The run-time performances of this library local functions are explained because on __CPP03__ compliant compilers (e.g., GCC 4.5.3 without [^-std=c++0x]) this library needs to use a function pointer in order to pass the local function class as a template parameter (see __N2657__ and the __Implementation__ section).
+For all tested compilers, this function pointer prevents the compiler optimization algorithms from inlining the local function calls.
+Instead, the functors used by other approaches (e.g., __Boost_Phoenix__) have been observed to allow all tested compilers to inline all the function calls for optimization.
+This run-time performance cost is not present on compilers that allow to pass local types as template parameters (e.g., MSVC 8.0 or GCC 4.5.3 with __CPP11__ features enabled [^-std=c++0x]) because this library does not have to use the extra function pointer to implement the local function call (it directly passes the local class type as template parameter).
+]
+
+This run-time performance cost on __CPP03__ compilers might or might not be an issue depending on the performance requirements of specific applications.
+For example, an application might already be using a number of indirect function calls (function pointers, virtual functions, etc) for which the overhead added by using the one extra function pointer required by the local function call might not be noticeable within the overall program run-time.
+
+Finally, note that only a very simple local function body with just a single instruction was used for the anaylsis presented here (see the source files below).
+The authors have not studied how this library and the other approaches will perform with respect to each other when a more complex set of instructions is programmed for the local function body (e.g., /if/ a more complex set of instructions in the local function body were to inhibit some compilers from inlining functor objects also other approaches like __Boost_Phoenix__ /could/ start to show higher run-times even when optimization is enabled).
+
+The following commands were executed from the library example directory to measure compile-time, binary size, and run-time respectively:
+
+[pre
+> touch <FILE_NAME>.cpp # force recompilation
+> python chrono.py bjam {release|debug} <FILE_NAME> # compile-time
+> size <FILE_NAME> # binary size
+> ./<FILE_NAME> # run-time
+]
+
+The local function was called =1e8= times to add together all the elements of a vector and the run-time was measured using __Boost_Chrono__ averaging over =10= executions of the vector summation (see the source files below).
+
+[table
+ [
+ [Legend]
+ [Approach]
+ [Source File]
+ ]
+ [
+ [[$../../example/profile_legend_local_function.png]]
+ [__Boost_LocalFunction__]
+ [[@../../example/profile_local_function.cpp =profile_local_function.cpp=]]
+ ]
+ [
+ [[$../../example/profile_legend_local_function_inline.png]]
+ [__Boost_LocalFunction__ inline]
+ [[@../../example/profile_local_function_inline.cpp =profile_local_function_inline.cpp=]]
+ ]
+ [
+ [[$../../example/profile_legend_lambda.png]]
+ [__CPP11__ Lambda Function
+[footnote
+Measurements available only for __CPP11__ compilers.
+]
+ ]
+ [[@../../example/profile_lambda.cpp =profile_lambda.cpp=]]
+ ]
+ [
+ [[$../../example/profile_legend_local_functor.png]]
+ [Local Functor]
+ [[@../../example/profile_local_functor.cpp =profile_local_functor.cpp=]]
+ ]
+ [
+ [[$../../example/profile_legend_global_functor.png]]
+ [Global Functor]
+ [[@../../example/profile_global_functor.cpp =profile_global_functor.cpp=]]
+ ]
+ [
+ [[$../../example/profile_legend_phoenix.png]]
+ [__Boost_Phoenix__]
+ [[@../../example/profile_phoenix.cpp =profile_phoenix.cpp=]]
+ ]
+]
+
+[table
+ [ [GCC 4.5.3 With C++11 Lambdas and "Local Types as Template Parameters" ([^bjam cxxflags=-std=c++0x ...])] ]
+ [ [
+ [*Compiled with =bjam release ...= for maximum optimization (=-O3 -finline-functions=)]
+ [$../../example/profile_gcc_cpp11_release.png [width 13in] [height 10in]]
+ ] ]
+ [ [
+ [*Compiled with =bjam debug ...= for no optimization (=-O0 -fno-inline=)]
+ [$../../example/profile_gcc_cpp11_debug.png [width 13in] [height 10in]]
+ ] ]
+]
+
+[table
+ [ [MSVC 8.0 With "Local Types as Template Parameters" (Without __CPP11__ Lambdas)] ]
+ [ [
+ [*Compiled with =bjam release ...= for maximum optimization (=/O2 /Ob2=)]
+ [$../../example/profile_msvc_release.png [width 13in] [height 10in]]
+ ] ]
+ [ [
+ [*Compiled with =bjam debug ...= for no optimization (=/Od /Ob0=)]
+ [$../../example/profile_msvc_debug.png [width 13in] [height 10in]]
+ ] ]
+]
+
+[table
+ [ [GCC 4.3.4 With __CPP03__ Only (Without __CPP11__ Lambdas and Without "Local Types as Template Parameters")] ]
+ [ [
+ [*Compiled with =bjam release ...= for maximum optimization (=-O3 -finline-functions=)]
+ [$../../example/profile_gcc_release.png [width 13in] [height 10in]]
+ ] ]
+ [ [
+ [*Compiled with =bjam debug ...= for no optimization (=-O0 -fno-inline=)]
+ [$../../example/profile_gcc_debug.png [width 13in] [height 10in]]
+ ] ]
+]
+
+[endsect]
+

Added: trunk/libs/local_function/doc/bibliography.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/bibliography.qbk 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,23 @@
+
+[/ Copyright (C) 2009-2012 Lorenzo Caminiti ]
+[/ Distributed under the Boost Software License, Version 1.0 ]
+[/ (see accompanying file LICENSE_1_0.txt or a copy at ]
+[/ http://www.boost.org/LICENSE_1_0.txt) ]
+[/ Home at http://www.boost.org/libs/local_function ]
+
+[section:Bibliography Bibliography]
+
+This section lists all the bibliographic references cited by this documentation.
+
+__N1613__ Thorsten Ottosen. /Proposal to add Design by Contract to C++./ The C++ Standards Committee, document no. N1613=04-0053, 2004.
+
+__N2511__ Alisdair Meredith. /Named Lambdas and Local Functions./ The C++ Standards Committee, document no. N2511=08-0021, 2008.
+
+__N2529__ Jaakko Jarvi, John Freeman, Lawrence Crowl. /Lambda Expressions and Closures: Wording for Monomorphic Lambdas (Revision 3)./ The C++ Standards Committee, document no. N2529=08-0039, 2008.
+
+__N2550__ Jaakko Jarvi, John Freeman, Lawrence Crowl. /Lambda Expressions and Closures: Wording for Monomorphic Lambdas (Revision 4)./ The C++ Standards Committee, document no. N2550=08-0060, 2008.
+
+__N2657__ John Spicer. /Local and Unamed Types as Template Arguments./ The C++ Standard Committee, document no. N2657=08-0167, 2008.
+
+[endsect]
+

Added: trunk/libs/local_function/doc/examples.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/examples.qbk 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,177 @@
+
+[/ Copyright (C) 2009-2012 Lorenzo Caminiti ]
+[/ Distributed under the Boost Software License, Version 1.0 ]
+[/ (see accompanying file LICENSE_1_0.txt or a copy at ]
+[/ http://www.boost.org/LICENSE_1_0.txt) ]
+[/ Home at http://www.boost.org/libs/local_function ]
+
+[section:Examples Examples]
+
+This section lists some examples that use this library.
+
+[section GCC Lambdas (Without C++11)]
+
+Combing local functions with the [@http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html statement expression] extension of GCC compilers, it is possible to implement lambda functions for GCC compilers even without __CPP11__ support.
+
+[warning
+This code only works on compilers that support the statement expression GCC extension or that support __CPP11_lambda__ functions.
+]
+
+For example (see also [@../../example/gcc_lambda.cpp =gcc_lambda.cpp=] and [@../../example/gcc_lambda_cpp11.cpp =gcc_lambda_cpp11.cpp=]):
+
+[table
+ [ [With Local Functions (GCC only)] [C++11 Lambdas] ]
+ [ [[gcc_lambda]] [[gcc_lambda_cpp11]] ]
+]
+
+Where the macros are defined in [@../../example/gcc_lambda.hpp =gcc_lambda.hpp=].
+
+This is possible because GCC statement expressions allow to use declaration statements within expressions and therefore to declare a local function within an expression.
+The macros automatically detect if the compiler supports __CPP11_lambda__ functions in which case the implementation uses native lambdas instead of local functions in statement expressions.
+However, __CPP11_lambda__ functions do not support constant binding so it is best to only use `const bind variable` (same as __CPP11_lambda__ `=variable`) and `bind& variable` (same as __CPP11_lambda__ `&variable`) because these have the exact same semantic between the local function and native lambda implementation.
+Unfortunately, the __CPP11_lambda__ short-hand binds `&` and `=` (which automatically bind all variables in scope either by reference or value) are not supported by the macros because they are not supported by the local function implementation.
+Finally, the result type `return `[^['result-type]] is optional and it is assumed `void` when it is not specified (same as with __CPP11_lambda__ functions).
+
+[endsect]
+
+[section Constant Blocks]
+
+It is possible to use local functions to check assertions between variables that are made constant within the asserted expressions.
+This is advantageous because assertions are not supposed to change the state of the program and ideally the compiler will not compile assertions that modify variables.
+
+For example, consider the following assertion where by mistake we programmed `operator=` instead of `operator==`:
+
+ int x = 1, y = 2;
+ assert(x = y); // Mistakenly `=` instead of `==`.
+
+Ideally this code will not compile instead this example not only compiles but the assertion even passes the run-time check and no error is generated at all.
+The __N1613__ paper introduces the idea of a /const-block/ which could be used to wrap the assertion above and catch the programming error at compile-time.
+Similarly, the following code will generate a compile-time error when `operator=` is mistakenly used instead of `operator==` because both `x` and `y` are made constants (using local functions) within the block of code performing the assertion (see also [@../../example/const_block_err.cpp =const_block_err.cpp=]):
+
+[table
+ [ [With Local Functions] [N1613 Const-Blocks] ]
+ [ [[const_block]] [``
+ int x = 1, y = 2;
+ const { // Constant block.
+ assert(x = y); // Compiler error.
+ }
+ ``] ]
+]
+
+Where the macros are defined in [@../../example/const_block.hpp =const_block.hpp=].
+
+The constant block macros are implemented using a local function which binds by constant reference `const bind&` all the specified variables (so the variables are constant within the code block but they do not need to be `CopyConstructible` and no extra copy is performed).
+The local function executes the `assert` instruction in its body which is called immediately after it is defined.
+More in general, constant blocks can be used to evaluate any instruction (not just assertions) within a block were all specified variables are constant.
+
+Unfortunately, constant blocks cannot be implemented with __CPP11_lambda__ functions because these do not support constant binding (of course it is always possible to introduce extra constant variables `const int& const_x = x`, etc and use these variables in the assertion).
+Variables bound by value using __CPP11_lambda__ functions (`variable`, `=variable`, and `=`) are constant but they are required to be `CopyConstructible` and they introduce potentially expensive copy operations.
+[footnote
+Ideally, __CPP11_lambda__ functions would allow to bind variables also using `const& variable` (constant reference) and `const&` (all variables by constant reference).
+]
+
+[endsect]
+
+[section Scope Exits]
+
+Scope exits allow to execute arbitrary code at the exit of the enclosing scope and they are provided by the __Boost_ScopeExit__ library.
+
+For curiosity, here we show how to re-implement scope exits using local functions.
+One small advantage of scope exits that use local functions is that they support constant binding.
+__Boost_ScopeExit__ does not directly support constant binding (however, it is always possible to introduce an extra `const` local variable, assign it to the value to bind, and then bind the `const` variable so to effectively have constant binding with __Boost_ScopeExit__ as well).
+In general, the authors recommend to use __Boost_ScopeExit__ instead of the code listed here whenever possible.
+
+The following example binds `p` by constant reference so this variable cannot be modified within the scope exit body but it is not copied and it will present the value it has at the exit of the enclosing scope and not at the scope exit declaration (see also [@../../example/scope_exit.cpp =scope_exit.cpp=]):
+
+[table
+ [ [With Local Functions] [Boost.ScopeExit] ]
+ [ [[scope_exit]] [
+[pre
+ person& p = persons_.back();
+ person::evolution_t checkpoint = p.evolution_;
+
+ BOOST_SCOPE_EXIT(checkpoint, &p, this_) { // Or extra variable `const_p`.
+ if (checkpoint == p.evolution_) this_->persons_.pop_back();
+ } BOOST_SCOPE_EXIT_END
+]
+ ] ]
+]
+
+Where the macros are defined in [@../../example/scope_exit.hpp =scope_exit.hpp=].
+
+The scope exit macros are implemented by passing a local function when constructing an object of the following class:
+
+[scope_exit_class]
+
+A local variable within the enclosing scope is used to hold the object so the destructor will be invoked at the exit of the enclosing scope and it will in turn call the local function executing the scope exit instructions.
+The scope exit local function has no parameter and `void` result type but it supports binding and constant binding.
+
+[endsect]
+
+[section Boost.Phoenix Functions]
+
+Local functions can be used to create __Boost_Phoenix__ functions.
+For example (see also [@../../example/phoenix_factorial_local.cpp =phoenix_factorial_local.cpp=] and [@../../example/phoenix_factorial.cpp =phoenix_factorial.cpp=]):
+
+[table
+ [ [Local Functions] [Global Functor] ]
+ [ [[phoenix_factorial_local]] [[phoenix_factorial]] ]
+]
+
+This is presented here mainly as a curiosity because __Boost_Phoenix__ functions created from local functions have the important limitation that they cannot be polymorphic.
+[footnote
+*Rationale.*
+Local functions can only be monomorphic because they are implemented using local classes and local classes cannot be templates in C++ (not even in __CPP11__).
+]
+Therefore, in many cases creating the __Boost_Phoenix__ function from global functors (possibly with the help of __Boost_Phoenix__ adaptor macros) might be a more valuable option.
+
+[endsect]
+
+[section Closures]
+
+The following are examples of [@http://en.wikipedia.org/wiki/Closure_(computer_science) closures] that illustrate how to return local functions to the calling scope (and the relative precautions to take).
+
+[table
+ [ [Files] ]
+ [ [[@../../test/return_inc.cpp =return_inc.cpp=]] ]
+ [ [[@../../test/return_this.cpp =return_this.cpp=]] ]
+ [ [[@../../test/return_setget.cpp =return_setget.cpp=]] ]
+ [ [[@../../test/return_derivative.cpp =return_derivative.cpp=]] ]
+]
+
+[endsect]
+
+[section GCC Nested Functions]
+
+The GCC C compiler supports local functions under the name of [@http://gcc.gnu.org/onlinedocs/gcc/Nested-Functions.html nested functions].
+Nested functions are exclusively a C extension of the GCC compiler (they are not supported for C++ not even by the GCC compiler, and they are not part of any C or C++ standard, nor they are supported by other compilers like MSVC).
+
+The following examples are taken form the GCC nested function documentation and programmed using this library:
+
+[table
+ [ [Files] ]
+ [ [[@../../example/gcc_square.cpp =gcc_square.cpp=]] ]
+ [ [[@../../example/gcc_access.cpp =gcc_access.cpp=]] ]
+ [ [[@../../example/gcc_store.cpp =gcc_store.cpp=]] ]
+]
+
+[endsect]
+
+[section N-Papers]
+
+The following examples are taken from a number of N-papers and programmed using this library.
+
+[table
+ [ [Files] [Notes] ]
+ [ [[@../../example/n2550_find_if.cpp =n2550_find_if.cpp=]] [
+This example is adapted from __N2550__ (__CPP11_lambda__ functions): It passes a local function to the STL algorithm `std::find_if`.
+ ] ]
+ [ [[@../../example/n2529_this.cpp =n2529_this.cpp=]] [
+This example is adapted from __N2529__ (__CPP11_lambda__ functions): It binds the object in scope `this` to a local function.
+ ] ]
+]
+
+[endsect]
+
+[endsect]
+

Added: trunk/libs/local_function/doc/getting_started.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/getting_started.qbk 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,78 @@
+
+[/ Copyright (C) 2009-2012 Lorenzo Caminiti ]
+[/ Distributed under the Boost Software License, Version 1.0 ]
+[/ (see accompanying file LICENSE_1_0.txt or a copy at ]
+[/ http://www.boost.org/LICENSE_1_0.txt) ]
+[/ Home at http://www.boost.org/libs/local_function ]
+
+[section:Getting_Started Getting Started]
+
+This section explains how programmers can setup their system to use this library.
+
+[section This Documentation]
+
+Programmers should have enough knowledge to use this library after reading the __Introduction__, __Getting_Started__, and __Tutorial__ sections.
+The __Advanced_Topics__ and __Reference__ sections can be consulted at a later point to gain a more advanced knowledge of the library.
+All the other sections of this documentation can be considered optional.
+
+Some footnotes are marked by the word "*Rationale*".
+They explain reasons behind decisions made during the design and implementation of this library.
+
+In some of the examples presented in this documentation, the __Boost_Test__ macro `BOOST_CHECK` is used equivalently to `assert` and the __Boost_Test__ macro `BOOST_AUTO_TEST_CASE` is used equivalently to `main`.
+[footnote
+*Rationale.*
+Using __Boost_Test__ allows to add the documentation examples to the library regression tests so to make sure that the listed examples always compile and run correctly.
+]
+
+[endsect]
+
+[section Compilers and Platforms]
+
+The implementation of this library uses preprocessor and template meta-programming (as supported by __Boost_Preprocessor__ and __Boost_MPL__), templates with partial specializations and function pointers (similarly to __Boost_Function__).
+As a consequence, this library is fairly demanding on compilers' compliance with the __CPP03__ standard.
+At present, this library has been successfully compiled and tested on the following compilers and platforms:
+
+# GNU Compiler Collection (GCC) 4.5.1 on Ubuntu Linux 10.
+# GCC 4.3.4 and 4.5.3 (with and without __CPP11__ features enabled `-std=c++0x`) on Cygwin.
+# Miscrosoft Visual Studio Compiler (MSVC) 8.0 on Windows XP and Windows 7.
+
+This library has not yet been tested on any other compiler and platform.
+
+[endsect]
+
+[section Installation]
+
+This library is composed of header files only.
+Therefore there is no pre-compiled object file which needs to be installed or linked.
+Programmers can simply instruct the C++ compiler where to find the library header files (`-I` option for GCC, `/I` option for MSVC, etc) and they can start compiling code using this library.
+
+This library implementation uses a number of __Boost__ libraries among which: __Boost_Preprocessor__, __Boost_ScopeExit__, __Boost_Typeof__, __Boost_TypeTraits__, and __Boost_MPL__.
+These __Boost__ libraries must be properly installed on your system in order for this library to work.
+
+The followings are part of the library private API, they are not documented, and they should not be directly used by programmers:
+[footnote
+*Rationale.*
+This library concatenates symbols specified by the programmers (e.g., the local function name) with other symbols (e.g., special prefixes or preprocessor line numbers) to make internal symbols with unique names to avoid name clashes.
+These symbols are separated by the letter "`X`" when they are concatenated so they read more easily during debugging (the underscore character "`_`" could not be used instead of the letter "`X`" because if the original symbols already contained a leading or trailing underscore, the concatenation could result in a symbol with double underscores "`__`" which is reserved by the C++ standard).
+The "aux" symbols are private to this library while the "detail" symbols can be used within Boost by other libraries but they are still not part of this library public API.
+]
+
+* Any symbol defined by files within the =boost/local_function/aux_/= or =boost/local_function/detail/= directory (these header files should not be directly included by programmers).
+* Any symbol within the `boost::local_function::aux` or `boost::local_function::detail` namespace.
+* Any symbol prefixed by `boost_local_function_aux_...` or `boost_local_function_detail_...` (regardless of its namespace).
+* Any symbol prefixed by `BOOST_LOCAL_FUNCTION_AUX_...` or `BOOST_LOCAL_FUNCTION_DETAIL_...` (regardless of its namespace).
+
+[endsect]
+
+[section Configuration]
+
+Some of the library behaviour can be changed at compile-time by defining special /configuration macros/.
+If a configuration macro is left undefined, the library will use an appropriate default value for it.
+
+All configuration macros are defined in the header file [headerref boost/local_function/config.hpp].
+It is strongly recommended not to change the library configuration macro definitions unless strictly necessary.
+
+[endsect]
+
+[endsect]
+

Added: trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,103 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Macro BOOST_LOCAL_FUNCTION</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="reference.html#header.boost.local_function_hpp" title="Header <boost/local_function.hpp>">
+<link rel="prev" href="reference.html" title="Reference">
+<link rel="next" href="BOOST_LOCAL_FUNCTION_TPL.html" title="Macro BOOST_LOCAL_FUNCTION_TPL">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.local_function_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_LOCAL_FUNCTION_TPL.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="refentry">
+<a name="BOOST_LOCAL_FUNCTION"></a><div class="titlepage"></div>
+<div class="refnamediv">
+<h2>Macro BOOST_LOCAL_FUNCTION</h2>
+BOOST_LOCAL_FUNCTION — This macro is used to start a local function declaration. 
+</div>
+<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
+<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">// In header: <<a class="link" href="reference.html#header.boost.local_function_hpp" title="Header <boost/local_function.hpp>">boost/local_function.hpp</a>>
+
+BOOST_LOCAL_FUNCTION(declarations)</pre></div>
+<div class="refsect1">
+<a name="id878789"></a><h2>Description</h2>
+This macro must be used within a declarative context, it must follow the local function result type, it must be followed by the local function body code, and then by the <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION_NAME.html" title="Macro BOOST_LOCAL_FUNCTION_NAME">BOOST_LOCAL_FUNCTION_NAME</a></code> macro (see the <a class="link" href="boost_localfunction/Tutorial.html" title="Tutorial">Tutorial</a> and <a class="link" href="boost_localfunction/Advanced_Topics.html" title="Advanced Topics"> Advanced Topics</a> sections): 
+<pre class="programlisting">{ // Some declarative context.
+ ...
+ result_type BOOST_LOCAL_FUNCTION(declarations) {
+ ... // Body code.
+ } BOOST_LOCAL_FUNCTION_NAME(qualified_function_name)
+ ...
+}
+</pre>
+As usual, exceptions specifications can be optionally programmed just after the macro and before the body code block <code class="computeroutput">{ ... }</code> (but the exception specifications will only apply to the body code and not to the library code automatically generated by the macro expansion, see the <a class="link" href="boost_localfunction/Advanced_Topics.html" title="Advanced Topics"> Advanced Topics</a> section).
+Within templates, the special macro <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION_TPL.html" title="Macro BOOST_LOCAL_FUNCTION_TPL">BOOST_LOCAL_FUNCTION_TPL</a></code> must be used instead of <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">BOOST_LOCAL_FUNCTION</a></code>.
+Parameters: 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<tbody><tr>
+<td><code class="computeroutput">declarations</code></td>
+<td>On compilers that support variadic macros, the parameter declarations are defined by the following grammar: <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"> declarations:
+ void | declaration_tuple | declaration_sequence
+ declaration_tuple:
+ declaration, declaration, ...
+ declaration_sequence:
+ (declaration) (declaration) ...
+ declaration:
+ bound_variable | parameter | default_value | result_type
+ bound_variable:
+ [const] bind [(variable_type)] [&] variable_name
+ parameter:
+ [auto | register] parameter_type parameter_name
+ default_value:
+ default parameter_default_value
+ result_type:
+ return function_result_type
+</pre> On compilers that do not support variadic macros, <code class="computeroutput">declaration_tuple</code> cannot be used: <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"> declarations:
+ void | declaration_sequence
+</pre>Lexical conventions: <code class="computeroutput">token1 | token2</code> means either <code class="computeroutput">token1</code> or <code class="computeroutput">token2</code>; <code class="computeroutput">[token]</code> means either <code class="computeroutput">token</code> or nothing; <code class="computeroutput">{expression}</code> means the token resulting from the expression. </td>
+</tr></tbody>
+</table></div>
+
+
+Note that on compilers that support variadic macros, commas can be used to separate the declarations resembling more closely the usual C++ function declaration syntax. This is the preferred syntax. However, for portability, on all C++ compilers (with and without variadic macros) the same library macros also accept parameter declarations specified as a Boost.Preprocessor sequence separated by round parenthesis <code class="computeroutput">()</code>.
+When binding the object <code class="computeroutput">this</code>, the special symbol <code class="computeroutput">this_</code> needs to be used instead of <code class="computeroutput">this</code> as the name of the variable to bind and also within the local function body to access the object. (Mistakenly using <code class="computeroutput">this</code> instead of <code class="computeroutput">this_</code> might not always result in a compiler error and will in general result in undefined behaviour.)
+The result type must either be specified just before the macro or within the macro declarations prefixed by <code class="computeroutput">return</code> (but not in both places).
+Within the local function body it possible to access the result type using <code class="computeroutput">result_type</code>, the type of the first parameter using <code class="computeroutput">arg1_type</code>, the type of the second parameter using <code class="computeroutput">arg2_type</code>, etc. The bound variable types can be accessed using <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION_TYPEOF.html" title="Macro BOOST_LOCAL_FUNCTION_TYPEOF">BOOST_LOCAL_FUNCTION_TYPEOF</a></code>.
+The maximum number of local function parameters (excluding bound variables) is specified by the configuration macro <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX.html" title="Macro BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX">BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX</a></code>. The maximum number of bound variables is specified by the configuration macro <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX.html" title="Macro BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX">BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX</a></code>.
+Note: Local functions are functors so they can be assigned to other functors like <code class="computeroutput">boost::function</code> (see Boost.Function).
+Note: This macro cannot be portably used multiple times on the same line (because on GCC and other compilers, it internally uses the line number <code class="computeroutput">__LINE__</code> to generate unique identifiers).
+See: <a class="link" href="boost_localfunction/Tutorial.html" title="Tutorial">Tutorial</a> section, <a class="link" href="boost_localfunction/Advanced_Topics.html" title="Advanced Topics"> Advanced Topics</a> section, <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION_TPL.html" title="Macro BOOST_LOCAL_FUNCTION_TPL">BOOST_LOCAL_FUNCTION_TPL</a></code>, <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION_NAME.html" title="Macro BOOST_LOCAL_FUNCTION_NAME">BOOST_LOCAL_FUNCTION_NAME</a></code>, <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION_TYPEOF.html" title="Macro BOOST_LOCAL_FUNCTION_TYPEOF">BOOST_LOCAL_FUNCTION_TYPEOF</a></code>, <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX.html" title="Macro BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX">BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX</a></code>, <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNC
TION_CONFIG_BIND_MAX.html" title="Macro BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX">BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX</a></code>. 
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.local_function_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_LOCAL_FUNCTION_TPL.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,56 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Macro BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="reference.html#header.boost.local_function.config_hpp" title="Header <boost/local_function/config.hpp>">
+<link rel="prev" href="BOOST_LOCAL_FUNCTION_TYPEOF.html" title="Macro BOOST_LOCAL_FUNCTION_TYPEOF">
+<link rel="next" href="BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX.html" title="Macro BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="BOOST_LOCAL_FUNCTION_TYPEOF.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.local_function.config_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="refentry">
+<a name="BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX"></a><div class="titlepage"></div>
+<div class="refnamediv">
+<h2>Macro BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX</h2>
+BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX — Maximum number of parameters supported by local functions. 
+</div>
+<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
+<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">// In header: <<a class="link" href="reference.html#header.boost.local_function.config_hpp" title="Header <boost/local_function/config.hpp>">boost/local_function/config.hpp</a>>
+
+BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX</pre></div>
+<div class="refsect1">
+<a name="id881266"></a><h2>Description</h2>
+If programmers leave this configuration macro undefined, its default value is <code class="computeroutput">5</code> (increasing this number might increase compilation time). When defined by programmers, this macro must be a non-negative integer number.
+Note: This macro specifies the maximum number of local function parameters excluding bound variables (which are instead specified by <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX.html" title="Macro BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX">BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX</a></code>).
+See: <a class="link" href="boost_localfunction/Tutorial.html" title="Tutorial">Tutorial</a> section, <a class="link" href="boost_localfunction/Getting_Started.html" title="Getting Started"> Getting Started</a> section, <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX.html" title="Macro BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX">BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX</a></code>. 
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="BOOST_LOCAL_FUNCTION_TYPEOF.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.local_function.config_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,56 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Macro BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="reference.html#header.boost.local_function.config_hpp" title="Header <boost/local_function/config.hpp>">
+<link rel="prev" href="BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX.html" title="Macro BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX">
+<link rel="next" href="boost_localfunction/Alternatives.html" title="Annex: Alternatives">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.local_function.config_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost_localfunction/Alternatives.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="refentry">
+<a name="BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX"></a><div class="titlepage"></div>
+<div class="refnamediv">
+<h2>Macro BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX</h2>
+BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX — Maximum number of bound variables supported by local functions. 
+</div>
+<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
+<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">// In header: <<a class="link" href="reference.html#header.boost.local_function.config_hpp" title="Header <boost/local_function/config.hpp>">boost/local_function/config.hpp</a>>
+
+BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX</pre></div>
+<div class="refsect1">
+<a name="id881341"></a><h2>Description</h2>
+If programmers leave this configuration macro undefined, its default value is <code class="computeroutput">10</code> (increasing this number might increase compilation time). When defined by programmers, this macro must be a non-negative integer number.
+Note: This macro specifies the maximum number of bound variables excluding local function parameters (which are instead specified by <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX.html" title="Macro BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX">BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX</a></code>).
+See: <a class="link" href="boost_localfunction/Tutorial.html" title="Tutorial">Tutorial</a> section, <a class="link" href="boost_localfunction/Getting_Started.html" title="Getting Started"> Getting Started</a> section, <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX.html" title="Macro BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX">BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX</a></code>. 
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.local_function.config_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost_localfunction/Alternatives.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION_NAME.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION_NAME.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,81 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Macro BOOST_LOCAL_FUNCTION_NAME</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="reference.html#header.boost.local_function_hpp" title="Header <boost/local_function.hpp>">
+<link rel="prev" href="BOOST_LOCAL_FUNCTION_TPL.html" title="Macro BOOST_LOCAL_FUNCTION_TPL">
+<link rel="next" href="BOOST_LOCAL_FUNCTION_TYPEOF.html" title="Macro BOOST_LOCAL_FUNCTION_TYPEOF">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="BOOST_LOCAL_FUNCTION_TPL.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.local_function_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_LOCAL_FUNCTION_TYPEOF.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="refentry">
+<a name="BOOST_LOCAL_FUNCTION_NAME"></a><div class="titlepage"></div>
+<div class="refnamediv">
+<h2>Macro BOOST_LOCAL_FUNCTION_NAME</h2>
+BOOST_LOCAL_FUNCTION_NAME — This macro is used to end a local function declaration specifying its name. 
+</div>
+<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
+<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">// In header: <<a class="link" href="reference.html#header.boost.local_function_hpp" title="Header <boost/local_function.hpp>">boost/local_function.hpp</a>>
+
+BOOST_LOCAL_FUNCTION_NAME(qualified_function_name)</pre></div>
+<div class="refsect1">
+<a name="id880744"></a><h2>Description</h2>
+This macro must follow the local function body code block <code class="computeroutput">{ ... }</code>: 
+<pre class="programlisting">{ // Some declarative context.
+ ...
+ result_type BOOST_LOCAL_FUNCTION(declarations) {
+ ... // Body code.
+ } BOOST_LOCAL_FUNCTION_NAME(qualified_function_name)
+ ...
+}
+</pre>
+Parameters: 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<tbody><tr>
+<td><code class="computeroutput">qualified_function_name</code></td>
+<td>The name of the local function optionally qualified as follow: <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">qualified_function_name:
+ [inline] [recursive] name
+</pre> Lexical conventions: <code class="computeroutput">token1 | token2</code> means either <code class="computeroutput">token1</code> or <code class="computeroutput">token2</code>; <code class="computeroutput">[token]</code> means either <code class="computeroutput">token</code> or nothing; <code class="computeroutput">{expression}</code> means the token resulting from the expression. </td>
+</tr></tbody>
+</table></div>
+
+
+The local function name can be qualified by prefixing it with the keyword <code class="computeroutput">inline</code> (see the <a class="link" href="boost_localfunction/Advanced_Topics.html" title="Advanced Topics"> Advanced Topics</a> section): <code class="computeroutput">BOOST_LOCAL_FUNCTION_NAME(inline name)</code>. This increases the chances that the compiler will be able to inline the local function calls (thus reducing run-time). However, inlined local functions cannot be passed as template parameters (e.g., to <code class="computeroutput">std::for_each</code>) or assigned to other functors (e.g., to <code class="computeroutput">boost::function</code>). That is true on C++03 compilers but inlined local functions can instead be passed as template parameters on C++11 compilers. On C++11 compilers, there is no need to declare a local function lined because this library will automatically use C++11 specific features to inline the local function while always allowing to pass it as a template parameter.

+The local function name can also be qualified by prefixing it with the "keyword" <code class="computeroutput">recursive</code> (see the <a class="link" href="boost_localfunction/Advanced_Topics.html" title="Advanced Topics"> Advanced Topics</a> section): <code class="computeroutput">BOOST_LOCAL_FUNCTION_NAME(recursive name)</code>. This allows the local function to recursively call itself from its body (as usual in C++). However, compilers have not been observed to be able to inline recursive local function calls (not even when the recursive local function is also declared inline: <code class="computeroutput">BOOST_LOCAL_FUNCTION(inline recursive name)</code>). Furthermore, recursive local functions should only be called within their declaration scope (otherwise the result is undefined behaviour).
+Note: The local function name cannot be the name of an operator <code class="computeroutput">operator...</code> and it cannot be the same name of another local function declared within the same enclosing scope (but <code class="computeroutput">boost::overloaded_function</code> can be used to overload local functions, see Boost.Functional/OverloadedFunction and the <a class="link" href="boost_localfunction/Advanced_Topics.html" title="Advanced Topics"> Advanced Topics</a> section).
+See: <a class="link" href="boost_localfunction/Tutorial.html" title="Tutorial">Tutorial</a> section, <a class="link" href="boost_localfunction/Advanced_Topics.html" title="Advanced Topics"> Advanced Topics</a> section, <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">BOOST_LOCAL_FUNCTION</a></code>. 
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="BOOST_LOCAL_FUNCTION_TPL.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.local_function_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_LOCAL_FUNCTION_TYPEOF.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION_TPL.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION_TPL.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,64 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Macro BOOST_LOCAL_FUNCTION_TPL</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="reference.html#header.boost.local_function_hpp" title="Header <boost/local_function.hpp>">
+<link rel="prev" href="BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">
+<link rel="next" href="BOOST_LOCAL_FUNCTION_NAME.html" title="Macro BOOST_LOCAL_FUNCTION_NAME">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="BOOST_LOCAL_FUNCTION.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.local_function_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_LOCAL_FUNCTION_NAME.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="refentry">
+<a name="BOOST_LOCAL_FUNCTION_TPL"></a><div class="titlepage"></div>
+<div class="refnamediv">
+<h2>Macro BOOST_LOCAL_FUNCTION_TPL</h2>
+BOOST_LOCAL_FUNCTION_TPL — This macro is used to start a local function declaration within templates. 
+</div>
+<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
+<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">// In header: <<a class="link" href="reference.html#header.boost.local_function_hpp" title="Header <boost/local_function.hpp>">boost/local_function.hpp</a>>
+
+BOOST_LOCAL_FUNCTION_TPL(declarations)</pre></div>
+<div class="refsect1">
+<a name="id880567"></a><h2>Description</h2>
+This macro must be used instead of <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">BOOST_LOCAL_FUNCTION</a></code> when declaring a local function within a template. A part from that, this macro has the exact same syntax as <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">BOOST_LOCAL_FUNCTION</a></code> (see <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">BOOST_LOCAL_FUNCTION</a></code> for more information): 
+<pre class="programlisting">{ // Some declarative context with a template.
+ ...
+ result_type BOOST_LOCAL_FUNCTION_TPL(declarations) {
+ ... // Body code.
+ } BOOST_LOCAL_FUNCTION_NAME(qualified_function_name)
+ ...
+}
+</pre>
+Note: C++03 does not allow to use <code class="computeroutput">typename</code> outside templates. This library internally manipulates types, these operations require <code class="computeroutput">typename</code> but only within templates so this macro is used to indicate to the library when the enclosing scope is a template.
+See: <a class="link" href="boost_localfunction/Tutorial.html" title="Tutorial">Tutorial</a> section, <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">BOOST_LOCAL_FUNCTION</a></code>, <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION_NAME.html" title="Macro BOOST_LOCAL_FUNCTION_NAME">BOOST_LOCAL_FUNCTION_NAME</a></code>. 
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="BOOST_LOCAL_FUNCTION.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.local_function_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_LOCAL_FUNCTION_NAME.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION_TYPEOF.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/BOOST_LOCAL_FUNCTION_TYPEOF.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,78 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Macro BOOST_LOCAL_FUNCTION_TYPEOF</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="reference.html#header.boost.local_function_hpp" title="Header <boost/local_function.hpp>">
+<link rel="prev" href="BOOST_LOCAL_FUNCTION_NAME.html" title="Macro BOOST_LOCAL_FUNCTION_NAME">
+<link rel="next" href="BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX.html" title="Macro BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="BOOST_LOCAL_FUNCTION_NAME.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.local_function_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="refentry">
+<a name="BOOST_LOCAL_FUNCTION_TYPEOF"></a><div class="titlepage"></div>
+<div class="refnamediv">
+<h2>Macro BOOST_LOCAL_FUNCTION_TYPEOF</h2>
+BOOST_LOCAL_FUNCTION_TYPEOF — This macro expands to the type of the specified bound variable. 
+</div>
+<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
+<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">// In header: <<a class="link" href="reference.html#header.boost.local_function_hpp" title="Header <boost/local_function.hpp>">boost/local_function.hpp</a>>
+
+BOOST_LOCAL_FUNCTION_TYPEOF(bound_variable_name)</pre></div>
+<div class="refsect1">
+<a name="id881054"></a><h2>Description</h2>
+This macro can be used within the local functions body to refer to the bound variable types so to declare local variables, check concepts (using Boost.ConceptCheck), etc (see the <a class="link" href="boost_localfunction/Advanced_Topics.html" title="Advanced Topics"> Advanced Topics</a> section). This way the local function can be programmed entirely without explicitly specifying the bound variable types thus facilitating maintenance (e.g., if the type of a bound variable changes in the enclosing scope, the local function code does not have to change).
+Parameters: 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<tbody><tr>
+<td><code class="computeroutput">bound_variable_name</code></td>
+<td>The name of one of the local function's bound variables. </td>
+</tr></tbody>
+</table></div>
+
+
+The type returned by the macro is fully qualified in that it contains the extra constant and reference qualifiers when the specified variable is bound by constant and by reference. For example, if a variable named <code class="computeroutput">t</code> of type <code class="computeroutput">T</code> is: 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">Bound by value using <code class="computeroutput">bind t</code> then <code class="computeroutput">BOOST_LOCAL_FUNCTION_TYPEOF(t)</code> is <code class="computeroutput">T</code>. </li>
+<li class="listitem">Bound by constant value using <code class="computeroutput">const bind t</code> then <code class="computeroutput">BOOST_LOCAL_FUNCTION_TYPEOF(t)</code> is <code class="computeroutput">const T</code>. </li>
+<li class="listitem">Bound by reference using <code class="computeroutput">bind& t</code> then <code class="computeroutput">BOOST_LOCAL_FUNCTION_TYPEOF(t)</code> is <code class="computeroutput">T&</code>. </li>
+<li class="listitem">Bound by constant reference using <code class="computeroutput">const bind& t</code> then <code class="computeroutput">BOOST_LOCAL_FUNCTION_TYPEOF(t)</code> is <code class="computeroutput">const T&</code>.</li>
+</ul></div>
+
+This macro must be prefixed by <code class="computeroutput">typename</code> when used in a type dependant context.
+It is best to use this macro instead of Boost.Typeof so to reduce the number of times Boost.Typeof is used to deduce types (see the <a class="link" href="boost_localfunction/Advanced_Topics.html" title="Advanced Topics"> Advanced Topics</a> section).
+See: <a class="link" href="boost_localfunction/Advanced_Topics.html" title="Advanced Topics"> Advanced Topics</a> section, <code class="computeroutput"><a class="link" href="BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">BOOST_LOCAL_FUNCTION</a></code>. 
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="BOOST_LOCAL_FUNCTION_NAME.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.local_function_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/boost_localfunction/Acknowledgments.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/boost_localfunction/Acknowledgments.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,103 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Acknowledgments</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="prev" href="Bibliography.html" title="Bibliography">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="Bibliography.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a>
+</div>
+<div class="section boost_localfunction_Acknowledgments">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_localfunction.Acknowledgments"></a><a class="link" href="Acknowledgments.html" title="Acknowledgments">Acknowledgments</a>
+</h2></div></div></div>
+
+ This section aims to recognize the contributions of all
+ the different people that participated directly or indirectly to the design
+ and development of this library.
+ 
+
+ Many thanks to Steven Watanabe and Vicente Botet for suggesting to me to use
+ Boost.ScopeExit binding
+ to <a href="http://boost.2283326.n4.nabble.com/contract-diff-n1962-tt2671482.html#none" target="_top">emulate
+ local functions</a>. Many thanks to Alexander Nasonov for clarifying how
+ Boost.ScopeExit binding
+ could be used to implement local functions and for some <a href="http://thread.gmane.org/gmane.comp.lib.boost.devel/168612" target="_top">early
+ work</a> in this direction.
+ 
+
+ Many thanks to Gregory Crosswhite for using an early version of this library
+ in one of his projects.
+ 
+
+ Thanks to David Abrahams, Vicente Botet, et al. for suggesting to provide the
+ <a href="http://lists.boost.org/Archives/boost/2011/02/176712.php" target="_top">variadic
+ macro syntax</a> on compilers that support variadic macros.
+ 
+
+ Thanks to Pierre Morcello for sharing some code that experimented with implementing
+ local functions using Boost.ScopeExit
+ binding (even if this library is not based on such a code).
+ 
+
+ Thanks to John Bytheway for checking the authors' virtual functor technique
+ that originally allowed this library to pass local functions as template parameters.
+ 
+
+ Thanks to Jeffrey Lee Hellrung for suggesting the use of the "keyword"
+ <code class="computeroutput">bind</code> to bind variables in scope
+ and for suggesting to use <code class="literal">bind(type)</code>
+ to optionally specify the bound variable type. Thanks to Vicente Botet for
+ suggesting to provide a macro to expose the bound variable type to the public
+ API.
+ 
+
+ Thanks to Steven Watanabe, Vicente Botet, Michael Caisse, Yechezkel Mett, Joel
+ de Guzman, Thomas Heller, et al. for helping with the <a class="link" href="Alternatives.html" title="Annex: Alternatives">Alternatives</a>
+ section and with the profiling of the different alternatives.
+ 
+
+ Many thanks to the library's <a href="http://lists.boost.org/boost-announce/2011/12/0340.php" target="_top">Boost
+ review</a> manager: Jeffrey Lee Hellrung. Thanks also to all the people
+ that submitted a (positive and negative) review: Andrzej Krzemienski, Edward
+ Diener, Gregory Crosswhite, John Bytheway, Hartmut Kaiser, Krzysztof Czainski,
+ Nat Lindon, Pierre Morcello, Thomas Heller, and Vicente J. Botet. Thanks to
+ everyone else that commented (positively and negatively) on the library during
+ its Boost review.
+ 
+
+ Finally, many thanks to the entire Boost
+ community and mailing list for
+ providing valuable comments about this library and great insights on the C++
+ programming language.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="Bibliography.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/boost_localfunction/Advanced_Topics.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/boost_localfunction/Advanced_Topics.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,1300 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Advanced Topics</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="prev" href="Tutorial.html" title="Tutorial">
+<link rel="next" href="Examples.html" title="Examples">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="Tutorial.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="Examples.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section boost_localfunction_Advanced_Topics">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_localfunction.Advanced_Topics"></a><a class="link" href="Advanced_Topics.html" title="Advanced Topics">Advanced Topics</a>
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt><a href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.default_parameters">Default
+ Parameters</a></dt>
+<dt><a href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.commas_and_symbols_in_macros">Commas
+ and Symbols in Macros</a></dt>
+<dt><a href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.assigning_and_returning">Assigning
+ and Returning</a></dt>
+<dt>Nesting</dt>
+<dt><a href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.accessing_types__concepts__etc_">Accessing
+ Types (concepts, etc)</a></dt>
+<dt><a href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.specifying_types">Specifying
+ Types</a></dt>
+<dt>Inlining</dt>
+<dt>Recursion</dt>
+<dt>Overloading</dt>
+<dt><a href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.exception_specifications">Exception
+ Specifications</a></dt>
+<dt><a href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.storage_classifiers___auto__and__register__">Storage
+ Classifiers (<code class="computeroutput">auto</code> and <code class="computeroutput">register</code>)</a></dt>
+<dt><a href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.limitations__operators__etc_">Limitations
+ (operators, etc)</a></dt>
+</dl></div>
+
+ This section illustrates advanced usages of this library (at the bottom there
+ is also a list of known limitations of the library).
+ 
+<div class="section boost_localfunction_Advanced_Topics_default_parameters">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Advanced_Topics.default_parameters"></a><a class="link" href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.default_parameters" title="Default Parameters">Default
+ Parameters</a>
+</h3></div></div></div>
+
+ This library also allows to specify default values for the local function
+ parameters. However, the usual C++ syntax for default parameters that uses
+ the assignment symbol <code class="computeroutput">=</code> cannot
+ be used. [<a name="boost_localfunction.Advanced_Topics.default_parameters.f0" href="#ftn.boost_localfunction.Advanced_Topics.default_parameters.f0" class="footnote">17</a>] The keyword <code class="computeroutput">default</code>
+ is used instead:
+ 
+<pre class="programlisting"><code class="literal">parameter-type parameter-name</code>, default <code class="literal">parameter-default-value</code>, ...
+</pre>
+
+ For example, let's program a local function <code class="computeroutput">add(x,
+ y)</code>
+ where the second parameter <code class="computeroutput">y</code>
+ is optional and has a default value of <code class="computeroutput">2</code>
+ (see also add_default.cpp):
+ 
+
+
+<pre class="programlisting">int BOOST_LOCAL_FUNCTION(int x, int y, default 2) { // Default.
+ return x + y;
+} BOOST_LOCAL_FUNCTION_NAME(add)
+
+BOOST_CHECK( add(1) == 3 );
+</pre>
+
+ 
+
+ Programmers can define a <code class="computeroutput">WITH_DEFAULT</code>
+ macro similar to the following if they think it improves readability over
+ the syntax above (see also add_with_default.cpp):
+ [<a name="boost_localfunction.Advanced_Topics.default_parameters.f1" href="#ftn.boost_localfunction.Advanced_Topics.default_parameters.f1" class="footnote">18</a>]
+ 
+
+
+<pre class="programlisting">#define WITH_DEFAULT , default
+</pre>
+
+ 
+
+
+<pre class="programlisting">int BOOST_LOCAL_FUNCTION(int x, int y WITH_DEFAULT 2) { // Default.
+ return x + y;
+} BOOST_LOCAL_FUNCTION_NAME(add)
+
+BOOST_CHECK( add(1) == 3 );
+</pre>
+
+ 
+</div>
+<div class="section boost_localfunction_Advanced_Topics_commas_and_symbols_in_macros">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Advanced_Topics.commas_and_symbols_in_macros"></a><a class="link" href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.commas_and_symbols_in_macros" title="Commas and Symbols in Macros">Commas
+ and Symbols in Macros</a>
+</h3></div></div></div>
+
+ The C++ preprocessor does not allow commas <code class="computeroutput">,</code>
+ within macro parameters unless they are wrapped by round parenthesis <code class="computeroutput">()</code> (see the Boost.Utility/IdentityType
+ documentation for details). Therefore, using commas within the local function
+ parameters and bindings will generate (cryptic) preprocessor errors unless
+ they are wrapped with an extra set of round parenthesis <code class="computeroutput">()</code>
+ as explained here.
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ Also macro parameters with commas wrapped by angular parenthesis <code class="computeroutput"><></code> (templates, etc) or square parenthesis
+ <code class="computeroutput">[]</code> (multidimensional array
+ access, etc) need to be wrapped by the extra round parenthesis <code class="computeroutput">()</code> as explained here (this is because the
+ preprocessor only recognizes the round parenthesis and it does not recognize
+ angular, square, or any other type of parenthesis). However, macro parameters
+ with commas which are already wrapped by round parenthesis <code class="computeroutput">()</code> are fine (function calls, some value
+ expressions, etc).
+ </td></tr>
+</table></div>
+
+ In addition, local function parameter types cannot start with non-alphanumeric
+ symbols (alphanumeric symbols are <code class="computeroutput">A-Z</code>, <code class="computeroutput">a-z</code>,
+ and <code class="computeroutput">0-9</code>). [<a name="boost_localfunction.Advanced_Topics.commas_and_symbols_in_macros.f0" href="#ftn.boost_localfunction.Advanced_Topics.commas_and_symbols_in_macros.f0" class="footnote">19</a>] The library will generate (cryptic) preprocessor errors if a
+ parameter type starts with a non-alphanumeric symbol.
+ 
+
+ Let's consider the following example:
+ 
+<pre class="programlisting">void BOOST_LOCAL_FUNCTION(
+ const std::map<std::string, size_t>& m, // (1) Error.
+ ::sign_t sign, // (2) Error.
+ const size_t& factor,
+ default key_sizeof<std::string, size_t>::value, // (3) Error.
+ const std::string& separator, default cat(":", " ") // (4) OK.
+) {
+ ...
+} BOOST_LOCAL_FUNCTION_NAME(f)
+</pre>
+
+ (1) The parameter type <code class="computeroutput">const
+ std::map<std::string, size_t>&</code> contains a comma <code class="computeroutput">,</code>
+ after the first template parameter <code class="computeroutput">std::string</code>.
+ This comma is not wrapped by any round parenthesis <code class="computeroutput">()</code>
+ thus it will cause a preprocessor error. [<a name="boost_localfunction.Advanced_Topics.commas_and_symbols_in_macros.f1" href="#ftn.boost_localfunction.Advanced_Topics.commas_and_symbols_in_macros.f1" class="footnote">20</a>] The Boost.Utility/IdentityType
+ macro <code class="computeroutput">BOOST_IDENTITY_TYPE(</code><code class="literal">parenthesized-type</code><code class="computeroutput">)</code> from the header <code class="literal">boost/utility/identity_type.hpp</code>
+ can be used to wrap a type within extra parenthesis <code class="computeroutput">()</code>
+ so to overcome the problem:
+ 
+<pre class="programlisting">#include <boost/utility/identity_type.hpp>
+
+void BOOST_LOCAL_FUNCTION(
+ BOOST_IDENTITY_TYPE((const std::map<std::string, size_t>&)) m, // OK.
+ ...
+) {
+ ...
+} BOOST_LOCAL_FUNCTION_NAME(f)
+</pre>
+
+ This macro expands to an expression that evaluates (at compile-time) exactly
+ to the specified type. Note that a total of two set of parenthesis <code class="computeroutput">()</code> are needed: The parenthesis to invoke the
+ <code class="computeroutput">BOOST_IDENTITY_TYPE(...)</code>
+ macro plus the parenthesis to wrap the type expression (and therefore any
+ comma <code class="computeroutput">,</code> that it contains) passed
+ as parameter to the <code class="computeroutput">BOOST_IDENTITY_TYPE((...))</code> macro. Finally, the <code class="computeroutput">BOOST_IDENTITY_TYPE</code> macro must be prefixed
+ by the <code class="computeroutput">typename</code> keyword <code class="computeroutput">typename BOOST_IDENTITY_TYPE(</code><code class="literal">parenthesized-type</code><code class="computeroutput">)</code> when used together with the <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION_TPL.html" title="Macro BOOST_LOCAL_FUNCTION_TPL">BOOST_LOCAL_FUNCTION_TPL</a></code>
+ macro within templates.
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ Often, there might be better ways to overcome this limitation that lead
+ to code which is more readable than the one using the <code class="computeroutput">BOOST_IDENTITY_TYPE</code>
+ macro.
+ </td></tr>
+</table></div>
+
+ For example, in this case a <code class="computeroutput">typedef</code>
+ from the enclosing scope could have been used to obtain the following valid
+ and perhaps more readable code:
+ 
+<pre class="programlisting">typedef std::map<std::string, size_t> map_type;
+void BOOST_LOCAL_FUNCTION(
+ const map_type& m, // OK (and more readable).
+ ...
+) BOOST_LOCAL_FUNCTION_NAME(f)
+</pre>
+
+ (2) The parameter type <code class="computeroutput">::sign_t</code> starts with the non-alphanumeric
+ symbols <code class="computeroutput">::</code> thus it will generate
+ preprocessor errors if used as a local function parameter type. The macros
+ <code class="computeroutput">BOOST_IDENTITY_TYPE</code> can also
+ be used to overcome this issue:
+ 
+<pre class="programlisting">void BOOST_LOCAL_FUNCTION(
+ ...
+ BOOST_IDENTITY_TYPE((::sign_t)) sign, // OK.
+ ...
+) {
+ ...
+} BOOST_LOCAL_FUNCTION_NAME(f)
+</pre>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ Often, there might be better ways to overcome this limitation that lead
+ to code which is more readable than the one using the <code class="computeroutput">BOOST_IDENTITY_TYPE</code>
+ macro.
+ </td></tr>
+</table></div>
+
+ For example, in this case the symbols <code class="computeroutput">::</code>
+ could have been simply dropped to obtain the following valid and perhaps
+ more readable code:
+ 
+<pre class="programlisting">void BOOST_LOCAL_FUNCTION(
+ ...
+ sign_t sign, // OK (and more readable).
+ ...
+) {
+ ...
+} BOOST_LOCAL_FUNCTION_NAME(f)
+</pre>
+
+ (3) The default parameter value <code class="computeroutput">key_sizeof<std::string, size_t>::value</code>
+ contains a comma <code class="computeroutput">,</code> after the
+ first template parameter <code class="computeroutput">std::string</code>.
+ Again, this comma is not wrapped by any parenthesis <code class="computeroutput">()</code>
+ so it will cause a preprocessor error. Because this is a value expression
+ (and not a type expression), it can be simply wrapped within an extra set
+ of round parenthesis <code class="computeroutput">()</code>:
+ 
+<pre class="programlisting">void BOOST_LOCAL_FUNCTION(
+ ...
+ const size_t& factor,
+ default (key_sizeof<std::string, size_t>::value), // OK.
+ ...
+) {
+ ...
+} BOOST_LOCAL_FUNCTION_NAME(f)
+</pre>
+
+ (4) The default parameter value <code class="computeroutput">cat(":", " ")</code> is instead fine because it contains a comma
+ <code class="computeroutput">,</code> which is already wrapped by
+ the parenthesis <code class="computeroutput">()</code> of the function
+ call <code class="computeroutput">cat(...)</code>.
+ 
+
+ Consider the following complete example (see also macro_commas.cpp):
+ 
+
+
+<pre class="programlisting">void BOOST_LOCAL_FUNCTION(
+ BOOST_IDENTITY_TYPE((const std::map<std::string, size_t>&)) m,
+ BOOST_IDENTITY_TYPE((::sign_t)) sign,
+ const size_t& factor,
+ default (key_sizeof<std::string, size_t>::value),
+ const std::string& separator, default cat(":", " ")
+) {
+ // Do something...
+} BOOST_LOCAL_FUNCTION_NAME(f)
+</pre>
+
+ 
+</div>
+<div class="section boost_localfunction_Advanced_Topics_assigning_and_returning">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Advanced_Topics.assigning_and_returning"></a><a class="link" href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.assigning_and_returning" title="Assigning and Returning">Assigning
+ and Returning</a>
+</h3></div></div></div>
+
+ Local functions are function objects so it is possible to assign them to
+ other functors like Boost.Function
+ <code class="computeroutput">boost::function</code> in order to store the local function
+ into a variable, pass it as a parameter to another function, or return it
+ from the enclosing function.
+ 
+
+ For example (see also return_assign.cpp):
+ 
+
+
+<pre class="programlisting">void call1(boost::function<int (int) > f) { BOOST_CHECK( f(1) == 5 ); }
+void call0(boost::function<int (void)> f) { BOOST_CHECK( f() == 5 ); }
+
+boost::function<int (int, int)> linear(const int& slope) {
+ int BOOST_LOCAL_FUNCTION(const bind& slope,
+ int x, default 1, int y, default 2) {
+ return x + slope * y;
+ } BOOST_LOCAL_FUNCTION_NAME(lin)
+
+ boost::function<int (int, int)> f = lin; // Assign to local variable.
+ BOOST_CHECK( f(1, 2) == 5 );
+
+ call1(lin); // Pass to other functions.
+ call0(lin);
+
+ return lin; // Return.
+}
+
+void call(void) {
+ boost::function<int (int, int)> f = linear(2);
+ BOOST_CHECK( f(1, 2) == 5 );
+}
+</pre>
+
+ 
+
+ Note that:
+ 
+<div class="important"><table border="0" summary="Important">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../../../../doc/src/images/important.png"></td>
+<th align="left">Important</th>
+</tr>
+<tr><td align="left" valign="top">
+ As with <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions, programmers are responsible to ensure that bound
+ references are valid in any scope where the local function object is called.
+ (This might be tricky to verify in a program when local functions are returned
+ and called outside the local scope of their declaration.)
+ </td></tr>
+</table></div>
+
+ In addition, a local function can bind and call another local function. Local
+ functions should always be bound by constant reference <code class="computeroutput">const
+ bind&</code>
+ to avoid unnecessary copies. For example, the following local function <code class="computeroutput">inc_sum</code> binds the local function <code class="computeroutput">inc</code> so <code class="computeroutput">inc_sum</code>
+ can call <code class="computeroutput">inc</code> (see aslo transform.cpp):
+ 
+
+
+<pre class="programlisting">int offset = 5;
+std::vector<int> v;
+std::vector<int> w;
+
+for(int i = 1; i <= 2; ++i) v.push_back(i * 10);
+BOOST_CHECK( v[0] == 10 ); BOOST_CHECK( v[1] == 20 );
+w.resize(v.size());
+
+int BOOST_LOCAL_FUNCTION(const bind& offset, int i) {
+ return ++i + offset;
+} BOOST_LOCAL_FUNCTION_NAME(inc)
+
+std::transform(v.begin(), v.end(), w.begin(), inc);
+BOOST_CHECK( w[0] == 16 ); BOOST_CHECK( w[1] == 26 );
+
+int BOOST_LOCAL_FUNCTION(bind& inc, int i, int j) {
+ return inc(i + j); // Call the other bound local function.
+} BOOST_LOCAL_FUNCTION_NAME(inc_sum)
+
+offset = 0;
+std::transform(v.begin(), v.end(), w.begin(), v.begin(), inc_sum);
+BOOST_CHECK( v[0] == 27 ); BOOST_CHECK( v[1] == 47 );
+</pre>
+
+ 
+</div>
+<div class="section boost_localfunction_Advanced_Topics_nesting">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Advanced_Topics.nesting"></a><a class="link" href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.nesting" title="Nesting">Nesting</a>
+</h3></div></div></div>
+
+ It is possible to nest local functions into one another. For example (see
+ also nesting.cpp):
+ 
+
+
+<pre class="programlisting">int x = 0;
+
+void BOOST_LOCAL_FUNCTION(bind& x) {
+ void BOOST_LOCAL_FUNCTION(bind& x) { // Nested.
+ x++;
+ } BOOST_LOCAL_FUNCTION_NAME(g)
+
+ x--;
+ g(); // Nested local function call.
+} BOOST_LOCAL_FUNCTION_NAME(f)
+
+f();
+</pre>
+
+ 
+</div>
+<div class="section boost_localfunction_Advanced_Topics_accessing_types__concepts__etc_">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Advanced_Topics.accessing_types__concepts__etc_"></a><a class="link" href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.accessing_types__concepts__etc_" title="Accessing Types (concepts, etc)">Accessing
+ Types (concepts, etc)</a>
+</h3></div></div></div>
+
+ This library never requires to explicitly specify the type of bound variables.
+ From within local functions, programmers can access the type of a bound variable
+ using the following macro:
+ 
+<pre class="programlisting">BOOST_LOCAL_FUNCTION_TYPEOF(bound-variable-name)
+</pre>
+
+ The <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION_TYPEOF.html" title="Macro BOOST_LOCAL_FUNCTION_TYPEOF">BOOST_LOCAL_FUNCTION_TYPEOF</a></code>
+ macro expands to a type expression that evaluates (at compile-time) to the
+ fully qualified type of the bound variable with the specified name. This
+ type expression is fully qualified in the sense that it will be constant
+ if the variable is bound by constant <code class="computeroutput">const
+ bind[&]</code>
+ and it will also be a reference if the variable is bound by reference <code class="computeroutput">[const]
+ bind&</code>
+ (if needed, programmers can remove the <code class="computeroutput">const</code>
+ and <code class="computeroutput">&</code> qualifiers using
+ <code class="computeroutput">boost::remove_const</code> and <code class="computeroutput">boost::remove_reference</code>,
+ see Boost.TypeTraits).
+ 
+
+ The deduced bound type can be used within the body to check concepts, declare
+ local variables, etc. For example (see also typeof.cpp
+ and addable.hpp):
+ 
+
+
+<pre class="programlisting">int sum = 0, factor = 10;
+
+void BOOST_LOCAL_FUNCTION(const bind factor, bind& sum, int num) {
+ // Typeof for concept checking.
+ BOOST_CONCEPT_ASSERT((Addable<boost::remove_reference<
+ BOOST_LOCAL_FUNCTION_TYPEOF(sum)>::type>));
+ // Typeof for declarations.
+ boost::remove_reference<BOOST_LOCAL_FUNCTION_TYPEOF(
+ factor)>::type mult = factor * num;
+ sum += mult;
+} BOOST_LOCAL_FUNCTION_NAME(add)
+
+add(6);
+</pre>
+
+ 
+
+ Within templates, <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION_TYPEOF.html" title="Macro BOOST_LOCAL_FUNCTION_TYPEOF">BOOST_LOCAL_FUNCTION_TYPEOF</a></code>
+ should not be prefixed by the <code class="computeroutput">typename</code>
+ keyword but eventual type manipulations need the <code class="computeroutput">typename</code>
+ prefix as usual (see also typeof_template.cpp
+ and addable.hpp):
+ 
+
+
+<pre class="programlisting">template<typename T>
+T calculate(const T& factor) {
+ T sum = 0;
+
+ void BOOST_LOCAL_FUNCTION_TPL(const bind factor, bind& sum, T num) {
+ // Local function `TYPEOF` does not need `typename`.
+ BOOST_CONCEPT_ASSERT((Addable<typename boost::remove_reference<
+ BOOST_LOCAL_FUNCTION_TYPEOF(sum)>::type>));
+ sum += factor * num;
+ } BOOST_LOCAL_FUNCTION_NAME(add)
+
+ add(6);
+ return sum;
+}
+</pre>
+
+ 
+
+ It is best to use the <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION_TYPEOF.html" title="Macro BOOST_LOCAL_FUNCTION_TYPEOF">BOOST_LOCAL_FUNCTION_TYPEOF</a></code>
+ macro instead of using Boost.Typeof
+ so to reduce the number of times that Boost.Typeof
+ is invoked:
+ 
+<div class="orderedlist"><ol class="orderedlist" type="1">
+<li class="listitem">
+ Either the library already internally used Boost.Typeof
+ once, in which case using this macro will not use Boost.Typeof
+ again.
+ </li>
+<li class="listitem">
+ Or, the bound variable type is explicitly specified by programmers (see
+ below), in which case using this macro will not use Boost.Typeof
+ at all.
+ </li>
+</ol></div>
+
+ Furthermore, within the local function body it possible to access the result
+ type using <code class="computeroutput">result_type</code>, the
+ type of the first parameter using <code class="computeroutput">arg1_type</code>,
+ the type of the second parameter using <code class="computeroutput">arg2_type</code>,
+ etc. [<a name="boost_localfunction.Advanced_Topics.accessing_types__concepts__etc_.f0" href="#ftn.boost_localfunction.Advanced_Topics.accessing_types__concepts__etc_.f0" class="footnote">21</a>]
+ 
+</div>
+<div class="section boost_localfunction_Advanced_Topics_specifying_types">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Advanced_Topics.specifying_types"></a><a class="link" href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.specifying_types" title="Specifying Types">Specifying
+ Types</a>
+</h3></div></div></div>
+
+ While not required, it is possible to explicitly specify the type of a bound
+ variable so the library will not internally use Boost.Typeof
+ to automatically deduce such a type. When specified, the bound variable type
+ must follow the <code class="computeroutput">bind</code> "keyword"
+ and it must be wrapped within round parenthesis <code class="computeroutput">()</code>:
+ 
+<pre class="programlisting">bind(variable-type) variable-name // Bind by value with explicit type.
+bind(variable-type)& variable-name // Bind by reference with explicit type.
+const bind(variable-type) variable-name // Bind by constant value with explicit type.
+const bind(variable-type)& variable-name // Bind by constant reference with explicit type.
+bind(class-type*) this_ // Bind object `this` with explicit type.
+const bind(class-type*) this_ // Bind object `this` by constant with explicit type.
+</pre>
+
+ Note that within the local function body it is always possible to abstract
+ the access to the type of a bound variable using <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION_TYPEOF.html" title="Macro BOOST_LOCAL_FUNCTION_TYPEOF">BOOST_LOCAL_FUNCTION_TYPEOF</a></code>
+ (even when the bound variable type is explicitly specified in the local function
+ declaration).
+ 
+
+ The library also uses Boost.Typeof
+ to determine the local function result type (because this type is specified
+ outside the <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">BOOST_LOCAL_FUNCTION</a></code>
+ macro). Thus it is also possible to specify the local function result type
+ as one of the <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">BOOST_LOCAL_FUNCTION</a></code>
+ macro parameters prefixing it by <code class="computeroutput">return</code>
+ so the library will not use Boost.Typeof
+ to deduce the result type:
+ 
+<pre class="programlisting">BOOST_LOCAL_FUNCTION_TYPE(return <code class="literal">result-type</code>, ...)
+</pre>
+
+ Note that the result type must be specified only once either before the macro
+ (without the <code class="computeroutput">return</code> prefix)
+ or as one of the macro parameters (with the <code class="computeroutput">return</code>
+ prefix). As usual, the result type can always be <code class="computeroutput">void</code>
+ to declare a function returning nothing (so <code class="computeroutput">return
+ void</code> is allowed when the result type
+ is specified as one of the macro parameters).
+ 
+
+ The following example specifies all bound variables and result types (see
+ also add_typed.cpp):
+ [<a name="boost_localfunction.Advanced_Topics.specifying_types.f0" href="#ftn.boost_localfunction.Advanced_Topics.specifying_types.f0" class="footnote">22</a>]
+ 
+
+
+<pre class="programlisting">struct adder {
+ adder(): sum_(0) {}
+
+ int sum(const std::vector<int>& nums, const int& factor = 10) {
+ // Explicitly specify bound variable and result types.
+ BOOST_LOCAL_FUNCTION(const bind(const int&) factor,
+ bind(adder*) this_, int num, return int) {
+ return this_->sum_ += factor * num;
+ } BOOST_LOCAL_FUNCTION_NAME(add)
+
+ std::for_each(nums.begin(), nums.end(), add);
+ return sum_;
+ }
+private:
+ int sum_;
+};
+</pre>
+
+ 
+
+ Unless necessary, it is recommended to not specify the bound variable and
+ result types. Let the library deduce these types so the local function syntax
+ will be more concise and the local function declaration will not have to
+ change if a bound variable type changes (facilitating maintenance).
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ Unfortunately, even when all bound variables and result types are explicitly
+ specified, the currently library implementation still has to use Boost.Typeof once (to deduce
+ the local function object type, see the <a class="link" href="Implementation.html" title="Annex: Implementation">Implementation</a>
+ section).
+ </td></tr>
+</table></div>
+</div>
+<div class="section boost_localfunction_Advanced_Topics_inlining">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Advanced_Topics.inlining"></a><a class="link" href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.inlining" title="Inlining">Inlining</a>
+</h3></div></div></div>
+
+ Local functions can be declared inline to increase the chances that the compiler
+ will be able to reduce the run-time of the local function call by inlining
+ the generated assembly code. A local function is declared inline by prefixing
+ its name with the keyword <code class="computeroutput">inline</code>:
+ 
+<pre class="programlisting">result-type BOOST_LOCAL_FUNCTION(parameters) {
+ ... // Body.
+} BOOST_LOCAL_FUNCTION_NAME(inline name) // Inlining.
+</pre>
+
+ When inlining a local function, note the following:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ On C++03
+ compliant compilers, inlined local functions always have a run-time comparable
+ to their equivalent implementation that uses local functors (see the
+ <a class="link" href="Alternatives.html" title="Annex: Alternatives">Alternatives</a>
+ section). However, inlined local functions have the important limitation
+ that they cannot be assigned to other functors (like <code class="computeroutput">boost::function</code>)
+ and they cannot be passed as template parameters.
+ </li>
+<li class="listitem">
+ On C++11
+ compilers, <code class="computeroutput">inline</code> has no
+ effect because this library will automatically generate code that uses
+ C++11 specific
+ features to inline the local function calls whenever possible even if
+ the local function is not declared inline. Furthermore, non C++11
+ local functions can always be passes as template parameters even when
+ they are declared inline. [<a name="boost_localfunction.Advanced_Topics.inlining.f0" href="#ftn.boost_localfunction.Advanced_Topics.inlining.f0" class="footnote">23</a>]
+ </li>
+</ul></div>
+<div class="important"><table border="0" summary="Important">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../../../../doc/src/images/important.png"></td>
+<th align="left">Important</th>
+</tr>
+<tr><td align="left" valign="top">
+ It is recommended to not declare a local function inline unless it is strictly
+ necessary for optimizing pure C++03
+ compliant code (because in all other cases this library will automatically
+ take advantage of C++11
+ features to optimize the local function calls while always allowing to
+ pass the local function as a template parameter).
+ </td></tr>
+</table></div>
+
+ For example, the following local function is declared inline (thus a for-loop
+ needs to be used for portability instead of passing the local function as
+ a template parameter to the <code class="computeroutput">std::for_each</code>
+ algorithm, see also add_inline.cpp):
+ 
+
+
+<pre class="programlisting">int sum = 0, factor = 10;
+
+void BOOST_LOCAL_FUNCTION(const bind factor, bind& sum, int num) {
+ sum += factor * num;
+} BOOST_LOCAL_FUNCTION_NAME(inline add) // Inlined.
+
+std::vector<int> v(100);
+std::fill(v.begin(), v.end(), 1);
+
+for(size_t i = 0; i < v.size(); ++i) add(v[i]); // Cannot use for_each.
+</pre>
+
+ 
+</div>
+<div class="section boost_localfunction_Advanced_Topics_recursion">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Advanced_Topics.recursion"></a><a class="link" href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.recursion" title="Recursion">Recursion</a>
+</h3></div></div></div>
+
+ Local functions can be declared recursive
+ so a local function can recursively call itself from its body (as usual with
+ C++ functions). A local function is declared recursive by prefixing its name
+ with the "keyword" <code class="computeroutput">recursive</code>
+ (thus <code class="computeroutput">recursive</code> cannot be
+ used as a local function name):
+ 
+<pre class="programlisting">result-type BOOST_LOCAL_FUNCTION(parameters) {
+ ... // Body.
+} BOOST_LOCAL_FUNCTION_NAME(recursive name) // Recursive.
+</pre>
+
+ For example, the following local function is used to recursively calculate
+ the factorials of all the numbers in the specified vector (see also factorial.cpp):
+ 
+
+
+<pre class="programlisting">struct calculator {
+ std::vector<int> results;
+
+ void factorials(const std::vector<int>& nums) {
+ int BOOST_LOCAL_FUNCTION(bind this_, int num,
+ bool recursion, default false) {
+ int result = 0;
+
+ if(num <= 0) result = 1;
+ else result = num * factorial(num - 1, true); // Recursive call.
+
+ if(!recursion) this_->results.push_back(result);
+ return result;
+ } BOOST_LOCAL_FUNCTION_NAME(recursive factorial) // Recursive.
+
+ std::for_each(nums.begin(), nums.end(), factorial);
+ }
+};
+</pre>
+
+ 
+
+ Compilers have not been observed to be able to inline recursive local function
+ calls (not even when the recursive local function is also declared inline
+ as in <code class="computeroutput">BOOST_LOCAL_FUNCTION_NAME(inline recursive
+ factorial)</code>).
+ 
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../doc/src/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td align="left" valign="top">
+ Recursive local functions should never be called outside their declaration
+ scope. If a local function is returned from the enclosing function and
+ called in a different scope, the behaviour is undefined (and it will likely
+ result in a run-time error). [<a name="boost_localfunction.Advanced_Topics.recursion.f0" href="#ftn.boost_localfunction.Advanced_Topics.recursion.f0" class="footnote">24</a>] This is not a limitation with respect to <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions because lambdas can never call themselves recursively
+ (in other words, there is no recursive lambda function that can successfully
+ be called outside its declaration scope because there is no recursive lambda
+ function at all).
+ </td></tr>
+</table></div>
+</div>
+<div class="section boost_localfunction_Advanced_Topics_overloading">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Advanced_Topics.overloading"></a><a class="link" href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.overloading" title="Overloading">Overloading</a>
+</h3></div></div></div>
+
+ It is possible to overload local functions using the <code class="computeroutput">boost::overloaded_function</code>
+ functor of Boost.Functional/OverloadedFunction
+ from the header <code class="literal">boost/functional/overloaded_function.hpp</code>
+ (see the Boost.Functional/OverloadedFunction
+ documentation for details).
+ 
+
+ In the following example, the overloaded function object <code class="computeroutput">add</code>
+ can be called with signatures from either the local function <code class="computeroutput">add_s</code>, or the local function <code class="computeroutput">add_d</code>, or the local function <code class="computeroutput">add_d</code> with its extra default parameter,
+ or the function pointer <code class="computeroutput">add_i</code>
+ (see also overload.cpp):
+ 
+
+
+<pre class="programlisting">int add_i(int x, int y) { return x + y; }
+
+BOOST_AUTO_TEST_CASE( test_overload ) {
+ std::string s = "abc";
+ std::string BOOST_LOCAL_FUNCTION(
+ const bind& s, const std::string& x) {
+ return s + x;
+ } BOOST_LOCAL_FUNCTION_NAME(add_s)
+
+ double d = 1.23;
+ double BOOST_LOCAL_FUNCTION(const bind d, double x, double y, default 0) {
+ return d + x + y;
+ } BOOST_LOCAL_FUNCTION_NAME(add_d)
+
+ boost::overloaded_function<
+ std::string (const std::string&)
+ , double (double)
+ , double (double, double) // Overload giving default param.
+ , int (int, int)
+ > add(add_s, add_d, add_d, add_i); // Overloaded function object.
+
+ BOOST_CHECK( add("xyz") == "abcxyz" ); // Call `add_s`.
+ BOOST_CHECK( fabs(add(3.21) - 4.44) < 0.001 ); // Call `add_d` (no default).
+ BOOST_CHECK( fabs(add(3.21, 40.0) - 44.44) < 0.001); // Call `add_d`.
+ BOOST_CHECK( add(1, 2) == 3 ); // Call `add_i`.
+}
+</pre>
+
+ 
+</div>
+<div class="section boost_localfunction_Advanced_Topics_exception_specifications">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Advanced_Topics.exception_specifications"></a><a class="link" href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.exception_specifications" title="Exception Specifications">Exception
+ Specifications</a>
+</h3></div></div></div>
+
+ It is possible to program exception specifications for local functions by
+ specifying them after the <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">BOOST_LOCAL_FUNCTION</a></code>
+ macro and before the body code block <code class="computeroutput">{
+ ... }</code>.
+ 
+<div class="important"><table border="0" summary="Important">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../../../../doc/src/images/important.png"></td>
+<th align="left">Important</th>
+</tr>
+<tr><td align="left" valign="top">
+ Note that the exception specifications only apply to the body code specified
+ by programmers and they do not apply to the rest of the code automatically
+ generated by the macro expansions to implement local functions. For example,
+ even if the body code is specified to throw no exception using <code class="computeroutput">throw () { ... }</code>,
+ the execution of the library code automatically generated by the macros
+ could still throw (if there is no memory, etc).
+ </td></tr>
+</table></div>
+
+ For example (see also add_except.cpp):
+ 
+
+
+<pre class="programlisting">double sum = 0.0;
+int factor = 10;
+
+void BOOST_LOCAL_FUNCTION(const bind factor, bind& sum,
+ double num) throw() { // Throw nothing.
+ sum += factor * num;
+} BOOST_LOCAL_FUNCTION_NAME(add)
+
+add(100);
+</pre>
+
+ 
+</div>
+<div class="section boost_localfunction_Advanced_Topics_storage_classifiers___auto__and__register__">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Advanced_Topics.storage_classifiers___auto__and__register__"></a><a class="link" href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.storage_classifiers___auto__and__register__" title="Storage Classifiers (auto and register)">Storage
+ Classifiers (<code class="computeroutput">auto</code> and <code class="computeroutput">register</code>)</a>
+</h3></div></div></div>
+
+ Local function parameters support the storage classifiers as usual in C++03.
+ The <code class="computeroutput">auto</code> storage classifier
+ is specified as: [<a name="boost_localfunction.Advanced_Topics.storage_classifiers___auto__and__register__.f0" href="#ftn.boost_localfunction.Advanced_Topics.storage_classifiers___auto__and__register__.f0" class="footnote">25</a>]
+ 
+<pre class="programlisting">auto parameter-type parameter-name
+</pre>
+
+ The <code class="computeroutput">register</code> storage classifier
+ is specified as:
+ 
+<pre class="programlisting">register parameter-type parameter-name
+</pre>
+
+ For example (see also add_classifiers.cpp):
+ 
+
+
+<pre class="programlisting">int BOOST_LOCAL_FUNCTION(auto int x, register int y) { // Classifiers.
+ return x + y;
+} BOOST_LOCAL_FUNCTION_NAME(add)
+</pre>
+
+ 
+</div>
+<div class="section boost_localfunction_Advanced_Topics_limitations__operators__etc_">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Advanced_Topics.limitations__operators__etc_"></a><a class="link" href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.limitations__operators__etc_" title="Limitations (operators, etc)">Limitations
+ (operators, etc)</a>
+</h3></div></div></div>
+
+ The following table summarizes all C++ function features indicating those
+ features that are not supported by this library for local functions.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ C++ Function Feature
+ 
+ </th>
+<th>
+ 
+ Local Function Support
+ 
+ </th>
+<th>
+ 
+ Comment
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">export</code>
+ 
+ </td>
+<td>
+ 
+ No
+ 
+ </td>
+<td>
+ 
+ This is not supported because local functions cannot be templates
+ (plus most C++ compilers do not implement <code class="computeroutput">export</code>
+ at all).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">template<</code><code class="literal">template-parameter-list</code><code class="computeroutput">></code>
+ 
+ </td>
+<td>
+ 
+ No
+ 
+ </td>
+<td>
+ 
+ This is not supported because local functions are implemented using
+ local classes and C++03
+ local classes cannot be templates.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">explicit</code>
+ 
+ </td>
+<td>
+ 
+ No
+ 
+ </td>
+<td>
+ 
+ This is not supported because local functions are not constructors.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">inline</code>
+ 
+ </td>
+<td>
+ 
+ Yes
+ 
+ </td>
+<td>
+ 
+ Local functions can be specified <code class="computeroutput">inline</code>
+ to improve the chances that C++03
+ standard compilers can optimize the local function call run-time
+ (but <code class="computeroutput">inline</code> local
+ functions cannot be passed as template parameters on C++03
+ standard compilers, see the <a class="link" href="Advanced_Topics.html" title="Advanced Topics">Advanced
+ Topics</a> section).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">extern</code>
+ 
+ </td>
+<td>
+ 
+ No
+ 
+ </td>
+<td>
+ 
+ This is not supported because local functions are always defined
+ locally within the enclosing scope and together with their declarations.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">static</code>
+ 
+ </td>
+<td>
+ 
+ No
+ 
+ </td>
+<td>
+ 
+ This is not supported because local functions are not member functions.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">virtual</code>
+ 
+ </td>
+<td>
+ 
+ No
+ 
+ </td>
+<td>
+ 
+ This is not supported because local functions are not member functions.
+ [<a name="boost_localfunction.Advanced_Topics.limitations__operators__etc_.f0" href="#ftn.boost_localfunction.Advanced_Topics.limitations__operators__etc_.f0" class="footnote">a</a>]
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="literal">result-type</code>
+ 
+ </td>
+<td>
+ 
+ Yes
+ 
+ </td>
+<td>
+ 
+ This is supported (see the <a class="link" href="Tutorial.html" title="Tutorial">Tutorial</a>
+ section).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="literal">function-name</code>
+ 
+ </td>
+<td>
+ 
+ Yes
+ 
+ </td>
+<td>
+ 
+ Local functions are named and they can call themselves recursively
+ but they cannot be operators (see the <a class="link" href="Tutorial.html" title="Tutorial">Tutorial</a>
+ and <a class="link" href="Advanced_Topics.html" title="Advanced Topics">Advanced
+ Topics</a> sections).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="literal">parameter-list</code>
+ 
+ </td>
+<td>
+ 
+ Yes
+ 
+ </td>
+<td>
+ 
+ This is supported and it also supports the <code class="computeroutput">auto</code>
+ and <code class="computeroutput">register</code> storage
+ classifiers, default parameters, and binding of variables in scope
+ (see the <a class="link" href="Tutorial.html" title="Tutorial">Tutorial</a>
+ and <a class="link" href="Advanced_Topics.html" title="Advanced Topics">Advanced
+ Topics</a> sections).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Trailing <code class="computeroutput">const</code> qualifier
+ 
+ </td>
+<td>
+ 
+ No
+ 
+ </td>
+<td>
+ 
+ This is not supported because local functions are not member functions.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Trailing <code class="computeroutput">volatile</code>
+ qualifier
+ 
+ </td>
+<td>
+ 
+ No
+ 
+ </td>
+<td>
+ 
+ This is not supported because local functions are not member functions.
+ 
+ </td>
+</tr>
+</tbody>
+<tbody class="footnotes"><tr><td colspan="3"><div class="footnote">[<a id="ftn.boost_localfunction.Advanced_Topics.limitations__operators__etc_.f0" href="#boost_localfunction.Advanced_Topics.limitations__operators__etc_.f0" class="para">a</a>] 
+ Rationale. It would be possible
+ to make a local function class inherit from another local function
+ class. However, this "inheritance" feature is not implemented
+ because it seemed of <a href="http://lists.boost.org/Archives/boost/2010/09/170895.php" target="_top">no
+ use</a> given that local functions can be bound to one another
+ thus they can simply call each other directly without recurring
+ to dynamic binding or base function call.
+ </div></td></tr></tbody>
+</table></div>
+<h6>
+<a name="boost_localfunction.Advanced_Topics.limitations__operators__etc_.h0"></a>
+ <a name="boost_localfunction.Advanced_Topics.limitations__operators__etc_.operators"></a><a class="link" href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.limitations__operators__etc_.operators">Operators</a>
+ </h6>
+
+ Local functions cannot be operators. Naming a local function <code class="computeroutput">operator...</code>
+ will generate a compile-time error. [<a name="boost_localfunction.Advanced_Topics.limitations__operators__etc_.f1" href="#ftn.boost_localfunction.Advanced_Topics.limitations__operators__etc_.f1" class="footnote">26</a>]
+ 
+
+ For example, the following code will not compile:
+ 
+
+
+<pre class="programlisting">struct point {
+ int x;
+ int y;
+};
+
+BOOST_AUTO_TEST_CASE( test_operator_err ) {
+ bool BOOST_LOCAL_FUNCTION(const point& p, const point& q) {
+ return p.x == q.x && p.y == q.y;
+ } BOOST_LOCAL_FUNCTION_NAME(operator==) // Error: Cannot use `operator...`.
+
+ point a; a.x = 1; a.y = 2;
+ point b = a;
+ BOOST_CHECK( a == b );
+}
+</pre>
+
+ 
+<h6>
+<a name="boost_localfunction.Advanced_Topics.limitations__operators__etc_.h1"></a>
+ <a name="boost_localfunction.Advanced_Topics.limitations__operators__etc_.goto"></a><a class="link" href="Advanced_Topics.html#boost_localfunction.Advanced_Topics.limitations__operators__etc_.goto">Goto</a>
+ </h6>
+
+ It is not possible to jump with a <code class="computeroutput">goto</code>
+ from within a local function to a label defined in the enclosing scope.
+ 
+
+ For example, the following will not compile:
+ 
+
+
+<pre class="programlisting">int error(int x, int y) {
+ int BOOST_LOCAL_FUNCTION(int x) {
+ if(x <= 0) goto failure; // Error: Cannot jump to enclosing scope.
+ else goto success; // OK: Can jump within local function.
+
+ success:
+ return 0;
+ } BOOST_LOCAL_FUNCTION_NAME(validate)
+
+ return validate(x + y);
+faliure:
+ return -1;
+}
+</pre>
+
+ 
+</div>
+<div class="footnotes">
+ <hr width="100" align="left">
+<div class="footnote">[<a id="ftn.boost_localfunction.Advanced_Topics.default_parameters.f0" href="#boost_localfunction.Advanced_Topics.default_parameters.f0" class="para">17</a>] 
+ Rationale. The assignment symbol <code class="computeroutput">=</code> cannot be used to specify default parameter
+ values because default values are not part of the parameter type so they
+ cannot be handled using template meta-programming. Default parameter values
+ need to be separated from the rest of the parameter declaration using the
+ preprocessor. Specifically, this library needs to use preprocessor meta-programming
+ to remove default values when constructing the local function type and
+ then to count the number of default values to provide the correct set of
+ call operators for the local functor. Therefore, the symbol <code class="computeroutput">=</code> cannot be used because it cannot be handled
+ by preprocessor meta-programming (non-alphanumeric symbols cannot be detected
+ by preprocessor meta-programming because they cannot be concatenated by
+ the preprocessor).
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Advanced_Topics.default_parameters.f1" href="#boost_localfunction.Advanced_Topics.default_parameters.f1" class="para">18</a>] 
+ The authors do not personally find the use of the <code class="computeroutput">WITH_DEFAULT</code>
+ macro more readable and they prefer to use the <code class="computeroutput">default</code>
+ keyword directly. Furthermore, <code class="computeroutput">WITH_DEFAULT</code>
+ needs to be defined differently for compilers without variadic macros
+ <code class="computeroutput">#define WITH_DEFAULT
+ (default)</code> so it can only be defined by programmers
+ based on the syntax they decide to use.
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Advanced_Topics.commas_and_symbols_in_macros.f0" href="#boost_localfunction.Advanced_Topics.commas_and_symbols_in_macros.f0" class="para">19</a>] 
+ Rationale. This limitation is because
+ this library uses preprocessor token concatenation <code class="literal">##</code>
+ to inspect the macro parameters (to distinguish between function parameters,
+ bound variables, etc) and the C++ preprocessor does not allow to concatenate
+ non-alphanumeric tokens.
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Advanced_Topics.commas_and_symbols_in_macros.f1" href="#boost_localfunction.Advanced_Topics.commas_and_symbols_in_macros.f1" class="para">20</a>] 
+ The preprocessor always interprets unwrapped commas as separating macro
+ parameters. Thus in this case the comma will indicate to the preprocessor
+ that the first macro parameter is <code class="computeroutput">const
+ std::map<std::tring</code>, the second macro parameter is
+ <code class="computeroutput">size_t>&
+ m</code>, etc instead of passing <code class="computeroutput">const std::map<std::string, size_t>& m</code>
+ as a single macro parameter.
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Advanced_Topics.accessing_types__concepts__etc_.f0" href="#boost_localfunction.Advanced_Topics.accessing_types__concepts__etc_.f0" class="para">21</a>] 
+ Rationale. The type names <code class="computeroutput">result_type</code> and <code class="computeroutput">arg</code><code class="literal">N</code><code class="computeroutput">_type</code> follow the Boost.TypeTraits
+ naming conventions for function traits.
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Advanced_Topics.specifying_types.f0" href="#boost_localfunction.Advanced_Topics.specifying_types.f0" class="para">22</a>] 
+ In the examples of this documentation, we specify bound variables, function
+ parameters, and result type in this order because this is the order used
+ by <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions. However, the library accepts bound variables,
+ function parameters, and the result type in any order.
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Advanced_Topics.inlining.f0" href="#boost_localfunction.Advanced_Topics.inlining.f0" class="para">23</a>] 
+ Rationale. This library uses an indirect
+ function call via a function pointer in order to pass the local function
+ as a template parameter (see the <a class="link" href="Implementation.html" title="Annex: Implementation">Implementation</a>
+ section). No compiler has yet been observed to be able to inline function
+ calls when they use such indirect function pointer calls. Therefore,
+ inlined local functions do not use such indirect function pointer call
+ (so they are more likely to be optimized) but because of that they
+ cannot be passed as template parameters. The indirect function pointer
+ call is needed on C++03
+ but it is not needed on C++11
+ (see [N2657])
+ thus this library automatically generates local function calls that
+ can be inlined on C++11
+ compilers (even when the local function is not declared inline).
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Advanced_Topics.recursion.f0" href="#boost_localfunction.Advanced_Topics.recursion.f0" class="para">24</a>] 
+ Rationale. This limitation comes from
+ the fact that the global functor used to pass the local function as a
+ template parameter (and eventually returned outside the declarations
+ scope) does not know the local function name so the local function name
+ used for recursive call cannot be set in the global functor. This limitation
+ together with preventing the possibility for inlining are the reasons
+ why local functions are not recursive unless programmers explicitly declare
+ them <code class="computeroutput">recursive</code>.
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Advanced_Topics.storage_classifiers___auto__and__register__.f0" href="#boost_localfunction.Advanced_Topics.storage_classifiers___auto__and__register__.f0" class="para">25</a>] 
+ The <code class="computeroutput">auto</code> storage classifier
+ is part of the C++03
+ standard and therefore supported by this library. However, the meaning
+ and usage of the <code class="computeroutput">auto</code> keyword
+ changed in C++11.
+ Therefore, use the <code class="computeroutput">auto</code> storage
+ classifier with the usual care in order to avoid writing C++03
+ code that might not work on C++11.
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Advanced_Topics.limitations__operators__etc_.f1" href="#boost_localfunction.Advanced_Topics.limitations__operators__etc_.f1" class="para">26</a>] 
+ Rationale. This is the because a local
+ function name must be a valid local variable name (the local variable used
+ to hold the local functor) and operators cannot be used as local variable
+ names.
+ </div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="Tutorial.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="Examples.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/boost_localfunction/Alternatives.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/boost_localfunction/Alternatives.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,1046 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Annex: Alternatives</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="prev" href="../BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX.html" title="Macro BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX">
+<link rel="next" href="No_Variadic_Macros.html" title="Annex: No Variadic Macros">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="No_Variadic_Macros.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section boost_localfunction_Alternatives">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_localfunction.Alternatives"></a><a class="link" href="Alternatives.html" title="Annex: Alternatives">Annex: Alternatives</a>
+</h2></div></div></div>
+
+ This section compares the features offered by this library with similar features
+ offered by C++ and by other libraries.
+ 
+<h6>
+<a name="boost_localfunction.Alternatives.h0"></a>
+ <a name="boost_localfunction.Alternatives.features"></a><a class="link" href="Alternatives.html#boost_localfunction.Alternatives.features">Features</a>
+ </h6>
+
+ The following table compares local function features.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Local Function Feature
+ 
+ </th>
+<th>
+ 
+ Boost.LocalFunction
+ 
+ </th>
+<th>
+ 
+ C++11 Lambda Function (Not C++03)
+ 
+ </th>
+<th>
+ 
+ Local Functor
+ 
+ </th>
+<th>
+ 
+ Global Functor (Not Local)
+ 
+ </th>
+<th>
+ 
+ Boost.Phoenix
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Can be defined locally
+ 
+ </td>
+<td>
+ 
+ Yes.
+ 
+ </td>
+<td>
+ 
+ Yes.
+ 
+ </td>
+<td>
+ 
+ Yes.
+ 
+ </td>
+<td>
+ 
+ No. Therefore this not really an alternative implementation of local
+ functions but it is listed here just for comparison.
+ 
+ </td>
+<td>
+ 
+ Yes.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Can be defined using C++ statement syntax
+ 
+ </td>
+<td>
+ 
+ Yes. Plus eventual compiler errors and debugging follow the usual
+ format of C++ statement errors.
+ 
+ </td>
+<td>
+ 
+ Yes. Plus eventual compiler errors and debugging follow the usual
+ format of C++ statement errors.
+ 
+ </td>
+<td>
+ 
+ Yes. Plus eventual compiler errors and debugging follow the usual
+ format of C++ statement errors.
+ 
+ </td>
+<td>
+ 
+ Yes. Plus eventual compiler errors and debugging follow the usual
+ format of C++ statement errors.
+ 
+ </td>
+<td>
+ 
+ No (it uses C++ <a href="http://en.wikibooks.org/wiki/More_C%2B%2B_Idioms/Expression-template" target="_top">expression
+ template</a> syntax).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Can be defined within expressions
+ 
+ </td>
+<td>
+ 
+ No. It can be defined only within declarations.
+ 
+ </td>
+<td>
+ 
+ Yes (plus the local function can be unnamed).
+ 
+ </td>
+<td>
+ 
+ No. It can be defined only within declarations.
+ 
+ </td>
+<td>
+ 
+ No. It can be defined only within declarations.
+ 
+ </td>
+<td>
+ 
+ Yes (plus the local function can be unnamed).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Can be passed as template parameter (e.g., to STL algorithms)
+ 
+ </td>
+<td>
+ 
+ Yes. The C++03
+ standard does not allow to pass local types as template parameters
+ (see [N2657])
+ but this library implements a "trick" to get around this
+ limitation (see the <a class="link" href="Implementation.html" title="Annex: Implementation">Implementation</a>
+ section).
+ 
+ </td>
+<td>
+ 
+ Yes.
+ 
+ </td>
+<td>
+ 
+ No on C++03
+ compilers (but yes on C++11
+ compilers and some compilers like MSVC 8.0, see [N2657]).
+ 
+ </td>
+<td>
+ 
+ Yes.
+ 
+ </td>
+<td>
+ 
+ Yes.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Access variables in scope
+ 
+ </td>
+<td>
+ 
+ Yes. The variable names are repeated in the function declaration
+ so they can be bound by value, by constant value, by reference, and
+ by constant reference (the object <code class="computeroutput">this</code>
+ can also be bound).
+ 
+ </td>
+<td>
+ 
+ Yes. The variable names are repeated in the function declaration
+ (plus there is a short-hand syntax to bind all variables in scope
+ at once) so they can be bound by constant value and by reference
+ (the object <code class="computeroutput">this</code> can
+ also be bound). However, variables cannot be bound by constant references
+ and non-constant value (see below).
+ 
+ </td>
+<td>
+ 
+ No. Programmers must manually program functor data members and explicitly
+ specify their types to access variables in scope.
+ 
+ </td>
+<td>
+ 
+ No. Programmers must manually program functor data members and explicitly
+ specify their types to access variables in scope.
+ 
+ </td>
+<td>
+ 
+ Yes. Variables in scope are accessible as usual within expressions
+ (plus <code class="computeroutput">boost::phoenix::let</code> can be used to bind variables
+ by constant reference).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Polymorphic
+ in the unbound parameter types
+ 
+ </td>
+<td>
+ 
+ No (local functions cannot be function templates).
+ 
+ </td>
+<td>
+ 
+ No (C++11
+ lambdas cannot be function templates).
+ 
+ </td>
+<td>
+ 
+ No (local classes cannot have member function templates).
+ 
+ </td>
+<td>
+ 
+ Yes.
+ 
+ </td>
+<td>
+ 
+ Yes.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ C++11 Lambda Function
+ 
+
+ <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions have most of the features of this library (see also
+ the example in the <a class="link" href="../index.html#boost_localfunction.Introduction" title="Introduction">Introduction</a>
+ section):
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions can be defined within expressions while this library
+ local functions can only be defined at declaration scope.
+ </li>
+<li class="listitem">
+ <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions are only supported by the C++11
+ standard so they are not supported by all C++ compilers. This library local
+ functions can be programmed also on C++03
+ compilers (and they have performances comparable to <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions on C++11
+ compilers).
+ </li>
+<li class="listitem">
+ <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions do not allow to bind variables in scope by constant
+ reference or by non-constant value. Because a variable cannot be bound
+ by constant reference, <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions can bind a variable by constant only if the variable
+ is <code class="computeroutput">CopyConstructible</code> and
+ the binding requires a (potentially expensive) extra copy operation. Both
+ constant reference and non-constant value binding are instead supported
+ by this library. However, <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions provide a short-hand syntax to bind all variables
+ in scope at once (<code class="computeroutput">&</code> or
+ <code class="computeroutput">=</code>).
+ </li>
+</ul></div>
+
+ For example, for non-copyable objects (see also noncopyable_lambda_err.cpp
+ and noncopyable_local_function.cpp):
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ C++11 Lambda
+ 
+ </th>
+<th>
+ 
+ Boost.LocalFunction
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">struct n: boost::noncopyable {
+ int i;
+ n(int _i): i(_i) {}
+};
+
+int main(void) {
+ n x(-1);
+
+ auto f = [x](void) { // Error: x is non-copyable, but if
+ assert( x.i == -1 ); // bind `&x` then `x` is not constant.
+ };
+ f();
+
+ return 0;
+}
+</pre>
+
+ 
+ </td>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">struct n: boost::noncopyable {
+ int i;
+ n(int _i): i(_i) {}
+};
+
+int main() {
+ n x(-1);
+
+ void BOOST_LOCAL_FUNCTION(const bind& x) { // OK: No copy
+ assert( x.i == -1 ); // and constant.
+ } BOOST_LOCAL_FUNCTION_NAME(f)
+ f();
+
+ return 0;
+}
+</pre>
+
+ 
+ </td>
+</tr></tbody>
+</table></div>
+
+ Or, for objects with expensive copy operations (see also expensive_copy_lambda.cpp
+ and expensive_copy_local_function.cpp):
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ C++11 Lambda
+ 
+ </th>
+<th>
+ 
+ Boost.LocalFunction
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">struct n {
+ int i;
+ n(int _i): i(_i) {}
+ n(n const& x): i(x.i) { // Some time consuming copy.
+ for (unsigned i = 0; i < 10000; ++i) std::cout << '.';
+ }
+};
+
+int main(void) {
+ n x(-1);
+
+ auto f = [x]() { // Problem: Expensive copy, but if bind
+ assert( x.i == -1); // by `&x` then `x` is not constant.
+ };
+ f();
+
+ return 0;
+}
+</pre>
+
+ 
+ </td>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">struct n {
+ int i;
+ n(int _i): i(_i) {}
+ n(n const& x): i(x.i) { // Some time consuming copy.
+ for (unsigned i = 0; i < 10000; ++i) std::cout << '.';
+ }
+};
+
+int main(void) {
+ n x(-1);
+
+ void BOOST_LOCAL_FUNCTION(const bind& x) { // OK: No copy
+ assert( x.i == -1 ); // and constant.
+ } BOOST_LOCAL_FUNCTION_NAME(f)
+ f();
+
+ return 0;
+}
+</pre>
+
+ 
+ </td>
+</tr></tbody>
+</table></div>
+
+ When constant binding functionality is needed for <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions, the best alternative might be to bind an extra local
+ variable declared constant and initialized to the original variable (for example,
+ <code class="computeroutput">const n& const_x = x</code> and then
+ bind <code class="computeroutput">const_x</code> instead of <code class="computeroutput">x</code> to the lambda function). In many cases
+ the use of the extra constant variable <code class="computeroutput">const_x</code>
+ can be acceptable but in other cases (e.g., constant blocks
+ presented in the <a class="link" href="Examples.html" title="Examples">Examples</a>
+ section) it might be preferable to maintain the same variable name <code class="computeroutput">x</code> within the function body.
+ 
+
+ Local Functor
+ 
+
+ The following example compares local functions with C++ local functors (see
+ also add_local_functor.cpp
+ and add.cpp):
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Local Functor
+ 
+ </th>
+<th>
+ 
+ Boost.LocalFunction
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">{
+ int sum = 0, factor = 10;
+
+ struct local_add { // Unfortunately, boilerplate code to program the class.
+ local_add(int& _sum, int _factor): sum(_sum), factor(_factor) {}
+
+ inline void operator()(int num) { // Body uses C++ statement syntax.
+ sum += factor * num;
+ }
+ private: // Unfortunately, cannot bind so repeat variable types.
+ int& sum; // Access `sum` by reference.
+ const int factor; // Make `factor` constant.
+ } add(sum, factor);
+
+ add(1);
+ int nums[] = {2, 3};
+ // Unfortunately, cannot pass as template parameter to `std::for_each`.
+ for(size_t i = 0; i < 2; ++i) add(nums[i]);
+
+ BOOST_CHECK( sum == 60 );
+}
+</pre>
+
+ 
+ </td>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">{ // Some local scope.
+ int sum = 0, factor = 10; // Variables in scope to bind.
+
+ void BOOST_LOCAL_FUNCTION(const bind factor, bind& sum, int num) {
+ sum += factor * num;
+ } BOOST_LOCAL_FUNCTION_NAME(add)
+
+ add(1); // Call the local function.
+ int nums[] = {2, 3};
+ std::for_each(nums, nums + 2, add); // Pass it to an algorithm.
+
+ BOOST_CHECK( sum == 60 ); // Assert final summation value.
+}
+</pre>
+
+ 
+ </td>
+</tr></tbody>
+</table></div>
+
+ Global Functor
+ 
+
+ The following example compares local functions with C++ global functors (see
+ also add_global_functor.cpp
+ and add.cpp):
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Global Functor
+ 
+ </th>
+<th>
+ 
+ Boost.LocalFunction
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">// Unfortunately, cannot be defined locally (so not a real alternative).
+struct global_add { // Unfortunately, boilerplate code to program the class.
+ global_add(int& _sum, int _factor): sum(_sum), factor(_factor) {}
+
+ inline void operator()(int num) { // Body uses C++ statement syntax.
+ sum += factor * num;
+ }
+private: // Unfortunately, cannot bind so repeat variable types.
+ int& sum; // Access `sum` by reference.
+ const int factor; // Make `factor` constant.
+};
+
+BOOST_AUTO_TEST_CASE( test_add_global_functor ) {
+ int sum = 0, factor = 10;
+
+ global_add add(sum, factor);
+
+ add(1);
+ int nums[] = {2, 3};
+ std::for_each(nums, nums + 2, add); // Passed as template parameter.
+
+ BOOST_CHECK( sum == 60 );
+}
+</pre>
+
+ 
+ </td>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">{ // Some local scope.
+ int sum = 0, factor = 10; // Variables in scope to bind.
+
+ void BOOST_LOCAL_FUNCTION(const bind factor, bind& sum, int num) {
+ sum += factor * num;
+ } BOOST_LOCAL_FUNCTION_NAME(add)
+
+ add(1); // Call the local function.
+ int nums[] = {2, 3};
+ std::for_each(nums, nums + 2, add); // Pass it to an algorithm.
+
+ BOOST_CHECK( sum == 60 ); // Assert final summation value.
+}
+</pre>
+
+ 
+ </td>
+</tr></tbody>
+</table></div>
+
+ However, note that global functors do not allow to define the function locally
+ so they are not a real alternative implementation of local functions.
+ 
+
+ Boost.Phoenix
+ 
+
+ The following example compares local functions with Boost.Phoenix
+ (see also add_phoenix.cpp
+ and add.cpp):
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Boost.Phoenix
+ 
+ </th>
+<th>
+ 
+ Boost.LocalFunction
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">{
+ using boost::phoenix::let;
+ using boost::phoenix::local_names::_f;
+ using boost::phoenix::cref;
+ using boost::phoenix::ref;
+ using boost::phoenix::arg_names::_1;
+
+ int sum = 0, factor = 10;
+ int nums[] = {1, 2, 3};
+
+ // Passed to template, `factor` by constant, and defined in expression.
+ std::for_each(nums, nums + 3, let(_f = cref(factor))[
+ // Unfortunately, body cannot use C++ statement syntax.
+ ref(sum) += _f * _1 // Access `sum` by reference.
+ ]);
+
+ BOOST_CHECK( sum == 60 );
+}
+</pre>
+
+ 
+ </td>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">{ // Some local scope.
+ int sum = 0, factor = 10; // Variables in scope to bind.
+
+ void BOOST_LOCAL_FUNCTION(const bind factor, bind& sum, int num) {
+ sum += factor * num;
+ } BOOST_LOCAL_FUNCTION_NAME(add)
+
+ add(1); // Call the local function.
+ int nums[] = {2, 3};
+ std::for_each(nums, nums + 2, add); // Pass it to an algorithm.
+
+ BOOST_CHECK( sum == 60 ); // Assert final summation value.
+}
+</pre>
+
+ 
+ </td>
+</tr></tbody>
+</table></div>
+
+ The comparison in this section does not include the Boost.Lambda
+ library because that library is obsolete and it was replaced by Boost.Phoenix.
+ The Boost.Phoenix library
+ version 3.0 is used for this comparison.
+ 
+<h6>
+<a name="boost_localfunction.Alternatives.h1"></a>
+ <a name="boost_localfunction.Alternatives.performances"></a><a class="link" href="Alternatives.html#boost_localfunction.Alternatives.performances">Performances</a>
+ </h6>
+
+ The following tables compare run-times, compile-times, and binary sizes for
+ the different alternatives presented here for local functions.
+ 
+
+ Overall, this library has compile-times and generates binary sizes similar
+ to the ones of the other approaches. This library run-times on C++03
+ compilers were measured to be larger than other approaches when compiler optimization
+ is enabled (using <code class="computeroutput">bjam release
+ ...</code>). However, on compilers that allow
+ to pass local types as template parameters (e.g., MSVC 8.0 or GCC 4.5.3 with
+ C++11 features
+ enabled <code class="literal">-std=c++0x</code>, see also [N2657])
+ this library automatically generates optimized code that runs as fast as the
+ fastest of the other approaches (see the "Boost.LocalFunction" approach
+ below). When this library local function is specified <code class="computeroutput">inline</code>
+ (see the "Boost.LocalFunction Inline" approach below and the <a class="link" href="Advanced_Topics.html" title="Advanced Topics">Advanced Topics</a> section)
+ its run-times are always comparable to both the "Local Functor" and
+ "Global Functor" approaches. However, in these cases the local function
+ cannot be portably passed as template parameter (see [N2657])
+ so <code class="computeroutput">std::for_each</code> is replaced by a for-loop (on MSVC
+ the for-loop, and not the local function in fact the same applies to local
+ functors, was measured to have worst performances than using <code class="computeroutput">std::for_each</code>).
+ Finally, this library run-times are always among the fastest when no compiler
+ optimization is enabled (using <code class="computeroutput">bjam
+ debug ...</code>).
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ The run-time performances of this library local functions are explained because
+ on C++03
+ compliant compilers (e.g., GCC 4.5.3 without <code class="literal">-std=c++0x</code>)
+ this library needs to use a function pointer in order to pass the local function
+ class as a template parameter (see [N2657]
+ and the <a class="link" href="Implementation.html" title="Annex: Implementation">Implementation</a>
+ section). For all tested compilers, this function pointer prevents the compiler
+ optimization algorithms from inlining the local function calls. Instead,
+ the functors used by other approaches (e.g., Boost.Phoenix)
+ have been observed to allow all tested compilers to inline all the function
+ calls for optimization. This run-time performance cost is not present on
+ compilers that allow to pass local types as template parameters (e.g., MSVC
+ 8.0 or GCC 4.5.3 with C++11
+ features enabled <code class="literal">-std=c++0x</code>) because this library does
+ not have to use the extra function pointer to implement the local function
+ call (it directly passes the local class type as template parameter).
+ </td></tr>
+</table></div>
+
+ This run-time performance cost on C++03
+ compilers might or might not be an issue depending on the performance requirements
+ of specific applications. For example, an application might already be using
+ a number of indirect function calls (function pointers, virtual functions,
+ etc) for which the overhead added by using the one extra function pointer required
+ by the local function call might not be noticeable within the overall program
+ run-time.
+ 
+
+ Finally, note that only a very simple local function body with just a single
+ instruction was used for the anaylsis presented here (see the source files
+ below). The authors have not studied how this library and the other approaches
+ will perform with respect to each other when a more complex set of instructions
+ is programmed for the local function body (e.g., if a
+ more complex set of instructions in the local function body were to inhibit
+ some compilers from inlining functor objects also other approaches like Boost.Phoenix could
+ start to show higher run-times even when optimization is enabled).
+ 
+
+ The following commands were executed from the library example directory to
+ measure compile-time, binary size, and run-time respectively:
+ 
+<pre class="programlisting">> touch <FILE_NAME>.cpp # force recompilation
+> python chrono.py bjam {release|debug} <FILE_NAME> # compile-time
+> size <FILE_NAME> # binary size
+> ./<FILE_NAME> # run-time
+</pre>
+
+ The local function was called <code class="literal">1e8</code> times to add together
+ all the elements of a vector and the run-time was measured using Boost.Chrono
+ averaging over <code class="literal">10</code> executions of the vector summation (see
+ the source files below).
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Legend
+ 
+ </th>
+<th>
+ 
+ Approach
+ 
+ </th>
+<th>
+ 
+ Source File
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <img src="../../../example/profile_legend_local_function.png" alt="profile_legend_local_function">
+ 
+ </td>
+<td>
+ 
+ Boost.LocalFunction
+ 
+ </td>
+<td>
+ 
+ profile_local_function.cpp
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <img src="../../../example/profile_legend_local_function_inline.png" alt="profile_legend_local_function_inline">
+ 
+ </td>
+<td>
+ 
+ Boost.LocalFunction
+ inline
+ 
+ </td>
+<td>
+ 
+ profile_local_function_inline.cpp
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <img src="../../../example/profile_legend_lambda.png" alt="profile_legend_lambda">
+ 
+ </td>
+<td>
+ 
+ C++11
+ Lambda Function [<a name="boost_localfunction.Alternatives.f0" href="#ftn.boost_localfunction.Alternatives.f0" class="footnote">a</a>]
+ 
+ </td>
+<td>
+ 
+ profile_lambda.cpp
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <img src="../../../example/profile_legend_local_functor.png" alt="profile_legend_local_functor">
+ 
+ </td>
+<td>
+ 
+ Local Functor
+ 
+ </td>
+<td>
+ 
+ profile_local_functor.cpp
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <img src="../../../example/profile_legend_global_functor.png" alt="profile_legend_global_functor">
+ 
+ </td>
+<td>
+ 
+ Global Functor
+ 
+ </td>
+<td>
+ 
+ profile_global_functor.cpp
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <img src="../../../example/profile_legend_phoenix.png" alt="profile_legend_phoenix">
+ 
+ </td>
+<td>
+ 
+ Boost.Phoenix
+ 
+ </td>
+<td>
+ 
+ profile_phoenix.cpp
+ 
+ </td>
+</tr>
+</tbody>
+<tbody class="footnotes"><tr><td colspan="3"><div class="footnote">[<a id="ftn.boost_localfunction.Alternatives.f0" href="#boost_localfunction.Alternatives.f0" class="para">a</a>] 
+ Measurements available only for C++11
+ compilers.
+ </div></td></tr></tbody>
+</table></div>
+<div class="informaltable"><table class="table">
+<colgroup><col></colgroup>
+<thead><tr><th>
+ 
+ GCC 4.5.3 With C++11 Lambdas and "Local Types as Template Parameters"
+ (<code class="literal">bjam cxxflags=-std=c++0x ...</code>)
+ 
+ </th></tr></thead>
+<tbody>
+<tr><td>
+ 
+ Compiled with <code class="literal">bjam release ...</code>
+ for maximum optimization (<code class="literal">-O3 -finline-functions</code>)
+ <img src="../../../example/profile_gcc_cpp11_release.png" width="1170" alt="profile_gcc_cpp11_release">
+ 
+ </td></tr>
+<tr><td>
+ 
+ Compiled with <code class="literal">bjam debug ...</code>
+ for no optimization (<code class="literal">-O0 -fno-inline</code>)
+ <img src="../../../example/profile_gcc_cpp11_debug.png" width="1170" alt="profile_gcc_cpp11_debug">
+ 
+ </td></tr>
+</tbody>
+</table></div>
+<div class="informaltable"><table class="table">
+<colgroup><col></colgroup>
+<thead><tr><th>
+ 
+ MSVC 8.0 With "Local Types as Template Parameters" (Without
+ C++11
+ Lambdas)
+ 
+ </th></tr></thead>
+<tbody>
+<tr><td>
+ 
+ Compiled with <code class="literal">bjam release ...</code>
+ for maximum optimization (<code class="literal">/O2 /Ob2</code>)
+ <img src="../../../example/profile_msvc_release.png" width="1170" alt="profile_msvc_release">
+ 
+ </td></tr>
+<tr><td>
+ 
+ Compiled with <code class="literal">bjam debug ...</code>
+ for no optimization (<code class="literal">/Od /Ob0</code>) <img src="../../../example/profile_msvc_debug.png" width="1170" alt="profile_msvc_debug">
+ 
+ </td></tr>
+</tbody>
+</table></div>
+<div class="informaltable"><table class="table">
+<colgroup><col></colgroup>
+<thead><tr><th>
+ 
+ GCC 4.3.4 With C++03
+ Only (Without C++11
+ Lambdas and Without "Local Types as Template Parameters")
+ 
+ </th></tr></thead>
+<tbody>
+<tr><td>
+ 
+ Compiled with <code class="literal">bjam release ...</code>
+ for maximum optimization (<code class="literal">-O3 -finline-functions</code>)
+ <img src="../../../example/profile_gcc_release.png" width="1170" alt="profile_gcc_release">
+ 
+ </td></tr>
+<tr><td>
+ 
+ Compiled with <code class="literal">bjam debug ...</code>
+ for no optimization (<code class="literal">-O0 -fno-inline</code>)
+ <img src="../../../example/profile_gcc_debug.png" width="1170" alt="profile_gcc_debug">
+ 
+ </td></tr>
+</tbody>
+</table></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="No_Variadic_Macros.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/boost_localfunction/Bibliography.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/boost_localfunction/Bibliography.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,74 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Bibliography</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="prev" href="Release_Notes.html" title="Release Notes">
+<link rel="next" href="Acknowledgments.html" title="Acknowledgments">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="Release_Notes.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="Acknowledgments.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section boost_localfunction_Bibliography">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_localfunction.Bibliography"></a><a class="link" href="Bibliography.html" title="Bibliography">Bibliography</a>
+</h2></div></div></div>
+
+ This section lists all the bibliographic references cited by this documentation.
+ 
+
+ [N1613]
+ Thorsten Ottosen. Proposal to add Design by Contract to C++.
+ The C++ Standards Committee, document no. N1613=04-0053, 2004.
+ 
+
+ [N2511]
+ Alisdair Meredith. Named Lambdas and Local Functions.
+ The C++ Standards Committee, document no. N2511=08-0021, 2008.
+ 
+
+ [N2529]
+ Jaakko Jarvi, John Freeman, Lawrence Crowl. Lambda Expressions and
+ Closures: Wording for Monomorphic Lambdas (Revision 3). The C++
+ Standards Committee, document no. N2529=08-0039, 2008.
+ 
+
+ [N2550]
+ Jaakko Jarvi, John Freeman, Lawrence Crowl. Lambda Expressions and
+ Closures: Wording for Monomorphic Lambdas (Revision 4). The C++
+ Standards Committee, document no. N2550=08-0060, 2008.
+ 
+
+ [N2657]
+ John Spicer. Local and Unamed Types as Template Arguments.
+ The C++ Standard Committee, document no. N2657=08-0167, 2008.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="Release_Notes.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="Acknowledgments.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/boost_localfunction/Examples.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/boost_localfunction/Examples.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,606 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Examples</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="prev" href="Advanced_Topics.html" title="Advanced Topics">
+<link rel="next" href="../reference.html" title="Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="Advanced_Topics.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../reference.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section boost_localfunction_Examples">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_localfunction.Examples"></a><a class="link" href="Examples.html" title="Examples">Examples</a>
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt><a href="Examples.html#boost_localfunction.Examples.gcc_lambdas__without_c__11_">GCC
+ Lambdas (Without C++11)</a></dt>
+<dt><a href="Examples.html#boost_localfunction.Examples.constant_blocks">Constant
+ Blocks</a></dt>
+<dt>Scope Exits</dt>
+<dt><a href="Examples.html#boost_localfunction.Examples.boost_phoenix_functions">Boost.Phoenix
+ Functions</a></dt>
+<dt>Closures</dt>
+<dt><a href="Examples.html#boost_localfunction.Examples.gcc_nested_functions">GCC
+ Nested Functions</a></dt>
+<dt>N-Papers</dt>
+</dl></div>
+
+ This section lists some examples that use this library.
+ 
+<div class="section boost_localfunction_Examples_gcc_lambdas__without_c__11_">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Examples.gcc_lambdas__without_c__11_"></a><a class="link" href="Examples.html#boost_localfunction.Examples.gcc_lambdas__without_c__11_" title="GCC Lambdas (Without C++11)">GCC
+ Lambdas (Without C++11)</a>
+</h3></div></div></div>
+
+ Combing local functions with the <a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html" target="_top">statement
+ expression</a> extension of GCC compilers, it is possible to implement
+ lambda functions for GCC compilers even without C++11
+ support.
+ 
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../doc/src/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td align="left" valign="top">
+ This code only works on compilers that support the statement expression
+ GCC extension or that support <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions.
+ </td></tr>
+</table></div>
+
+ For example (see also gcc_lambda.cpp
+ and gcc_lambda_cpp11.cpp):
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ With Local Functions (GCC only)
+ 
+ </th>
+<th>
+ 
+ C++11 Lambdas
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">int val = 2;
+int nums[] = {1, 2, 3};
+int* end = nums + 3;
+
+int* iter = std::find_if(nums, end,
+ GCC_LAMBDA(const bind val, int num, return bool) {
+ return num == val;
+ } GCC_LAMBDA_END
+);
+</pre>
+
+ 
+ </td>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">int val = 2;
+int nums[] = {1, 2, 3};
+int* end = nums + 3;
+
+int* iter = std::find_if(nums, end,
+ [val](int num) -> bool {
+ return num == val;
+ }
+);
+</pre>
+
+ 
+ </td>
+</tr></tbody>
+</table></div>
+
+ Where the macros are defined in gcc_lambda.hpp.
+ 
+
+ This is possible because GCC statement expressions allow to use declaration
+ statements within expressions and therefore to declare a local function within
+ an expression. The macros automatically detect if the compiler supports
+ <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions in which case the implementation uses native lambdas
+ instead of local functions in statement expressions. However, <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions do not support constant binding so it is best to
+ only use <code class="computeroutput">const bind
+ variable</code> (same as <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> <code class="computeroutput">=variable</code>)
+ and <code class="computeroutput">bind&
+ variable</code> (same as <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> <code class="computeroutput">&variable</code>)
+ because these have the exact same semantic between the local function and
+ native lambda implementation. Unfortunately, the <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> short-hand binds <code class="computeroutput">&</code>
+ and <code class="computeroutput">=</code> (which automatically bind
+ all variables in scope either by reference or value) are not supported by
+ the macros because they are not supported by the local function implementation.
+ Finally, the result type <code class="computeroutput">return </code><code class="literal">result-type</code>
+ is optional and it is assumed <code class="computeroutput">void</code>
+ when it is not specified (same as with <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions).
+ 
+</div>
+<div class="section boost_localfunction_Examples_constant_blocks">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Examples.constant_blocks"></a><a class="link" href="Examples.html#boost_localfunction.Examples.constant_blocks" title="Constant Blocks">Constant
+ Blocks</a>
+</h3></div></div></div>
+
+ It is possible to use local functions to check assertions between variables
+ that are made constant within the asserted expressions. This is advantageous
+ because assertions are not supposed to change the state of the program and
+ ideally the compiler will not compile assertions that modify variables.
+ 
+
+ For example, consider the following assertion where by mistake we programmed
+ <code class="computeroutput">operator=</code>
+ instead of <code class="computeroutput">operator==</code>:
+ 
+<pre class="programlisting">int x = 1, y = 2;
+assert(x = y); // Mistakenly `=` instead of `==`.
+</pre>
+
+ Ideally this code will not compile instead this example not only compiles
+ but the assertion even passes the run-time check and no error is generated
+ at all. The [N1613]
+ paper introduces the idea of a const-block which could
+ be used to wrap the assertion above and catch the programming error at compile-time.
+ Similarly, the following code will generate a compile-time error when <code class="computeroutput">operator=</code>
+ is mistakenly used instead of <code class="computeroutput">operator==</code> because both <code class="computeroutput">x</code>
+ and <code class="computeroutput">y</code> are made constants
+ (using local functions) within the block of code performing the assertion
+ (see also const_block_err.cpp):
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ With Local Functions
+ 
+ </th>
+<th>
+ 
+ N1613 Const-Blocks
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">int x = 1, y = 2;
+CONST_BLOCK(x, y) { // Constant block.
+ assert(x = y); // Compiler error.
+} CONST_BLOCK_END
+</pre>
+
+ 
+ </td>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">int x = 1, y = 2;
+const { // Constant block.
+ assert(x = y); // Compiler error.
+}
+</pre>
+
+ 
+ </td>
+</tr></tbody>
+</table></div>
+
+ Where the macros are defined in const_block.hpp.
+ 
+
+ The constant block macros are implemented using a local function which binds
+ by constant reference <code class="computeroutput">const bind&</code>
+ all the specified variables (so the variables are constant within the code
+ block but they do not need to be <code class="computeroutput">CopyConstructible</code>
+ and no extra copy is performed). The local function executes the <code class="computeroutput">assert</code> instruction in its body which is
+ called immediately after it is defined. More in general, constant blocks
+ can be used to evaluate any instruction (not just assertions) within a block
+ were all specified variables are constant.
+ 
+
+ Unfortunately, constant blocks cannot be implemented with <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions because these do not support constant binding (of
+ course it is always possible to introduce extra constant variables <code class="computeroutput">const int& const_x
+ = x</code>,
+ etc and use these variables in the assertion). Variables bound by value using
+ <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions (<code class="computeroutput">variable</code>,
+ <code class="computeroutput">=variable</code>,
+ and <code class="computeroutput">=</code>) are constant but they
+ are required to be <code class="computeroutput">CopyConstructible</code>
+ and they introduce potentially expensive copy operations. [<a name="boost_localfunction.Examples.constant_blocks.f0" href="#ftn.boost_localfunction.Examples.constant_blocks.f0" class="footnote">27</a>]
+ 
+</div>
+<div class="section boost_localfunction_Examples_scope_exits">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Examples.scope_exits"></a><a class="link" href="Examples.html#boost_localfunction.Examples.scope_exits" title="Scope Exits">Scope Exits</a>
+</h3></div></div></div>
+
+ Scope exits allow to execute arbitrary code at the exit of the enclosing
+ scope and they are provided by the Boost.ScopeExit
+ library.
+ 
+
+ For curiosity, here we show how to re-implement scope exits using local functions.
+ One small advantage of scope exits that use local functions is that they
+ support constant binding. Boost.ScopeExit
+ does not directly support constant binding (however, it is always possible
+ to introduce an extra <code class="computeroutput">const</code>
+ local variable, assign it to the value to bind, and then bind the <code class="computeroutput">const</code> variable so to effectively have constant
+ binding with Boost.ScopeExit
+ as well). In general, the authors recommend to use Boost.ScopeExit
+ instead of the code listed here whenever possible.
+ 
+
+ The following example binds <code class="computeroutput">p</code>
+ by constant reference so this variable cannot be modified within the scope
+ exit body but it is not copied and it will present the value it has at the
+ exit of the enclosing scope and not at the scope exit declaration (see also
+ scope_exit.cpp):
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ With Local Functions
+ 
+ </th>
+<th>
+ 
+ Boost.ScopeExit
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">person& p = persons_.back();
+person::evolution_t checkpoint = p.evolution_;
+
+SCOPE_EXIT(const bind checkpoint, const bind& p, bind this_) {
+ if (checkpoint == p.evolution_) this_->persons_.pop_back();
+} SCOPE_EXIT_END
+</pre>
+
+ 
+ </td>
+<td>
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">person& p = persons_.back();
+ person::evolution_t checkpoint = p.evolution_;
+
+ BOOST_SCOPE_EXIT(checkpoint, &p, this_) { // Or extra variable <code class="computeroutput">const_p</code>.
+ if (checkpoint == p.evolution_) this_->persons_.pop_back();
+ } BOOST_SCOPE_EXIT_END
+</pre>
+ </td>
+</tr></tbody>
+</table></div>
+
+ Where the macros are defined in scope_exit.hpp.
+ 
+
+ The scope exit macros are implemented by passing a local function when constructing
+ an object of the following class:
+ 
+
+
+<pre class="programlisting">struct scope_exit {
+ scope_exit(boost::function<void (void)> f): f_(f) {}
+ ~scope_exit(void) { f_(); }
+private:
+ boost::function<void (void)> f_;
+};
+</pre>
+
+ 
+
+ A local variable within the enclosing scope is used to hold the object so
+ the destructor will be invoked at the exit of the enclosing scope and it
+ will in turn call the local function executing the scope exit instructions.
+ The scope exit local function has no parameter and <code class="computeroutput">void</code>
+ result type but it supports binding and constant binding.
+ 
+</div>
+<div class="section boost_localfunction_Examples_boost_phoenix_functions">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Examples.boost_phoenix_functions"></a><a class="link" href="Examples.html#boost_localfunction.Examples.boost_phoenix_functions" title="Boost.Phoenix Functions">Boost.Phoenix
+ Functions</a>
+</h3></div></div></div>
+
+ Local functions can be used to create Boost.Phoenix
+ functions. For example (see also phoenix_factorial_local.cpp
+ and phoenix_factorial.cpp):
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Local Functions
+ 
+ </th>
+<th>
+ 
+ Global Functor
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">BOOST_AUTO_TEST_CASE( test_phoenix_factorial_local ) {
+ using boost::phoenix::arg_names::arg1;
+
+ int BOOST_LOCAL_FUNCTION(int n) { // Unfortunately, monomorphic.
+ return (n <= 0) ? 1 : n * factorial_impl(n - 1);
+ } BOOST_LOCAL_FUNCTION_NAME(recursive factorial_impl)
+
+ boost::phoenix::function< boost::function<int (int)> >
+ factorial(factorial_impl); // Phoenix function from local function.
+
+ int i = 4;
+ BOOST_CHECK( factorial(i)() == 24 ); // Call.
+ BOOST_CHECK( factorial(arg1)(i) == 24 ); // Lazy call.
+}
+</pre>
+
+ 
+ </td>
+<td>
+ 
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">struct factorial_impl { // Phoenix function from global functor.
+ template<typename Sig>
+ struct result;
+
+ template<typename This, typename Arg>
+ struct result<This (Arg)> : result<This (Arg const&)> {};
+
+ template<typename This, typename Arg>
+ struct result<This (Arg&)> { typedef Arg type; };
+
+ template<typename Arg> // Polymorphic.
+ Arg operator()(Arg n) const {
+ return (n <= 0) ? 1 : n * (*this)(n - 1);
+ }
+};
+
+BOOST_AUTO_TEST_CASE( test_phoenix_factorial ) {
+ using boost::phoenix::arg_names::arg1;
+
+ boost::phoenix::function<factorial_impl> factorial;
+
+ int i = 4;
+ BOOST_CHECK( factorial(i)() == 24 ); // Call.
+ BOOST_CHECK( factorial(arg1)(i) == 24 ); // Lazy call.
+}
+</pre>
+
+ 
+ </td>
+</tr></tbody>
+</table></div>
+
+ This is presented here mainly as a curiosity because Boost.Phoenix
+ functions created from local functions have the important limitation that
+ they cannot be polymorphic. [<a name="boost_localfunction.Examples.boost_phoenix_functions.f0" href="#ftn.boost_localfunction.Examples.boost_phoenix_functions.f0" class="footnote">28</a>] Therefore, in many cases creating the Boost.Phoenix
+ function from global functors (possibly with the help of Boost.Phoenix
+ adaptor macros) might be a more valuable option.
+ 
+</div>
+<div class="section boost_localfunction_Examples_closures">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Examples.closures"></a><a class="link" href="Examples.html#boost_localfunction.Examples.closures" title="Closures">Closures</a>
+</h3></div></div></div>
+
+ The following are examples of closures
+ that illustrate how to return local functions to the calling scope (and the
+ relative precautions to take).
+ 
+<div class="informaltable"><table class="table">
+<colgroup><col></colgroup>
+<thead><tr><th>
+ 
+ Files
+ 
+ </th></tr></thead>
+<tbody>
+<tr><td>
+ 
+ return_inc.cpp
+ 
+ </td></tr>
+<tr><td>
+ 
+ return_this.cpp
+ 
+ </td></tr>
+<tr><td>
+ 
+ return_setget.cpp
+ 
+ </td></tr>
+<tr><td>
+ 
+ return_derivative.cpp
+ 
+ </td></tr>
+</tbody>
+</table></div>
+</div>
+<div class="section boost_localfunction_Examples_gcc_nested_functions">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Examples.gcc_nested_functions"></a><a class="link" href="Examples.html#boost_localfunction.Examples.gcc_nested_functions" title="GCC Nested Functions">GCC
+ Nested Functions</a>
+</h3></div></div></div>
+
+ The GCC C compiler supports local functions under the name of <a href="http://gcc.gnu.org/onlinedocs/gcc/Nested-Functions.html" target="_top">nested
+ functions</a>. Nested functions are exclusively a C extension of the
+ GCC compiler (they are not supported for C++ not even by the GCC compiler,
+ and they are not part of any C or C++ standard, nor they are supported by
+ other compilers like MSVC).
+ 
+
+ The following examples are taken form the GCC nested function documentation
+ and programmed using this library:
+ 
+<div class="informaltable"><table class="table">
+<colgroup><col></colgroup>
+<thead><tr><th>
+ 
+ Files
+ 
+ </th></tr></thead>
+<tbody>
+<tr><td>
+ 
+ gcc_square.cpp
+ 
+ </td></tr>
+<tr><td>
+ 
+ gcc_access.cpp
+ 
+ </td></tr>
+<tr><td>
+ 
+ gcc_store.cpp
+ 
+ </td></tr>
+</tbody>
+</table></div>
+</div>
+<div class="section boost_localfunction_Examples_n_papers">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Examples.n_papers"></a><a class="link" href="Examples.html#boost_localfunction.Examples.n_papers" title="N-Papers">N-Papers</a>
+</h3></div></div></div>
+
+ The following examples are taken from a number of N-papers and programmed
+ using this library.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Files
+ 
+ </th>
+<th>
+ 
+ Notes
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ n2550_find_if.cpp
+ 
+ </td>
+<td>
+ 
+ This example is adapted from [N2550]
+ (<a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions): It passes a local function to the STL
+ algorithm <code class="computeroutput">std::find_if</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ n2529_this.cpp
+ 
+ </td>
+<td>
+ 
+ This example is adapted from [N2529]
+ (<a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions): It binds the object in scope <code class="computeroutput">this</code> to a local function.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="footnotes">
+ <hr width="100" align="left">
+<div class="footnote">[<a id="ftn.boost_localfunction.Examples.constant_blocks.f0" href="#boost_localfunction.Examples.constant_blocks.f0" class="para">27</a>] 
+ Ideally, <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions would allow to bind variables also using <code class="computeroutput">const& variable</code> (constant reference) and <code class="computeroutput">const&</code>
+ (all variables by constant reference).
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Examples.boost_phoenix_functions.f0" href="#boost_localfunction.Examples.boost_phoenix_functions.f0" class="para">28</a>] 
+ Rationale. Local functions can only be
+ monomorphic because they are implemented using local classes and local
+ classes cannot be templates in C++ (not even in C++11).
+ </div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="Advanced_Topics.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../reference.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/boost_localfunction/Getting_Started.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/boost_localfunction/Getting_Started.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,199 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Getting Started</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="prev" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="next" href="Tutorial.html" title="Tutorial">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="Tutorial.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section boost_localfunction_Getting_Started">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_localfunction.Getting_Started"></a><a class="link" href="Getting_Started.html" title="Getting Started">Getting Started</a>
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt><a href="Getting_Started.html#boost_localfunction.Getting_Started.this_documentation">This
+ Documentation</a></dt>
+<dt><a href="Getting_Started.html#boost_localfunction.Getting_Started.compilers_and_platforms">Compilers
+ and Platforms</a></dt>
+<dt>Installation</dt>
+<dt>Configuration</dt>
+</dl></div>
+
+ This section explains how programmers can setup their system to use this library.
+ 
+<div class="section boost_localfunction_Getting_Started_this_documentation">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Getting_Started.this_documentation"></a><a class="link" href="Getting_Started.html#boost_localfunction.Getting_Started.this_documentation" title="This Documentation">This
+ Documentation</a>
+</h3></div></div></div>
+
+ Programmers should have enough knowledge to use this library after reading
+ the <a class="link" href="../index.html#boost_localfunction.Introduction" title="Introduction">Introduction</a>,
+ <a class="link" href="Getting_Started.html" title="Getting Started">Getting Started</a>,
+ and <a class="link" href="Tutorial.html" title="Tutorial">Tutorial</a> sections.
+ The <a class="link" href="Advanced_Topics.html" title="Advanced Topics">Advanced Topics</a>
+ and Reference sections can be consulted
+ at a later point to gain a more advanced knowledge of the library. All the
+ other sections of this documentation can be considered optional.
+ 
+
+ Some footnotes are marked by the word "Rationale".
+ They explain reasons behind decisions made during the design and implementation
+ of this library.
+ 
+
+ In some of the examples presented in this documentation, the Boost.Test
+ macro <code class="computeroutput">BOOST_CHECK</code> is used
+ equivalently to <code class="computeroutput">assert</code> and
+ the Boost.Test macro
+ <code class="computeroutput">BOOST_AUTO_TEST_CASE</code> is used
+ equivalently to <code class="computeroutput">main</code>. [<a name="boost_localfunction.Getting_Started.this_documentation.f0" href="#ftn.boost_localfunction.Getting_Started.this_documentation.f0" class="footnote">3</a>]
+ 
+</div>
+<div class="section boost_localfunction_Getting_Started_compilers_and_platforms">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Getting_Started.compilers_and_platforms"></a><a class="link" href="Getting_Started.html#boost_localfunction.Getting_Started.compilers_and_platforms" title="Compilers and Platforms">Compilers
+ and Platforms</a>
+</h3></div></div></div>
+
+ The implementation of this library uses preprocessor and template meta-programming
+ (as supported by Boost.Preprocessor
+ and Boost.MPL), templates
+ with partial specializations and function pointers (similarly to Boost.Function).
+ As a consequence, this library is fairly demanding on compilers' compliance
+ with the C++03
+ standard. At present, this library has been successfully compiled and tested
+ on the following compilers and platforms:
+ 
+<div class="orderedlist"><ol class="orderedlist" type="1">
+<li class="listitem">
+ GNU Compiler Collection (GCC) 4.5.1 on Ubuntu Linux 10.
+ </li>
+<li class="listitem">
+ GCC 4.3.4 and 4.5.3 (with and without C++11
+ features enabled <code class="computeroutput">-std=c++0x</code>)
+ on Cygwin.
+ </li>
+<li class="listitem">
+ Miscrosoft Visual Studio Compiler (MSVC) 8.0 on Windows XP and Windows
+ 7.
+ </li>
+</ol></div>
+
+ This library has not yet been tested on any other compiler and platform.
+ 
+</div>
+<div class="section boost_localfunction_Getting_Started_installation">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Getting_Started.installation"></a><a class="link" href="Getting_Started.html#boost_localfunction.Getting_Started.installation" title="Installation">Installation</a>
+</h3></div></div></div>
+
+ This library is composed of header files only. Therefore there is no pre-compiled
+ object file which needs to be installed or linked. Programmers can simply
+ instruct the C++ compiler where to find the library header files (<code class="computeroutput">-I</code> option
+ for GCC, <code class="computeroutput">/I</code>
+ option for MSVC, etc) and they can start compiling code using this library.
+ 
+
+ This library implementation uses a number of Boost
+ libraries among which: Boost.Preprocessor,
+ Boost.ScopeExit,
+ Boost.Typeof, Boost.TypeTraits, and
+ Boost.MPL. These Boost libraries must be properly installed
+ on your system in order for this library to work.
+ 
+
+ The followings are part of the library private API, they are not documented,
+ and they should not be directly used by programmers: [<a name="boost_localfunction.Getting_Started.installation.f0" href="#ftn.boost_localfunction.Getting_Started.installation.f0" class="footnote">4</a>]
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Any symbol defined by files within the <code class="literal">boost/local_function/aux_/</code>
+ or <code class="literal">boost/local_function/detail/</code> directory (these header
+ files should not be directly included by programmers).
+ </li>
+<li class="listitem">
+ Any symbol within the <code class="computeroutput">boost::local_function::aux</code>
+ or <code class="computeroutput">boost::local_function::detail</code> namespace.
+ </li>
+<li class="listitem">
+ Any symbol prefixed by <code class="computeroutput">boost_local_function_aux_...</code> or <code class="computeroutput">boost_local_function_detail_...</code> (regardless of its namespace).
+ </li>
+<li class="listitem">
+ Any symbol prefixed by <code class="computeroutput">BOOST_LOCAL_FUNCTION_AUX_...</code> or <code class="computeroutput">BOOST_LOCAL_FUNCTION_DETAIL_...</code> (regardless of its namespace).
+ </li>
+</ul></div>
+</div>
+<div class="section boost_localfunction_Getting_Started_configuration">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Getting_Started.configuration"></a><a class="link" href="Getting_Started.html#boost_localfunction.Getting_Started.configuration" title="Configuration">Configuration</a>
+</h3></div></div></div>
+
+ Some of the library behaviour can be changed at compile-time by defining
+ special configuration macros. If a configuration macro
+ is left undefined, the library will use an appropriate default value for
+ it.
+ 
+
+ All configuration macros are defined in the header file <code class="computeroutput"><a class="link" href="../reference.html#header.boost.local_function.config_hpp" title="Header <boost/local_function/config.hpp>">boost/local_function/config.hpp</a></code>.
+ It is strongly recommended not to change the library configuration macro
+ definitions unless strictly necessary.
+ 
+</div>
+<div class="footnotes">
+ <hr width="100" align="left">
+<div class="footnote">[<a id="ftn.boost_localfunction.Getting_Started.this_documentation.f0" href="#boost_localfunction.Getting_Started.this_documentation.f0" class="para">3</a>] 
+ Rationale. Using Boost.Test
+ allows to add the documentation examples to the library regression tests
+ so to make sure that the listed examples always compile and run correctly.
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Getting_Started.installation.f0" href="#boost_localfunction.Getting_Started.installation.f0" class="para">4</a>] 
+ Rationale. This library concatenates symbols
+ specified by the programmers (e.g., the local function name) with other
+ symbols (e.g., special prefixes or preprocessor line numbers) to make internal
+ symbols with unique names to avoid name clashes. These symbols are separated
+ by the letter "<code class="computeroutput">X</code>"
+ when they are concatenated so they read more easily during debugging (the
+ underscore character "<code class="computeroutput">_</code>"
+ could not be used instead of the letter "<code class="computeroutput">X</code>"
+ because if the original symbols already contained a leading or trailing
+ underscore, the concatenation could result in a symbol with double underscores
+ "<code class="computeroutput">__</code>" which is
+ reserved by the C++ standard). The "aux" symbols are private
+ to this library while the "detail" symbols can be used within
+ Boost by other libraries but they are still not part of this library public
+ API.
+ </div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="Tutorial.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/boost_localfunction/Implementation.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/boost_localfunction/Implementation.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,228 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Annex: Implementation</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="prev" href="No_Variadic_Macros.html" title="Annex: No Variadic Macros">
+<link rel="next" href="Release_Notes.html" title="Release Notes">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="No_Variadic_Macros.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="Release_Notes.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section boost_localfunction_Implementation">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_localfunction.Implementation"></a><a class="link" href="Implementation.html" title="Annex: Implementation">Annex: Implementation</a>
+</h2></div></div></div>
+
+ This section gives an overview of the key programming techniques used to implement
+ this library.
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ The code listed here can be used by curious readers and library maintainers
+ as a reference in trying to understand the library source code. There is
+ absolutely no guarantee that the library implementation uses the exact code
+ listed here.
+ </td></tr>
+</table></div>
+<h6>
+<a name="boost_localfunction.Implementation.h0"></a>
+ <a name="boost_localfunction.Implementation.local_classes_as_template_parameters"></a><a class="link" href="Implementation.html#boost_localfunction.Implementation.local_classes_as_template_parameters">Local
+ Classes as Template Parameters</a>
+ </h6>
+
+ This library uses a local class to implement the local function object. However,
+ in C++03
+ local classes (and therefore the local function objects they implement) cannot
+ be passed as template parameters (e.g., to the <code class="computeroutput">std::for_each</code>
+ algorithm), this is instead possible in C++11,
+ MSVC, and some other compilers (see [N2657]).
+ To work around this limitation, this library investigated the following two
+ "tricks" (both tricks can be extended to support eventual function
+ default parameters):
+ 
+<div class="orderedlist"><ol class="orderedlist" type="1">
+<li class="listitem">
+ The casting functor trick uses a non-local functor
+ that calls a static member function of the local class via a function pointer.
+ The static member function then calls the correct local function body after
+ type casting the object from a <code class="computeroutput">void*</code> pointer (local classes can always be used
+ for type casting).
+ </li>
+<li class="listitem">
+ The virtual functor trick derives the local functor
+ class from a non-local base class. The correct overridden implementation
+ of the virtual <code class="computeroutput">operator()</code>
+ is then called via polymorphism.
+ </li>
+</ol></div>
+
+ For example (see also impl_tparam_tricks.cpp):
+ 
+
+
+<pre class="programlisting">#define BOOST_TEST_MODULE TestImplTparamTricks
+#include <boost/test/unit_test.hpp>
+#include <vector>
+#include <algorithm>
+
+// Casting functor trick.
+struct casting_func {
+ explicit casting_func(void* obj, void (*call)(void*, const int&)):
+ obj_(obj), call_(call) {}
+ // Unfortunately, function pointer call is not inlined.
+ inline void operator()(const int& num) { call_(obj_, num); }
+private:
+ void* obj_;
+ void (*call_)(void*, const int&);
+};
+
+// Virtual functor trick.
+struct virtual_func {
+ struct interface {
+ // Unfortunately, virtual function call is not inlined.
+ inline virtual void operator()(const int&) {}
+ };
+ explicit virtual_func(interface& func): func_(&func) {}
+ inline void operator()(const int& num) { (*func_)(num); }
+private:
+ interface* func_;
+};
+
+BOOST_AUTO_TEST_CASE( test_impl_tparam_tricks ) {
+ int sum = 0, factor = 10;
+
+ // Local class for local function.
+ struct local_add: virtual_func::interface {
+ explicit local_add(int& _sum, const int& _factor):
+ sum_(_sum), factor_(_factor) {}
+ inline void operator()(const int& num) {
+ body(sum_, factor_, num);
+ }
+ inline static void call(
+ void* obj, const int& num) {
+ local_add* self = static_cast<local_add*>(obj);
+ self->body(self->sum_, self->factor_, num);
+ }
+ private:
+ int& sum_;
+ const int& factor_;
+ inline void body(int& sum, const int& factor, const int& num) {
+ sum += factor * num;
+ }
+ } add_local(sum, factor);
+ casting_func add_casting(&add_local, &local_add::call);
+ virtual_func add_virtual(add_local);
+
+ std::vector<int> v(10);
+ std::fill(v.begin(), v.end(), 1);
+
+// std::for_each(v.begin(), v.end(), add_local); // Error but OK on C++11.
+ std::for_each(v.begin(), v.end(), add_casting); // OK.
+ std::for_each(v.begin(), v.end(), add_virtual); // OK.
+
+ BOOST_CHECK( sum == 200 );
+}
+</pre>
+
+ 
+
+ The casting functor trick measured slightly better run-time performances than
+ the virtual functor trick so the current implementation of this library uses
+ the casting functor trick (probably because in addition to the indirect function
+ call, the virtual functor trick also requires accessing the <a href="http://en.wikipedia.org/wiki/Virtual_method_table" target="_top">virtual
+ function table</a>). However, neither one of tricks has been observed to
+ allow for compiler optimizations that inline the local function calls (because
+ they rely on one indirect function call via either a function pointer or a
+ virtual function respectively). Therefore, on compilers that accept local types
+ as template parameters (MSVC, C++11,
+ etc, see [N2657]),
+ this library automatically generates code that passes the local class type
+ directly as template parameter without using neither one of these two tricks
+ in order to take full advantage of compiler optimizations that inline the local
+ function calls.
+ 
+<h6>
+<a name="boost_localfunction.Implementation.h1"></a>
+ <a name="boost_localfunction.Implementation.parsing_macros"></a><a class="link" href="Implementation.html#boost_localfunction.Implementation.parsing_macros">Parsing
+ Macros</a>
+ </h6>
+
+ This library macros can parse the list of specified parameters and detect if
+ any of the bound variable names matches the token <code class="computeroutput">this_</code>
+ (to generate special code to bind the object in scope), or if the variable
+ is bound by <code class="computeroutput">const</code> (to generate
+ special code to bind by constant), etc. The parameter tokens are inspected
+ using preprocessor metaprogramming and specifically using the macros defined
+ by the files in the <code class="literal">boost/local_function/detail/preprocessor/keyword/</code>
+ directory. [<a name="boost_localfunction.Implementation.f0" href="#ftn.boost_localfunction.Implementation.f0" class="footnote">29</a>]
+ 
+
+ For example, the following code defines a macro that allows the preprocessor
+ to detect if a set of space-separated tokens ends with <code class="computeroutput">this_</code>
+ or not (see also impl_pp_keyword.cpp):
+ 
+
+
+<pre class="programlisting">#include <boost/local_function/detail/preprocessor/keyword/thisunderscore.hpp>
+#include <boost/local_function/detail/preprocessor/keyword/const.hpp>
+#include <boost/local_function/detail/preprocessor/keyword/bind.hpp>
+#define BOOST_TEST_MODULE TestImplPpKeyword
+#include <boost/test/unit_test.hpp>
+
+// Expand to 1 if space-separated tokens end with `this_`, 0 otherwise.
+#define IS_THIS_BACK(tokens) \
+ BOOST_LOCAL_FUNCTION_DETAIL_PP_KEYWORD_IS_THISUNDERSCORE_BACK( \
+ BOOST_LOCAL_FUNCTION_DETAIL_PP_KEYWORD_BIND_REMOVE_FRONT( \
+ BOOST_LOCAL_FUNCTION_DETAIL_PP_KEYWORD_CONST_REMOVE_FRONT( \
+ tokens \
+ )))
+
+BOOST_AUTO_TEST_CASE( test_impl_pp_keyword ) {
+ BOOST_CHECK( IS_THIS_BACK(const bind this_) == 1 );
+ BOOST_CHECK( IS_THIS_BACK(const bind& x) == 0 );
+}
+</pre>
+
+ 
+<div class="footnotes">
+ <hr width="100" align="left">
+<div class="footnote">[<a id="ftn.boost_localfunction.Implementation.f0" href="#boost_localfunction.Implementation.f0" class="para">29</a>] 
+ This technique is at the core of even more complex preprocessor parsing macros
+ like the ones that parse the Contract++
+ syntax.
+ </div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="No_Variadic_Macros.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="Release_Notes.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/boost_localfunction/No_Variadic_Macros.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/boost_localfunction/No_Variadic_Macros.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,292 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Annex: No Variadic Macros</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="prev" href="Alternatives.html" title="Annex: Alternatives">
+<link rel="next" href="Implementation.html" title="Annex: Implementation">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="Alternatives.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="Implementation.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section boost_localfunction_No_Variadic_Macros">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_localfunction.No_Variadic_Macros"></a><a class="link" href="No_Variadic_Macros.html" title="Annex: No Variadic Macros">Annex: No Variadic
+ Macros</a>
+</h2></div></div></div>
+
+ This section illustrates an alternative syntax for compilers without variadic
+ macro support.
+ 
+<h6>
+<a name="boost_localfunction.No_Variadic_Macros.h0"></a>
+ <a name="boost_localfunction.No_Variadic_Macros.sequence_syntax"></a><a class="link" href="No_Variadic_Macros.html#boost_localfunction.No_Variadic_Macros.sequence_syntax">Sequence Syntax</a>
+ </h6>
+
+ Most modern compilers support <a href="http://en.wikipedia.org/wiki/Variadic_macro" target="_top">variaid
+ macros</a> (notably, these include GCC, MSVC, and all C++11
+ compilers). However, in the rare case that programmers need to use this library
+ on a compiler without variadic macros, this library also allows to specify
+ its macro parameters using a Boost.Preprocessor
+ sequence where tokens are separated by round parenthesis <code class="computeroutput">()</code>:
+ 
+<pre class="programlisting">(token1) (token2) ... // All compilers.
+</pre>
+
+ Instead of the comma-separated list that we have seen so far which requires
+ variadic macros:
+ 
+<pre class="programlisting">token1, token2, ... // Only compilers with varidic macros.
+</pre>
+
+ For example, the following syntax is accepted on all compilers with and without
+ variadic macros (see also add_seq.cpp):
+ 
+
+
+<pre class="programlisting">{ // Some local scope.
+ int sum = 0, factor = 10; // Variables in scope to bind.
+
+ void BOOST_LOCAL_FUNCTION( (const bind factor) (bind& sum) (int num) ) {
+ sum += factor * num; // Parameters as sequence.
+ } BOOST_LOCAL_FUNCTION_NAME(add)
+
+ add(1); // Call the local function.
+ int nums[] = {2, 3};
+ std::for_each(nums, nums + 2, add); // Pass it to an algorithm.
+
+ BOOST_CHECK( sum == 60 ); // Assert final summation value.
+}
+</pre>
+
+ 
+
+ However, on compilers with variadic macros the comma-separated syntax we have
+ seen so far is preferred because more readable (see also add.cpp):
+ 
+
+
+<pre class="programlisting">{ // Some local scope.
+ int sum = 0, factor = 10; // Variables in scope to bind.
+
+ void BOOST_LOCAL_FUNCTION(const bind factor, bind& sum, int num) {
+ sum += factor * num;
+ } BOOST_LOCAL_FUNCTION_NAME(add)
+
+ add(1); // Call the local function.
+ int nums[] = {2, 3};
+ std::for_each(nums, nums + 2, add); // Pass it to an algorithm.
+
+ BOOST_CHECK( sum == 60 ); // Assert final summation value.
+}
+</pre>
+
+ 
+
+ Note how the same macros accept both syntaxes on compilers with variadic macros
+ and only the sequence syntax on compilers without variadic macros. Finally,
+ an parameter list is always specified using <code class="computeroutput">void</code>
+ on compilers with and without variadic macros:
+ 
+
+
+<pre class="programlisting">int BOOST_LOCAL_FUNCTION(void) { // No parameter.
+ return 10;
+} BOOST_LOCAL_FUNCTION_NAME(ten)
+
+BOOST_CHECK( ten() == 10 );
+</pre>
+
+ 
+<h6>
+<a name="boost_localfunction.No_Variadic_Macros.h1"></a>
+ <a name="boost_localfunction.No_Variadic_Macros.an_example"></a><a class="link" href="No_Variadic_Macros.html#boost_localfunction.No_Variadic_Macros.an_example">An
+ Example</a>
+ </h6>
+
+ The following example shows a bit of all the different macro parameter combinations
+ using the sequence syntax (see also seq.cpp):
+ 
+
+
+<pre class="programlisting">struct s {
+ void f(double p = 1.23, double q = -1.23) {
+ { // Only params.
+ void BOOST_LOCAL_FUNCTION( (int x) (int y)(default 0) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(l)
+ l(1);
+ }
+ { // Only const binds.
+ int a, b;
+
+ const int& BOOST_LOCAL_FUNCTION( (const bind a)
+ (const bind& b) (const bind& p) (const bind q) ) {
+ return b;
+ } BOOST_LOCAL_FUNCTION_NAME(l)
+ l();
+
+ const s& BOOST_LOCAL_FUNCTION( (const bind this_) ) {
+ return *this_;
+ } BOOST_LOCAL_FUNCTION_NAME(t)
+ t();
+
+ const int BOOST_LOCAL_FUNCTION( (const bind a)
+ (const bind& b) (const bind& p) (const bind q)
+ (const bind this_) ) {
+ return a;
+ } BOOST_LOCAL_FUNCTION_NAME(lt)
+ lt();
+ }
+ { // Only plain binds.
+ int c, d;
+
+ int& BOOST_LOCAL_FUNCTION( (bind c) (bind& d)
+ (bind& p) (bind& q) ) {
+ return d;
+ } BOOST_LOCAL_FUNCTION_NAME(l)
+ l();
+
+ s& BOOST_LOCAL_FUNCTION( (bind this_) ) {
+ return *this_;
+ } BOOST_LOCAL_FUNCTION_NAME(t)
+ t();
+
+ int BOOST_LOCAL_FUNCTION( (bind c) (bind& d)
+ (bind& p) (bind& q) (bind this_) ) {
+ return c;
+ } BOOST_LOCAL_FUNCTION_NAME(lt)
+ lt();
+ }
+
+ { // Both params and const binds.
+ int a, b;
+
+ void BOOST_LOCAL_FUNCTION( (const bind a) (const bind& b)
+ (const bind& p) (const bind q)
+ (int x) (int y)(default 0) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(l)
+ l(1);
+
+ void BOOST_LOCAL_FUNCTION( (const bind this_)
+ (int x) (int y)(default 0) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(t)
+ t(1);
+
+ void BOOST_LOCAL_FUNCTION( (const bind a) (const bind this_)
+ (const bind& b) (const bind& p) (const bind q)
+ (int x) (int y)(default 0) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(lt)
+ lt(1);
+ }
+ { // Both params and plain binds.
+ int c, d;
+
+ void BOOST_LOCAL_FUNCTION( (bind c) (bind& d) (bind& p) (bind q)
+ (int x) (int y)(default 0) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(l)
+ l(1);
+
+ void BOOST_LOCAL_FUNCTION( (bind this_)
+ (int x) (int y)(default 0) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(t)
+ t(1);
+
+ void BOOST_LOCAL_FUNCTION( (bind c) (bind& d)
+ (bind& p) (bind this_) (bind q)
+ (int x) (int y)(default 0) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(lt)
+ lt(1);
+ }
+ { // Both const and plain binds.
+ int a, b, c, d;
+
+ void BOOST_LOCAL_FUNCTION( (const bind a) (const bind& b)
+ (const bind p) (bind c) (bind& d) (bind q) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(l)
+ l();
+
+ void BOOST_LOCAL_FUNCTION( (const bind this_)
+ (bind c) (bind& d) (bind q) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(ct)
+ ct();
+ void BOOST_LOCAL_FUNCTION( (const bind this_)
+ (const bind a) (const bind& b) (const bind p)
+ (bind c) (bind& d) (bind q) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(lct)
+ lct();
+
+ void BOOST_LOCAL_FUNCTION( (const bind a) (const bind& b)
+ (const bind p) (bind this_) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(pt)
+ pt();
+ void BOOST_LOCAL_FUNCTION( (const bind a) (const bind& b)
+ (const bind p) (bind c) (bind this_) (bind& d) (bind q) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(lpt)
+ lpt();
+ }
+
+ { // All params, const binds, and plain binds.
+ int a, b, c, d;
+
+ void BOOST_LOCAL_FUNCTION(
+ (const bind a) (const bind& b) (const bind& p)
+ (bind c) (bind& d) (bind& q) (int x) (int y)(default 0) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(l)
+ l(1);
+
+ void BOOST_LOCAL_FUNCTION( (const bind this_)
+ (bind c) (bind& d) (bind& q)
+ (int x) (int y)(default 0) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(ct)
+ ct(1);
+ void BOOST_LOCAL_FUNCTION(
+ (const bind a) (const bind& b) (const bind& p)
+ (bind this_) (int x) (int y)(default 0) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(pt)
+ pt(1);
+
+ void BOOST_LOCAL_FUNCTION( (const bind a) (const bind this_)
+ (const bind& b) (const bind& p) (bind c) (bind& d)
+ (bind& q) (int x) (int y)(default 0) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(lct)
+ lct(1);
+ void BOOST_LOCAL_FUNCTION( (const bind a) (const bind& b)
+ (const bind& p) (bind c) (bind& d) (bind this_) (bind& q)
+ (int x) (int y)(default 0) ) {
+ } BOOST_LOCAL_FUNCTION_NAME(lpt)
+ lpt(1);
+ }
+ }
+};
+</pre>
+
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="Alternatives.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="Implementation.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/boost_localfunction/Release_Notes.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/boost_localfunction/Release_Notes.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,157 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Release Notes</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="prev" href="Implementation.html" title="Annex: Implementation">
+<link rel="next" href="Bibliography.html" title="Bibliography">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="Implementation.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="Bibliography.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section boost_localfunction_Release_Notes">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_localfunction.Release_Notes"></a><a class="link" href="Release_Notes.html" title="Release Notes">Release Notes</a>
+</h2></div></div></div>
+
+ This section lists the major changes between different library releases (in
+ chronological order).
+ 
+<h6>
+<a name="boost_localfunction.Release_Notes.h0"></a>
+ <a name="boost_localfunction.Release_Notes.version_1_0_0__2012_01_31_"></a><a class="link" href="Release_Notes.html#boost_localfunction.Release_Notes.version_1_0_0__2012_01_31_">Version
+ 1.0.0 (2012-01-31)</a>
+ </h6>
+<div class="orderedlist"><ol class="orderedlist" type="1">
+<li class="listitem">
+ Incorporated all comments from the <a href="http://lists.boost.org/boost-announce/2011/12/0340.php" target="_top">Boost
+ review of this library</a>.
+ </li>
+<li class="listitem">
+ Removed local blocks and local exits.
+ </li>
+<li class="listitem">
+ Renamed the library from Boost.Local to Boost.LocalFunction.
+ </li>
+<li class="listitem">
+ Using <code class="computeroutput">this_</code> instead of
+ <code class="computeroutput">this</code> also in the local function
+ declaration (not just the body).
+ </li>
+<li class="listitem">
+ Made changes that allow to return local functions (similar to closures).
+ </li>
+<li class="listitem">
+ Added GCC lambda and constant block examples.
+ </li>
+<li class="listitem">
+ Moved <code class="computeroutput">overloaded_function</code>
+ to Boost.Functional/OverloadedFunction.
+ </li>
+<li class="listitem">
+ Moved <code class="computeroutput">BOOST_IDENTITY_TYPE</code>
+ to Boost.Utility/IdentityType.
+ </li>
+</ol></div>
+<h6>
+<a name="boost_localfunction.Release_Notes.h1"></a>
+ <a name="boost_localfunction.Release_Notes.version_0_2_0__2011_05_14_"></a><a class="link" href="Release_Notes.html#boost_localfunction.Release_Notes.version_0_2_0__2011_05_14_">Version
+ 0.2.0 (2011-05-14)</a>
+ </h6>
+<div class="orderedlist"><ol class="orderedlist" type="1">
+<li class="listitem">
+ Replaced parenthesized syntax with variadic and sequencing macro syntaxes.
+ </li>
+<li class="listitem">
+ Profiled library performances against other approaches.
+ </li>
+<li class="listitem">
+ Replaced virtual functor trick with casting functor trick (for smaller
+ run-time).
+ </li>
+<li class="listitem">
+ Optimized library run-time (rearranging code and not using casting functor
+ trick on compilers that accept local classes as template parameters).
+ </li>
+<li class="listitem">
+ Supported inline and recursive local functions.
+ </li>
+<li class="listitem">
+ Added type-of macro to expose bound types.
+ </li>
+<li class="listitem">
+ Allowed to explicitly specify bound types.
+ </li>
+<li class="listitem">
+ Removed using <code class="computeroutput">boost::function</code> instead of exposing internal
+ local functor as public API.
+ </li>
+<li class="listitem">
+ Added functor to overload local functions (and functors in general).
+ </li>
+<li class="listitem">
+ Implemented support for nesting local functions, blocks, and exits into
+ one another.
+ </li>
+</ol></div>
+<h6>
+<a name="boost_localfunction.Release_Notes.h2"></a>
+ <a name="boost_localfunction.Release_Notes.version_0_1_1__2011_01_10_"></a><a class="link" href="Release_Notes.html#boost_localfunction.Release_Notes.version_0_1_1__2011_01_10_">Version
+ 0.1.1 (2011-01-10)</a>
+ </h6>
+<div class="orderedlist"><ol class="orderedlist" type="1">
+<li class="listitem">
+ Uploaded library source into Boost SVN sandbox.
+ </li>
+<li class="listitem">
+ Fixed prev/next arrows and other minor layouts in documentation.
+ </li>
+<li class="listitem">
+ Added Release section to documentation.
+ </li>
+</ol></div>
+<h6>
+<a name="boost_localfunction.Release_Notes.h3"></a>
+ <a name="boost_localfunction.Release_Notes.version_0_1_0__2011_01_03_"></a><a class="link" href="Release_Notes.html#boost_localfunction.Release_Notes.version_0_1_0__2011_01_03_">Version
+ 0.1.0 (2011-01-03)</a>
+ </h6>
+<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
+ Shared with Boost for first round of comments.
+ </li></ol></div>
+<h6>
+<a name="boost_localfunction.Release_Notes.h4"></a>
+ <a name="boost_localfunction.Release_Notes.version_0_0_1__2010_12_15_"></a><a class="link" href="Release_Notes.html#boost_localfunction.Release_Notes.version_0_0_1__2010_12_15_">Version
+ 0.0.1 (2010-12-15)</a>
+ </h6>
+<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
+ Completed development, examples, and documentation.
+ </li></ol></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="Implementation.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="Bibliography.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/boost_localfunction/Tutorial.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/boost_localfunction/Tutorial.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,544 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Tutorial</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="prev" href="Getting_Started.html" title="Getting Started">
+<link rel="next" href="Advanced_Topics.html" title="Advanced Topics">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="Getting_Started.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="Advanced_Topics.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section boost_localfunction_Tutorial">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_localfunction.Tutorial"></a><a class="link" href="Tutorial.html" title="Tutorial">Tutorial</a>
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt>Local Functions</dt>
+<dt>Binding Variables</dt>
+<dt><a href="Tutorial.html#boost_localfunction.Tutorial.binding_the_object__this_">Binding
+ the Object <code class="computeroutput">this</code></a></dt>
+<dt>Templates</dt>
+</dl></div>
+
+ This section illustrates basic usages of this library.
+ 
+<div class="section boost_localfunction_Tutorial_local_functions">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Tutorial.local_functions"></a><a class="link" href="Tutorial.html#boost_localfunction.Tutorial.local_functions" title="Local Functions">Local Functions</a>
+</h3></div></div></div>
+
+ Local functions are defined using macros from the header file <code class="computeroutput"><a class="link" href="../reference.html#header.boost.local_function_hpp" title="Header <boost/local_function.hpp>">boost/local_function.hpp</a></code>. The
+ macros must be used from within a declarative context (this is a limitation
+ with respect to <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions which can instead be declared also within expressions):
+ 
+<pre class="programlisting">#include <boost/local_function.hpp> // This library header.
+
+...
+{ // Some declarative context.
+ ...
+ result-type BOOST_LOCAL_FUNCTION(parameters) {
+ body-code
+ } BOOST_LOCAL_FUNCTION_NAME(name)
+ ...
+}
+</pre>
+
+ The code expanded by the macros declares a function object (or functor)
+ with the local function name specified by <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION_NAME.html" title="Macro BOOST_LOCAL_FUNCTION_NAME">BOOST_LOCAL_FUNCTION_NAME</a></code>.
+ [<a name="boost_localfunction.Tutorial.local_functions.f0" href="#ftn.boost_localfunction.Tutorial.local_functions.f0" class="footnote">5</a>] The usual C++ scope visibility rules apply to local functions
+ for which a local function is visible only within the enclosing scope in
+ which it is declared.
+ 
+
+ The local function body is specified in a code block <code class="computeroutput">{
+ ... }</code>
+ using the usual C++ syntax. The body is specified outside any of the macros
+ so eventual compiler error messages and related line numbers retain their
+ usual meaning and format. [<a name="boost_localfunction.Tutorial.local_functions.f1" href="#ftn.boost_localfunction.Tutorial.local_functions.f1" class="footnote">6</a>]
+ 
+
+ The local function parameters are passed to the <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">BOOST_LOCAL_FUNCTION</a></code>
+ macro as a comma-separated list of tokens (see the <a class="link" href="No_Variadic_Macros.html" title="Annex: No Variadic Macros">No
+ Variadic Macros</a> section for compilers that do not support variadic
+ macros):
+ 
+<pre class="programlisting">BOOST_LOCAL_FUNCTION(<code class="literal">parameter-type1 parameter-name1</code>, <code class="literal">parameter-type2 parameter-name2, ...</code>)
+</pre>
+
+ The maximum number of parameters that can be passed to a local function is
+ controlled at compile-time by the configuration macro <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX.html" title="Macro BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX">BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX</a></code>.
+ For example, let's program a local function named <code class="computeroutput">add</code>
+ that adds together two integers <code class="computeroutput">x</code>
+ and <code class="computeroutput">y</code> (see also add_params.cpp):
+ 
+
+
+<pre class="programlisting">int BOOST_LOCAL_FUNCTION(int x, int y) { // Local function.
+ return x + y;
+} BOOST_LOCAL_FUNCTION_NAME(add)
+
+BOOST_CHECK( add(1, 2) == 3 ); // Local function call.
+</pre>
+
+ 
+
+ If the local function has no parameter, it is possible to pass <code class="computeroutput">void</code> to the <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">BOOST_LOCAL_FUNCTION</a></code>
+ macro (similarly to the C syntax that allows to use <code class="literal">result-type
+ function-name</code><code class="computeroutput">(void)</code> to declare
+ a function with no parameter): [<a name="boost_localfunction.Tutorial.local_functions.f2" href="#ftn.boost_localfunction.Tutorial.local_functions.f2" class="footnote">7</a>]
+ 
+<pre class="programlisting">BOOST_LOCAL_FUNCTION(void) // No parameter.
+</pre>
+
+ For example, let's program a local function that always returns <code class="computeroutput">10</code> (see also ten_void.cpp):
+ 
+
+
+<pre class="programlisting">int BOOST_LOCAL_FUNCTION(void) { // No parameter.
+ return 10;
+} BOOST_LOCAL_FUNCTION_NAME(ten)
+
+BOOST_CHECK( ten() == 10 );
+</pre>
+
+ 
+</div>
+<div class="section boost_localfunction_Tutorial_Binding">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Tutorial.Binding"></a><a class="link" href="Tutorial.html#boost_localfunction.Tutorial.Binding" title="Binding Variables">Binding Variables</a>
+</h3></div></div></div>
+
+ Variables in scope (local variables, enclosing function parameters, member
+ variables, etc) can be bound to a local function declaration. Only bound
+ variables, static variables, global variables, functions, and enumerations
+ from the enclosing scope are accessible from within the local function body.
+ The types of bound variables are deduced automatically by this library.
+ [<a name="boost_localfunction.Tutorial.Binding.f0" href="#ftn.boost_localfunction.Tutorial.Binding.f0" class="footnote">8</a>]
+ 
+<div class="important"><table border="0" summary="Important">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../../../../doc/src/images/important.png"></td>
+<th align="left">Important</th>
+</tr>
+<tr><td align="left" valign="top">
+ The library implementation uses Boost.Typeof
+ to automatically deduce the types of the bound variables. Therefore, in
+ order to compile code in type-of emulation mode, all types should be properly
+ registered with <code class="computeroutput">BOOST_TYPEOF_REGISTER_TYPE</code>
+ or <code class="computeroutput">BOOST_TYPEOF_REGISTER_TEMPLATE</code>
+ macros, or appropriate Boost.Typeof
+ headers should be included (see the Boost.Typeof
+ documentation for more detail).
+ </td></tr>
+</table></div>
+
+ This library introduces the new "keyword" <code class="computeroutput">bind</code>
+ [<a name="boost_localfunction.Tutorial.Binding.f1" href="#ftn.boost_localfunction.Tutorial.Binding.f1" class="footnote">9</a>] which is used in place of the parameter type to specify the name
+ of a variable in scope to bind (therefore, <code class="computeroutput">bind</code>
+ cannot be used as a local function parameter type). A variable can be bound
+ by value:
+ 
+<pre class="programlisting">bind variable-name // Bind by value.
+</pre>
+
+ Or by reference prefixing the variable name with <code class="computeroutput">&</code>:
+ 
+<pre class="programlisting">bind& variable-name // Bind by reference.
+</pre>
+
+ Furthermore, the "keyword" <code class="computeroutput">bind</code>
+ can be prefixed by <code class="computeroutput">const</code> to
+ bind the variable by constant value:
+ 
+<pre class="programlisting">const bind variable-name // Bind by constant value.
+</pre>
+
+ Or by constant reference:
+ 
+<pre class="programlisting">const bind& variable-name // Bind by constant value.
+</pre>
+
+ Note that when <code class="computeroutput">const</code> is used,
+ it must always precede <code class="computeroutput">bind</code>.
+ [<a name="boost_localfunction.Tutorial.Binding.f2" href="#ftn.boost_localfunction.Tutorial.Binding.f2" class="footnote">10</a>]
+ 
+
+ If a variable is bound by value, then a copy of the variable value is taken
+ at the point of the local function declaration. If a variable is bound by
+ reference instead, the variable will refer to the value it has at the point
+ of the local function call. Furthermore, it is the programmers' responsibility
+ to ensure that variables bound by reference survive the existence scope of
+ the local function otherwise the bound references will be invalid when the
+ local function is called resulting in undefined behaviour (in other words,
+ the usual care in using C++ references must be taken for variables bound
+ by reference).
+ 
+
+ The type of a bound variable is automatically deduced and it is the exact
+ same type used to declare such a variable in the enclosing scope with the
+ following notes:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ If a bound variable was declared constant in the enclosing scope, it
+ will always be bound by constant value or constant reference even if
+ <code class="computeroutput">bind...</code>
+ is used instead of <code class="computeroutput">const bind...</code>
+ . However, if a bound variable was not declared constant in the enclosing
+ scope then it will not be bound as constant unless constant binding is
+ forced using <code class="computeroutput">const bind...</code>. (Note that binding by constant reference
+ is not supported by <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions but it is supported by this library.) [<a name="boost_localfunction.Tutorial.Binding.f3" href="#ftn.boost_localfunction.Tutorial.Binding.f3" class="footnote">11</a>]
+ </li>
+<li class="listitem">
+ If a bound variable was declared as a reference in the enclosing scope,
+ it will still be bound by value unless it is explicitly bound by reference
+ using <code class="computeroutput">bind&</code>
+ or <code class="computeroutput">const bind&</code>. [<a name="boost_localfunction.Tutorial.Binding.f4" href="#ftn.boost_localfunction.Tutorial.Binding.f4" class="footnote">12</a>]
+ </li>
+</ul></div>
+
+ When a variable is bound by value (constant or not), its type must be <code class="computeroutput">CopyConstructible</code> (i.e., its must provide
+ a copy constructor). As with passing parameters to usual C++ functions, programmers
+ might want to bind variables of complex types by (possibly constant) reference
+ instead of by value to avoid expensive copy operations when these variables
+ are bound to a local function.
+ 
+
+ For example, let's program the local function <code class="computeroutput">add</code>
+ from the example in the <a class="link" href="../index.html#boost_localfunction.Introduction" title="Introduction">Introduction</a>
+ section. We bind the local variable <code class="computeroutput">factor</code>
+ by constant value (because its value should not be modified by the local
+ function), the local variable <code class="computeroutput">sum</code>
+ by non-constant reference (because its value needs to be updated with the
+ summation result), and program the body to perform the summation (see also
+ add.cpp):
+ 
+
+
+<pre class="programlisting">{ // Some local scope.
+ int sum = 0, factor = 10; // Variables in scope to bind.
+
+ void BOOST_LOCAL_FUNCTION(const bind factor, bind& sum, int num) {
+ sum += factor * num;
+ } BOOST_LOCAL_FUNCTION_NAME(add)
+
+ add(1); // Call the local function.
+ int nums[] = {2, 3};
+ std::for_each(nums, nums + 2, add); // Pass it to an algorithm.
+
+ BOOST_CHECK( sum == 60 ); // Assert final summation value.
+}
+</pre>
+
+ 
+</div>
+<div class="section boost_localfunction_Tutorial_binding_the_object__this_">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Tutorial.binding_the_object__this_"></a><a class="link" href="Tutorial.html#boost_localfunction.Tutorial.binding_the_object__this_" title="Binding the Object this">Binding
+ the Object <code class="computeroutput">this</code></a>
+</h3></div></div></div>
+
+ It is also possible to bind the object <code class="computeroutput">this</code>
+ when it is in scope (e.g., from an enclosing non-static member function).
+ This is done by using the special symbol <code class="computeroutput">this_</code>
+ (instead of <code class="computeroutput">this</code>) as the name
+ of the variable to bind in the local function declaration and also to access
+ the object within the local function body. [<a name="boost_localfunction.Tutorial.binding_the_object__this_.f0" href="#ftn.boost_localfunction.Tutorial.binding_the_object__this_.f0" class="footnote">13</a>]
+ 
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../doc/src/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td align="left" valign="top">
+ The library will generate a compile-time error if <code class="computeroutput">this</code>
+ is mistakenly used instead of <code class="computeroutput">this_</code>
+ to bind the object in the local function declaration. However, mistakenly
+ using <code class="computeroutput">this</code> instead of <code class="computeroutput">this_</code> to access the object within the
+ local function body will leads to undefined behaviour and it will not necessarily
+ generate a compile-time error. [<a name="boost_localfunction.Tutorial.binding_the_object__this_.f1" href="#ftn.boost_localfunction.Tutorial.binding_the_object__this_.f1" class="footnote">14</a>] Programmers are ultimately responsible to make sure that <code class="computeroutput">this</code> is never used within a local function.
+ </td></tr>
+</table></div>
+
+ The object <code class="computeroutput">this</code> can be bound
+ by value:
+ 
+<pre class="programlisting">bind this_ // Bind the object `this` by value.
+</pre>
+
+ In this case the local function will be able to modify the object when the
+ enclosing scope is not a constant member and it will not be able to modify
+ the object when the enclosing scope is a constant member. Otherwise, the
+ object <code class="computeroutput">this</code> can be bound by
+ constant value:
+ 
+<pre class="programlisting">const bind this_ // Bind the object `this` by constant value.
+</pre>
+
+ In this case the local function will never be able to modify the object (regardless
+ of whether the enclosing scope is a constant member or not).
+ 
+
+ Note that the object <code class="computeroutput">this</code> can
+ never be bound by reference because C++ does not allow to obtain a reference
+ to <code class="computeroutput">this</code> (the library will generate
+ a compile-time error if programmers try to use <code class="computeroutput">bind& this_</code>
+ or <code class="computeroutput">const bind& this_</code>).
+ Note that <code class="computeroutput">this</code> is a pointer
+ so the pointed object is never copied even if <code class="computeroutput">this</code>
+ is bound by value (also it is not possible to directly bind <code class="computeroutput">*this</code> because
+ <code class="computeroutput">*this</code>
+ is an expression and not a variable name).
+ 
+
+ For example, let's program a local function <code class="computeroutput">add</code>
+ similar to the one in the example from the <a class="link" href="../index.html#boost_localfunction.Introduction" title="Introduction">Introduction</a>
+ section but using a member function to illustrate how to bind the object
+ <code class="computeroutput">this</code> (see also add_this.cpp):
+ 
+
+
+<pre class="programlisting">struct adder {
+ adder(): sum_(0) {}
+
+ int sum(const std::vector<int>& nums, const int factor = 10) {
+
+ void BOOST_LOCAL_FUNCTION(const bind factor, bind this_, int num) {
+ this_->sum_ += factor * num; // Use `this_` instead of `this`.
+ } BOOST_LOCAL_FUNCTION_NAME(add)
+
+ std::for_each(nums.begin(), nums.end(), add);
+ return sum_;
+ }
+private:
+ int sum_;
+};
+</pre>
+
+ 
+
+ Note that the local function has access to all class members via the bound
+ object <code class="computeroutput">this_</code> regardless of
+ their access level (<code class="computeroutput">public</code>,
+ <code class="computeroutput">protected</code>, or <code class="computeroutput">private</code>). [<a name="boost_localfunction.Tutorial.binding_the_object__this_.f2" href="#ftn.boost_localfunction.Tutorial.binding_the_object__this_.f2" class="footnote">15</a>] Specifically, in the example above the local function updates
+ the <code class="computeroutput">private</code> data member <code class="computeroutput">sum_</code>.
+ 
+</div>
+<div class="section boost_localfunction_Tutorial_templates">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_localfunction.Tutorial.templates"></a><a class="link" href="Tutorial.html#boost_localfunction.Tutorial.templates" title="Templates">Templates</a>
+</h3></div></div></div>
+
+ When local functions are programmed within templates, they need to be declared
+ using the special macro <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION_TPL.html" title="Macro BOOST_LOCAL_FUNCTION_TPL">BOOST_LOCAL_FUNCTION_TPL</a></code>:
+ [<a name="boost_localfunction.Tutorial.templates.f0" href="#ftn.boost_localfunction.Tutorial.templates.f0" class="footnote">16</a>]
+ 
+<pre class="programlisting">#include <boost/local_function.hpp> // This library header.
+
+...
+{ // Some declarative context within a template.
+ ...
+ result-type BOOST_LOCAL_FUNCTION_TPL(parameters) {
+ body-code
+ } BOOST_LOCAL_FUNCTION_NAME(name)
+ ...
+}
+</pre>
+
+ The <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION_TPL.html" title="Macro BOOST_LOCAL_FUNCTION_TPL">BOOST_LOCAL_FUNCTION_TPL</a></code>
+ macro has the exact same syntax of the <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">BOOST_LOCAL_FUNCTION</a></code>
+ macro that we have seen so far.
+ 
+
+ For example, let's program a local function similar to the one from the
+ <a class="link" href="../index.html#boost_localfunction.Introduction" title="Introduction">Introduction</a> section
+ but within a template (see also add_template.cpp):
+ 
+
+
+<pre class="programlisting">template<typename T>
+T total(const T& x, const T& y, const T& z) {
+ T sum = T(), factor = 10;
+
+ // Using the `..._TPL` macro.
+ T BOOST_LOCAL_FUNCTION_TPL(const bind factor, bind& sum, T num) {
+ return sum += factor * num;
+ } BOOST_LOCAL_FUNCTION_NAME(add)
+
+ add(x);
+ T nums[2]; nums[0] = y; nums[1] = z;
+ std::for_each(nums, nums + 2, add);
+
+ return sum;
+}
+</pre>
+
+ 
+</div>
+<div class="footnotes">
+ <hr width="100" align="left">
+<div class="footnote">[<a id="ftn.boost_localfunction.Tutorial.local_functions.f0" href="#boost_localfunction.Tutorial.local_functions.f0" class="para">5</a>] 
+ Rationale. The local function name must
+ be passed to the macro <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION_NAME.html" title="Macro BOOST_LOCAL_FUNCTION_NAME">BOOST_LOCAL_FUNCTION_NAME</a></code>
+ ending the function definition so this macro can declare a local variable
+ with the local function name to hold the local function object. Therefore
+ the local function name cannot be specified within the <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">BOOST_LOCAL_FUNCTION</a></code>
+ and it must appear instead after the local function body (even if that
+ differs from the usual C++ function declaration syntax).
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Tutorial.local_functions.f1" href="#boost_localfunction.Tutorial.local_functions.f1" class="para">6</a>] 
+ Rationale. If the local function body
+ were instead passed as a macro parameter, it would be expanded on a single
+ line of code (because macros always expand as a single line of code). Therefore,
+ eventual compiler error line numbers would all report the same value and
+ would no longer be useful to pinpoint errors.
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Tutorial.local_functions.f2" href="#boost_localfunction.Tutorial.local_functions.f2" class="para">7</a>] 
+ Rationale. The C++03
+ standard does not allow to pass empty parameters to a macro so the macro
+ cannot be invoked as <code class="computeroutput">BOOST_LOCAL_FUNCTION()</code>. On C99
+ compilers with properly implemented empty macro parameter support, it would
+ be possible to allow <code class="computeroutput">BOOST_LOCAL_FUNCTION()</code> but this is already not the case for
+ MSVC so this syntax is never allowed to ensure better portability.
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Tutorial.Binding.f0" href="#boost_localfunction.Tutorial.Binding.f0" class="para">8</a>] 
+ Rationale. By binding a variable in scope,
+ the local function declaration is specifying that such a variable should
+ be accessible within the local function body regardless of its type. Semantically,
+ this binding should be seen as an "extension" of the scope of
+ the bound variable from the enclosing scope to the scope of the local function
+ body. Therefore, contrary to the semantic of passing a function parameter,
+ the semantic of binding a variable does not depend on the variable type
+ but just on the variable name: "The variable in scope named x
+ should be accessible within the local function named f".
+ For example, this reduces maintenance because if a bound variable type
+ is changed, the local function declaration does not have to change.
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Tutorial.Binding.f1" href="#boost_localfunction.Tutorial.Binding.f1" class="para">9</a>] 
+ Obviously, the token <code class="computeroutput">bind</code>
+ is not a keyword of the C++ language. This library parses the token <code class="computeroutput">bind</code> during macro expansion using preprocessor
+ meta-programming (see the <a class="link" href="Implementation.html" title="Annex: Implementation">Implementation</a>
+ section). Therefore, <code class="computeroutput">bind</code>
+ can be considered a new "keyword" only at the preprocessor meta-programming
+ level within the syntax defined by the macros of this library (thus it
+ is referred to as a "keyword" only within quotes).
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Tutorial.Binding.f2" href="#boost_localfunction.Tutorial.Binding.f2" class="para">10</a>] 
+ Rationale. The library macros could have
+ been implemented to accept both syntaxes <code class="computeroutput">const
+ bind ...</code>
+ and <code class="computeroutput">bind const
+ ...</code> equivalently. However, handling
+ both syntaxes would have complicated the macro implementation without adding
+ any feature so only one syntax (<code class="computeroutput">const
+ bind ...</code>)
+ is supported.
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Tutorial.Binding.f3" href="#boost_localfunction.Tutorial.Binding.f3" class="para">11</a>] 
+ An historical note: Constant binding of variables in scope was the
+ main use case that originally motivated the authors in developing this
+ library. The authors needed to locally create a chuck of code to assert
+ some correctness conditions while these assertions were not supposed
+ to modify any of the variables they were using (see the Contract++
+ library). This was achieved by binding by constant reference <code class="computeroutput">const bind&</code> the variables needed by the assertions
+ and then by programming the local function body to check the assertions.
+ This way if any of the assertions mistakenly changes a bound variable
+ (for example confusing the operator <code class="computeroutput">==</code>
+ with <code class="computeroutput">=</code>), the compiler
+ correctly generates an error because the bound variable is of <code class="computeroutput">const</code> type within the local function
+ body (see also constant blocks in the <a class="link" href="Examples.html" title="Examples">Examples</a>
+ section).
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Tutorial.Binding.f4" href="#boost_localfunction.Tutorial.Binding.f4" class="para">12</a>] 
+ Rationale. Variables originally declared
+ as references are bound by value unless <code class="computeroutput">[const] bind&</code>
+ is used so that references can be bound by both value <code class="computeroutput">[const] bind</code>
+ and reference <code class="computeroutput">[const] bind&</code> (this is the same binding semantic
+ adopted by Boost.ScopeExit).
+ On the other hand, variables originally declared as constants should
+ never loose their <code class="computeroutput">const</code>
+ qualifier (to prevent their modification not just in the enclosing
+ scope but also in the local scope) thus they are always bound by constant
+ even if <code class="computeroutput">bind[&]</code>
+ is used instead of <code class="computeroutput">const bind[&]</code>.
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Tutorial.binding_the_object__this_.f0" href="#boost_localfunction.Tutorial.binding_the_object__this_.f0" class="para">13</a>] 
+ Rationale. The special name <code class="computeroutput">this_</code> was chosen following <a href="http://boost.2283326.n4.nabble.com/local-this-or-this-td3423912.html" target="_top">Boost
+ practises</a> which postfix with an underscore identifiers that are
+ named after keywords (the C++ keyword <code class="computeroutput">this</code>
+ in this case). The special symbol <code class="computeroutput">this_</code>
+ is needed because <code class="computeroutput">this</code> is
+ a reserved C++ keyword so it cannot be used as the name of the internal
+ parameter that passes the bound object to the local function body. It would
+ have been possible to use <code class="computeroutput">this</code>
+ (instead of <code class="computeroutput">this_</code>) within
+ the local function body either at the expenses of copying the bound object
+ (which would introduce run-time overhead and also the stringent requirement
+ that the bound object must have a deep copy constructor) or by relying
+ on an <a href="http://groups.google.com/group/comp.lang.c++.moderated/browse_thread/thread/d3a86f27277f713b" target="_top">undefined
+ behaviour of <code class="computeroutput">static_cast</code></a>
+ (which might not work on all platforms at the cost of portability).
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Tutorial.binding_the_object__this_.f1" href="#boost_localfunction.Tutorial.binding_the_object__this_.f1" class="para">14</a>] 
+ Rationale. The local function body cannot
+ be a static member function of the local functor object in order to support
+ recursion (because the local function name is specified by the <code class="computeroutput"><a class="link" href="../BOOST_LOCAL_FUNCTION_NAME.html" title="Macro BOOST_LOCAL_FUNCTION_NAME">BOOST_LOCAL_FUNCTION_NAME</a></code>
+ macro only after the body so it must be made available via a functor
+ member variable named after the local function and local classes cannot
+ have static member variables in C++) and nesting (because the argument
+ binding variable must be declared as a member variable so it is visible
+ in a local function nested within the body member function) -- see the
+ <a class="link" href="Implementation.html" title="Annex: Implementation">Implementation</a>
+ section. Therefore, from within the local function body the variable
+ <code class="computeroutput">this</code> is visible but it refers
+ to the local functor and not to the bound object.
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Tutorial.binding_the_object__this_.f2" href="#boost_localfunction.Tutorial.binding_the_object__this_.f2" class="para">15</a>] 
+ Rationale. This is possible because of
+ the fix to C++ <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_defects.html#45" target="_top">defect
+ 45</a> that made inner and local types able to access all outer class
+ members regardless of their access level.
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Tutorial.templates.f0" href="#boost_localfunction.Tutorial.templates.f0" class="para">16</a>] 
+ Rationale. Within templates, this library
+ needs to use <code class="computeroutput">typename</code> to explicitly
+ indicate that some expressions evaluate to a type. Because C++03
+ does not allow to use <code class="computeroutput">typename</code>
+ outside templates, the special <code class="computeroutput">TPL</code>
+ macro is used to indicate that the enclosing scope is a template so this
+ library can safely use <code class="computeroutput">typename</code>
+ to resolve expression type ambiguities.
+ </div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="Getting_Started.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="Advanced_Topics.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/index.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/index.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,231 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Chapter 1. Boost.LocalFunction 1.0.0</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="next" href="boost_localfunction/Getting_Started.html" title="Getting Started">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="boost_localfunction/Getting_Started.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
+<div class="chapter">
+<div class="titlepage"><div>
+<div><h2 class="title">
+<a name="boost_localfunction"></a>Chapter 1. Boost.LocalFunction 1.0.0</h2></div>
+<div><div class="author"><h3 class="author">
+Lorenzo Caminiti <code class="email"><<a class="email" href="mailto:lorcaminiti_at_[hidden]">lorcaminiti_at_[hidden]</a>></code>
+</h3></div></div>
+<div>Copyright © 2009-2012 Lorenzo
+ Caminiti</div>
+<div><div class="legalnotice">
+<a name="boost_localfunction.legal"></a>
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></div>
+</div></div>
+<div class="toc">
+Table of Contents
+<dl>
+<dt>Introduction</dt>
+<dt>Getting Started</dt>
+<dd><dl>
+<dt><a href="boost_localfunction/Getting_Started.html#boost_localfunction.Getting_Started.this_documentation">This
+ Documentation</a></dt>
+<dt><a href="boost_localfunction/Getting_Started.html#boost_localfunction.Getting_Started.compilers_and_platforms">Compilers
+ and Platforms</a></dt>
+<dt>Installation</dt>
+<dt>Configuration</dt>
+</dl></dd>
+<dt>Tutorial</dt>
+<dd><dl>
+<dt>Local Functions</dt>
+<dt>Binding Variables</dt>
+<dt><a href="boost_localfunction/Tutorial.html#boost_localfunction.Tutorial.binding_the_object__this_">Binding
+ the Object <code class="computeroutput">this</code></a></dt>
+<dt>Templates</dt>
+</dl></dd>
+<dt>Advanced Topics</dt>
+<dd><dl>
+<dt><a href="boost_localfunction/Advanced_Topics.html#boost_localfunction.Advanced_Topics.default_parameters">Default
+ Parameters</a></dt>
+<dt><a href="boost_localfunction/Advanced_Topics.html#boost_localfunction.Advanced_Topics.commas_and_symbols_in_macros">Commas
+ and Symbols in Macros</a></dt>
+<dt><a href="boost_localfunction/Advanced_Topics.html#boost_localfunction.Advanced_Topics.assigning_and_returning">Assigning
+ and Returning</a></dt>
+<dt>Nesting</dt>
+<dt><a href="boost_localfunction/Advanced_Topics.html#boost_localfunction.Advanced_Topics.accessing_types__concepts__etc_">Accessing
+ Types (concepts, etc)</a></dt>
+<dt><a href="boost_localfunction/Advanced_Topics.html#boost_localfunction.Advanced_Topics.specifying_types">Specifying
+ Types</a></dt>
+<dt>Inlining</dt>
+<dt>Recursion</dt>
+<dt>Overloading</dt>
+<dt><a href="boost_localfunction/Advanced_Topics.html#boost_localfunction.Advanced_Topics.exception_specifications">Exception
+ Specifications</a></dt>
+<dt><a href="boost_localfunction/Advanced_Topics.html#boost_localfunction.Advanced_Topics.storage_classifiers___auto__and__register__">Storage
+ Classifiers (<code class="computeroutput">auto</code> and <code class="computeroutput">register</code>)</a></dt>
+<dt><a href="boost_localfunction/Advanced_Topics.html#boost_localfunction.Advanced_Topics.limitations__operators__etc_">Limitations
+ (operators, etc)</a></dt>
+</dl></dd>
+<dt>Examples</dt>
+<dd><dl>
+<dt><a href="boost_localfunction/Examples.html#boost_localfunction.Examples.gcc_lambdas__without_c__11_">GCC
+ Lambdas (Without C++11)</a></dt>
+<dt><a href="boost_localfunction/Examples.html#boost_localfunction.Examples.constant_blocks">Constant
+ Blocks</a></dt>
+<dt>Scope Exits</dt>
+<dt><a href="boost_localfunction/Examples.html#boost_localfunction.Examples.boost_phoenix_functions">Boost.Phoenix
+ Functions</a></dt>
+<dt>Closures</dt>
+<dt><a href="boost_localfunction/Examples.html#boost_localfunction.Examples.gcc_nested_functions">GCC
+ Nested Functions</a></dt>
+<dt>N-Papers</dt>
+</dl></dd>
+<dt>Reference</dt>
+<dd><dl>
+<dt>Header <boost/local_function.hpp></dt>
+<dt>Header <boost/local_function/config.hpp></dt>
+</dl></dd>
+<dt>Annex: Alternatives</dt>
+<dt><a href="boost_localfunction/No_Variadic_Macros.html">Annex: No Variadic
+ Macros</a></dt>
+<dt>Annex: Implementation</dt>
+<dt>Release Notes</dt>
+<dt>Bibliography</dt>
+<dt>Acknowledgments</dt>
+</dl>
+</div>
+
+ This library allows to program functions locally, directly within the scope where
+ they are needed.
+ 
+<div class="section boost_localfunction_Introduction">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_localfunction.Introduction"></a><a class="link" href="index.html#boost_localfunction.Introduction" title="Introduction">Introduction</a>
+</h2></div></div></div>
+
+ Local functions are a form of information hiding
+ and they are useful for dividing procedural tasks into subtasks which are only
+ meaningful locally, avoiding cluttering other parts of the program with functions,
+ variables, etc unrelated to those parts. Local functions therefore complement
+ other structuring possibilities such as namespaces and classes. Local functions
+ are a feature of many programming languages, notably Pascal
+ and Ada,
+ yet lacking from C++03
+ (see also [N2511]).
+ 
+
+ Using <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions, it is possible to implement local functions by naming
+ the lambdas assigning them to local variables. For example (see also add_lambda.cpp):
+ 
+
+
+<pre class="programlisting">{ // Some local scope.
+ int sum = 0, factor = 10; // Variables in scope to bind.
+
+ auto add = [factor, &sum](int num) { // C++11 only.
+ sum += factor * num;
+ };
+
+ add(1); // Call the lambda.
+ int nums[] = {2, 3};
+ std::for_each(nums, nums + 2, add); // Pass it to an algorithm.
+
+ BOOST_CHECK( sum == 60 ); // Assert final summation value.
+}
+</pre>
+
+ 
+
+ This library allows to program local functions portably between C++03
+ and C++11 (and
+ with performances comparable to lambdas on C++11
+ compilers, see the <a class="link" href="boost_localfunction/Alternatives.html" title="Annex: Alternatives">Alternatives</a>
+ section). For example (see also add.cpp):
+ 
+
+
+<pre class="programlisting">{ // Some local scope.
+ int sum = 0, factor = 10; // Variables in scope to bind.
+
+ void BOOST_LOCAL_FUNCTION(const bind factor, bind& sum, int num) {
+ sum += factor * num;
+ } BOOST_LOCAL_FUNCTION_NAME(add)
+
+ add(1); // Call the local function.
+ int nums[] = {2, 3};
+ std::for_each(nums, nums + 2, add); // Pass it to an algorithm.
+
+ BOOST_CHECK( sum == 60 ); // Assert final summation value.
+}
+</pre>
+
+ 
+
+ This library supports the following features for local functions:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Local functions can capture, or better bind,
+ any of the variables from the enclosing scope (a function together with
+ its captured variables is also called a closure).
+ </li>
+<li class="listitem">
+ The local function body is programmed using the usual C++ statement syntax
+ (as a consequence, compiler errors and debugging retain their usual meaning
+ and format).
+ </li>
+<li class="listitem">
+ Local functions can be passed as template parameters so they can be conveniently
+ used with STL algorithms, etc. [<a name="boost_localfunction.Introduction.f0" href="#ftn.boost_localfunction.Introduction.f0" class="footnote">1</a>]
+ </li>
+<li class="listitem">
+ However, local functions must be specified within a declarative context
+ (e.g., at a point in the code where local variables can be declared) thus
+ they cannot be specified within expressions. [<a name="boost_localfunction.Introduction.f1" href="#ftn.boost_localfunction.Introduction.f1" class="footnote">2</a>]
+ </li>
+</ul></div>
+
+ See the <a class="link" href="boost_localfunction/Alternatives.html" title="Annex: Alternatives">Alternatives</a>
+ section for a comparison between this library, <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions, Boost.Phoenix,
+ and other C++ techniques that implement features related to local functions.
+ 
+</div>
+<div class="footnotes">
+ <hr width="100" align="left">
+<div class="footnote">[<a id="ftn.boost_localfunction.Introduction.f0" href="#boost_localfunction.Introduction.f0" class="para">1</a>] 
+ This is a strength with respect to C++03
+ functors implemented using local classes which cannot be passed as template
+ parameters (see [N2657]
+ and the <a class="link" href="boost_localfunction/Alternatives.html" title="Annex: Alternatives">Alternatives</a>
+ section).
+ </div>
+<div class="footnote">[<a id="ftn.boost_localfunction.Introduction.f1" href="#boost_localfunction.Introduction.f1" class="para">2</a>] 
+ This is a weakness with respect to <a href="http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions" target="_top">C++11
+ lambda</a> functions which can instead be specified also within expressions
+ (see the <a class="link" href="boost_localfunction/Alternatives.html" title="Annex: Alternatives">Alternatives</a>
+ section).
+ </div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left">Last revised: February 14, 2012 at 15:46:08 GMT</td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="boost_localfunction/Getting_Started.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/html/reference.html
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/html/reference.html 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,67 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Reference</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="up" href="index.html" title="Chapter 1. Boost.LocalFunction 1.0.0">
+<link rel="prev" href="boost_localfunction/Examples.html" title="Examples">
+<link rel="next" href="BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="boost_localfunction/Examples.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="index.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_LOCAL_FUNCTION.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section reference">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="reference"></a>Reference</h2></div></div></div>
+<div class="toc"><dl>
+<dt>Header <boost/local_function.hpp></dt>
+<dt>Header <boost/local_function/config.hpp></dt>
+</dl></div>
+<div class="section header_boost_local_function_hpp">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="header.boost.local_function_hpp"></a>Header <boost/local_function.hpp></h3></div></div></div>
+Local functions allow to program functions locally, directly within the scope where they are needed. 
+<pre class="synopsis">
+
+<a class="link" href="BOOST_LOCAL_FUNCTION.html" title="Macro BOOST_LOCAL_FUNCTION">BOOST_LOCAL_FUNCTION</a>(declarations)
+<a class="link" href="BOOST_LOCAL_FUNCTION_TPL.html" title="Macro BOOST_LOCAL_FUNCTION_TPL">BOOST_LOCAL_FUNCTION_TPL</a>(declarations)
+<a class="link" href="BOOST_LOCAL_FUNCTION_NAME.html" title="Macro BOOST_LOCAL_FUNCTION_NAME">BOOST_LOCAL_FUNCTION_NAME</a>(qualified_function_name)
+<a class="link" href="BOOST_LOCAL_FUNCTION_TYPEOF.html" title="Macro BOOST_LOCAL_FUNCTION_TYPEOF">BOOST_LOCAL_FUNCTION_TYPEOF</a>(bound_variable_name)</pre>
+</div>
+<div class="section header_boost_local_function_config_hpp">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="header.boost.local_function.config_hpp"></a>Header <boost/local_function/config.hpp></h3></div></div></div>
+Configuration macros allow to change the behaviour of this library at compile-time. 
+<pre class="synopsis">
+
+<a class="link" href="BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX.html" title="Macro BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX">BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX</a>
+<a class="link" href="BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX.html" title="Macro BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX">BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX</a></pre>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Lorenzo
+ Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="boost_localfunction/Examples.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="index.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_LOCAL_FUNCTION.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/local_function/doc/implementation.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/implementation.qbk 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,50 @@
+
+[/ Copyright (C) 2009-2012 Lorenzo Caminiti ]
+[/ Distributed under the Boost Software License, Version 1.0 ]
+[/ (see accompanying file LICENSE_1_0.txt or a copy at ]
+[/ http://www.boost.org/LICENSE_1_0.txt) ]
+[/ Home at http://www.boost.org/libs/local_function ]
+
+[section:Implementation Annex: Implementation]
+
+This section gives an overview of the key programming techniques used to implement this library.
+
+[note
+The code listed here can be used by curious readers and library maintainers as a reference in trying to understand the library source code.
+There is absolutely no guarantee that the library implementation uses the exact code listed here.
+]
+
+[h5 Local Classes as Template Parameters]
+
+This library uses a local class to implement the local function object.
+However, in __CPP03__ local classes (and therefore the local function objects they implement) cannot be passed as template parameters (e.g., to the `std::for_each` algorithm), this is instead possible in __CPP11__, MSVC, and some other compilers (see __N2657__).
+To work around this limitation, this library investigated the following two "tricks" (both tricks can be extended to support eventual function default parameters):
+
+# The /casting functor trick/ uses a non-local functor that calls a static member function of the local class via a function pointer.
+The static member function then calls the correct local function body after type casting the object from a `void*` pointer (local classes can always be used for type casting).
+
+# The /virtual functor trick/ derives the local functor class from a non-local base class.
+The correct overridden implementation of the virtual `operator()` is then called via polymorphism.
+
+For example (see also [@../../example/impl_tparam_tricks.cpp =impl_tparam_tricks.cpp=]):
+
+[impl_tparam_tricks]
+
+The casting functor trick measured slightly better run-time performances than the virtual functor trick so the current implementation of this library uses the casting functor trick (probably because in addition to the indirect function call, the virtual functor trick also requires accessing the [@http://en.wikipedia.org/wiki/Virtual_method_table virtual function table]).
+However, neither one of tricks has been observed to allow for compiler optimizations that inline the local function calls (because they rely on one indirect function call via either a function pointer or a virtual function respectively).
+Therefore, on compilers that accept local types as template parameters (MSVC, __CPP11__, etc, see __N2657__), this library automatically generates code that passes the local class type directly as template parameter without using neither one of these two tricks in order to take full advantage of compiler optimizations that inline the local function calls.
+
+[h5 Parsing Macros]
+
+This library macros can parse the list of specified parameters and detect if any of the bound variable names matches the token `this_` (to generate special code to bind the object in scope), or if the variable is bound by `const` (to generate special code to bind by constant), etc.
+The parameter tokens are inspected using preprocessor metaprogramming and specifically using the macros defined by the files in the =boost/local_function/detail/preprocessor/keyword/= directory.
+[footnote
+This technique is at the core of even more complex preprocessor parsing macros like the ones that parse the __Contractpp__ syntax.
+]
+
+For example, the following code defines a macro that allows the preprocessor to detect if a set of space-separated tokens ends with `this_` or not (see also [@../../example/impl_pp_keyword.cpp =impl_pp_keyword.cpp=]):
+
+[impl_pp_keyword]
+
+[endsect]
+

Added: trunk/libs/local_function/doc/introduction.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/introduction.qbk 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,40 @@
+
+[/ Copyright (C) 2009-2012 Lorenzo Caminiti ]
+[/ Distributed under the Boost Software License, Version 1.0 ]
+[/ (see accompanying file LICENSE_1_0.txt or a copy at ]
+[/ http://www.boost.org/LICENSE_1_0.txt) ]
+[/ Home at http://www.boost.org/libs/local_function ]
+
+[section:Introduction Introduction]
+
+/Local functions/ are a form of /information hiding/ and they are useful for dividing procedural tasks into subtasks which are only meaningful locally, avoiding cluttering other parts of the program with functions, variables, etc unrelated to those parts.
+Local functions therefore complement other structuring possibilities such as namespaces and classes.
+Local functions are a feature of many programming languages, notably [@http://en.wikipedia.org/wiki/Nested_function#An_example Pascal] and [@http://en.wikipedia.org/wiki/Nesting_(computing)#In_programming Ada], yet lacking from __CPP03__ (see also __N2511__).
+
+Using __CPP11_lambda__ functions, it is possible to implement local functions by naming the lambdas assigning them to local variables.
+For example (see also [@../../test/add_lambda.cpp =add_lambda.cpp=]):
+
+[add_lambda]
+
+This library allows to program local functions portably between __CPP03__ and __CPP11__ (and with performances comparable to lambdas on __CPP11__ compilers, see the __Alternatives__ section).
+For example (see also [@../../test/add.cpp =add.cpp=]):
+
+[add]
+
+This library supports the following features for local functions:
+
+* Local functions can capture, or better [@http://en.wikipedia.org/wiki/Name_binding /bind/], any of the variables from the enclosing scope (a function together with its captured variables is also called a [@http://en.wikipedia.org/wiki/Closure_(computer_science) /closure/]).
+* The local function body is programmed using the usual C++ statement syntax (as a consequence, compiler errors and debugging retain their usual meaning and format).
+* Local functions can be passed as template parameters so they can be conveniently used with STL algorithms, etc.
+[footnote
+This is a strength with respect to __CPP03__ functors implemented using local classes which cannot be passed as template parameters (see __N2657__ and the __Alternatives__ section).
+]
+* However, local functions must be specified within a declarative context (e.g., at a point in the code where local variables can be declared) thus they cannot be specified within expressions.
+[footnote
+This is a weakness with respect to __CPP11_lambda__ functions which can instead be specified also within expressions (see the __Alternatives__ section).
+]
+
+See the __Alternatives__ section for a comparison between this library, __CPP11_lambda__ functions, __Boost_Phoenix__, and other C++ techniques that implement features related to local functions.
+
+[endsect]
+

Added: trunk/libs/local_function/doc/local_function.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/local_function.qbk 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,121 @@
+
+[/ Copyright (C) 2009-2012 Lorenzo Caminiti ]
+[/ Distributed under the Boost Software License, Version 1.0 ]
+[/ (see accompanying file LICENSE_1_0.txt or a copy at ]
+[/ http://www.boost.org/LICENSE_1_0.txt) ]
+[/ Home at http://www.boost.org/libs/local_function ]
+
+[library Boost.LocalFunction
+ [quickbook 1.5]
+ [version 1.0.0]
+ [copyright 2009-2012 Lorenzo Caminiti]
+ [purpose declare functions at local scope]
+ [license
+ Distributed under the Boost Software License, Version 1.0
+ (see accompanying file LICENSE_1_0.txt or a copy at
+ [@http://www.boost.org/LICENSE_1_0.txt])
+ ]
+ [authors [Caminiti <email>lorcaminiti_at_[hidden]</email>, Lorenzo]]
+ [category Function Objects and Higher-Order Programming]
+]
+
+[def __CPP03__ [@http://www.open-std.org/JTC1/SC22/WG21/docs/standards C++03]]
+[def __CPP11__ [@http://www.open-std.org/JTC1/SC22/WG21/ C++11]]
+[def __C99__ [@http://www.open-std.org/jtc1/sc22/wg14/www/projects#9899 C99]]
+[def __Boost__ [@http://www.boost.org Boost]]
+[def __Boost_LocalFunction__ [@http://www.boost.org/libs/local_function Boost.LocalFunction]]
+[def __Boost_ScopeExit__ [@http://www.boost.org/libs/scope_exit Boost.ScopeExit]]
+[def __Boost_Test__ [@http://www.boost.org/libs/test Boost.Test]]
+[def __Boost_Lambda__ [@http://www.boost.org/libs/lambda Boost.Lambda]]
+[def __Boost_Phoenix__ [@http://www.boost.org/libs/phoenix Boost.Phoenix]]
+[def __Boost_Preprocessor__ [@http://www.boost.org/libs/preprocessor Boost.Preprocessor]]
+[def __Boost_MPL__ [@http://www.boost.org/libs/mpl Boost.MPL]]
+[def __Boost_ConceptCheck__ [@http://www.boost.org/libs/concept_check Boost.ConceptCheck]]
+[def __Boost_Parameter__ [@http://www.boost.org/libs/parameter Boost.Paramater]]
+[def __Boost_Typeof__ [@http://www.boost.org/libs/typeof Boost.Typeof]]
+[def __Boost_Function__ [@http://www.boost.org/libs/function Boost.Function]]
+[def __Boost_Functional_OverloadedFunction__ [@http://www.boost.org/libs/functional/overloaded_function Boost.Functional/OverloadedFunction]]
+[def __Boost_TypeTraits__ [@http://www.boost.org/libs/type_traits Boost.TypeTraits]]
+[def __Boost_Utility_IdentityType__ [@http://www.boost.org/libs/utility/identity_type Boost.Utility/IdentityType]]
+[def __Boost_Chrono__ [@http://www.boost.org/libs/chrono Boost.Chrono]]
+[def __CPP11_lambda__ [@http://en.wikipedia.org/wiki/C%2B%2B0x#Lambda_functions_and_expressions C++11 lambda]]
+[def __LISP__ [@http://en.wikipedia.org/wiki/Lisp_(programming_language) LISP]]
+[def __Contractpp__ [@http://sourceforge.net/projects/contractpp Contract++]]
+[def __D_Programming_Language__ [@http://d.digitalmars.com D Programming Language]]
+[def __expression_template__ [@http://en.wikibooks.org/wiki/More_C%2B%2B_Idioms/Expression-template expression template]]
+[def __N1613__ [@http://www.open-std.org/JTC1/SC22/WG21/docs/papers/2004/n1613.pdf \[N1613\]]]
+[def __N2511__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2511.html \[N2511\]]]
+[def __N2529__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2529.pdf \[N2529\]]]
+[def __N2550__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2550.pdf \[N2550\]]]
+[def __N2657__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm \[N2657\]]]
+
+[def __Introduction__ [link boost_localfunction.Introduction Introduction]]
+[def __Getting_Started__ [link boost_localfunction.Getting_Started Getting Started]]
+[def __Tutorial__ [link boost_localfunction.Tutorial Tutorial]]
+[def __Advanced_Topics__ [link boost_localfunction.Advanced_Topics Advanced Topics]]
+[def __Examples__ [link boost_localfunction.Examples Examples]]
+[def __Reference__ [@reference.html Reference]]
+[def __Alternatives__ [link boost_localfunction.Alternatives Alternatives]]
+[def __No_Variadic_Macros__ [link boost_localfunction.No_Variadic_Macros No Variadic Macros]]
+[def __Implementation__ [link boost_localfunction.Implementation Implementation]]
+[def __Release_Notes__ [link boost_localfunction.Release_Notes Release Notes]]
+[def __Bibliography__ [link boost_localfunction.Bibliography Bibliography]]
+[def __Acknowledgments__ [link boost_localfunction.Acknowledgments Acknowledgments]]
+
+[import ../test/add.cpp]
+[import ../test/add_seq.cpp]
+[import ../test/add_lambda.cpp]
+[import ../test/add_params.cpp]
+[import ../test/ten_void.cpp]
+[import ../test/add_this.cpp]
+[import ../test/add_template.cpp]
+[import ../test/add_default.cpp]
+[import ../test/add_with_default.cpp]
+[import ../test/macro_commas.cpp]
+[import ../test/return_assign.cpp]
+[import ../test/transform.cpp]
+[import ../test/typeof.cpp]
+[import ../test/typeof_template.cpp]
+[import ../test/add_typed.cpp]
+[import ../test/add_inline.cpp]
+[import ../test/nesting.cpp]
+[import ../test/factorial.cpp]
+[import ../test/overload.cpp]
+[import ../test/add_except.cpp]
+[import ../test/add_classifiers.cpp]
+[import ../test/operator_err.cpp]
+[import ../test/goto_err.cpp]
+[import ../test/seq.cpp]
+
+[import ../example/gcc_lambda.cpp]
+[import ../example/gcc_lambda_cpp11.cpp]
+[import ../example/const_block_err.cpp]
+[import ../example/scope_exit.cpp]
+[import ../example/scope_exit.hpp]
+[import ../example/phoenix_factorial_local.cpp]
+[import ../example/phoenix_factorial.cpp]
+[import ../example/noncopyable_lambda_err.cpp]
+[import ../example/noncopyable_local_function.cpp]
+[import ../example/expensive_copy_lambda.cpp]
+[import ../example/expensive_copy_local_function.cpp]
+[import ../example/add_local_functor.cpp]
+[import ../example/add_global_functor.cpp]
+[import ../example/add_phoenix.cpp]
+[import ../example/impl_tparam_tricks.cpp]
+[import ../example/impl_pp_keyword.cpp]
+
+This library allows to program functions locally, directly within the scope where they are needed.
+
+[include introduction.qbk]
+[include getting_started.qbk]
+[include tutorial.qbk]
+[include advanced_topics.qbk]
+[include examples.qbk]
+[xinclude reference.xml]
+[include alternatives.qbk]
+[include no_variadic_macros.qbk]
+[include implementation.qbk]
+[include release_notes.qbk]
+[include bibliography.qbk]
+[include acknowledgements.qbk]
+

Added: trunk/libs/local_function/doc/no_variadic_macros.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/no_variadic_macros.qbk 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,43 @@
+
+[/ Copyright (C) 2009-2012 Lorenzo Caminiti ]
+[/ Distributed under the Boost Software License, Version 1.0 ]
+[/ (see accompanying file LICENSE_1_0.txt or a copy at ]
+[/ http://www.boost.org/LICENSE_1_0.txt) ]
+[/ Home at http://www.boost.org/libs/local_function ]
+
+[section:No_Variadic_Macros Annex: No Variadic Macros]
+
+This section illustrates an alternative syntax for compilers without variadic macro support.
+
+[h5 Sequence Syntax]
+
+Most modern compilers support [@http://en.wikipedia.org/wiki/Variadic_macro variaid macros] (notably, these include GCC, MSVC, and all __CPP11__ compilers).
+However, in the rare case that programmers need to use this library on a compiler without variadic macros, this library also allows to specify its macro parameters using a __Boost_Preprocessor__ sequence where tokens are separated by round parenthesis `()`:
+
+ (token1) (token2) ... // All compilers.
+
+Instead of the comma-separated list that we have seen so far which requires variadic macros:
+
+ token1, token2, ... // Only compilers with varidic macros.
+
+For example, the following syntax is accepted on all compilers with and without variadic macros (see also [@../../test/add_seq.cpp =add_seq.cpp=]):
+
+[add_seq]
+
+However, on compilers with variadic macros the comma-separated syntax we have seen so far is preferred because more readable (see also [@../../test/add.cpp =add.cpp=]):
+
+[add]
+
+Note how the same macros accept both syntaxes on compilers with variadic macros and only the sequence syntax on compilers without variadic macros.
+Finally, an parameter list is always specified using `void` on compilers with and without variadic macros:
+
+[ten_void]
+
+[h5 An Example]
+
+The following example shows a bit of all the different macro parameter combinations using the sequence syntax (see also [@../../test/seq.cpp =seq.cpp=]):
+
+[seq]
+
+[endsect]
+

Added: trunk/libs/local_function/doc/release_notes.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/release_notes.qbk 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,51 @@
+
+[/ Copyright (C) 2009-2012 Lorenzo Caminiti ]
+[/ Distributed under the Boost Software License, Version 1.0 ]
+[/ (see accompanying file LICENSE_1_0.txt or a copy at ]
+[/ http://www.boost.org/LICENSE_1_0.txt) ]
+[/ Home at http://www.boost.org/libs/local_function ]
+
+[section:Release_Notes Release Notes]
+
+This section lists the major changes between different library releases (in chronological order).
+
+[h5 Version 1.0.0 (2012-01-31)]
+
+# Incorporated all comments from the [@http://lists.boost.org/boost-announce/2011/12/0340.php Boost review of this library].
+# Removed local blocks and local exits.
+# Renamed the library from Boost.Local to Boost.LocalFunction.
+# Using `this_` instead of `this` also in the local function declaration (not just the body).
+# Made changes that allow to return local functions (similar to closures).
+# Added GCC lambda and constant block examples.
+# Moved `overloaded_function` to Boost.Functional/OverloadedFunction.
+# Moved `BOOST_IDENTITY_TYPE` to Boost.Utility/IdentityType.
+
+[h5 Version 0.2.0 (2011-05-14)]
+
+# Replaced parenthesized syntax with variadic and sequencing macro syntaxes.
+# Profiled library performances against other approaches.
+# Replaced virtual functor trick with casting functor trick (for smaller run-time).
+# Optimized library run-time (rearranging code and not using casting functor trick on compilers that accept local classes as template parameters).
+# Supported inline and recursive local functions.
+# Added type-of macro to expose bound types.
+# Allowed to explicitly specify bound types.
+# Removed using `boost::function` instead of exposing internal local functor as public API.
+# Added functor to overload local functions (and functors in general).
+# Implemented support for nesting local functions, blocks, and exits into one another.
+
+[h5 Version 0.1.1 (2011-01-10)]
+
+# Uploaded library source into Boost SVN sandbox.
+# Fixed prev/next arrows and other minor layouts in documentation.
+# Added Release section to documentation.
+
+[h5 Version 0.1.0 (2011-01-03)]
+
+# Shared with Boost for first round of comments.
+
+[h5 Version 0.0.1 (2010-12-15)]
+
+# Completed development, examples, and documentation.
+
+[endsect]
+

Added: trunk/libs/local_function/doc/tutorial.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/local_function/doc/tutorial.qbk 2012-02-14 19:34:25 EST (Tue, 14 Feb 2012)
@@ -0,0 +1,226 @@
+
+[/ Copyright (C) 2009-2012 Lorenzo Caminiti ]
+[/ Distributed under the Boost Software License, Version 1.0 ]
+[/ (see accompanying file LICENSE_1_0.txt or a copy at ]
+[/ http://www.boost.org/LICENSE_1_0.txt) ]
+[/ Home at http://www.boost.org/libs/local_function ]
+
+[section:Tutorial Tutorial]
+
+This section illustrates basic usages of this library.
+
+[section Local Functions]
+
+Local functions are defined using macros from the header file [headerref boost/local_function.hpp].
+The macros must be used from within a declarative context (this is a limitation with respect to __CPP11_lambda__ functions which can instead be declared also within expressions):
+
+ #include <boost/local_function.hpp> // This library header.
+
+ ...
+ { // Some declarative context.
+ ...
+ ``/result-type/`` BOOST_LOCAL_FUNCTION(``/parameters/``) {
+ ``/body-code/``
+ } BOOST_LOCAL_FUNCTION_NAME(``/name/``)
+ ...
+ }
+
+The code expanded by the macros declares a function object (or [@http://en.wikipedia.org/wiki/Functor functor]) with the local function name specified by [macroref BOOST_LOCAL_FUNCTION_NAME].
+[footnote
+*Rationale.*
+The local function name must be passed to the macro [macroref BOOST_LOCAL_FUNCTION_NAME] ending the function definition so this macro can declare a local variable with the local function name to hold the local function object.
+Therefore the local function name cannot be specified within the [macroref BOOST_LOCAL_FUNCTION] and it must appear instead after the local function body (even if that differs from the usual C++ function declaration syntax).
+]
+The usual C++ scope visibility rules apply to local functions for which a local function is visible only within the enclosing scope in which it is declared.
+
+The local function body is specified in a code block `{ ... }` using the usual C++ syntax.
+The body is specified outside any of the macros so eventual compiler error messages and related line numbers retain their usual meaning and format.
+[footnote
+*Rationale.*
+If the local function body were instead passed as a macro parameter, it would be expanded on a single line of code (because macros always expand as a single line of code).
+Therefore, eventual compiler error line numbers would all report the same value and would no longer be useful to pinpoint errors.
+]
+
+The local function parameters are passed to the [macroref BOOST_LOCAL_FUNCTION] macro as a comma-separated list of tokens (see the __No_Variadic_Macros__ section for compilers that do not support variadic macros):
+
+ BOOST_LOCAL_FUNCTION(``[^/parameter-type1 parameter-name1/]``,`` [^/parameter-type2 parameter-name2, .../]``)
+
+The maximum number of parameters that can be passed to a local function is controlled at compile-time by the configuration macro [macroref BOOST_LOCAL_FUNCTION_CONFIG_ARITY_MAX].
+For example, let's program a local function named `add` that adds together two integers `x` and `y` (see also [@../../test/add_params.cpp =add_params.cpp=]):
+
+[add_params]
+
+If the local function has no parameter, it is possible to pass `void` to the [macroref BOOST_LOCAL_FUNCTION] macro (similarly to the C syntax that allows to use [^['result-type function-name]]`(void)` to declare a function with no parameter):
+[footnote
+*Rationale.*
+The __CPP03__ standard does not allow to pass empty parameters to a macro so the macro cannot be invoked as `BOOST_LOCAL_FUNCTION()`.
+On __C99__ compilers with properly implemented empty macro parameter support, it would be possible to allow `BOOST_LOCAL_FUNCTION()` but this is already not the case for MSVC so this syntax is never allowed to ensure better portability.
+]
+
+ BOOST_LOCAL_FUNCTION(void) // No parameter.
+
+For example, let's program a local function that always returns `10` (see also [@../../test/ten_void.cpp =ten_void.cpp=]):
+
+[ten_void]
+
+[endsect]
+
+[section:Binding Binding Variables]
+
+Variables in scope (local variables, enclosing function parameters, member variables, etc) can be bound to a local function declaration.
+Only bound variables, static variables, global variables, functions, and enumerations from the enclosing scope are accessible from within the local function body.
+The types of bound variables are deduced automatically by this library.
+[footnote
+*Rationale.*
+By binding a variable in scope, the local function declaration is specifying that such a variable should be accessible within the local function body regardless of its type.
+Semantically, this binding should be seen as an "extension" of the scope of the bound variable from the enclosing scope to the scope of the local function body.
+Therefore, contrary to the semantic of passing a function parameter, the semantic of binding a variable does not depend on the variable type but just on the variable name: "The variable in scope named /x/ should be accessible within the local function named /f/".
+For example, this reduces maintenance because if a bound variable type is changed, the local function declaration does not have to change.
+]
+
+[important
+The library implementation uses __Boost_Typeof__ to automatically deduce the types of the bound variables.
+Therefore, in order to compile code in type-of emulation mode, all types should be properly registered with `BOOST_TYPEOF_REGISTER_TYPE` or `BOOST_TYPEOF_REGISTER_TEMPLATE` macros, or appropriate __Boost_Typeof__ headers should be included (see the __Boost_Typeof__ documentation for more detail).
+]
+
+This library introduces the new "keyword" `bind`
+[footnote
+Obviously, the token `bind` is not a keyword of the C++ language.
+This library parses the token `bind` during macro expansion using preprocessor meta-programming (see the __Implementation__ section).
+Therefore, `bind` can be considered a new "keyword" only at the preprocessor meta-programming level within the syntax defined by the macros of this library (thus it is referred to as a "keyword" only within quotes).
+]
+which is used in place of the parameter type to specify the name of a variable in scope to bind (therefore, `bind` cannot be used as a local function parameter type).
+A variable can be bound by value:
+
+ bind ``/variable-name/`` // Bind by value.
+
+Or by reference prefixing the variable name with `&`:
+
+ bind& ``/variable-name/`` // Bind by reference.
+
+Furthermore, the "keyword" `bind` can be prefixed by `const` to bind the variable by constant value:
+
+ const bind ``/variable-name/`` // Bind by constant value.
+
+Or by constant reference:
+
+ const bind& ``/variable-name/`` // Bind by constant value.
+
+Note that when `const` is used, it must always precede `bind`.
+[footnote
+*Rationale.*
+The library macros could have been implemented to accept both syntaxes `const bind ...` and `bind const ...` equivalently.
+However, handling both syntaxes would have complicated the macro implementation without adding any feature so only one syntax (`const bind ...`) is supported.
+]
+
+If a variable is bound by value, then a copy of the variable value is taken at the point of the local function declaration.
+If a variable is bound by reference instead, the variable will refer to the value it has at the point of the local function call.
+Furthermore, it is the programmers' responsibility to ensure that variables bound by reference survive the existence scope of the local function otherwise the bound references will be invalid when the local function is called resulting in undefined behaviour (in other words, the usual care in using C++ references must be taken for variables bound by reference).
+
+The type of a bound variable is automatically deduced and it is the exact same type used to declare such a variable in the enclosing scope with the following notes:
+
+* If a bound variable was declared constant in the enclosing scope, it will always be bound by constant value or constant reference even if `bind...` is used instead of `const bind...` .
+However, if a bound variable was not declared constant in the enclosing scope then it will not be bound as constant unless constant binding is forced using `const bind...`.
+(Note that binding by constant reference is not supported by __CPP11_lambda__ functions but it is supported by this library.)
+[footnote
+An historical note: Constant binding of variables in scope was the main use case that originally motivated the authors in developing this library.
+The authors needed to locally create a chuck of code to assert some correctness conditions while these assertions were not supposed to modify any of the variables they were using (see the __Contractpp__ library).
+This was achieved by binding by constant reference `const bind&` the variables needed by the assertions and then by programming the local function body to check the assertions.
+This way if any of the assertions mistakenly changes a bound variable (for example confusing the operator `==` with `=`), the compiler correctly generates an error because the bound variable is of `const` type within the local function body (see also /constant blocks/ in the __Examples__ section).
+]
+* If a bound variable was declared as a reference in the enclosing scope, it will still be bound by value unless it is explicitly bound by reference using `bind&` or `const bind&`.
+[footnote
+*Rationale.*
+Variables originally declared as references are bound by value unless `[const] bind&` is used so that references can be bound by both value `[const] bind` and reference `[const] bind&` (this is the same binding semantic adopted by __Boost_ScopeExit__).
+On the other hand, variables originally declared as constants should never loose their `const` qualifier (to prevent their modification not just in the enclosing scope but also in the local scope) thus they are always bound by constant even if `bind[&]` is used instead of `const bind[&]`.
+]
+
+When a variable is bound by value (constant or not), its type must be `CopyConstructible` (i.e., its must provide a copy constructor).
+As with passing parameters to usual C++ functions, programmers might want to bind variables of complex types by (possibly constant) reference instead of by value to avoid expensive copy operations when these variables are bound to a local function.
+
+For example, let's program the local function `add` from the example in the __Introduction__ section.
+We bind the local variable `factor` by constant value (because its value should not be modified by the local function), the local variable `sum` by non-constant reference (because its value needs to be updated with the summation result), and program the body to perform the summation (see also [@../../test/add.cpp =add.cpp=]):
+
+[add]
+
+[endsect]
+
+[section Binding the Object `this`]
+
+It is also possible to bind the object `this` when it is in scope (e.g., from an enclosing non-static member function).
+This is done by using the special symbol `this_` (instead of `this`) as the name of the variable to bind in the local function declaration and also to access the object within the local function body.
+[footnote
+*Rationale.*
+The special name `this_` was chosen following [@http://boost.2283326.n4.nabble.com/local-this-or-this-td3423912.html Boost practises] which postfix with an underscore identifiers that are named after keywords (the C++ keyword `this` in this case).
+The special symbol `this_` is needed because `this` is a reserved C++ keyword so it cannot be used as the name of the internal parameter that passes the bound object to the local function body.
+It would have been possible to use `this` (instead of `this_`) within the local function body either at the expenses of copying the bound object (which would introduce run-time overhead and also the stringent requirement that the bound object must have a deep copy constructor) or by relying on an [@http://groups.google.com/group/comp.lang.c++.moderated/browse_thread/thread/d3a86f27277f713b undefined behaviour of `static_cast`] (which might not work on all platforms at the cost of portability).
+]
+
+[warning
+The library will generate a compile-time error if `this` is mistakenly used instead of `this_` to bind the object in the local function declaration.
+However, mistakenly using `this` instead of `this_` to access the object within the local function body will leads to undefined behaviour and it will not necessarily generate a compile-time error.
+[footnote
+*Rationale.*
+The local function body cannot be a static member function of the local functor object in order to support recursion (because the local function name is specified by the [macroref BOOST_LOCAL_FUNCTION_NAME] macro only after the body so it must be made available via a functor member variable named after the local function and local classes cannot have static member variables in C++) and nesting (because the argument binding variable must be declared as a member variable so it is visible in a local function nested within the body member function) -- see the __Implementation__ section.
+Therefore, from within the local function body the variable `this` is visible but it refers to the local functor and not to the bound object.
+]
+Programmers are ultimately responsible to make sure that `this` is never used within a local function.
+]
+
+The object `this` can be bound by value:
+
+ bind this_ // Bind the object `this` by value.
+
+In this case the local function will be able to modify the object when the enclosing scope is not a constant member and it will not be able to modify the object when the enclosing scope is a constant member.
+Otherwise, the object `this` can be bound by constant value:
+
+ const bind this_ // Bind the object `this` by constant value.
+
+In this case the local function will never be able to modify the object (regardless of whether the enclosing scope is a constant member or not).
+
+Note that the object `this` can never be bound by reference because C++ does not allow to obtain a reference to `this` (the library will generate a compile-time error if programmers try to use `bind& this_` or `const bind& this_`).
+Note that `this` is a pointer so the pointed object is never copied even if `this` is bound by value (also it is not possible to directly bind `*this` because `*this` is an expression and not a variable name).
+
+For example, let's program a local function `add` similar to the one in the example from the __Introduction__ section but using a member function to illustrate how to bind the object `this` (see also [@../../test/add_this.cpp =add_this.cpp=]):
+
+[add_this]
+
+Note that the local function has access to all class members via the bound object `this_` regardless of their access level (`public`, `protected`, or `private`).
+[footnote
+*Rationale.*
+This is possible because of the fix to C++ [@http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_defects.html#45 defect 45] that made inner and local types able to access all outer class members regardless of their access level.
+]
+Specifically, in the example above the local function updates the `private` data member `sum_`.
+
+[endsect]
+
+[section Templates]
+
+When local functions are programmed within templates, they need to be declared using the special macro [macroref BOOST_LOCAL_FUNCTION_TPL]:
+[footnote
+*Rationale.*
+Within templates, this library needs to use `typename` to explicitly indicate that some expressions evaluate to a type.
+Because __CPP03__ does not allow to use `typename` outside templates, the special `TPL` macro is used to indicate that the enclosing scope is a template so this library can safely use `typename` to resolve expression type ambiguities.
+]
+
+ #include <boost/local_function.hpp> // This library header.
+
+ ...
+ { // Some declarative context within a template.
+ ...
+ ``/result-type/`` BOOST_LOCAL_FUNCTION_TPL(``/parameters/``) {
+ ``/body-code/``
+ } BOOST_LOCAL_FUNCTION_NAME(``/name/``)
+ ...
+ }
+
+The [macroref BOOST_LOCAL_FUNCTION_TPL] macro has the exact same syntax of the [macroref BOOST_LOCAL_FUNCTION] macro that we have seen so far.
+
+For example, let's program a local function similar to the one from the __Introduction__ section but within a template (see also [@../../test/add_template.cpp =add_template.cpp=]):
+
+[add_template]
+
+[endsect]
+
+[endsect]
+

Date view	Thread view	Subject view	Author view

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