1 // Debugging support implementation -*- C++ -*-
3 // Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 // Free Software Foundation, Inc.
6 // This file is part of the GNU ISO C++ Library. This library is free
7 // software; you can redistribute it and/or modify it under the
8 // terms of the GNU General Public License as published by the
9 // Free Software Foundation; either version 3, or (at your option)
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
17 // Under Section 7 of GPL version 3, you are granted additional
18 // permissions described in the GCC Runtime Library Exception, version
19 // 3.1, as published by the Free Software Foundation.
21 // You should have received a copy of the GNU General Public License and
22 // a copy of the GCC Runtime Library Exception along with this program;
23 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24 // <http://www.gnu.org/licenses/>.
26 /** @file debug/functions.h
27 * This file is a GNU debug extension to the Standard C++ Library.
30 #ifndef _GLIBCXX_DEBUG_FUNCTIONS_H
31 #define _GLIBCXX_DEBUG_FUNCTIONS_H 1
33 #include <bits/c++config.h>
34 #include <bits/stl_iterator_base_types.h> // for iterator_traits, categories
35 #include <bits/cpp_type_traits.h> // for __is_integer
36 #include <debug/formatter.h>
40 template<typename _Iterator, typename _Sequence>
43 // An arbitrary iterator pointer is not singular.
45 __check_singular_aux(const void*) { return false; }
47 // We may have an iterator that derives from _Safe_iterator_base but isn't
49 template<typename _Iterator>
51 __check_singular(_Iterator& __x)
52 { return __check_singular_aux(&__x); }
54 /** Non-NULL pointers are nonsingular. */
55 template<typename _Tp>
57 __check_singular(const _Tp* __ptr)
58 { return __ptr == 0; }
60 /** Safe iterators know if they are singular. */
61 template<typename _Iterator, typename _Sequence>
63 __check_singular(const _Safe_iterator<_Iterator, _Sequence>& __x)
64 { return __x._M_singular(); }
66 /** Assume that some arbitrary iterator is dereferenceable, because we
67 can't prove that it isn't. */
68 template<typename _Iterator>
70 __check_dereferenceable(_Iterator&)
73 /** Non-NULL pointers are dereferenceable. */
74 template<typename _Tp>
76 __check_dereferenceable(const _Tp* __ptr)
79 /** Safe iterators know if they are singular. */
80 template<typename _Iterator, typename _Sequence>
82 __check_dereferenceable(const _Safe_iterator<_Iterator, _Sequence>& __x)
83 { return __x._M_dereferenceable(); }
85 /** If the distance between two random access iterators is
86 * nonnegative, assume the range is valid.
88 template<typename _RandomAccessIterator>
90 __valid_range_aux2(const _RandomAccessIterator& __first,
91 const _RandomAccessIterator& __last,
92 std::random_access_iterator_tag)
93 { return __last - __first >= 0; }
95 /** Can't test for a valid range with input iterators, because
96 * iteration may be destructive. So we just assume that the range
99 template<typename _InputIterator>
101 __valid_range_aux2(const _InputIterator&, const _InputIterator&,
102 std::input_iterator_tag)
105 /** We say that integral types for a valid range, and defer to other
106 * routines to realize what to do with integral types instead of
109 template<typename _Integral>
111 __valid_range_aux(const _Integral&, const _Integral&, std::__true_type)
114 /** We have iterators, so figure out what kind of iterators that are
115 * to see if we can check the range ahead of time.
117 template<typename _InputIterator>
119 __valid_range_aux(const _InputIterator& __first,
120 const _InputIterator& __last, std::__false_type)
122 typedef typename std::iterator_traits<_InputIterator>::iterator_category
124 return __valid_range_aux2(__first, __last, _Category());
127 /** Don't know what these iterators are, or if they are even
128 * iterators (we may get an integral type for InputIterator), so
129 * see if they are integral and pass them on to the next phase
132 template<typename _InputIterator>
134 __valid_range(const _InputIterator& __first, const _InputIterator& __last)
136 typedef typename std::__is_integer<_InputIterator>::__type _Integral;
137 return __valid_range_aux(__first, __last, _Integral());
140 /** Safe iterators know how to check if they form a valid range. */
141 template<typename _Iterator, typename _Sequence>
143 __valid_range(const _Safe_iterator<_Iterator, _Sequence>& __first,
144 const _Safe_iterator<_Iterator, _Sequence>& __last)
145 { return __first._M_valid_range(__last); }
147 /* Checks that [first, last) is a valid range, and then returns
148 * __first. This routine is useful when we can't use a separate
149 * assertion statement because, e.g., we are in a constructor.
151 template<typename _InputIterator>
152 inline _InputIterator
153 __check_valid_range(const _InputIterator& __first,
154 const _InputIterator& __last
155 __attribute__((__unused__)))
157 __glibcxx_check_valid_range(__first, __last);
161 /** Checks that __s is non-NULL or __n == 0, and then returns __s. */
162 template<typename _CharT, typename _Integer>
164 __check_string(const _CharT* __s,
165 const _Integer& __n __attribute__((__unused__)))
167 #ifdef _GLIBCXX_DEBUG_PEDANTIC
168 __glibcxx_assert(__s != 0 || __n == 0);
173 /** Checks that __s is non-NULL and then returns __s. */
174 template<typename _CharT>
176 __check_string(const _CharT* __s)
178 #ifdef _GLIBCXX_DEBUG_PEDANTIC
179 __glibcxx_assert(__s != 0);
184 // Can't check if an input iterator sequence is sorted, because we
185 // can't step through the sequence.
186 template<typename _InputIterator>
188 __check_sorted_aux(const _InputIterator&, const _InputIterator&,
189 std::input_iterator_tag)
192 // Can verify if a forward iterator sequence is in fact sorted using
194 template<typename _ForwardIterator>
196 __check_sorted_aux(_ForwardIterator __first, _ForwardIterator __last,
197 std::forward_iterator_tag)
199 if (__first == __last)
202 _ForwardIterator __next = __first;
203 for (++__next; __next != __last; __first = __next, ++__next)
204 if (*__next < *__first)
210 // Can't check if an input iterator sequence is sorted, because we can't step
211 // through the sequence.
212 template<typename _InputIterator, typename _Predicate>
214 __check_sorted_aux(const _InputIterator&, const _InputIterator&,
215 _Predicate, std::input_iterator_tag)
218 // Can verify if a forward iterator sequence is in fact sorted using
220 template<typename _ForwardIterator, typename _Predicate>
222 __check_sorted_aux(_ForwardIterator __first, _ForwardIterator __last,
223 _Predicate __pred, std::forward_iterator_tag)
225 if (__first == __last)
228 _ForwardIterator __next = __first;
229 for (++__next; __next != __last; __first = __next, ++__next)
230 if (__pred(*__next, *__first))
236 // Determine if a sequence is sorted.
237 template<typename _InputIterator>
239 __check_sorted(const _InputIterator& __first, const _InputIterator& __last)
241 typedef typename std::iterator_traits<_InputIterator>::iterator_category
244 // Verify that the < operator for elements in the sequence is a
245 // StrictWeakOrdering by checking that it is irreflexive.
246 __glibcxx_assert(__first == __last || !(*__first < *__first));
248 return __check_sorted_aux(__first, __last, _Category());
251 template<typename _InputIterator, typename _Predicate>
253 __check_sorted(const _InputIterator& __first, const _InputIterator& __last,
256 typedef typename std::iterator_traits<_InputIterator>::iterator_category
259 // Verify that the predicate is StrictWeakOrdering by checking that it
261 __glibcxx_assert(__first == __last || !__pred(*__first, *__first));
263 return __check_sorted_aux(__first, __last, __pred, _Category());
266 template<typename _InputIterator>
268 __check_sorted_set_aux(const _InputIterator& __first,
269 const _InputIterator& __last,
271 { return __check_sorted(__first, __last); }
273 template<typename _InputIterator>
275 __check_sorted_set_aux(const _InputIterator&,
276 const _InputIterator&,
280 template<typename _InputIterator, typename _Predicate>
282 __check_sorted_set_aux(const _InputIterator& __first,
283 const _InputIterator& __last,
284 _Predicate __pred, std::__true_type)
285 { return __check_sorted(__first, __last, __pred); }
287 template<typename _InputIterator, typename _Predicate>
289 __check_sorted_set_aux(const _InputIterator&,
290 const _InputIterator&, _Predicate,
294 // ... special variant used in std::merge, std::includes, std::set_*.
295 template<typename _InputIterator1, typename _InputIterator2>
297 __check_sorted_set(const _InputIterator1& __first,
298 const _InputIterator1& __last,
299 const _InputIterator2&)
301 typedef typename std::iterator_traits<_InputIterator1>::value_type
303 typedef typename std::iterator_traits<_InputIterator2>::value_type
306 typedef typename std::__are_same<_ValueType1, _ValueType2>::__type
308 return __check_sorted_set_aux(__first, __last, _SameType());
311 template<typename _InputIterator1, typename _InputIterator2,
314 __check_sorted_set(const _InputIterator1& __first,
315 const _InputIterator1& __last,
316 const _InputIterator2&, _Predicate __pred)
318 typedef typename std::iterator_traits<_InputIterator1>::value_type
320 typedef typename std::iterator_traits<_InputIterator2>::value_type
323 typedef typename std::__are_same<_ValueType1, _ValueType2>::__type
325 return __check_sorted_set_aux(__first, __last, __pred, _SameType());
328 // _GLIBCXX_RESOLVE_LIB_DEFECTS
329 // 270. Binary search requirements overly strict
330 // Determine if a sequence is partitioned w.r.t. this element.
331 template<typename _ForwardIterator, typename _Tp>
333 __check_partitioned_lower(_ForwardIterator __first,
334 _ForwardIterator __last, const _Tp& __value)
336 while (__first != __last && *__first < __value)
338 while (__first != __last && !(*__first < __value))
340 return __first == __last;
343 template<typename _ForwardIterator, typename _Tp>
345 __check_partitioned_upper(_ForwardIterator __first,
346 _ForwardIterator __last, const _Tp& __value)
348 while (__first != __last && !(__value < *__first))
350 while (__first != __last && __value < *__first)
352 return __first == __last;
355 // Determine if a sequence is partitioned w.r.t. this element.
356 template<typename _ForwardIterator, typename _Tp, typename _Pred>
358 __check_partitioned_lower(_ForwardIterator __first,
359 _ForwardIterator __last, const _Tp& __value,
362 while (__first != __last && bool(__pred(*__first, __value)))
364 while (__first != __last && !bool(__pred(*__first, __value)))
366 return __first == __last;
369 template<typename _ForwardIterator, typename _Tp, typename _Pred>
371 __check_partitioned_upper(_ForwardIterator __first,
372 _ForwardIterator __last, const _Tp& __value,
375 while (__first != __last && !bool(__pred(__value, *__first)))
377 while (__first != __last && bool(__pred(__value, *__first)))
379 return __first == __last;
381 } // namespace __gnu_debug