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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/*PGR-GNU*****************************************************************
FILE: pgr_assert
Copyright 2015~ Vicky Vergara <vicky_vergara@hotmail.com>
Copyright 2014 Stephen Woodbridge <woodbri@imaptools.com>
------
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 Street, Fifth Floor, Boston, MA 02110-1301 USA.
********************************************************************PGR-GNU*/
#ifndef INCLUDE_CPP_COMMON_PGR_ASSERT_H_
#define INCLUDE_CPP_COMMON_PGR_ASSERT_H_
#pragma once
#include <string>
#include <exception>
#ifdef assert
#undef assert
#endif
/*! @file
*
* Assertions Handling
*
* @brief An assert functionality that uses C++ throw().
*
* This file provides an alternative to assert functionality that will
* convert all pgassert() into C++ throw using an AssertFailedException class.
*
* This allows catching errors and do appropriate clean up
* re-throw if needed to catch errors in the postgresql environment
*
* **Do not crash the backend server.**
*/
#ifndef __STRING
#define __STRING(x) #x
#endif
#define __TOSTRING(x) __STRING(x)
/*! @def pgassert(expr)
* @brief Uses the standard assert syntax.
*
* When an assertion fails it will throw \ref AssertFailedException and what()
* will return a string like "AssertFailedException(2+2 == 5) at t.cpp:11"
*
* Example:
* @code
#include <iostream>
#include "pgr_assert.h"
int main() {
try {
pgassert(2+2 == 4);
pgassert(2+2 == 5);
}
catch (AssertFailedException &e) {
std::cout << e.what() << "\n";
}
catch (std::exception& e) {
std::cout << e.what() << "\n";
}
catch(...) {
std::cout << "Caught unknown exception!\n";
}
return 0;
}
@endcode
*/
#ifdef NDEBUG
#define pgassert(expr) ((void)0)
#else
#define pgassert(expr) \
((expr) \
? static_cast<void>(0) \
: throw AssertFailedException( \
"AssertFailedException: " __STRING(expr) \
" at " __FILE__ ":" __TOSTRING(__LINE__) + get_backtrace() ) )
#endif
/*! @def pgassertwm(expr, msg)
@brief Adds a message to the assertion.
Example:
@code
pgassert(2+2 == 5, "Expected a 4 as result");
std::ostringstream log;
log << "Expected a 4 as result"
pgassert(2+2 == 5, log.str());
@endcode
*/
#ifdef NDEBUG
#define pgassertwm(expr, msg) ((void)0)
#else
#define pgassertwm(expr, msg) \
((expr) \
? static_cast<void>(0) \
: throw AssertFailedException( \
"AssertFailedException: " __STRING(expr) \
" at " __FILE__ ":" __TOSTRING(__LINE__) + get_backtrace(msg) ) )
#endif
/*! @brief returns the execution path of the trace
In case of a failed exception the backtrace can be is shown in the error message.
Does not work for windows, please read:
http://stackoverflow.com/questions/27639931/can-not-find-execinfo-h-when-setup-malpack
*/
std::string get_backtrace();
std::string get_backtrace(const std::string &);
/*! @class AssertFailedException
* @brief Extends std::exception and is the exception that we throw if an assert fails.
*/
class AssertFailedException : public std::exception {
private:
const std::string str; ///< Holds what() we got as message
public:
virtual const char *what() const throw();
explicit AssertFailedException(std::string msg);
virtual ~AssertFailedException() throw() {}
};
#endif // INCLUDE_CPP_COMMON_PGR_ASSERT_H_
|
