sot-talos-balance  1.6.0
deprecated.hh
Go to the documentation of this file.
1 // Copyright (C) 2008-2018 LAAS-CNRS, JRL AIST-CNRS.
2 //
3 // Redistribution and use in source and binary forms, with or without modification,
4 // are permitted provided that the following conditions are met:
5 //
6 // 1. Redistributions of source code must retain the above copyright notice,
7 // this list of conditions and the following disclaimer.
8 //
9 // 2. Redistributions in binary form must reproduce the above copyright notice,
10 // this list of conditions and the following disclaimer in the documentation
11 // and/or other materials provided with the distribution.
12 //
13 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
14 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
17 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
23 // POSSIBILITY OF SUCH DAMAGE.
24 
25 #ifndef SOT_TALOS_BALANCE_DEPRECATED_HH
26 # define SOT_TALOS_BALANCE_DEPRECATED_HH
27 
28 // Define a suffix which can be used to tag a type, a function or a a
29 // variable as deprecated (i.e. it will emit a warning when using it).
30 //
31 // Tagging a function as deprecated:
32 // void foo () SOT_TALOS_BALANCE_DEPRECATED;
33 //
34 // Tagging a type as deprecated:
35 // class Foo {};
36 // typedef Foo Bar SOT_TALOS_BALANCE_DEPRECATED;
37 //
38 // Tagging a variable as deprecated:
39 // int a SOT_TALOS_BALANCE_DEPRECATED = 0;
40 //
41 // The use of a macro is required as this is /not/ a standardized
42 // feature of C++ language or preprocessor, even if most of the
43 // compilers support it.
44 # ifdef __GNUC__
45 # define SOT_TALOS_BALANCE_DEPRECATED __attribute__ ((deprecated))
46 # else
47 # if defined(_MSC_VER) && !defined(__INTEL_COMPILER)
48 # define SOT_TALOS_BALANCE_DEPRECATED __declspec (deprecated)
49 # else
50 // If the compiler is not recognized, drop the feature.
51 # define SOT_TALOS_BALANCE_DEPRECATED /* nothing */
52 # endif // __MSVC__
53 # endif // __GNUC__
54 
55 #endif