Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_TestForException.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 #ifndef TEUCHOS_TEST_FOR_EXCEPTION_H
00043 #define TEUCHOS_TEST_FOR_EXCEPTION_H
00044 
00049 #include "Teuchos_TypeNameTraits.hpp"
00050 #include "Teuchos_stacktrace.hpp"
00051 
00052 
00053 namespace Teuchos {
00054 
00055 
00061 TEUCHOSCORE_LIB_DLL_EXPORT void TestForException_incrThrowNumber();
00062 
00064 TEUCHOSCORE_LIB_DLL_EXPORT int TestForException_getThrowNumber();
00065 
00068 TEUCHOSCORE_LIB_DLL_EXPORT void TestForException_break( const std::string &msg );
00069 
00072 TEUCHOSCORE_LIB_DLL_EXPORT void TestForException_setEnableStacktrace(bool enableStrackTrace);
00073 
00076 TEUCHOSCORE_LIB_DLL_EXPORT bool TestForException_getEnableStacktrace();
00077 
00078 
00079 } // namespace Teuchos
00080 
00081 
00082 #ifdef HAVE_TEUCHOS_STACKTRACE
00083 #  define TEUCHOS_STORE_STACKTRACE() \
00084   if (Teuchos::TestForException_getEnableStacktrace()) { \
00085     Teuchos::store_stacktrace(); \
00086   }
00087 #else
00088 #  define TEUCHOS_STORE_STACKTRACE()
00089 #endif
00090 
00091 
00167 #define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg) \
00168 { \
00169   const bool throw_exception = (throw_exception_test); \
00170   if(throw_exception) { \
00171     Teuchos::TestForException_incrThrowNumber(); \
00172     std::ostringstream omsg; \
00173     omsg \
00174       << __FILE__ << ":" << __LINE__ << ":\n\n" \
00175       << "Throw number = " << Teuchos::TestForException_getThrowNumber() \
00176       << "\n\n" \
00177       << "Throw test that evaluated to true: "#throw_exception_test \
00178       << "\n\n" \
00179       << msg; \
00180     const std::string &omsgstr = omsg.str(); \
00181     TEUCHOS_STORE_STACKTRACE(); \
00182     Teuchos::TestForException_break(omsgstr); \
00183     throw Exception(omsgstr); \
00184   } \
00185 }
00186 
00187 
00229 #define TEUCHOS_TEST_FOR_EXCEPTION_CLASS_FUNC(throw_exception_test, Exception, msg) \
00230 { \
00231    TEUCHOS_TEST_FOR_EXCEPTION( (throw_exception_test), Exception, \
00232    Teuchos::typeName(*this) << "::" << tfecfFuncName << msg ) \
00233 }
00234 
00235 
00243 #define TEUCHOS_TEST_FOR_EXCEPTION_PURE_MSG(throw_exception_test, Exception, msg) \
00244 { \
00245     const bool throw_exception = (throw_exception_test); \
00246     if(throw_exception) { \
00247       Teuchos::TestForException_incrThrowNumber(); \
00248       std::ostringstream omsg; \
00249       omsg << msg; \
00250       omsg << "\n\nThrow number = " << Teuchos::TestForException_getThrowNumber() << "\n\n"; \
00251       const std::string &omsgstr = omsg.str(); \
00252       Teuchos::TestForException_break(omsgstr); \
00253       TEUCHOS_STORE_STACKTRACE(); \
00254       throw Exception(omsgstr); \
00255     } \
00256 }
00257 
00258 
00276 #define TEUCHOS_TEST_FOR_EXCEPTION_PRINT(throw_exception_test, Exception, msg, out_ptr) \
00277 try { \
00278   TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg); \
00279 } \
00280 catch(const std::exception &except) { \
00281   std::ostream *l_out_ptr = (out_ptr); \
00282   if(l_out_ptr) { \
00283     *l_out_ptr \
00284       << "\nThrowing an std::exception of type \'"<<Teuchos::typeName(except) \
00285       <<"\' with the error message: " \
00286       << except.what(); \
00287   } \
00288   throw; \
00289 }
00290 
00291 
00304 #define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test) \
00305   TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, std::logic_error, "Error!")
00306 
00307 
00324 #define TEUCHOS_TEST_FOR_EXCEPT_MSG(throw_exception_test, msg) \
00325   TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, std::logic_error, msg)
00326 
00327 
00341 #define TEUCHOS_TEST_FOR_EXCEPT_PRINT(throw_exception_test, out_ptr) \
00342   TEUCHOS_TEST_FOR_EXCEPTION_PRINT(throw_exception_test, std::logic_error, "Error!", out_ptr)
00343 
00344 
00353 #define TEUCHOS_TRACE(exc)\
00354 { \
00355   std::ostringstream omsg; \
00356   omsg << exc.what() << std::endl \
00357        << "caught in " << __FILE__ << ":" << __LINE__ << std::endl ; \
00358   throw std::runtime_error(omsg.str()); \
00359 }
00360 
00361 
00362 
00363 
00364 #endif // TEUCHOS_TEST_FOR_EXCEPTION_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines