This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
is_invlist(): Allow NULL input
[perl5.git] / warnings.h
CommitLineData
37442d52
RGS
1/* -*- buffer-read-only: t -*-
2 !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
78102347 3 This file is built by regen/warnings.pl.
599cee73 4 Any changes made here will be lost!
78102347 5 */
599cee73
PM
6
7
0453d815
PM
8#define Off(x) ((x) / 8)
9#define Bit(x) (1 << ((x) % 8))
599cee73
PM
10#define IsSet(a, x) ((a)[Off(x)] & Bit(x))
11
0453d815 12
599cee73 13#define G_WARN_OFF 0 /* $^W == 0 */
0453d815 14#define G_WARN_ON 1 /* -w flag and $^W != 0 */
599cee73
PM
15#define G_WARN_ALL_ON 2 /* -W flag */
16#define G_WARN_ALL_OFF 4 /* -X flag */
0453d815 17#define G_WARN_ONCE 8 /* set if 'once' ever enabled */
599cee73
PM
18#define G_WARN_ALL_MASK (G_WARN_ALL_ON|G_WARN_ALL_OFF)
19
84b2b14b 20#define pWARN_STD NULL
8c165a32
KW
21#define pWARN_ALL (STRLEN *) &PL_WARN_ALL /* use warnings 'all' */
22#define pWARN_NONE (STRLEN *) &PL_WARN_NONE /* no warnings 'all' */
599cee73 23
d3a7d8c7
GS
24#define specialWARN(x) ((x) == pWARN_STD || (x) == pWARN_ALL || \
25 (x) == pWARN_NONE)
0d658bf5 26
5f2d9966 27/* if PL_warnhook is set to this value, then warnings die */
06dcd5bf 28#define PERL_WARNHOOK_FATAL (&PL_sv_placeholder)
5f2d9966 29
0d658bf5
PM
30/* Warnings Categories added in Perl 5.008 */
31
3c3f8cd6
AB
32#define WARN_ALL 0
33#define WARN_CLOSURE 1
34#define WARN_DEPRECATED 2
35#define WARN_EXITING 3
36#define WARN_GLOB 4
37#define WARN_IO 5
38#define WARN_CLOSED 6
39#define WARN_EXEC 7
40#define WARN_LAYER 8
41#define WARN_NEWLINE 9
42#define WARN_PIPE 10
43#define WARN_UNOPENED 11
44#define WARN_MISC 12
45#define WARN_NUMERIC 13
46#define WARN_ONCE 14
47#define WARN_OVERFLOW 15
48#define WARN_PACK 16
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
63#define WARN_DIGIT 31
64#define WARN_PARENTHESIS 32
65#define WARN_PRECEDENCE 33
66#define WARN_PRINTF 34
67#define WARN_PROTOTYPE 35
68#define WARN_QW 36
69#define WARN_RESERVED 37
70#define WARN_SEMICOLON 38
71#define WARN_TAINT 39
72#define WARN_THREADS 40
73#define WARN_UNINITIALIZED 41
74#define WARN_UNPACK 42
75#define WARN_UNTIE 43
76#define WARN_UTF8 44
77#define WARN_VOID 45
e476b1b5 78
b88df990
NC
79/* Warnings Categories added in Perl 5.011 */
80
3c3f8cd6
AB
81#define WARN_IMPRECISION 46
82#define WARN_ILLEGALPROTO 47
b88df990 83
8457b38f
KW
84/* Warnings Categories added in Perl 5.013 */
85
3c3f8cd6
AB
86#define WARN_NON_UNICODE 48
87#define WARN_NONCHAR 49
88#define WARN_SURROGATE 50
8457b38f 89
6f87cb12
FC
90/* Warnings Categories added in Perl 5.017 */
91
3c3f8cd6
AB
92#define WARN_EXPERIMENTAL 51
93#define WARN_EXPERIMENTAL__LEXICAL_SUBS 52
c29314de
FC
94#define WARN_EXPERIMENTAL__REGEX_SETS 53
95#define WARN_EXPERIMENTAL__SMARTMATCH 54
6f87cb12 96
c8028aa6
TC
97/* Warnings Categories added in Perl 5.019 */
98
c29314de
FC
99#define WARN_EXPERIMENTAL__POSTDEREF 55
100#define WARN_EXPERIMENTAL__SIGNATURES 56
101#define WARN_SYSCALLS 57
c8028aa6 102
7ac92924
TC
103/* Warnings Categories added in Perl 5.021 */
104
c29314de
FC
105#define WARN_EXPERIMENTAL__BITWISE 58
106#define WARN_EXPERIMENTAL__CONST_ATTR 59
107#define WARN_EXPERIMENTAL__RE_STRICT 60
108#define WARN_EXPERIMENTAL__REFALIASING 61
109#define WARN_EXPERIMENTAL__WIN32_PERLIO 62
110#define WARN_LOCALE 63
111#define WARN_MISSING 64
112#define WARN_REDUNDANT 65
3c3f8cd6 113
88d5dae9
FC
114/* Warnings Categories added in Perl 5.025 */
115
116#define WARN_EXPERIMENTAL__DECLARED_REFS 66
117
52e3acf8
Z
118/* Warnings Categories added in Perl 5.027 */
119
948f26d8
KW
120#define WARN_EXPERIMENTAL__ALPHA_ASSERTIONS 67
121#define WARN_EXPERIMENTAL__SCRIPT_RUN 68
122#define WARN_SHADOW 69
52e3acf8 123
21c34e97
KW
124/* Warnings Categories added in Perl 5.029 */
125
126#define WARN_EXPERIMENTAL__PRIVATE_USE 70
127
0d76344b
KW
128#define WARNsize 18
129#define WARN_ALLstring "\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125"
130#define WARN_NONEstring "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"
599cee73 131
a2637ca0
FC
132#define isLEXWARN_on \
133 cBOOL(PL_curcop && PL_curcop->cop_warnings != pWARN_STD)
134#define isLEXWARN_off \
135 cBOOL(!PL_curcop || PL_curcop->cop_warnings == pWARN_STD)
d5a71f30 136#define isWARN_ONCE (PL_dowarn & (G_WARN_ON|G_WARN_ONCE))
72dc9ed5
NC
137#define isWARN_on(c,x) (IsSet((U8 *)(c + 1), 2*(x)))
138#define isWARNf_on(c,x) (IsSet((U8 *)(c + 1), 2*(x)+1))
139
c1e47bad 140#define DUP_WARNINGS(p) Perl_dup_warnings(aTHX_ p)
d5a71f30 141
feff94e1
KW
142/*
143
144=head1 Warning and Dieing
145
146=for apidoc Am|bool|ckWARN|U32 w
147
148Returns a boolean as to whether or not warnings are enabled for the warning
149category C<w>. If the category is by default enabled even if not within the
150scope of S<C<use warnings>>, instead use the L</ckWARN_d> macro.
151
152=for apidoc Am|bool|ckWARN_d|U32 w
153
154Like C<L</ckWARN>>, but for use if and only if the warning category is by
155default enabled even if not within the scope of S<C<use warnings>>.
156
157=for apidoc Am|bool|ckWARN2|U32 w1|U32 w2
158
159Like C<L</ckWARN>>, but takes two warnings categories as input, and returns
160TRUE if either is enabled. If either category is by default enabled even if
161not within the scope of S<C<use warnings>>, instead use the L</ckWARN2_d>
162macro. The categories must be completely independent, one may not be
163subclassed from the other.
164
165=for apidoc Am|bool|ckWARN2_d|U32 w1|U32 w2
166
167Like C<L</ckWARN2>>, but for use if and only if either warning category is by
168default enabled even if not within the scope of S<C<use warnings>>.
169
170=for apidoc Am|bool|ckWARN3|U32 w1|U32 w2|U32 w3
171
172Like C<L</ckWARN2>>, but takes three warnings categories as input, and returns
173TRUE if any is enabled. If any of the categories is by default enabled even
174if not within the scope of S<C<use warnings>>, instead use the L</ckWARN3_d>
175macro. The categories must be completely independent, one may not be
176subclassed from any other.
177
178=for apidoc Am|bool|ckWARN3_d|U32 w1|U32 w2|U32 w3
179
180Like C<L</ckWARN3>>, but for use if and only if any of the warning categories
181is by default enabled even if not within the scope of S<C<use warnings>>.
182
183=for apidoc Am|bool|ckWARN4|U32 w1|U32 w2|U32 w3|U32 w4
184
185Like C<L</ckWARN3>>, but takes four warnings categories as input, and returns
186TRUE if any is enabled. If any of the categories is by default enabled even
187if not within the scope of S<C<use warnings>>, instead use the L</ckWARN4_d>
188macro. The categories must be completely independent, one may not be
189subclassed from any other.
190
191=for apidoc Am|bool|ckWARN4_d|U32 w1|U32 w2|U32 w3|U32 w4
192
193Like C<L</ckWARN4>>, but for use if and only if any of the warning categories
194is by default enabled even if not within the scope of S<C<use warnings>>.
195
196=cut
197
198*/
199
f54ba1c2 200#define ckWARN(w) Perl_ckwarn(aTHX_ packWARN(w))
7c08c4c5
KW
201
202/* The w1, w2 ... should be independent warnings categories; one shouldn't be
203 * a subcategory of any other */
204
f54ba1c2
DM
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))
208
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))
12bcd1a6 213
98fe6610
NC
214#define WARNshift 8
215
3b9e3074 216#define packWARN(a) (a )
7c08c4c5
KW
217
218/* The a, b, ... should be independent warnings categories; one shouldn't be
219 * a subcategory of any other */
220
3b9e3074
SH
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))
12bcd1a6
PM
224
225#define unpackWARN1(x) ((x) & 0xFF)
226#define unpackWARN2(x) (((x) >>8) & 0xFF)
227#define unpackWARN3(x) (((x) >>16) & 0xFF)
228#define unpackWARN4(x) (((x) >>24) & 0xFF)
229
230#define ckDEAD(x) \
006c1a1d
Z
231 (PL_curcop && \
232 !specialWARN(PL_curcop->cop_warnings) && \
233 (isWARNf_on(PL_curcop->cop_warnings, unpackWARN1(x)) || \
234 (unpackWARN2(x) && \
235 (isWARNf_on(PL_curcop->cop_warnings, unpackWARN2(x)) || \
236 (unpackWARN3(x) && \
237 (isWARNf_on(PL_curcop->cop_warnings, unpackWARN3(x)) || \
238 (unpackWARN4(x) && \
239 isWARNf_on(PL_curcop->cop_warnings, unpackWARN4(x)))))))))
12bcd1a6 240
4438c4b7 241/* end of file warnings.h */
ce716c52 242
37442d52 243/* ex: set ro: */