src/Standard/Standard_DefineException.hxx

   1 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   2 //
   3 // This file is part of Open CASCADE Technology software library.
   4 //
   5 // This library is free software; you can redistribute it and/or modify it under
   6 // the terms of the GNU Lesser General Public License version 2.1 as published
   7 // by the Free Software Foundation, with special exception defined in the file
   8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
   9 // distribution for complete text of the license and disclaimer of any warranty.
  10 //
  11 // Alternatively, this file may be used under the terms of Open CASCADE
  12 // commercial license or contractual agreement.
  13
  14 #ifndef _Standard_DefineException_HeaderFile
  15 #define _Standard_DefineException_HeaderFile
  16
  17 #include <Standard_Type.hxx>
  18
  19 //! Defines an exception class \a C1 that inherits an exception class \a C2.
  20 /*! \a C2 must be Standard_Failure or its ancestor.
  21     The macro defines empty constructor, copy constructor and static methods Raise() and NewInstance().
  22     Since Standard_Failure implements class manipulated by handle, DEFINE_STANDARD_RTTI macro is also
  23     added to enable RTTI.
  24
  25     When using DEFINE_STANDARD_EXCEPTION in your code make sure you also insert a macro
  26     DEFINE_STANDARD_HANDLE(C1,C2) before it.
  27 */
  28
  29 #define DEFINE_STANDARD_EXCEPTION(C1,C2) \
  30  \
  31 class C1 : public C2 { \
  32   void Throw () const Standard_OVERRIDE { throw *this; } \
  33 public: \
  34   C1() : C2() {} \
  35   C1(Standard_CString theMessage) : C2(theMessage) {} \
  36   C1(Standard_CString theMessage, Standard_CString theStackTrace) \
  37   : C2 (theMessage, theStackTrace) {} \
  38   static void Raise(const Standard_CString theMessage = "") { \
  39     Handle(C1) _E = new C1; \
  40     _E->Reraise(theMessage); \
  41   } \
  42   static void Raise(Standard_SStream& theMessage) { \
  43     Handle(C1) _E = new C1; \
  44     _E->Reraise (theMessage); \
  45   } \
  46   static Handle(C1) NewInstance(Standard_CString theMessage = "") { return new C1(theMessage); } \
  47   static Handle(C1) NewInstance(Standard_CString theMessage, Standard_CString theStackTrace) { return new C1(theMessage, theStackTrace); } \
  48   DEFINE_STANDARD_RTTI_INLINE(C1,C2) \
  49 };
  50
  51 //! Obsolete macro, kept for compatibility with old code
  52 #define IMPLEMENT_STANDARD_EXCEPTION(C1)
  53
  54 #endif