DART  6.10.1
Deprecated.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2021, The DART development contributors
3  * All rights reserved.
4  *
5  * The list of contributors can be found at:
6  * https://github.com/dartsim/dart/blob/master/LICENSE
7  *
8  * This file is provided under the following "BSD-style" License:
9  * Redistribution and use in source and binary forms, with or
10  * without modification, are permitted provided that the following
11  * conditions are met:
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef DART_COMMON_DEPRECATED_HPP_
34 #define DART_COMMON_DEPRECATED_HPP_
35 
36 #include "dart/config.hpp"
37 
38 //==============================================================================
39 // Deprecated is used for backward compatibility between different minor
40 // versions of DART. Every deprecated function should be removed for every major
41 // version up.
42 //==============================================================================
43 
44 #if defined(__GNUC__) || defined(__clang__)
45 # define DART_DEPRECATED(version) __attribute__((deprecated))
46 # define DART_FORCEINLINE __attribute__((always_inline))
47 #elif defined(_MSC_VER)
48 # define DART_DEPRECATED(version) __declspec(deprecated)
49 # define DART_FORCEINLINE _forceinline
50 #else
51 # define DART_DEPRECATED(version) ()
52 # define DART_FORCEINLINE
53 #endif
54 
55 // We define two convenient macros that can be used to suppress
56 // deprecated-warnings for a specific code block rather than a whole project.
57 // This macros would be useful when you need to call deprecated function for
58 // some reason (e.g., for backward compatibility) but don't want warnings.
59 //
60 // Example code:
61 //
62 // deprecated_function() // warning
63 //
64 // DART_SUPPRESS_DEPRECATED_BEGIN
65 // deprecated_function() // okay, no warning
66 // DART_SUPPRESS_DEPRECATED_END
67 //
68 #if defined(DART_COMPILER_GCC)
69 
70 # define DART_SUPPRESS_DEPRECATED_BEGIN \
71  _Pragma("GCC diagnostic push") \
72  _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
73 
74 # define DART_SUPPRESS_DEPRECATED_END _Pragma("GCC diagnostic pop")
75 
76 #elif defined(DART_COMPILER_CLANG)
77 
78 # define DART_SUPPRESS_DEPRECATED_BEGIN \
79  _Pragma("clang diagnostic push") \
80  _Pragma("clang diagnostic ignored \"-Wdeprecated-declarations\"")
81 
82 # define DART_SUPPRESS_DEPRECATED_END _Pragma("clang diagnostic pop")
83 
84 #elif defined(DART_COMPILER_MSVC)
85 
86 # define DART_SUPPRESS_DEPRECATED_BEGIN \
87  __pragma(warning(push)) __pragma(warning(disable : 4996))
88 
89 # define DART_SUPPRESS_DEPRECATED_END __pragma(warning(pop))
90 
91 #endif
92 
93 #endif // DART_COMMON_DEPRECATED_HPP_