1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
/** @file
* @brief Various assertion macros.
*/
/* Copyright (C) 2007,2008,2009,2012,2013,2015 Olly Betts
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/* The "om" prefix is a historical vestige dating back to the "Open Muscat"
* code base upon which Xapian is partly based. It's preserved here only
* to avoid colliding with the ISO C "assert.h" header.
*/
#ifndef XAPIAN_INCLUDED_OMASSERT_H
#define XAPIAN_INCLUDED_OMASSERT_H
#ifndef XAPIAN_ASSERTIONS
// The configure script should always define XAPIAN_ASSERTIONS if it defines
// XAPIAN_ASSERTIONS_PARANOID.
# ifdef XAPIAN_ASSERTIONS_PARANOID
# error XAPIAN_ASSERTIONS_PARANOID defined without XAPIAN_ASSERTIONS
# endif
#else
#include <xapian/error.h>
#include "str.h"
#define XAPIAN_ASSERT_LOCATION__(LINE,MSG) __FILE__":"#LINE": "#MSG
#define XAPIAN_ASSERT_LOCATION_(LINE,MSG) XAPIAN_ASSERT_LOCATION__(LINE,MSG)
#define XAPIAN_ASSERT_LOCATION(MSG) XAPIAN_ASSERT_LOCATION_(__LINE__,MSG)
// Expensive (or potentially expensive) assertions can be marked as "Paranoid"
// - these can be disabled separately from other assertions to allow a build
// with assertions which still has good performance.
#ifdef XAPIAN_ASSERTIONS_PARANOID
# define AssertParanoid(COND) Assert(COND)
# define AssertRelParanoid(A,REL,B) AssertRel(A,REL,B)
# define AssertEqParanoid(A,B) AssertEq(A,B)
# define AssertEqDoubleParanoid(A,B) AssertEqDouble(A,B)
#endif
/** Assert that condition COND is non-zero.
*
* If this assertion fails, Xapian::AssertionError() will be thrown.
*/
#define Assert(COND) \
do {\
if (rare(!(COND)))\
throw Xapian::AssertionError(XAPIAN_ASSERT_LOCATION(COND));\
} while (0)
/** Assert that A REL B is non-zero.
*
* The intended usage is that REL is ==, !=, <=, <, >=, or >.
*
* If this assertion fails, Xapian::AssertionError() will be thrown, and the
* exception message will include the values of A and B.
*/
#define AssertRel(A,REL,B) \
do {\
if (rare(!((A) REL (B)))) {\
std::string xapian_assertion_msg(XAPIAN_ASSERT_LOCATION(A REL B));\
xapian_assertion_msg += " : values were ";\
xapian_assertion_msg += str(A);\
xapian_assertion_msg += " and ";\
xapian_assertion_msg += str(B);\
throw Xapian::AssertionError(xapian_assertion_msg);\
}\
} while (0)
/** Assert that A == B.
*
* This is just a wrapper for AssertRel(A,==,B) and is provided partly for
* historical reasons (we've have AssertEq() for ages) and partly because
* it's convenient to have a shorthand for the most common relation which
* we want to assert.
*/
#define AssertEq(A,B) AssertRel(A,==,B)
/** Helper function to check if two values are within DBL_EPSILON. */
namespace Xapian {
namespace Internal {
bool within_DBL_EPSILON(double a, double b);
}
}
/// Assert two values differ by DBL_EPSILON or more.
#define AssertEqDouble(A,B) \
do {\
using Xapian::Internal::within_DBL_EPSILON;\
if (rare(!within_DBL_EPSILON(A, B))) {\
std::string xapian_assertion_msg(XAPIAN_ASSERT_LOCATION(within_DBL_EPSILON(A, B)));\
xapian_assertion_msg += " : values were ";\
xapian_assertion_msg += str(A);\
xapian_assertion_msg += " and ";\
xapian_assertion_msg += str(B);\
throw Xapian::AssertionError(xapian_assertion_msg);\
}\
} while (0)
#endif
// If assertions are disabled, set the macros to expand to (void)0 so that
// we get a compiler error in this case for assertions missing a trailing
// semicolon. This avoids one source of compile errors in debug builds
// which don't manifest in non-debug builds.
#ifndef Assert
# define Assert(COND) (void)0
# define AssertRel(A,REL,B) (void)0
# define AssertEq(A,B) (void)0
# define AssertEqDouble(A,B) (void)0
#endif
#ifndef AssertParanoid
# define AssertParanoid(COND) (void)0
# define AssertRelParanoid(A,REL,B) (void)0
# define AssertEqParanoid(A,B) (void)0
# define AssertEqDoubleParanoid(A,B) (void)0
#endif
#endif // XAPIAN_INCLUDED_OMASSERT_H
|
