bslmf_functionpointertraits.h

Go to the documentation of this file.

/// @file bslmf_functionpointertraits.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bslmf_functionpointertraits.h                                      -*-C++-*-
#ifndef INCLUDED_BSLMF_FUNCTIONPOINTERTRAITS
#define INCLUDED_BSLMF_FUNCTIONPOINTERTRAITS
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bslmf_functionpointertraits bslmf_functionpointertraits
/// @brief  Provide a meta-function for determining function pointer traits.
/// @addtogroup bsl
/// @{
/// @addtogroup bslmf
/// @{
/// @addtogroup bslmf_functionpointertraits
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bslmf_functionpointertraits-purpose"> Purpose</a>
/// * <a href="#bslmf_functionpointertraits-classes"> Classes </a>
/// * <a href="#bslmf_functionpointertraits-description"> Description </a>
///   * <a href="#bslmf_functionpointertraits-usage"> Usage </a>
///
/// # Purpose {#bslmf_functionpointertraits-purpose}
/// Provide a meta-function for determining function pointer traits.
///
/// # Classes {#bslmf_functionpointertraits-classes}
///
/// -  bslmf::FunctionPointerTraits: meta-function for detecting function pointer
/// -                                traits
/// -  bslmf::IsFunctionPointer: meta-function to determine if a type is a
/// -                            function pointer
///
/// @see  bslmf_memberfunctionpointertraits
///
/// # Description {#bslmf_functionpointertraits-description}
/// This component provides meta-functions for determining whether
/// a type is a pointer to either a free function or a class method (but not to
/// a member function, see the component @ref bslmf_memberfunctionpointertraits 
/// component for that), and some information about this function type.  The
/// meta-function `bslmf::IsFunctionPointer` provides an enumerated `value`
/// which can be either 1 or 0 depending on whether or not the template argument
/// `t_PROTOTYPE` is a pointer to a free function or class method.  In the
/// affirmative, the class `bslmf::FunctionPointerTraits` also provides
/// information regarding the function type, such as its argument list type and
/// its return type.
///
/// Note that there is no reference-to-function traits class, since whether
/// `FUNC` is a reference to function type can be very easily obtained using the
/// meta-function call `bslmf::IsFunctionPointer<FUNC *>`.
///
/// ## Usage {#bslmf_functionpointertraits-usage}
///
///
/// Define the following function types:
/// @code
/// typedef int  (*IntFunctionIntIntPtr)(int, int);
/// typedef void (*VoidFunc0)();
/// @endcode
/// The following program should compile and run without errors:
/// @code
/// int main()
/// {
///     assert(0 == bslmf::IsFunctionPointer<int>::value);
///     assert(0 == bslmf::IsFunctionPointer<void>::value);
///
///     assert(1 == bslmf::IsFunctionPointer<IntFunctionIntIntPtr>::value);
///     typedef bslmf::FunctionPointerTraits<IntFunctionIntIntPtr>::ResultType
///         ResultType1;
///     assert(1 == (bsl::is_same<ResultType1, int>::value));
///
///     assert(1 == bslmf::IsFunctionPointer<VoidFunc0>::value);
///     typedef bslmf::FunctionPointerTraits<VoidFunc0>::ResultType
///         ResultType0;
///     typedef bslmf::FunctionPointerTraits<VoidFunc0>::ArgumentList
///         ArgList0;
///     assert(1 == (bsl::is_same<ResultType0, void>::value));
///     assert(1 == (bsl::is_same<ArgList0, bslmf::TypeList0>::value));
/// }
/// @endcode
/// @}
/** @} */
/** @} */
 
/** @addtogroup bsl
 * @{
 */
/** @addtogroup bslmf
 * @{
 */
/** @addtogroup bslmf_functionpointertraits
 * @{
 */
 
#include <bslscm_version.h>
 
#include <bslmf_integralconstant.h>
#include <bslmf_typelist.h>
 
#include <bsls_compilerfeatures.h>
#include <bsls_platform.h>
 
#if BSLS_COMPILERFEATURES_SIMULATE_CPP11_FEATURES
// clang-format off
// Include version that can be compiled with C++03
// Generated on Mon Jan 13 08:31:25 2025
// Command line: sim_cpp11_features.pl bslmf_functionpointertraits.h
 
# define COMPILING_BSLMF_FUNCTIONPOINTERTRAITS_H
# include <bslmf_functionpointertraits_cpp03.h>
# undef COMPILING_BSLMF_FUNCTIONPOINTERTRAITS_H
 
// clang-format on
#else
 
 
namespace bslmf {
 
/// C++ function pointer linkage tag.
///
/// See @ref bslmf_functionpointertraits 
struct FunctionPointerCPlusPlusLinkage {
};
 
/// C function pointer linkage tag.
///
/// See @ref bslmf_functionpointertraits 
struct FunctionPointerCLinkage {
};
 
