Teuchos_TestForException.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_TEST_FOR_EXCEPTION_H
#define TEUCHOS_TEST_FOR_EXCEPTION_H

#include "Teuchos_TypeNameTraits.hpp"
#include "Teuchos_stacktrace.hpp"


namespace Teuchos {


TEUCHOS_LIB_DLL_EXPORT void TestForException_incrThrowNumber();

TEUCHOS_LIB_DLL_EXPORT int TestForException_getThrowNumber();

TEUCHOS_LIB_DLL_EXPORT void TestForException_break( const std::string &msg );

TEUCHOS_LIB_DLL_EXPORT void TestForException_setEnableStacktrace(bool enableStrackTrace);

TEUCHOS_LIB_DLL_EXPORT bool TestForException_getEnableStacktrace();


} // 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(); \
    std::ostringstream omsg; \
    omsg \
      << __FILE__ << ":" << __LINE__ << ":\n\n" \
      << "Throw number = " << Teuchos::TestForException_getThrowNumber() \
      << "\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); \
    throw Exception(omsgstr); \
  } \
}


#define TEUCHOS_TEST_FOR_EXCEPTION_CLASS_FUNC(throw_exception_test, Exception, msg) \
{ \
   TEUCHOS_TEST_FOR_EXCEPTION( (throw_exception_test), Exception, \
   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(); \
      std::ostringstream omsg; \
      omsg << msg; \
      omsg << "\n\nThrow number = " << Teuchos::TestForException_getThrowNumber() << "\n\n"; \
      const std::string &omsgstr = omsg.str(); \
      Teuchos::TestForException_break(omsgstr); \
      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()); \
}


//
// Deprecated functions
//


TEUCHOS_DEPRECATED inline
void TestForException_incrThrowNumber()
{
  Teuchos::TestForException_incrThrowNumber();
}


TEUCHOS_DEPRECATED inline
int TestForException_getThrowNumber()
{
  return Teuchos::TestForException_getThrowNumber();
}


TEUCHOS_DEPRECATED inline
void TestForException_break( const std::string &msg )
{
  Teuchos::TestForException_break(msg);
}


TEUCHOS_DEPRECATED inline
void TestForException_setEnableStacktrace(bool enableStrackTrace)
{
  Teuchos::TestForException_setEnableStacktrace(enableStrackTrace);
}


TEUCHOS_DEPRECATED inline
bool TestForException_getEnableStacktrace()
{
  return Teuchos::TestForException_getEnableStacktrace();
}


//
// Deprecated macros
//
// NOTE: You can't deprecate macros but you can deprecate functions that
// deprecated macros can call!  This way, as people get a fairly good
// deprecated warning when they use the non-namespaced macros.
//


TEUCHOS_DEPRECATED inline void TEST_FOR_EXCEPTION_this_macro_is_deprecated() {}
#define TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg) \
  { \
    TEST_FOR_EXCEPTION_this_macro_is_deprecated(); \
    TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg); \
  }


TEUCHOS_DEPRECATED inline void TEST_FOR_EXCEPTION_CLASS_FUNC_this_macro_is_deprecated() {}
#define TEST_FOR_EXCEPTION_CLASS_FUNC(throw_exception_test, Exception, msg) \
  { \
    TEST_FOR_EXCEPTION_CLASS_FUNC_this_macro_is_deprecated(); \
    TEUCHOS_TEST_FOR_EXCEPTION_CLASS_FUNC(throw_exception_test, Exception, msg); \
  }


TEUCHOS_DEPRECATED inline void TEST_FOR_EXCEPTION_PURE_MSG_this_macro_is_deprecated() {}
#define TEST_FOR_EXCEPTION_PURE_MSG(throw_exception_test, Exception, msg) \
  { \
    TEST_FOR_EXCEPTION_PURE_MSG_this_macro_is_deprecated(); \
    TEUCHOS_TEST_FOR_EXCEPTION_PURE_MSG(throw_exception_test, Exception, msg); \
  }


TEUCHOS_DEPRECATED inline void TEST_FOR_EXCEPTION_PRINT_this_macro_is_deprecated() {}
#define TEST_FOR_EXCEPTION_PRINT(throw_exception_test, Exception, msg, out_ptr) \
  { \
    TEST_FOR_EXCEPTION_PRINT_this_macro_is_deprecated(); \
    TEUCHOS_TEST_FOR_EXCEPTION_PRINT(throw_exception_test, Exception, msg, out_ptr); \
  }


TEUCHOS_DEPRECATED inline void TEST_FOR_EXCEPT_this_macro_is_deprecated() {}
#define TEST_FOR_EXCEPT(throw_exception_test) \
  { \
    TEST_FOR_EXCEPT_this_macro_is_deprecated(); \
    TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test); \
  }


TEUCHOS_DEPRECATED inline void TEST_FOR_EXCEPT_MSG_this_macro_is_deprecated() {}
#define TEST_FOR_EXCEPT_MSG(throw_exception_test, msg) \
  { \
    TEST_FOR_EXCEPT_MSG_this_macro_is_deprecated(); \
    TEUCHOS_TEST_FOR_EXCEPT_MSG(throw_exception_test, msg); \
  }


TEUCHOS_DEPRECATED inline void TEST_FOR_EXCEPT_PRINT_this_macro_is_deprecated() {}
#define TEST_FOR_EXCEPT_PRINT(throw_exception_test, out_ptr) \
  { \
    TEST_FOR_EXCEPT_PRINT_this_macro_is_deprecated(); \
    TEUCHOS_TEST_FOR_EXCEPT_PRINT(throw_exception_test, out_ptr); \
  }


#endif // TEUCHOS_TEST_FOR_EXCEPTION_H