Teuchos_CompilerCodeTweakMacros.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_COMPILER_CODE_TWEAK_MACROS_HPP
#define TEUCHOS_COMPILER_CODE_TWEAK_MACROS_HPP

#include "TeuchosCore_config.h"


//
// Implementations of below macros
//


#ifdef __NVCC__
  #define TEUCHOS_UNREACHABLE_RETURN_IMPL(dummyReturnVal)
#else
  #define TEUCHOS_UNREACHABLE_RETURN_IMPL(dummyReturnVal) \
    return dummyReturnVal
#endif
// Above, the unreachable return statement is only removed for __NVCC__.  This
// is because only __NVCC__ warns about the unreachable return.  Having that
// return statement added for other compilers that don't warn leads to safer
// code by avoiding undefined behavior in case a function is modified in such
// a way that this return is no longer unreachable.  In that case, we want it
// to return something to avoid undefined behavior in case it ever gets
// executed.  That is just good defensive programming.  Also, by leaving this
// return statement by default, we avoid the (incorrect) warning by some
// compilers that the function may not return a value.


//
// User interface macros
//


#define TEUCHOS_UNREACHABLE_RETURN(dummyReturnVal) \
  TEUCHOS_UNREACHABLE_RETURN_IMPL(dummyReturnVal)


#endif // TEUCHOS_COMPILER_CODE_TWEAK_MACROS_HPP