[thirdparty/gcc.git] / libstdc++-v3 / include / debug / array

// Debugging array implementation -*- C++ -*-

// Copyright (C) 2012 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library.  This library is free
// software; you can redistribute it and/or modify it under the
// terms of the GNU General Public License as published by the
// Free Software Foundation; either version 3, or (at your option)
// any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// Under Section 7 of GPL version 3, you are granted additional
// permissions described in the GCC Runtime Library Exception, version
// 3.1, as published by the Free Software Foundation.

// You should have received a copy of the GNU General Public License and
// a copy of the GCC Runtime Library Exception along with this program;
// see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
// <http://www.gnu.org/licenses/>.

/** @file debug/array
 *  This is a Standard C++ Library header.
 */

#ifndef _GLIBCXX_DEBUG_ARRAY
#define _GLIBCXX_DEBUG_ARRAY 1

#pragma GCC system_header

#include <debug/safe_sequence.h>

#ifndef _GLIBCXX_THROW_OR_ABORT
# if __EXCEPTIONS
#  define _GLIBCXX_THROW_OR_ABORT(_Exc) (throw (_Exc))
# else
#  define _GLIBCXX_THROW_OR_ABORT(_Exc) (__builtin_abort())
# endif
#endif

namespace std _GLIBCXX_VISIBILITY(default)
{
namespace __debug
{
  template<typename _Tp, std::size_t _Nm>
    struct array
    {
      typedef _Tp 	    			      value_type;
      typedef value_type*			      pointer;
      typedef const value_type*                       const_pointer;
      typedef value_type&                   	      reference;
      typedef const value_type&             	      const_reference;
      typedef value_type*                             iterator;
      typedef const value_type*                       const_iterator;
      typedef std::size_t                    	      size_type;
      typedef std::ptrdiff_t                   	      difference_type;
      typedef std::reverse_iterator<iterator>	      reverse_iterator;
      typedef std::reverse_iterator<const_iterator>   const_reverse_iterator;

      // Support for zero-sized arrays mandatory.
      typedef _GLIBCXX_STD_C::__array_traits<_Tp, _Nm> _AT_Type;
      typename _AT_Type::_Type                         _M_elems;

      template<std::size_t _Size>
	struct _Array_check_subscript
 	{
	  std::size_t size() { return _Size; }

	  _Array_check_subscript(std::size_t __index)
	  { __glibcxx_check_subscript(__index); }
        };

      template<std::size_t _Size>
	struct _Array_check_nonempty
 	{
	  bool empty() { return _Size == 0; }

	  _Array_check_nonempty()
	  { __glibcxx_check_nonempty(); }
        };

      // No explicit construct/copy/destroy for aggregate type.

      // DR 776.
      void
      fill(const value_type& __u)
      { std::fill_n(begin(), size(), __u); }

      void
      swap(array& __other)
      noexcept(noexcept(swap(std::declval<_Tp&>(), std::declval<_Tp&>())))
      { std::swap_ranges(begin(), end(), __other.begin()); }

      // Iterators.
      iterator
      begin() noexcept
      { return iterator(data()); }

      const_iterator
      begin() const noexcept
      { return const_iterator(data()); }

      iterator
      end() noexcept
      { return iterator(data() + _Nm); }

      const_iterator
      end() const noexcept
      { return const_iterator(data() + _Nm); }

      reverse_iterator 
      rbegin() noexcept
      { return reverse_iterator(end()); }

      const_reverse_iterator 
      rbegin() const noexcept
      { return const_reverse_iterator(end()); }

      reverse_iterator 
      rend() noexcept
      { return reverse_iterator(begin()); }

      const_reverse_iterator 
      rend() const noexcept
      { return const_reverse_iterator(begin()); }

      const_iterator
      cbegin() const noexcept
      { return const_iterator(data()); }

      const_iterator
      cend() const noexcept
      { return const_iterator(data() + _Nm); }

      const_reverse_iterator 
      crbegin() const noexcept
      { return const_reverse_iterator(end()); }

