Teuchos - Trilinos Tools Package Version of the Day
Teuchos_TestForException.cpp
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 #include "Teuchos_TestForException.hpp"
00043 
00044 
00045 //
00046 // ToDo: Make these functions thread-safe!
00047 //
00048 
00049 
00050 namespace {
00051 
00052 
00053 int throwNumber = 0;
00054 
00055 
00056 bool& loc_enableStackTrace()
00057 {
00058   static bool static_enableStackTrace =
00059 #ifdef HAVE_TEUCHOS_DEFAULT_STACKTRACE
00060     true
00061 #else
00062     false
00063 #endif
00064     ;
00065   return static_enableStackTrace;
00066 }
00067 
00068 
00069 } // namespace
00070 
00071 
00072 void Teuchos::TestForException_incrThrowNumber()
00073 {
00074   ++throwNumber;
00075 }
00076 
00077 
00078 int Teuchos::TestForException_getThrowNumber()
00079 {
00080   return throwNumber;
00081 }
00082 
00083 
00084 void Teuchos::TestForException_break( const std::string &errorMsg )
00085 {
00086   int break_on_me;
00087   break_on_me = errorMsg.length(); // Use errMsg to avoid compiler warning.
00088   (void)break_on_me;
00089   // Above is just some statement for the debugger to break on.  Note: now is
00090   // a good time to examine the stack trace and look at the error message in
00091   // 'errorMsg' to see what happened.  In GDB just type 'where' or you can go
00092   // up by typing 'up' and moving up in the stack trace to see where you are
00093   // and how you got to this point in the code where you are throwning this
00094   // exception!  Typing in a 'p errorMsg' will show you what the error message
00095   // is.  Also, you should consider adding a conditional breakpoint in this
00096   // function based on a specific value of 'throwNumber' if the exception you
00097   // want to examine is not the first exception thrown.
00098 }
00099 
00100 
00101 void Teuchos::TestForException_setEnableStacktrace(bool enableStrackTrace)
00102 {
00103   loc_enableStackTrace() = enableStrackTrace;
00104 }
00105 
00106 
00107 bool Teuchos::TestForException_getEnableStacktrace()
00108 {
00109   return loc_enableStackTrace();
00110 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines