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