handle deprecation warnings uniformly

ginkgo-project · Oct 28, 2023 · 534e3fb · 534e3fb
1 parent d9bd299
commit 534e3fb
Show file tree

Hide file tree

Showing 32 changed files with 229 additions and 374 deletions.
diff --git a/core/reorder/rcm.cpp b/core/reorder/rcm.cpp
@@ -81,15 +81,7 @@ void rcm_reorder(matrix::SparsityCsr<ValueType, IndexType>* mtx,
 }
 
 
-#if defined(__GNUC__) || defined(__clang__)
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
-
-#endif
-#ifdef _MSC_VER
-#pragma warning(push)
-#pragma warning(disable : 5211, 4973, 4974)
-#endif
+GKO_BEGIN_DISABLE_DEPRECATION_WARNINGS
 
 
 template <typename ValueType, typename IndexType>
@@ -164,12 +156,7 @@ Rcm<ValueType, IndexType>::Rcm(const Factory* factory,
 GKO_INSTANTIATE_FOR_EACH_VALUE_AND_INDEX_TYPE(GKO_DECLARE_RCM);
 
 
-#if defined(__GNUC__) || defined(__clang__)
-#pragma GCC diagnostic pop
-#endif
-#ifdef _MSC_VER
-#pragma warning(pop)
-#endif
+GKO_END_DISABLE_DEPRECATION_WARNINGS
 
 
 }  // namespace reorder

diff --git a/core/test/log/logger.cpp b/core/test/log/logger.cpp
@@ -30,18 +30,13 @@ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ******************************<GINKGO LICENSE>*******************************/
 
-#include <ginkgo/core/log/logger.hpp>
-
+// force-top: on
+#include <ginkgo/core/base/types.hpp>
+GKO_BEGIN_DISABLE_DEPRECATION_WARNINGS
+// force-top: off
 
-#if defined(__GNUC__) || defined(__clang__)
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
 
-#endif
-#ifdef _MSC_VER
-#pragma warning(push)
-#pragma warning(disable : 5211, 4973, 4974)
-#endif
+#include <ginkgo/core/log/logger.hpp>
 
 
 #include <memory>
@@ -362,9 +357,4 @@ TEST(IterationCompleteOverload, CanLogCurrent)
 }  // namespace
 
 
-#if defined(__GNUC__) || defined(__clang__)
-#pragma GCC diagnostic pop
-#endif
-#ifdef _MSC_VER
-#pragma warning(pop)
-#endif
+GKO_END_DISABLE_DEPRECATION_WARNINGS
diff --git a/core/test/preconditioner/ic.cpp b/core/test/preconditioner/ic.cpp
@@ -33,15 +33,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #include <ginkgo/core/preconditioner/ic.hpp>
 
 
-#if defined(__GNUC__) || defined(__clang__)
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
-
-#endif
-#ifdef _MSC_VER
-#pragma warning(push)
-#pragma warning(disable : 5211, 4973, 4974)
-#endif
+GKO_BEGIN_DISABLE_DEPRECATION_WARNINGS
 
 
 #include <memory>

diff --git a/core/test/preconditioner/ilu.cpp b/core/test/preconditioner/ilu.cpp
@@ -33,15 +33,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #include <ginkgo/core/preconditioner/ilu.hpp>
 
 
-#if defined(__GNUC__) || defined(__clang__)
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
-
-#endif
-#ifdef _MSC_VER
-#pragma warning(push)
-#pragma warning(disable : 5211, 4973, 4974)
-#endif
+GKO_BEGIN_DISABLE_DEPRECATION_WARNINGS
 
 
 #include <memory>

diff --git a/core/test/reorder/rcm.cpp b/core/test/reorder/rcm.cpp
@@ -33,15 +33,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #include <ginkgo/core/reorder/rcm.hpp>
 
 
-#if defined(__GNUC__) || defined(__clang__)
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
-
-#endif
-#ifdef _MSC_VER
-#pragma warning(push)
-#pragma warning(disable : 5211, 4973, 4974)
-#endif
+GKO_BEGIN_DISABLE_DEPRECATION_WARNINGS
 
 
 #include <memory>

