/** \file
\brief type_traits public header */
-#ifndef HH_type_traits_
-#define HH_type_traits_ 1
+#ifndef HH_SENF_Utils_type_traits_
+#define HH_SENF_Utils_type_traits_ 1
// Custom includes
#include <boost/type_traits/function_traits.hpp>
#include <boost/type_traits/remove_pointer.hpp>
#include <boost/type_traits/is_function.hpp>
+#include <boost/type_traits/remove_cv.hpp>
+#include <boost/type_traits/remove_reference.hpp>
#include <boost/bind.hpp>
+#include "../config.hh"
#include "type_traits.mpp"
///////////////////////////////hh.p////////////////////////////////////////
-namespace senf {
+namespace senf
+{
- template <class Traits, unsigned arity=Traits::arity>
+ /** \defgroup typetraits Type traits
+ */
+
+ ///\addtogroup typetraits
+ ///\{
+
+ /** \brief Strip first parameter from function traits
+
+ This meta-function will remove the first argument from \a Traits. The return value is a new
+ function trait with one less argument.
+
+ If the function described in \a Traits does not take any arguments, it is returned
+ unchanged.
+
+ \code
+ typedef boost::function_traits<void (int, double)> traits
+ BOOST_STATIC_ASSERT(( boost::is_same<
+ senf::function_traits_remove_arg< traits >::type,
+ boost::function_traits<void (double)>
+ >::value ));
+ \endcode
+
+ \tparam Traits \c boost::function_traits instantiation
+ */
+ template < class Traits, unsigned arity = Traits::arity >
struct function_traits_remove_arg {};
- template <class MemberPointer>
- struct remove_member_pointer
+ /** \brief Get argument type from function traits
+
+ function_traits_arg<Traits, index> will return the type of the \a index-th argument from \a
+ Traits. If the function has no argument at that index, \c void is returned
+
+ \code
+ typedef boost::function_traits<void (int, double)> traits;
+ BOOST_STATIC_ASSERT(( boost:is_same<
+ senf::function_traits_arg_type< traits, 0 >::type,
+ int
+ >::value ));
+ BOOST_STATIC_ASSERT(( boost::is_same<
+ senf::function_traits_arg_type< traits, 2 >::type,
+ void
+ >::value ));
+ \endcode
+
+ \tparam Traits \c boost::function_traits instantiation
+ \tparam index 0 based argument index
+ */
+ template < class Traits, int index, bool flag = (index < Traits::arity) >
+ struct function_traits_arg_type {};
+
+#ifndef DOXYGEN
+
+ template < class Traits, int index >
+ struct function_traits_arg_type <Traits, index, false >
+ {
+ typedef void type;
+ };
+
+#endif
+
+ /** \brief Remove member pointer from type
+
+ This meta function will remove any type of member pointer from it's argument. Other types
+ will be returned unchanged.
+
+ \code
+ BOOST_STATIC_ASSERT(( boost::is_same<
+ senf::remove_member_pointer< int (Class::*) >::type,
+ int
+ >::value ));
+ BOOST_STATIC_ASSERT(( boost::is_same<
+ senf::remove_member_pointer< void (Class::*)(int) >::type,
+ void (int)
+ >::value ));
+ \endcode
+
+ \tparam MemberPointer type to remove member pointer from
+ */
+ template < class MemberPointer > struct remove_member_pointer
{
typedef MemberPointer type;
};
- template <class C, class T>
- struct remove_member_pointer<T (C::*)>
+#ifndef DOXYGEN
+
+ template < class C, class T > struct remove_member_pointer <T (C::*) >
{
typedef T type;
};
- template <class MemberPointer>
- struct member_class
+ template < class C, class T > struct remove_member_pointer <T (C::* const) >
+ {
+ typedef T type;
+ };
+
+#endif
+
+ /** \brief Get class of a member pointer
+
+ Returns the class, an arbitrary member pointer belongs to. If the argument is not a member
+ pointer, void is returned.
+
+ \code
+ BOOST_STATIC_ASSERT(( boost::is_same<
+ senf::member_class< int (Class::*) >::type,
+ Class
+ >::value ));
+ BOOST_STATIC_ASSERT(( boost::is_Same<
+ senf::member_class< int * >::type,
+ void
+ >::value ));
+ \endcode
+
+ \tparam MemberPointer Type to get the member pointer class from
+ */
+ template < class MemberPointer > struct member_class
{
typedef void type;
};
+
+#ifndef DOXYGEN
+
+ template < class C, class T > struct member_class <T (C::*) >
+ {
+ typedef C type;
+ };
- template <class C, class T>
- struct member_class<T (C::*)>
+ template < class C, class T > struct member_class <T (C::* const) >
{
typedef C type;
};
- template <class T>
+#endif
+
+ /** \brief Remove any type of pointer from type
+
+ This meta function will remove a plain or member pointer from the given type. If \a T is
+ neither a member pointer nor an ordinary pointer, \a T will be returned unchanged.
+
+ \code
+ BOOST_STATIC_ASSERT(( boost::is_same<
+ senf::remove_any_pointer< int (Class::*) >::type,
+ int
+ >::value ));
+ BOOST_STATIC_ASSERT(( boost::is_same<
+ senf::remove_any_pointer< void (Class::*)(int) >::type,
+ void (int) > );
+ BOOST_STATIC_ASSERT(( boost::is_same<
+ senf::remove_any_pointer < int (*)() >::type,
+ int (
+ >::value ));
+ BOOST_STATIC_ASSERT(( boost::is_same<
+ senf::remove_any_pointer < int >::type,
+ int
+ >::value ));
+ \endcode
+
+ \tparam T type to remove member pointer from
+ */
+ template < class T >
struct remove_any_pointer
- : public remove_member_pointer<typename boost::remove_pointer<T>::type>
+ : public remove_member_pointer < typename boost::remove_pointer < T >::type >
{};
- template <class T>
+ /** \brief Test object if it is a function or member-function (pointer)
+
+ is_any_function will inherit from \c boost::true_type, when \a T is a function type,
+ function pointer type or a member function pointer type. Otherwise, it will inherit from \c
+ boost::false_type.
+
+ \code
+ BOOST_STATIC_ASSERT(( senf::is_any_function< void () >::value ));
+ BOOST_STATIC_ASSERT(( senf::is_any_function< void (*)(int) >::value ));
+ BOOST_STATIC_ASSERT(( senf::is_any_function< void (Class::*)() >::value ));
+ BOOST_STATIC_ASSERT(( ! senf::is_any_function< int * >::value ));
+ \endcode
+
+ \tparam T type to test
+ */
+ template < class T >
struct is_any_function
- : public boost::is_function<typename senf::remove_any_pointer<T>::type>
+ : public boost::is_function < typename senf::remove_any_pointer < T >::type >
+ {};
+
+ /** \brief Remove reference and CV qualification from type
+
+ remove_cvref will remove all the 'ornaments' from a type as typically used to pass
+ arguments: references and any CV spec. It will thus convert a typical argument type into
+ it's basic type.
+
+ \code
+ BOOST_STATIC_ASSERT(( boost::is_same<
+ senf::remove_cvref<int const &>::type,
+ int
+ >::value ));
+ \endcode
+ */
+ template < class T >
+ struct remove_cvref
+ : public boost::remove_cv< typename boost::remove_reference<T>::type >
{};
-# define BOOST_PP_ITERATION_PARAMS_1 (4, (0, 10, \
- SENF_ABSOLUTE_INCLUDE_PATH(Utils/type_traits.mpp), \
+ ///}
+
+#ifndef DOXYGEN
+
+# define BOOST_PP_ITERATION_PARAMS_1 (4, (0, 10, \
+ SENF_ABSOLUTE_INCLUDE_PATH(Utils/type_traits.mpp), \
1))
# include BOOST_PP_ITERATE()
+#endif
+
}
///////////////////////////////hh.e////////////////////////////////////////
//#include "type_traits.ct"
//#include "type_traits.cti"
#endif
-
\f
+
// Local Variables:
// mode: c++
// fill-column: 100
projects / senf.git / blobdiff