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