This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
warnings.h: Add pod about finding the XS warning category
[perl5.git] / warnings.h
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!
5  */
6
7
8 #define Off(x)                  ((x) / 8)
9 #define Bit(x)                  (1 << ((x) % 8))
10 #define IsSet(a, x)             ((a)[Off(x)] & Bit(x))
11
12
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)
19
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' */
23
24 #define specialWARN(x)          ((x) == pWARN_STD || (x) == pWARN_ALL ||        \
25                                  (x) == pWARN_NONE)
26
27 /* if PL_warnhook is set to this value, then warnings die */
28 #define PERL_WARNHOOK_FATAL     (&PL_sv_placeholder)
29
30 /* Warnings Categories added in Perl 5.008 */
31
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
78
79 /* Warnings Categories added in Perl 5.011 */
80
81 #define WARN_IMPRECISION                 46
82 #define WARN_ILLEGALPROTO                47
83
84 /* Warnings Categories added in Perl 5.013 */
85
86 #define WARN_NON_UNICODE                 48
87 #define WARN_NONCHAR                     49
88 #define WARN_SURROGATE                   50
89
90 /* Warnings Categories added in Perl 5.017 */
91
92 #define WARN_EXPERIMENTAL                51
93 #define WARN_EXPERIMENTAL__LEXICAL_SUBS  52
94 #define WARN_EXPERIMENTAL__REGEX_SETS    53
95 #define WARN_EXPERIMENTAL__SMARTMATCH    54
96
97 /* Warnings Categories added in Perl 5.019 */
98
99 #define WARN_EXPERIMENTAL__POSTDEREF     55
100 #define WARN_EXPERIMENTAL__SIGNATURES    56
101 #define WARN_SYSCALLS                    57
102
103 /* Warnings Categories added in Perl 5.021 */
104
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
113
114 /* Warnings Categories added in Perl 5.025 */
115
116 #define WARN_EXPERIMENTAL__DECLARED_REFS 66
117
118 /* Warnings Categories added in Perl 5.027 */
119
120 #define WARN_EXPERIMENTAL__ALPHA_ASSERTIONS 67
121 #define WARN_EXPERIMENTAL__SCRIPT_RUN    68
122 #define WARN_SHADOW                      69
123
124 /* Warnings Categories added in Perl 5.029 */
125
126 #define WARN_EXPERIMENTAL__PRIVATE_USE   70
127 #define WARN_EXPERIMENTAL__UNIPROP_WILDCARDS 71
128 #define WARN_EXPERIMENTAL__VLB           72
129
130 #define WARNsize                         19
131 #define WARN_ALLstring                   "\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125"
132 #define WARN_NONEstring                  "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"
133
134 #define isLEXWARN_on \
135         cBOOL(PL_curcop && PL_curcop->cop_warnings != pWARN_STD)
136 #define isLEXWARN_off \
137         cBOOL(!PL_curcop || PL_curcop->cop_warnings == pWARN_STD)
138 #define isWARN_ONCE     (PL_dowarn & (G_WARN_ON|G_WARN_ONCE))
139 #define isWARN_on(c,x)  (IsSet((U8 *)(c + 1), 2*(x)))
140 #define isWARNf_on(c,x) (IsSet((U8 *)(c + 1), 2*(x)+1))
141
142 #define DUP_WARNINGS(p) Perl_dup_warnings(aTHX_ p)
143
144 /*
145
146 =head1 Warning and Dieing
147
148 In all these calls, the C<U32 wI<n>> parameters are warning category
149 constants.  You can see the ones currently available in
150 L<warnings/Category Hierarchy>, just capitalize all letters in the names
151 and prefix them by C<WARN_>.  So, for example, the category C<void> used in a
152 perl program becomes C<WARN_VOID> when used in XS code and passed to one of
153 the calls below.
154
155 =for apidoc Am|bool|ckWARN|U32 w
156
157 Returns a boolean as to whether or not warnings are enabled for the warning
158 category C<w>.  If the category is by default enabled even if not within the
159 scope of S<C<use warnings>>, instead use the L</ckWARN_d> macro.
160
161 =for apidoc Am|bool|ckWARN_d|U32 w
162
163 Like C<L</ckWARN>>, but for use if and only if the warning category is by
164 default enabled even if not within the scope of S<C<use warnings>>.
165
166 =for apidoc Am|bool|ckWARN2|U32 w1|U32 w2
167
168 Like C<L</ckWARN>>, but takes two warnings categories as input, and returns
169 TRUE if either is enabled.  If either category is by default enabled even if
170 not within the scope of S<C<use warnings>>, instead use the L</ckWARN2_d>
171 macro.  The categories must be completely independent, one may not be
172 subclassed from the other.
173
174 =for apidoc Am|bool|ckWARN2_d|U32 w1|U32 w2
175
176 Like C<L</ckWARN2>>, but for use if and only if either warning category is by
177 default enabled even if not within the scope of S<C<use warnings>>.
178
179 =for apidoc Am|bool|ckWARN3|U32 w1|U32 w2|U32 w3
180
181 Like C<L</ckWARN2>>, but takes three warnings categories as input, and returns
182 TRUE if any is enabled.  If any of the categories is by default enabled even
183 if not within the scope of S<C<use warnings>>, instead use the L</ckWARN3_d>
184 macro.  The categories must be completely independent, one may not be
185 subclassed from any other.
186
187 =for apidoc Am|bool|ckWARN3_d|U32 w1|U32 w2|U32 w3
188
189 Like C<L</ckWARN3>>, but for use if and only if any of the warning categories
190 is by default enabled even if not within the scope of S<C<use warnings>>.
191
192 =for apidoc Am|bool|ckWARN4|U32 w1|U32 w2|U32 w3|U32 w4
193
194 Like C<L</ckWARN3>>, but takes four warnings categories as input, and returns
195 TRUE if any is enabled.  If any of the categories is by default enabled even
196 if not within the scope of S<C<use warnings>>, instead use the L</ckWARN4_d>
197 macro.  The categories must be completely independent, one may not be
198 subclassed from any other.
199
200 =for apidoc Am|bool|ckWARN4_d|U32 w1|U32 w2|U32 w3|U32 w4
201
202 Like C<L</ckWARN4>>, but for use if and only if any of the warning categories
203 is by default enabled even if not within the scope of S<C<use warnings>>.
204
205 =cut
206
207 */
208
209 #define ckWARN(w)               Perl_ckwarn(aTHX_ packWARN(w))
210
211 /* The w1, w2 ... should be independent warnings categories; one shouldn't be
212  * a subcategory of any other */
213
214 #define ckWARN2(w1,w2)          Perl_ckwarn(aTHX_ packWARN2(w1,w2))
215 #define ckWARN3(w1,w2,w3)       Perl_ckwarn(aTHX_ packWARN3(w1,w2,w3))
216 #define ckWARN4(w1,w2,w3,w4)    Perl_ckwarn(aTHX_ packWARN4(w1,w2,w3,w4))
217
218 #define ckWARN_d(w)             Perl_ckwarn_d(aTHX_ packWARN(w))
219 #define ckWARN2_d(w1,w2)        Perl_ckwarn_d(aTHX_ packWARN2(w1,w2))
220 #define ckWARN3_d(w1,w2,w3)     Perl_ckwarn_d(aTHX_ packWARN3(w1,w2,w3))
221 #define ckWARN4_d(w1,w2,w3,w4)  Perl_ckwarn_d(aTHX_ packWARN4(w1,w2,w3,w4))
222
223 #define WARNshift               8
224
225 #define packWARN(a)             (a                                      )
226
227 /* The a, b, ... should be independent warnings categories; one shouldn't be
228  * a subcategory of any other */
229
230 #define packWARN2(a,b)          ((a) | ((b)<<8)                         )
231 #define packWARN3(a,b,c)        ((a) | ((b)<<8) | ((c)<<16)             )
232 #define packWARN4(a,b,c,d)      ((a) | ((b)<<8) | ((c)<<16) | ((d) <<24))
233
234 #define unpackWARN1(x)          ((x)        & 0xFF)
235 #define unpackWARN2(x)          (((x) >>8)  & 0xFF)
236 #define unpackWARN3(x)          (((x) >>16) & 0xFF)
237 #define unpackWARN4(x)          (((x) >>24) & 0xFF)
238
239 #define ckDEAD(x)                                                       \
240    (PL_curcop &&                                                        \
241     !specialWARN(PL_curcop->cop_warnings) &&                            \
242     (isWARNf_on(PL_curcop->cop_warnings, unpackWARN1(x)) ||             \
243       (unpackWARN2(x) &&                                                \
244         (isWARNf_on(PL_curcop->cop_warnings, unpackWARN2(x)) ||         \
245           (unpackWARN3(x) &&                                            \
246             (isWARNf_on(PL_curcop->cop_warnings, unpackWARN3(x)) ||     \
247               (unpackWARN4(x) &&                                        \
248                 isWARNf_on(PL_curcop->cop_warnings, unpackWARN4(x)))))))))
249
250 /* end of file warnings.h */
251
252 /* ex: set ro: */