Teuchos - Trilinos Tools Package 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 
00057 TEUCHOS_LIB_DLL_EXPORT void TestForException_incrThrowNumber();
00058 
00060 TEUCHOS_LIB_DLL_EXPORT int TestForException_getThrowNumber();
00061 
00064 TEUCHOS_LIB_DLL_EXPORT void TestForException_break( const std::string &msg );
00065 
00068 TEUCHOS_LIB_DLL_EXPORT void TestForException_setEnableStacktrace(bool enableStrackTrace);
00069 
00072 TEUCHOS_LIB_DLL_EXPORT bool TestForException_getEnableStacktrace();
00073 
00074 #ifdef HAVE_TEUCHOS_STACKTRACE
00075 #  define TEUCHOS_STORE_STACKTRACE() \
00076   if (TestForException_getEnableStacktrace()) { \
00077     Teuchos::store_stacktrace(); \
00078   }
00079 #else
00080 #  define TEUCHOS_STORE_STACKTRACE()
00081 #endif
00082 
00083 
00159 #define TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg) \
00160 { \
00161   const bool throw_exception = (throw_exception_test); \
00162   if(throw_exception) { \
00163     TestForException_incrThrowNumber(); \
00164     std::ostringstream omsg; \
00165     omsg \
00166       << __FILE__ << ":" << __LINE__ << ":\n\n" \
00167       << "Throw number = " << TestForException_getThrowNumber() \
00168       << "\n\n" \
00169       << "Throw test that evaluated to true: "#throw_exception_test \
00170       << "\n\n" \
00171       << msg; \
00172     const std::string &omsgstr = omsg.str(); \
00173     TEUCHOS_STORE_STACKTRACE(); \
00174     TestForException_break(omsgstr); \
00175     throw Exception(omsgstr); \
00176   } \
00177 }
00178 
00179 
00221 #define TEST_FOR_EXCEPTION_CLASS_FUNC(throw_exception_test, Exception, msg) \
00222 { \
00223    TEST_FOR_EXCEPTION( (throw_exception_test), Exception, \
00224    typeName(*this) << "::" << tfecfFuncName << msg ) \
00225 }
00226 
00227 
00235 #define TEST_FOR_EXCEPTION_PURE_MSG(throw_exception_test, Exception, msg) \
00236 { \
00237     const bool throw_exception = (throw_exception_test); \
00238     if(throw_exception) { \
00239       TestForException_incrThrowNumber(); \
00240       std::ostringstream omsg; \
00241       omsg << msg; \
00242       omsg << "\n\nThrow number = " << TestForException_getThrowNumber() << "\n\n"; \
00243       const std::string &omsgstr = omsg.str(); \
00244       TestForException_break(omsgstr); \
00245       TEUCHOS_STORE_STACKTRACE(); \
00246       throw Exception(omsgstr); \
00247     } \
00248 }
00249 
00262 #define TEST_FOR_EXCEPT(throw_exception_test) \
00263   TEST_FOR_EXCEPTION(throw_exception_test, std::logic_error, "Error!")
00264 
00281 #define TEST_FOR_EXCEPT_MSG(throw_exception_test, msg) \
00282   TEST_FOR_EXCEPTION(throw_exception_test, std::logic_error, msg)
00283 
00301 #define TEST_FOR_EXCEPTION_PRINT(throw_exception_test, Exception, msg, out_ptr) \
00302 try { \
00303   TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg); \
00304 } \
00305 catch(const std::exception &except) { \
00306   std::ostream *l_out_ptr = (out_ptr); \
00307   if(l_out_ptr) { \
00308     *l_out_ptr \
00309       << "\nThorwing an std::exception of type \'"<<Teuchos::typeName(except) \
00310       <<"\' with the error message: " \
00311       << except.what(); \
00312   } \
00313   throw; \
00314 }
00315 
00316 
00330 #define TEST_FOR_EXCEPT_PRINT(throw_exception_test, out_ptr) \
00331   TEST_FOR_EXCEPTION_PRINT(throw_exception_test, std::logic_error, "Error!", out_ptr)
00332 
00333 
00342 #define TEUCHOS_TRACE(exc)\
00343 { \
00344   std::ostringstream omsg; \
00345   omsg << exc.what() << std::endl \
00346        << "caught in " << __FILE__ << ":" << __LINE__ << std::endl ; \
00347   throw std::runtime_error(omsg.str()); \
00348 }
00349 
00350 
00351 #endif // TEUCHOS_TEST_FOR_EXCEPTION_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines