-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathitassert.h
185 lines (156 loc) · 5.68 KB
/
itassert.h
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
/*!
* \file
* \brief Error handling functions - header file
* \author Tobias Ringstrom and Adam Piatyszek
*
* -------------------------------------------------------------------------
*
* Copyright (C) 1995-2010 (see AUTHORS file for a list of contributors)
*
* This file is part of IT++ - a C++ library of mathematical, signal
* processing, speech processing, and communications classes and functions.
*
* IT++ 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 3 of the License, or (at your option) any
* later version.
*
* IT++ 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 IT++. If not, see <http://www.gnu.org/licenses/>.
*
* -------------------------------------------------------------------------
*/
#ifndef ITASSERT_H
#define ITASSERT_H
#include <sstream>
#include <string>
//namespace itpp
//{
/*!
\addtogroup errorhandlingfunc
For the following macros, the argument \c s is a string that is displayed.
\code
it_assert(t,s); // Abort if t is not true
it_assert_debug(t,s); // Abort if t is not true and NDEBUG is not defined
it_error_if(t,s); // Abort if t is true
it_error(s); // Abort
it_info(s); // Display a message
it_info_debug(s); // Display a message if NDEBUG is not defined
it_info_no_endl(s); // Display a message without appended "std::endl"
it_info_no_endl_debug(s); // Display a message without appended "std::endl" if NDEBUG is not defined
it_warning(s); // Display a warning
\endcode
\c it_assert(), \c it_error(), \c it_error_if(), \c it_info(), \c
it_info_no_endl() and \c it_warning() are always active, whereas \c
it_assert_debug(), \c it_info_debug() and \c it_info_no_endl_debug()
depends on the \c NDEBUG compile time definition. If \c NDEBUG is
defined, then none of these macros is executed.
\note \c it_assert0() and \c it_assert1() macros are still defined for
backward compatibility, but \c it_assert_debug() should be used instead
of them.
*/
//!@{
//! Helper function for the \c it_assert and \c it_assert_debug macros
void it_assert_f(std::string ass, std::string msg, std::string file, int line);
//! Helper function for the \c it_error and \c it_error_if macros
void it_error_f(std::string msg, std::string file, int line);
//! Helper function for the \c it_info and \c it_info_debug macros
void it_info_f(std::string msg);
//! Helper function for the \c it_warning macro
void it_warning_f(std::string msg, std::string file, int line);
//! Enable/disable using exceptions for error handling.
void it_enable_exceptions(bool on);
//! Enable warnings
void it_enable_warnings();
//! Disable warnings
void it_disable_warnings();
//! Redirect warnings to the ostream warn_stream
void it_redirect_warnings(std::ostream *warn_stream);
//! Style of assert, error and warning messages.
enum error_msg_style { Full, Minimum };
//! Set preferred style of assert, error and warning messages
void it_error_msg_style(error_msg_style style);
//! Abort if \c t is not true
#define it_assert(t,s) \
if (!(t)) { \
std::ostringstream m_sout; \
m_sout << s; \
it_assert_f(#t,m_sout.str(),__FILE__,__LINE__); \
} else \
((void) 0)
#if defined(NDEBUG)
//! Abort if \c t is not true and NDEBUG is not defined
# define it_assert_debug(t,s) ((void) 0)
#else
//! Abort if \c t is not true and NDEBUG is not defined
# define it_assert_debug(t,s) it_assert(t,s)
#endif // if defined(NDEBUG)
//! Deprecated macro. Please use \c it_assert_debug() instead.
#define it_assert0(t,s) it_assert_debug(t,s)
//! Deprecated macro. Please use \c it_assert_debug() instead.
#define it_assert1(t,s) it_assert_debug(t,s)
//! Abort if \c t is true
#define it_error_if(t,s) \
if((t)) { \
std::ostringstream m_sout; \
m_sout << s; \
it_error_f(m_sout.str(),__FILE__,__LINE__); \
} else \
((void) 0)
//! Abort unconditionally
#define it_error(s) \
if (true) { \
std::ostringstream m_sout; \
m_sout << s; \
it_error_f(m_sout.str(),__FILE__,__LINE__); \
} else \
((void) 0)
//! Print information message
#define it_info(s) \
if (true) { \
std::ostringstream m_sout; \
m_sout << s << std::endl; \
it_info_f(m_sout.str()); \
} else \
((void) 0)
//! Print information message withot \c std::endl at the end
#define it_info_no_endl(s) \
if (true) { \
std::ostringstream m_sout; \
m_sout << s; \
it_info_f(m_sout.str()); \
} else \
((void) 0)
#if defined(NDEBUG)
//! Print information message if NDEBUG is not defined
# define it_info_debug(s) ((void) 0)
/*!
\brief Print information message without \c std::endl at the end if
NDEBUG is not defined
*/
# define it_info_no_endl_debug(s) ((void) 0)
#else
//! Print information message if NDEBUG is not defined
# define it_info_debug(s) it_info(s)
/*!
\brief Print information message withot \c std::endl at the end if
NDEBUG is not defined
*/
# define it_info_no_endl_debug(s) it_info_no_endl(s)
#endif // if defined(NDEBUG)
//! Display a warning message
#define it_warning(s) \
if (true) { \
std::ostringstream m_sout; \
m_sout << s; \
it_warning_f(m_sout.str(),__FILE__,__LINE__); \
} else \
((void) 0)
//!@}
//} // namespace itpp
#endif // #ifndef ITASSERT_H