diff --git a/core/test/reorder/scaled_reordered.cpp b/core/test/reorder/scaled_reordered.cpp
@@ -46,15 +46,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #include <ginkgo/core/solver/bicgstab.hpp>
 
 
-#if defined(__GNUC__) || defined(__clang__)
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
-
-#endif
-#ifdef _MSC_VER
-#pragma warning(push)
-#pragma warning(disable : 5211, 4973, 4974)
-#endif
+GKO_BEGIN_DISABLE_DEPRECATION_WARNINGS
 
 
 namespace {
@@ -145,9 +137,4 @@ TEST_F(ScaledReorderedFactory, CanSetColScaling)
 }  // namespace
 
 
-#if defined(__GNUC__) || defined(__clang__)
-#pragma GCC diagnostic pop
-#endif
-#ifdef _MSC_VER
-#pragma warning(pop)
-#endif
+GKO_END_DISABLE_DEPRECATION_WARNINGS
diff --git a/cuda/test/reorder/rcm_kernels.cpp b/cuda/test/reorder/rcm_kernels.cpp
@@ -33,15 +33,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #include <ginkgo/core/reorder/rcm.hpp>
 
 
-#if defined(__GNUC__) || defined(__clang__)
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
-
-#endif
-#ifdef _MSC_VER
-#pragma warning(push)
-#pragma warning(disable : 5211, 4973, 4974)
-#endif
+GKO_BEGIN_DISABLE_DEPRECATION_WARNINGS
 
 
 #include <gtest/gtest.h>

