xref: /xnu-10063.101.15/libkern/os/cpp_util.h (revision 94d3b452840153a99b38a3a9659680b2a006908e)
1*94d3b452SApple OSS Distributions #ifndef _OS_CPP_UTIL_H
2*94d3b452SApple OSS Distributions #define _OS_CPP_UTIL_H
3*94d3b452SApple OSS Distributions 
4*94d3b452SApple OSS Distributions #include <sys/cdefs.h>
5*94d3b452SApple OSS Distributions #include <sys/_types/_size_t.h>
6*94d3b452SApple OSS Distributions 
7*94d3b452SApple OSS Distributions #if __has_feature(cxx_nullptr) && __has_feature(cxx_decltype)
8*94d3b452SApple OSS Distributions # define OS_HAS_NULLPTR 1
9*94d3b452SApple OSS Distributions #endif
10*94d3b452SApple OSS Distributions 
11*94d3b452SApple OSS Distributions #if __has_feature(cxx_rvalue_references) || __has_extension(cxx_rvalue_references)
12*94d3b452SApple OSS Distributions # define OS_HAS_RVALUE_REFERENCES 1
13*94d3b452SApple OSS Distributions #endif
14*94d3b452SApple OSS Distributions 
15*94d3b452SApple OSS Distributions #if (defined(__has_include) && __has_include(<__xnu_libcxx_sentinel.h>) && __has_include(<new>))
16*94d3b452SApple OSS Distributions #include <new>
17*94d3b452SApple OSS Distributions #else
18*94d3b452SApple OSS Distributions void* operator new(size_t, void*) noexcept; // forward declaration needed for placement-new
19*94d3b452SApple OSS Distributions #endif
20*94d3b452SApple OSS Distributions 
21*94d3b452SApple OSS Distributions namespace os {
22*94d3b452SApple OSS Distributions #if OS_HAS_NULLPTR
23*94d3b452SApple OSS Distributions typedef decltype(nullptr) nullptr_t;
24*94d3b452SApple OSS Distributions #endif
25*94d3b452SApple OSS Distributions 
26*94d3b452SApple OSS Distributions /*
27*94d3b452SApple OSS Distributions  * Reference removal
28*94d3b452SApple OSS Distributions  */
29*94d3b452SApple OSS Distributions 
30*94d3b452SApple OSS Distributions template <class _T> struct remove_reference       {typedef _T type;};
31*94d3b452SApple OSS Distributions template <class _T> struct remove_reference<_T&>  {typedef _T type;};
32*94d3b452SApple OSS Distributions template <class _T> struct remove_reference<_T &&> {typedef _T type;};
33*94d3b452SApple OSS Distributions template <class _T> using remove_reference_t = typename remove_reference<_T>::type;
34*94d3b452SApple OSS Distributions 
35*94d3b452SApple OSS Distributions /*
36*94d3b452SApple OSS Distributions  * Pointer removal
37*94d3b452SApple OSS Distributions  */
38*94d3b452SApple OSS Distributions 
39*94d3b452SApple OSS Distributions template <class _T> struct remove_pointer                     {typedef _T type;};
40*94d3b452SApple OSS Distributions template <class _T> struct remove_pointer<_T*>                {typedef _T type;};
41*94d3b452SApple OSS Distributions template <class _T> struct remove_pointer<_T* const>          {typedef _T type;};
42*94d3b452SApple OSS Distributions template <class _T> struct remove_pointer<_T* volatile>       {typedef _T type;};
43*94d3b452SApple OSS Distributions template <class _T> struct remove_pointer<_T* const volatile> {typedef _T type;};
44*94d3b452SApple OSS Distributions template <class _T> using remove_pointer_t = typename remove_pointer<_T>::type;
45*94d3b452SApple OSS Distributions 
46*94d3b452SApple OSS Distributions /*
47*94d3b452SApple OSS Distributions  * Const removal
48*94d3b452SApple OSS Distributions  */
49*94d3b452SApple OSS Distributions 
50*94d3b452SApple OSS Distributions template <class _T> struct remove_const           {typedef _T type;};
51*94d3b452SApple OSS Distributions template <class _T> struct remove_const<const _T> {typedef _T type;};
52*94d3b452SApple OSS Distributions template <class _T> using remove_const_t = typename remove_const<_T>::type;
53*94d3b452SApple OSS Distributions 
54*94d3b452SApple OSS Distributions /*
55*94d3b452SApple OSS Distributions  * Volatile removal
56*94d3b452SApple OSS Distributions  */
57*94d3b452SApple OSS Distributions 
58*94d3b452SApple OSS Distributions template <class _T> struct remove_volatile              {typedef _T type;};
59*94d3b452SApple OSS Distributions template <class _T> struct remove_volatile<volatile _T> {typedef _T type;};
60*94d3b452SApple OSS Distributions template <class _T> using remove_volatile_t = typename remove_volatile<_T>::type;
61*94d3b452SApple OSS Distributions 
62*94d3b452SApple OSS Distributions /*
63*94d3b452SApple OSS Distributions  * Extent removal
64*94d3b452SApple OSS Distributions  */
65*94d3b452SApple OSS Distributions 
66*94d3b452SApple OSS Distributions template<class _T> struct remove_extent { typedef _T type; };
67*94d3b452SApple OSS Distributions template<class _T> struct remove_extent<_T[]> { typedef _T type; };
68*94d3b452SApple OSS Distributions template<class _T, size_t N> struct remove_extent<_T[N]> { typedef _T type; };
69*94d3b452SApple OSS Distributions template <class _T> using remove_extent_t = typename remove_extent<_T>::type;
70*94d3b452SApple OSS Distributions 
71*94d3b452SApple OSS Distributions 
72*94d3b452SApple OSS Distributions template <class T> struct is_lvalue_reference { static constexpr bool value = false; };
73*94d3b452SApple OSS Distributions template <class T> struct is_lvalue_reference<T&> { static constexpr bool value = true; };
74*94d3b452SApple OSS Distributions 
75*94d3b452SApple OSS Distributions /*
76*94d3b452SApple OSS Distributions  * is_same
77*94d3b452SApple OSS Distributions  */
78*94d3b452SApple OSS Distributions 
79*94d3b452SApple OSS Distributions template<class T, class U> struct is_same { static constexpr bool value = false; };
80*94d3b452SApple OSS Distributions template<class T> struct is_same<T, T> { static constexpr bool value = true; };
81*94d3b452SApple OSS Distributions 
82*94d3b452SApple OSS Distributions /*
83*94d3b452SApple OSS Distributions  * Move
84*94d3b452SApple OSS Distributions  */
85*94d3b452SApple OSS Distributions 
86*94d3b452SApple OSS Distributions template <class _T>
87*94d3b452SApple OSS Distributions inline typename remove_reference<_T>::type &&
88*94d3b452SApple OSS Distributions move(_T && _t)
89*94d3b452SApple OSS Distributions {
90*94d3b452SApple OSS Distributions 	typedef typename os::remove_reference<_T>::type _U;
91*94d3b452SApple OSS Distributions 	return static_cast<_U &&>(_t);
92*94d3b452SApple OSS Distributions }
93*94d3b452SApple OSS Distributions 
94*94d3b452SApple OSS Distributions template <class T>
95*94d3b452SApple OSS Distributions T*
96*94d3b452SApple OSS Distributions move(T* first, T* last, T* d_first)
97*94d3b452SApple OSS Distributions {
98*94d3b452SApple OSS Distributions 	for (; first != last; ++d_first, (void)++first) {
99*94d3b452SApple OSS Distributions 		*d_first = os::move(*first);
100*94d3b452SApple OSS Distributions 	}
101*94d3b452SApple OSS Distributions 	return d_first;
102*94d3b452SApple OSS Distributions }
103*94d3b452SApple OSS Distributions 
104*94d3b452SApple OSS Distributions template <class T>
105*94d3b452SApple OSS Distributions constexpr T && forward(os::remove_reference_t<T>&t) noexcept {
106*94d3b452SApple OSS Distributions 	return static_cast<T &&>(t);
107*94d3b452SApple OSS Distributions }
108*94d3b452SApple OSS Distributions 
109*94d3b452SApple OSS Distributions template <class T>
110*94d3b452SApple OSS Distributions constexpr T && forward(os::remove_reference_t<T>&& t) noexcept {
111*94d3b452SApple OSS Distributions 	static_assert(!os::is_lvalue_reference<T>::value,
112*94d3b452SApple OSS Distributions 	    "can not forward an rvalue as an lvalue");
113*94d3b452SApple OSS Distributions 	return static_cast<T &&>(t);
114*94d3b452SApple OSS Distributions }
115*94d3b452SApple OSS Distributions 
116*94d3b452SApple OSS Distributions // Moves [first, last) into the range ending at d_last,
117*94d3b452SApple OSS Distributions // proceeding backwards (from last to first)
118*94d3b452SApple OSS Distributions // UB if d_last is within (first, last]
119*94d3b452SApple OSS Distributions template <class T>
120*94d3b452SApple OSS Distributions T*
121*94d3b452SApple OSS Distributions move_backward(T* first, T* last, T* d_last)
122*94d3b452SApple OSS Distributions {
123*94d3b452SApple OSS Distributions 	while (first != last) {
124*94d3b452SApple OSS Distributions 		*(--d_last) = os::move(*(--last));
125*94d3b452SApple OSS Distributions 	}
126*94d3b452SApple OSS Distributions 	return d_last;
127*94d3b452SApple OSS Distributions }
128*94d3b452SApple OSS Distributions 
129*94d3b452SApple OSS Distributions template <class T>
130*94d3b452SApple OSS Distributions T*
131*94d3b452SApple OSS Distributions uninitialized_move(T* first, T* last, T* d_first)
132*94d3b452SApple OSS Distributions {
133*94d3b452SApple OSS Distributions 	for (; first != last; ++d_first, (void) ++first) {
134*94d3b452SApple OSS Distributions 		::new (static_cast<void*>(d_first)) T(os::move(*first));
135*94d3b452SApple OSS Distributions 	}
136*94d3b452SApple OSS Distributions 	return first;
137*94d3b452SApple OSS Distributions }
138*94d3b452SApple OSS Distributions 
139*94d3b452SApple OSS Distributions template <class T>
140*94d3b452SApple OSS Distributions void
141*94d3b452SApple OSS Distributions destroy(T* first, T* last)
142*94d3b452SApple OSS Distributions {
143*94d3b452SApple OSS Distributions 	for (; first != last; ++first) {
144*94d3b452SApple OSS Distributions 		first->~T();
145*94d3b452SApple OSS Distributions 	}
146*94d3b452SApple OSS Distributions }
147*94d3b452SApple OSS Distributions 
148*94d3b452SApple OSS Distributions template <class T>
149*94d3b452SApple OSS Distributions void
150*94d3b452SApple OSS Distributions uninitialized_value_construct(T* first, T* last)
151*94d3b452SApple OSS Distributions {
152*94d3b452SApple OSS Distributions 	for (; first != last; ++first) {
153*94d3b452SApple OSS Distributions 		::new (static_cast<void*>(first)) T();
154*94d3b452SApple OSS Distributions 	}
155*94d3b452SApple OSS Distributions }
156*94d3b452SApple OSS Distributions }
157*94d3b452SApple OSS Distributions 
158*94d3b452SApple OSS Distributions #endif /* _OS_CPP_UTIL_H */
159