      const_reverse_iterator 
      crend() const noexcept
      { return const_reverse_iterator(begin()); }

      // Capacity.
      constexpr size_type 
      size() const noexcept { return _Nm; }

      constexpr size_type 
      max_size() const noexcept { return _Nm; }

      constexpr bool 
      empty() const noexcept { return size() == 0; }

      // Element access.
      reference
      operator[](size_type __n)
      {
	__glibcxx_check_subscript(__n);
	return _AT_Type::_S_ref(_M_elems, __n);
      }

      constexpr const_reference
      operator[](size_type __n) const noexcept
      {
	return __n < _Nm ? _AT_Type::_S_ref(_M_elems, __n)
	 : (_GLIBCXX_THROW_OR_ABORT (_Array_check_subscript<_Nm>(__n)),
	    _AT_Type::_S_ref(_M_elems, 0));
      }

      reference
      at(size_type __n)
      {
	if (__n >= _Nm)
	  std::__throw_out_of_range(__N("array::at"));
	return _AT_Type::_S_ref(_M_elems, __n);
      }

      constexpr const_reference
      at(size_type __n) const
      {
	// Result of conditional expression must be an lvalue so use
	// boolean ? lvalue : (throw-expr, lvalue)
	return __n < _Nm ? _AT_Type::_S_ref(_M_elems, __n)
	  : (std::__throw_out_of_range(__N("array::at")),
	     _AT_Type::_S_ref(_M_elems, 0));
      }

      reference 
      front()
      {
	__glibcxx_check_nonempty();
	return *begin();
      }

      constexpr const_reference 
      front() const
      {
	return _Nm ? _AT_Type::_S_ref(_M_elems, 0)
	  : (_GLIBCXX_THROW_OR_ABORT (_Array_check_nonempty<_Nm>()),
	     _AT_Type::_S_ref(_M_elems, 0));
      }

      reference 
      back()
      {
	__glibcxx_check_nonempty();
	return _Nm ? *(end() - 1) : *end();
      }

      constexpr const_reference 
      back() const
      {
	return _Nm ? _AT_Type::_S_ref(_M_elems, _Nm - 1)
	  : (_GLIBCXX_THROW_OR_ABORT (_Array_check_nonempty<_Nm>()),
	     _AT_Type::_S_ref(_M_elems, 0));
      }

      pointer
      data() noexcept
      { return std::__addressof(_AT_Type::_S_ref(_M_elems, 0)); }

      const_pointer
      data() const noexcept
      { return std::__addressof(_AT_Type::_S_ref(_M_elems, 0)); }
    };

