Gazebo Common

API Reference

3.17.0
gz/common/SuppressWarning.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 
18 
19 #ifndef GZ_COMMON_SUPPRESSWARNING_HH_
20 #define GZ_COMMON_SUPPRESSWARNING_HH_
21 
22 #include <gz/common/detail/SuppressWarning.hh>
23 #include <gz/common/config.hh>
24 
25 // This header contains cross-platform macros for suppressing warnings. Please
26 // only use these macros responsibly when you are certain that the compiler is
27 // producing a warning that is not applicable to the specific instance. Do not
28 // use these macros to ignore legitimate warnings, even if you may find them
29 // irritating.
30 
31 /*
32  * Usage example:
33  *
34  * SomeClass* ptr = CreatePtr();
35  * IGN_COMMON_WARN_IGNORE__DELETE_NON_VIRTUAL_DESTRUCTOR
36  * delete ptr;
37  * IGN_COMMON_WARN_RESUME__DELETE_NON_VIRTUAL_DESTRUCTOR
38  *
39  */
40 
41 // Be sure to call the IGN_COMMON_WARN_RESUME__XXXXX macro at the end of the
42 // block of code where the warning suppression is needed. Otherwise, you might
43 // inadvertently suppress legitimate warnings.
44 
45 // ---- List of available suppressions ----
46 
53 #define IGN_COMMON_WARN_IGNORE__DELETE_NON_VIRTUAL_DESTRUCTOR \
54  DETAIL_IGN_COMMON_WARN_IGNORE__DELETE_NON_VIRTUAL_DESTRUCTOR
55 
56 #define IGN_COMMON_WARN_RESUME__DELETE_NON_VIRTUAL_DESTRUCTOR \
57  DETAIL_IGN_COMMON_WARN_RESUME__DELETE_NON_VIRTUAL_DESTRUCTOR
58 
59 
65 #define IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING \
66  DETAIL_IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
67 
68 #define IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING \
69  DETAIL_IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
70 
71 
72 // TODO(anyone): Add more warning types as they become relevant.
73 // Do not add warning
74 // types to suppress unless they are genuinely necessary.
75 
76 #endif