Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_CWrapperSupport_Cpp.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 
43 #ifndef TEUCHOS_C_WRAPPER_SUPPORT_CPP_HPP
44 #define TEUCHOS_C_WRAPPER_SUPPORT_CPP_HPP
45 
46 
48 #include "Teuchos_FancyOStream.hpp"
49 
50 
54 namespace Teuchos {
55 
56 
61 public:
62 
67  static void setPrintErrorOStream(const RCP<FancyOStream> &errorOStream);
68 
73  static RCP<FancyOStream> getPrintErrorOStream();
74 
80  static void setShowStackTraceOnException(const bool showStrackTraceOnException);
81 
84  static bool getShowStackTraceOnException();
85 
86 
87 }; // class CWrapperErrorHandling
88 
89 
90 } // Teuchos
91 
92 
93 
98 #define TEUCHOS_CWRAPPER_TRY(IERR) \
99  TEUCHOS_TEST_FOR_EXCEPT((IERR) == 0); \
100  (*(IERR)) = 0; \
101  bool cwrapper_try_success = true; \
102  try
103 // Above: We must set *ierr = 0 in case a return statement will return the
104 // value.
105 
106 
111 #define TEUCHOS_CWRAPPER_CATCH_ERROR_CODE(IERR) \
112  TEUCHOS_STANDARD_CATCH_STATEMENTS_IMPL( \
113  true, *Teuchos::CWrapperErrorHandling::getPrintErrorOStream(), \
114  Teuchos::CWrapperErrorHandling::getShowStackTraceOnException(), \
115  cwrapper_try_success ); \
116  if (!cwrapper_try_success) { (*(IERR)) = -1; }
117 // Above: We make sure and set the error code in case there is a failure.
118 
119 
120 
128 #define TEUCHOS_CWRAPPER_SET_ERROR_CODE(IERR, IERR_VALUE) \
129  if ((IERR)) { \
130  (*(IERR)) = (IERR_VALUE); \
131  }
132 
133 
134 #endif // TEUCHOS_C_WRAPPER_SUPPORT_CPP_HPP
Static C Wrapper Error Handling Policy Class.
#define TEUCHOSCORE_LIB_DLL_EXPORT
Smart reference counting pointer class for automatic garbage collection.