xref: /dflybsd-src/contrib/gcc-4.7/libstdc++-v3/include/bits/ptr_traits.h (revision 04febcfb30580676d3e95f58a16c5137ee478b32)
1*e4b17023SJohn Marino // Pointer Traits -*- C++ -*-
2*e4b17023SJohn Marino 
3*e4b17023SJohn Marino // Copyright (C) 2011, 2012 Free Software Foundation, Inc.
4*e4b17023SJohn Marino //
5*e4b17023SJohn Marino // This file is part of the GNU ISO C++ Library.  This library is free
6*e4b17023SJohn Marino // software; you can redistribute it and/or modify it under the
7*e4b17023SJohn Marino // terms of the GNU General Public License as published by the
8*e4b17023SJohn Marino // Free Software Foundation; either version 3, or (at your option)
9*e4b17023SJohn Marino // any later version.
10*e4b17023SJohn Marino 
11*e4b17023SJohn Marino // This library is distributed in the hope that it will be useful,
12*e4b17023SJohn Marino // but WITHOUT ANY WARRANTY; without even the implied warranty of
13*e4b17023SJohn Marino // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14*e4b17023SJohn Marino // GNU General Public License for more details.
15*e4b17023SJohn Marino 
16*e4b17023SJohn Marino // Under Section 7 of GPL version 3, you are granted additional
17*e4b17023SJohn Marino // permissions described in the GCC Runtime Library Exception, version
18*e4b17023SJohn Marino // 3.1, as published by the Free Software Foundation.
19*e4b17023SJohn Marino 
20*e4b17023SJohn Marino // You should have received a copy of the GNU General Public License and
21*e4b17023SJohn Marino // a copy of the GCC Runtime Library Exception along with this program;
22*e4b17023SJohn Marino // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
23*e4b17023SJohn Marino // <http://www.gnu.org/licenses/>.
24*e4b17023SJohn Marino 
25*e4b17023SJohn Marino /** @file bits/ptr_traits.h
26*e4b17023SJohn Marino  *  This is an internal header file, included by other library headers.
27*e4b17023SJohn Marino  *  Do not attempt to use it directly. @headername{memory}
28*e4b17023SJohn Marino  */
29*e4b17023SJohn Marino 
30*e4b17023SJohn Marino #ifndef _PTR_TRAITS_H
31*e4b17023SJohn Marino #define _PTR_TRAITS_H 1
32*e4b17023SJohn Marino 
33*e4b17023SJohn Marino #ifdef __GXX_EXPERIMENTAL_CXX0X__
34*e4b17023SJohn Marino 
35*e4b17023SJohn Marino #include <type_traits> // For _GLIBCXX_HAS_NESTED_TYPE
36*e4b17023SJohn Marino 
_GLIBCXX_VISIBILITY(default)37*e4b17023SJohn Marino namespace std _GLIBCXX_VISIBILITY(default)
38*e4b17023SJohn Marino {
39*e4b17023SJohn Marino _GLIBCXX_BEGIN_NAMESPACE_VERSION
40*e4b17023SJohn Marino 
41*e4b17023SJohn Marino _GLIBCXX_HAS_NESTED_TYPE(element_type)
42*e4b17023SJohn Marino _GLIBCXX_HAS_NESTED_TYPE(difference_type)
43*e4b17023SJohn Marino 
44*e4b17023SJohn Marino   template<typename _Tp, bool = __has_element_type<_Tp>::value>
45*e4b17023SJohn Marino     struct __ptrtr_elt_type;
46*e4b17023SJohn Marino 
47*e4b17023SJohn Marino   template<typename _Tp>
48*e4b17023SJohn Marino     struct __ptrtr_elt_type<_Tp, true>
49*e4b17023SJohn Marino     {
50*e4b17023SJohn Marino       typedef typename _Tp::element_type __type;
51*e4b17023SJohn Marino     };
52*e4b17023SJohn Marino 
53*e4b17023SJohn Marino   template<template<typename, typename...> class _SomePtr, typename _Tp,
54*e4b17023SJohn Marino             typename... _Args>
55*e4b17023SJohn Marino     struct __ptrtr_elt_type<_SomePtr<_Tp, _Args...>, false>
56*e4b17023SJohn Marino     {
57*e4b17023SJohn Marino       typedef _Tp __type;
58*e4b17023SJohn Marino     };
59*e4b17023SJohn Marino 
60*e4b17023SJohn Marino   template<typename _Tp, bool = __has_difference_type<_Tp>::value>
61*e4b17023SJohn Marino     struct __ptrtr_diff_type
62*e4b17023SJohn Marino     {
63*e4b17023SJohn Marino       typedef typename _Tp::difference_type __type;
64*e4b17023SJohn Marino     };
65*e4b17023SJohn Marino 
66*e4b17023SJohn Marino   template<typename _Tp>
67*e4b17023SJohn Marino     struct __ptrtr_diff_type<_Tp, false>
68*e4b17023SJohn Marino     {
69*e4b17023SJohn Marino       typedef ptrdiff_t __type;
70*e4b17023SJohn Marino     };
71*e4b17023SJohn Marino 
72*e4b17023SJohn Marino   template<typename _Ptr, typename _Up>
73*e4b17023SJohn Marino     class __ptrtr_rebind_helper
74*e4b17023SJohn Marino     {
75*e4b17023SJohn Marino       template<typename _Ptr2, typename _Up2>
76*e4b17023SJohn Marino 	static constexpr bool
77*e4b17023SJohn Marino        	_S_chk(typename _Ptr2::template rebind<_Up2>*)
78*e4b17023SJohn Marino        	{ return true; }
79*e4b17023SJohn Marino 
80*e4b17023SJohn Marino       template<typename, typename>
81*e4b17023SJohn Marino         static constexpr bool
82*e4b17023SJohn Marino        	_S_chk(...)
83*e4b17023SJohn Marino        	{ return false; }
84*e4b17023SJohn Marino 
85*e4b17023SJohn Marino     public:
86*e4b17023SJohn Marino       static const bool __value = _S_chk<_Ptr, _Up>(nullptr);
87*e4b17023SJohn Marino     };
88*e4b17023SJohn Marino 
89*e4b17023SJohn Marino   template<typename _Ptr, typename _Up>
90*e4b17023SJohn Marino     const bool __ptrtr_rebind_helper<_Ptr, _Up>::__value;
91*e4b17023SJohn Marino 
92*e4b17023SJohn Marino   template<typename _Tp, typename _Up,
93*e4b17023SJohn Marino            bool = __ptrtr_rebind_helper<_Tp, _Up>::__value>
94*e4b17023SJohn Marino     struct __ptrtr_rebind;
95*e4b17023SJohn Marino 
96*e4b17023SJohn Marino   template<typename _Tp, typename _Up>
97*e4b17023SJohn Marino     struct __ptrtr_rebind<_Tp, _Up, true>
98*e4b17023SJohn Marino     {
99*e4b17023SJohn Marino       typedef typename _Tp::template rebind<_Up> __type;
100*e4b17023SJohn Marino     };
101*e4b17023SJohn Marino 
102*e4b17023SJohn Marino   template<template<typename, typename...> class _SomePtr, typename _Up,
103*e4b17023SJohn Marino             typename _Tp, typename... _Args>
104*e4b17023SJohn Marino     struct __ptrtr_rebind<_SomePtr<_Tp, _Args...>, _Up, false>
105*e4b17023SJohn Marino     {
106*e4b17023SJohn Marino       typedef _SomePtr<_Up, _Args...> __type;
107*e4b17023SJohn Marino     };
108*e4b17023SJohn Marino 
109*e4b17023SJohn Marino   template<typename _Tp, typename = typename remove_cv<_Tp>::type>
110*e4b17023SJohn Marino     struct __ptrtr_not_void
111*e4b17023SJohn Marino     {
112*e4b17023SJohn Marino       typedef _Tp __type;
113*e4b17023SJohn Marino     };
114*e4b17023SJohn Marino 
115*e4b17023SJohn Marino   template<typename _Tp>
116*e4b17023SJohn Marino     struct __ptrtr_not_void<_Tp, void>
117*e4b17023SJohn Marino     {
118*e4b17023SJohn Marino       struct __type { };
119*e4b17023SJohn Marino     };
120*e4b17023SJohn Marino 
121*e4b17023SJohn Marino   template<typename _Ptr>
122*e4b17023SJohn Marino     class __ptrtr_pointer_to
123*e4b17023SJohn Marino     {
124*e4b17023SJohn Marino       typedef typename __ptrtr_elt_type<_Ptr>::__type   __orig_type;
125*e4b17023SJohn Marino       typedef typename __ptrtr_not_void<__orig_type>::__type __element_type;
126*e4b17023SJohn Marino 
127*e4b17023SJohn Marino     public:
128*e4b17023SJohn Marino       static _Ptr pointer_to(__element_type& __e)
129*e4b17023SJohn Marino       { return _Ptr::pointer_to(__e); }
130*e4b17023SJohn Marino     };
131*e4b17023SJohn Marino 
132*e4b17023SJohn Marino   /**
133*e4b17023SJohn Marino    * @brief  Uniform interface to all pointer-like types
134*e4b17023SJohn Marino    * @ingroup pointer_abstractions
135*e4b17023SJohn Marino   */
136*e4b17023SJohn Marino   template<typename _Ptr>
137*e4b17023SJohn Marino     struct pointer_traits : __ptrtr_pointer_to<_Ptr>
138*e4b17023SJohn Marino     {
139*e4b17023SJohn Marino       /// The pointer type
140*e4b17023SJohn Marino       typedef _Ptr                                      pointer;
141*e4b17023SJohn Marino       /// The type pointed to
142*e4b17023SJohn Marino       typedef typename __ptrtr_elt_type<_Ptr>::__type   element_type;
143*e4b17023SJohn Marino       /// Type used to represent the difference between two pointers
144*e4b17023SJohn Marino       typedef typename __ptrtr_diff_type<_Ptr>::__type  difference_type;
145*e4b17023SJohn Marino 
146*e4b17023SJohn Marino       template<typename _Up>
147*e4b17023SJohn Marino         using rebind = typename __ptrtr_rebind<_Ptr, _Up>::__type;
148*e4b17023SJohn Marino     };
149*e4b17023SJohn Marino 
150*e4b17023SJohn Marino   /**
151*e4b17023SJohn Marino    * @brief  Partial specialization for built-in pointers.
152*e4b17023SJohn Marino    * @ingroup pointer_abstractions
153*e4b17023SJohn Marino   */
154*e4b17023SJohn Marino   template<typename _Tp>
155*e4b17023SJohn Marino     struct pointer_traits<_Tp*>
156*e4b17023SJohn Marino     {
157*e4b17023SJohn Marino       /// The pointer type
158*e4b17023SJohn Marino       typedef _Tp* pointer;
159*e4b17023SJohn Marino       /// The type pointed to
160*e4b17023SJohn Marino       typedef _Tp  element_type;
161*e4b17023SJohn Marino       /// Type used to represent the difference between two pointers
162*e4b17023SJohn Marino       typedef ptrdiff_t difference_type;
163*e4b17023SJohn Marino 
164*e4b17023SJohn Marino       template<typename _Up>
165*e4b17023SJohn Marino         using rebind = _Up*;
166*e4b17023SJohn Marino 
167*e4b17023SJohn Marino       /**
168*e4b17023SJohn Marino        *  @brief  Obtain a pointer to an object
169*e4b17023SJohn Marino        *  @param  __r  A reference to an object of type @c element_type
170*e4b17023SJohn Marino        *  @return @c addressof(__r)
171*e4b17023SJohn Marino       */
172*e4b17023SJohn Marino       static pointer
173*e4b17023SJohn Marino       pointer_to(typename __ptrtr_not_void<element_type>::__type& __r) noexcept
174*e4b17023SJohn Marino       { return std::addressof(__r); }
175*e4b17023SJohn Marino     };
176*e4b17023SJohn Marino 
177*e4b17023SJohn Marino _GLIBCXX_END_NAMESPACE_VERSION
178*e4b17023SJohn Marino } // namespace std
179*e4b17023SJohn Marino 
180*e4b17023SJohn Marino #endif
181*e4b17023SJohn Marino 
182*e4b17023SJohn Marino #endif
183