Chris@16: 
Chris@16: // Copyright (C) 2009-2012 Lorenzo Caminiti
Chris@16: // Distributed under the Boost Software License, Version 1.0
Chris@16: // (see accompanying file LICENSE_1_0.txt or a copy at
Chris@16: // http://www.boost.org/LICENSE_1_0.txt)
Chris@16: // Home at http://www.boost.org/libs/local_function
Chris@16: 
Chris@16: #if !BOOST_PP_IS_ITERATING
Chris@16: #   ifndef BOOST_LOCAL_FUNCTION_AUX_FUNCTION_HPP_
Chris@16: #       define BOOST_LOCAL_FUNCTION_AUX_FUNCTION_HPP_
Chris@16: 
Chris@16: #       include <boost/local_function/config.hpp>
Chris@16: #       include <boost/local_function/aux_/member.hpp>
Chris@16: #       include <boost/call_traits.hpp>
Chris@16: #       include <boost/typeof/typeof.hpp>
Chris@16: #       include <boost/config.hpp>
Chris@16: #       include <boost/preprocessor/iteration/iterate.hpp>
Chris@16: #       include <boost/preprocessor/repetition/repeat.hpp>
Chris@16: #       include <boost/preprocessor/repetition/enum.hpp>
Chris@16: #       include <boost/preprocessor/punctuation/comma_if.hpp>
Chris@16: #       include <boost/preprocessor/arithmetic/add.hpp>
Chris@16: #       include <boost/preprocessor/arithmetic/sub.hpp>
Chris@16: #       include <boost/preprocessor/arithmetic/inc.hpp>
Chris@16: #       include <boost/preprocessor/control/iif.hpp>
Chris@16: #       include <boost/preprocessor/cat.hpp>
Chris@16: 
Chris@16: // PRIVATE //
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_FUNCTION_THIS_FILE_ \
Chris@16:     "boost/local_function/aux_/function.hpp"
Chris@16: 
Chris@16: // PUBLIC //
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_FUNCTION_INIT_CALL_FUNC \
Chris@16:     BOOST_LOCAL_FUNCTION_AUX_SYMBOL( (init_call) )
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_typename_seq(z, n, unused) \
Chris@16:     (typename)
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_arg_type(z, arg_n, unused) \
Chris@16:     BOOST_PP_CAT(Arg, arg_n)
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_arg_typedef(z, arg_n, unused) \
Chris@16:     typedef \
Chris@16:         BOOST_LOCAL_FUNCTION_AUX_arg_type(z, arg_n, ~) \
Chris@16:         /* name must follow Boost.FunctionTraits arg1_type, arg2_type, ... */ \
Chris@16:         BOOST_PP_CAT(BOOST_PP_CAT(arg, BOOST_PP_INC(arg_n)), _type) \
Chris@16:     ;
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_comma_arg_tparam(z, arg_n, unused) \
Chris@16:     , typename BOOST_LOCAL_FUNCTION_AUX_arg_type(z, arg_n, ~)
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_arg_param_type(z, arg_n, comma01) \
Chris@16:     BOOST_PP_COMMA_IF(comma01) \
Chris@16:     typename ::boost::call_traits< \
Chris@16:         BOOST_LOCAL_FUNCTION_AUX_arg_type(z, arg_n, ~) \
Chris@16:     >::param_type
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_arg_name(z, arg_n, comma01) \
Chris@16:     BOOST_PP_COMMA_IF(comma01) \
Chris@16:     BOOST_PP_CAT(arg, arg_n)
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_arg_param_decl(z, arg_n, unused) \
Chris@16:     BOOST_LOCAL_FUNCTION_AUX_arg_param_type(z, arg_n, 0 /* no leading comma */)\
Chris@16:     BOOST_LOCAL_FUNCTION_AUX_arg_name(z, arg_n, 0 /* no leading comma */)
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_bind_type(z, bind_n, unused) \
Chris@16:     BOOST_PP_CAT(Bind, bind_n)
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_comma_bind_type(z, bind_n, unused) \
Chris@16:     , BOOST_LOCAL_FUNCTION_AUX_bind_type(z, bind_n, ~)
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_comma_bind_ref(z, bind_n, unused) \
Chris@16:     , BOOST_LOCAL_FUNCTION_AUX_bind_type(z, bind_n, ~) &
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_comma_bind_tparam(z, bind_n, unused) \
Chris@16:     , typename BOOST_LOCAL_FUNCTION_AUX_bind_type(z, bind_n, ~)
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_bind_name(z, bind_n, unused) \
Chris@16:     BOOST_PP_CAT(bing, bind_n)
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_comma_bind_param_decl(z, bind_n, unused) \
Chris@16:     , \
Chris@16:     BOOST_LOCAL_FUNCTION_AUX_bind_type(z, bind_n, ~) & \
Chris@16:     BOOST_LOCAL_FUNCTION_AUX_bind_name(z, bind_n, ~)
Chris@16:     
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_bind_member(z, bind_n, unsued) \
Chris@16:     BOOST_PP_CAT(BOOST_LOCAL_FUNCTION_AUX_bind_name(z, bind_n, ~), _)
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_comma_bind_member_deref(z, bind_n, unsued) \
Chris@16:     , member_deref< BOOST_LOCAL_FUNCTION_AUX_bind_type(z, bind_n, ~) >( \
Chris@16:             BOOST_LOCAL_FUNCTION_AUX_bind_member(z, bind_n, ~))
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_bind_member_init(z, bind_n, unused) \
Chris@16:     BOOST_LOCAL_FUNCTION_AUX_bind_member(z, bind_n, ~) = member_addr( \
Chris@16:             BOOST_LOCAL_FUNCTION_AUX_bind_name(z, bind_n, ~));
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_bind_member_decl(z, bind_n, unused) \
Chris@16:     /* must be ptr (not ref) so can use default constr */ \
Chris@16:     typename member_type< \
Chris@16:         BOOST_LOCAL_FUNCTION_AUX_bind_type(z, bind_n, ~) \
Chris@16:     >::pointer BOOST_LOCAL_FUNCTION_AUX_bind_member(z, bind_n, ~) ;
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_call_ptr(z, n, unused) \
Chris@16:     BOOST_PP_CAT(call_ptr, n)
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_call_name(z, n, unused) \
Chris@16:     BOOST_PP_CAT(call, n)
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_call_member(z, n, unused) \
Chris@16:     BOOST_PP_CAT(BOOST_LOCAL_FUNCTION_AUX_call_name(z, n, unused), _)
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_call_typedef(z, n, arity) \
Chris@16:     typedef R (*BOOST_LOCAL_FUNCTION_AUX_call_ptr(z, n, ~))( \
Chris@16:         object_ptr \
Chris@16:         BOOST_PP_IIF(BOOST_LOCAL_FUNCTION_CONFIG_LOCALS_AS_TPARAMS, \
Chris@16:             BOOST_PP_TUPLE_EAT(3) \
Chris@16:         , \
Chris@16:             BOOST_PP_REPEAT_ ## z \
Chris@16:         )(BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX, \
Chris@16:                 BOOST_LOCAL_FUNCTION_AUX_comma_bind_ref, ~) \
Chris@16:         BOOST_PP_REPEAT_ ## z(BOOST_PP_SUB(arity, n), \
Chris@16:                 BOOST_LOCAL_FUNCTION_AUX_arg_param_type, 1 /* leading comma */)\
Chris@16:     );
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_comma_call_param_decl(z, n, unused) \
Chris@16:     , \
Chris@16:     BOOST_LOCAL_FUNCTION_AUX_call_ptr(z, n, ~) \
Chris@16:     BOOST_LOCAL_FUNCTION_AUX_call_name(z, n, ~)
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_call_decl(z, n, unused) \
Chris@16:     BOOST_LOCAL_FUNCTION_AUX_call_ptr(z, n, ~) \
Chris@16:     BOOST_LOCAL_FUNCTION_AUX_call_member(z, n, ~);
Chris@16: 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_call_init(z, n, unused) \
Chris@16:     BOOST_LOCAL_FUNCTION_AUX_call_member(z, n, ~) = \
Chris@16:             BOOST_LOCAL_FUNCTION_AUX_call_name(z, n, ~);
Chris@16:                 
Chris@16: #define BOOST_LOCAL_FUNCTION_AUX_operator_call(z, defaults_n, arity) \
Chris@16:     /* precondition: object_ && call_function_ */ \
Chris@16:     inline R operator()( \
Chris@16:         BOOST_PP_ENUM_ ## z(BOOST_PP_SUB(arity, defaults_n), \
Chris@16:                 BOOST_LOCAL_FUNCTION_AUX_arg_param_decl, ~) \
Chris@16:     ) /* cannot be const because of binds (same as for local ftor) */ { \
Chris@16:         /* run-time: do not assert preconditions here for efficiency */ \
Chris@16:         /* run-time: this function call is done via a function pointer */ \
Chris@16:         /* so unfortunately does not allow for compiler inlining */ \
Chris@16:         /* optimizations (an alternative using virtual function was also */ \
Chris@16:         /* investigated but also virtual functions cannot be optimized */ \
Chris@16:         /* plus they require virtual table lookups to the alternative */ \
Chris@16:         /* performed worst) */ \
Chris@16:         return BOOST_LOCAL_FUNCTION_AUX_call_member(z, defaults_n, ~)( \
Chris@16:             object_ \
Chris@16:             BOOST_PP_IIF( \
Chris@16:                     BOOST_LOCAL_FUNCTION_CONFIG_LOCALS_AS_TPARAMS,\
Chris@16:                 BOOST_PP_TUPLE_EAT(3) \
Chris@16:             , \
Chris@16:                 BOOST_PP_REPEAT_ ## z \
Chris@16:             )(BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX, \
Chris@16:                     BOOST_LOCAL_FUNCTION_AUX_comma_bind_member_deref, ~) \
Chris@16:             BOOST_PP_REPEAT_ ## z(BOOST_PP_SUB(arity, defaults_n), \
Chris@16:                     BOOST_LOCAL_FUNCTION_AUX_arg_name, 1 /* leading comma */) \
Chris@16:         ); \
Chris@16:     }
Chris@16: 
Chris@16: namespace boost { namespace local_function { namespace aux {
Chris@16: 
Chris@16: template<
Chris@16:       typename F
Chris@16:     , size_t defaults
Chris@16: #if !BOOST_LOCAL_FUNCTION_CONFIG_LOCALS_AS_TPARAMS
Chris@16:     BOOST_PP_REPEAT(BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX,
Chris@16:             BOOST_LOCAL_FUNCTION_AUX_comma_bind_tparam, ~)
Chris@16: #endif
Chris@16: >
Chris@16: class function {}; // Empty template, only use its specializations.
Chris@16: 
Chris@16: // Iterate within namespace.
Chris@16: #       define BOOST_PP_ITERATION_PARAMS_1 \
Chris@16:                 (3, (0, BOOST_LOCAL_FUNCTION_CONFIG_FUNCTION_ARITY_MAX, \
Chris@16:                 BOOST_LOCAL_FUNCTION_AUX_FUNCTION_THIS_FILE_))
Chris@16: #       include BOOST_PP_ITERATE() // Iterate over function arity.
Chris@16: 
Chris@16: } } } // namespace
Chris@16: 
Chris@16: // Register type for type-of emu (NAME use TYPEOF to deduce this fctor type).
Chris@16: #include BOOST_TYPEOF_INCREMENT_REGISTRATION_GROUP()
Chris@16: BOOST_TYPEOF_REGISTER_TEMPLATE(boost::local_function::aux::function,
Chris@16:     (typename) // For `F` tparam.
Chris@16:     (size_t) // For `defaults` tparam.
Chris@16:     // MSVC error if using #if instead of PP_IIF here.
Chris@16:     BOOST_PP_IIF(BOOST_LOCAL_FUNCTION_CONFIG_LOCALS_AS_TPARAMS,
Chris@16:         BOOST_PP_TUPLE_EAT(3) // Nothing.
Chris@16:     ,
Chris@16:         BOOST_PP_REPEAT // For bind tparams.
Chris@16:     )(BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX,
Chris@16:             BOOST_LOCAL_FUNCTION_AUX_typename_seq, ~)
Chris@16: )
Chris@16: 
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_typename_seq
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_arg_type
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_arg_typedef
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_comma_arg_tparam
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_arg_param_type
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_arg_name
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_arg_param_decl
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_bind_type
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_comma_bind_type
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_comma_bind_ref
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_comma_bind_tparam
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_bind_name
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_comma_bind_param_decl
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_bind_member
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_comma_bind_member_deref
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_bind_member_init
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_bind_member_decl
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_call_ptr
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_call_name
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_call_member
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_call_typedef
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_comma_call_param_decl
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_call_decl
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_call_init
Chris@16: #undef BOOST_LOCAL_FUNCTION_AUX_operator_call
Chris@16: 
Chris@16: #   endif // #include guard
Chris@16: 
Chris@16: #elif BOOST_PP_ITERATION_DEPTH() == 1
Chris@16: #   define BOOST_LOCAL_FUNCTION_AUX_arity BOOST_PP_FRAME_ITERATION(1)
Chris@16: #   define BOOST_PP_ITERATION_PARAMS_2 \
Chris@16:             (3, (0, BOOST_LOCAL_FUNCTION_AUX_arity, \
Chris@16:             BOOST_LOCAL_FUNCTION_AUX_FUNCTION_THIS_FILE_))
Chris@16: #   include BOOST_PP_ITERATE() // Iterate over default params count.
Chris@16: #   undef BOOST_LOCAL_FUNCTION_AUX_arity
Chris@16: 
Chris@16: #elif BOOST_PP_ITERATION_DEPTH() == 2
Chris@16: #   define BOOST_LOCAL_FUNCTION_AUX_defaults BOOST_PP_FRAME_ITERATION(2)
Chris@16: 
Chris@16: template<
Chris@16:     typename R
Chris@16:     BOOST_PP_REPEAT(BOOST_LOCAL_FUNCTION_AUX_arity,
Chris@16:             BOOST_LOCAL_FUNCTION_AUX_comma_arg_tparam, ~)
Chris@16: #if !BOOST_LOCAL_FUNCTION_CONFIG_LOCALS_AS_TPARAMS
Chris@16:     BOOST_PP_REPEAT(BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX,
Chris@16:             BOOST_LOCAL_FUNCTION_AUX_comma_bind_tparam, ~)
Chris@16: #endif
Chris@16: >
Chris@16: class function<
Chris@16:       R (
Chris@16:         BOOST_PP_ENUM(BOOST_LOCAL_FUNCTION_AUX_arity,
Chris@16:                 BOOST_LOCAL_FUNCTION_AUX_arg_type, ~)
Chris@16:       )
Chris@16:     , BOOST_LOCAL_FUNCTION_AUX_defaults
Chris@16: #if !BOOST_LOCAL_FUNCTION_CONFIG_LOCALS_AS_TPARAMS
Chris@16:     BOOST_PP_REPEAT(BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX,
Chris@16:             BOOST_LOCAL_FUNCTION_AUX_comma_bind_type, ~)
Chris@16: #endif
Chris@16: > {
Chris@16:     // The object type will actually be a local class which cannot be passed as
Chris@16:     // a template parameter so a generic `void*` pointer is used to hold the
Chris@16:     // object (this pointer will then be cased by the call-function implemented
Chris@16:     // by the local class itself). This is the trick used to pass a local
Chris@16:     // function as a template parameter. This trick uses function pointers for
Chris@16:     // the call-functions and function pointers cannot always be optimized by
Chris@16:     // the compiler (they cannot be inlined) thus this trick increased run-time
Chris@16:     // (another trick using virtual functions for the local class was also
Chris@16:     // investigated but also virtual functions cannot be inlined plus they
Chris@16:     // require virtual tables lookups so the virtual functions trick measured
Chris@16:     // worst run-time performance than the function pointer trick).
Chris@16:     typedef void* object_ptr;
Chris@16:     BOOST_PP_REPEAT(BOOST_PP_INC(BOOST_LOCAL_FUNCTION_AUX_defaults),
Chris@16:             BOOST_LOCAL_FUNCTION_AUX_call_typedef, // INC for no defaults.
Chris@16:             BOOST_LOCAL_FUNCTION_AUX_arity)
Chris@16: 
Chris@16: public:
Chris@16:     // Provide public type interface following Boost.Function names
Chris@16:     // (traits must be defined in both this and the local functor).
Chris@16:     BOOST_STATIC_CONSTANT(size_t, arity = BOOST_LOCAL_FUNCTION_AUX_arity);
Chris@16:     typedef R result_type;
Chris@16:     BOOST_PP_REPEAT(BOOST_LOCAL_FUNCTION_AUX_arity,
Chris@16:             BOOST_LOCAL_FUNCTION_AUX_arg_typedef, ~)
Chris@16: 
Chris@16:     // NOTE: Must have default constructor for init without function name in
Chris@16:     // function macro expansion.
Chris@16: 
Chris@16:     // Cannot be private but it should never be used by programmers directly
Chris@16:     // so used internal symbol.
Chris@16:     inline void BOOST_LOCAL_FUNCTION_AUX_FUNCTION_INIT_CALL_FUNC(
Chris@16:         object_ptr object
Chris@16: #if !BOOST_LOCAL_FUNCTION_CONFIG_LOCALS_AS_TPARAMS
Chris@16:         BOOST_PP_REPEAT(BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX,
Chris@16:                 BOOST_LOCAL_FUNCTION_AUX_comma_bind_param_decl, ~)
Chris@16: #endif
Chris@16:         BOOST_PP_REPEAT(BOOST_PP_INC(BOOST_LOCAL_FUNCTION_AUX_defaults),
Chris@16:                 BOOST_LOCAL_FUNCTION_AUX_comma_call_param_decl, ~)
Chris@16:     ) {
Chris@16:         object_ = object;
Chris@16: #if !BOOST_LOCAL_FUNCTION_CONFIG_LOCALS_AS_TPARAMS
Chris@16:         BOOST_PP_REPEAT(BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX,
Chris@16:                 BOOST_LOCAL_FUNCTION_AUX_bind_member_init, ~)
Chris@16: #endif
Chris@16:         BOOST_PP_REPEAT(BOOST_PP_INC(BOOST_LOCAL_FUNCTION_AUX_defaults),
Chris@16:                 BOOST_LOCAL_FUNCTION_AUX_call_init, ~) // INC for no defaults.
Chris@16:         unused_ = 0; // To avoid a GCC uninitialized warning.
Chris@16:     }
Chris@16:     
Chris@16:     // Result operator(Arg1, ..., ArgN-1, ArgN) -- iff defaults >= 0
Chris@16:     // Result operator(Arg1, ..., ArgN-1)       -- iff defaults >= 1
Chris@16:     // ...                                      -- etc
Chris@16:     BOOST_PP_REPEAT(BOOST_PP_INC(BOOST_LOCAL_FUNCTION_AUX_defaults),
Chris@16:             BOOST_LOCAL_FUNCTION_AUX_operator_call, // INC for no defaults.
Chris@16:             BOOST_LOCAL_FUNCTION_AUX_arity)
Chris@16: 
Chris@16: private:
Chris@16:     object_ptr object_;
Chris@16: #if !BOOST_LOCAL_FUNCTION_CONFIG_LOCALS_AS_TPARAMS
Chris@16:     BOOST_PP_REPEAT(BOOST_LOCAL_FUNCTION_CONFIG_BIND_MAX,
Chris@16:             BOOST_LOCAL_FUNCTION_AUX_bind_member_decl, ~)
Chris@16: #endif
Chris@16:     BOOST_PP_REPEAT(BOOST_PP_INC(BOOST_LOCAL_FUNCTION_AUX_defaults),
Chris@16:             BOOST_LOCAL_FUNCTION_AUX_call_decl, ~) // INC for no defaults.
Chris@16: 
Chris@16:     // run-time: this unused void* member variable allows for compiler
Chris@16:     // optimizations (at least on MSVC it reduces invocation time of about 50%)
Chris@16:     void* unused_;
Chris@16: };
Chris@16: 
Chris@16: #   undef BOOST_LOCAL_FUNCTION_AUX_defaults
Chris@16: #endif // iteration
Chris@16: