bslmf_isfunction.h

Go to the documentation of this file.

/// @file bslmf_isfunction.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bslmf_isfunction.h                                                 -*-C++-*-
#ifndef INCLUDED_BSLMF_ISFUNCTION
#define INCLUDED_BSLMF_ISFUNCTION
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bslmf_isfunction bslmf_isfunction
/// @brief  Provide a compile-time check for determining function types.
/// @addtogroup bsl
/// @{
/// @addtogroup bslmf
/// @{
/// @addtogroup bslmf_isfunction
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bslmf_isfunction-purpose"> Purpose</a>
/// * <a href="#bslmf_isfunction-classes"> Classes </a>
/// * <a href="#bslmf_isfunction-description"> Description </a>
///   * <a href="#bslmf_isfunction-usage"> Usage </a>
///     * <a href="#bslmf_isfunction-example-1-verify-function-types"> Example 1: Verify Function Types </a>
///
/// # Purpose {#bslmf_isfunction-purpose}
/// Provide a compile-time check for determining function types.
///
/// # Classes {#bslmf_isfunction-classes}
///
/// -  bsl::is_function: standard meta-function for determining function types
/// -  bsl::is_function_v: the result value of `bsl::is_function`
///
/// @see  bslmf_integralconstant
///
/// # Description {#bslmf_isfunction-description}
/// This component defines a meta-function, `bsl::is_function` and
/// a template variable `bsl::is_function_v`, that represents the result value
/// of the `bsl::is_function` meta-function, that may be used to query whether a
/// template parameter type is a function type.
///
/// `bsl::is_function` meets the requirements of the `is_function` template
/// defined in the C++11 standard [meta.unary.cat].
///
/// Note that the template variable `is_function_v` is defined in the C++17
/// standard as an inline variable.  If the current compiler supports the inline
/// variable C++17 compiler feature, `bsl::is_function_v` is defined as an
/// `inline constexpr bool` variable.  Otherwise, if the compiler supports the
/// variable templates C++14 compiler feature, `bsl::is_function_v` is defined
/// as a non-`const` `constexpr bool` variable.  See
/// `BSLS_COMPILERFEATURES_SUPPORT_INLINE_VARIABLES` and
/// `BSLS_COMPILERFEATURES_SUPPORT_VARIABLE_TEMPLATES` macros in
/// bsls_compilerfeatures component for details.
///
/// ## Usage {#bslmf_isfunction-usage}
///
///
/// In this section we show intended use of this component.
///
/// ### Example 1: Verify Function Types {#bslmf_isfunction-example-1-verify-function-types}
///
///
/// Suppose that we want to assert whether a set of types are function types.
///
/// Now, we instantiate the `bsl::is_function` template for both a non-function
/// type and a function type, and assert the `value` static data member of each
/// instantiation:
/// @code
/// assert(false == bsl::is_function<int>::value);
/// assert(true  == bsl::is_function<int (int)>::value);
/// @endcode
/// Note that if the current compiler supports the variable templates C++14
/// feature, then we can re-write the snippet of code above using the
/// `bsl::is_function_v` variable as follows:
/// @code
/// #ifdef BSLS_COMPILERFEATURES_SUPPORT_VARIABLE_TEMPLATES
///   assert(false == bsl::is_function_v<int>);
///   assert(true  == bsl::is_function_v<int (int)>);
/// #endif
/// @endcode
/// @}
/** @} */
/** @} */
 
/** @addtogroup bsl
 * @{
 */
/** @addtogroup bslmf
 * @{
 */
/** @addtogroup bslmf_isfunction
 * @{
 */
 
#include <bslscm_version.h>
 
#include <bslmf_integralconstant.h>
#include <bslmf_isconst.h>
 
#include <bsls_compilerfeatures.h>
#include <bsls_keyword.h>
#include <bsls_platform.h>
 
#ifndef BDE_DONT_ALLOW_TRANSITIVE_INCLUDES
#include <bslmf_addpointer.h>
#include <bslmf_functionpointertraits.h>
#endif // BDE_DONT_ALLOW_TRANSITIVE_INCLUDES
 
#if defined(BSLS_PLATFORM_CMP_IBM)
// The IBM xlC compiler produces a "hard" error (not eligible for SFINAE) when
// trying to apply cv-qualifiers to a template parameter (or typedef) that is a
// function type.  Hence, a more oblique approach is needed to detect all
// function types on this platform.  This implementation relies on the fact
// that you cannot form an array of function types.
 
 
namespace bslmf {
 
struct IsFunction_Imp {
    struct FalseType {
        // This 'struct' provides a type larger than 'char' to be used in
        // unevaluated contexts, allowing 'sizeof(selected overload)' to
        // distinguish which overload was called when all other overloads
        // return a 'char'.
 
        char d_dummy[17];  // Member to guarantee 'sizeof(FalseType) > 1'
    };
 
    template <class t_TYPE>
    static FalseType test(int t_TYPE::*, void *);
        // This function will match any class type, including abstract types.
 
