1 /* -*- 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))
13 #define G_WARN_OFF 0 /* $^W == 0 */
14 #define G_WARN_ON 1 /* -w flag and $^W != 0 */
15 #define G_WARN_ALL_ON 2 /* -W flag */
16 #define G_WARN_ALL_OFF 4 /* -X flag */
17 #define G_WARN_ONCE 8 /* set if 'once' ever enabled */
18 #define G_WARN_ALL_MASK (G_WARN_ALL_ON|G_WARN_ALL_OFF)
20 #define pWARN_STD NULL
21 #define pWARN_ALL (STRLEN *) &PL_WARN_ALL /* use warnings 'all' */
22 #define pWARN_NONE (STRLEN *) &PL_WARN_NONE /* no warnings 'all' */
24 #define specialWARN(x) ((x) == pWARN_STD || (x) == pWARN_ALL || \
27 /* if PL_warnhook is set to this value, then warnings die */
28 #define PERL_WARNHOOK_FATAL (&PL_sv_placeholder)
30 /* Warnings Categories added in Perl 5.008 */
33 #define WARN_CLOSURE 1
34 #define WARN_DEPRECATED 2
35 #define WARN_EXITING 3
41 #define WARN_NEWLINE 9
43 #define WARN_UNOPENED 11
45 #define WARN_NUMERIC 13
47 #define WARN_OVERFLOW 15
49 #define WARN_PORTABLE 17
50 #define WARN_RECURSION 18
51 #define WARN_REDEFINE 19
52 #define WARN_REGEXP 20
53 #define WARN_SEVERE 21
54 #define WARN_DEBUGGING 22
55 #define WARN_INPLACE 23
56 #define WARN_INTERNAL 24
57 #define WARN_MALLOC 25
58 #define WARN_SIGNAL 26
59 #define WARN_SUBSTR 27
60 #define WARN_SYNTAX 28
61 #define WARN_AMBIGUOUS 29
62 #define WARN_BAREWORD 30
64 #define WARN_PARENTHESIS 32
65 #define WARN_PRECEDENCE 33
66 #define WARN_PRINTF 34
67 #define WARN_PROTOTYPE 35
69 #define WARN_RESERVED 37
70 #define WARN_SEMICOLON 38
72 #define WARN_THREADS 40
73 #define WARN_UNINITIALIZED 41
74 #define WARN_UNPACK 42
79 /* Warnings Categories added in Perl 5.011 */
81 #define WARN_IMPRECISION 46
82 #define WARN_ILLEGALPROTO 47
84 /* Warnings Categories added in Perl 5.013 */
86 #define WARN_NON_UNICODE 48
87 #define WARN_NONCHAR 49
88 #define WARN_SURROGATE 50
90 /* Warnings Categories added in Perl 5.017 */
92 #define WARN_EXPERIMENTAL 51
93 #define WARN_EXPERIMENTAL__REGEX_SETS 52
94 #define WARN_EXPERIMENTAL__SMARTMATCH 53
96 /* Warnings Categories added in Perl 5.019 */
98 #define WARN_SYSCALLS 54
100 /* Warnings Categories added in Perl 5.021 */
102 #define WARN_EXPERIMENTAL__CONST_ATTR 55
103 #define WARN_EXPERIMENTAL__RE_STRICT 56
104 #define WARN_EXPERIMENTAL__REFALIASING 57
105 #define WARN_LOCALE 58
106 #define WARN_MISSING 59
107 #define WARN_REDUNDANT 60
109 /* Warnings Categories added in Perl 5.025 */
111 #define WARN_EXPERIMENTAL__DECLARED_REFS 61
113 /* Warnings Categories added in Perl 5.027 */
115 #define WARN_SHADOW 62
117 /* Warnings Categories added in Perl 5.029 */
119 #define WARN_EXPERIMENTAL__PRIVATE_USE 63
120 #define WARN_EXPERIMENTAL__UNIPROP_WILDCARDS 64
121 #define WARN_EXPERIMENTAL__VLB 65
123 /* Warnings Categories added in Perl 5.033 */
125 #define WARN_EXPERIMENTAL__TRY 66
127 /* Warnings Categories added in Perl 5.035 */
129 #define WARN_EXPERIMENTAL__ARGS_ARRAY_WITH_SIGNATURES 67
130 #define WARN_EXPERIMENTAL__BUILTIN 68
131 #define WARN_EXPERIMENTAL__DEFER 69
132 #define WARN_EXPERIMENTAL__EXTRA_PAIRED_DELIMITERS 70
133 #define WARN_EXPERIMENTAL__FOR_LIST 71
134 #define WARN_SCALAR 72
136 #define WARN_ALLstring "\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125"
137 #define WARN_NONEstring "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"
139 #define isLEXWARN_on \
140 cBOOL(PL_curcop && PL_curcop->cop_warnings != pWARN_STD)
141 #define isLEXWARN_off \
142 cBOOL(!PL_curcop || PL_curcop->cop_warnings == pWARN_STD)
143 #define isWARN_ONCE (PL_dowarn & (G_WARN_ON|G_WARN_ONCE))
144 #define isWARN_on(c,x) (PerlWarnIsSet_((U8 *)(c + 1), 2*(x)))
145 #define isWARNf_on(c,x) (PerlWarnIsSet_((U8 *)(c + 1), 2*(x)+1))
147 #define DUP_WARNINGS(p) Perl_dup_warnings(aTHX_ p)
149 #define free_and_set_cop_warnings(cmp,w) STMT_START { \
150 if (!specialWARN((cmp)->cop_warnings)) PerlMemShared_free((cmp)->cop_warnings); \
151 (cmp)->cop_warnings = w; \
156 =head1 Warning and Dieing
158 In all these calls, the C<U32 wI<n>> parameters are warning category
159 constants. You can see the ones currently available in
160 L<warnings/Category Hierarchy>, just capitalize all letters in the names
161 and prefix them by C<WARN_>. So, for example, the category C<void> used in a
162 perl program becomes C<WARN_VOID> when used in XS code and passed to one of
165 =for apidoc Am|bool|ckWARN|U32 w
166 =for apidoc_item ||ckWARN2|U32 w1|U32 w2
167 =for apidoc_item ||ckWARN3|U32 w1|U32 w2|U32 w3
168 =for apidoc_item ||ckWARN4|U32 w1|U32 w2|U32 w3|U32 w4
169 These return a boolean as to whether or not warnings are enabled for any of
170 the warning category(ies) parameters: C<w>, C<w1>, ....
172 Should any of the categories by default be enabled even if not within the
173 scope of S<C<use warnings>>, instead use the C<L</ckWARN_d>> macros.
175 The categories must be completely independent, one may not be subclassed from
178 =for apidoc Am|bool|ckWARN_d|U32 w
179 =for apidoc_item ||ckWARN2_d|U32 w1|U32 w2
180 =for apidoc_item ||ckWARN3_d|U32 w1|U32 w2|U32 w3
181 =for apidoc_item ||ckWARN4_d|U32 w1|U32 w2|U32 w3|U32 w4
183 Like C<L</ckWARN>>, but for use if and only if the warning category(ies) is by
184 default enabled even if not within the scope of S<C<use warnings>>.
186 =for apidoc Am|U32|packWARN|U32 w1
187 =for apidoc_item ||packWARN2|U32 w1|U32 w2
188 =for apidoc_item ||packWARN3|U32 w1|U32 w2|U32 w3
189 =for apidoc_item ||packWARN4|U32 w1|U32 w2|U32 w3|U32 w4
191 These macros are used to pack warning categories into a single U32 to pass to
192 macros and functions that take a warning category parameter. The number of
193 categories to pack is given by the name, with a corresponding number of
194 category parameters passed.
200 #define ckWARN(w) Perl_ckwarn(aTHX_ packWARN(w))
202 /* The w1, w2 ... should be independent warnings categories; one shouldn't be
203 * a subcategory of any other */
205 #define ckWARN2(w1,w2) Perl_ckwarn(aTHX_ packWARN2(w1,w2))
206 #define ckWARN3(w1,w2,w3) Perl_ckwarn(aTHX_ packWARN3(w1,w2,w3))
207 #define ckWARN4(w1,w2,w3,w4) Perl_ckwarn(aTHX_ packWARN4(w1,w2,w3,w4))
209 #define ckWARN_d(w) Perl_ckwarn_d(aTHX_ packWARN(w))
210 #define ckWARN2_d(w1,w2) Perl_ckwarn_d(aTHX_ packWARN2(w1,w2))
211 #define ckWARN3_d(w1,w2,w3) Perl_ckwarn_d(aTHX_ packWARN3(w1,w2,w3))
212 #define ckWARN4_d(w1,w2,w3,w4) Perl_ckwarn_d(aTHX_ packWARN4(w1,w2,w3,w4))
216 #define packWARN(a) (a )
218 /* The a, b, ... should be independent warnings categories; one shouldn't be
219 * a subcategory of any other */
221 #define packWARN2(a,b) ((a) | ((b)<<8) )
222 #define packWARN3(a,b,c) ((a) | ((b)<<8) | ((c)<<16) )
223 #define packWARN4(a,b,c,d) ((a) | ((b)<<8) | ((c)<<16) | ((d) <<24))
225 #define unpackWARN1(x) ((U8) (x) )
226 #define unpackWARN2(x) ((U8) ((x) >> 8))
227 #define unpackWARN3(x) ((U8) ((x) >> 16))
228 #define unpackWARN4(x) ((U8) ((x) >> 24))
232 !specialWARN(PL_curcop->cop_warnings) && \
233 (isWARNf_on(PL_curcop->cop_warnings, unpackWARN1(x)) || \
235 (isWARNf_on(PL_curcop->cop_warnings, unpackWARN2(x)) || \
237 (isWARNf_on(PL_curcop->cop_warnings, unpackWARN3(x)) || \
239 isWARNf_on(PL_curcop->cop_warnings, unpackWARN4(x)))))))))
244 =for apidoc Amnh||WARN_ALL
245 =for apidoc Amnh||WARN_CLOSURE
246 =for apidoc Amnh||WARN_DEPRECATED
247 =for apidoc Amnh||WARN_EXITING
248 =for apidoc Amnh||WARN_GLOB
249 =for apidoc Amnh||WARN_IO
250 =for apidoc Amnh||WARN_CLOSED
251 =for apidoc Amnh||WARN_EXEC
252 =for apidoc Amnh||WARN_LAYER
253 =for apidoc Amnh||WARN_NEWLINE
254 =for apidoc Amnh||WARN_PIPE
255 =for apidoc Amnh||WARN_UNOPENED
256 =for apidoc Amnh||WARN_MISC
257 =for apidoc Amnh||WARN_NUMERIC
258 =for apidoc Amnh||WARN_ONCE
259 =for apidoc Amnh||WARN_OVERFLOW
260 =for apidoc Amnh||WARN_PACK
261 =for apidoc Amnh||WARN_PORTABLE
262 =for apidoc Amnh||WARN_RECURSION
263 =for apidoc Amnh||WARN_REDEFINE
264 =for apidoc Amnh||WARN_REGEXP
265 =for apidoc Amnh||WARN_SEVERE
266 =for apidoc Amnh||WARN_DEBUGGING
267 =for apidoc Amnh||WARN_INPLACE
268 =for apidoc Amnh||WARN_INTERNAL
269 =for apidoc Amnh||WARN_MALLOC
270 =for apidoc Amnh||WARN_SIGNAL
271 =for apidoc Amnh||WARN_SUBSTR
272 =for apidoc Amnh||WARN_SYNTAX
273 =for apidoc Amnh||WARN_AMBIGUOUS
274 =for apidoc Amnh||WARN_BAREWORD
275 =for apidoc Amnh||WARN_DIGIT
276 =for apidoc Amnh||WARN_PARENTHESIS
277 =for apidoc Amnh||WARN_PRECEDENCE
278 =for apidoc Amnh||WARN_PRINTF
279 =for apidoc Amnh||WARN_PROTOTYPE
280 =for apidoc Amnh||WARN_QW
281 =for apidoc Amnh||WARN_RESERVED
282 =for apidoc Amnh||WARN_SEMICOLON
283 =for apidoc Amnh||WARN_TAINT
284 =for apidoc Amnh||WARN_THREADS
285 =for apidoc Amnh||WARN_UNINITIALIZED
286 =for apidoc Amnh||WARN_UNPACK
287 =for apidoc Amnh||WARN_UNTIE
288 =for apidoc Amnh||WARN_UTF8
289 =for apidoc Amnh||WARN_VOID
290 =for apidoc Amnh||WARN_IMPRECISION
291 =for apidoc Amnh||WARN_ILLEGALPROTO
292 =for apidoc Amnh||WARN_NON_UNICODE
293 =for apidoc Amnh||WARN_NONCHAR
294 =for apidoc Amnh||WARN_SURROGATE
295 =for apidoc Amnh||WARN_EXPERIMENTAL
296 =for apidoc Amnh||WARN_EXPERIMENTAL__REGEX_SETS
297 =for apidoc Amnh||WARN_EXPERIMENTAL__SMARTMATCH
298 =for apidoc Amnh||WARN_SYSCALLS
299 =for apidoc Amnh||WARN_EXPERIMENTAL__CONST_ATTR
300 =for apidoc Amnh||WARN_EXPERIMENTAL__RE_STRICT
301 =for apidoc Amnh||WARN_EXPERIMENTAL__REFALIASING
302 =for apidoc Amnh||WARN_LOCALE
303 =for apidoc Amnh||WARN_MISSING
304 =for apidoc Amnh||WARN_REDUNDANT
305 =for apidoc Amnh||WARN_EXPERIMENTAL__DECLARED_REFS
306 =for apidoc Amnh||WARN_SHADOW
307 =for apidoc Amnh||WARN_EXPERIMENTAL__PRIVATE_USE
308 =for apidoc Amnh||WARN_EXPERIMENTAL__UNIPROP_WILDCARDS
309 =for apidoc Amnh||WARN_EXPERIMENTAL__VLB
310 =for apidoc Amnh||WARN_EXPERIMENTAL__TRY
311 =for apidoc Amnh||WARN_EXPERIMENTAL__ARGS_ARRAY_WITH_SIGNATURES
312 =for apidoc Amnh||WARN_EXPERIMENTAL__BUILTIN
313 =for apidoc Amnh||WARN_EXPERIMENTAL__DEFER
314 =for apidoc Amnh||WARN_EXPERIMENTAL__EXTRA_PAIRED_DELIMITERS
315 =for apidoc Amnh||WARN_EXPERIMENTAL__FOR_LIST
316 =for apidoc Amnh||WARN_SCALAR
321 /* end of file warnings.h */