Geogram  Version 1.9.1-rc
A programming library of geometric algorithms
assert.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2000-2022 Inria
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  * * Neither the name of the ALICE Project-Team nor the names of its
14  * contributors may be used to endorse or promote products derived from this
15  * software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  *
29  * Contact: Bruno Levy
30  *
31  * https://www.inria.fr/fr/bruno-levy
32  *
33  * Inria,
34  * Domaine de Voluceau,
35  * 78150 Le Chesnay - Rocquencourt
36  * FRANCE
37  *
38  */
39 
40 #ifndef GEOGRAM_BASIC_ASSERT
41 #define GEOGRAM_BASIC_ASSERT
42 
43 #include <geogram/basic/common.h>
44 #include <string>
45 
51 namespace GEO {
52 
58  enum AssertMode {
65  };
66 
72  void GEOGRAM_API set_assert_mode(AssertMode mode);
73 
77  AssertMode GEOGRAM_API assert_mode();
78 
85  GEO_NORETURN_DECL void GEOGRAM_API geo_abort() GEO_NORETURN;
86 
92  GEO_NORETURN_DECL void GEOGRAM_API geo_breakpoint() GEO_NORETURN;
93 
103  GEO_NORETURN_DECL void GEOGRAM_API geo_assertion_failed(
104  const std::string& condition_string,
105  const std::string& file, int line
106  ) GEO_NORETURN;
107 
119  GEO_NORETURN_DECL void GEOGRAM_API geo_range_assertion_failed(
120  double value, double min_value, double max_value,
121  const std::string& file, int line
122  ) GEO_NORETURN;
123 
132  GEO_NORETURN_DECL void GEOGRAM_API geo_should_not_have_reached(
133  const std::string& file, int line
134  ) GEO_NORETURN;
135 }
136 
137 // Three levels of assert:
138 // use geo_assert() and geo_range_assert() non-expensive asserts
139 // use geo_debug_assert() and geo_debug_range_assert() expensive asserts
140 // use geo_parano_assert() and geo_parano_range_assert() very exensive asserts
141 
149 #define geo_assert(x) { \
150  if(!(x)) { \
151  GEO::geo_assertion_failed(#x, __FILE__, __LINE__); \
152  } \
153  }
154 
165 #define geo_range_assert(x, min_val, max_val) { \
166  if(((x) < (min_val)) || ((x) > (max_val))) { \
167  GEO::geo_range_assertion_failed(x, min_val, max_val, \
168  __FILE__, __LINE__ \
169  ); \
170  } \
171  }
172 
177 #define geo_assert_not_reached { \
178  GEO::geo_should_not_have_reached(__FILE__, __LINE__); \
179  }
180 
191 #ifdef GEO_DEBUG
192 #define geo_debug_assert(x) geo_assert(x)
193 #define geo_debug_range_assert(x, min_val, max_val) geo_range_assert(x, min_val, max_val)
194 #define geo_debug(x) x
195 #else
196 #define geo_debug_assert(x)
197 #define geo_debug_range_assert(x, min_val, max_val)
198 #define geo_debug(x)
199 #endif
200 
211 #ifdef GEO_PARANOID
212 #define geo_parano_assert(x) geo_assert(x)
213 #define geo_parano_range_assert(x, min_val, max_val) geo_range_assert(x, min_val, max_val)
214 #else
215 #define geo_parano_assert(x)
216 #define geo_parano_range_assert(x, min_val, max_val)
217 #endif
218 
219 #endif
Common include file, providing basic definitions. Should be included before anything else by all head...
Global Vorpaline namespace.
Definition: basic.h:55
GEO_NORETURN_DECL void geo_assertion_failed(const std::string &condition_string, const std::string &file, int line) GEO_NORETURN
Prints an assertion failure.
void set_assert_mode(AssertMode mode)
Sets assertion mode.
GEO_NORETURN_DECL void geo_should_not_have_reached(const std::string &file, int line) GEO_NORETURN
Prints an unreachable location failure.
GEO_NORETURN_DECL void geo_abort() GEO_NORETURN
Aborts the program.
AssertMode assert_mode()
Returns the current assert termination mode.
AssertMode
Assert termination mode.
Definition: assert.h:58
@ ASSERT_ABORT
Definition: assert.h:62
@ ASSERT_BREAKPOINT
Definition: assert.h:64
@ ASSERT_THROW
Definition: assert.h:60
GEO_NORETURN_DECL void geo_range_assertion_failed(double value, double min_value, double max_value, const std::string &file, int line) GEO_NORETURN
Prints a range assertion failure.
GEO_NORETURN_DECL void geo_breakpoint() GEO_NORETURN
Generates a debugger breakpoint programmatically.