Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_CWrapperSupport_Cpp.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 
00043 #ifndef TEUCHOS_C_WRAPPER_SUPPORT_CPP_HPP
00044 #define TEUCHOS_C_WRAPPER_SUPPORT_CPP_HPP
00045 
00046 
00047 #include "Teuchos_StandardCatchMacros.hpp"
00048 #include "Teuchos_FancyOStream.hpp"
00049 
00050 
00054 namespace Teuchos {
00055 
00056 
00060 class TEUCHOSCORE_LIB_DLL_EXPORT CWrapperErrorHandling {
00061 public:
00062 
00067   static void setPrintErrorOStream(const RCP<FancyOStream> &errorOStream);
00068   
00073   static RCP<FancyOStream> getPrintErrorOStream();
00074 
00080   static void setShowStackTraceOnException(const bool showStrackTraceOnException);
00081 
00084   static bool getShowStackTraceOnException();
00085   
00086 
00087 }; // class CWrapperErrorHandling
00088 
00089 
00090 } // Teuchos
00091 
00092 
00093 
00098 #define TEUCHOS_CWRAPPER_TRY(IERR) \
00099   TEUCHOS_TEST_FOR_EXCEPT((IERR) == 0); \
00100   (*(IERR)) = 0; \
00101   bool cwrapper_try_success = true; \
00102   try
00103 // Above: We must set *ierr = 0 in case a return statement will return the
00104 // value.
00105 
00106 
00111 #define TEUCHOS_CWRAPPER_CATCH_ERROR_CODE(IERR) \
00112   TEUCHOS_STANDARD_CATCH_STATEMENTS_IMPL( \
00113     true, *Teuchos::CWrapperErrorHandling::getPrintErrorOStream(), \
00114     Teuchos::CWrapperErrorHandling::getShowStackTraceOnException(), \
00115     cwrapper_try_success ); \
00116   if (!cwrapper_try_success) { (*(IERR)) = -1; }
00117 // Above: We make sure and set the error code in case there is a failure.
00118 
00119 
00120 
00128 #define TEUCHOS_CWRAPPER_SET_ERROR_CODE(IERR, IERR_VALUE) \
00129   if ((IERR)) { \
00130     (*(IERR)) = (IERR_VALUE); \
00131   }
00132 
00133 
00134 #endif // TEUCHOS_C_WRAPPER_SUPPORT_CPP_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines