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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
// OpenVPN -- An application to securely tunnel IP networks
// over a single port, with support for SSL/TLS-based
// session authentication and key exchange,
// packet encryption, packet authentication, and
// packet compression.
//
// Copyright (C) 2012-2022 OpenVPN Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License Version 3
// as published by the Free Software Foundation.
//
// 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program in the COPYING file.
// If not, see <http://www.gnu.org/licenses/>.
// Basic exception handling. Allow exception classes for specific errors
// to be easily defined, and allow exceptions to be thrown with a consise
// syntax that allows stringstream concatenation using <<
#ifndef OPENVPN_COMMON_EXCEPTION_H
#define OPENVPN_COMMON_EXCEPTION_H
#include <string>
#include <sstream>
#include <exception>
#include <utility>
#include <openvpn/common/stringize.hpp> // for OPENVPN_STRINGIZE
#include <openvpn/common/string.hpp>
#ifdef OPENVPN_DEBUG_EXCEPTION
// well-known preprocessor hack to get __FILE__:__LINE__ rendered as a string
#define OPENVPN_FILE_LINE "/" __FILE__ ":" OPENVPN_STRINGIZE(__LINE__)
#else
#define OPENVPN_FILE_LINE
#endif
namespace openvpn {
// string exception class, where the exception is described by a std::string
class Exception : public std::exception
{
public:
explicit Exception(const std::string &err) noexcept
: err_(err)
{
}
explicit Exception(std::string &&err) noexcept
: err_(std::move(err))
{
}
virtual const char *what() const noexcept
{
return err_.c_str();
}
const std::string &err() const noexcept
{
return err_;
}
virtual ~Exception() noexcept = default;
void add_label(const std::string &label)
{
err_ = label + ": " + err_;
}
void remove_label(const std::string &label)
{
const std::string head = label + ": ";
if (string::starts_with(err_, head))
err_ = err_.substr(head.length());
}
private:
std::string err_;
};
// define a simple custom exception class with no extra info
#define OPENVPN_SIMPLE_EXCEPTION(C) \
class C : public std::exception \
{ \
public: \
virtual const char *what() const noexcept \
{ \
return #C OPENVPN_FILE_LINE; \
} \
}
// define a simple custom exception class with no extra info that inherits from a custom base
#define OPENVPN_SIMPLE_EXCEPTION_INHERIT(B, C) \
class C : public B \
{ \
public: \
C() : B(#C OPENVPN_FILE_LINE) \
{ \
} \
virtual const char *what() const noexcept \
{ \
return #C OPENVPN_FILE_LINE; \
} \
}
// define a custom exception class that allows extra info
#define OPENVPN_EXCEPTION(C) \
class C : public openvpn::Exception \
{ \
public: \
C() : openvpn::Exception(#C OPENVPN_FILE_LINE) \
{ \
} \
C(const std::string err) : openvpn::Exception(#C OPENVPN_FILE_LINE ": " + err) \
{ \
} \
}
// define a custom exception class that allows extra info with error code
#define OPENVPN_EXCEPTION_WITH_CODE(C, DEFAULT_CODE, ...) \
enum C##_##code : unsigned int{__VA_ARGS__}; \
class C : public openvpn::Exception \
{ \
public: \
C() : openvpn::Exception(#C OPENVPN_FILE_LINE) \
{ \
add_label(#DEFAULT_CODE); \
} \
C(const std::string &err) : openvpn::Exception(#C OPENVPN_FILE_LINE ": " + err) \
{ \
add_label(#DEFAULT_CODE); \
} \
option_error(C##_##code code, const std::string &err) \
: openvpn::Exception(#C OPENVPN_FILE_LINE ": " + err) \
{ \
add_label(code2string(code)); \
} \
static std::string code2string(C##_##code code); \
}
// define a custom exception class that allows extra info, but does not emit a tag
#define OPENVPN_UNTAGGED_EXCEPTION(C) \
class C : public openvpn::Exception \
{ \
public: \
C(const std::string err) : openvpn::Exception(err) \
{ \
} \
}
// define a custom exception class that allows extra info, and inherits from a custom base
#define OPENVPN_EXCEPTION_INHERIT(B, C) \
class C : public B \
{ \
public: \
C() : B(#C OPENVPN_FILE_LINE) \
{ \
} \
C(const std::string err) : B(#C OPENVPN_FILE_LINE ": " + err) \
{ \
} \
}
// define a custom exception class that allows extra info, and inherits from a custom base,
// but does not emit a tag
#define OPENVPN_UNTAGGED_EXCEPTION_INHERIT(B, C) \
class C : public B \
{ \
public: \
using B::B; \
}
// throw an Exception with stringstream concatenation allowed
#define OPENVPN_THROW_EXCEPTION(stuff) \
do \
{ \
std::ostringstream _ovpn_exc; \
_ovpn_exc << stuff; \
throw openvpn::Exception(_ovpn_exc.str()); \
} while (0)
// throw an OPENVPN_EXCEPTION class with stringstream concatenation allowed
#define OPENVPN_THROW(exc, stuff) \
do \
{ \
std::ostringstream _ovpn_exc; \
_ovpn_exc << stuff; \
throw exc(_ovpn_exc.str()); \
} while (0)
#define OPENVPN_THROW_ARG1(exc, arg, stuff) \
do \
{ \
std::ostringstream _ovpn_exc; \
_ovpn_exc << stuff; \
throw exc(arg, _ovpn_exc.str()); \
} while (0)
// properly rethrow an exception that might be derived from Exception
inline void throw_ref(const std::exception &e)
{
const Exception *ex = dynamic_cast<const Exception *>(&e);
if (ex)
throw *ex;
else
throw e;
}
} // namespace openvpn
#endif // OPENVPN_COMMON_EXCEPTION_H
|
