-
Notifications
You must be signed in to change notification settings - Fork 10
/
SuppressWarning.hh
91 lines (77 loc) · 3.54 KB
/
SuppressWarning.hh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*
* Copyright (C) 2018 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#ifndef GZ_UTILS__SUPPRESSWARNING_HH_
#define GZ_UTILS__SUPPRESSWARNING_HH_
#include <gz/utils/detail/SuppressWarning.hh>
// This header contains cross-platform macros for suppressing warnings. Please
// only use these macros responsibly when you are certain that the compiler is
// producing a warning that is not applicable to the specific instance. Do not
// use these macros to ignore legitimate warnings, even if you may find them
// irritating.
/*
* Usage example:
*
* SomeClass *ptr = CreatePtr();
* GZ_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR
* delete ptr;
* GZ_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR
*
*/
// Be sure to call the GZ_UTILS_WARN_RESUME__XXXXX macro at the end of the
// block of code where the warning suppression is needed. Otherwise, you might
// inadvertently suppress legitimate warnings.
// ---- List of available suppressions ----
/// \brief Compilers might warn about deleting a pointer to a class that has
/// virtual functions without a virtual destructor or a `final` declaration,
/// because the pointer might secretly be pointing to a more derived class type.
/// We want to suppress this warning when we know for certain (via the design
/// of our implementation) that the pointer is definitely not pointing to a more
/// derived type.
#ifndef GZ_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR
#define GZ_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR \
DETAIL_GZ_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR
#endif
#ifndef GZ_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR
#define GZ_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR \
DETAIL_GZ_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR
#endif
/// \brief Microsoft Visual Studio does not automatically export the interface
/// information for member variables that belong to interface classes of a DLL.
/// Instead it issues this warning. When the member variable is private, we
/// choose to suppress the warning instead of needlessly adding the class
/// information to the DLL interface.
#ifndef GZ_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
#define GZ_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING \
DETAIL_GZ_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
#endif
#ifndef GZ_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
#define GZ_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING \
DETAIL_GZ_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
#endif
/// \brief Use this to suppress deprecation warnings. This may be useful when
/// retaining tests for deprecated methods to preserve code coverage.
#ifndef GZ_UTILS_WARN_IGNORE__DEPRECATED_DECLARATION
#define GZ_UTILS_WARN_IGNORE__DEPRECATED_DECLARATION \
DETAIL_GZ_UTILS_WARN_IGNORE__DEPRECATED_DECLARATION
#endif
#ifndef GZ_UTILS_WARN_RESUME__DEPRECATED_DECLARATION
#define GZ_UTILS_WARN_RESUME__DEPRECATED_DECLARATION \
DETAIL_GZ_UTILS_WARN_RESUME__DEPRECATED_DECLARATION
#endif
// TODO(anyone): Add more warning types as they become relevant.
// Do not add warning types to suppress unless they are genuinely necessary.
#endif // GZ_UTILS__SUPPRESSWARNING_HH_