1 /* -*- mode: C; buffer-read-only: t -*-
2 !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
3 This file is built by regen/warnings.pl.
4 Any changes made here will be lost!
8 #define Perl_Warn_Off_(x) ((x) / 8)
9 #define Perl_Warn_Bit_(x) (1 << ((x) % 8))
10 #define PerlWarnIsSet_(a, x) ((a)[Perl_Warn_Off_(x)] & Perl_Warn_Bit_(x))
12 #define G_WARN_OFF 0 /* $^W == 0 */
13 #define G_WARN_ON 1 /* -w flag and $^W != 0 */
14 #define G_WARN_ALL_ON 2 /* -W flag */
15 #define G_WARN_ALL_OFF 4 /* -X flag */
16 #define G_WARN_ONCE 8 /* set if 'once' ever enabled */
17 #define G_WARN_ALL_MASK (G_WARN_ALL_ON|G_WARN_ALL_OFF)
19 #define pWARN_STD NULL
20 #define pWARN_ALL &PL_WARN_ALL /* use warnings 'all' */
21 #define pWARN_NONE &PL_WARN_NONE /* no warnings 'all' */
23 #define specialWARN(x) ((x) == pWARN_STD || (x) == pWARN_ALL || \
26 /* if PL_warnhook is set to this value, then warnings die */
27 #define PERL_WARNHOOK_FATAL (&PL_sv_placeholder)
29 /* Warnings Categories added in Perl 5.008 */
32 #define WARN_CLOSURE 1
33 #define WARN_DEPRECATED 2
34 #define WARN_EXITING 3
40 #define WARN_NEWLINE 9
42 #define WARN_UNOPENED 11
44 #define WARN_NUMERIC 13
46 #define WARN_OVERFLOW 15
48 #define WARN_PORTABLE 17
49 #define WARN_RECURSION 18
50 #define WARN_REDEFINE 19
51 #define WARN_REGEXP 20
52 #define WARN_SEVERE 21
53 #define WARN_DEBUGGING 22
54 #define WARN_INPLACE 23
55 #define WARN_INTERNAL 24
56 #define WARN_MALLOC 25
57 #define WARN_SIGNAL 26
58 #define WARN_SUBSTR 27
59 #define WARN_SYNTAX 28
60 #define WARN_AMBIGUOUS 29
61 #define WARN_BAREWORD 30
63 #define WARN_PARENTHESIS 32
64 #define WARN_PRECEDENCE 33
65 #define WARN_PRINTF 34
66 #define WARN_PROTOTYPE 35
68 #define WARN_RESERVED 37
69 #define WARN_SEMICOLON 38
71 #define WARN_THREADS 40
72 #define WARN_UNINITIALIZED 41
73 #define WARN_UNPACK 42
78 /* Warnings Categories added in Perl 5.011 */
80 #define WARN_IMPRECISION 46
81 #define WARN_ILLEGALPROTO 47
83 /* Warnings Categories added in Perl 5.011003 */
85 #define WARN_DEPRECATED__GOTO_CONSTRUCT 48
86 #define WARN_DEPRECATED__UNICODE_PROPERTY_NAME 49
88 /* Warnings Categories added in Perl 5.013 */
90 #define WARN_NON_UNICODE 50
91 #define WARN_NONCHAR 51
92 #define WARN_SURROGATE 52
94 /* Warnings Categories added in Perl 5.017 */
96 #define WARN_EXPERIMENTAL 53
97 #define WARN_EXPERIMENTAL__REGEX_SETS 54
99 /* Warnings Categories added in Perl 5.019 */
101 #define WARN_SYSCALLS 55
103 /* Warnings Categories added in Perl 5.021 */
105 #define WARN_EXPERIMENTAL__CONST_ATTR 56
106 #define WARN_EXPERIMENTAL__RE_STRICT 57
107 #define WARN_EXPERIMENTAL__REFALIASING 58
108 #define WARN_LOCALE 59
109 #define WARN_MISSING 60
110 #define WARN_REDUNDANT 61
112 /* Warnings Categories added in Perl 5.025 */
114 #define WARN_EXPERIMENTAL__DECLARED_REFS 62
116 /* Warnings Categories added in Perl 5.025011 */
118 #define WARN_DEPRECATED__DOT_IN_INC 63
120 /* Warnings Categories added in Perl 5.027 */
122 #define WARN_SHADOW 64
124 /* Warnings Categories added in Perl 5.029 */
126 #define WARN_EXPERIMENTAL__PRIVATE_USE 65
127 #define WARN_EXPERIMENTAL__UNIPROP_WILDCARDS 66
128 #define WARN_EXPERIMENTAL__VLB 67
130 /* Warnings Categories added in Perl 5.033 */
132 #define WARN_EXPERIMENTAL__TRY 68
134 /* Warnings Categories added in Perl 5.035 */
136 #define WARN_EXPERIMENTAL__ARGS_ARRAY_WITH_SIGNATURES 69
137 #define WARN_EXPERIMENTAL__BUILTIN 70
138 #define WARN_EXPERIMENTAL__DEFER 71
139 #define WARN_EXPERIMENTAL__EXTRA_PAIRED_DELIMITERS 72
140 #define WARN_EXPERIMENTAL__FOR_LIST 73
141 #define WARN_SCALAR 74
143 /* Warnings Categories added in Perl 5.035009 */
145 #define WARN_DEPRECATED__VERSION_DOWNGRADE 75
147 /* Warnings Categories added in Perl 5.03501 */
149 #define WARN_DEPRECATED__DELIMITER_WILL_BE_PAIRED 76
151 /* Warnings Categories added in Perl 5.037 */
153 #define WARN_EXPERIMENTAL__CLASS 77
155 /* Warnings Categories added in Perl 5.037009 */
157 #define WARN_DEPRECATED__APOSTROPHE_AS_PACKAGE_SEPARATOR 78
159 /* Warnings Categories added in Perl 5.03701 */
161 #define WARN_DEPRECATED__SMARTMATCH 79
163 /* Warnings Categories added in Perl 5.03901 */
165 #define WARN_DEPRECATED__MISSING_IMPORT_CALLED_WITH_ARGS 80
167 #define WARN_ALLstring "\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125"
168 #define WARN_NONEstring "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"
170 #define isLEXWARN_on \
171 cBOOL(PL_curcop && PL_curcop->cop_warnings != pWARN_STD)
172 #define isLEXWARN_off \
173 cBOOL(!PL_curcop || PL_curcop->cop_warnings == pWARN_STD)
174 #define isWARN_ONCE (PL_dowarn & (G_WARN_ON|G_WARN_ONCE))
175 #define hasWARNBIT(c,x) (RCPV_LEN(c) > (2*(x)/8))
176 #define isWARN_on(c,x) (hasWARNBIT(c,x) \
177 ? PerlWarnIsSet_((U8 *)(c), 2*(x)) \
179 #define isWARNf_on(c,x) (hasWARNBIT(c,x) \
180 ? PerlWarnIsSet_((U8 *)(c), 2*(x)+1) \
183 #define DUP_WARNINGS(p) Perl_dup_warnings(aTHX_ p)
185 #define free_and_set_cop_warnings(cmp,w) STMT_START { \
186 if (!specialWARN((cmp)->cop_warnings)) rcpv_free((cmp)->cop_warnings); \
187 (cmp)->cop_warnings = w; \
192 =head1 Warning and Dieing
194 In all these calls, the C<U32 wI<n>> parameters are warning category
195 constants. You can see the ones currently available in
196 L<warnings/Category Hierarchy>, just capitalize all letters in the names
197 and prefix them by C<WARN_>. So, for example, the category C<void> used in a
198 perl program becomes C<WARN_VOID> when used in XS code and passed to one of
201 =for apidoc Am|bool|ckWARN|U32 w
202 =for apidoc_item ||ckWARN2|U32 w1|U32 w2
203 =for apidoc_item ||ckWARN3|U32 w1|U32 w2|U32 w3
204 =for apidoc_item ||ckWARN4|U32 w1|U32 w2|U32 w3|U32 w4
205 These return a boolean as to whether or not warnings are enabled for any of
206 the warning category(ies) parameters: C<w>, C<w1>, ....
208 Should any of the categories by default be enabled even if not within the
209 scope of S<C<use warnings>>, instead use the C<L</ckWARN_d>> macros.
211 The categories must be completely independent, one may not be subclassed from
214 =for apidoc Am|bool|ckWARN_d|U32 w
215 =for apidoc_item ||ckWARN2_d|U32 w1|U32 w2
216 =for apidoc_item ||ckWARN3_d|U32 w1|U32 w2|U32 w3
217 =for apidoc_item ||ckWARN4_d|U32 w1|U32 w2|U32 w3|U32 w4
219 Like C<L</ckWARN>>, but for use if and only if the warning category(ies) is by
220 default enabled even if not within the scope of S<C<use warnings>>.
222 =for apidoc Am|U32|packWARN|U32 w1
223 =for apidoc_item ||packWARN2|U32 w1|U32 w2
224 =for apidoc_item ||packWARN3|U32 w1|U32 w2|U32 w3
225 =for apidoc_item ||packWARN4|U32 w1|U32 w2|U32 w3|U32 w4
227 These macros are used to pack warning categories into a single U32 to pass to
228 macros and functions that take a warning category parameter. The number of
229 categories to pack is given by the name, with a corresponding number of
230 category parameters passed.
236 #define ckWARN(w) Perl_ckwarn(aTHX_ packWARN(w))
238 /* The w1, w2 ... should be independent warnings categories; one shouldn't be
239 * a subcategory of any other */
241 #define ckWARN2(w1,w2) Perl_ckwarn(aTHX_ packWARN2(w1,w2))
242 #define ckWARN3(w1,w2,w3) Perl_ckwarn(aTHX_ packWARN3(w1,w2,w3))
243 #define ckWARN4(w1,w2,w3,w4) Perl_ckwarn(aTHX_ packWARN4(w1,w2,w3,w4))
245 #define ckWARN_d(w) Perl_ckwarn_d(aTHX_ packWARN(w))
246 #define ckWARN2_d(w1,w2) Perl_ckwarn_d(aTHX_ packWARN2(w1,w2))
247 #define ckWARN3_d(w1,w2,w3) Perl_ckwarn_d(aTHX_ packWARN3(w1,w2,w3))
248 #define ckWARN4_d(w1,w2,w3,w4) Perl_ckwarn_d(aTHX_ packWARN4(w1,w2,w3,w4))
252 #define packWARN(a) (a )
254 /* The a, b, ... should be independent warnings categories; one shouldn't be
255 * a subcategory of any other */
257 #define packWARN2(a,b) ((a) | ((b)<<8) )
258 #define packWARN3(a,b,c) ((a) | ((b)<<8) | ((c)<<16) )
259 #define packWARN4(a,b,c,d) ((a) | ((b)<<8) | ((c)<<16) | ((d) <<24))
261 #define unpackWARN1(x) ((U8) (x) )
262 #define unpackWARN2(x) ((U8) ((x) >> 8))
263 #define unpackWARN3(x) ((U8) ((x) >> 16))
264 #define unpackWARN4(x) ((U8) ((x) >> 24))
268 !specialWARN(PL_curcop->cop_warnings) && \
269 (isWARNf_on(PL_curcop->cop_warnings, unpackWARN1(x)) || \
271 (isWARNf_on(PL_curcop->cop_warnings, unpackWARN2(x)) || \
273 (isWARNf_on(PL_curcop->cop_warnings, unpackWARN3(x)) || \
275 isWARNf_on(PL_curcop->cop_warnings, unpackWARN4(x)))))))))
280 =for apidoc Amnh||WARN_ALL
281 =for apidoc Amnh||WARN_CLOSURE
282 =for apidoc Amnh||WARN_DEPRECATED
283 =for apidoc Amnh||WARN_EXITING
284 =for apidoc Amnh||WARN_GLOB
285 =for apidoc Amnh||WARN_IO
286 =for apidoc Amnh||WARN_CLOSED
287 =for apidoc Amnh||WARN_EXEC
288 =for apidoc Amnh||WARN_LAYER
289 =for apidoc Amnh||WARN_NEWLINE
290 =for apidoc Amnh||WARN_PIPE
291 =for apidoc Amnh||WARN_UNOPENED
292 =for apidoc Amnh||WARN_MISC
293 =for apidoc Amnh||WARN_NUMERIC
294 =for apidoc Amnh||WARN_ONCE
295 =for apidoc Amnh||WARN_OVERFLOW
296 =for apidoc Amnh||WARN_PACK
297 =for apidoc Amnh||WARN_PORTABLE
298 =for apidoc Amnh||WARN_RECURSION
299 =for apidoc Amnh||WARN_REDEFINE
300 =for apidoc Amnh||WARN_REGEXP
301 =for apidoc Amnh||WARN_SEVERE
302 =for apidoc Amnh||WARN_DEBUGGING
303 =for apidoc Amnh||WARN_INPLACE
304 =for apidoc Amnh||WARN_INTERNAL
305 =for apidoc Amnh||WARN_MALLOC
306 =for apidoc Amnh||WARN_SIGNAL
307 =for apidoc Amnh||WARN_SUBSTR
308 =for apidoc Amnh||WARN_SYNTAX
309 =for apidoc Amnh||WARN_AMBIGUOUS
310 =for apidoc Amnh||WARN_BAREWORD
311 =for apidoc Amnh||WARN_DIGIT
312 =for apidoc Amnh||WARN_PARENTHESIS
313 =for apidoc Amnh||WARN_PRECEDENCE
314 =for apidoc Amnh||WARN_PRINTF
315 =for apidoc Amnh||WARN_PROTOTYPE
316 =for apidoc Amnh||WARN_QW
317 =for apidoc Amnh||WARN_RESERVED
318 =for apidoc Amnh||WARN_SEMICOLON
319 =for apidoc Amnh||WARN_TAINT
320 =for apidoc Amnh||WARN_THREADS
321 =for apidoc Amnh||WARN_UNINITIALIZED
322 =for apidoc Amnh||WARN_UNPACK
323 =for apidoc Amnh||WARN_UNTIE
324 =for apidoc Amnh||WARN_UTF8
325 =for apidoc Amnh||WARN_VOID
326 =for apidoc Amnh||WARN_IMPRECISION
327 =for apidoc Amnh||WARN_ILLEGALPROTO
328 =for apidoc Amnh||WARN_DEPRECATED__GOTO_CONSTRUCT
329 =for apidoc Amnh||WARN_DEPRECATED__UNICODE_PROPERTY_NAME
330 =for apidoc Amnh||WARN_NON_UNICODE
331 =for apidoc Amnh||WARN_NONCHAR
332 =for apidoc Amnh||WARN_SURROGATE
333 =for apidoc Amnh||WARN_EXPERIMENTAL
334 =for apidoc Amnh||WARN_EXPERIMENTAL__REGEX_SETS
335 =for apidoc Amnh||WARN_SYSCALLS
336 =for apidoc Amnh||WARN_EXPERIMENTAL__CONST_ATTR
337 =for apidoc Amnh||WARN_EXPERIMENTAL__RE_STRICT
338 =for apidoc Amnh||WARN_EXPERIMENTAL__REFALIASING
339 =for apidoc Amnh||WARN_LOCALE
340 =for apidoc Amnh||WARN_MISSING
341 =for apidoc Amnh||WARN_REDUNDANT
342 =for apidoc Amnh||WARN_EXPERIMENTAL__DECLARED_REFS
343 =for apidoc Amnh||WARN_DEPRECATED__DOT_IN_INC
344 =for apidoc Amnh||WARN_SHADOW
345 =for apidoc Amnh||WARN_EXPERIMENTAL__PRIVATE_USE
346 =for apidoc Amnh||WARN_EXPERIMENTAL__UNIPROP_WILDCARDS
347 =for apidoc Amnh||WARN_EXPERIMENTAL__VLB
348 =for apidoc Amnh||WARN_EXPERIMENTAL__TRY
349 =for apidoc Amnh||WARN_EXPERIMENTAL__ARGS_ARRAY_WITH_SIGNATURES
350 =for apidoc Amnh||WARN_EXPERIMENTAL__BUILTIN
351 =for apidoc Amnh||WARN_EXPERIMENTAL__DEFER
352 =for apidoc Amnh||WARN_EXPERIMENTAL__EXTRA_PAIRED_DELIMITERS
353 =for apidoc Amnh||WARN_EXPERIMENTAL__FOR_LIST
354 =for apidoc Amnh||WARN_SCALAR
355 =for apidoc Amnh||WARN_DEPRECATED__VERSION_DOWNGRADE
356 =for apidoc Amnh||WARN_DEPRECATED__DELIMITER_WILL_BE_PAIRED
357 =for apidoc Amnh||WARN_EXPERIMENTAL__CLASS
358 =for apidoc Amnh||WARN_DEPRECATED__APOSTROPHE_AS_PACKAGE_SEPARATOR
359 =for apidoc Amnh||WARN_DEPRECATED__SMARTMATCH
360 =for apidoc Amnh||WARN_DEPRECATED__MISSING_IMPORT_CALLED_WITH_ARGS
365 /* end of file warnings.h */
367 /* ex: set ro ft=c: */