1 // Debugging support implementation -*- C++ -*-
3 // Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008
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 2, 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 // You should have received a copy of the GNU General Public License along
18 // with this library; see the file COPYING. If not, write to the Free
19 // Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
22 // As a special exception, you may use this file as part of a free software
23 // library without restriction. Specifically, if other files instantiate
24 // templates or use macros or inline functions from this file, or you compile
25 // this file and link it with other files to produce an executable, this
26 // file does not by itself cause the resulting executable to be covered by
27 // the GNU General Public License. This exception does not however
28 // invalidate any other reasons why the executable file might be covered by
29 // the GNU General Public License.
31 /** @file debug/functions.h
32 * This file is a GNU debug extension to the Standard C++ Library.
35 #ifndef _GLIBCXX_DEBUG_FUNCTIONS_H
36 #define _GLIBCXX_DEBUG_FUNCTIONS_H 1
38 #include <bits/c++config.h>
39 #include <cstddef> // for ptrdiff_t
40 #include <bits/stl_iterator_base_types.h> // for iterator_traits, categories
41 #include <bits/cpp_type_traits.h> // for __is_integer
45 template<typename _Iterator
, typename _Sequence
>
48 // An arbitrary iterator pointer is not singular.
50 __check_singular_aux(const void*) { return false; }
52 // We may have an iterator that derives from _Safe_iterator_base but isn't
54 template<typename _Iterator
>
56 __check_singular(_Iterator
& __x
)
57 { return __check_singular_aux(&__x
); }
59 /** Non-NULL pointers are nonsingular. */
60 template<typename _Tp
>
62 __check_singular(const _Tp
* __ptr
)
63 { return __ptr
== 0; }
65 /** Safe iterators know if they are singular. */
66 template<typename _Iterator
, typename _Sequence
>
68 __check_singular(const _Safe_iterator
<_Iterator
, _Sequence
>& __x
)
69 { return __x
._M_singular(); }
71 /** Assume that some arbitrary iterator is dereferenceable, because we
72 can't prove that it isn't. */
73 template<typename _Iterator
>
75 __check_dereferenceable(_Iterator
&)
78 /** Non-NULL pointers are dereferenceable. */
79 template<typename _Tp
>
81 __check_dereferenceable(const _Tp
* __ptr
)
84 /** Safe iterators know if they are singular. */
85 template<typename _Iterator
, typename _Sequence
>
87 __check_dereferenceable(const _Safe_iterator
<_Iterator
, _Sequence
>& __x
)
88 { return __x
._M_dereferenceable(); }
90 /** If the distance between two random access iterators is
91 * nonnegative, assume the range is valid.
93 template<typename _RandomAccessIterator
>
95 __valid_range_aux2(const _RandomAccessIterator
& __first
,
96 const _RandomAccessIterator
& __last
,
97 std::random_access_iterator_tag
)
98 { return __last
- __first
>= 0; }
100 /** Can't test for a valid range with input iterators, because
101 * iteration may be destructive. So we just assume that the range
104 template<typename _InputIterator
>
106 __valid_range_aux2(const _InputIterator
&, const _InputIterator
&,
107 std::input_iterator_tag
)
110 /** We say that integral types for a valid range, and defer to other
111 * routines to realize what to do with integral types instead of
114 template<typename _Integral
>
116 __valid_range_aux(const _Integral
&, const _Integral
&, std::__true_type
)
119 /** We have iterators, so figure out what kind of iterators that are
120 * to see if we can check the range ahead of time.
122 template<typename _InputIterator
>
124 __valid_range_aux(const _InputIterator
& __first
,
125 const _InputIterator
& __last
, std::__false_type
)
127 typedef typename
std::iterator_traits
<_InputIterator
>::iterator_category
129 return __valid_range_aux2(__first
, __last
, _Category());
132 /** Don't know what these iterators are, or if they are even
133 * iterators (we may get an integral type for InputIterator), so
134 * see if they are integral and pass them on to the next phase
137 template<typename _InputIterator
>
139 __valid_range(const _InputIterator
& __first
, const _InputIterator
& __last
)
141 typedef typename
std::__is_integer
<_InputIterator
>::__type _Integral
;
142 return __valid_range_aux(__first
, __last
, _Integral());
145 /** Safe iterators know how to check if they form a valid range. */
146 template<typename _Iterator
, typename _Sequence
>
148 __valid_range(const _Safe_iterator
<_Iterator
, _Sequence
>& __first
,
149 const _Safe_iterator
<_Iterator
, _Sequence
>& __last
)
150 { return __first
._M_valid_range(__last
); }
152 /* Checks that [first, last) is a valid range, and then returns
153 * __first. This routine is useful when we can't use a separate
154 * assertion statement because, e.g., we are in a constructor.
156 template<typename _InputIterator
>
157 inline _InputIterator
158 __check_valid_range(const _InputIterator
& __first
,
159 const _InputIterator
& __last
160 __attribute__((__unused__
)))
162 _GLIBCXX_DEBUG_ASSERT(__valid_range(__first
, __last
));
166 /** Checks that __s is non-NULL or __n == 0, and then returns __s. */
167 template<typename _CharT
, typename _Integer
>
169 __check_string(const _CharT
* __s
,
170 const _Integer
& __n
__attribute__((__unused__
)))
172 #ifdef _GLIBCXX_DEBUG_PEDANTIC
173 _GLIBCXX_DEBUG_ASSERT(__s
!= 0 || __n
== 0);
178 /** Checks that __s is non-NULL and then returns __s. */
179 template<typename _CharT
>
181 __check_string(const _CharT
* __s
)
183 #ifdef _GLIBCXX_DEBUG_PEDANTIC
184 _GLIBCXX_DEBUG_ASSERT(__s
!= 0);
189 // Can't check if an input iterator sequence is sorted, because we
190 // can't step through the sequence.
191 template<typename _InputIterator
>
193 __check_sorted_aux(const _InputIterator
&, const _InputIterator
&,
194 std::input_iterator_tag
)
197 // Can verify if a forward iterator sequence is in fact sorted using
199 template<typename _ForwardIterator
>
201 __check_sorted_aux(_ForwardIterator __first
, _ForwardIterator __last
,
202 std::forward_iterator_tag
)
204 if (__first
== __last
)
207 _ForwardIterator __next
= __first
;
208 for (++__next
; __next
!= __last
; __first
= __next
, ++__next
)
209 if (*__next
< *__first
)
215 // Can't check if an input iterator sequence is sorted, because we can't step
216 // through the sequence.
217 template<typename _InputIterator
, typename _Predicate
>
219 __check_sorted_aux(const _InputIterator
&, const _InputIterator
&,
220 _Predicate
, std::input_iterator_tag
)
223 // Can verify if a forward iterator sequence is in fact sorted using
225 template<typename _ForwardIterator
, typename _Predicate
>
227 __check_sorted_aux(_ForwardIterator __first
, _ForwardIterator __last
,
228 _Predicate __pred
, std::forward_iterator_tag
)
230 if (__first
== __last
)
233 _ForwardIterator __next
= __first
;
234 for (++__next
; __next
!= __last
; __first
= __next
, ++__next
)
235 if (__pred(*__next
, *__first
))
241 // Determine if a sequence is sorted.
242 template<typename _InputIterator
>
244 __check_sorted(const _InputIterator
& __first
, const _InputIterator
& __last
)
246 typedef typename
std::iterator_traits
<_InputIterator
>::iterator_category
249 // Verify that the < operator for elements in the sequence is a
250 // StrictWeakOrdering by checking that it is irreflexive.
251 _GLIBCXX_DEBUG_ASSERT(__first
== __last
|| !(*__first
< *__first
));
253 return __check_sorted_aux(__first
, __last
, _Category());
256 template<typename _InputIterator
, typename _Predicate
>
258 __check_sorted(const _InputIterator
& __first
, const _InputIterator
& __last
,
261 typedef typename
std::iterator_traits
<_InputIterator
>::iterator_category
264 // Verify that the predicate is StrictWeakOrdering by checking that it
266 _GLIBCXX_DEBUG_ASSERT(__first
== __last
|| !__pred(*__first
, *__first
));
268 return __check_sorted_aux(__first
, __last
, __pred
, _Category());
271 template<typename _InputIterator
>
273 __check_sorted_set_aux(const _InputIterator
& __first
,
274 const _InputIterator
& __last
,
276 { return __check_sorted(__first
, __last
); }
278 template<typename _InputIterator
>
280 __check_sorted_set_aux(const _InputIterator
&,
281 const _InputIterator
&,
285 template<typename _InputIterator
, typename _Predicate
>
287 __check_sorted_set_aux(const _InputIterator
& __first
,
288 const _InputIterator
& __last
,
289 _Predicate __pred
, std::__true_type
)
290 { return __check_sorted(__first
, __last
, __pred
); }
292 template<typename _InputIterator
, typename _Predicate
>
294 __check_sorted_set_aux(const _InputIterator
&,
295 const _InputIterator
&, _Predicate
,
299 // ... special variant used in std::merge, std::includes, std::set_*.
300 template<typename _InputIterator1
, typename _InputIterator2
>
302 __check_sorted_set(const _InputIterator1
& __first
,
303 const _InputIterator1
& __last
,
304 const _InputIterator2
&)
306 typedef typename
std::iterator_traits
<_InputIterator1
>::value_type
308 typedef typename
std::iterator_traits
<_InputIterator2
>::value_type
311 typedef typename
std::__are_same
<_ValueType1
, _ValueType2
>::__type
313 return __check_sorted_set_aux(__first
, __last
, _SameType());
316 template<typename _InputIterator1
, typename _InputIterator2
,
319 __check_sorted_set(const _InputIterator1
& __first
,
320 const _InputIterator1
& __last
,
321 const _InputIterator2
&, _Predicate __pred
)
323 typedef typename
std::iterator_traits
<_InputIterator1
>::value_type
325 typedef typename
std::iterator_traits
<_InputIterator2
>::value_type
328 typedef typename
std::__are_same
<_ValueType1
, _ValueType2
>::__type
330 return __check_sorted_set_aux(__first
, __last
, __pred
, _SameType());
333 // _GLIBCXX_RESOLVE_LIB_DEFECTS
334 // 270. Binary search requirements overly strict
335 // Determine if a sequence is partitioned w.r.t. this element.
336 template<typename _ForwardIterator
, typename _Tp
>
338 __check_partitioned_lower(_ForwardIterator __first
,
339 _ForwardIterator __last
, const _Tp
& __value
)
341 while (__first
!= __last
&& *__first
< __value
)
343 while (__first
!= __last
&& !(*__first
< __value
))
345 return __first
== __last
;
348 template<typename _ForwardIterator
, typename _Tp
>
350 __check_partitioned_upper(_ForwardIterator __first
,
351 _ForwardIterator __last
, const _Tp
& __value
)
353 while (__first
!= __last
&& !(__value
< *__first
))
355 while (__first
!= __last
&& __value
< *__first
)
357 return __first
== __last
;
360 // Determine if a sequence is partitioned w.r.t. this element.
361 template<typename _ForwardIterator
, typename _Tp
, typename _Pred
>
363 __check_partitioned_lower(_ForwardIterator __first
,
364 _ForwardIterator __last
, const _Tp
& __value
,
367 while (__first
!= __last
&& bool(__pred(*__first
, __value
)))
369 while (__first
!= __last
&& !bool(__pred(*__first
, __value
)))
371 return __first
== __last
;
374 template<typename _ForwardIterator
, typename _Tp
, typename _Pred
>
376 __check_partitioned_upper(_ForwardIterator __first
,
377 _ForwardIterator __last
, const _Tp
& __value
,
380 while (__first
!= __last
&& !bool(__pred(__value
, *__first
)))
382 while (__first
!= __last
&& bool(__pred(__value
, *__first
)))
384 return __first
== __last
;
386 } // namespace __gnu_debug