  // Array comparisons.
  template<typename _Tp, std::size_t _Nm>
    inline bool 
    operator==(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
    { return std::equal(__one.begin(), __one.end(), __two.begin()); }

  template<typename _Tp, std::size_t _Nm>
    inline bool
    operator!=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
    { return !(__one == __two); }

  template<typename _Tp, std::size_t _Nm>
    inline bool
    operator<(const array<_Tp, _Nm>& __a, const array<_Tp, _Nm>& __b)
    { 
      return std::lexicographical_compare(__a.begin(), __a.end(),
					  __b.begin(), __b.end()); 
    }

  template<typename _Tp, std::size_t _Nm>
    inline bool
    operator>(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
    { return __two < __one; }

  template<typename _Tp, std::size_t _Nm>
    inline bool
    operator<=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
    { return !(__one > __two); }

  template<typename _Tp, std::size_t _Nm>
    inline bool
    operator>=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
    { return !(__one < __two); }

  // Specialized algorithms.
  template<typename _Tp, std::size_t _Nm>
    inline void
    swap(array<_Tp, _Nm>& __one, array<_Tp, _Nm>& __two)
    noexcept(noexcept(__one.swap(__two)))
    { __one.swap(__two); }

  template<std::size_t _Int, typename _Tp, std::size_t _Nm>
    constexpr _Tp&
    get(array<_Tp, _Nm>& __arr) noexcept
    {
      static_assert(_Int < _Nm, "index is out of bounds");
      return _GLIBCXX_STD_C::__array_traits<_Tp, _Nm>::
	_S_ref(__arr._M_elems, _Int);
    }

  template<std::size_t _Int, typename _Tp, std::size_t _Nm>
    constexpr _Tp&&
    get(array<_Tp, _Nm>&& __arr) noexcept
    {
      static_assert(_Int < _Nm, "index is out of bounds");
      return std::move(get<_Int>(__arr));
    }

  template<std::size_t _Int, typename _Tp, std::size_t _Nm>
    constexpr const _Tp&
    get(const array<_Tp, _Nm>& __arr) noexcept
    {
      static_assert(_Int < _Nm, "index is out of bounds");
      return _GLIBCXX_STD_C::__array_traits<_Tp, _Nm>::
	_S_ref(__arr._M_elems, _Int);
    }
} // namespace __debug

  // Tuple interface to class template array.

  /// tuple_size
  template<typename _Tp> 
    class tuple_size;

  template<typename _Tp, std::size_t _Nm>
    struct tuple_size<__debug::array<_Tp, _Nm>>
    : public integral_constant<std::size_t, _Nm> { };

  /// tuple_element
  template<std::size_t _Int, typename _Tp>
    class tuple_element;

  template<std::size_t _Int, typename _Tp, std::size_t _Nm>
    struct tuple_element<_Int, __debug::array<_Tp, _Nm>>
    {
      static_assert(_Int < _Nm, "index is out of bounds");
      typedef _Tp type;
    };
} // namespace std

#undef _GLIBCXX_THROW_OR_ABORT

#endif // _GLIBCXX_DEBUG_ARRAY
Commit	Line	Data
0611ce44 PC	1	// Debugging array implementation -- C++ --
	2
	3	// Copyright (C) 2012 Free Software Foundation, Inc.
	4	//
	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)
	9	// any later version.
	10
	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.
	15
	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.
	19
	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/>.
	24
	25	/** @file debug/array
	26	* This is a Standard C++ Library header.
	27	*/
	28
	29	#ifndef _GLIBCXX_DEBUG_ARRAY
	30	#define _GLIBCXX_DEBUG_ARRAY 1
	31
	32	#pragma GCC system_header
	33
	34	#include <debug/safe_sequence.h>
	35
	36	#ifndef _GLIBCXX_THROW_OR_ABORT
	37	# if __EXCEPTIONS
	38	# define _GLIBCXX_THROW_OR_ABORT(_Exc) (throw (_Exc))
	39	# else
	40	# define _GLIBCXX_THROW_OR_ABORT(_Exc) (__builtin_abort())
	41	# endif
	42	#endif
	43
	44	namespace std _GLIBCXX_VISIBILITY(default)
	45	{
	46	namespace __debug
	47	{
	48	template<typename _Tp, std::size_t _Nm>
	49	struct array
	50	{
	51	typedef _Tp value_type;
	52	typedef value_type* pointer;
	53	typedef const value_type* const_pointer;
	54	typedef value_type& reference;
	55	typedef const value_type& const_reference;
	56	typedef value_type* iterator;
	57	typedef const value_type* const_iterator;
	58	typedef std::size_t size_type;
	59	typedef std::ptrdiff_t difference_type;
	60	typedef std::reverse_iterator<iterator> reverse_iterator;
	61	typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
	62
	63	// Support for zero-sized arrays mandatory.
	64	typedef _GLIBCXX_STD_C::__array_traits<_Tp, _Nm> _AT_Type;
65	typename _AT_Type::_Type _M_elems;
66
67	template<std::size_t _Size>
68	struct _Array_check_subscript
69	{
70	std::size_t size() { return _Size; }
71
72	_Array_check_subscript(std::size_t __index)
73	{ __glibcxx_check_subscript(__index); }
74	};
75
76	template<std::size_t _Size>
77	struct _Array_check_nonempty
78	{
79	bool empty() { return _Size == 0; }
80
81	_Array_check_nonempty()
82	{ __glibcxx_check_nonempty(); }
83	};
84
85	// No explicit construct/copy/destroy for aggregate type.
86
87	// DR 776.
88	void
89	fill(const value_type& __u)
90	{ std::fill_n(begin(), size(), __u); }
91
92	void
93	swap(array& __other)
94	noexcept(noexcept(swap(std::declval<_Tp&>(), std::declval<_Tp&>())))
95	{ std::swap_ranges(begin(), end(), __other.begin()); }
96
97	// Iterators.
98	iterator
99	begin() noexcept
100	{ return iterator(data()); }
101
102	const_iterator
103	begin() const noexcept
104	{ return const_iterator(data()); }
105
106	iterator
107	end() noexcept
108	{ return iterator(data() + _Nm); }
109
110	const_iterator
111	end() const noexcept
112	{ return const_iterator(data() + _Nm); }
113
114	reverse_iterator
115	rbegin() noexcept
116	{ return reverse_iterator(end()); }
117
118	const_reverse_iterator
119	rbegin() const noexcept
120	{ return const_reverse_iterator(end()); }
121
122	reverse_iterator
123	rend() noexcept
124	{ return reverse_iterator(begin()); }
125
126	const_reverse_iterator
127	rend() const noexcept
128	{ return const_reverse_iterator(begin()); }
129
130	const_iterator
131	cbegin() const noexcept
132	{ return const_iterator(data()); }
133
134	const_iterator
135	cend() const noexcept
136	{ return const_iterator(data() + _Nm); }
137
138	const_reverse_iterator
139	crbegin() const noexcept
140	{ return const_reverse_iterator(end()); }
141
142	const_reverse_iterator
143	crend() const noexcept
144	{ return const_reverse_iterator(begin()); }
145
146	// Capacity.
147	constexpr size_type
148	size() const noexcept { return _Nm; }
149
150	constexpr size_type
151	max_size() const noexcept { return _Nm; }
152
153	constexpr bool
154	empty() const noexcept { return size() == 0; }
155
156	// Element access.
157	reference
158	operator[](size_type __n)
159	{
160	__glibcxx_check_subscript(__n);
161	return _AT_Type::_S_ref(_M_elems, __n);
162	}
163
164	constexpr const_reference
165	operator[](size_type __n) const noexcept
166	{
167	return __n < _Nm ? _AT_Type::_S_ref(_M_elems, __n)
168	: (_GLIBCXX_THROW_OR_ABORT (_Array_check_subscript<_Nm>(__n)),
169	_AT_Type::_S_ref(_M_elems, 0));
170	}
171
172	reference
173	at(size_type __n)
174	{
175	if (__n >= _Nm)
176	std::__throw_out_of_range(__N("array::at"));
177	return _AT_Type::_S_ref(_M_elems, __n);
178	}
179
180	constexpr const_reference
181	at(size_type __n) const
182	{
183	// Result of conditional expression must be an lvalue so use
184	// boolean ? lvalue : (throw-expr, lvalue)
185	return __n < _Nm ? _AT_Type::_S_ref(_M_elems, __n)
186	: (std::__throw_out_of_range(__N("array::at")),
187	_AT_Type::_S_ref(_M_elems, 0));
188	}
189
190	reference
191	front()
192	{
193	__glibcxx_check_nonempty();
194	return *begin();
195	}
196
197	constexpr const_reference
198	front() const
199	{
200	return _Nm ? _AT_Type::_S_ref(_M_elems, 0)
201	: (_GLIBCXX_THROW_OR_ABORT (_Array_check_nonempty<_Nm>()),
202	_AT_Type::_S_ref(_M_elems, 0));
203	}
204
205	reference
206	back()
207	{
208	__glibcxx_check_nonempty();
209	return _Nm ? (end() - 1) : end();
210	}
211
212	constexpr const_reference
213	back() const
214	{
215	return _Nm ? _AT_Type::_S_ref(_M_elems, _Nm - 1)
216	: (_GLIBCXX_THROW_OR_ABORT (_Array_check_nonempty<_Nm>()),
217	_AT_Type::_S_ref(_M_elems, 0));
218	}
219
220	pointer
221	data() noexcept
222	{ return std::__addressof(_AT_Type::_S_ref(_M_elems, 0)); }
223
224	const_pointer
225	data() const noexcept
226	{ return std::__addressof(_AT_Type::_S_ref(_M_elems, 0)); }
227	};
228
229	// Array comparisons.
230	template<typename _Tp, std::size_t _Nm>
231	inline bool
232	operator==(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
233	{ return std::equal(__one.begin(), __one.end(), __two.begin()); }
234
235	template<typename _Tp, std::size_t _Nm>
236	inline bool
237	operator!=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
238	{ return !(__one == __two); }
239
240	template<typename _Tp, std::size_t _Nm>
241	inline bool
242	operator<(const array<_Tp, _Nm>& __a, const array<_Tp, _Nm>& __b)
243	{
244	return std::lexicographical_compare(__a.begin(), __a.end(),
245	__b.begin(), __b.end());
246	}
247
248	template<typename _Tp, std::size_t _Nm>
249	inline bool
250	operator>(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
251	{ return __two < __one; }
252
253	template<typename _Tp, std::size_t _Nm>
254	inline bool
255	operator<=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
256	{ return !(__one > __two); }
257
258	template<typename _Tp, std::size_t _Nm>
259	inline bool
260	operator>=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
261	{ return !(__one < __two); }
262
263	// Specialized algorithms.
264	template<typename _Tp, std::size_t _Nm>
265	inline void
266	swap(array<_Tp, _Nm>& __one, array<_Tp, _Nm>& __two)
267	noexcept(noexcept(__one.swap(__two)))
268	{ __one.swap(__two); }
269
270	template<std::size_t _Int, typename _Tp, std::size_t _Nm>
271	constexpr _Tp&
272	get(array<_Tp, _Nm>& __arr) noexcept
273	{
274	static_assert(_Int < _Nm, "index is out of bounds");
275	return _GLIBCXX_STD_C::__array_traits<_Tp, _Nm>::
276	_S_ref(__arr._M_elems, _Int);
277	}
278
279	template<std::size_t _Int, typename _Tp, std::size_t _Nm>
280	constexpr _Tp&&
281	get(array<_Tp, _Nm>&& __arr) noexcept
282	{
283	static_assert(_Int < _Nm, "index is out of bounds");
284	return std::move(get<_Int>(__arr));
285	}
286
287	template<std::size_t _Int, typename _Tp, std::size_t _Nm>
288	constexpr const _Tp&
289	get(const array<_Tp, _Nm>& __arr) noexcept
290	{
291	static_assert(_Int < _Nm, "index is out of bounds");
292	return _GLIBCXX_STD_C::__array_traits<_Tp, _Nm>::
293	_S_ref(__arr._M_elems, _Int);
294	}
295	} // namespace __debug
296
297	// Tuple interface to class template array.
298
299	/// tuple_size
300	template<typename _Tp>
301	class tuple_size;
302
303	template<typename _Tp, std::size_t _Nm>
304	struct tuple_size<__debug::array<_Tp, _Nm>>
305	: public integral_constant<std::size_t, _Nm> { };
306
307	/// tuple_element
308	template<std::size_t _Int, typename _Tp>
309	class tuple_element;
310
311	template<std::size_t _Int, typename _Tp, std::size_t _Nm>
312	struct tuple_element<_Int, __debug::array<_Tp, _Nm>>
313	{
314	static_assert(_Int < _Nm, "index is out of bounds");
315	typedef _Tp type;
316	};
317	} // namespace std
318
319	#undef _GLIBCXX_THROW_OR_ABORT
320
321	#endif // _GLIBCXX_DEBUG_ARRAY