Teuchos - Trilinos Tools Package  Version of the Day
Teuchos_TestForException.cpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
43 
44 
45 //
46 // ToDo: Make these functions thread-safe!
47 //
48 
49 
50 namespace {
51 
52 
53 int throwNumber = 0;
54 
55 
56 bool& loc_enableStackTrace()
57 {
58  static bool static_enableStackTrace =
59 #ifdef HAVE_TEUCHOS_DEFAULT_STACKTRACE
60  true
61 #else
62  false
63 #endif
64  ;
65  return static_enableStackTrace;
66 }
67 
68 
69 } // namespace
70 
71 
73 {
74  ++throwNumber;
75 }
76 
77 
79 {
80  return throwNumber;
81 }
82 
83 
84 void Teuchos::TestForException_break( const std::string &errorMsg )
85 {
86  int break_on_me;
87  break_on_me = errorMsg.length(); // Use errMsg to avoid compiler warning.
88  (void)break_on_me;
89  // Above is just some statement for the debugger to break on. Note: now is
90  // a good time to examine the stack trace and look at the error message in
91  // 'errorMsg' to see what happened. In GDB just type 'where' or you can go
92  // up by typing 'up' and moving up in the stack trace to see where you are
93  // and how you got to this point in the code where you are throwning this
94  // exception! Typing in a 'p errorMsg' will show you what the error message
95  // is. Also, you should consider adding a conditional breakpoint in this
96  // function based on a specific value of 'throwNumber' if the exception you
97  // want to examine is not the first exception thrown.
98 }
99 
100 
102 {
103  loc_enableStackTrace() = enableStrackTrace;
104 }
105 
106 
108 {
109  return loc_enableStackTrace();
110 }
TEUCHOSCORE_LIB_DLL_EXPORT void TestForException_setEnableStacktrace(bool enableStrackTrace)
Set at runtime if stacktracing functionality is enabled when * exceptions are thrown.
TEUCHOSCORE_LIB_DLL_EXPORT int TestForException_getThrowNumber()
Increment the throw number.
TEUCHOSCORE_LIB_DLL_EXPORT void TestForException_incrThrowNumber()
Increment the throw number.
TEUCHOSCORE_LIB_DLL_EXPORT void TestForException_break(const std::string &msg)
The only purpose for this function is to set a breakpoint.
Standard test and throw macros.
TEUCHOSCORE_LIB_DLL_EXPORT bool TestForException_getEnableStacktrace()
Get at runtime if stacktracing functionality is enabled when exceptions are thrown.