1 // Debugging support implementation -*- C++ -*-
3 // Copyright (C) 2003, 2005
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 #ifndef _GLIBCXX_DEBUG_FUNCTIONS_H
32 #define _GLIBCXX_DEBUG_FUNCTIONS_H 1
34 #include <bits/c++config.h>
35 #include <stddef.h> // for ptrdiff_t
36 #include <bits/stl_iterator_base_types.h> // for iterator_traits, categories
37 #include <bits/cpp_type_traits.h> // for __is_integer
43 template<typename _Iterator
, typename _Sequence
>
46 // An arbitrary iterator pointer is not singular.
48 __check_singular_aux(const void*) { return false; }
50 // We may have an iterator that derives from _Safe_iterator_base but isn't
52 template<typename _Iterator
>
54 __check_singular(_Iterator
& __x
)
55 { return __check_singular_aux(&__x
); }
57 /** Non-NULL pointers are nonsingular. */
58 template<typename _Tp
>
60 __check_singular(const _Tp
* __ptr
)
61 { return __ptr
== 0; }
63 /** Safe iterators know if they are singular. */
64 template<typename _Iterator
, typename _Sequence
>
66 __check_singular(const _Safe_iterator
<_Iterator
, _Sequence
>& __x
)
67 { return __x
._M_singular(); }
69 /** Assume that some arbitrary iterator is dereferenceable, because we
70 can't prove that it isn't. */
71 template<typename _Iterator
>
73 __check_dereferenceable(_Iterator
&)
76 /** Non-NULL pointers are dereferenceable. */
77 template<typename _Tp
>
79 __check_dereferenceable(const _Tp
* __ptr
)
82 /** Safe iterators know if they are singular. */
83 template<typename _Iterator
, typename _Sequence
>
85 __check_dereferenceable(const _Safe_iterator
<_Iterator
, _Sequence
>& __x
)
86 { return __x
._M_dereferenceable(); }
88 /** If the distance between two random access iterators is
89 * nonnegative, assume the range is valid.
91 template<typename _RandomAccessIterator
>
93 __valid_range_aux2(const _RandomAccessIterator
& __first
,
94 const _RandomAccessIterator
& __last
,
95 std::random_access_iterator_tag
)
96 { return __last
- __first
>= 0; }
98 /** Can't test for a valid range with input iterators, because
99 * iteration may be destructive. So we just assume that the range
102 template<typename _InputIterator
>
104 __valid_range_aux2(const _InputIterator
&, const _InputIterator
&,
105 std::input_iterator_tag
)
108 /** We say that integral types for a valid range, and defer to other
109 * routines to realize what to do with integral types instead of
112 template<typename _Integral
>
114 __valid_range_aux(const _Integral
&, const _Integral
&, __true_type
)
117 /** We have iterators, so figure out what kind of iterators that are
118 * to see if we can check the range ahead of time.
120 template<typename _InputIterator
>
122 __valid_range_aux(const _InputIterator
& __first
,
123 const _InputIterator
& __last
, __false_type
)
125 typedef typename
std::iterator_traits
<_InputIterator
>::iterator_category
127 return __valid_range_aux2(__first
, __last
, _Category());
130 /** Don't know what these iterators are, or if they are even
131 * iterators (we may get an integral type for InputIterator), so
132 * see if they are integral and pass them on to the next phase
135 template<typename _InputIterator
>
137 __valid_range(const _InputIterator
& __first
, const _InputIterator
& __last
)
139 typedef typename
std::__is_integer
<_InputIterator
>::__type _Integral
;
140 return __valid_range_aux(__first
, __last
, _Integral());
143 /** Safe iterators know how to check if they form a valid range. */
144 template<typename _Iterator
, typename _Sequence
>
146 __valid_range(const _Safe_iterator
<_Iterator
, _Sequence
>& __first
,
147 const _Safe_iterator
<_Iterator
, _Sequence
>& __last
)
148 { return __first
._M_valid_range(__last
); }
150 /* Checks that [first, last) is a valid range, and then returns
151 * __first. This routine is useful when we can't use a separate
152 * assertion statement because, e.g., we are in a constructor.
154 template<typename _InputIterator
>
155 inline _InputIterator
156 __check_valid_range(const _InputIterator
& __first
,
157 const _InputIterator
& __last
158 __attribute__((__unused__
)))
160 _GLIBCXX_DEBUG_ASSERT(__valid_range(__first
, __last
));
164 /** Checks that __s is non-NULL or __n == 0, and then returns __s. */
165 template<typename _CharT
, typename _Integer
>
167 __check_string(const _CharT
* __s
,
168 const _Integer
& __n
__attribute__((__unused__
)))
170 #ifdef _GLIBCXX_DEBUG_PEDANTIC
171 _GLIBCXX_DEBUG_ASSERT(__s
!= 0 || __n
== 0);
176 /** Checks that __s is non-NULL and then returns __s. */
177 template<typename _CharT
>
179 __check_string(const _CharT
* __s
)
181 #ifdef _GLIBCXX_DEBUG_PEDANTIC
182 _GLIBCXX_DEBUG_ASSERT(__s
!= 0);
187 // Can't check if an input iterator sequence is sorted, because we
188 // can't step through the sequence.
189 template<typename _InputIterator
>
191 __check_sorted_aux(const _InputIterator
&, const _InputIterator
&,
192 std::input_iterator_tag
)
195 // Can verify if a forward iterator sequence is in fact sorted using
197 template<typename _ForwardIterator
>
199 __check_sorted_aux(_ForwardIterator __first
, _ForwardIterator __last
,
200 std::forward_iterator_tag
)
202 if (__first
== __last
)
205 _ForwardIterator __next
= __first
;
206 for (++__next
; __next
!= __last
; __first
= __next
, ++__next
) {
207 if (*__next
< *__first
)
214 // Can't check if an input iterator sequence is sorted, because we can't step
215 // through the sequence.
216 template<typename _InputIterator
, typename _Predicate
>
218 __check_sorted_aux(const _InputIterator
&, const _InputIterator
&,
219 _Predicate
, std::input_iterator_tag
)
222 // Can verify if a forward iterator sequence is in fact sorted using
224 template<typename _ForwardIterator
, typename _Predicate
>
226 __check_sorted_aux(_ForwardIterator __first
, _ForwardIterator __last
,
227 _Predicate __pred
, std::forward_iterator_tag
)
229 if (__first
== __last
)
232 _ForwardIterator __next
= __first
;
233 for (++__next
; __next
!= __last
; __first
= __next
, ++__next
) {
234 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
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
258 return __check_sorted_aux(__first
, __last
, __pred
,
262 // _GLIBCXX_RESOLVE_LIB_DEFECTS
263 // 270. Binary search requirements overly strict
264 // Determine if a sequence is partitioned w.r.t. this element.
265 template<typename _ForwardIterator
, typename _Tp
>
267 __check_partitioned(_ForwardIterator __first
, _ForwardIterator __last
,
270 while (__first
!= __last
&& *__first
< __value
)
272 while (__first
!= __last
&& !(*__first
< __value
))
274 return __first
== __last
;
277 // Determine if a sequence is partitioned w.r.t. this element.
278 template<typename _ForwardIterator
, typename _Tp
, typename _Pred
>
280 __check_partitioned(_ForwardIterator __first
, _ForwardIterator __last
,
281 const _Tp
& __value
, _Pred __pred
)
283 while (__first
!= __last
&& __pred(*__first
, __value
))
285 while (__first
!= __last
&& !__pred(*__first
, __value
))
287 return __first
== __last
;
289 } // namespace __gnu_debug