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
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* 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
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* 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.
*
*=========================================================================*/
#ifndef itkFloatingPointExceptions_h
#define itkFloatingPointExceptions_h
#include <cstdint>
#include "itkMacro.h" // for ITKCommon_EXPORT
#include "itkSingletonMacro.h"
#include <cstdint>
namespace itk
{
/** \class FloatingPointExceptionsEnums
* \brief Contains all enum classes used by FloatingPointExceptions class.
* \ingroup ITKCommon
*/
class FloatingPointExceptionsEnums
{
public:
/** \class ExceptionAction
* \ingroup ITKCommon
* defines what should happen when exceptions occur */
enum class ExceptionAction : uint8_t
{
ABORT,
EXIT
};
};
// Define how to print enumeration
extern ITKCommon_EXPORT std::ostream &
operator<<(std::ostream & out, const FloatingPointExceptionsEnums::ExceptionAction value);
/** \class FloatingPointExceptions
* \brief Allows floating point exceptions to be caught during program execution.
*
* Allows floating point exceptions to be caught during program execution.
* \ingroup ITKCommon
*/
struct ExceptionGlobals;
class ITKCommon_EXPORT FloatingPointExceptions
{
public:
ITK_DISALLOW_COPY_AND_MOVE(FloatingPointExceptions);
// default constructor required for wrapping to succeed
FloatingPointExceptions() = default;
virtual ~FloatingPointExceptions() = default;
using ExceptionActionEnum = FloatingPointExceptionsEnums::ExceptionAction;
#if !defined(ITK_LEGACY_REMOVE)
/**Exposes enum values at class level for backwards compatibility*/
using ExceptionAction = ExceptionActionEnum;
static constexpr ExceptionActionEnum ABORT = ExceptionActionEnum::ABORT;
static constexpr ExceptionActionEnum EXIT = ExceptionActionEnum::EXIT;
#endif
/** Enable floating point exceptions.
*
* If floating point exceptions are not supported on the platform, the program
* will either abort or exit displaying the error message `FloatingPointExceptions
* are not supported on this platform.`.
*
* Choice between Exit or Abort is based on the value returned by
* based GetExceptionAction().
*
* \sa Disable, SetEnabled, GetEnabled
*/
static void
Enable();
/** Disable floating point exceptions.
*
* \sa Enable, SetEnabled, GetEnabled
*/
static void
Disable();
/** Return the current state of FP Exceptions */
static bool
GetEnabled();
/** Set the state to specified value.
*
* \sa Enable, Disable, GetEnabled
*/
static void
SetEnabled(bool val);
/** Control whether exit(255) or abort() is called on an exception */
static void
SetExceptionAction(ExceptionActionEnum a);
/** Access current ExceptionAction */
static ExceptionActionEnum
GetExceptionAction();
/** Return if floating point exceptions are supported on this platform */
static bool
HasFloatingPointExceptionsSupport();
private:
itkGetGlobalDeclarationMacro(ExceptionGlobals, PimplGlobals);
/** static member that controls what happens during an exception */
static ExceptionGlobals * m_PimplGlobals;
};
} // namespace itk
#endif
|
