xref: /openbsd/gnu/usr.bin/perl/warnings.h (revision e0680481)
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!
5  */
6 
7 
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))
11 
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)
18 
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' */
22 
23 #define specialWARN(x)		((x) == pWARN_STD || (x) == pWARN_ALL ||	\
24                                  (x) == pWARN_NONE)
25 
26 /* if PL_warnhook is set to this value, then warnings die */
27 #define PERL_WARNHOOK_FATAL	(&PL_sv_placeholder)
28 
29 /* Warnings Categories added in Perl 5.008 */
30 
31 #define WARN_ALL			 0
32 #define WARN_CLOSURE			 1
33 #define WARN_DEPRECATED			 2
34 #define WARN_EXITING			 3
35 #define WARN_GLOB			 4
36 #define WARN_IO				 5
37 #define WARN_CLOSED			 6
38 #define WARN_EXEC			 7
39 #define WARN_LAYER			 8
40 #define WARN_NEWLINE			 9
41 #define WARN_PIPE			 10
42 #define WARN_UNOPENED			 11
43 #define WARN_MISC			 12
44 #define WARN_NUMERIC			 13
45 #define WARN_ONCE			 14
46 #define WARN_OVERFLOW			 15
47 #define WARN_PACK			 16
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
62 #define WARN_DIGIT			 31
63 #define WARN_PARENTHESIS		 32
64 #define WARN_PRECEDENCE			 33
65 #define WARN_PRINTF			 34
66 #define WARN_PROTOTYPE			 35
67 #define WARN_QW				 36
68 #define WARN_RESERVED			 37
69 #define WARN_SEMICOLON			 38
70 #define WARN_TAINT			 39
71 #define WARN_THREADS			 40
72 #define WARN_UNINITIALIZED		 41
73 #define WARN_UNPACK			 42
74 #define WARN_UNTIE			 43
75 #define WARN_UTF8			 44
76 #define WARN_VOID			 45
77 
78 /* Warnings Categories added in Perl 5.011 */
79 
80 #define WARN_IMPRECISION		 46
81 #define WARN_ILLEGALPROTO		 47
82 
83 /* Warnings Categories added in Perl 5.011003 */
84 
85 #define WARN_DEPRECATED__GOTO_CONSTRUCT	 48
86 #define WARN_DEPRECATED__UNICODE_PROPERTY_NAME 49
87 
88 /* Warnings Categories added in Perl 5.013 */
89 
90 #define WARN_NON_UNICODE		 50
91 #define WARN_NONCHAR			 51
92 #define WARN_SURROGATE			 52
93 
94 /* Warnings Categories added in Perl 5.017 */
95 
96 #define WARN_EXPERIMENTAL		 53
97 #define WARN_EXPERIMENTAL__REGEX_SETS	 54
98 
99 /* Warnings Categories added in Perl 5.019 */
100 
101 #define WARN_SYSCALLS			 55
102 
103 /* Warnings Categories added in Perl 5.021 */
104 
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
111 
112 /* Warnings Categories added in Perl 5.025 */
113 
114 #define WARN_EXPERIMENTAL__DECLARED_REFS 62
115 
116 /* Warnings Categories added in Perl 5.025011 */
117 
118 #define WARN_DEPRECATED__DOT_IN_INC	 63
119 
120 /* Warnings Categories added in Perl 5.027 */
121 
122 #define WARN_SHADOW			 64
123 
124 /* Warnings Categories added in Perl 5.029 */
125 
126 #define WARN_EXPERIMENTAL__PRIVATE_USE	 65
127 #define WARN_EXPERIMENTAL__UNIPROP_WILDCARDS 66
128 #define WARN_EXPERIMENTAL__VLB		 67
129 
130 /* Warnings Categories added in Perl 5.033 */
131 
132 #define WARN_EXPERIMENTAL__TRY		 68
133 
134 /* Warnings Categories added in Perl 5.035 */
135 
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
142 
143 /* Warnings Categories added in Perl 5.035009 */
144 
145 #define WARN_DEPRECATED__VERSION_DOWNGRADE 75
146 
147 /* Warnings Categories added in Perl 5.03501 */
148 
149 #define WARN_DEPRECATED__DELIMITER_WILL_BE_PAIRED 76
150 
151 /* Warnings Categories added in Perl 5.037 */
152 
153 #define WARN_EXPERIMENTAL__CLASS	 77
154 
155 /* Warnings Categories added in Perl 5.037009 */
156 
157 #define WARN_DEPRECATED__APOSTROPHE_AS_PACKAGE_SEPARATOR 78
158 
159 /* Warnings Categories added in Perl 5.03701 */
160 
161 #define WARN_DEPRECATED__SMARTMATCH	 79
162 #define WARNsize			 20
163 #define WARN_ALLstring			 "\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125"
164 #define WARN_NONEstring			 "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"
165 
166 #define isLEXWARN_on \
167         cBOOL(PL_curcop && PL_curcop->cop_warnings != pWARN_STD)
168 #define isLEXWARN_off \
169         cBOOL(!PL_curcop || PL_curcop->cop_warnings == pWARN_STD)
170 #define isWARN_ONCE	(PL_dowarn & (G_WARN_ON|G_WARN_ONCE))
171 #define hasWARNBIT(c,x) (RCPV_LEN(c) > (2*(x)/8))
172 #define isWARN_on(c,x)  (hasWARNBIT(c,x) \
173                         ? PerlWarnIsSet_((U8 *)(c), 2*(x)) \
174                         : 0)
175 #define isWARNf_on(c,x) (hasWARNBIT(c,x) \
176                         ? PerlWarnIsSet_((U8 *)(c), 2*(x)+1) \
177                         : 0)
178 
179 #define DUP_WARNINGS(p) Perl_dup_warnings(aTHX_ p)
180 
181 #define free_and_set_cop_warnings(cmp,w) STMT_START { \
182   if (!specialWARN((cmp)->cop_warnings)) rcpv_free((cmp)->cop_warnings); \
183   (cmp)->cop_warnings = w; \
184 } STMT_END
185 
186 /*
187 
188 =head1 Warning and Dieing
189 
190 In all these calls, the C<U32 wI<n>> parameters are warning category
191 constants.  You can see the ones currently available in
192 L<warnings/Category Hierarchy>, just capitalize all letters in the names
193 and prefix them by C<WARN_>.  So, for example, the category C<void> used in a
194 perl program becomes C<WARN_VOID> when used in XS code and passed to one of
195 the calls below.
196 
197 =for apidoc Am|bool|ckWARN|U32 w
198 =for apidoc_item ||ckWARN2|U32 w1|U32 w2
199 =for apidoc_item ||ckWARN3|U32 w1|U32 w2|U32 w3
200 =for apidoc_item ||ckWARN4|U32 w1|U32 w2|U32 w3|U32 w4
201 These return a boolean as to whether or not warnings are enabled for any of
202 the warning category(ies) parameters:  C<w>, C<w1>, ....
203 
204 Should any of the categories by default be enabled even if not within the
205 scope of S<C<use warnings>>, instead use the C<L</ckWARN_d>> macros.
206 
207 The categories must be completely independent, one may not be subclassed from
208 the other.
209 
210 =for apidoc Am|bool|ckWARN_d|U32 w
211 =for apidoc_item ||ckWARN2_d|U32 w1|U32 w2
212 =for apidoc_item ||ckWARN3_d|U32 w1|U32 w2|U32 w3
213 =for apidoc_item ||ckWARN4_d|U32 w1|U32 w2|U32 w3|U32 w4
214 
215 Like C<L</ckWARN>>, but for use if and only if the warning category(ies) is by
216 default enabled even if not within the scope of S<C<use warnings>>.
217 
218 =for apidoc Am|U32|packWARN|U32 w1
219 =for apidoc_item ||packWARN2|U32 w1|U32 w2
220 =for apidoc_item ||packWARN3|U32 w1|U32 w2|U32 w3
221 =for apidoc_item ||packWARN4|U32 w1|U32 w2|U32 w3|U32 w4
222 
223 These macros are used to pack warning categories into a single U32 to pass to
224 macros and functions that take a warning category parameter.  The number of
225 categories to pack is given by the name, with a corresponding number of
226 category parameters passed.
227 
228 =cut
229 
230 */
231 
232 #define ckWARN(w)		Perl_ckwarn(aTHX_ packWARN(w))
233 
234 /* The w1, w2 ... should be independent warnings categories; one shouldn't be
235  * a subcategory of any other */
236 
237 #define ckWARN2(w1,w2)		Perl_ckwarn(aTHX_ packWARN2(w1,w2))
238 #define ckWARN3(w1,w2,w3)	Perl_ckwarn(aTHX_ packWARN3(w1,w2,w3))
239 #define ckWARN4(w1,w2,w3,w4)	Perl_ckwarn(aTHX_ packWARN4(w1,w2,w3,w4))
240 
241 #define ckWARN_d(w)		Perl_ckwarn_d(aTHX_ packWARN(w))
242 #define ckWARN2_d(w1,w2)	Perl_ckwarn_d(aTHX_ packWARN2(w1,w2))
243 #define ckWARN3_d(w1,w2,w3)	Perl_ckwarn_d(aTHX_ packWARN3(w1,w2,w3))
244 #define ckWARN4_d(w1,w2,w3,w4)	Perl_ckwarn_d(aTHX_ packWARN4(w1,w2,w3,w4))
245 
246 #define WARNshift		8
247 
248 #define packWARN(a)		(a                                      )
249 
250 /* The a, b, ... should be independent warnings categories; one shouldn't be
251  * a subcategory of any other */
252 
253 #define packWARN2(a,b)		((a) | ((b)<<8)                         )
254 #define packWARN3(a,b,c)	((a) | ((b)<<8) | ((c)<<16)             )
255 #define packWARN4(a,b,c,d)	((a) | ((b)<<8) | ((c)<<16) | ((d) <<24))
256 
257 #define unpackWARN1(x)		((U8)  (x)       )
258 #define unpackWARN2(x)		((U8) ((x) >>  8))
259 #define unpackWARN3(x)		((U8) ((x) >> 16))
260 #define unpackWARN4(x)		((U8) ((x) >> 24))
261 
262 #define ckDEAD(x)							\
263    (PL_curcop &&                                                        \
264     !specialWARN(PL_curcop->cop_warnings) &&			        \
265     (isWARNf_on(PL_curcop->cop_warnings, unpackWARN1(x)) ||	        \
266       (unpackWARN2(x) &&                                                \
267         (isWARNf_on(PL_curcop->cop_warnings, unpackWARN2(x)) ||	        \
268           (unpackWARN3(x) &&                                            \
269             (isWARNf_on(PL_curcop->cop_warnings, unpackWARN3(x)) ||	\
270               (unpackWARN4(x) &&                                        \
271                 isWARNf_on(PL_curcop->cop_warnings, unpackWARN4(x)))))))))
272 
273 
274 
275 /*
276 =for apidoc Amnh||WARN_ALL
277 =for apidoc Amnh||WARN_CLOSURE
278 =for apidoc Amnh||WARN_DEPRECATED
279 =for apidoc Amnh||WARN_EXITING
280 =for apidoc Amnh||WARN_GLOB
281 =for apidoc Amnh||WARN_IO
282 =for apidoc Amnh||WARN_CLOSED
283 =for apidoc Amnh||WARN_EXEC
284 =for apidoc Amnh||WARN_LAYER
285 =for apidoc Amnh||WARN_NEWLINE
286 =for apidoc Amnh||WARN_PIPE
287 =for apidoc Amnh||WARN_UNOPENED
288 =for apidoc Amnh||WARN_MISC
289 =for apidoc Amnh||WARN_NUMERIC
290 =for apidoc Amnh||WARN_ONCE
291 =for apidoc Amnh||WARN_OVERFLOW
292 =for apidoc Amnh||WARN_PACK
293 =for apidoc Amnh||WARN_PORTABLE
294 =for apidoc Amnh||WARN_RECURSION
295 =for apidoc Amnh||WARN_REDEFINE
296 =for apidoc Amnh||WARN_REGEXP
297 =for apidoc Amnh||WARN_SEVERE
298 =for apidoc Amnh||WARN_DEBUGGING
299 =for apidoc Amnh||WARN_INPLACE
300 =for apidoc Amnh||WARN_INTERNAL
301 =for apidoc Amnh||WARN_MALLOC
302 =for apidoc Amnh||WARN_SIGNAL
303 =for apidoc Amnh||WARN_SUBSTR
304 =for apidoc Amnh||WARN_SYNTAX
305 =for apidoc Amnh||WARN_AMBIGUOUS
306 =for apidoc Amnh||WARN_BAREWORD
307 =for apidoc Amnh||WARN_DIGIT
308 =for apidoc Amnh||WARN_PARENTHESIS
309 =for apidoc Amnh||WARN_PRECEDENCE
310 =for apidoc Amnh||WARN_PRINTF
311 =for apidoc Amnh||WARN_PROTOTYPE
312 =for apidoc Amnh||WARN_QW
313 =for apidoc Amnh||WARN_RESERVED
314 =for apidoc Amnh||WARN_SEMICOLON
315 =for apidoc Amnh||WARN_TAINT
316 =for apidoc Amnh||WARN_THREADS
317 =for apidoc Amnh||WARN_UNINITIALIZED
318 =for apidoc Amnh||WARN_UNPACK
319 =for apidoc Amnh||WARN_UNTIE
320 =for apidoc Amnh||WARN_UTF8
321 =for apidoc Amnh||WARN_VOID
322 =for apidoc Amnh||WARN_IMPRECISION
323 =for apidoc Amnh||WARN_ILLEGALPROTO
324 =for apidoc Amnh||WARN_DEPRECATED__GOTO_CONSTRUCT
325 =for apidoc Amnh||WARN_DEPRECATED__UNICODE_PROPERTY_NAME
326 =for apidoc Amnh||WARN_NON_UNICODE
327 =for apidoc Amnh||WARN_NONCHAR
328 =for apidoc Amnh||WARN_SURROGATE
329 =for apidoc Amnh||WARN_EXPERIMENTAL
330 =for apidoc Amnh||WARN_EXPERIMENTAL__REGEX_SETS
331 =for apidoc Amnh||WARN_SYSCALLS
332 =for apidoc Amnh||WARN_EXPERIMENTAL__CONST_ATTR
333 =for apidoc Amnh||WARN_EXPERIMENTAL__RE_STRICT
334 =for apidoc Amnh||WARN_EXPERIMENTAL__REFALIASING
335 =for apidoc Amnh||WARN_LOCALE
336 =for apidoc Amnh||WARN_MISSING
337 =for apidoc Amnh||WARN_REDUNDANT
338 =for apidoc Amnh||WARN_EXPERIMENTAL__DECLARED_REFS
339 =for apidoc Amnh||WARN_DEPRECATED__DOT_IN_INC
340 =for apidoc Amnh||WARN_SHADOW
341 =for apidoc Amnh||WARN_EXPERIMENTAL__PRIVATE_USE
342 =for apidoc Amnh||WARN_EXPERIMENTAL__UNIPROP_WILDCARDS
343 =for apidoc Amnh||WARN_EXPERIMENTAL__VLB
344 =for apidoc Amnh||WARN_EXPERIMENTAL__TRY
345 =for apidoc Amnh||WARN_EXPERIMENTAL__ARGS_ARRAY_WITH_SIGNATURES
346 =for apidoc Amnh||WARN_EXPERIMENTAL__BUILTIN
347 =for apidoc Amnh||WARN_EXPERIMENTAL__DEFER
348 =for apidoc Amnh||WARN_EXPERIMENTAL__EXTRA_PAIRED_DELIMITERS
349 =for apidoc Amnh||WARN_EXPERIMENTAL__FOR_LIST
350 =for apidoc Amnh||WARN_SCALAR
351 =for apidoc Amnh||WARN_DEPRECATED__VERSION_DOWNGRADE
352 =for apidoc Amnh||WARN_DEPRECATED__DELIMITER_WILL_BE_PAIRED
353 =for apidoc Amnh||WARN_EXPERIMENTAL__CLASS
354 =for apidoc Amnh||WARN_DEPRECATED__APOSTROPHE_AS_PACKAGE_SEPARATOR
355 =for apidoc Amnh||WARN_DEPRECATED__SMARTMATCH
356 
357 =cut
358 */
359 
360 /* end of file warnings.h */
361 
362 /* ex: set ro ft=c: */
363