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
|
// Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/*! \file asserts.hpp
* \brief Assertion-like exceptions for halting tests.
*/
#ifndef RCPPUTILS__ASSERTS_HPP_
#define RCPPUTILS__ASSERTS_HPP_
#include <exception>
#include <stdexcept>
#include <string>
#include "rcpputils/visibility_control.hpp"
// Needed to disable compiler warning for exporting a class that extends a
// non-DLL-interface class.
// This should be fine since its extending an STL class.
#ifdef _WIN32
# pragma warning(push)
# pragma warning(disable:4251)
# pragma warning(disable:4275)
#endif
namespace rcpputils
{
/**
* \brief An assertion-like exception for halting tests if conditions are not met.
*/
class RCPPUTILS_PUBLIC AssertionException : public std::exception
{
std::string msg_;
public:
/**
* \brief Constructor for AssertionException
*
* \param[in] msg The message to display when this exception is thrown.
*/
explicit AssertionException(const char * msg);
/**
* \brief Get the message description of why this exception was thrown.
*
* \return The string message
*/
virtual const char * what() const noexcept;
};
/**
* \brief An exception to be thrown when a state check fails.
*/
class RCPPUTILS_PUBLIC IllegalStateException : public std::exception
{
std::string msg_;
public:
/**
* \brief Constructor for IllegalStateException
*
* \param[in] msg The message to display when this exception is thrown.
*/
explicit IllegalStateException(const char * msg);
/**
* \brief Get the message description of why this exception was thrown.
*
* \return The string message
*/
virtual const char * what() const noexcept;
};
/**
* \brief Check that an argument condition passes.
*
* \param[in] condition condition that is asserted to be true
* \param[in] msg message to pass to exception when condition is false
* \throw std::invalid_argument if the condition is not met.
*/
inline void require_true(bool condition, const std::string & msg = "invalid argument passed")
{
if (!condition) {
throw std::invalid_argument{msg};
}
}
/**
* \brief Check that a state condition passes.
*
* \param[in] condition condition to check whether it is true or not
* \param[in] msg message to pass to exception when condition is false
* \throw rcpputils::IllegalStateException if the condition is not met.
*/
inline void check_true(bool condition, const std::string & msg = "check reported invalid state")
{
if (!condition) {
throw rcpputils::IllegalStateException{msg.c_str()};
}
}
/**
* \brief Assert that a condition passes.
*
* This function behaves similar to assert, except that it throws instead of invoking abort().
* It is only enabled when NDEBUG is not defined
*
* \param[in] condition condition to check whether it's true or not
* \param[in] msg message to pass to exception when condition is not met.
* \throw rcpputils::AssertionException if the macro NDEBUG is not set and the condition is not met.
*/
inline void assert_true(bool condition, const std::string & msg = "assertion failed")
{
// Same macro definition used by cassert
#ifndef NDEBUG
if (!condition) {
throw rcpputils::AssertionException{msg.c_str()};
}
#else
(void) condition;
(void) msg;
#endif
}
} // namespace rcpputils
#ifdef _WIN32
# pragma warning(pop)
#endif
#endif // RCPPUTILS__ASSERTS_HPP_
|
