libstdc++
assertions.h
Go to the documentation of this file.
1 // Debugging support implementation -*- C++ -*-
2 
3 // Copyright (C) 2003-2025 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.
10 
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.
15 
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.
19 
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/>.
24 
25 /** @file debug/assertions.h
26  * This file is a GNU debug extension to the Standard C++ Library.
27  */
28 
29 #ifndef _GLIBCXX_DEBUG_ASSERTIONS_H
30 #define _GLIBCXX_DEBUG_ASSERTIONS_H 1
31 
32 #include <bits/c++config.h>
33 
34 #ifndef _GLIBCXX_DEBUG
35 // Verify that [_First, _Last) forms a non-empty iterator range.
36 # define __glibcxx_requires_non_empty_range(_First,_Last) \
37  __glibcxx_assert(_First != _Last)
38 # define __glibcxx_requires_subscript(_N) \
39  __glibcxx_assert(_N < this->size())
40 // Verify that the container is nonempty
41 # define __glibcxx_requires_nonempty() \
42  __glibcxx_assert(!this->empty())
43 #else // Use the more verbose Debug Mode checks.
44 # define __glibcxx_requires_non_empty_range(_First,_Last) \
45  __glibcxx_check_non_empty_range(_First,_Last)
46 # define __glibcxx_requires_nonempty() \
47  __glibcxx_check_nonempty()
48 # define __glibcxx_requires_subscript(_N) \
49  __glibcxx_check_subscript(_N)
50 #endif
51 
52 #if defined _GLIBCXX_DEBUG && _GLIBCXX_HOSTED
53 
54 # define _GLIBCXX_DEBUG_ASSERT(_Condition) __glibcxx_assert(_Condition)
55 
56 # ifdef _GLIBCXX_DEBUG_PEDANTIC
57 # define _GLIBCXX_DEBUG_PEDASSERT(_Condition) _GLIBCXX_DEBUG_ASSERT(_Condition)
58 # else
59 # define _GLIBCXX_DEBUG_PEDASSERT(_Condition)
60 # endif
61 
62 # define _GLIBCXX_DEBUG_ONLY(_Statement) _Statement
63 
64 #else
65 # define _GLIBCXX_DEBUG_ASSERT(_Condition)
66 # define _GLIBCXX_DEBUG_PEDASSERT(_Condition)
67 # define _GLIBCXX_DEBUG_ONLY(_Statement)
68 #endif
69 
70 #endif // _GLIBCXX_DEBUG_ASSERTIONS