Commit | Line | Data |
0453d815 |
1 | =head1 NAME |
d74e8afc |
2 | X<warning, lexical> X<warnings> X<warning> |
0453d815 |
3 | |
4 | perllexwarn - Perl Lexical Warnings |
5 | |
6 | =head1 DESCRIPTION |
5a3e7812 |
7 | |
4438c4b7 |
8 | The C<use warnings> pragma is a replacement for both the command line |
0453d815 |
9 | flag B<-w> and the equivalent Perl variable, C<$^W>. |
10 | |
11 | The pragma works just like the existing "strict" pragma. |
12 | This means that the scope of the warning pragma is limited to the |
106325ad |
13 | enclosing block. It also means that the pragma setting will not |
0453d815 |
14 | leak across files (via C<use>, C<require> or C<do>). This allows |
15 | authors to independently define the degree of warning checks that will |
16 | be applied to their module. |
17 | |
18 | By default, optional warnings are disabled, so any legacy code that |
19 | doesn't attempt to control the warnings will work unchanged. |
20 | |
21 | All warnings are enabled in a block by either of these: |
c47ff5f1 |
22 | |
4358a253 |
23 | use warnings; |
24 | use warnings 'all'; |
c47ff5f1 |
25 | |
0453d815 |
26 | Similarly all warnings are disabled in a block by either of these: |
27 | |
4358a253 |
28 | no warnings; |
29 | no warnings 'all'; |
0453d815 |
30 | |
31 | For example, consider the code below: |
32 | |
4358a253 |
33 | use warnings; |
34 | my @a; |
0453d815 |
35 | { |
4358a253 |
36 | no warnings; |
37 | my $b = @a[0]; |
0453d815 |
38 | } |
f1f33818 |
39 | my $c = @a[0]; |
0453d815 |
40 | |
41 | The code in the enclosing block has warnings enabled, but the inner |
f1f33818 |
42 | block has them disabled. In this case that means the assignment to the |
43 | scalar C<$c> will trip the C<"Scalar value @a[0] better written as $a[0]"> |
44 | warning, but the assignment to the scalar C<$b> will not. |
0453d815 |
45 | |
46 | =head2 Default Warnings and Optional Warnings |
47 | |
48 | Before the introduction of lexical warnings, Perl had two classes of |
49 | warnings: mandatory and optional. |
50 | |
51 | As its name suggests, if your code tripped a mandatory warning, you |
52 | would get a warning whether you wanted it or not. |
252aa082 |
53 | For example, the code below would always produce an C<"isn't numeric"> |
54 | warning about the "2:". |
0453d815 |
55 | |
252aa082 |
56 | my $a = "2:" + 3; |
0453d815 |
57 | |
0453d815 |
58 | With the introduction of lexical warnings, mandatory warnings now become |
59 | I<default> warnings. The difference is that although the previously |
60 | mandatory warnings are still enabled by default, they can then be |
61 | subsequently enabled or disabled with the lexical warning pragma. For |
e476b1b5 |
62 | example, in the code below, an C<"isn't numeric"> warning will only |
0453d815 |
63 | be reported for the C<$a> variable. |
64 | |
252aa082 |
65 | my $a = "2:" + 3; |
4358a253 |
66 | no warnings; |
252aa082 |
67 | my $b = "2:" + 3; |
0453d815 |
68 | |
69 | Note that neither the B<-w> flag or the C<$^W> can be used to |
70 | disable/enable default warnings. They are still mandatory in this case. |
71 | |
72 | =head2 What's wrong with B<-w> and C<$^W> |
73 | |
74 | Although very useful, the big problem with using B<-w> on the command |
75 | line to enable warnings is that it is all or nothing. Take the typical |
76 | scenario when you are writing a Perl program. Parts of the code you |
77 | will write yourself, but it's very likely that you will make use of |
78 | pre-written Perl modules. If you use the B<-w> flag in this case, you |
79 | end up enabling warnings in pieces of code that you haven't written. |
80 | |
81 | Similarly, using C<$^W> to either disable or enable blocks of code is |
82 | fundamentally flawed. For a start, say you want to disable warnings in |
83 | a block of code. You might expect this to be enough to do the trick: |
84 | |
85 | { |
4358a253 |
86 | local ($^W) = 0; |
87 | my $a =+ 2; |
88 | my $b; chop $b; |
0453d815 |
89 | } |
90 | |
91 | When this code is run with the B<-w> flag, a warning will be produced |
92 | for the C<$a> line -- C<"Reversed += operator">. |
93 | |
94 | The problem is that Perl has both compile-time and run-time warnings. To |
95 | disable compile-time warnings you need to rewrite the code like this: |
96 | |
97 | { |
98 | BEGIN { $^W = 0 } |
4358a253 |
99 | my $a =+ 2; |
100 | my $b; chop $b; |
0453d815 |
101 | } |
102 | |
f1f33818 |
103 | The other big problem with C<$^W> is the way you can inadvertently |
0453d815 |
104 | change the warning setting in unexpected places in your code. For example, |
105 | when the code below is run (without the B<-w> flag), the second call |
106 | to C<doit> will trip a C<"Use of uninitialized value"> warning, whereas |
107 | the first will not. |
108 | |
109 | sub doit |
110 | { |
4358a253 |
111 | my $b; chop $b; |
0453d815 |
112 | } |
113 | |
4358a253 |
114 | doit(); |
0453d815 |
115 | |
116 | { |
4358a253 |
117 | local ($^W) = 1; |
0453d815 |
118 | doit() |
119 | } |
120 | |
121 | This is a side-effect of C<$^W> being dynamically scoped. |
122 | |
123 | Lexical warnings get around these limitations by allowing finer control |
124 | over where warnings can or can't be tripped. |
125 | |
126 | =head2 Controlling Warnings from the Command Line |
127 | |
128 | There are three Command Line flags that can be used to control when |
129 | warnings are (or aren't) produced: |
130 | |
131 | =over 5 |
132 | |
133 | =item B<-w> |
d74e8afc |
134 | X<-w> |
0453d815 |
135 | |
136 | This is the existing flag. If the lexical warnings pragma is B<not> |
137 | used in any of you code, or any of the modules that you use, this flag |
138 | will enable warnings everywhere. See L<Backward Compatibility> for |
139 | details of how this flag interacts with lexical warnings. |
140 | |
141 | =item B<-W> |
d74e8afc |
142 | X<-W> |
c47ff5f1 |
143 | |
0453d815 |
144 | If the B<-W> flag is used on the command line, it will enable all warnings |
145 | throughout the program regardless of whether warnings were disabled |
4438c4b7 |
146 | locally using C<no warnings> or C<$^W =0>. This includes all files that get |
0453d815 |
147 | included via C<use>, C<require> or C<do>. |
148 | Think of it as the Perl equivalent of the "lint" command. |
149 | |
150 | =item B<-X> |
d74e8afc |
151 | X<-X> |
0453d815 |
152 | |
153 | Does the exact opposite to the B<-W> flag, i.e. it disables all warnings. |
154 | |
155 | =back |
156 | |
157 | =head2 Backward Compatibility |
158 | |
159 | If you are used with working with a version of Perl prior to the |
160 | introduction of lexically scoped warnings, or have code that uses both |
161 | lexical warnings and C<$^W>, this section will describe how they interact. |
162 | |
163 | How Lexical Warnings interact with B<-w>/C<$^W>: |
5a3e7812 |
164 | |
0453d815 |
165 | =over 5 |
166 | |
167 | =item 1. |
168 | |
169 | If none of the three command line flags (B<-w>, B<-W> or B<-X>) that |
e476b1b5 |
170 | control warnings is used and neither C<$^W> or the C<warnings> pragma |
171 | are used, then default warnings will be enabled and optional warnings |
172 | disabled. |
0453d815 |
173 | This means that legacy code that doesn't attempt to control the warnings |
174 | will work unchanged. |
175 | |
176 | =item 2. |
177 | |
178 | The B<-w> flag just sets the global C<$^W> variable as in 5.005 -- this |
179 | means that any legacy code that currently relies on manipulating C<$^W> |
180 | to control warning behavior will still work as is. |
181 | |
182 | =item 3. |
c47ff5f1 |
183 | |
0453d815 |
184 | Apart from now being a boolean, the C<$^W> variable operates in exactly |
185 | the same horrible uncontrolled global way, except that it cannot |
186 | disable/enable default warnings. |
187 | |
188 | =item 4. |
c47ff5f1 |
189 | |
e476b1b5 |
190 | If a piece of code is under the control of the C<warnings> pragma, |
0453d815 |
191 | both the C<$^W> variable and the B<-w> flag will be ignored for the |
192 | scope of the lexical warning. |
193 | |
194 | =item 5. |
c47ff5f1 |
195 | |
0453d815 |
196 | The only way to override a lexical warnings setting is with the B<-W> |
197 | or B<-X> command line flags. |
198 | |
199 | =back |
200 | |
106325ad |
201 | The combined effect of 3 & 4 is that it will allow code which uses |
e476b1b5 |
202 | the C<warnings> pragma to control the warning behavior of $^W-type |
0453d815 |
203 | code (using a C<local $^W=0>) if it really wants to, but not vice-versa. |
204 | |
0453d815 |
205 | =head2 Category Hierarchy |
d74e8afc |
206 | X<warning, categories> |
c47ff5f1 |
207 | |
e476b1b5 |
208 | A hierarchy of "categories" have been defined to allow groups of warnings |
209 | to be enabled/disabled in isolation. |
210 | |
211 | The current hierarchy is: |
212 | |
213 | all -+ |
214 | | |
e476b1b5 |
215 | +- closure |
216 | | |
12bcd1a6 |
217 | +- deprecated |
218 | | |
e476b1b5 |
219 | +- exiting |
220 | | |
221 | +- glob |
222 | | |
223 | +- io -----------+ |
224 | | | |
225 | | +- closed |
226 | | | |
227 | | +- exec |
228 | | | |
99ef548b |
229 | | +- layer |
230 | | | |
e476b1b5 |
231 | | +- newline |
232 | | | |
233 | | +- pipe |
234 | | | |
235 | | +- unopened |
236 | | |
237 | +- misc |
238 | | |
239 | +- numeric |
240 | | |
241 | +- once |
242 | | |
243 | +- overflow |
244 | | |
245 | +- pack |
246 | | |
247 | +- portable |
248 | | |
249 | +- recursion |
250 | | |
251 | +- redefine |
252 | | |
253 | +- regexp |
254 | | |
255 | +- severe -------+ |
256 | | | |
257 | | +- debugging |
258 | | | |
259 | | +- inplace |
260 | | | |
261 | | +- internal |
262 | | | |
263 | | +- malloc |
264 | | |
265 | +- signal |
266 | | |
267 | +- substr |
268 | | |
269 | +- syntax -------+ |
270 | | | |
271 | | +- ambiguous |
272 | | | |
273 | | +- bareword |
274 | | | |
e476b1b5 |
275 | | +- digit |
276 | | | |
277 | | +- parenthesis |
278 | | | |
279 | | +- precedence |
280 | | | |
281 | | +- printf |
282 | | | |
283 | | +- prototype |
284 | | | |
285 | | +- qw |
286 | | | |
287 | | +- reserved |
288 | | | |
289 | | +- semicolon |
290 | | |
291 | +- taint |
292 | | |
38875929 |
293 | +- threads |
294 | | |
e476b1b5 |
295 | +- uninitialized |
296 | | |
297 | +- unpack |
298 | | |
299 | +- untie |
300 | | |
301 | +- utf8 |
302 | | |
303 | +- void |
0453d815 |
304 | |
4438c4b7 |
305 | Just like the "strict" pragma any of these categories can be combined |
306 | |
4358a253 |
307 | use warnings qw(void redefine); |
308 | no warnings qw(io syntax untie); |
4438c4b7 |
309 | |
310 | Also like the "strict" pragma, if there is more than one instance of the |
e476b1b5 |
311 | C<warnings> pragma in a given scope the cumulative effect is additive. |
4438c4b7 |
312 | |
4358a253 |
313 | use warnings qw(void); # only "void" warnings enabled |
4438c4b7 |
314 | ... |
4358a253 |
315 | use warnings qw(io); # only "void" & "io" warnings enabled |
4438c4b7 |
316 | ... |
4358a253 |
317 | no warnings qw(void); # only "io" warnings enabled |
4438c4b7 |
318 | |
e476b1b5 |
319 | To determine which category a specific warning has been assigned to see |
320 | L<perldiag>. |
0453d815 |
321 | |
12bcd1a6 |
322 | Note: In Perl 5.6.1, the lexical warnings category "deprecated" was a |
323 | sub-category of the "syntax" category. It is now a top-level category |
324 | in its own right. |
325 | |
326 | |
0453d815 |
327 | =head2 Fatal Warnings |
d74e8afc |
328 | X<warning, fatal> |
c47ff5f1 |
329 | |
0453d815 |
330 | The presence of the word "FATAL" in the category list will escalate any |
e476b1b5 |
331 | warnings detected from the categories specified in the lexical scope |
f1f33818 |
332 | into fatal errors. In the code below, the use of C<time>, C<length> |
333 | and C<join> can all produce a C<"Useless use of xxx in void context"> |
334 | warning. |
4438c4b7 |
335 | |
4358a253 |
336 | use warnings; |
cea6626f |
337 | |
4358a253 |
338 | time; |
cea6626f |
339 | |
0453d815 |
340 | { |
4358a253 |
341 | use warnings FATAL => qw(void); |
342 | length "abc"; |
0453d815 |
343 | } |
cea6626f |
344 | |
4358a253 |
345 | join "", 1,2,3; |
cea6626f |
346 | |
4358a253 |
347 | print "done\n"; |
f1f33818 |
348 | |
349 | When run it produces this output |
350 | |
351 | Useless use of time in void context at fatal line 3. |
352 | Useless use of length in void context at fatal line 7. |
353 | |
354 | The scope where C<length> is used has escalated the C<void> warnings |
355 | category into a fatal error, so the program terminates immediately it |
356 | encounters the warning. |
c47ff5f1 |
357 | |
6e9af7e4 |
358 | To explicitly turn off a "FATAL" warning you just disable the warning |
359 | it is associated with. So, for example, to disable the "void" warning |
360 | in the example above, either of these will do the trick: |
08540116 |
361 | |
362 | no warnings qw(void); |
363 | no warnings FATAL => qw(void); |
0453d815 |
364 | |
6e9af7e4 |
365 | If you want to downgrade a warning that has been escalated into a fatal |
366 | error back to a normal warning, you can use the "NONFATAL" keyword. For |
367 | example, the code below will promote all warnings into fatal errors, |
368 | except for those in the "syntax" category. |
369 | |
370 | use warnings FATAL => 'all', NONFATAL => 'syntax'; |
371 | |
e476b1b5 |
372 | =head2 Reporting Warnings from a Module |
d74e8afc |
373 | X<warning, reporting> X<warning, registering> |
e476b1b5 |
374 | |
d3a7d8c7 |
375 | The C<warnings> pragma provides a number of functions that are useful for |
376 | module authors. These are used when you want to report a module-specific |
7e6d00f8 |
377 | warning to a calling module has enabled warnings via the C<warnings> |
d3a7d8c7 |
378 | pragma. |
e476b1b5 |
379 | |
d3a7d8c7 |
380 | Consider the module C<MyMod::Abc> below. |
e476b1b5 |
381 | |
d3a7d8c7 |
382 | package MyMod::Abc; |
e476b1b5 |
383 | |
d3a7d8c7 |
384 | use warnings::register; |
385 | |
386 | sub open { |
4358a253 |
387 | my $path = shift; |
7ddf7bb5 |
388 | if ($path !~ m#^/#) { |
2359510d |
389 | warnings::warn("changing relative path to /var/abc") |
7ddf7bb5 |
390 | if warnings::enabled(); |
2359510d |
391 | $path = "/var/abc/$path"; |
d3a7d8c7 |
392 | } |
393 | } |
394 | |
4358a253 |
395 | 1; |
d3a7d8c7 |
396 | |
397 | The call to C<warnings::register> will create a new warnings category |
7e6d00f8 |
398 | called "MyMod::abc", i.e. the new category name matches the current |
399 | package name. The C<open> function in the module will display a warning |
400 | message if it gets given a relative path as a parameter. This warnings |
401 | will only be displayed if the code that uses C<MyMod::Abc> has actually |
402 | enabled them with the C<warnings> pragma like below. |
d3a7d8c7 |
403 | |
404 | use MyMod::Abc; |
405 | use warnings 'MyMod::Abc'; |
406 | ... |
407 | abc::open("../fred.txt"); |
408 | |
409 | It is also possible to test whether the pre-defined warnings categories are |
410 | set in the calling module with the C<warnings::enabled> function. Consider |
411 | this snippet of code: |
412 | |
413 | package MyMod::Abc; |
414 | |
415 | sub open { |
7e6d00f8 |
416 | warnings::warnif("deprecated", |
4358a253 |
417 | "open is deprecated, use new instead"); |
418 | new(@_); |
e476b1b5 |
419 | } |
6bc102ca |
420 | |
e476b1b5 |
421 | sub new |
422 | ... |
4358a253 |
423 | 1; |
e476b1b5 |
424 | |
425 | The function C<open> has been deprecated, so code has been included to |
426 | display a warning message whenever the calling module has (at least) the |
427 | "deprecated" warnings category enabled. Something like this, say. |
428 | |
429 | use warnings 'deprecated'; |
d3a7d8c7 |
430 | use MyMod::Abc; |
e476b1b5 |
431 | ... |
4358a253 |
432 | MyMod::Abc::open($filename); |
e476b1b5 |
433 | |
7e6d00f8 |
434 | Either the C<warnings::warn> or C<warnings::warnif> function should be |
435 | used to actually display the warnings message. This is because they can |
436 | make use of the feature that allows warnings to be escalated into fatal |
437 | errors. So in this case |
e476b1b5 |
438 | |
d3a7d8c7 |
439 | use MyMod::Abc; |
440 | use warnings FATAL => 'MyMod::Abc'; |
e476b1b5 |
441 | ... |
d3a7d8c7 |
442 | MyMod::Abc::open('../fred.txt'); |
e476b1b5 |
443 | |
7e6d00f8 |
444 | the C<warnings::warnif> function will detect this and die after |
d3a7d8c7 |
445 | displaying the warning message. |
e476b1b5 |
446 | |
7e6d00f8 |
447 | The three warnings functions, C<warnings::warn>, C<warnings::warnif> |
448 | and C<warnings::enabled> can optionally take an object reference in place |
449 | of a category name. In this case the functions will use the class name |
450 | of the object as the warnings category. |
451 | |
452 | Consider this example: |
453 | |
4358a253 |
454 | package Original; |
7e6d00f8 |
455 | |
4358a253 |
456 | no warnings; |
457 | use warnings::register; |
7e6d00f8 |
458 | |
459 | sub new |
460 | { |
4358a253 |
461 | my $class = shift; |
462 | bless [], $class; |
7e6d00f8 |
463 | } |
464 | |
465 | sub check |
466 | { |
4358a253 |
467 | my $self = shift; |
468 | my $value = shift; |
7e6d00f8 |
469 | |
470 | if ($value % 2 && warnings::enabled($self)) |
471 | { warnings::warn($self, "Odd numbers are unsafe") } |
472 | } |
473 | |
474 | sub doit |
475 | { |
4358a253 |
476 | my $self = shift; |
477 | my $value = shift; |
478 | $self->check($value); |
7e6d00f8 |
479 | # ... |
480 | } |
481 | |
4358a253 |
482 | 1; |
7e6d00f8 |
483 | |
4358a253 |
484 | package Derived; |
7e6d00f8 |
485 | |
4358a253 |
486 | use warnings::register; |
487 | use Original; |
488 | our @ISA = qw( Original ); |
7e6d00f8 |
489 | sub new |
490 | { |
4358a253 |
491 | my $class = shift; |
492 | bless [], $class; |
7e6d00f8 |
493 | } |
494 | |
13a2d996 |
495 | |
4358a253 |
496 | 1; |
7e6d00f8 |
497 | |
498 | The code below makes use of both modules, but it only enables warnings from |
499 | C<Derived>. |
500 | |
4358a253 |
501 | use Original; |
502 | use Derived; |
7e6d00f8 |
503 | use warnings 'Derived'; |
63acfd00 |
504 | my $a = Original->new(); |
4358a253 |
505 | $a->doit(1); |
63acfd00 |
506 | my $b = Derived->new(); |
4358a253 |
507 | $a->doit(1); |
7e6d00f8 |
508 | |
509 | When this code is run only the C<Derived> object, C<$b>, will generate |
510 | a warning. |
511 | |
512 | Odd numbers are unsafe at main.pl line 7 |
513 | |
514 | Notice also that the warning is reported at the line where the object is first |
515 | used. |
516 | |
e476b1b5 |
517 | =head1 TODO |
c47ff5f1 |
518 | |
0453d815 |
519 | perl5db.pl |
520 | The debugger saves and restores C<$^W> at runtime. I haven't checked |
521 | whether the debugger will still work with the lexical warnings |
522 | patch applied. |
523 | |
524 | diagnostics.pm |
525 | I *think* I've got diagnostics to work with the lexical warnings |
526 | patch, but there were design decisions made in diagnostics to work |
527 | around the limitations of C<$^W>. Now that those limitations are gone, |
528 | the module should be revisited. |
529 | |
7e6d00f8 |
530 | document calling the warnings::* functions from XS |
531 | |
0453d815 |
532 | =head1 SEE ALSO |
533 | |
e476b1b5 |
534 | L<warnings>, L<perldiag>. |
c47ff5f1 |
535 | |
0453d815 |
536 | =head1 AUTHOR |
c47ff5f1 |
537 | |
0453d815 |
538 | Paul Marquess |