1 // Debugging array implementation -*- C++ -*-
3 // Copyright (C) 2012-2020 Free Software Foundation, Inc.
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 3, or (at your option)
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
26 * This is a Standard C++ Library header.
29 #ifndef _GLIBCXX_DEBUG_ARRAY
30 #define _GLIBCXX_DEBUG_ARRAY 1
32 #pragma GCC system_header
36 #include <debug/formatter.h>
37 #include <debug/macros.h>
39 namespace std _GLIBCXX_VISIBILITY(default)
43 template<typename _Tp, std::size_t _Nm>
46 typedef _Tp value_type;
47 typedef value_type* pointer;
48 typedef const value_type* const_pointer;
49 typedef value_type& reference;
50 typedef const value_type& const_reference;
51 typedef value_type* iterator;
52 typedef const value_type* const_iterator;
53 typedef std::size_t size_type;
54 typedef std::ptrdiff_t difference_type;
55 typedef std::reverse_iterator<iterator> reverse_iterator;
56 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
58 // Support for zero-sized arrays mandatory.
59 typedef _GLIBCXX_STD_C::__array_traits<_Tp, _Nm> _AT_Type;
60 typename _AT_Type::_Type _M_elems;
62 template<std::size_t _Size>
63 struct _Array_check_subscript
65 std::size_t size() { return _Size; }
67 _Array_check_subscript(std::size_t __index)
68 { __glibcxx_check_subscript(__index); }
71 template<std::size_t _Size>
72 struct _Array_check_nonempty
74 _GLIBCXX_NODISCARD bool empty() { return _Size == 0; }
76 _Array_check_nonempty()
77 { __glibcxx_check_nonempty(); }
80 // No explicit construct/copy/destroy for aggregate type.
83 _GLIBCXX20_CONSTEXPR void
84 fill(const value_type& __u)
85 { std::fill_n(begin(), size(), __u); }
87 _GLIBCXX20_CONSTEXPR void
89 noexcept(_AT_Type::_Is_nothrow_swappable::value)
90 { std::swap_ranges(begin(), end(), __other.begin()); }
93 _GLIBCXX17_CONSTEXPR iterator
95 { return iterator(data()); }
97 _GLIBCXX17_CONSTEXPR const_iterator
98 begin() const noexcept
99 { return const_iterator(data()); }
101 _GLIBCXX17_CONSTEXPR iterator
103 { return iterator(data() + _Nm); }
105 _GLIBCXX17_CONSTEXPR const_iterator
107 { return const_iterator(data() + _Nm); }
109 _GLIBCXX17_CONSTEXPR reverse_iterator
111 { return reverse_iterator(end()); }
113 _GLIBCXX17_CONSTEXPR const_reverse_iterator
114 rbegin() const noexcept
115 { return const_reverse_iterator(end()); }
117 _GLIBCXX17_CONSTEXPR reverse_iterator
119 { return reverse_iterator(begin()); }
121 _GLIBCXX17_CONSTEXPR const_reverse_iterator
122 rend() const noexcept
123 { return const_reverse_iterator(begin()); }
125 _GLIBCXX17_CONSTEXPR const_iterator
126 cbegin() const noexcept
127 { return const_iterator(data()); }
129 _GLIBCXX17_CONSTEXPR const_iterator
130 cend() const noexcept
131 { return const_iterator(data() + _Nm); }
133 _GLIBCXX17_CONSTEXPR const_reverse_iterator
134 crbegin() const noexcept
135 { return const_reverse_iterator(end()); }
137 _GLIBCXX17_CONSTEXPR const_reverse_iterator
138 crend() const noexcept
139 { return const_reverse_iterator(begin()); }
143 size() const noexcept { return _Nm; }
146 max_size() const noexcept { return _Nm; }
148 _GLIBCXX_NODISCARD constexpr bool
149 empty() const noexcept { return size() == 0; }
152 _GLIBCXX17_CONSTEXPR reference
153 operator[](size_type __n) noexcept
155 __glibcxx_check_subscript(__n);
156 return _AT_Type::_S_ref(_M_elems, __n);
159 constexpr const_reference
160 operator[](size_type __n) const noexcept
162 return __n < _Nm ? _AT_Type::_S_ref(_M_elems, __n)
163 : (_GLIBCXX_THROW_OR_ABORT(_Array_check_subscript<_Nm>(__n)),
164 _AT_Type::_S_ref(_M_elems, 0));
167 _GLIBCXX17_CONSTEXPR reference
171 std::__throw_out_of_range_fmt(__N("array::at: __n (which is %zu) "
172 ">= _Nm (which is %zu)"),
174 return _AT_Type::_S_ref(_M_elems, __n);
177 constexpr const_reference
178 at(size_type __n) const
180 // Result of conditional expression must be an lvalue so use
181 // boolean ? lvalue : (throw-expr, lvalue)
182 return __n < _Nm ? _AT_Type::_S_ref(_M_elems, __n)
183 : (std::__throw_out_of_range_fmt(__N("array::at: __n (which is %zu) "
184 ">= _Nm (which is %zu)"),
186 _AT_Type::_S_ref(_M_elems, 0));
189 _GLIBCXX17_CONSTEXPR reference
192 __glibcxx_check_nonempty();
196 constexpr const_reference
197 front() const noexcept
199 return _Nm ? _AT_Type::_S_ref(_M_elems, 0)
200 : (_GLIBCXX_THROW_OR_ABORT(_Array_check_nonempty<_Nm>()),
201 _AT_Type::_S_ref(_M_elems, 0));
204 _GLIBCXX17_CONSTEXPR reference
207 __glibcxx_check_nonempty();
208 return _Nm ? *(end() - 1) : *end();
211 constexpr const_reference
212 back() const noexcept
214 return _Nm ? _AT_Type::_S_ref(_M_elems, _Nm - 1)
215 : (_GLIBCXX_THROW_OR_ABORT(_Array_check_nonempty<_Nm>()),
216 _AT_Type::_S_ref(_M_elems, 0));
219 _GLIBCXX17_CONSTEXPR pointer
221 { return _AT_Type::_S_ptr(_M_elems); }
223 _GLIBCXX17_CONSTEXPR const_pointer
224 data() const noexcept
225 { return _AT_Type::_S_ptr(_M_elems); }
228 #if __cpp_deduction_guides >= 201606
229 template<typename _Tp, typename... _Up>
231 -> array<std::enable_if_t<(std::is_same_v<_Tp, _Up> && ...), _Tp>,
235 // Array comparisons.
236 template<typename _Tp, std::size_t _Nm>
239 operator==(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
240 { return std::equal(__one.begin(), __one.end(), __two.begin()); }
242 template<typename _Tp, std::size_t _Nm>
245 operator!=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
246 { return !(__one == __two); }
248 template<typename _Tp, std::size_t _Nm>
251 operator<(const array<_Tp, _Nm>& __a, const array<_Tp, _Nm>& __b)
253 return std::lexicographical_compare(__a.begin(), __a.end(),
254 __b.begin(), __b.end());
257 template<typename _Tp, std::size_t _Nm>
260 operator>(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
261 { return __two < __one; }
263 template<typename _Tp, std::size_t _Nm>
266 operator<=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
267 { return !(__one > __two); }
269 template<typename _Tp, std::size_t _Nm>
272 operator>=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
273 { return !(__one < __two); }
275 // Specialized algorithms.
277 #if __cplusplus > 201402L || !defined(__STRICT_ANSI__) // c++1z or gnu++11
278 template<typename _Tp, size_t _Nm>
280 !_GLIBCXX_STD_C::__array_traits<_Tp, _Nm>::_Is_swappable::value>::type
281 swap(array<_Tp, _Nm>&, array<_Tp, _Nm>&) = delete;
284 template<typename _Tp, std::size_t _Nm>
287 swap(array<_Tp, _Nm>& __one, array<_Tp, _Nm>& __two)
288 noexcept(noexcept(__one.swap(__two)))
289 { __one.swap(__two); }
291 template<std::size_t _Int, typename _Tp, std::size_t _Nm>
293 get(array<_Tp, _Nm>& __arr) noexcept
295 static_assert(_Int < _Nm, "index is out of bounds");
296 return _GLIBCXX_STD_C::__array_traits<_Tp, _Nm>::
297 _S_ref(__arr._M_elems, _Int);
300 template<std::size_t _Int, typename _Tp, std::size_t _Nm>
302 get(array<_Tp, _Nm>&& __arr) noexcept
304 static_assert(_Int < _Nm, "index is out of bounds");
305 return std::move(__debug::get<_Int>(__arr));
308 template<std::size_t _Int, typename _Tp, std::size_t _Nm>
310 get(const array<_Tp, _Nm>& __arr) noexcept
312 static_assert(_Int < _Nm, "index is out of bounds");
313 return _GLIBCXX_STD_C::__array_traits<_Tp, _Nm>::
314 _S_ref(__arr._M_elems, _Int);
317 template<std::size_t _Int, typename _Tp, std::size_t _Nm>
318 constexpr const _Tp&&
319 get(const array<_Tp, _Nm>&& __arr) noexcept
321 static_assert(_Int < _Nm, "index is out of bounds");
322 return std::move(__debug::get<_Int>(__arr));
325 #if __cplusplus > 201703L
326 #define __cpp_lib_to_array 201907L
328 template<bool _Move = false, typename _Tp, size_t... _Idx>
329 constexpr array<remove_cv_t<_Tp>, sizeof...(_Idx)>
330 __to_array(_Tp (&__a)[sizeof...(_Idx)], index_sequence<_Idx...>)
333 return {{std::move(__a[_Idx])...}};
335 return {{__a[_Idx]...}};
338 template<typename _Tp, size_t _Nm>
339 constexpr array<remove_cv_t<_Tp>, _Nm>
340 to_array(_Tp (&__a)[_Nm])
341 noexcept(is_nothrow_constructible_v<_Tp, _Tp&>)
343 static_assert(!is_array_v<_Tp>);
344 static_assert(is_constructible_v<_Tp, _Tp&>);
345 if constexpr (is_constructible_v<_Tp, _Tp&>)
346 return __debug::__to_array(__a, make_index_sequence<_Nm>{});
347 __builtin_unreachable(); // FIXME: see PR c++/91388
350 template<typename _Tp, size_t _Nm>
351 constexpr array<remove_cv_t<_Tp>, _Nm>
352 to_array(_Tp (&&__a)[_Nm])
353 noexcept(is_nothrow_move_constructible_v<_Tp>)
355 static_assert(!is_array_v<_Tp>);
356 static_assert(is_move_constructible_v<_Tp>);
357 if constexpr (is_move_constructible_v<_Tp>)
358 return __debug::__to_array<1>(__a, make_index_sequence<_Nm>{});
359 __builtin_unreachable(); // FIXME: see PR c++/91388
363 } // namespace __debug
365 _GLIBCXX_BEGIN_NAMESPACE_VERSION
366 // Tuple interface to class template array.
369 template<typename _Tp, std::size_t _Nm>
370 struct tuple_size<std::__debug::array<_Tp, _Nm>>
371 : public integral_constant<std::size_t, _Nm> { };
374 template<std::size_t _Int, typename _Tp, std::size_t _Nm>
375 struct tuple_element<_Int, std::__debug::array<_Tp, _Nm>>
377 static_assert(_Int < _Nm, "index is out of bounds");
381 template<typename _Tp, std::size_t _Nm>
382 struct __is_tuple_like_impl<std::__debug::array<_Tp, _Nm>> : true_type
385 _GLIBCXX_END_NAMESPACE_VERSION
388 #endif // _GLIBCXX_DEBUG_ARRAY