PCL
UnixSignalException.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.6.5
6 // ----------------------------------------------------------------------------
7 // pcl/UnixSignalException.h - Released 2024-01-13T15:47:58Z
8 // ----------------------------------------------------------------------------
9 // This file is part of the PixInsight Class Library (PCL).
10 // PCL is a multiplatform C++ framework for development of PixInsight modules.
11 //
12 // Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
13 //
14 // Redistribution and use in both source and binary forms, with or without
15 // modification, is permitted provided that the following conditions are met:
16 //
17 // 1. All redistributions of source code must retain the above copyright
18 // notice, this list of conditions and the following disclaimer.
19 //
20 // 2. All redistributions in binary form must reproduce the above copyright
21 // notice, this list of conditions and the following disclaimer in the
22 // documentation and/or other materials provided with the distribution.
23 //
24 // 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
25 // of their contributors, may be used to endorse or promote products derived
26 // from this software without specific prior written permission. For written
27 // permission, please contact info@pixinsight.com.
28 //
29 // 4. All products derived from this software, in any form whatsoever, must
30 // reproduce the following acknowledgment in the end-user documentation
31 // and/or other materials provided with the product:
32 //
33 // "This product is based on software from the PixInsight project, developed
34 // by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
35 //
36 // Alternatively, if that is where third-party acknowledgments normally
37 // appear, this acknowledgment must be reproduced in the product itself.
38 //
39 // THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
40 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
43 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 // EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
45 // INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
46 // DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49 // POSSIBILITY OF SUCH DAMAGE.
50 // ----------------------------------------------------------------------------
51 
52 #ifndef __PCL_UnixSignalException_h
53 #define __PCL_UnixSignalException_h
54 
56 
57 #if defined( __PCL_WINDOWS ) || !defined( __PCL_LINUX ) && !defined( __PCL_FREEBSD ) && !defined( __PCL_MACOSX )
58 # error UnixSignalException can only be used on Linux, FreeBSD and macOS platforms.
59 #endif
60 
61 #include <pcl/Defs.h>
62 
63 #include <pcl/Exception.h>
64 
65 #include <signal.h>
66 
67 namespace pcl
68 {
69 
70 // ----------------------------------------------------------------------------
71 
92 class PCL_CLASS UnixSignalException : public pcl::Exception
93 {
94 public:
95 
100  UnixSignalException( int signal, const IsoString& details = IsoString() )
101  : m_signal( signal )
102  , m_details( details )
103  {
104  }
105 
109  UnixSignalException( const UnixSignalException& ) = default;
110 
114  int SignalNumber() const
115  {
116  return m_signal;
117  }
118 
127  const IsoString& Details() const
128  {
129  return m_details;
130  }
131 
137  String Message() const override
138  {
139  return "Undefined signal";
140  }
141 
146  String FormatInfo() const override
147  {
148  String info = String().Format( "Critical signal caught (%d): ", SignalNumber() ) + Message();
149  if ( !m_details.IsEmpty() )
150  {
151  info.Append( '\n' );
152  info.Append( m_details );
153  }
154  return info;
155  }
156 
162  String Caption() const override
163  {
164  return "PCL Unix Signal Handler";
165  }
166 
177  void Show() const override;
178 
187  static void Initialize();
188 
189 protected:
190 
191  int m_signal; // signal number
192  IsoString m_details; // backtrace information
193 };
194 
195 // ----------------------------------------------------------------------------
196 
197 #define DECLARE_UNIX_SIGNAL_EXCEPTION( className, sigNum, message ) \
198  class PCL_CLASS className : public pcl::UnixSignalException \
199  { \
200  public: \
201  className( const IsoString& details = IsoString() ) : \
202  pcl::UnixSignalException( sigNum, details ) \
203  { \
204  } \
205  className( const className& ) = default; \
206  String Message() const override \
207  { \
208  return message; \
209  } \
210  }
211 
212 // ----------------------------------------------------------------------------
213 
214 DECLARE_UNIX_SIGNAL_EXCEPTION( EUnixSegmentationViolation, SIGSEGV,
215  "Segmentation violation" );
216 
217 DECLARE_UNIX_SIGNAL_EXCEPTION( EUnixBusError, SIGBUS,
218  "Bus error" );
219 
220 DECLARE_UNIX_SIGNAL_EXCEPTION( EUnixFloatingPointException, SIGFPE,
221  "Floating point exception" );
222 
223 DECLARE_UNIX_SIGNAL_EXCEPTION( EUnixIllegalInstructionException, SIGILL,
224  "Illegal instruction" );
225 
226 DECLARE_UNIX_SIGNAL_EXCEPTION( EUnixIBrokenPipeException, SIGPIPE,
227  "Broken pipe" );
228 
229 // ----------------------------------------------------------------------------
230 
231 #undef DECLARE_UNIX_SIGNAL_EXCEPTION
232 
233 // ----------------------------------------------------------------------------
234 
235 } // pcl
236 
237 #endif // __PCL_UnixSignalException_h
238 
239 // ----------------------------------------------------------------------------
240 // EOF pcl/UnixSignalException.h - Released 2024-01-13T15:47:58Z
pcl
PCL root namespace.
Definition: AbstractImage.h:76
pcl::UnixSignalException::Caption
String Caption() const override
Definition: UnixSignalException.h:162
pcl::UnixSignalException
A UNIX synchronous signal handler that throws C++ exceptions.
Definition: UnixSignalException.h:92
pcl::UnixSignalException::Details
const IsoString & Details() const
Definition: UnixSignalException.h:127
pcl::String
Unicode (UTF-16) string.
Definition: String.h:8112
pcl::IsoString
Eight-bit string (ISO/IEC-8859-1 or UTF-8 string)
Definition: String.h:5424
Exception.h
pcl::Exception
Root base class for all PCL exception classes.
Definition: Exception.h:81
pcl::UnixSignalException::FormatInfo
String FormatInfo() const override
Definition: UnixSignalException.h:146
pcl::UnixSignalException::UnixSignalException
UnixSignalException(int signal, const IsoString &details=IsoString())
Definition: UnixSignalException.h:100
pcl::String::Format
String & Format(const_c_string8 fmt,...)
Definition: String.h:11081
pcl::UnixSignalException::SignalNumber
int SignalNumber() const
Definition: UnixSignalException.h:114
Defs.h
pcl::UnixSignalException::Message
String Message() const override
Definition: UnixSignalException.h:137