diff --git a/include/ginkgo/core/base/array.hpp b/include/ginkgo/core/base/array.hpp
@@ -160,7 +160,7 @@ class const_array_view {
 
 
 template <typename ValueType>
-using ConstArrayView [[deprecated("please use const_array_view")]] =
+using ConstArrayView GKO_DEPRECATED("please use const_array_view") =
     const_array_view<ValueType>;
 
 
@@ -714,7 +714,7 @@ class array {
 
 
 template <typename ValueType>
-using Array [[deprecated("please use array")]] = array<ValueType>;
+using Array GKO_DEPRECATED("please use array") = array<ValueType>;
 
 
 /**

diff --git a/include/ginkgo/core/base/executor.hpp b/include/ginkgo/core/base/executor.hpp
@@ -1307,24 +1307,20 @@ class EnableDeviceReset {
      *
      * @param device_reset  whether to allow a device reset or not
      */
-    [[deprecated(
+    GKO_DEPRECATED(
         "device_reset is no longer supported, call "
-        "cudaDeviceReset/hipDeviceReset manually")]] void
-    set_device_reset(bool device_reset)
-    {}
+        "cudaDeviceReset/hipDeviceReset manually")
+    void set_device_reset(bool device_reset) {}
 
     /**
      * Returns the current status of the device reset boolean for this executor.
      *
      * @return the current status of the device reset boolean for this executor.
      */
-    [[deprecated(
+    GKO_DEPRECATED(
         "device_reset is no longer supported, call "
-        "cudaDeviceReset/hipDeviceReset manually")]] bool
-    get_device_reset()
-    {
-        return false;
-    }
+        "cudaDeviceReset/hipDeviceReset manually")
+    bool get_device_reset() { return false; }
 
 protected:
     /**
@@ -1334,11 +1330,10 @@ class EnableDeviceReset {
      */
     EnableDeviceReset() {}
 
-    [[deprecated(
+    GKO_DEPRECATED(
         "device_reset is no longer supported, call "
-        "cudaDeviceReset/hipDeviceReset manually")]] EnableDeviceReset(bool
-                                                                           device_reset)
-    {}
+        "cudaDeviceReset/hipDeviceReset manually")
+    EnableDeviceReset(bool device_reset) {}
 };
 
 
@@ -1530,13 +1525,14 @@ class CudaExecutor : public detail::ExecutorBase<CudaExecutor>,
      *                    on. See @allocation_mode for more details
      * @param stream  the stream to execute operations on.
      */
-    [[deprecated(
+    GKO_DEPRECATED(
         "device_reset is deprecated entirely, call cudaDeviceReset directly. "
         "alloc_mode was replaced by the Allocator type "
-        "hierarchy.")]] static std::shared_ptr<CudaExecutor>
-    create(int device_id, std::shared_ptr<Executor> master, bool device_reset,
-           allocation_mode alloc_mode = default_cuda_alloc_mode,
-           CUstream_st* stream = nullptr);
+        "hierarchy.")
+    static std::shared_ptr<CudaExecutor> create(
+        int device_id, std::shared_ptr<Executor> master, bool device_reset,
+        allocation_mode alloc_mode = default_cuda_alloc_mode,
+        CUstream_st* stream = nullptr);
 
     /**
      * Creates a new CudaExecutor with a custom allocator and device stream.
@@ -1743,13 +1739,14 @@ class HipExecutor : public detail::ExecutorBase<HipExecutor>,
      * @param alloc_mode  the allocation mode that the executor should operate
      *                    on. See @allocation_mode for more details
      */
-    [[deprecated(
+    GKO_DEPRECATED(
         "device_reset is deprecated entirely, call hipDeviceReset directly. "
         "alloc_mode was replaced by the Allocator type "
-        "hierarchy.")]] static std::shared_ptr<HipExecutor>
-    create(int device_id, std::shared_ptr<Executor> master, bool device_reset,
-           allocation_mode alloc_mode = default_hip_alloc_mode,
-           GKO_HIP_STREAM_STRUCT* stream = nullptr);
+        "hierarchy.")
+    static std::shared_ptr<HipExecutor> create(
+        int device_id, std::shared_ptr<Executor> master, bool device_reset,
+        allocation_mode alloc_mode = default_hip_alloc_mode,
+        GKO_HIP_STREAM_STRUCT* stream = nullptr);
 
     static std::shared_ptr<HipExecutor> create(
         int device_id, std::shared_ptr<Executor> master,

diff --git a/include/ginkgo/core/base/machine_topology.hpp b/include/ginkgo/core/base/machine_topology.hpp
@@ -415,7 +415,7 @@ class machine_topology {
 };
 
 
-using MachineTopology [[deprecated("please use machine_topology")]] =
+using MachineTopology GKO_DEPRECATED("please use machine_topology") =
     machine_topology;
 
 

diff --git a/include/ginkgo/core/base/polymorphic_object.hpp b/include/ginkgo/core/base/polymorphic_object.hpp
@@ -182,14 +182,13 @@ class PolymorphicObject : public log::EnableLogging<PolymorphicObject> {
      * @tparam Deleter  the deleter of the unique_ptr parameter
      */
     template <typename Derived, typename Deleter>
-    [[deprecated(
+    GKO_DEPRECATED(
         "This function will be removed in a future release, the replacement "
         "will copy instead of move. If a move is intended, use move_from "
-        "instead.")]] std::
-        enable_if_t<
-            std::is_base_of<PolymorphicObject, std::decay_t<Derived>>::value,
-            PolymorphicObject>*
-        copy_from(std::unique_ptr<Derived, Deleter>&& other)
+        "instead.")
+    std::enable_if_t<
+        std::is_base_of<PolymorphicObject, std::decay_t<Derived>>::value,
+        PolymorphicObject>* copy_from(std::unique_ptr<Derived, Deleter>&& other)
     {
         this->template log<log::Logger::polymorphic_object_move_started>(
             exec_.get(), other.get(), this);
@@ -409,14 +408,13 @@ class EnableAbstractPolymorphicObject : public PolymorphicBase {
     }
 
     template <typename Derived>
-    [[deprecated(
+    GKO_DEPRECATED(
         "This function will be removed in a future release, the replacement "
         "will copy instead of move. If a move in intended, use move_to "
-        "instead.")]] std::
-        enable_if_t<
-            std::is_base_of<PolymorphicObject, std::decay_t<Derived>>::value,
-            AbstractObject>*
-        copy_from(std::unique_ptr<Derived>&& other)
+        "instead.")
+    std::enable_if_t<
+        std::is_base_of<PolymorphicObject, std::decay_t<Derived>>::value,
+        AbstractObject>* copy_from(std::unique_ptr<Derived>&& other)
     {
         return static_cast<AbstractObject*>(
             this->PolymorphicBase::copy_from(std::move(other)));

diff --git a/include/ginkgo/core/base/range.hpp b/include/ginkgo/core/base/range.hpp
@@ -618,9 +618,8 @@ struct implement_binary_operation<operation_kind::range_by_scalar,
                                              _operation_name)                \
     namespace accessor {                                                     \
     template <typename Operand>                                              \
-    struct [[deprecated(                                                     \
-        "Please use " #_operation_name)]] _operation_deprecated_name         \
-        : _operation_name<Operand>{};                                        \
+    struct GKO_DEPRECATED("Please use " #_operation_name)                    \
+        _operation_deprecated_name : _operation_name<Operand> {};            \
     }                                                                        \
     static_assert(true,                                                      \
                   "This assert is used to counter the false positive extra " \
@@ -864,7 +863,7 @@ GKO_BIND_UNARY_RANGE_OPERATION_TO_OPERATOR(transpose_operation, transpose);
 
 
 #define GKO_DEPRECATED_SIMPLE_BINARY_OPERATION(_deprecated_name, _name) \
-    struct [[deprecated("Please use " #_name)]] _deprecated_name : _name {}
+    struct GKO_DEPRECATED("Please use " #_name) _deprecated_name : _name {}
 
 #define GKO_DEFINE_SIMPLE_BINARY_OPERATION(_name, ...)                         \
     struct _name {                                                             \

diff --git a/include/ginkgo/core/base/types.hpp b/include/ginkgo/core/base/types.hpp
@@ -89,11 +89,26 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
 // Handle deprecated notices correctly on different systems
-#if defined(_WIN32) || defined(__CYGWIN__)
-#define GKO_DEPRECATED(msg) __declspec(deprecated(msg))
+// clang-format off
+#define GKO_DEPRECATED(_msg) [[deprecated(_msg)]]
+#ifdef __NVCOMPILER
+#define GKO_BEGIN_DISABLE_DEPRECATION_WARNINGS _Pragma("diag_suppress 1445")
+#define GKO_END_DISABLE_DEPRECATION_WARNINGS _Pragma("diag_warning 1445")
+#elif defined(__GNUC__) || defined(__clang__)
+#define GKO_BEGIN_DISABLE_DEPRECATION_WARNINGS                      \
+    _Pragma("GCC diagnostic push")                                  \
+    _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
+#define GKO_END_DISABLE_DEPRECATION_WARNINGS _Pragma("GCC diagnostic pop")
+#elif defined(_MSC_VER)
+#define GKO_BEGIN_DISABLE_DEPRECATION_WARNINGS        \
+    _Pragma("warning(push)")                          \
+    _Pragma("warning(disable : 5211 4973 4974 4996)")
+#define GKO_END_DISABLE_DEPRECATION_WARNINGS _Pragma("warning(pop)")
 #else
-#define GKO_DEPRECATED(msg) __attribute__((deprecated(msg)))
-#endif  // defined(_WIN32) || defined(__CYGWIN__)
+#define GKO_BEGIN_DISABLE_DEPRECATION_WARNINGS
+#define GKO_END_DISABLE_DEPRECATION_WARNINGS
+#endif
+// clang-format on
 
 
 namespace gko {

diff --git a/include/ginkgo/core/base/utils_helper.hpp b/include/ginkgo/core/base/utils_helper.hpp
@@ -294,9 +294,9 @@ inline typename std::remove_reference<OwningPointer>::type&& give(
  *       same as calling .get() on the smart pointer.
  */
 template <typename Pointer>
-[[deprecated("no longer necessary, just pass the object without lend")]] inline
-    typename std::enable_if<detail::have_ownership_s<Pointer>::value,
-                            detail::pointee<Pointer>*>::type
+GKO_DEPRECATED("no longer necessary, just pass the object without lend")
+inline typename std::enable_if<detail::have_ownership_s<Pointer>::value,
+                               detail::pointee<Pointer>*>::type
     lend(const Pointer& p)
 {
     return p.get();
@@ -313,9 +313,9 @@ template <typename Pointer>
  *       returns `p`.
  */
 template <typename Pointer>
-[[deprecated("no longer necessary, just pass the object without lend")]] inline
-    typename std::enable_if<!detail::have_ownership_s<Pointer>::value,
-                            detail::pointee<Pointer>*>::type
+GKO_DEPRECATED("no longer necessary, just pass the object without lend")
+inline typename std::enable_if<!detail::have_ownership_s<Pointer>::value,
+                               detail::pointee<Pointer>*>::type
     lend(const Pointer& p)
 {
     return p;
-Original file line number
+Diff line change
@@ Expand Up / @@ -415,7 +415,7 @@ class machine_topology { @@
     };
-    using MachineTopology [[deprecated("please use machine_topology")]] =
+    using MachineTopology GKO_DEPRECATED("please use machine_topology") =
         machine_topology;
@@ Expand Down @@