Commit | Line | Data |
---|---|---|
599cee73 | 1 | #!/usr/bin/perl |
6294c161 DM |
2 | # |
3 | # Regenerate (overwriting only if changed): | |
4 | # | |
5 | # lib/warnings.pm | |
6 | # warnings.h | |
7 | # | |
8 | # from information hardcoded into this script (the $tree hash), plus the | |
9 | # template for warnings.pm in the DATA section. | |
10 | # | |
11 | # With an argument of 'tree', just dump the contents of $tree and exits. | |
12 | # Also accepts the standard regen_lib -q and -v args. | |
13 | # | |
14 | # This script is normally invoked from regen.pl. | |
599cee73 | 15 | |
8bc6a5d5 | 16 | $VERSION = '1.02_03'; |
b75c8c73 | 17 | |
73f0cc2d | 18 | BEGIN { |
b6b9a099 JC |
19 | require 'regen_lib.pl'; |
20 | push @INC, './lib'; | |
73f0cc2d | 21 | } |
599cee73 PM |
22 | use strict ; |
23 | ||
24 | sub DEFAULT_ON () { 1 } | |
25 | sub DEFAULT_OFF () { 2 } | |
26 | ||
27 | my $tree = { | |
d3a7d8c7 | 28 | |
0d658bf5 PM |
29 | 'all' => [ 5.008, { |
30 | 'io' => [ 5.008, { | |
31 | 'pipe' => [ 5.008, DEFAULT_OFF], | |
32 | 'unopened' => [ 5.008, DEFAULT_OFF], | |
33 | 'closed' => [ 5.008, DEFAULT_OFF], | |
34 | 'newline' => [ 5.008, DEFAULT_OFF], | |
35 | 'exec' => [ 5.008, DEFAULT_OFF], | |
36 | 'layer' => [ 5.008, DEFAULT_OFF], | |
37 | }], | |
38 | 'syntax' => [ 5.008, { | |
39 | 'ambiguous' => [ 5.008, DEFAULT_OFF], | |
40 | 'semicolon' => [ 5.008, DEFAULT_OFF], | |
41 | 'precedence' => [ 5.008, DEFAULT_OFF], | |
42 | 'bareword' => [ 5.008, DEFAULT_OFF], | |
43 | 'reserved' => [ 5.008, DEFAULT_OFF], | |
44 | 'digit' => [ 5.008, DEFAULT_OFF], | |
45 | 'parenthesis' => [ 5.008, DEFAULT_OFF], | |
46 | 'printf' => [ 5.008, DEFAULT_OFF], | |
47 | 'prototype' => [ 5.008, DEFAULT_OFF], | |
48 | 'qw' => [ 5.008, DEFAULT_OFF], | |
197afce1 | 49 | 'illegalproto' => [ 5.011, DEFAULT_OFF], |
0d658bf5 PM |
50 | }], |
51 | 'severe' => [ 5.008, { | |
52 | 'inplace' => [ 5.008, DEFAULT_ON], | |
53 | 'internal' => [ 5.008, DEFAULT_ON], | |
54 | 'debugging' => [ 5.008, DEFAULT_ON], | |
55 | 'malloc' => [ 5.008, DEFAULT_ON], | |
56 | }], | |
57 | 'deprecated' => [ 5.008, DEFAULT_OFF], | |
58 | 'void' => [ 5.008, DEFAULT_OFF], | |
59 | 'recursion' => [ 5.008, DEFAULT_OFF], | |
60 | 'redefine' => [ 5.008, DEFAULT_OFF], | |
61 | 'numeric' => [ 5.008, DEFAULT_OFF], | |
62 | 'uninitialized' => [ 5.008, DEFAULT_OFF], | |
63 | 'once' => [ 5.008, DEFAULT_OFF], | |
64 | 'misc' => [ 5.008, DEFAULT_OFF], | |
65 | 'regexp' => [ 5.008, DEFAULT_OFF], | |
66 | 'glob' => [ 5.008, DEFAULT_OFF], | |
0d658bf5 PM |
67 | 'untie' => [ 5.008, DEFAULT_OFF], |
68 | 'substr' => [ 5.008, DEFAULT_OFF], | |
69 | 'taint' => [ 5.008, DEFAULT_OFF], | |
70 | 'signal' => [ 5.008, DEFAULT_OFF], | |
71 | 'closure' => [ 5.008, DEFAULT_OFF], | |
72 | 'overflow' => [ 5.008, DEFAULT_OFF], | |
73 | 'portable' => [ 5.008, DEFAULT_OFF], | |
74 | 'utf8' => [ 5.008, DEFAULT_OFF], | |
75 | 'exiting' => [ 5.008, DEFAULT_OFF], | |
76 | 'pack' => [ 5.008, DEFAULT_OFF], | |
77 | 'unpack' => [ 5.008, DEFAULT_OFF], | |
38875929 | 78 | 'threads' => [ 5.008, DEFAULT_OFF], |
b88df990 | 79 | 'imprecision' => [ 5.011, DEFAULT_OFF], |
8fa7688f | 80 | |
0d658bf5 PM |
81 | #'default' => [ 5.008, DEFAULT_ON ], |
82 | }], | |
d3a7d8c7 | 83 | } ; |
599cee73 | 84 | |
599cee73 PM |
85 | ########################################################################### |
86 | sub tab { | |
87 | my($l, $t) = @_; | |
88 | $t .= "\t" x ($l - (length($t) + 1) / 8); | |
89 | $t; | |
90 | } | |
91 | ||
92 | ########################################################################### | |
93 | ||
94 | my %list ; | |
95 | my %Value ; | |
0d658bf5 PM |
96 | my %ValueToName ; |
97 | my %NameToValue ; | |
d3a7d8c7 | 98 | my $index ; |
599cee73 | 99 | |
0d658bf5 PM |
100 | my %v_list = () ; |
101 | ||
102 | sub valueWalk | |
103 | { | |
104 | my $tre = shift ; | |
105 | my @list = () ; | |
106 | my ($k, $v) ; | |
107 | ||
108 | foreach $k (sort keys %$tre) { | |
109 | $v = $tre->{$k}; | |
110 | die "duplicate key $k\n" if defined $list{$k} ; | |
111 | die "Value associated with key '$k' is not an ARRAY reference" | |
112 | if !ref $v || ref $v ne 'ARRAY' ; | |
113 | ||
114 | my ($ver, $rest) = @{ $v } ; | |
115 | push @{ $v_list{$ver} }, $k; | |
116 | ||
117 | if (ref $rest) | |
118 | { valueWalk ($rest) } | |
119 | ||
120 | } | |
121 | ||
122 | } | |
123 | ||
124 | sub orderValues | |
125 | { | |
126 | my $index = 0; | |
127 | foreach my $ver ( sort { $a <=> $b } keys %v_list ) { | |
128 | foreach my $name (@{ $v_list{$ver} } ) { | |
129 | $ValueToName{ $index } = [ uc $name, $ver ] ; | |
130 | $NameToValue{ uc $name } = $index ++ ; | |
131 | } | |
132 | } | |
133 | ||
134 | return $index ; | |
135 | } | |
136 | ||
137 | ########################################################################### | |
138 | ||
599cee73 PM |
139 | sub walk |
140 | { | |
141 | my $tre = shift ; | |
142 | my @list = () ; | |
143 | my ($k, $v) ; | |
144 | ||
95dfd3ab GS |
145 | foreach $k (sort keys %$tre) { |
146 | $v = $tre->{$k}; | |
599cee73 | 147 | die "duplicate key $k\n" if defined $list{$k} ; |
0d658bf5 PM |
148 | #$Value{$index} = uc $k ; |
149 | die "Can't find key '$k'" | |
150 | if ! defined $NameToValue{uc $k} ; | |
151 | push @{ $list{$k} }, $NameToValue{uc $k} ; | |
152 | die "Value associated with key '$k' is not an ARRAY reference" | |
153 | if !ref $v || ref $v ne 'ARRAY' ; | |
154 | ||
155 | my ($ver, $rest) = @{ $v } ; | |
156 | if (ref $rest) | |
157 | { push (@{ $list{$k} }, walk ($rest)) } | |
158 | ||
599cee73 PM |
159 | push @list, @{ $list{$k} } ; |
160 | } | |
161 | ||
162 | return @list ; | |
599cee73 PM |
163 | } |
164 | ||
165 | ########################################################################### | |
166 | ||
167 | sub mkRange | |
168 | { | |
169 | my @a = @_ ; | |
170 | my @out = @a ; | |
171 | my $i ; | |
172 | ||
173 | ||
174 | for ($i = 1 ; $i < @a; ++ $i) { | |
0ca4541c | 175 | $out[$i] = ".." |
599cee73 PM |
176 | if $a[$i] == $a[$i - 1] + 1 && $a[$i] + 1 == $a[$i + 1] ; |
177 | } | |
178 | ||
179 | my $out = join(",",@out); | |
180 | ||
181 | $out =~ s/,(\.\.,)+/../g ; | |
182 | return $out; | |
183 | } | |
184 | ||
185 | ########################################################################### | |
e476b1b5 GS |
186 | sub printTree |
187 | { | |
188 | my $tre = shift ; | |
189 | my $prefix = shift ; | |
e476b1b5 GS |
190 | my ($k, $v) ; |
191 | ||
192 | my $max = (sort {$a <=> $b} map { length $_ } keys %$tre)[-1] ; | |
0d658bf5 | 193 | my @keys = sort keys %$tre ; |
e476b1b5 | 194 | |
0d658bf5 | 195 | while ($k = shift @keys) { |
e476b1b5 | 196 | $v = $tre->{$k}; |
0d658bf5 PM |
197 | die "Value associated with key '$k' is not an ARRAY reference" |
198 | if !ref $v || ref $v ne 'ARRAY' ; | |
199 | ||
200 | my $offset ; | |
201 | if ($tre ne $tree) { | |
202 | print $prefix . "|\n" ; | |
203 | print $prefix . "+- $k" ; | |
204 | $offset = ' ' x ($max + 4) ; | |
205 | } | |
206 | else { | |
207 | print $prefix . "$k" ; | |
208 | $offset = ' ' x ($max + 1) ; | |
209 | } | |
210 | ||
211 | my ($ver, $rest) = @{ $v } ; | |
212 | if (ref $rest) | |
0ca4541c | 213 | { |
0d658bf5 PM |
214 | my $bar = @keys ? "|" : " "; |
215 | print " -" . "-" x ($max - length $k ) . "+\n" ; | |
216 | printTree ($rest, $prefix . $bar . $offset ) | |
e476b1b5 GS |
217 | } |
218 | else | |
219 | { print "\n" } | |
220 | } | |
221 | ||
222 | } | |
223 | ||
224 | ########################################################################### | |
599cee73 | 225 | |
317ea90d | 226 | sub mkHexOct |
599cee73 | 227 | { |
317ea90d | 228 | my ($f, $max, @a) = @_ ; |
599cee73 PM |
229 | my $mask = "\x00" x $max ; |
230 | my $string = "" ; | |
231 | ||
232 | foreach (@a) { | |
233 | vec($mask, $_, 1) = 1 ; | |
234 | } | |
235 | ||
599cee73 | 236 | foreach (unpack("C*", $mask)) { |
317ea90d MS |
237 | if ($f eq 'x') { |
238 | $string .= '\x' . sprintf("%2.2x", $_) | |
239 | } | |
240 | else { | |
241 | $string .= '\\' . sprintf("%o", $_) | |
242 | } | |
599cee73 PM |
243 | } |
244 | return $string ; | |
245 | } | |
246 | ||
317ea90d MS |
247 | sub mkHex |
248 | { | |
249 | my($max, @a) = @_; | |
250 | return mkHexOct("x", $max, @a); | |
251 | } | |
252 | ||
253 | sub mkOct | |
254 | { | |
255 | my($max, @a) = @_; | |
256 | return mkHexOct("o", $max, @a); | |
257 | } | |
258 | ||
599cee73 PM |
259 | ########################################################################### |
260 | ||
e476b1b5 GS |
261 | if (@ARGV && $ARGV[0] eq "tree") |
262 | { | |
0d658bf5 | 263 | printTree($tree, " ") ; |
e476b1b5 GS |
264 | exit ; |
265 | } | |
599cee73 | 266 | |
424a4936 NC |
267 | my $warn = safer_open("warnings.h-new"); |
268 | my $pm = safer_open("lib/warnings.pm-new"); | |
599cee73 | 269 | |
424a4936 | 270 | print $warn <<'EOM' ; |
37442d52 RGS |
271 | /* -*- buffer-read-only: t -*- |
272 | !!!!!!! DO NOT EDIT THIS FILE !!!!!!! | |
4438c4b7 | 273 | This file is built by warnings.pl |
599cee73 PM |
274 | Any changes made here will be lost! |
275 | */ | |
276 | ||
277 | ||
0453d815 PM |
278 | #define Off(x) ((x) / 8) |
279 | #define Bit(x) (1 << ((x) % 8)) | |
599cee73 PM |
280 | #define IsSet(a, x) ((a)[Off(x)] & Bit(x)) |
281 | ||
0453d815 | 282 | |
599cee73 | 283 | #define G_WARN_OFF 0 /* $^W == 0 */ |
0453d815 | 284 | #define G_WARN_ON 1 /* -w flag and $^W != 0 */ |
599cee73 PM |
285 | #define G_WARN_ALL_ON 2 /* -W flag */ |
286 | #define G_WARN_ALL_OFF 4 /* -X flag */ | |
0453d815 | 287 | #define G_WARN_ONCE 8 /* set if 'once' ever enabled */ |
599cee73 PM |
288 | #define G_WARN_ALL_MASK (G_WARN_ALL_ON|G_WARN_ALL_OFF) |
289 | ||
a0714e2c | 290 | #define pWARN_STD NULL |
72dc9ed5 NC |
291 | #define pWARN_ALL (((STRLEN*)0)+1) /* use warnings 'all' */ |
292 | #define pWARN_NONE (((STRLEN*)0)+2) /* no warnings 'all' */ | |
599cee73 | 293 | |
d3a7d8c7 GS |
294 | #define specialWARN(x) ((x) == pWARN_STD || (x) == pWARN_ALL || \ |
295 | (x) == pWARN_NONE) | |
5f2d9966 DM |
296 | |
297 | /* if PL_warnhook is set to this value, then warnings die */ | |
06dcd5bf | 298 | #define PERL_WARNHOOK_FATAL (&PL_sv_placeholder) |
599cee73 PM |
299 | EOM |
300 | ||
d3a7d8c7 GS |
301 | my $offset = 0 ; |
302 | ||
303 | $index = $offset ; | |
304 | #@{ $list{"all"} } = walk ($tree) ; | |
0d658bf5 PM |
305 | valueWalk ($tree) ; |
306 | my $index = orderValues(); | |
599cee73 | 307 | |
12bcd1a6 PM |
308 | die <<EOM if $index > 255 ; |
309 | Too many warnings categories -- max is 255 | |
310 | rewrite packWARN* & unpackWARN* macros | |
311 | EOM | |
599cee73 | 312 | |
0d658bf5 PM |
313 | walk ($tree) ; |
314 | ||
599cee73 PM |
315 | $index *= 2 ; |
316 | my $warn_size = int($index / 8) + ($index % 8 != 0) ; | |
317 | ||
318 | my $k ; | |
0d658bf5 PM |
319 | my $last_ver = 0; |
320 | foreach $k (sort { $a <=> $b } keys %ValueToName) { | |
321 | my ($name, $version) = @{ $ValueToName{$k} }; | |
424a4936 | 322 | print $warn "\n/* Warnings Categories added in Perl $version */\n\n" |
0d658bf5 | 323 | if $last_ver != $version ; |
424a4936 | 324 | print $warn tab(5, "#define WARN_$name"), "$k\n" ; |
0d658bf5 | 325 | $last_ver = $version ; |
599cee73 | 326 | } |
424a4936 | 327 | print $warn "\n" ; |
599cee73 | 328 | |
424a4936 | 329 | print $warn tab(5, '#define WARNsize'), "$warn_size\n" ; |
599cee73 | 330 | #print WARN tab(5, '#define WARN_ALLstring'), '"', ('\377' x $warn_size) , "\"\n" ; |
424a4936 NC |
331 | print $warn tab(5, '#define WARN_ALLstring'), '"', ('\125' x $warn_size) , "\"\n" ; |
332 | print $warn tab(5, '#define WARN_NONEstring'), '"', ('\0' x $warn_size) , "\"\n" ; | |
599cee73 | 333 | |
424a4936 | 334 | print $warn <<'EOM'; |
599cee73 | 335 | |
d5a71f30 GS |
336 | #define isLEXWARN_on (PL_curcop->cop_warnings != pWARN_STD) |
337 | #define isLEXWARN_off (PL_curcop->cop_warnings == pWARN_STD) | |
338 | #define isWARN_ONCE (PL_dowarn & (G_WARN_ON|G_WARN_ONCE)) | |
72dc9ed5 NC |
339 | #define isWARN_on(c,x) (IsSet((U8 *)(c + 1), 2*(x))) |
340 | #define isWARNf_on(c,x) (IsSet((U8 *)(c + 1), 2*(x)+1)) | |
341 | ||
342 | #define DUP_WARNINGS(p) \ | |
594cd643 NC |
343 | (specialWARN(p) ? (STRLEN*)(p) \ |
344 | : (STRLEN*)CopyD(p, PerlMemShared_malloc(sizeof(*p)+*p), sizeof(*p)+*p, \ | |
345 | char)) | |
d5a71f30 | 346 | |
f54ba1c2 DM |
347 | #define ckWARN(w) Perl_ckwarn(aTHX_ packWARN(w)) |
348 | #define ckWARN2(w1,w2) Perl_ckwarn(aTHX_ packWARN2(w1,w2)) | |
349 | #define ckWARN3(w1,w2,w3) Perl_ckwarn(aTHX_ packWARN3(w1,w2,w3)) | |
350 | #define ckWARN4(w1,w2,w3,w4) Perl_ckwarn(aTHX_ packWARN4(w1,w2,w3,w4)) | |
351 | ||
352 | #define ckWARN_d(w) Perl_ckwarn_d(aTHX_ packWARN(w)) | |
353 | #define ckWARN2_d(w1,w2) Perl_ckwarn_d(aTHX_ packWARN2(w1,w2)) | |
354 | #define ckWARN3_d(w1,w2,w3) Perl_ckwarn_d(aTHX_ packWARN3(w1,w2,w3)) | |
355 | #define ckWARN4_d(w1,w2,w3,w4) Perl_ckwarn_d(aTHX_ packWARN4(w1,w2,w3,w4)) | |
12bcd1a6 | 356 | |
98fe6610 NC |
357 | #define WARNshift 8 |
358 | ||
3b9e3074 SH |
359 | #define packWARN(a) (a ) |
360 | #define packWARN2(a,b) ((a) | ((b)<<8) ) | |
361 | #define packWARN3(a,b,c) ((a) | ((b)<<8) | ((c)<<16) ) | |
362 | #define packWARN4(a,b,c,d) ((a) | ((b)<<8) | ((c)<<16) | ((d) <<24)) | |
12bcd1a6 PM |
363 | |
364 | #define unpackWARN1(x) ((x) & 0xFF) | |
365 | #define unpackWARN2(x) (((x) >>8) & 0xFF) | |
366 | #define unpackWARN3(x) (((x) >>16) & 0xFF) | |
367 | #define unpackWARN4(x) (((x) >>24) & 0xFF) | |
368 | ||
369 | #define ckDEAD(x) \ | |
370 | ( ! specialWARN(PL_curcop->cop_warnings) && \ | |
371 | ( isWARNf_on(PL_curcop->cop_warnings, WARN_ALL) || \ | |
372 | isWARNf_on(PL_curcop->cop_warnings, unpackWARN1(x)) || \ | |
373 | isWARNf_on(PL_curcop->cop_warnings, unpackWARN2(x)) || \ | |
374 | isWARNf_on(PL_curcop->cop_warnings, unpackWARN3(x)) || \ | |
375 | isWARNf_on(PL_curcop->cop_warnings, unpackWARN4(x)))) | |
376 | ||
4438c4b7 | 377 | /* end of file warnings.h */ |
37442d52 | 378 | /* ex: set ro: */ |
599cee73 PM |
379 | EOM |
380 | ||
08858ed2 | 381 | safer_close $warn; |
424a4936 | 382 | rename_if_different("warnings.h-new", "warnings.h"); |
599cee73 PM |
383 | |
384 | while (<DATA>) { | |
385 | last if /^KEYWORDS$/ ; | |
424a4936 | 386 | print $pm $_ ; |
599cee73 PM |
387 | } |
388 | ||
d3a7d8c7 GS |
389 | #$list{'all'} = [ $offset .. 8 * ($warn_size/2) - 1 ] ; |
390 | ||
0d658bf5 | 391 | $last_ver = 0; |
424a4936 | 392 | print $pm "our %Offsets = (\n" ; |
0d658bf5 PM |
393 | foreach my $k (sort { $a <=> $b } keys %ValueToName) { |
394 | my ($name, $version) = @{ $ValueToName{$k} }; | |
395 | $name = lc $name; | |
d3a7d8c7 | 396 | $k *= 2 ; |
0d658bf5 | 397 | if ( $last_ver != $version ) { |
424a4936 NC |
398 | print $pm "\n"; |
399 | print $pm tab(4, " # Warnings Categories added in Perl $version"); | |
400 | print $pm "\n\n"; | |
0d658bf5 | 401 | } |
424a4936 | 402 | print $pm tab(4, " '$name'"), "=> $k,\n" ; |
0d658bf5 | 403 | $last_ver = $version; |
d3a7d8c7 GS |
404 | } |
405 | ||
424a4936 | 406 | print $pm " );\n\n" ; |
d3a7d8c7 | 407 | |
424a4936 | 408 | print $pm "our %Bits = (\n" ; |
599cee73 PM |
409 | foreach $k (sort keys %list) { |
410 | ||
411 | my $v = $list{$k} ; | |
412 | my @list = sort { $a <=> $b } @$v ; | |
413 | ||
424a4936 | 414 | print $pm tab(4, " '$k'"), '=> "', |
0ca4541c NIS |
415 | # mkHex($warn_size, @list), |
416 | mkHex($warn_size, map $_ * 2 , @list), | |
599cee73 PM |
417 | '", # [', mkRange(@list), "]\n" ; |
418 | } | |
419 | ||
424a4936 | 420 | print $pm " );\n\n" ; |
599cee73 | 421 | |
424a4936 | 422 | print $pm "our %DeadBits = (\n" ; |
599cee73 PM |
423 | foreach $k (sort keys %list) { |
424 | ||
425 | my $v = $list{$k} ; | |
426 | my @list = sort { $a <=> $b } @$v ; | |
427 | ||
424a4936 | 428 | print $pm tab(4, " '$k'"), '=> "', |
0ca4541c NIS |
429 | # mkHex($warn_size, @list), |
430 | mkHex($warn_size, map $_ * 2 + 1 , @list), | |
599cee73 PM |
431 | '", # [', mkRange(@list), "]\n" ; |
432 | } | |
433 | ||
424a4936 NC |
434 | print $pm " );\n\n" ; |
435 | print $pm '$NONE = "', ('\0' x $warn_size) , "\";\n" ; | |
436 | print $pm '$LAST_BIT = ' . "$index ;\n" ; | |
437 | print $pm '$BYTES = ' . "$warn_size ;\n" ; | |
599cee73 | 438 | while (<DATA>) { |
424a4936 | 439 | print $pm $_ ; |
599cee73 PM |
440 | } |
441 | ||
424a4936 | 442 | print $pm "# ex: set ro:\n"; |
08858ed2 | 443 | safer_close $pm; |
424a4936 | 444 | rename_if_different("lib/warnings.pm-new", "lib/warnings.pm"); |
599cee73 PM |
445 | |
446 | __END__ | |
37442d52 | 447 | # -*- buffer-read-only: t -*- |
38875929 | 448 | # !!!!!!! DO NOT EDIT THIS FILE !!!!!!! |
4438c4b7 | 449 | # This file was created by warnings.pl |
599cee73 PM |
450 | # Any changes made here will be lost. |
451 | # | |
452 | ||
4438c4b7 | 453 | package warnings; |
599cee73 | 454 | |
f73b28b4 | 455 | our $VERSION = '1.09'; |
f2c3e829 RGS |
456 | |
457 | # Verify that we're called correctly so that warnings will work. | |
458 | # see also strict.pm. | |
5108dc18 | 459 | unless ( __FILE__ =~ /(^|[\/\\])\Q${\__PACKAGE__}\E\.pmc?$/ ) { |
f2c3e829 | 460 | my (undef, $f, $l) = caller; |
5108dc18 | 461 | die("Incorrect use of pragma '${\__PACKAGE__}' at $f line $l.\n"); |
f2c3e829 | 462 | } |
b75c8c73 | 463 | |
599cee73 PM |
464 | =head1 NAME |
465 | ||
4438c4b7 | 466 | warnings - Perl pragma to control optional warnings |
599cee73 PM |
467 | |
468 | =head1 SYNOPSIS | |
469 | ||
4438c4b7 JH |
470 | use warnings; |
471 | no warnings; | |
599cee73 | 472 | |
4438c4b7 JH |
473 | use warnings "all"; |
474 | no warnings "all"; | |
599cee73 | 475 | |
d3a7d8c7 GS |
476 | use warnings::register; |
477 | if (warnings::enabled()) { | |
478 | warnings::warn("some warning"); | |
479 | } | |
480 | ||
481 | if (warnings::enabled("void")) { | |
e476b1b5 GS |
482 | warnings::warn("void", "some warning"); |
483 | } | |
484 | ||
7e6d00f8 PM |
485 | if (warnings::enabled($object)) { |
486 | warnings::warn($object, "some warning"); | |
487 | } | |
488 | ||
721f911b PM |
489 | warnings::warnif("some warning"); |
490 | warnings::warnif("void", "some warning"); | |
491 | warnings::warnif($object, "some warning"); | |
7e6d00f8 | 492 | |
599cee73 PM |
493 | =head1 DESCRIPTION |
494 | ||
fe2e802c EM |
495 | The C<warnings> pragma is a replacement for the command line flag C<-w>, |
496 | but the pragma is limited to the enclosing block, while the flag is global. | |
497 | See L<perllexwarn> for more information. | |
498 | ||
0453d815 PM |
499 | If no import list is supplied, all possible warnings are either enabled |
500 | or disabled. | |
599cee73 | 501 | |
0ca4541c | 502 | A number of functions are provided to assist module authors. |
e476b1b5 GS |
503 | |
504 | =over 4 | |
505 | ||
d3a7d8c7 GS |
506 | =item use warnings::register |
507 | ||
7e6d00f8 PM |
508 | Creates a new warnings category with the same name as the package where |
509 | the call to the pragma is used. | |
510 | ||
511 | =item warnings::enabled() | |
512 | ||
513 | Use the warnings category with the same name as the current package. | |
514 | ||
515 | Return TRUE if that warnings category is enabled in the calling module. | |
516 | Otherwise returns FALSE. | |
517 | ||
518 | =item warnings::enabled($category) | |
519 | ||
520 | Return TRUE if the warnings category, C<$category>, is enabled in the | |
521 | calling module. | |
522 | Otherwise returns FALSE. | |
523 | ||
524 | =item warnings::enabled($object) | |
525 | ||
526 | Use the name of the class for the object reference, C<$object>, as the | |
527 | warnings category. | |
528 | ||
529 | Return TRUE if that warnings category is enabled in the first scope | |
530 | where the object is used. | |
531 | Otherwise returns FALSE. | |
532 | ||
ec983580 AR |
533 | =item warnings::fatal_enabled() |
534 | ||
535 | Return TRUE if the warnings category with the same name as the current | |
536 | package has been set to FATAL in the calling module. | |
537 | Otherwise returns FALSE. | |
538 | ||
539 | =item warnings::fatal_enabled($category) | |
540 | ||
541 | Return TRUE if the warnings category C<$category> has been set to FATAL in | |
542 | the calling module. | |
543 | Otherwise returns FALSE. | |
544 | ||
545 | =item warnings::fatal_enabled($object) | |
546 | ||
547 | Use the name of the class for the object reference, C<$object>, as the | |
548 | warnings category. | |
549 | ||
550 | Return TRUE if that warnings category has been set to FATAL in the first | |
551 | scope where the object is used. | |
552 | Otherwise returns FALSE. | |
553 | ||
7e6d00f8 PM |
554 | =item warnings::warn($message) |
555 | ||
556 | Print C<$message> to STDERR. | |
557 | ||
558 | Use the warnings category with the same name as the current package. | |
559 | ||
560 | If that warnings category has been set to "FATAL" in the calling module | |
561 | then die. Otherwise return. | |
562 | ||
563 | =item warnings::warn($category, $message) | |
564 | ||
565 | Print C<$message> to STDERR. | |
566 | ||
567 | If the warnings category, C<$category>, has been set to "FATAL" in the | |
568 | calling module then die. Otherwise return. | |
d3a7d8c7 | 569 | |
7e6d00f8 | 570 | =item warnings::warn($object, $message) |
e476b1b5 | 571 | |
7e6d00f8 | 572 | Print C<$message> to STDERR. |
e476b1b5 | 573 | |
7e6d00f8 PM |
574 | Use the name of the class for the object reference, C<$object>, as the |
575 | warnings category. | |
e476b1b5 | 576 | |
7e6d00f8 PM |
577 | If that warnings category has been set to "FATAL" in the scope where C<$object> |
578 | is first used then die. Otherwise return. | |
599cee73 | 579 | |
e476b1b5 | 580 | |
7e6d00f8 PM |
581 | =item warnings::warnif($message) |
582 | ||
583 | Equivalent to: | |
584 | ||
585 | if (warnings::enabled()) | |
586 | { warnings::warn($message) } | |
587 | ||
588 | =item warnings::warnif($category, $message) | |
589 | ||
590 | Equivalent to: | |
591 | ||
592 | if (warnings::enabled($category)) | |
593 | { warnings::warn($category, $message) } | |
594 | ||
595 | =item warnings::warnif($object, $message) | |
596 | ||
597 | Equivalent to: | |
598 | ||
599 | if (warnings::enabled($object)) | |
600 | { warnings::warn($object, $message) } | |
d3a7d8c7 | 601 | |
e476b1b5 GS |
602 | =back |
603 | ||
749f83fa | 604 | See L<perlmodlib/Pragmatic Modules> and L<perllexwarn>. |
599cee73 PM |
605 | |
606 | =cut | |
607 | ||
599cee73 PM |
608 | KEYWORDS |
609 | ||
d3a7d8c7 GS |
610 | $All = "" ; vec($All, $Offsets{'all'}, 2) = 3 ; |
611 | ||
c3186b65 PM |
612 | sub Croaker |
613 | { | |
4dd71923 | 614 | require Carp; # this initializes %CarpInternal |
dbab294c | 615 | local $Carp::CarpInternal{'warnings'}; |
c3186b65 | 616 | delete $Carp::CarpInternal{'warnings'}; |
8becbb3b | 617 | Carp::croak(@_); |
c3186b65 PM |
618 | } |
619 | ||
6e9af7e4 PM |
620 | sub bits |
621 | { | |
622 | # called from B::Deparse.pm | |
623 | ||
624 | push @_, 'all' unless @_; | |
625 | ||
626 | my $mask; | |
599cee73 PM |
627 | my $catmask ; |
628 | my $fatal = 0 ; | |
6e9af7e4 PM |
629 | my $no_fatal = 0 ; |
630 | ||
631 | foreach my $word ( @_ ) { | |
632 | if ($word eq 'FATAL') { | |
327afb7f | 633 | $fatal = 1; |
6e9af7e4 PM |
634 | $no_fatal = 0; |
635 | } | |
636 | elsif ($word eq 'NONFATAL') { | |
637 | $fatal = 0; | |
638 | $no_fatal = 1; | |
327afb7f | 639 | } |
d3a7d8c7 GS |
640 | elsif ($catmask = $Bits{$word}) { |
641 | $mask |= $catmask ; | |
642 | $mask |= $DeadBits{$word} if $fatal ; | |
6e9af7e4 | 643 | $mask &= ~($DeadBits{$word}|$All) if $no_fatal ; |
599cee73 | 644 | } |
d3a7d8c7 | 645 | else |
c3186b65 | 646 | { Croaker("Unknown warnings category '$word'")} |
599cee73 PM |
647 | } |
648 | ||
649 | return $mask ; | |
650 | } | |
651 | ||
6e9af7e4 PM |
652 | sub import |
653 | { | |
599cee73 | 654 | shift; |
6e9af7e4 PM |
655 | |
656 | my $catmask ; | |
657 | my $fatal = 0 ; | |
658 | my $no_fatal = 0 ; | |
659 | ||
f1f33818 | 660 | my $mask = ${^WARNING_BITS} ; |
6e9af7e4 | 661 | |
f1f33818 PM |
662 | if (vec($mask, $Offsets{'all'}, 1)) { |
663 | $mask |= $Bits{'all'} ; | |
664 | $mask |= $DeadBits{'all'} if vec($mask, $Offsets{'all'}+1, 1); | |
665 | } | |
6e9af7e4 PM |
666 | |
667 | push @_, 'all' unless @_; | |
668 | ||
669 | foreach my $word ( @_ ) { | |
670 | if ($word eq 'FATAL') { | |
671 | $fatal = 1; | |
672 | $no_fatal = 0; | |
673 | } | |
674 | elsif ($word eq 'NONFATAL') { | |
675 | $fatal = 0; | |
676 | $no_fatal = 1; | |
677 | } | |
678 | elsif ($catmask = $Bits{$word}) { | |
679 | $mask |= $catmask ; | |
680 | $mask |= $DeadBits{$word} if $fatal ; | |
681 | $mask &= ~($DeadBits{$word}|$All) if $no_fatal ; | |
682 | } | |
683 | else | |
684 | { Croaker("Unknown warnings category '$word'")} | |
685 | } | |
686 | ||
687 | ${^WARNING_BITS} = $mask ; | |
599cee73 PM |
688 | } |
689 | ||
6e9af7e4 PM |
690 | sub unimport |
691 | { | |
599cee73 | 692 | shift; |
6e9af7e4 PM |
693 | |
694 | my $catmask ; | |
d3a7d8c7 | 695 | my $mask = ${^WARNING_BITS} ; |
6e9af7e4 | 696 | |
d3a7d8c7 | 697 | if (vec($mask, $Offsets{'all'}, 1)) { |
f1f33818 | 698 | $mask |= $Bits{'all'} ; |
d3a7d8c7 GS |
699 | $mask |= $DeadBits{'all'} if vec($mask, $Offsets{'all'}+1, 1); |
700 | } | |
6e9af7e4 PM |
701 | |
702 | push @_, 'all' unless @_; | |
703 | ||
704 | foreach my $word ( @_ ) { | |
705 | if ($word eq 'FATAL') { | |
706 | next; | |
707 | } | |
708 | elsif ($catmask = $Bits{$word}) { | |
709 | $mask &= ~($catmask | $DeadBits{$word} | $All); | |
710 | } | |
711 | else | |
712 | { Croaker("Unknown warnings category '$word'")} | |
713 | } | |
714 | ||
715 | ${^WARNING_BITS} = $mask ; | |
599cee73 PM |
716 | } |
717 | ||
9df0f64f MK |
718 | my %builtin_type; @builtin_type{qw(SCALAR ARRAY HASH CODE REF GLOB LVALUE Regexp)} = (); |
719 | ||
7e6d00f8 | 720 | sub __chk |
599cee73 | 721 | { |
d3a7d8c7 GS |
722 | my $category ; |
723 | my $offset ; | |
7e6d00f8 | 724 | my $isobj = 0 ; |
d3a7d8c7 GS |
725 | |
726 | if (@_) { | |
727 | # check the category supplied. | |
728 | $category = shift ; | |
9df0f64f MK |
729 | if (my $type = ref $category) { |
730 | Croaker("not an object") | |
731 | if exists $builtin_type{$type}; | |
732 | $category = $type; | |
7e6d00f8 PM |
733 | $isobj = 1 ; |
734 | } | |
d3a7d8c7 | 735 | $offset = $Offsets{$category}; |
c3186b65 | 736 | Croaker("Unknown warnings category '$category'") |
d3a7d8c7 GS |
737 | unless defined $offset; |
738 | } | |
739 | else { | |
0ca4541c | 740 | $category = (caller(1))[0] ; |
d3a7d8c7 | 741 | $offset = $Offsets{$category}; |
c3186b65 | 742 | Croaker("package '$category' not registered for warnings") |
d3a7d8c7 GS |
743 | unless defined $offset ; |
744 | } | |
745 | ||
0ca4541c | 746 | my $this_pkg = (caller(1))[0] ; |
7e6d00f8 PM |
747 | my $i = 2 ; |
748 | my $pkg ; | |
749 | ||
750 | if ($isobj) { | |
751 | while (do { { package DB; $pkg = (caller($i++))[0] } } ) { | |
752 | last unless @DB::args && $DB::args[0] =~ /^$category=/ ; | |
753 | } | |
754 | $i -= 2 ; | |
755 | } | |
756 | else { | |
4f527b71 | 757 | $i = _error_loc(); # see where Carp will allocate the error |
7e6d00f8 PM |
758 | } |
759 | ||
0ca4541c | 760 | my $callers_bitmask = (caller($i))[9] ; |
7e6d00f8 PM |
761 | return ($callers_bitmask, $offset, $i) ; |
762 | } | |
763 | ||
4f527b71 | 764 | sub _error_loc { |
4dd71923 | 765 | require Carp; |
4f527b71 AS |
766 | goto &Carp::short_error_loc; # don't introduce another stack frame |
767 | } | |
768 | ||
7e6d00f8 PM |
769 | sub enabled |
770 | { | |
c3186b65 | 771 | Croaker("Usage: warnings::enabled([category])") |
7e6d00f8 PM |
772 | unless @_ == 1 || @_ == 0 ; |
773 | ||
774 | my ($callers_bitmask, $offset, $i) = __chk(@_) ; | |
775 | ||
776 | return 0 unless defined $callers_bitmask ; | |
d3a7d8c7 GS |
777 | return vec($callers_bitmask, $offset, 1) || |
778 | vec($callers_bitmask, $Offsets{'all'}, 1) ; | |
599cee73 PM |
779 | } |
780 | ||
ec983580 AR |
781 | sub fatal_enabled |
782 | { | |
783 | Croaker("Usage: warnings::fatal_enabled([category])") | |
784 | unless @_ == 1 || @_ == 0 ; | |
785 | ||
786 | my ($callers_bitmask, $offset, $i) = __chk(@_) ; | |
787 | ||
788 | return 0 unless defined $callers_bitmask; | |
789 | return vec($callers_bitmask, $offset + 1, 1) || | |
790 | vec($callers_bitmask, $Offsets{'all'} + 1, 1) ; | |
791 | } | |
d3a7d8c7 | 792 | |
e476b1b5 GS |
793 | sub warn |
794 | { | |
c3186b65 | 795 | Croaker("Usage: warnings::warn([category,] 'message')") |
d3a7d8c7 | 796 | unless @_ == 2 || @_ == 1 ; |
d3a7d8c7 | 797 | |
7e6d00f8 PM |
798 | my $message = pop ; |
799 | my ($callers_bitmask, $offset, $i) = __chk(@_) ; | |
09e96b99 | 800 | require Carp; |
8becbb3b | 801 | Carp::croak($message) |
d3a7d8c7 GS |
802 | if vec($callers_bitmask, $offset+1, 1) || |
803 | vec($callers_bitmask, $Offsets{'all'}+1, 1) ; | |
8becbb3b | 804 | Carp::carp($message) ; |
e476b1b5 GS |
805 | } |
806 | ||
7e6d00f8 PM |
807 | sub warnif |
808 | { | |
c3186b65 | 809 | Croaker("Usage: warnings::warnif([category,] 'message')") |
7e6d00f8 PM |
810 | unless @_ == 2 || @_ == 1 ; |
811 | ||
812 | my $message = pop ; | |
813 | my ($callers_bitmask, $offset, $i) = __chk(@_) ; | |
7e6d00f8 | 814 | |
0ca4541c | 815 | return |
7e6d00f8 PM |
816 | unless defined $callers_bitmask && |
817 | (vec($callers_bitmask, $offset, 1) || | |
818 | vec($callers_bitmask, $Offsets{'all'}, 1)) ; | |
819 | ||
09e96b99 | 820 | require Carp; |
8becbb3b | 821 | Carp::croak($message) |
7e6d00f8 PM |
822 | if vec($callers_bitmask, $offset+1, 1) || |
823 | vec($callers_bitmask, $Offsets{'all'}+1, 1) ; | |
824 | ||
8becbb3b | 825 | Carp::carp($message) ; |
7e6d00f8 | 826 | } |
0d658bf5 | 827 | |
599cee73 | 828 | 1; |