functional/overloaded_function/config.hpp

0001
0002 // Copyright (C) 2009-2012 Lorenzo Caminiti
0003 // Distributed under the Boost Software License, Version 1.0
0004 // (see accompanying file LICENSE_1_0.txt or a copy at
0005 // http://www.boost.org/LICENSE_1_0.txt)
0006 // Home at http://www.boost.org/libs/functional/overloaded_function
0007
0008 #ifndef BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_HPP_
0009 #define BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_HPP_
0010
0011 /** @file
0012 @brief Change the compile-time configuration of this library.
0013 */
0014
0015 /**
0016 @brief Specify the maximum number of arguments of the functions being
0017 overloaded.
0018
0019 If this macro is left undefined by the user, it has a default value of 5
0020 (increasing this number might increase compilation time).
0021 When specified by the user, this macro must be a non-negative integer number.
0022
0023 @See @RefSect{getting_started, Getting Started},
0024 @RefClass{boost::overloaded_function}.
0025 */
0026 #ifndef BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_ARITY_MAX
0027 #   define BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_ARITY_MAX 5
0028 #endif
0029
0030 /**
0031 @brief Specify the maximum number of functions that can be overloaded.
0032
0033 If this macro is left undefined by the user, it has a default value of 5
0034 (increasing this number might increase compilation time).
0035 When defined by the user, this macro must be an integer number greater or
0036 equal than 2 (because at least two distinct functions need to be specified in
0037 order to define an overload).
0038
0039 @See @RefSect{getting_started, Getting Started},
0040 @RefClass{boost::overloaded_function}.
0041 */
0042 #ifndef BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX
0043 #   define BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX 5
0044 #endif
0045 #if BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX < 2
0046 #   error "maximum overload macro cannot be less than 2"
0047 #endif
0048
0049 #endif // #include guard
0050