Teuchos_TestForException.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                    Teuchos: Common Tools Package
//
// Copyright 2004 NTESS and the Teuchos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef TEUCHOS_TEST_FOR_EXCEPTION_H
#define TEUCHOS_TEST_FOR_EXCEPTION_H
 
#include "Teuchos_TypeNameTraits.hpp"
#include "Teuchos_stacktrace.hpp"
 
 
namespace Teuchos {
 
 
TEUCHOSCORE_LIB_DLL_EXPORT void TestForException_incrThrowNumber();
 
TEUCHOSCORE_LIB_DLL_EXPORT int TestForException_getThrowNumber();
 
TEUCHOSCORE_LIB_DLL_EXPORT void TestForException_break(const std::string &msg,
  int throwNumber);
 
TEUCHOSCORE_LIB_DLL_EXPORT void TestForException_setEnableStacktrace(bool enableStrackTrace);
 
TEUCHOSCORE_LIB_DLL_EXPORT bool TestForException_getEnableStacktrace();
 
[[noreturn]] TEUCHOSCORE_LIB_DLL_EXPORT void TestForTermination_terminate(const std::string &msg);
 
 
} // namespace Teuchos
 
 
#ifdef HAVE_TEUCHOS_STACKTRACE
#  define TEUCHOS_STORE_STACKTRACE() \
  if (Teuchos::TestForException_getEnableStacktrace()) { \
    Teuchos::store_stacktrace(); \
  }
#else
#  define TEUCHOS_STORE_STACKTRACE()
#endif
 
 
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg) \
{ \
  const bool throw_exception = (throw_exception_test); \
  if(throw_exception) { \
    Teuchos::TestForException_incrThrowNumber(); \
    const int throwNumber = Teuchos::TestForException_getThrowNumber(); \
    std::ostringstream omsg; \
    omsg \
      << __FILE__ << ":" << __LINE__ << ":\n\n" \
      << "Throw number = " << throwNumber \
      << "\n\n" \
      << "Throw test that evaluated to true: "#throw_exception_test \
      << "\n\n" \
      << msg; \
    const std::string &omsgstr = omsg.str(); \
    TEUCHOS_STORE_STACKTRACE(); \
    Teuchos::TestForException_break(omsgstr, throwNumber); \
    throw Exception(omsgstr); \
  } \
}
 
 
#define TEUCHOS_TEST_FOR_EXCEPTION_CLASS_FUNC(throw_exception_test, Exception, msg) \
{ \
   TEUCHOS_TEST_FOR_EXCEPTION( (throw_exception_test), Exception, \
   Teuchos::typeName(*this) << "::" << tfecfFuncName << msg ) \
}
 
 
#define TEUCHOS_TEST_FOR_EXCEPTION_PURE_MSG(throw_exception_test, Exception, msg) \
{ \
  const bool throw_exception = (throw_exception_test); \
  if(throw_exception) { \
    Teuchos::TestForException_incrThrowNumber(); \
    const int throwNumber = Teuchos::TestForException_getThrowNumber(); \
    std::ostringstream omsg; \
    omsg << msg; \
    omsg << "\n\nThrow number = " << throwNumber << "\n\n"; \
    const std::string &omsgstr = omsg.str(); \
    Teuchos::TestForException_break(omsgstr, throwNumber); \
    TEUCHOS_STORE_STACKTRACE(); \
    throw Exception(omsgstr); \
  } \
}
 
 
#define TEUCHOS_TEST_FOR_EXCEPTION_PRINT(throw_exception_test, Exception, msg, out_ptr) \
try { \
  TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg); \
} \
catch(const std::exception &except) { \
  std::ostream *l_out_ptr = (out_ptr); \
  if(l_out_ptr) { \
    *l_out_ptr \
      << "\nThrowing an std::exception of type \'"<<Teuchos::typeName(except) \
      <<"\' with the error message: " \
      << except.what(); \
  } \
  throw; \
}
 
 
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test) \
  TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, std::logic_error, "Error!")
 
 
#define TEUCHOS_TEST_FOR_EXCEPT_MSG(throw_exception_test, msg) \
  TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, std::logic_error, msg)
 
 
#define TEUCHOS_TEST_FOR_EXCEPT_PRINT(throw_exception_test, out_ptr) \
  TEUCHOS_TEST_FOR_EXCEPTION_PRINT(throw_exception_test, std::logic_error, "Error!", out_ptr)
 
 
#define TEUCHOS_TRACE(exc)\
{ \
  std::ostringstream omsg; \
  omsg << exc.what() << std::endl \
       << "caught in " << __FILE__ << ":" << __LINE__ << std::endl ; \
  throw std::runtime_error(omsg.str()); \
}
 
#define TEUCHOS_TEST_FOR_TERMINATION(terminate_test, msg) \
{ \
  const bool call_terminate = (terminate_test); \
  if (call_terminate) { \
    std::ostringstream omsg; \
    omsg \
      << __FILE__ << ":" << __LINE__ << ":\n\n" \
      << "Terminate test that evaluated to true: "#terminate_test \
      << "\n\n" \
      << msg << "\n\n"; \
    auto str = omsg.str(); \
    Teuchos::TestForTermination_terminate(str); \
  } \
}
 
#endif // TEUCHOS_TEST_FOR_EXCEPTION_H