* xcoff.c (struct xcoff_line, struct xcoff_line_vector): Remove.
[official-gcc.git] / libstdc++-v3 / include / debug / macros.h
blob44f48b04b181b35709f3e57a94e96ee8cd69128e
1 // Debugging support implementation -*- C++ -*-
3 // Copyright (C) 2003-2018 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.
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.
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.
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/>.
25 /** @file debug/macros.h
26 * This file is a GNU debug extension to the Standard C++ Library.
29 #ifndef _GLIBCXX_DEBUG_MACROS_H
30 #define _GLIBCXX_DEBUG_MACROS_H 1
32 /**
33 * Macros used by the implementation to verify certain
34 * properties. These macros may only be used directly by the debug
35 * wrappers. Note that these are macros (instead of the more obviously
36 * @a correct choice of making them functions) because we need line and
37 * file information at the call site, to minimize the distance between
38 * the user error and where the error is reported.
41 #define _GLIBCXX_DEBUG_VERIFY_COND_AT(_Cond,_ErrMsg,_File,_Line,_Func) \
42 if (! (_Cond)) \
43 __gnu_debug::_Error_formatter::_S_at(_File, _Line, _Func) \
44 ._ErrMsg._M_error()
46 #define _GLIBCXX_DEBUG_VERIFY_AT_F(_Cond,_ErrMsg,_File,_Line,_Func) \
47 do \
48 { \
49 _GLIBCXX_DEBUG_VERIFY_COND_AT(_Cond,_ErrMsg,_File,_Line,_Func); \
50 } while (false)
52 #define _GLIBCXX_DEBUG_VERIFY_AT(_Cond,_ErrMsg,_File,_Line) \
53 _GLIBCXX_DEBUG_VERIFY_AT_F(_Cond,_ErrMsg,_File,_Line,__PRETTY_FUNCTION__)
55 #define _GLIBCXX_DEBUG_VERIFY(_Cond,_ErrMsg) \
56 _GLIBCXX_DEBUG_VERIFY_AT_F(_Cond, _ErrMsg, __FILE__, __LINE__, \
57 __PRETTY_FUNCTION__)
59 // Verify that [_First, _Last) forms a valid iterator range.
60 #define __glibcxx_check_valid_range(_First,_Last) \
61 _GLIBCXX_DEBUG_VERIFY(__gnu_debug::__valid_range(_First, _Last), \
62 _M_message(__gnu_debug::__msg_valid_range) \
63 ._M_iterator(_First, #_First) \
64 ._M_iterator(_Last, #_Last))
66 #define __glibcxx_check_valid_range_at(_First,_Last,_File,_Line,_Func) \
67 _GLIBCXX_DEBUG_VERIFY_AT_F(__gnu_debug::__valid_range(_First, _Last), \
68 _M_message(__gnu_debug::__msg_valid_range) \
69 ._M_iterator(_First, #_First) \
70 ._M_iterator(_Last, #_Last), \
71 _File,_Line,_Func)
73 #define __glibcxx_check_valid_range2(_First,_Last,_Dist) \
74 _GLIBCXX_DEBUG_VERIFY(__gnu_debug::__valid_range(_First, _Last, _Dist), \
75 _M_message(__gnu_debug::__msg_valid_range) \
76 ._M_iterator(_First, #_First) \
77 ._M_iterator(_Last, #_Last))
79 #define __glibcxx_check_valid_constructor_range(_First,_Last) \
80 __gnu_debug::__check_valid_range(_First, _Last, \
81 __FILE__, __LINE__, __PRETTY_FUNCTION__)
83 // Verify that [_First, _Last) forms a non-empty iterator range.
84 #define __glibcxx_check_non_empty_range(_First,_Last) \
85 _GLIBCXX_DEBUG_VERIFY(_First != _Last, \
86 _M_message(__gnu_debug::__msg_non_empty_range) \
87 ._M_iterator(_First, #_First) \
88 ._M_iterator(_Last, #_Last))
90 // Verify that [_First, _First + _Size) forms a valid range.
91 #define __glibcxx_check_can_increment(_First,_Size) \
92 _GLIBCXX_DEBUG_VERIFY(__gnu_debug::__can_advance(_First, _Size), \
93 _M_message(__gnu_debug::__msg_iter_subscript_oob) \
94 ._M_iterator(_First, #_First) \
95 ._M_integer(_Size, #_Size))
97 #define __glibcxx_check_can_increment_range(_First1,_Last1,_First2) \
98 do \
99 { \
100 typename __gnu_debug::_Distance_traits<__decltype(_First1)>::__type __dist;\
101 _GLIBCXX_DEBUG_VERIFY_COND_AT( \
102 __gnu_debug::__valid_range(_First1, _Last1, __dist),\
103 _M_message(__gnu_debug::__msg_valid_range) \
104 ._M_iterator(_First1, #_First1) \
105 ._M_iterator(_Last1, #_Last1), \
106 __FILE__,__LINE__,__PRETTY_FUNCTION__); \
107 _GLIBCXX_DEBUG_VERIFY_COND_AT( \
108 __gnu_debug::__can_advance(_First2, __dist.first),\
109 _M_message(__gnu_debug::__msg_iter_subscript_oob)\
110 ._M_iterator(_First2, #_First2) \
111 ._M_integer(__dist.first), \
112 __FILE__,__LINE__,__PRETTY_FUNCTION__); \
113 } while(false)
115 #define __glibcxx_check_can_decrement_range(_First1,_Last1,_First2) \
116 do \
118 typename __gnu_debug::_Distance_traits<__decltype(_First1)>::__type __dist;\
119 _GLIBCXX_DEBUG_VERIFY_COND_AT( \
120 __gnu_debug::__valid_range(_First1, _Last1, __dist),\
121 _M_message(__gnu_debug::__msg_valid_range) \
122 ._M_iterator(_First1, #_First1) \
123 ._M_iterator(_Last1, #_Last1), \
124 __FILE__,__LINE__,__PRETTY_FUNCTION__); \
125 _GLIBCXX_DEBUG_VERIFY_COND_AT( \
126 __gnu_debug::__can_advance(_First2, -__dist.first),\
127 _M_message(__gnu_debug::__msg_iter_subscript_oob)\
128 ._M_iterator(_First2, #_First2) \
129 ._M_integer(-__dist.first), \
130 __FILE__,__LINE__,__PRETTY_FUNCTION__); \
131 } while(false)
133 /** Verify that we can insert into *this with the iterator _Position.
134 * Insertion into a container at a specific position requires that
135 * the iterator be nonsingular, either dereferenceable or past-the-end,
136 * and that it reference the sequence we are inserting into. Note that
137 * this macro is only valid when the container is a_Safe_sequence and
138 * the iterator is a _Safe_iterator.
140 #define __glibcxx_check_insert(_Position) \
141 _GLIBCXX_DEBUG_VERIFY(!_Position._M_singular(), \
142 _M_message(__gnu_debug::__msg_insert_singular) \
143 ._M_sequence(*this, "this") \
144 ._M_iterator(_Position, #_Position)); \
145 _GLIBCXX_DEBUG_VERIFY(_Position._M_attached_to(this), \
146 _M_message(__gnu_debug::__msg_insert_different) \
147 ._M_sequence(*this, "this") \
148 ._M_iterator(_Position, #_Position))
150 /** Verify that we can insert into *this after the iterator _Position.
151 * Insertion into a container after a specific position requires that
152 * the iterator be nonsingular, either dereferenceable or before-begin,
153 * and that it reference the sequence we are inserting into. Note that
154 * this macro is only valid when the container is a_Safe_sequence and
155 * the iterator is a _Safe_iterator.
157 #define __glibcxx_check_insert_after(_Position) \
158 __glibcxx_check_insert(_Position); \
159 _GLIBCXX_DEBUG_VERIFY(!_Position._M_is_end(), \
160 _M_message(__gnu_debug::__msg_insert_after_end) \
161 ._M_sequence(*this, "this") \
162 ._M_iterator(_Position, #_Position))
164 /** Verify that we can insert the values in the iterator range
165 * [_First, _Last) into *this with the iterator _Position. Insertion
166 * into a container at a specific position requires that the iterator
167 * be nonsingular (i.e., either dereferenceable or past-the-end),
168 * that it reference the sequence we are inserting into, and that the
169 * iterator range [_First, _Last) is a valid (possibly empty)
170 * range which does not reference the sequence we are inserting into.
171 * Note that this macro is only valid when the container is a
172 * _Safe_sequence and the _Position iterator is a _Safe_iterator.
174 #define __glibcxx_check_insert_range(_Position,_First,_Last,_Dist) \
175 __glibcxx_check_valid_range2(_First,_Last,_Dist); \
176 __glibcxx_check_insert(_Position); \
177 _GLIBCXX_DEBUG_VERIFY(__gnu_debug::__foreign_iterator(_Position,_First,_Last),\
178 _M_message(__gnu_debug::__msg_insert_range_from_self)\
179 ._M_iterator(_First, #_First) \
180 ._M_iterator(_Last, #_Last) \
181 ._M_sequence(*this, "this"))
183 /** Verify that we can insert the values in the iterator range
184 * [_First, _Last) into *this after the iterator _Position. Insertion
185 * into a container after a specific position requires that the iterator
186 * be nonsingular (i.e., either dereferenceable or past-the-end),
187 * that it reference the sequence we are inserting into, and that the
188 * iterator range [_First, _Last) is a valid (possibly empty)
189 * range which does not reference the sequence we are inserting into.
190 * Note that this macro is only valid when the container is a
191 * _Safe_sequence and the _Position iterator is a _Safe_iterator.
193 #define __glibcxx_check_insert_range_after(_Position,_First,_Last,_Dist)\
194 __glibcxx_check_valid_range2(_First,_Last,_Dist); \
195 __glibcxx_check_insert_after(_Position); \
196 _GLIBCXX_DEBUG_VERIFY(__gnu_debug::__foreign_iterator(_Position,_First,_Last),\
197 _M_message(__gnu_debug::__msg_insert_range_from_self)\
198 ._M_iterator(_First, #_First) \
199 ._M_iterator(_Last, #_Last) \
200 ._M_sequence(*this, "this"))
202 /** Verify that we can erase the element referenced by the iterator
203 * _Position. We can erase the element if the _Position iterator is
204 * dereferenceable and references this sequence.
206 #define __glibcxx_check_erase(_Position) \
207 _GLIBCXX_DEBUG_VERIFY(_Position._M_dereferenceable(), \
208 _M_message(__gnu_debug::__msg_erase_bad) \
209 ._M_sequence(*this, "this") \
210 ._M_iterator(_Position, #_Position)); \
211 _GLIBCXX_DEBUG_VERIFY(_Position._M_attached_to(this), \
212 _M_message(__gnu_debug::__msg_erase_different) \
213 ._M_sequence(*this, "this") \
214 ._M_iterator(_Position, #_Position))
216 /** Verify that we can erase the element after the iterator
217 * _Position. We can erase the element if the _Position iterator is
218 * before a dereferenceable one and references this sequence.
220 #define __glibcxx_check_erase_after(_Position) \
221 _GLIBCXX_DEBUG_VERIFY(_Position._M_before_dereferenceable(), \
222 _M_message(__gnu_debug::__msg_erase_after_bad) \
223 ._M_sequence(*this, "this") \
224 ._M_iterator(_Position, #_Position)); \
225 _GLIBCXX_DEBUG_VERIFY(_Position._M_attached_to(this), \
226 _M_message(__gnu_debug::__msg_erase_different) \
227 ._M_sequence(*this, "this") \
228 ._M_iterator(_Position, #_Position))
230 /** Verify that we can erase the elements in the iterator range
231 * [_First, _Last). We can erase the elements if [_First, _Last) is a
232 * valid iterator range within this sequence.
234 #define __glibcxx_check_erase_range(_First,_Last) \
235 __glibcxx_check_valid_range(_First,_Last); \
236 _GLIBCXX_DEBUG_VERIFY(_First._M_attached_to(this), \
237 _M_message(__gnu_debug::__msg_erase_different) \
238 ._M_sequence(*this, "this") \
239 ._M_iterator(_First, #_First) \
240 ._M_iterator(_Last, #_Last))
242 /** Verify that we can erase the elements in the iterator range
243 * (_First, _Last). We can erase the elements if (_First, _Last) is a
244 * valid iterator range within this sequence.
246 #define __glibcxx_check_erase_range_after(_First,_Last) \
247 _GLIBCXX_DEBUG_VERIFY(_First._M_can_compare(_Last), \
248 _M_message(__gnu_debug::__msg_erase_different) \
249 ._M_sequence(*this, "this") \
250 ._M_iterator(_First, #_First) \
251 ._M_iterator(_Last, #_Last)); \
252 _GLIBCXX_DEBUG_VERIFY(_First._M_attached_to(this), \
253 _M_message(__gnu_debug::__msg_erase_different) \
254 ._M_sequence(*this, "this") \
255 ._M_iterator(_First, #_First)); \
256 _GLIBCXX_DEBUG_VERIFY(_First != _Last, \
257 _M_message(__gnu_debug::__msg_valid_range2) \
258 ._M_sequence(*this, "this") \
259 ._M_iterator(_First, #_First) \
260 ._M_iterator(_Last, #_Last)); \
261 _GLIBCXX_DEBUG_VERIFY(_First._M_incrementable(), \
262 _M_message(__gnu_debug::__msg_valid_range2) \
263 ._M_sequence(*this, "this") \
264 ._M_iterator(_First, #_First) \
265 ._M_iterator(_Last, #_Last)); \
266 _GLIBCXX_DEBUG_VERIFY(!_Last._M_is_before_begin(), \
267 _M_message(__gnu_debug::__msg_valid_range2) \
268 ._M_sequence(*this, "this") \
269 ._M_iterator(_First, #_First) \
270 ._M_iterator(_Last, #_Last)) \
272 // Verify that the subscript _N is less than the container's size.
273 #define __glibcxx_check_subscript(_N) \
274 _GLIBCXX_DEBUG_VERIFY(_N < this->size(), \
275 _M_message(__gnu_debug::__msg_subscript_oob) \
276 ._M_sequence(*this, "this") \
277 ._M_integer(_N, #_N) \
278 ._M_integer(this->size(), "size"))
280 // Verify that the bucket _N is less than the container's buckets count.
281 #define __glibcxx_check_bucket_index(_N) \
282 _GLIBCXX_DEBUG_VERIFY(_N < this->bucket_count(), \
283 _M_message(__gnu_debug::__msg_bucket_index_oob) \
284 ._M_sequence(*this, "this") \
285 ._M_integer(_N, #_N) \
286 ._M_integer(this->bucket_count(), "size"))
288 // Verify that the container is nonempty
289 #define __glibcxx_check_nonempty() \
290 _GLIBCXX_DEBUG_VERIFY(! this->empty(), \
291 _M_message(__gnu_debug::__msg_empty) \
292 ._M_sequence(*this, "this"))
294 // Verify that the iterator range [_First, _Last) is sorted
295 #define __glibcxx_check_sorted(_First,_Last) \
296 __glibcxx_check_valid_range(_First,_Last); \
297 _GLIBCXX_DEBUG_VERIFY(__gnu_debug::__check_sorted( \
298 __gnu_debug::__base(_First), \
299 __gnu_debug::__base(_Last)), \
300 _M_message(__gnu_debug::__msg_unsorted) \
301 ._M_iterator(_First, #_First) \
302 ._M_iterator(_Last, #_Last))
304 /** Verify that the iterator range [_First, _Last) is sorted by the
305 predicate _Pred. */
306 #define __glibcxx_check_sorted_pred(_First,_Last,_Pred) \
307 __glibcxx_check_valid_range(_First,_Last); \
308 _GLIBCXX_DEBUG_VERIFY(__gnu_debug::__check_sorted( \
309 __gnu_debug::__base(_First), \
310 __gnu_debug::__base(_Last), _Pred), \
311 _M_message(__gnu_debug::__msg_unsorted_pred) \
312 ._M_iterator(_First, #_First) \
313 ._M_iterator(_Last, #_Last) \
314 ._M_string(#_Pred))
316 // Special variant for std::merge, std::includes, std::set_*
317 #define __glibcxx_check_sorted_set(_First1,_Last1,_First2) \
318 __glibcxx_check_valid_range(_First1,_Last1); \
319 _GLIBCXX_DEBUG_VERIFY( \
320 __gnu_debug::__check_sorted_set(__gnu_debug::__base(_First1), \
321 __gnu_debug::__base(_Last1), _First2),\
322 _M_message(__gnu_debug::__msg_unsorted) \
323 ._M_iterator(_First1, #_First1) \
324 ._M_iterator(_Last1, #_Last1))
326 // Likewise with a _Pred.
327 #define __glibcxx_check_sorted_set_pred(_First1,_Last1,_First2,_Pred) \
328 __glibcxx_check_valid_range(_First1,_Last1); \
329 _GLIBCXX_DEBUG_VERIFY( \
330 __gnu_debug::__check_sorted_set(__gnu_debug::__base(_First1), \
331 __gnu_debug::__base(_Last1), \
332 _First2, _Pred), \
333 _M_message(__gnu_debug::__msg_unsorted_pred) \
334 ._M_iterator(_First1, #_First1) \
335 ._M_iterator(_Last1, #_Last1) \
336 ._M_string(#_Pred))
338 /** Verify that the iterator range [_First, _Last) is partitioned
339 w.r.t. the value _Value. */
340 #define __glibcxx_check_partitioned_lower(_First,_Last,_Value) \
341 __glibcxx_check_valid_range(_First,_Last); \
342 _GLIBCXX_DEBUG_VERIFY(__gnu_debug::__check_partitioned_lower( \
343 __gnu_debug::__base(_First), \
344 __gnu_debug::__base(_Last), _Value), \
345 _M_message(__gnu_debug::__msg_unpartitioned) \
346 ._M_iterator(_First, #_First) \
347 ._M_iterator(_Last, #_Last) \
348 ._M_string(#_Value))
350 #define __glibcxx_check_partitioned_upper(_First,_Last,_Value) \
351 __glibcxx_check_valid_range(_First,_Last); \
352 _GLIBCXX_DEBUG_VERIFY(__gnu_debug::__check_partitioned_upper( \
353 __gnu_debug::__base(_First), \
354 __gnu_debug::__base(_Last), _Value), \
355 _M_message(__gnu_debug::__msg_unpartitioned) \
356 ._M_iterator(_First, #_First) \
357 ._M_iterator(_Last, #_Last) \
358 ._M_string(#_Value))
360 /** Verify that the iterator range [_First, _Last) is partitioned
361 w.r.t. the value _Value and predicate _Pred. */
362 #define __glibcxx_check_partitioned_lower_pred(_First,_Last,_Value,_Pred) \
363 __glibcxx_check_valid_range(_First,_Last); \
364 _GLIBCXX_DEBUG_VERIFY(__gnu_debug::__check_partitioned_lower( \
365 __gnu_debug::__base(_First), \
366 __gnu_debug::__base(_Last), _Value, _Pred), \
367 _M_message(__gnu_debug::__msg_unpartitioned_pred) \
368 ._M_iterator(_First, #_First) \
369 ._M_iterator(_Last, #_Last) \
370 ._M_string(#_Pred) \
371 ._M_string(#_Value))
373 /** Verify that the iterator range [_First, _Last) is partitioned
374 w.r.t. the value _Value and predicate _Pred. */
375 #define __glibcxx_check_partitioned_upper_pred(_First,_Last,_Value,_Pred) \
376 __glibcxx_check_valid_range(_First,_Last); \
377 _GLIBCXX_DEBUG_VERIFY(__gnu_debug::__check_partitioned_upper( \
378 __gnu_debug::__base(_First), \
379 __gnu_debug::__base(_Last), _Value, _Pred), \
380 _M_message(__gnu_debug::__msg_unpartitioned_pred) \
381 ._M_iterator(_First, #_First) \
382 ._M_iterator(_Last, #_Last) \
383 ._M_string(#_Pred) \
384 ._M_string(#_Value))
386 // Verify that the iterator range [_First, _Last) is a heap
387 #define __glibcxx_check_heap(_First,_Last) \
388 _GLIBCXX_DEBUG_VERIFY(std::__is_heap(__gnu_debug::__base(_First), \
389 __gnu_debug::__base(_Last)), \
390 _M_message(__gnu_debug::__msg_not_heap) \
391 ._M_iterator(_First, #_First) \
392 ._M_iterator(_Last, #_Last))
394 /** Verify that the iterator range [_First, _Last) is a heap
395 w.r.t. the predicate _Pred. */
396 #define __glibcxx_check_heap_pred(_First,_Last,_Pred) \
397 _GLIBCXX_DEBUG_VERIFY(std::__is_heap(__gnu_debug::__base(_First), \
398 __gnu_debug::__base(_Last), \
399 _Pred), \
400 _M_message(__gnu_debug::__msg_not_heap_pred) \
401 ._M_iterator(_First, #_First) \
402 ._M_iterator(_Last, #_Last) \
403 ._M_string(#_Pred))
405 // Verify that the container is not self move assigned
406 #define __glibcxx_check_self_move_assign(_Other) \
407 _GLIBCXX_DEBUG_VERIFY(this != &_Other, \
408 _M_message(__gnu_debug::__msg_self_move_assign) \
409 ._M_sequence(*this, "this"))
411 // Verify that load factor is positive
412 #define __glibcxx_check_max_load_factor(_F) \
413 _GLIBCXX_DEBUG_VERIFY(_F > 0.0f, \
414 _M_message(__gnu_debug::__msg_valid_load_factor) \
415 ._M_sequence(*this, "this"))
417 #define __glibcxx_check_equal_allocs(_This, _Other) \
418 _GLIBCXX_DEBUG_VERIFY(_This.get_allocator() == _Other.get_allocator(), \
419 _M_message(__gnu_debug::__msg_equal_allocs) \
420 ._M_sequence(_This, "this"))
422 #define __glibcxx_check_string(_String) _GLIBCXX_DEBUG_PEDASSERT(_String != 0)
423 #define __glibcxx_check_string_len(_String,_Len) \
424 _GLIBCXX_DEBUG_PEDASSERT(_String != 0 || _Len == 0)
426 // Verify that a predicate is irreflexive
427 #define __glibcxx_check_irreflexive(_First,_Last) \
428 _GLIBCXX_DEBUG_VERIFY(_First == _Last || !(*_First < *_First), \
429 _M_message(__gnu_debug::__msg_irreflexive_ordering) \
430 ._M_iterator_value_type(_First, "< operator type"))
432 #if __cplusplus >= 201103L
433 # define __glibcxx_check_irreflexive2(_First,_Last) \
434 _GLIBCXX_DEBUG_VERIFY(_First == _Last \
435 || __gnu_debug::__is_irreflexive(_First), \
436 _M_message(__gnu_debug::__msg_irreflexive_ordering) \
437 ._M_iterator_value_type(_First, "< operator type"))
438 #else
439 # define __glibcxx_check_irreflexive2(_First,_Last)
440 #endif
442 #define __glibcxx_check_irreflexive_pred(_First,_Last,_Pred) \
443 _GLIBCXX_DEBUG_VERIFY(_First == _Last || !_Pred(*_First, *_First), \
444 _M_message(__gnu_debug::__msg_irreflexive_ordering) \
445 ._M_instance(_Pred, "functor") \
446 ._M_iterator_value_type(_First, "ordered type"))
448 #if __cplusplus >= 201103L
449 # define __glibcxx_check_irreflexive_pred2(_First,_Last,_Pred) \
450 _GLIBCXX_DEBUG_VERIFY(_First == _Last \
451 ||__gnu_debug::__is_irreflexive_pred(_First, _Pred), \
452 _M_message(__gnu_debug::__msg_irreflexive_ordering) \
453 ._M_instance(_Pred, "functor") \
454 ._M_iterator_value_type(_First, "ordered type"))
455 #else
456 # define __glibcxx_check_irreflexive_pred2(_First,_Last,_Pred)
457 #endif
459 #endif