2
0
mirror of https://github.com/boostorg/hof.git synced 2026-01-22 05:12:39 +00:00
Files
hof/include/fit/function.hpp
2017-08-13 18:04:21 -05:00

81 lines
2.3 KiB
C++

/*=============================================================================
Copyright (c) 2014 Paul Fultz II
function.h
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
==============================================================================*/
#ifndef FIT_GUARD_FUNCTION_FUNCTION_H
#define FIT_GUARD_FUNCTION_FUNCTION_H
/// FIT_STATIC_FUNCTION
/// ===================
///
/// Description
/// -----------
///
/// The `FIT_STATIC_FUNCTION` macro allows initializing a function object from
/// a `constexpr` expression. It also ensures that the function object will
/// have a unique address across translation units. This helps to avoid ODR
/// violations. As such, the object that is deduced is default constructed.
///
/// By default, all functions defined with `FIT_STATIC_FUNCTION` use the
/// [`fit::reveal`](/include/fit/reveal) adaptor to improve error messages.
///
/// Example
/// -------
///
/// #include <fit.hpp>
/// #include <cassert>
///
/// struct sum_f
/// {
/// template<class T, class U>
/// T operator()(T x, U y) const
/// {
/// return x+y;
/// }
/// };
///
/// FIT_STATIC_FUNCTION(sum) = sum_f();
/// FIT_STATIC_FUNCTION(partial_sum) = fit::partial(sum_f());
///
/// int main() {
/// assert(sum(1, 2) == partial_sum(1)(2));
/// }
///
#include <fit/reveal.hpp>
#if !FIT_HAS_INLINE_VARIABLES
#include <fit/detail/static_const_var.hpp>
#include <fit/detail/constexpr_deduce.hpp>
#endif
namespace fit {
namespace detail {
struct reveal_static_const_factory
{
constexpr reveal_static_const_factory()
{}
template<class F>
constexpr reveal_adaptor<F> operator=(const F& f) const
{
#if FIT_HAS_INLINE_VARIABLES
#else
static_assert(FIT_IS_DEFAULT_CONSTRUCTIBLE(F), "Static functions must be default constructible");
#endif
return reveal_adaptor<F>(f);
}
};
}} // namespace fit
#if FIT_HAS_INLINE_VARIABLES
#define FIT_STATIC_FUNCTION(name) inline const constexpr auto name = fit::detail::reveal_static_const_factory()
#else
#define FIT_STATIC_FUNCTION(name) FIT_STATIC_CONST_VAR(name) = FIT_DETAIL_MSVC_CONSTEXPR_DEDUCE fit::detail::reveal_static_const_factory()
#endif
#endif