Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: //
Chris@16: // (C) Copyright Pablo Halpern 2009. Distributed under the Boost
Chris@16: // Software License, Version 1.0. (See accompanying file
Chris@16: // LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
Chris@16: //
Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: //
Chris@16: // (C) Copyright Ion Gaztanaga 2011-2013. Distributed under the Boost
Chris@16: // Software License, Version 1.0. (See accompanying file
Chris@16: // LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
Chris@16: //
Chris@16: // See http://www.boost.org/libs/intrusive for documentation.
Chris@16: //
Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: 
Chris@16: #ifndef BOOST_INTRUSIVE_POINTER_TRAITS_HPP
Chris@16: #define BOOST_INTRUSIVE_POINTER_TRAITS_HPP
Chris@16: 
Chris@16: #if (defined _MSC_VER) && (_MSC_VER >= 1200)
Chris@16: #  pragma once
Chris@16: #endif
Chris@16: 
Chris@16: #include <boost/intrusive/detail/config_begin.hpp>
Chris@16: #include <boost/intrusive/detail/workaround.hpp>
Chris@16: #include <boost/intrusive/detail/memory_util.hpp>
Chris@16: #include <boost/type_traits/integral_constant.hpp>
Chris@16: #include <cstddef>
Chris@16: 
Chris@16: namespace boost {
Chris@16: namespace intrusive {
Chris@16: 
Chris@16: //! pointer_traits is the implementation of C++11 std::pointer_traits class with some
Chris@16: //! extensions like castings.
Chris@16: //!
Chris@16: //! pointer_traits supplies a uniform interface to certain attributes of pointer-like types.
Chris@16: template <typename Ptr>
Chris@16: struct pointer_traits
Chris@16: {
Chris@16:    #ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED
Chris@16:       //!The pointer type
Chris@16:       //!queried by this pointer_traits instantiation
Chris@16:       typedef Ptr             pointer;
Chris@16: 
Chris@16:       //!Ptr::element_type if such a type exists; otherwise, T if Ptr is a class
Chris@16:       //!template instantiation of the form SomePointer<T, Args>, where Args is zero or
Chris@16:       //!more type arguments ; otherwise , the specialization is ill-formed.
Chris@16:       typedef unspecified_type element_type;
Chris@16: 
Chris@16:       //!Ptr::difference_type if such a type exists; otherwise,
Chris@16:       //!std::ptrdiff_t.
Chris@16:       typedef unspecified_type difference_type;
Chris@16: 
Chris@16:       //!Ptr::rebind<U> if such a type exists; otherwise, SomePointer<U, Args> if Ptr is
Chris@16:       //!a class template instantiation of the form SomePointer<T, Args>, where Args is zero or
Chris@16:       //!more type arguments ; otherwise, the instantiation of rebind is ill-formed.
Chris@16:       //!
Chris@16:       //!For portable code for C++03 and C++11, <pre>typename rebind_pointer<U>::type</pre>
Chris@16:       //!shall be used instead of rebind<U> to obtain a pointer to U.
Chris@16:       template <class U> using rebind = unspecified;
Chris@16: 
Chris@16:       //!Ptr::rebind<U> if such a type exists; otherwise, SomePointer<U, Args> if Ptr is
Chris@16:       //!a class template instantiation of the form SomePointer<T, Args>, where Args is zero or
Chris@16:       //!more type arguments ; otherwise, the instantiation of rebind is ill-formed.
Chris@16:       //!
Chris@16:       typedef element_type &reference;
Chris@16:    #else
Chris@16:       typedef Ptr                                                             pointer;
Chris@16:       //
Chris@16:       typedef BOOST_INTRUSIVE_OBTAIN_TYPE_WITH_EVAL_DEFAULT
Chris@16:          ( boost::intrusive::detail::, Ptr, element_type
Chris@16:          , boost::intrusive::detail::first_param<Ptr>)                        element_type;
Chris@16:       //
Chris@16:       typedef BOOST_INTRUSIVE_OBTAIN_TYPE_WITH_DEFAULT
Chris@16:          (boost::intrusive::detail::, Ptr, difference_type, std::ptrdiff_t)   difference_type;
Chris@16:       //
Chris@16:       typedef typename boost::intrusive::detail::unvoid_ref<element_type>::type  reference;
Chris@16:       //
Chris@16:       template <class U> struct rebind_pointer
Chris@16:       {
Chris@16:          typedef typename boost::intrusive::detail::type_rebinder<Ptr, U>::type  type;
Chris@16:       };
Chris@16: 
Chris@16:       #if !defined(BOOST_NO_CXX11_TEMPLATE_ALIASES)
Chris@16:          template <class U> using rebind = typename boost::intrusive::detail::type_rebinder<Ptr, U>::type;
Chris@16:       #endif
Chris@16:    #endif   //#if !defined(BOOST_NO_CXX11_TEMPLATE_ALIASES)
Chris@16: 
Chris@16:    //! <b>Remark</b>: If element_type is (possibly cv-qualified) void, r type is unspecified; otherwise,
Chris@16:    //!   it is element_type &.
Chris@16:    //!
Chris@16:    //! <b>Returns</b>: A dereferenceable pointer to r obtained by calling Ptr::pointer_to(r).
Chris@16:    //!   Non-standard extension: If such function does not exist, returns pointer(addressof(r));
Chris@16:    static pointer pointer_to(reference r)
Chris@16:    {
Chris@16:       //Non-standard extension, it does not require Ptr::pointer_to. If not present
Chris@16:       //tries to converts &r to pointer.
Chris@16:       const bool value = boost::intrusive::detail::
Chris@16:          has_member_function_callable_with_pointer_to
Chris@16:             <Ptr, typename boost::intrusive::detail::unvoid<element_type &>::type>::value;
Chris@16:       ::boost::integral_constant<bool, value> flag;
Chris@16:       return pointer_traits::priv_pointer_to(flag, r);
Chris@16:    }
Chris@16: 
Chris@16:    //! <b>Remark</b>: Non-standard extension.
Chris@16:    //!
Chris@16:    //! <b>Returns</b>: A dereferenceable pointer to r obtained by calling Ptr::static_cast_from(r).
Chris@16:    //!   If such function does not exist, returns pointer_to(static_cast<element_type&>(*uptr))
Chris@16:    template<class UPtr>
Chris@16:    static pointer static_cast_from(const UPtr &uptr)
Chris@16:    {
Chris@16:       const bool value = boost::intrusive::detail::
Chris@16:          has_member_function_callable_with_static_cast_from
Chris@16:             <Ptr, const UPtr>::value;
Chris@16:       ::boost::integral_constant<bool, value> flag;
Chris@16:       return pointer_traits::priv_static_cast_from(flag, uptr);
Chris@16:    }
Chris@16: 
Chris@16:    //! <b>Remark</b>: Non-standard extension.
Chris@16:    //!
Chris@16:    //! <b>Returns</b>: A dereferenceable pointer to r obtained by calling Ptr::const_cast_from(r).
Chris@16:    //!   If such function does not exist, returns pointer_to(const_cast<element_type&>(*uptr))
Chris@16:    template<class UPtr>
Chris@16:    static pointer const_cast_from(const UPtr &uptr)
Chris@16:    {
Chris@16:       const bool value = boost::intrusive::detail::
Chris@16:          has_member_function_callable_with_const_cast_from
Chris@16:             <Ptr, const UPtr>::value;
Chris@16:       ::boost::integral_constant<bool, value> flag;
Chris@16:       return pointer_traits::priv_const_cast_from(flag, uptr);
Chris@16:    }
Chris@16: 
Chris@16:    //! <b>Remark</b>: Non-standard extension.
Chris@16:    //!
Chris@16:    //! <b>Returns</b>: A dereferenceable pointer to r obtained by calling Ptr::dynamic_cast_from(r).
Chris@16:    //!   If such function does not exist, returns pointer_to(*dynamic_cast<element_type*>(&*uptr))
Chris@16:    template<class UPtr>
Chris@16:    static pointer dynamic_cast_from(const UPtr &uptr)
Chris@16:    {
Chris@16:       const bool value = boost::intrusive::detail::
Chris@16:          has_member_function_callable_with_dynamic_cast_from
Chris@16:             <Ptr, const UPtr>::value;
Chris@16:       ::boost::integral_constant<bool, value> flag;
Chris@16:       return pointer_traits::priv_dynamic_cast_from(flag, uptr);
Chris@16:    }
Chris@16: 
Chris@16:    ///@cond
Chris@16:    private:
Chris@16:    //priv_to_raw_pointer
Chris@16:    template <class T>
Chris@16:    static T* to_raw_pointer(T* p)
Chris@16:    {  return p; }
Chris@16: 
Chris@16:    template <class Pointer>
Chris@16:    static typename pointer_traits<Pointer>::element_type*
Chris@16:       to_raw_pointer(const Pointer &p)
Chris@16:    {  return pointer_traits::to_raw_pointer(p.operator->());  }
Chris@16: 
Chris@16:    //priv_pointer_to
Chris@16:    static pointer priv_pointer_to(boost::true_type, typename boost::intrusive::detail::unvoid<element_type>::type& r)
Chris@16:       { return Ptr::pointer_to(r); }
Chris@16: 
Chris@16:    static pointer priv_pointer_to(boost::false_type, typename boost::intrusive::detail::unvoid<element_type>::type& r)
Chris@16:       { return pointer(boost::intrusive::detail::addressof(r)); }
Chris@16: 
Chris@16:    //priv_static_cast_from
Chris@16:    template<class UPtr>
Chris@16:    static pointer priv_static_cast_from(boost::true_type, const UPtr &uptr)
Chris@16:    { return Ptr::static_cast_from(uptr); }
Chris@16: 
Chris@16:    template<class UPtr>
Chris@16:    static pointer priv_static_cast_from(boost::false_type, const UPtr &uptr)
Chris@16:    {  return pointer_to(*static_cast<element_type*>(to_raw_pointer(uptr)));  }
Chris@16: 
Chris@16:    //priv_const_cast_from
Chris@16:    template<class UPtr>
Chris@16:    static pointer priv_const_cast_from(boost::true_type, const UPtr &uptr)
Chris@16:    { return Ptr::const_cast_from(uptr); }
Chris@16: 
Chris@16:    template<class UPtr>
Chris@16:    static pointer priv_const_cast_from(boost::false_type, const UPtr &uptr)
Chris@16:    {  return pointer_to(const_cast<element_type&>(*uptr));  }
Chris@16: 
Chris@16:    //priv_dynamic_cast_from
Chris@16:    template<class UPtr>
Chris@16:    static pointer priv_dynamic_cast_from(boost::true_type, const UPtr &uptr)
Chris@16:    { return Ptr::dynamic_cast_from(uptr); }
Chris@16: 
Chris@16:    template<class UPtr>
Chris@16:    static pointer priv_dynamic_cast_from(boost::false_type, const UPtr &uptr)
Chris@16:    {  return pointer_to(*dynamic_cast<element_type*>(&*uptr));  }
Chris@16:    ///@endcond
Chris@16: };
Chris@16: 
Chris@16: ///@cond
Chris@16: 
Chris@16: // Remove cv qualification from Ptr parameter to pointer_traits:
Chris@16: template <typename Ptr>
Chris@16: struct pointer_traits<const Ptr> : pointer_traits<Ptr> {};
Chris@16: template <typename Ptr>
Chris@16: struct pointer_traits<volatile Ptr> : pointer_traits<Ptr> { };
Chris@16: template <typename Ptr>
Chris@16: struct pointer_traits<const volatile Ptr> : pointer_traits<Ptr> { };
Chris@16: // Remove reference from Ptr parameter to pointer_traits:
Chris@16: template <typename Ptr>
Chris@16: struct pointer_traits<Ptr&> : pointer_traits<Ptr> { };
Chris@16: 
Chris@16: ///@endcond
Chris@16: 
Chris@16: //! Specialization of pointer_traits for raw pointers
Chris@16: //!
Chris@16: template <typename T>
Chris@16: struct pointer_traits<T*>
Chris@16: {
Chris@16:    typedef T            element_type;
Chris@16:    typedef T*           pointer;
Chris@16:    typedef std::ptrdiff_t difference_type;
Chris@16: 
Chris@16:    #ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED
Chris@16:       typedef T &          reference;
Chris@16:       //!typedef for <pre>U *</pre>
Chris@16:       //!
Chris@16:       //!For portable code for C++03 and C++11, <pre>typename rebind_pointer<U>::type</pre>
Chris@16:       //!shall be used instead of rebind<U> to obtain a pointer to U.
Chris@16:       template <class U> using rebind = U*;
Chris@16:    #else
Chris@16:       typedef typename boost::intrusive::detail::unvoid_ref<element_type>::type reference;
Chris@16:       #if !defined(BOOST_NO_CXX11_TEMPLATE_ALIASES)
Chris@16:          template <class U> using rebind = U*;
Chris@16:       #endif
Chris@16:    #endif
Chris@16: 
Chris@16:    template <class U> struct rebind_pointer
Chris@16:    {  typedef U* type;  };
Chris@16: 
Chris@16:    //! <b>Returns</b>: addressof(r)
Chris@16:    //!
Chris@16:    static pointer pointer_to(reference r)
Chris@16:    { return boost::intrusive::detail::addressof(r); }
Chris@16: 
Chris@16:    //! <b>Returns</b>: static_cast<pointer>(uptr)
Chris@16:    //!
Chris@16:    template<class U>
Chris@16:    static pointer static_cast_from(U *uptr)
Chris@16:    {  return static_cast<pointer>(uptr);  }
Chris@16: 
Chris@16:    //! <b>Returns</b>: const_cast<pointer>(uptr)
Chris@16:    //!
Chris@16:    template<class U>
Chris@16:    static pointer const_cast_from(U *uptr)
Chris@16:    {  return const_cast<pointer>(uptr);  }
Chris@16: 
Chris@16:    //! <b>Returns</b>: dynamic_cast<pointer>(uptr)
Chris@16:    //!
Chris@16:    template<class U>
Chris@16:    static pointer dynamic_cast_from(U *uptr)
Chris@16:    {  return dynamic_cast<pointer>(uptr);  }
Chris@16: };
Chris@16: 
Chris@16: }  //namespace container {
Chris@16: }  //namespace boost {
Chris@16: 
Chris@16: #include <boost/intrusive/detail/config_end.hpp>
Chris@16: 
Chris@16: #endif // ! defined(BOOST_INTRUSIVE_POINTER_TRAITS_HPP)