    template <class t_TYPE>
    static FalseType test(t_TYPE (*)[2], ...);
        // This function will match all types other than those that cannot be
        // used to form an array.  This includes function types, reference
        // types, void types, and abstract types.  Further overloads and
        // specializations will filter the reference, array, and abstract
        // types.
 
    template <class t_TYPE>
    static char test(...);
        // This function, when called with '0' in a non-evaluated context, will
        // match anything that the previous overloads fail to match, which will
        // include all function types, reference types, void types, and arrays
        // of unknown bound.
};
 
} // close package namespace
 
 
namespace bsl {
 
template <class t_TYPE>
struct is_function
: integral_constant<
      bool,
      sizeof(BloombergLP::bslmf::IsFunction_Imp::test<t_TYPE>(0, 0)) == 1> {
    // This 'struct' template implements the 'is_function' meta-function
    // defined in the C++11 standard [meta.unary.cat] to determine if the
    // (template parameter) 't_TYPE' is a function type.  This 'struct' derives
    // from 'bsl::true_type' if the 't_TYPE' is a function type, and from
    // 'bsl::false_type' otherwise.
};
 
template <class t_TYPE>
struct is_function<t_TYPE[]> : false_type {
    // Array types are, self-evidently, never function types.  Arrays of
    // unknown bound will be misdiagnosed by the 'IsFunction_Imp' detector, so
    // this template is partially specialized to resolve such cases.
};
 
template <class t_TYPE>
struct is_function<t_TYPE&> : false_type {
    // Reference types are, self-evidently, never function types.  This
    // template is partially specialized to resolve such cases, as the
    // detection idiom embodied in 'IsFunction_Imp' would yield the wrong
    // result otherwise.
};
 
template <>
struct is_function<void> : false_type {
    // 'void' types are not functions.  It is easier to provide 4 cv-qualified
    // explicit specializations than introduce a further dependency and chain
    // template instantiations through 'remove_cv'.
};
 
template <>
struct is_function<const void> : false_type {
    // 'void' types are not functions.  It is easier to provide 4 cv-qualified
    // explicit specializations than introduce a further dependency and chain
    // template instantiations through 'remove_cv'.
};
 
template <>
struct is_function<volatile void> : false_type {
    // 'void' types are not functions.  It is easier to provide 4 cv-qualified
    // explicit specializations than introduce a further dependency and chain
    // template instantiations through 'remove_cv'.
};
 
template <>
struct is_function<const volatile void> : false_type {
    // 'void' types are not functions.  It is easier to provide 4 cv-qualified
    // explicit specializations than introduce a further dependency and chain
    // template instantiations through 'remove_cv'.
};
 
} // close namespace bsl
 
#else  // This is the simplest implementation, for conforming compilers.
namespace bsl {
 
#ifdef BSLS_PLATFORM_CMP_MSVC
# pragma warning(push)
# pragma warning(disable: 4180)  // cv-qualifier has no effect on function type
#endif
 
/// This `struct` template implements the `is_function` meta-function
/// defined in the C++11 standard [meta.unary.cat] to determine if the
/// (template parameter) `t_TYPE` is a function type.  This `struct` derives
/// from `bsl::true_type` if the `t_TYPE` is a function type, and from
/// `bsl::false_type` otherwise.  This implementation relies on the fact
/// that neither function types nor reference types can be cv-qualified so
/// that `is_const<const t_TYPE>` will actually yield `false`.
template <class t_TYPE>
struct is_function
: bsl::integral_constant<bool, !is_const<const t_TYPE>::value> {
};
 
#ifdef BSLS_PLATFORM_CMP_MSVC
# pragma warning(pop)
#endif
 
/// Reference types are, self-evidently, never function types.  The idiom
/// for detecting function types in this component is that a function is a
/// type that is the same as the const-qualified version of that same type.
/// As references also have this property, we must filter out references
/// with this partial specialization.
template <class t_TYPE>
struct is_function<t_TYPE&> : false_type {
};
 
#if defined(BSLS_COMPILERFEATURES_SUPPORT_RVALUE_REFERENCES)
/// Reference types are, self-evidently, never function types.  The idiom
/// for detecting function types in this component is that a function is a
/// type that is the same as the const-qualified version of that same type.
/// As references also have this property, we must filter out references
/// with this partial specialization.
template <class t_TYPE>
struct is_function<t_TYPE&&> : false_type {
};
# endif
 
#ifdef BSLS_COMPILERFEATURES_SUPPORT_VARIABLE_TEMPLATES
/// This template variable represents the result value of the
/// `bsl::is_function` meta-function.
template <class t_TYPE>
BSLS_KEYWORD_INLINE_VARIABLE constexpr bool is_function_v =
                                                    is_function<t_TYPE>::value;
#endif
 
}  // close namespace bsl
#endif
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2017 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 ----------------------------------
 
/** @} */
/** @} */
/** @} */