This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
fix handling of registered warning categories
[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
72dc9ed5
NC
21#define pWARN_ALL (((STRLEN*)0)+1) /* use warnings 'all' */
22#define pWARN_NONE (((STRLEN*)0)+2) /* 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
3c3f8cd6
AB
118#define WARNsize 17
119#define WARN_ALLstring "\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125"
120#define WARN_NONEstring "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"
599cee73 121
a2637ca0
FC
122#define isLEXWARN_on \
123 cBOOL(PL_curcop && PL_curcop->cop_warnings != pWARN_STD)
124#define isLEXWARN_off \
125 cBOOL(!PL_curcop || PL_curcop->cop_warnings == pWARN_STD)
d5a71f30 126#define isWARN_ONCE (PL_dowarn & (G_WARN_ON|G_WARN_ONCE))
72dc9ed5
NC
127#define isWARN_on(c,x) (IsSet((U8 *)(c + 1), 2*(x)))
128#define isWARNf_on(c,x) (IsSet((U8 *)(c + 1), 2*(x)+1))
129
130#define DUP_WARNINGS(p) \
594cd643
NC
131 (specialWARN(p) ? (STRLEN*)(p) \
132 : (STRLEN*)CopyD(p, PerlMemShared_malloc(sizeof(*p)+*p), sizeof(*p)+*p, \
133 char))
d5a71f30 134
feff94e1
KW
135/*
136
137=head1 Warning and Dieing
138
139=for apidoc Am|bool|ckWARN|U32 w
140
141Returns a boolean as to whether or not warnings are enabled for the warning
142category C<w>. If the category is by default enabled even if not within the
143scope of S<C<use warnings>>, instead use the L</ckWARN_d> macro.
144
145=for apidoc Am|bool|ckWARN_d|U32 w
146
147Like C<L</ckWARN>>, but for use if and only if the warning category is by
148default enabled even if not within the scope of S<C<use warnings>>.
149
150=for apidoc Am|bool|ckWARN2|U32 w1|U32 w2
151
152Like C<L</ckWARN>>, but takes two warnings categories as input, and returns
153TRUE if either is enabled. If either category is by default enabled even if
154not within the scope of S<C<use warnings>>, instead use the L</ckWARN2_d>
155macro. The categories must be completely independent, one may not be
156subclassed from the other.
157
158=for apidoc Am|bool|ckWARN2_d|U32 w1|U32 w2
159
160Like C<L</ckWARN2>>, but for use if and only if either warning category is by
161default enabled even if not within the scope of S<C<use warnings>>.
162
163=for apidoc Am|bool|ckWARN3|U32 w1|U32 w2|U32 w3
164
165Like C<L</ckWARN2>>, but takes three warnings categories as input, and returns
166TRUE if any is enabled. If any of the categories is by default enabled even
167if not within the scope of S<C<use warnings>>, instead use the L</ckWARN3_d>
168macro. The categories must be completely independent, one may not be
169subclassed from any other.
170
171=for apidoc Am|bool|ckWARN3_d|U32 w1|U32 w2|U32 w3
172
173Like C<L</ckWARN3>>, but for use if and only if any of the warning categories
174is by default enabled even if not within the scope of S<C<use warnings>>.
175
176=for apidoc Am|bool|ckWARN4|U32 w1|U32 w2|U32 w3|U32 w4
177
178Like C<L</ckWARN3>>, but takes four warnings categories as input, and returns
179TRUE if any is enabled. If any of the categories is by default enabled even
180if not within the scope of S<C<use warnings>>, instead use the L</ckWARN4_d>
181macro. The categories must be completely independent, one may not be
182subclassed from any other.
183
184=for apidoc Am|bool|ckWARN4_d|U32 w1|U32 w2|U32 w3|U32 w4
185
186Like C<L</ckWARN4>>, but for use if and only if any of the warning categories
187is by default enabled even if not within the scope of S<C<use warnings>>.
188
189=cut
190
191*/
192
f54ba1c2 193#define ckWARN(w) Perl_ckwarn(aTHX_ packWARN(w))
7c08c4c5
KW
194
195/* The w1, w2 ... should be independent warnings categories; one shouldn't be
196 * a subcategory of any other */
197
f54ba1c2
DM
198#define ckWARN2(w1,w2) Perl_ckwarn(aTHX_ packWARN2(w1,w2))
199#define ckWARN3(w1,w2,w3) Perl_ckwarn(aTHX_ packWARN3(w1,w2,w3))
200#define ckWARN4(w1,w2,w3,w4) Perl_ckwarn(aTHX_ packWARN4(w1,w2,w3,w4))
201
202#define ckWARN_d(w) Perl_ckwarn_d(aTHX_ packWARN(w))
203#define ckWARN2_d(w1,w2) Perl_ckwarn_d(aTHX_ packWARN2(w1,w2))
204#define ckWARN3_d(w1,w2,w3) Perl_ckwarn_d(aTHX_ packWARN3(w1,w2,w3))
205#define ckWARN4_d(w1,w2,w3,w4) Perl_ckwarn_d(aTHX_ packWARN4(w1,w2,w3,w4))
12bcd1a6 206
98fe6610
NC
207#define WARNshift 8
208
3b9e3074 209#define packWARN(a) (a )
7c08c4c5
KW
210
211/* The a, b, ... should be independent warnings categories; one shouldn't be
212 * a subcategory of any other */
213
3b9e3074
SH
214#define packWARN2(a,b) ((a) | ((b)<<8) )
215#define packWARN3(a,b,c) ((a) | ((b)<<8) | ((c)<<16) )
216#define packWARN4(a,b,c,d) ((a) | ((b)<<8) | ((c)<<16) | ((d) <<24))
12bcd1a6
PM
217
218#define unpackWARN1(x) ((x) & 0xFF)
219#define unpackWARN2(x) (((x) >>8) & 0xFF)
220#define unpackWARN3(x) (((x) >>16) & 0xFF)
221#define unpackWARN4(x) (((x) >>24) & 0xFF)
222
223#define ckDEAD(x) \
006c1a1d
Z
224 (PL_curcop && \
225 !specialWARN(PL_curcop->cop_warnings) && \
226 (isWARNf_on(PL_curcop->cop_warnings, unpackWARN1(x)) || \
227 (unpackWARN2(x) && \
228 (isWARNf_on(PL_curcop->cop_warnings, unpackWARN2(x)) || \
229 (unpackWARN3(x) && \
230 (isWARNf_on(PL_curcop->cop_warnings, unpackWARN3(x)) || \
231 (unpackWARN4(x) && \
232 isWARNf_on(PL_curcop->cop_warnings, unpackWARN4(x)))))))))
12bcd1a6 233
4438c4b7 234/* end of file warnings.h */
ce716c52 235
37442d52 236/* ex: set ro: */