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 <stddef.h> // for ptrdiff_t
35 #include <bits/stl_iterator_base_types.h> // for iterator_traits, categories
36 #include <bits/cpp_type_traits.h> // for __is_integer
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 __gnu_debug::__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
&, __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
, __false_type
)
122 typedef typename
std::iterator_traits
<_InputIterator
>::iterator_category
124 return __gnu_debug::__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 __gnu_debug::__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
)
156 _GLIBCXX_DEBUG_ASSERT(__gnu_debug::__valid_range(__first
, __last
));
160 /** Checks that __s is non-NULL or __n == 0, and then returns __s. */
161 template<typename _CharT
, typename _Integer
>
163 __check_string(const _CharT
* __s
, const _Integer
& __n
)
165 #ifdef _GLIBCXX_DEBUG_PEDANTIC
166 _GLIBCXX_DEBUG_ASSERT(__s
!= 0 || __n
== 0);
171 /** Checks that __s is non-NULL and then returns __s. */
172 template<typename _CharT
>
174 __check_string(const _CharT
* __s
)
176 #ifdef _GLIBCXX_DEBUG_PEDANTIC
177 _GLIBCXX_DEBUG_ASSERT(__s
!= 0);
182 // Can't check if an input iterator sequence is sorted, because we
183 // can't step through the sequence.
184 template<typename _InputIterator
>
186 __check_sorted_aux(const _InputIterator
&, const _InputIterator
&,
187 std::input_iterator_tag
)
190 // Can verify if a forward iterator sequence is in fact sorted using
192 template<typename _ForwardIterator
>
194 __check_sorted_aux(_ForwardIterator __first
, _ForwardIterator __last
,
195 std::forward_iterator_tag
)
197 if (__first
== __last
)
200 _ForwardIterator __next
= __first
;
201 for (++__next
; __next
!= __last
; __first
= __next
, ++__next
) {
202 if (*__next
< *__first
)
209 // Can't check if an input iterator sequence is sorted, because we can't step
210 // through the sequence.
211 template<typename _InputIterator
, typename _Predicate
>
213 __check_sorted_aux(const _InputIterator
&, const _InputIterator
&,
214 _Predicate
, std::input_iterator_tag
)
217 // Can verify if a forward iterator sequence is in fact sorted using
219 template<typename _ForwardIterator
, typename _Predicate
>
221 __check_sorted_aux(_ForwardIterator __first
, _ForwardIterator __last
,
222 _Predicate __pred
, std::forward_iterator_tag
)
224 if (__first
== __last
)
227 _ForwardIterator __next
= __first
;
228 for (++__next
; __next
!= __last
; __first
= __next
, ++__next
) {
229 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
243 return __gnu_debug::__check_sorted_aux(__first
, __last
, _Category());
246 template<typename _InputIterator
, typename _Predicate
>
248 __check_sorted(const _InputIterator
& __first
, const _InputIterator
& __last
,
251 typedef typename
std::iterator_traits
<_InputIterator
>::iterator_category
253 return __gnu_debug::__check_sorted_aux(__first
, __last
, __pred
,
257 // _GLIBCXX_RESOLVE_LIB_DEFECTS
258 // 270. Binary search requirements overly strict
259 // Determine if a sequence is partitioned w.r.t. this element.
260 template<typename _ForwardIterator
, typename _Tp
>
262 __check_partitioned(_ForwardIterator __first
, _ForwardIterator __last
,
265 while (__first
!= __last
&& *__first
< __value
)
267 while (__first
!= __last
&& !(*__first
< __value
))
269 return __first
== __last
;
272 // Determine if a sequence is partitioned w.r.t. this element.
273 template<typename _ForwardIterator
, typename _Tp
, typename _Pred
>
275 __check_partitioned(_ForwardIterator __first
, _ForwardIterator __last
,
276 const _Tp
& __value
, _Pred __pred
)
278 while (__first
!= __last
&& __pred(*__first
, __value
))
280 while (__first
!= __last
&& !__pred(*__first
, __value
))
282 return __first
== __last
;
284 } // namespace __gnu_debug