Deprecated.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt for details.
//
//  This software is distributed WITHOUT ANY WARRANTY; without even
//  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
//  PURPOSE.  See the above copyright notice for more information.
//============================================================================
#ifndef viskores_Deprecated_h
#define viskores_Deprecated_h
 
#include <viskores/StaticAssert.h>
#include <viskores/Types.h>
 
#define VISKORES_DEPRECATED_MAKE_MESSAGE(...) \
  VISKORES_EXPAND(                            \
    VISKORES_DEPRECATED_MAKE_MESSAGE_IMPL(__VA_ARGS__, "", viskores::internal::NullType{}))
#define VISKORES_DEPRECATED_MAKE_MESSAGE_IMPL(version, message, ...) \
  message " Deprecated in version " #version "."
 
 
 
 
// Determine whether the [[deprecated]] attribute is supported. Note that we are not
// using other older compiler features such as __attribute__((__deprecated__)) because
// they do not all support all [[deprecated]] uses (such as uses in enums). If
// [[deprecated]] is supported, then VISKORES_DEPRECATED_ATTRIBUTE_SUPPORTED will get defined.
#ifndef VISKORES_DEPRECATED_ATTRIBUTE_SUPPORTED
 
#if defined(__NVCC__)
// Currently nvcc has zero support deprecated attributes
#elif __cplusplus >= 201402L && !defined(VISKORES_GCC)
 
// C++14 and better supports [[deprecated]]
// Except in these cases:
//   - nvcc
#define VISKORES_DEPRECATED_ATTRIBUTE_SUPPORTED
 
#elif defined(VISKORES_GCC)
// GCC has supported [[deprecated]] since version 5.0, but using it on enum was not
// supported until 6.0. So we have to make a special case to only use it for high
// enough revisions.
#if __GNUC__ >= 6
#define VISKORES_DEPRECATED_ATTRIBUTE_SUPPORTED
#endif // Too old GCC
 
#elif defined(__has_cpp_attribute)
 
#if __has_cpp_attribute(deprecated)
// Compiler not fully C++14 compliant, but it reports to support [[deprecated]]
#define VISKORES_DEPRECATED_ATTRIBUTE_SUPPORTED
#endif // __has_cpp_attribute(deprecated)
 
#elif defined(VISKORES_MSVC) && (_MSC_VER >= 1920)
 
#define VISKORES_DEPRECATED_ATTRIBUTE_SUPPORTED
 
#endif // no known compiler support for [[deprecated]]
 
#endif // VISKORES_DEPRECATED_ATTRIBUTE_SUPPORTED check
 
// Determine how to turn deprecated warnings on and off, generally with pragmas. If
// deprecated warnings can be turned off and on, then VISKORES_DEPRECATED_SUPPRESS_SUPPORTED
// is defined and the pair VISKORES_DEPRECATED_SUPPRESS_BEGIN and VISKORES_DEPRECATED_SUPRESS_END
// are defined to the pragmas to disable and restore these warnings. If this support
// cannot be determined, VISKORES_DEPRECATED_SUPPRESS_SUPPORTED is _not_ define whereas
// VISKORES_DEPRECATED_SUPPRESS_BEGIN and VISKORES_DEPRECATED_SUPPRESS_END are defined to be
// empty.
#ifndef VISKORES_DEPRECATED_SUPPRESS_SUPPORTED
 
#if defined(VISKORES_GCC) || defined(VISKORES_CLANG)
 
#define VISKORES_DEPRECATED_SUPPRESS_SUPPORTED
#define VISKORES_DEPRECATED_SUPPRESS_BEGIN \
  _Pragma("GCC diagnostic push") _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
#define VISKORES_DEPRECATED_SUPPRESS_END _Pragma("GCC diagnostic pop")
 
#elif defined(VISKORES_MSVC)
 
#define VISKORES_DEPRECATED_SUPPRESS_SUPPORTED
#define VISKORES_DEPRECATED_SUPPRESS_BEGIN __pragma(warning(push)) __pragma(warning(disable : 4996))
#define VISKORES_DEPRECATED_SUPPRESS_END __pragma(warning(pop))
 
#else
 
//   Other compilers probably have different pragmas for turning warnings off and on.
//   Adding more compilers to this list is fine, but the above probably capture most
//   developers and should be covered on dashboards.
#define VISKORES_DEPRECATED_SUPPRESS_BEGIN
#define VISKORES_DEPRECATED_SUPPRESS_END
 
#endif
 
#endif // VISKORES_DEPRECATED_SUPPRESS_SUPPORTED check
 
#if !defined(VISKORES_DEPRECATED_SUPPRESS_BEGIN) || !defined(VISKORES_DEPRECATED_SUPPRESS_END)
#error VISKORES_DEPRECATED_SUPPRESS macros not properly defined.
#endif
 
// Only actually use the [[deprecated]] attribute if the compiler supports it AND
// we know how to suppress deprecations when necessary.
#if defined(VISKORES_DEPRECATED_ATTRIBUTE_SUPPORTED) && \
  defined(VISKORES_DEPRECATED_SUPPRESS_SUPPORTED)
#ifdef VISKORES_MSVC
#define VISKORES_DEPRECATED(...) [[deprecated(VISKORES_DEPRECATED_MAKE_MESSAGE(__VA_ARGS__))]]
#else // !MSVC
// GCC and other compilers support the C++14 attribute [[deprecated]], but there appears to be a
// bug (or other undesirable behavior) where if you mix [[deprecated]] with __attribute__(()) you
// get compile errors. To get around this, use __attribute((deprecated)) where supported.
#define VISKORES_DEPRECATED(...) \
  __attribute__((deprecated(VISKORES_DEPRECATED_MAKE_MESSAGE(__VA_ARGS__))))
#endif // !MSVC
#else
#define VISKORES_DEPRECATED(...)
#endif
 
#endif // viskores_Deprecated_h