1// Debugging support implementation -*- C++ -*-
2
3// Copyright (C) 2003-2016 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/debug.h
26 * This file is a GNU debug extension to the Standard C++ Library.
27 */
28
29#ifndef _GLIBCXX_DEBUG_MACRO_SWITCH_H
30#define _GLIBCXX_DEBUG_MACRO_SWITCH_H 1
31
32/** Macros and namespaces used by the implementation outside of debug
33 * wrappers to verify certain properties. The __glibcxx_requires_xxx
34 * macros are merely wrappers around the __glibcxx_check_xxx wrappers
35 * when we are compiling with debug mode, but disappear when we are
36 * in release mode so that there is no checking performed in, e.g.,
37 * the standard library algorithms.
38*/
39
40#include <debug/assertions.h>
41
42// Debug mode namespaces.
43
44/**
45 * @namespace std::__debug
46 * @brief GNU debug code, replaces standard behavior with debug behavior.
47 */
48namespace std
49{
50 namespace __debug { }
51}
52
53/** @namespace __gnu_debug
54 * @brief GNU debug classes for public use.
55*/
56namespace __gnu_debug
57{
58 using namespace std::__debug;
59}
60
61#ifndef _GLIBCXX_DEBUG
62
63# define __glibcxx_requires_cond(_Cond,_Msg)
64# define __glibcxx_requires_valid_range(_First,_Last)
65# define __glibcxx_requires_sorted(_First,_Last)
66# define __glibcxx_requires_sorted_pred(_First,_Last,_Pred)
67# define __glibcxx_requires_sorted_set(_First1,_Last1,_First2)
68# define __glibcxx_requires_sorted_set_pred(_First1,_Last1,_First2,_Pred)
69# define __glibcxx_requires_partitioned_lower(_First,_Last,_Value)
70# define __glibcxx_requires_partitioned_upper(_First,_Last,_Value)
71# define __glibcxx_requires_partitioned_lower_pred(_First,_Last,_Value,_Pred)
72# define __glibcxx_requires_partitioned_upper_pred(_First,_Last,_Value,_Pred)
73# define __glibcxx_requires_heap(_First,_Last)
74# define __glibcxx_requires_heap_pred(_First,_Last,_Pred)
75# define __glibcxx_requires_string(_String)
76# define __glibcxx_requires_string_len(_String,_Len)
77# define __glibcxx_requires_subscript(_N)
78# define __glibcxx_requires_irreflexive(_First,_Last)
79# define __glibcxx_requires_irreflexive2(_First,_Last)
80# define __glibcxx_requires_irreflexive_pred(_First,_Last,_Pred)
81# define __glibcxx_requires_irreflexive_pred2(_First,_Last,_Pred)
82
83#ifdef _GLIBCXX_ASSERTIONS
84// Verify that [_First, _Last) forms a non-empty iterator range.
85# define __glibcxx_requires_non_empty_range(_First,_Last) \
86 __glibcxx_assert(_First != _Last)
87// Verify that the container is nonempty
88# define __glibcxx_requires_nonempty() \
89 __glibcxx_assert(! this->empty())
90#else
91# define __glibcxx_requires_non_empty_range(_First,_Last)
92# define __glibcxx_requires_nonempty()
93#endif
94
95#else
96
97# include <debug/macros.h>
98
99# define __glibcxx_requires_cond(_Cond,_Msg) _GLIBCXX_DEBUG_VERIFY(_Cond,_Msg)
100# define __glibcxx_requires_valid_range(_First,_Last) \
101 __glibcxx_check_valid_range(_First,_Last)
102# define __glibcxx_requires_non_empty_range(_First,_Last) \
103 __glibcxx_check_non_empty_range(_First,_Last)
104# define __glibcxx_requires_sorted(_First,_Last) \
105 __glibcxx_check_sorted(_First,_Last)
106# define __glibcxx_requires_sorted_pred(_First,_Last,_Pred) \
107 __glibcxx_check_sorted_pred(_First,_Last,_Pred)
108# define __glibcxx_requires_sorted_set(_First1,_Last1,_First2) \
109 __glibcxx_check_sorted_set(_First1,_Last1,_First2)
110# define __glibcxx_requires_sorted_set_pred(_First1,_Last1,_First2,_Pred) \
111 __glibcxx_check_sorted_set_pred(_First1,_Last1,_First2,_Pred)
112# define __glibcxx_requires_partitioned_lower(_First,_Last,_Value) \
113 __glibcxx_check_partitioned_lower(_First,_Last,_Value)
114# define __glibcxx_requires_partitioned_upper(_First,_Last,_Value) \
115 __glibcxx_check_partitioned_upper(_First,_Last,_Value)
116# define __glibcxx_requires_partitioned_lower_pred(_First,_Last,_Value,_Pred) \
117 __glibcxx_check_partitioned_lower_pred(_First,_Last,_Value,_Pred)
118# define __glibcxx_requires_partitioned_upper_pred(_First,_Last,_Value,_Pred) \
119 __glibcxx_check_partitioned_upper_pred(_First,_Last,_Value,_Pred)
120# define __glibcxx_requires_heap(_First,_Last) \
121 __glibcxx_check_heap(_First,_Last)
122# define __glibcxx_requires_heap_pred(_First,_Last,_Pred) \
123 __glibcxx_check_heap_pred(_First,_Last,_Pred)
124# define __glibcxx_requires_nonempty() __glibcxx_check_nonempty()
125# define __glibcxx_requires_string(_String) __glibcxx_check_string(_String)
126# define __glibcxx_requires_string_len(_String,_Len) \
127 __glibcxx_check_string_len(_String,_Len)
128# define __glibcxx_requires_subscript(_N) __glibcxx_check_subscript(_N)
129# define __glibcxx_requires_irreflexive(_First,_Last) \
130 __glibcxx_check_irreflexive(_First,_Last)
131# define __glibcxx_requires_irreflexive2(_First,_Last) \
132 __glibcxx_check_irreflexive2(_First,_Last)
133# define __glibcxx_requires_irreflexive_pred(_First,_Last,_Pred) \
134 __glibcxx_check_irreflexive_pred(_First,_Last,_Pred)
135# define __glibcxx_requires_irreflexive_pred2(_First,_Last,_Pred) \
136 __glibcxx_check_irreflexive_pred2(_First,_Last,_Pred)
137
138# include <debug/functions.h>
139
140#endif
141
142#endif // _GLIBCXX_DEBUG_MACRO_SWITCH_H
143