Salome HOME
Fix Redesign of SMESH documentation
[modules/smesh.git] / src / SMESHUtils / SMESH_TryCatch.hxx
1 // Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 // Lesser General Public License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22 // File      : SMESH_TryCatch.hxx
23 // Created   : Mon Dec 17 15:43:38 2012
24 // Author    : Edward AGAPOV (eap)
25
26 #ifndef __SMESH_TryCatch_HXX__
27 #define __SMESH_TryCatch_HXX__
28
29 #include "SMESH_Comment.hxx"
30 #include "SMESH_ComputeError.hxx"
31 #include "SMESH_Utils.hxx"
32
33 #include <Utils_SALOME_Exception.hxx>
34 #include <Standard_Failure.hxx>
35 #include <Standard_ErrorHandler.hxx>
36 #include <utilities.h>
37
38 // IMPORTANT: include this file _after_ OCC ones, else OCC_CATCH_SIGNALS can be undefined!
39
40 #ifndef OCC_CATCH_SIGNALS
41 #define OCC_CATCH_SIGNALS
42 #endif
43
44 // Define macros to catch and convert some of possible exceptions into text or SALOME_Exception.
45 // WARNING: SALOME::SALOME_Exception (CORBA exception) is not treated here; to care about it add
46 //          #define SMY_OWN_CATCH catch ( SALOME::SALOME_Exception & e ) { do_something(e); }
47 //          before #include<SMESH_TryCatch.hxx>
48
49
50 //-------------------------------------------------------------------------------------
51 #define SMESH_TRY                               \
52   try {                                         \
53   OCC_CATCH_SIGNALS                             \
54
55 //-------------------------------------------------------------------------------------
56 // A macro to add a custom catch clause to SMESH_CATCH
57 // To add your own catch close, define SMY_OWN_CATCH macro before including this file.
58 #ifndef SMY_OWN_CATCH
59 #define SMY_OWN_CATCH
60 #endif
61
62 //-------------------------------------------------------------------------------------
63 // A macro allowing to retrieve a result returned by onExceptionFun
64 #define SMESH_CAUGHT
65
66 //-------------------------------------------------------------------------------------
67 // A macro makes description of a caught exception and calls onExceptionFun(const char*).
68 // Two onExceptionFun() are defined here: SMESH::throwSalomeEx() and SMESH::doNothing().
69 // To add your own catch close, define SMY_OWN_CATCH macro before including this file.
70
71 #define SMESH_CATCH( onExceptionFun )                                   \
72   }                                                                     \
73   catch (Standard_Failure& ex)                                          \
74   {                                                                     \
75     SMESH_Comment text("OCCT Exception: ");                             \
76     text << ": " << ex.DynamicType()->Name();                           \
77     if ( ex.GetMessageString() && strlen( ex.GetMessageString() ))      \
78       text << ": " << ex.GetMessageString();                            \
79     SMESH_CAUGHT onExceptionFun( text );                                \
80   }                                                                     \
81   catch ( ::SMESH_ComputeError& ce )                                    \
82   {                                                                     \
83     if ( !ce.myComment.empty() )                                        \
84       SMESH_CAUGHT onExceptionFun( ce.myComment.c_str() );              \
85     else if ( ce.IsCommon() )                                           \
86       SMESH_CAUGHT onExceptionFun( ce.CommonName().c_str() );           \
87     else                                                                \
88       SMESH_CAUGHT onExceptionFun                                       \
89         (SMESH_Comment("SMESH_ComputeError: ") << ce.myName );          \
90   }                                                                     \
91   catch ( const std::exception& ex)                                     \
92   {                                                                     \
93     SMESH_CAUGHT onExceptionFun( ex.what() );                           \
94   }                                                                     \
95                                                                         \
96   SMY_OWN_CATCH                                                         \
97                                                                         \
98   catch (...)                                                           \
99   {                                                                     \
100     SMESH_CAUGHT onExceptionFun("Unknown Exception caught");            \
101   }
102
103 //-------------------------------------------------------------------------------------
104 // Functions that can be used as an argument of SMESH_CATCH
105
106 namespace SMESH
107 {
108   SMESHUtils_EXPORT void throwSalomeEx(const char* txt);
109   SMESHUtils_EXPORT void doNothing(const char* txt);
110   SMESHUtils_EXPORT const char* returnError(const char* txt);
111 }
112
113 #endif