                        // ===========================
                        // class FunctionPointerTraits
                        // ===========================
 
/// This class gives information about the specified `t_PROTOTYPE`.  The
/// general definition gives no information, but specializations for
/// function pointers types define nested types `ResultType`,
/// `ArgumentList`, and `Linkage`.
///
/// See @ref bslmf_functionpointertraits 
template <class t_PROTOTYPE>
struct FunctionPointerTraits {
 
    enum { IS_FUNCTION_POINTER = 0 };
};
 
                          // =======================
                          // class IsFunctionPointer
                          // =======================
 
/// This template determines if the specified `t_PROTOTYPE` is a free (i.e.,
/// non-member) function pointer.  `value` is defined as 1 if the specified
/// `t_PROTOTYPE` is a function pointer type, and a zero value otherwise.
template <class t_PROTOTYPE>
struct IsFunctionPointer
: bsl::integral_constant<
      bool,
      FunctionPointerTraits<t_PROTOTYPE>::IS_FUNCTION_POINTER> {
};
 
// ---- Anything below this line is implementation specific.  Do not use. ----
 
#if defined(BSLS_COMPILERFEATURES_SUPPORT_NOEXCEPT_TYPES) &&                  \
    !defined(BSLS_COMPILERFEATURES_SUPPORT_VARIADIC_TEMPLATES)
    // All of our compilers which identify 'noexcept' as part of the type
    // system (a C++17 piece of functionality) similarly also support variadic
    // templates, so we refrain from having the dead code to support this case.
#   error Feature not supported for compilers without variadic templates
#endif
 
                // ---------------------------
                // class FunctionPointerTraits
                // ---------------------------
 
#if !BSLS_COMPILERFEATURES_SIMULATE_CPP11_FEATURES // $var-args=14
 
// This pragma is not supported by older versions of Apple Clang
// {DRQS 169716845<GO>}
#if defined(BSLS_PLATFORM_CMP_CLANG) && (!defined(BSLS_PLATFORM_OS_DARWIN)    \
        || BSLS_PLATFORM_CMP_VERSION > 130000)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-volatile"
#endif
 
/// Specialization for function pointers that return `t_BSLMF_RETURN` and
/// accept a fixed number of arguments
template <class t_BSLMF_RETURN, class... t_ARGS>
struct FunctionPointerTraits<t_BSLMF_RETURN (*)(t_ARGS...)> {
 
    enum {
        IS_FUNCTION_POINTER = 1,
        IS_NOEXCEPT = 0
    };
    enum { e_IS_VARARG = 0 };
    typedef t_BSLMF_RETURN                     ResultType;
    typedef typename TypeList<t_ARGS...>::Type ArgumentList;
    typedef t_BSLMF_RETURN                   FuncType(t_ARGS...);
    typedef FunctionPointerCPlusPlusLinkage  Linkage;
};
 
/// Specialization for function pointers that return `t_BSLMF_RETURN` and
/// accept variable (C-style varargs) number of arguments
template <class t_BSLMF_RETURN, class... t_ARGS>
struct FunctionPointerTraits<t_BSLMF_RETURN (*)(t_ARGS...,...)> {
 
    enum {
        IS_FUNCTION_POINTER = 1,
        IS_NOEXCEPT = 0
    };
    enum { e_IS_VARARG = 1 };
    typedef t_BSLMF_RETURN                     ResultType;
    typedef typename TypeList<t_ARGS...>::Type ArgumentList;
    typedef t_BSLMF_RETURN                   FuncType(t_ARGS...,...);
    typedef FunctionPointerCPlusPlusLinkage  Linkage;
};
 
#if defined(BSLS_PLATFORM_CMP_CLANG)
#pragma clang diagnostic pop
#endif
 
#endif
 
#if defined(BSLS_PLATFORM_CMP_MSVC)
// Microsoft Visual C++ has a problem matching 'T * const' pointers to the
// appropriate partial specialization, whereas it will match a 'T const'
// specialization.  We could use the Microsoft fix on all platforms, but why
// instantiate more traits than necessary when testing pointer traits of
// cv-qualified types that are not function pointers?
 
template <class t_PROTOTYPE>
struct FunctionPointerTraits<t_PROTOTYPE const>
: FunctionPointerTraits<t_PROTOTYPE> {
    // This class gives information about the specified 't_PROTOTYPE'.  The
    // general definition gives no information, but specializations for
    // function pointers types define nested types 'ResultType',
    // 'ArgumentList', and 'Linkage'.
};
 
template <class t_PROTOTYPE>
struct FunctionPointerTraits<t_PROTOTYPE volatile>
: FunctionPointerTraits<t_PROTOTYPE> {
    // This class gives information about the specified 't_PROTOTYPE'.  The
    // general definition gives no information, but specializations for
    // function pointers types define nested types 'ResultType',
    // 'ArgumentList', and 'Linkage'.
};
 
