Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_CompilerCodeTweakMacros.hpp
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
42#ifndef TEUCHOS_COMPILER_CODE_TWEAK_MACROS_HPP
43#define TEUCHOS_COMPILER_CODE_TWEAK_MACROS_HPP
44
45#include "TeuchosCore_config.h"
46
47
48//
49// Implementations of below macros
50//
51
52
53#ifdef __NVCC__
54 #define TEUCHOS_UNREACHABLE_RETURN_IMPL(dummyReturnVal)
55#else
56 #define TEUCHOS_UNREACHABLE_RETURN_IMPL(dummyReturnVal) \
57 return dummyReturnVal
58#endif
59// Above, the unreachable return statement is only removed for __NVCC__. This
60// is because only __NVCC__ warns about the unreachable return. Having that
61// return statement added for other compilers that don't warn leads to safer
62// code by avoiding undefined behavior in case a function is modified in such
63// a way that this return is no longer unreachable. In that case, we want it
64// to return something to avoid undefined behavior in case it ever gets
65// executed. That is just good defensive programming. Also, by leaving this
66// return statement by default, we avoid the (incorrect) warning by some
67// compilers that the function may not return a value.
68
69
70//
71// User interface macros
72//
73
74
131#define TEUCHOS_UNREACHABLE_RETURN(dummyReturnVal) \
132 TEUCHOS_UNREACHABLE_RETURN_IMPL(dummyReturnVal)
133
134
135#endif // TEUCHOS_COMPILER_CODE_TWEAK_MACROS_HPP