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