template <class t_PROTOTYPE>
struct FunctionPointerTraits<t_PROTOTYPE const volatile>
: FunctionPointerTraits<t_PROTOTYPE> {
    // This class gives information about the specified 't_PROTOTYPE'.  The
    // general definition gives no information, but specializations for
    // function pointers types define nested types 'ResultType',
    // 'ArgumentList', and 'Linkage'.
};
#else
/// This class gives information about the specified `t_PROTOTYPE`.  The
/// general definition gives no information, but specializations for
/// function pointers types define nested types `ResultType`,
/// `ArgumentList`, and `Linkage`.
template <class t_PROTOTYPE>
struct FunctionPointerTraits<t_PROTOTYPE *const>
: FunctionPointerTraits<t_PROTOTYPE *> {
};
 
/// This class gives information about the specified `t_PROTOTYPE`.  The
/// general definition gives no information, but specializations for
/// function pointers types define nested types `ResultType`,
/// `ArgumentList`, and `Linkage`.
template <class t_PROTOTYPE>
struct FunctionPointerTraits<t_PROTOTYPE *volatile>
: FunctionPointerTraits<t_PROTOTYPE *> {
};
 
/// This class gives information about the specified `t_PROTOTYPE`.  The
/// general definition gives no information, but specializations for
/// function pointers types define nested types `ResultType`,
/// `ArgumentList`, and `Linkage`.
template <class t_PROTOTYPE>
struct FunctionPointerTraits<t_PROTOTYPE *const volatile>
: FunctionPointerTraits<t_PROTOTYPE *> {
};
// }}} END GENERATED CODE
#endif
 
#ifdef BSLS_COMPILERFEATURES_SUPPORT_NOEXCEPT_TYPES
 
#if defined(BSLS_PLATFORM_CMP_CLANG)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-volatile"
#endif
 
/// Specialization for `noexcept` function pointers that return
/// `t_BSLMF_RETURN` and accept a fixed number of arguments
template <class t_BSLMF_RETURN, class... t_ARGS>
struct FunctionPointerTraits<t_BSLMF_RETURN (*)(t_ARGS...) noexcept> {
 
    enum {
        IS_FUNCTION_POINTER = 1,
        IS_NOEXCEPT = 1
    };
    enum { e_IS_VARARG = 0 };
    typedef t_BSLMF_RETURN                     ResultType;
    typedef typename TypeList<t_ARGS...>::Type ArgumentList;
    typedef t_BSLMF_RETURN                   FuncType(t_ARGS...) noexcept;
    typedef FunctionPointerCPlusPlusLinkage  Linkage;
};
 
/// Specialization for `noexcept` function pointers that return
/// `t_BSLMF_RETURN` and accept variable (C-style varargs) number of
/// arguments
template <class t_BSLMF_RETURN, class... t_ARGS>
struct FunctionPointerTraits<t_BSLMF_RETURN (*)(t_ARGS...,...) noexcept> {
 
    enum {
        IS_FUNCTION_POINTER = 1,
        IS_NOEXCEPT = 1
    };
    enum { e_IS_VARARG = 1 };
    typedef t_BSLMF_RETURN                     ResultType;
    typedef typename TypeList<t_ARGS...>::Type ArgumentList;
    typedef t_BSLMF_RETURN                   FuncType(t_ARGS...,...) noexcept;
    typedef FunctionPointerCPlusPlusLinkage  Linkage;
};
 
#if defined(BSLS_PLATFORM_CMP_CLANG)
#pragma clang diagnostic pop
#endif
 
#endif // BSLS_COMPILERFEATURES_SUPPORT_NOEXCEPT_TYPES
 
}  // close package namespace
 
#ifndef BDE_OPENSOURCE_PUBLICATION  // BACKWARD_COMPATIBILITY
// ============================================================================
//                           BACKWARD COMPATIBILITY
// ============================================================================
 
/// This alias is defined for backward compatibility.
typedef bslmf::FunctionPointerCPlusPlusLinkage
                                         bslmf_FunctionPointerCPlusPlusLinkage;
 
/// This alias is defined for backward compatibility.
typedef bslmf::FunctionPointerCLinkage bslmf_FunctionPointerCLinkage;
 
#ifdef bslmf_FunctionPointerTraits
#undef bslmf_FunctionPointerTraits
#endif
/// This alias is defined for backward compatibility.
#define bslmf_FunctionPointerTraits bslmf::FunctionPointerTraits
 
#ifdef bslmf_IsFunctionPointer
#undef bslmf_IsFunctionPointer
#endif
/// This alias is defined for backward compatibility.
#define bslmf_IsFunctionPointer bslmf::IsFunctionPointer
#endif  // BDE_OPENSOURCE_PUBLICATION -- BACKWARD_COMPATIBILITY
 
 
 
#endif // End C++11 code
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2013 Bloomberg Finance L.P.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------- END-OF-FILE ----------------------------------
 
/** @} */
/** @} */
/** @} */