HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pragmas.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the terms set forth in the LICENSE.txt file available at
5 // https://openusd.org/license.
6 //
7 #ifndef PXR_BASE_ARCH_PRAGMAS_H
8 #define PXR_BASE_ARCH_PRAGMAS_H
9 
10 /// \file arch/pragmas.h
11 /// Pragmas for controlling compiler-specific behaviors.
12 ///
13 /// This header contains pragmas used to control compiler-specific behaviors.
14 /// Behaviors that are not supported or required by a certain compiler should
15 /// be implemented as a no-op.
16 
17 #include "pxr/base/arch/defines.h"
18 
19 #if defined(ARCH_COMPILER_GCC)
20 
21  #define ARCH_PRAGMA_PUSH \
22  _Pragma("GCC diagnostic push")
23 
24  #define ARCH_PRAGMA_POP \
25  _Pragma("GCC diagnostic pop")
26 
27  #define ARCH_PRAGMA(x) _Pragma(#x)
28 
29  #define ARCH_PRAGMA_PUSH_MACRO(macro_name) \
30  ARCH_PRAGMA(push_macro(#macro_name))
31 
32  #define ARCH_PRAGMA_POP_MACRO(macro_name) \
33  ARCH_PRAGMA(pop_macro(#macro_name))
34 
35  // Convert errors about variables that may be used before initialization
36  // into warnings.
37  //
38  // This works around GCC bug 47679.
39  #define ARCH_PRAGMA_MAYBE_UNINITIALIZED \
40  _Pragma("GCC diagnostic ignored \"-Wmaybe-uninitialized\"")
41 
42  #define ARCH_PRAGMA_MACRO_REDEFINITION \
43  _Pragma("GCC diagnostic ignored \"-Wbuiltin-macro-redefined\"")
44 
45  #define ARCH_PRAGMA_WRITE_STRINGS \
46  _Pragma("GCC diagnostic ignored \"-Wwrite-strings\"")
47 
48  #define ARCH_PRAGMA_UNUSED_FUNCTION \
49  _Pragma("GCC diagnostic ignored \"-Wunused-function\"")
50 
51  #define ARCH_PRAGMA_STRINGOP_OVERFLOW \
52  _Pragma("GCC diagnostic ignored \"-Wstringop-overflow=\"")
53 
54  #if ARCH_COMPILER_GCC_MAJOR >= 13
55  #define ARCH_PRAGMA_SELF_MOVE \
56  _Pragma("GCC diagnostic ignored \"-Wself-move\"")
57  #endif
58 
59 #elif defined(ARCH_COMPILER_CLANG)
60 
61  #define ARCH_PRAGMA_PUSH \
62  _Pragma("clang diagnostic push")
63 
64  #define ARCH_PRAGMA_POP \
65  _Pragma("clang diagnostic pop")
66 
67  #define ARCH_PRAGMA(x) _Pragma(#x)
68 
69  #define ARCH_PRAGMA_PUSH_MACRO(macro_name) \
70  ARCH_PRAGMA(push_macro(#macro_name))
71 
72  #define ARCH_PRAGMA_POP_MACRO(macro_name) \
73  ARCH_PRAGMA(pop_macro(#macro_name))
74 
75  #define ARCH_PRAGMA_MACRO_REDEFINITION \
76  _Pragma("clang diagnostic ignored \"-Wbuiltin-macro-redefined\"")
77 
78  #define ARCH_PRAGMA_UNDEFINED_VAR_TEMPLATE \
79  _Pragma("clang diagnostic ignored \"-Wundefined-var-template\"")
80 
81  #define ARCH_PRAGMA_WRITE_STRINGS \
82  _Pragma("clang diagnostic ignored \"-Wwrite-strings\"")
83 
84  #define ARCH_PRAGMA_UNUSED_FUNCTION \
85  _Pragma("clang diagnostic ignored \"-Wunused-function\"")
86 
87  #define ARCH_PRAGMA_UNUSED_PRIVATE_FIELD \
88  _Pragma("clang diagnostic ignored \"-Wunused-private-field\"")
89 
90  #define ARCH_PRAGMA_INSTANTIATION_AFTER_SPECIALIZATION \
91  _Pragma("clang diagnostic ignored \"-Winstantiation-after-specialization\"")
92 
93  #define ARCH_PRAGMA_INSTANCE_METHOD_NOT_FOUND \
94  _Pragma("clang diagnostic ignored \"-Wobjc-method-access\"")
95 
96  #define ARCH_PRAGMA_SELF_MOVE \
97  _Pragma("clang diagnostic ignored \"-Wself-move\"")
98 
99  #define ARCH_PRAGMA_SELF_ASSIGN_OVERLOADED \
100  _Pragma("clang diagnostic ignored \"-Wself-assign-overloaded\"")
101 
102 #elif defined(ARCH_COMPILER_MSVC)
103 
104  #define ARCH_PRAGMA_PUSH \
105  __pragma(warning(push))
106 
107  #define ARCH_PRAGMA_POP \
108  __pragma(warning(pop))
109 
110  #define ARCH_PRAGMA(x) __pragma(x)
111 
112  #define ARCH_PRAGMA_PUSH_MACRO(macro_name) \
113  __pragma(push_macro(#macro_name))
114 
115  #define ARCH_PRAGMA_POP_MACRO(macro_name) \
116  __pragma(pop_macro(#macro_name))
117 
118  #define ARCH_PRAGMA_MACRO_TOO_FEW_ARGUMENTS \
119  __pragma(warning(disable:4003))
120 
121  #define ARCH_PRAGMA_MACRO_REDEFINITION \
122  __pragma(warning(disable:4005))
123 
124  #define ARCH_PRAGMA_UNUSED_FUNCTION \
125  __pragma(warning(disable:4505))
126 
127  #define ARCH_PRAGMA_QUALIFIER_HAS_NO_MEANING \
128  __pragma(warning(disable:4180))
129 
130  #define ARCH_PRAGMA_ZERO_SIZED_STRUCT \
131  __pragma(warning(disable:4200))
132 
133  #define ARCH_PRAGMA_NEEDS_EXPORT_INTERFACE \
134  __pragma(warning(disable:4251))
135 
136  #define ARCH_PRAGMA_CONVERSION_FROM_SIZET \
137  __pragma(warning(disable:4267))
138 
139  #define ARCH_PRAGMA_MAY_NOT_BE_ALIGNED \
140  __pragma(warning(disable:4316))
141 
142  #define ARCH_PRAGMA_SHIFT_TO_64_BITS \
143  __pragma(warning(disable:4334))
144 
145  #define ARCH_PRAGMA_DESTRUCTOR_IMPLICIT_DEFINE \
146  __pragma(warning(disable:4624))
147 
148  #define ARCH_PRAGMA_DEPRECATED \
149  __pragma(warning(disable:4996))
150 
151  #define ARCH_PRAGMA_FORCING_TO_BOOL \
152  __pragma(warning(disable:4800))
153 
154  #define ARCH_PRAGMA_UNSAFE_USE_OF_BOOL \
155  __pragma(warning(disable:4804))
156 
157  #define ARCH_PRAGMA_UNARY_MINUS_ON_UNSIGNED \
158  __pragma(warning(disable:4146))
159 
160  #define ARCH_PRAGMA_NON_EXPORTED_BASE_CLASS \
161  __pragma(warning(disable:4275))
162 
163 #endif
164 
165 #if !defined ARCH_PRAGMA_PUSH
166  #define ARCH_PRAGMA_PUSH
167 #endif
168 
169 #if !defined ARCH_PRAGMA_POP
170  #define ARCH_PRAGMA_POP
171 #endif
172 
173 #if !defined ARCH_PRAGMA
174  #define ARCH_PRAGMA
175 #endif
176 
177 #if !defined ARCH_PRAGMA_PUSH_MACRO
178  #define ARCH_PRAGMA_PUSH_MACRO
179 #endif
180 
181 #if !defined ARCH_PRAGMA_POP_MACRO
182  #define ARCH_PRAGMA_POP_MACRO
183 #endif
184 
185 #if !defined ARCH_PRAGMA_MAYBE_UNINITIALIZED
186  #define ARCH_PRAGMA_MAYBE_UNINITIALIZED
187 #endif
188 
189 #if !defined ARCH_PRAGMA_MACRO_REDEFINITION
190  #define ARCH_PRAGMA_MACRO_REDEFINITION
191 #endif
192 
193 #if !defined ARCH_PRAGMA_WRITE_STRINGS
194  #define ARCH_PRAGMA_WRITE_STRINGS
195 #endif
196 
197 #if !defined ARCH_PRAGMA_UNUSED_FUNCTION
198  #define ARCH_PRAGMA_UNUSED_FUNCTION
199 #endif
200 
201 #if !defined ARCH_PRAGMA_STRINGOP_OVERFLOW
202  #define ARCH_PRAGMA_STRINGOP_OVERFLOW
203 #endif
204 
205 #if !defined ARCH_PRAGMA_UNUSED_PRIVATE_FIELD
206  #define ARCH_PRAGMA_UNUSED_PRIVATE_FIELD
207 #endif
208 
209 #if !defined ARCH_PRAGMA_MACRO_TOO_FEW_ARGUMENTS
210  #define ARCH_PRAGMA_MACRO_TOO_FEW_ARGUMENTS
211 #endif
212 
213 #if !defined ARCH_PRAGMA_QUALIFIER_HAS_NO_MEANING
214  #define ARCH_PRAGMA_QUALIFIER_HAS_NO_MEANING
215 #endif
216 
217 #if !defined ARCH_PRAGMA_ZERO_SIZED_STRUCT
218  #define ARCH_PRAGMA_ZERO_SIZED_STRUCT
219 #endif
220 
221 #if !defined ARCH_PRAGMA_NEEDS_EXPORT_INTERFACE
222  #define ARCH_PRAGMA_NEEDS_EXPORT_INTERFACE
223 #endif
224 
225 #if !defined ARCH_PRAGMA_CONVERSION_FROM_SIZET
226  #define ARCH_PRAGMA_CONVERSION_FROM_SIZET
227 #endif
228 
229 #if !defined ARCH_PRAGMA_MAY_NOT_BE_ALIGNED
230  #define ARCH_PRAGMA_MAY_NOT_BE_ALIGNED
231 #endif
232 
233 #if !defined ARCH_PRAGMA_SHIFT_TO_64_BITS
234  #define ARCH_PRAGMA_SHIFT_TO_64_BITS
235 #endif
236 
237 #if !defined ARCH_PRAGMA_DESTRUCTOR_IMPLICIT_DEFINE
238  #define ARCH_PRAGMA_DESTRUCTOR_IMPLICIT_DEFINE
239 #endif
240 
241 #if !defined ARCH_PRAGMA_DEPRECATED
242  #define ARCH_PRAGMA_DEPRECATED
243 #endif
244 
245 #if !defined ARCH_PRAGMA_FORCING_TO_BOOL
246  #define ARCH_PRAGMA_FORCING_TO_BOOL
247 #endif
248 
249 #if !defined ARCH_PRAGMA_UNSAFE_USE_OF_BOOL
250  #define ARCH_PRAGMA_UNSAFE_USE_OF_BOOL
251 #endif
252 
253 #if !defined ARCH_PRAGMA_UNARY_MINUS_ON_UNSIGNED
254  #define ARCH_PRAGMA_UNARY_MINUS_ON_UNSIGNED
255 #endif
256 
257 #if !defined ARCH_PRAGMA_INSTANTIATION_AFTER_SPECIALIZATION
258  #define ARCH_PRAGMA_INSTANTIATION_AFTER_SPECIALIZATION
259 #endif
260 
261 #if !defined ARCH_PRAGMA_UNDEFINED_VAR_TEMPLATE
262  #define ARCH_PRAGMA_UNDEFINED_VAR_TEMPLATE
263 #endif
264 
265 #if !defined ARCH_PRAGMA_INSTANCE_METHOD_NOT_FOUND
266  #define ARCH_PRAGMA_INSTANCE_METHOD_NOT_FOUND
267 #endif
268 
269 #if !defined ARCH_PRAGMA_NON_EXPORTED_BASE_CLASS
270  #define ARCH_PRAGMA_NON_EXPORTED_BASE_CLASS
271 #endif
272 
273 #if !defined ARCH_PRAGMA_SELF_MOVE
274  #define ARCH_PRAGMA_SELF_MOVE
275 #endif
276 
277 #if !defined ARCH_PRAGMA_SELF_ASSIGN_OVERLOADED
278  #define ARCH_PRAGMA_SELF_ASSIGN_OVERLOADED
279 #endif
280 
281 #endif // PXR_BASE_ARCH_PRAGMAS_H