2 X<warning, lexical> X<warnings> X<warning>
4 perllexwarn - Perl Lexical Warnings
8 The C<use warnings> pragma enables to control precisely what warnings are
9 to be enabled in which parts of a Perl program. It's a more flexible
10 alternative for both the command line flag B<-w> and the equivalent Perl
13 This pragma works just like the C<strict> pragma.
14 This means that the scope of the warning pragma is limited to the
15 enclosing block. It also means that the pragma setting will not
16 leak across files (via C<use>, C<require> or C<do>). This allows
17 authors to independently define the degree of warning checks that will
18 be applied to their module.
20 By default, optional warnings are disabled, so any legacy code that
21 doesn't attempt to control the warnings will work unchanged.
23 All warnings are enabled in a block by either of these:
28 Similarly all warnings are disabled in a block by either of these:
33 For example, consider the code below:
43 The code in the enclosing block has warnings enabled, but the inner
44 block has them disabled. In this case that means the assignment to the
45 scalar C<$c> will trip the C<"Scalar value @a[0] better written as $a[0]">
46 warning, but the assignment to the scalar C<$b> will not.
48 =head2 Default Warnings and Optional Warnings
50 Before the introduction of lexical warnings, Perl had two classes of
51 warnings: mandatory and optional.
53 As its name suggests, if your code tripped a mandatory warning, you
54 would get a warning whether you wanted it or not.
55 For example, the code below would always produce an C<"isn't numeric">
56 warning about the "2:".
60 With the introduction of lexical warnings, mandatory warnings now become
61 I<default> warnings. The difference is that although the previously
62 mandatory warnings are still enabled by default, they can then be
63 subsequently enabled or disabled with the lexical warning pragma. For
64 example, in the code below, an C<"isn't numeric"> warning will only
65 be reported for the C<$a> variable.
71 Note that neither the B<-w> flag or the C<$^W> can be used to
72 disable/enable default warnings. They are still mandatory in this case.
74 =head2 What's wrong with B<-w> and C<$^W>
76 Although very useful, the big problem with using B<-w> on the command
77 line to enable warnings is that it is all or nothing. Take the typical
78 scenario when you are writing a Perl program. Parts of the code you
79 will write yourself, but it's very likely that you will make use of
80 pre-written Perl modules. If you use the B<-w> flag in this case, you
81 end up enabling warnings in pieces of code that you haven't written.
83 Similarly, using C<$^W> to either disable or enable blocks of code is
84 fundamentally flawed. For a start, say you want to disable warnings in
85 a block of code. You might expect this to be enough to do the trick:
93 When this code is run with the B<-w> flag, a warning will be produced
94 for the C<$a> line: C<"Reversed += operator">.
96 The problem is that Perl has both compile-time and run-time warnings. To
97 disable compile-time warnings you need to rewrite the code like this:
105 The other big problem with C<$^W> is the way you can inadvertently
106 change the warning setting in unexpected places in your code. For example,
107 when the code below is run (without the B<-w> flag), the second call
108 to C<doit> will trip a C<"Use of uninitialized value"> warning, whereas
123 This is a side-effect of C<$^W> being dynamically scoped.
125 Lexical warnings get around these limitations by allowing finer control
126 over where warnings can or can't be tripped.
128 =head2 Controlling Warnings from the Command Line
130 There are three Command Line flags that can be used to control when
131 warnings are (or aren't) produced:
138 This is the existing flag. If the lexical warnings pragma is B<not>
139 used in any of you code, or any of the modules that you use, this flag
140 will enable warnings everywhere. See L<Backward Compatibility> for
141 details of how this flag interacts with lexical warnings.
146 If the B<-W> flag is used on the command line, it will enable all warnings
147 throughout the program regardless of whether warnings were disabled
148 locally using C<no warnings> or C<$^W =0>. This includes all files that get
149 included via C<use>, C<require> or C<do>.
150 Think of it as the Perl equivalent of the "lint" command.
155 Does the exact opposite to the B<-W> flag, i.e. it disables all warnings.
159 =head2 Backward Compatibility
161 If you are used to working with a version of Perl prior to the
162 introduction of lexically scoped warnings, or have code that uses both
163 lexical warnings and C<$^W>, this section will describe how they interact.
165 How Lexical Warnings interact with B<-w>/C<$^W>:
171 If none of the three command line flags (B<-w>, B<-W> or B<-X>) that
172 control warnings is used and neither C<$^W> nor the C<warnings> pragma
173 are used, then default warnings will be enabled and optional warnings
175 This means that legacy code that doesn't attempt to control the warnings
180 The B<-w> flag just sets the global C<$^W> variable as in 5.005. This
181 means that any legacy code that currently relies on manipulating C<$^W>
182 to control warning behavior will still work as is.
186 Apart from now being a boolean, the C<$^W> variable operates in exactly
187 the same horrible uncontrolled global way, except that it cannot
188 disable/enable default warnings.
192 If a piece of code is under the control of the C<warnings> pragma,
193 both the C<$^W> variable and the B<-w> flag will be ignored for the
194 scope of the lexical warning.
198 The only way to override a lexical warnings setting is with the B<-W>
199 or B<-X> command line flags.
203 The combined effect of 3 & 4 is that it will allow code which uses
204 the C<warnings> pragma to control the warning behavior of $^W-type
205 code (using a C<local $^W=0>) if it really wants to, but not vice-versa.
207 =head2 Category Hierarchy
208 X<warning, categories>
210 A hierarchy of "categories" have been defined to allow groups of warnings
211 to be enabled/disabled in isolation.
213 The current hierarchy is:
216 This tree is generated by regen/warnings.pl. Any changes made here
219 =for warnings.pl begin
231 | +- experimental::lexical_subs
233 | +- experimental::lexical_topic
235 | +- experimental::regex_sets
237 | +- experimental::smartmatch
335 Just like the "strict" pragma any of these categories can be combined
337 use warnings qw(void redefine);
338 no warnings qw(io syntax untie);
340 Also like the "strict" pragma, if there is more than one instance of the
341 C<warnings> pragma in a given scope the cumulative effect is additive.
343 use warnings qw(void); # only "void" warnings enabled
345 use warnings qw(io); # only "void" & "io" warnings enabled
347 no warnings qw(void); # only "io" warnings enabled
349 To determine which category a specific warning has been assigned to see
352 Note: In Perl 5.6.1, the lexical warnings category "deprecated" was a
353 sub-category of the "syntax" category. It is now a top-level category
356 =head2 Fatal Warnings
359 The presence of the word "FATAL" in the category list will escalate any
360 warnings detected from the categories specified in the lexical scope
361 into fatal errors. In the code below, the use of C<time>, C<length>
362 and C<join> can all produce a C<"Useless use of xxx in void context">
370 use warnings FATAL => qw(void);
378 When run it produces this output
380 Useless use of time in void context at fatal line 3.
381 Useless use of length in void context at fatal line 7.
383 The scope where C<length> is used has escalated the C<void> warnings
384 category into a fatal error, so the program terminates immediately it
385 encounters the warning.
387 To explicitly turn off a "FATAL" warning you just disable the warning
388 it is associated with. So, for example, to disable the "void" warning
389 in the example above, either of these will do the trick:
391 no warnings qw(void);
392 no warnings FATAL => qw(void);
394 If you want to downgrade a warning that has been escalated into a fatal
395 error back to a normal warning, you can use the "NONFATAL" keyword. For
396 example, the code below will promote all warnings into fatal errors,
397 except for those in the "syntax" category.
399 use warnings FATAL => 'all', NONFATAL => 'syntax';
401 =head2 Reporting Warnings from a Module
402 X<warning, reporting> X<warning, registering>
404 The C<warnings> pragma provides a number of functions that are useful for
405 module authors. These are used when you want to report a module-specific
406 warning to a calling module has enabled warnings via the C<warnings>
409 Consider the module C<MyMod::Abc> below.
413 use warnings::register;
417 if ($path !~ m#^/#) {
418 warnings::warn("changing relative path to /var/abc")
419 if warnings::enabled();
420 $path = "/var/abc/$path";
426 The call to C<warnings::register> will create a new warnings category
427 called "MyMod::Abc", i.e. the new category name matches the current
428 package name. The C<open> function in the module will display a warning
429 message if it gets given a relative path as a parameter. This warnings
430 will only be displayed if the code that uses C<MyMod::Abc> has actually
431 enabled them with the C<warnings> pragma like below.
434 use warnings 'MyMod::Abc';
436 abc::open("../fred.txt");
438 It is also possible to test whether the pre-defined warnings categories are
439 set in the calling module with the C<warnings::enabled> function. Consider
440 this snippet of code:
445 warnings::warnif("deprecated",
446 "open is deprecated, use new instead");
454 The function C<open> has been deprecated, so code has been included to
455 display a warning message whenever the calling module has (at least) the
456 "deprecated" warnings category enabled. Something like this, say.
458 use warnings 'deprecated';
461 MyMod::Abc::open($filename);
463 Either the C<warnings::warn> or C<warnings::warnif> function should be
464 used to actually display the warnings message. This is because they can
465 make use of the feature that allows warnings to be escalated into fatal
466 errors. So in this case
469 use warnings FATAL => 'MyMod::Abc';
471 MyMod::Abc::open('../fred.txt');
473 the C<warnings::warnif> function will detect this and die after
474 displaying the warning message.
476 The three warnings functions, C<warnings::warn>, C<warnings::warnif>
477 and C<warnings::enabled> can optionally take an object reference in place
478 of a category name. In this case the functions will use the class name
479 of the object as the warnings category.
481 Consider this example:
486 use warnings::register;
499 if ($value % 2 && warnings::enabled($self))
500 { warnings::warn($self, "Odd numbers are unsafe") }
507 $self->check($value);
515 use warnings::register;
517 our @ISA = qw( Original );
527 The code below makes use of both modules, but it only enables warnings from
532 use warnings 'Derived';
533 my $a = Original->new();
535 my $b = Derived->new();
538 When this code is run only the C<Derived> object, C<$b>, will generate
541 Odd numbers are unsafe at main.pl line 7
543 Notice also that the warning is reported at the line where the object is first
546 When registering new categories of warning, you can supply more names to
547 warnings::register like this:
550 use warnings::register qw(format precision);
554 warnings::warnif('MyModule::format', '...');
558 L<warnings>, L<perldiag>.