warning.h
Go to the documentation of this file.
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2016, Open Source Robotics Foundation
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of CNRS-LAAS and AIST nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
36 
37 #ifndef FCL_COMMON_WARNING_H
38 #define FCL_COMMON_WARNING_H
39 
40 #include "fcl/config.h"
41 
42 // We define two convenient macros that can be used to suppress
43 // deprecated-warnings for a specific code block rather than a whole project.
44 // This macros would be useful when you need to call deprecated function for
45 // some reason (e.g., for backward compatibility) but don't want warnings.
46 //
47 // Example code:
48 //
49 // deprecated_function() // warning
50 //
51 // FCL_SUPPRESS_DEPRECATED_BEGIN
52 // deprecated_function() // okay, no warning
53 // FCL_SUPPRESS_DEPRECATED_END
54 //
55 #if defined (FCL_COMPILER_GCC)
56 
57  #define FCL_SUPPRESS_DEPRECATED_BEGIN \
58  _Pragma("GCC diagnostic push") \
59  _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
60 
61  #define FCL_SUPPRESS_DEPRECATED_END \
62  _Pragma("GCC diagnostic pop")
63 
64  #define FCL_SUPPRESS_UNINITIALIZED_BEGIN \
65  _Pragma("GCC diagnostic push") \
66  _Pragma("GCC diagnostic ignored \"-Wuninitialized\"")
67 
68  #define FCL_SUPPRESS_UNINITIALIZED_END \
69  _Pragma("GCC diagnostic pop")
70 
71 #elif defined (FCL_COMPILER_CLANG)
72 
73  #define FCL_SUPPRESS_DEPRECATED_BEGIN \
74  _Pragma("clang diagnostic push") \
75  _Pragma("clang diagnostic ignored \"-Wdeprecated-declarations\"")
76 
77  #define FCL_SUPPRESS_DEPRECATED_END \
78  _Pragma("clang diagnostic pop")
79 
80  #define FCL_SUPPRESS_UNINITIALIZED_BEGIN \
81  _Pragma("clang diagnostic push") \
82  _Pragma("clang diagnostic ignored \"-Wuninitialized\"")
83 
84  #define FCL_SUPPRESS_UNINITIALIZED_END \
85  _Pragma("clang diagnostic pop")
86 
87 #elif defined (FCL_COMPILER_MSVC)
88 
89  #define FCL_SUPPRESS_DEPRECATED_BEGIN \
90  __pragma(warning(push)) \
91  __pragma(warning(disable:4996))
92 
93  #define FCL_SUPPRESS_DEPRECATED_END \
94  __pragma(warning(pop))
95 
96  #define FCL_SUPPRESS_UNINITIALIZED_BEGIN // TODO
97 
98  #define FCL_SUPPRESS_UNINITIALIZED_END // TODO
99 
100 #endif
101 
102 #endif // FCL_COMMON_WARNING_H


fcl
Author(s):
autogenerated on Sat Sep 11 2021 02:37:42