3 our $VERSION = '1.13'; ## no critic
11 perl -MO=Lint[,OPTIONS] foo.pl
15 The B::Lint module is equivalent to an extended version of the B<-w>
16 option of B<perl>. It is named after the program F<lint> which carries
17 out a similar process for C programs.
19 =head1 OPTIONS AND LINT CHECKS
21 Option words are separated by commas (not whitespace) and follow the
22 usual conventions of compiler backend options. Following any options
23 (indicated by a leading B<->) come lint check arguments. Each such
24 argument (apart from the special B<all> and B<none> options) is a
25 word representing one possible lint check (turning on that check) or
26 is B<no-foo> (turning off that check). Before processing the check
27 arguments, a standard list of checks is turned on. Later options
28 override earlier ones. Available options are:
32 =item B<magic-diamond>
34 Produces a warning whenever the magic C<E<lt>E<gt>> readline is
35 used. Internally it uses perl's two-argument open which itself treats
36 filenames with special characters specially. This could allow
37 interestingly named files to have unexpected effects when reading.
42 The above creates a file named C<rm *|>. When perl opens it with
43 C<E<lt>E<gt>> it actually executes the shell program C<rm *>. This
44 makes C<E<lt>E<gt>> dangerous to use carelessly.
48 Produces a warning whenever an array is used in an implicit scalar
49 context. For example, both of the lines
54 will elicit a warning. Using an explicit B<scalar()> silences the
59 =item B<implicit-read> and B<implicit-write>
61 These options produce a warning whenever an operation implicitly
62 reads or (respectively) writes to one of Perl's special variables.
63 For example, B<implicit-read> will warn about these:
67 and B<implicit-write> will warn about these:
71 Both B<implicit-read> and B<implicit-write> warn about this:
77 This option warns whenever a bareword is implicitly quoted, but is also
78 the name of a subroutine in the current package. Typical mistakes that it will
81 use constant foo => 'bar';
85 Neither of these will do what a naive user would expect.
87 =item B<dollar-underscore>
89 This option warns whenever C<$_> is used either explicitly anywhere or
90 as the implicit argument of a B<print> statement.
92 =item B<private-names>
94 This option warns on each use of any variable, subroutine or
95 method name that lives in a non-current package but begins with
96 an underscore ("_"). Warnings aren't issued for the special case
97 of the single character name "_" by itself (e.g. C<$_> and C<@_>).
99 =item B<undefined-subs>
101 This option warns whenever an undefined subroutine is invoked.
102 This option will only catch explicitly invoked subroutines such
103 as C<foo()> and not indirect invocations such as C<&$subref()>
104 or C<$obj-E<gt>meth()>. Note that some programs or modules delay
105 definition of subs until runtime by means of the AUTOLOAD
108 =item B<regexp-variables>
110 This option warns whenever one of the regexp variables C<$`>, C<$&> or C<$'>
111 is used. Any occurrence of any of these variables in your
112 program can slow your whole program down. See L<perlre> for
117 Turn all warnings on.
121 Turn all warnings off.
125 =head1 NON LINT-CHECK OPTIONS
131 Normally, Lint only checks the main code of the program together
132 with all subs defined in package main. The B<-u> option lets you
133 include other package names whose subs are then checked by Lint.
137 =head1 EXTENDING LINT
139 Lint can be extended by with plugins. Lint uses L<Module::Pluggable>
140 to find available plugins. Plugins are expected but not required to
141 inform Lint of which checks they are adding.
143 The C<< B::Lint->register_plugin( MyPlugin => \@new_checks ) >> method
144 adds the list of C<@new_checks> to the list of valid checks. If your
145 module wasn't loaded by L<Module::Pluggable> then your class name is
146 added to the list of plugins.
148 You must create a C<match( \%checks )> method in your plugin class or one
149 of its parents. It will be called on every op as a regular method call
150 with a hash ref of checks as its parameter.
152 The class methods C<< B::Lint->file >> and C<< B::Lint->line >> contain
153 the current filename and line number.
157 B::Lint->register_plugin( Sample => [ 'good_taste' ] );
160 my ( $op, $checks_href ) = shift @_;
161 if ( $checks_href->{good_taste} ) {
170 =item while(<FH>) stomps $_
174 =item unchecked system calls
176 =item more tests, validate against older perls
182 This is only a very preliminary version.
186 Malcolm Beattie, mbeattie@sable.ox.ac.uk.
188 =head1 ACKNOWLEDGEMENTS
190 Sebastien Aperghis-Tramoni - bug fixes
195 use B qw( walkoptree_slow
196 main_root main_cv walksymtable parents
198 OPf_WANT_VOID OPf_WANT_LIST OPf_WANT OPf_STACKED SVf_POK );
201 # The current M::P doesn't know about .pmc files.
202 use Module::Pluggable ( require => 1 );
204 use List::Util 'first';
205 ## no critic Prototypes
206 sub any (&@) { my $test = shift @_; $test->() and return 1 for @_; return 0 }
210 # Import or create some constants from B. B doesn't provide
211 # everything I need so some things like OPpCONST_BARE are defined
213 for my $sym ( qw( begin_av check_av init_av end_av ),
214 [ 'OPpCONST_BARE' => 64 ] )
217 ( $sym, $val ) = @$sym if ref $sym;
219 if ( any { $sym eq $_ } @B::EXPORT_OK, @B::EXPORT ) {
224 constant->import( $sym => $val );
229 my $file = "unknown"; # shadows current filename
230 my $line = 0; # shadows current line number
231 my $curstash = "main"; # shadows current stash
232 my $curcv; # shadows current B::CV for pad lookups
236 sub curstash {$curstash}
241 my %implies_ok_context;
243 map( $implies_ok_context{$_}++,
244 qw(scalar av2arylen aelem aslice helem hslice
245 keys values hslice defined undef delete) );
247 # Lint checks turned on by default
249 = qw(context magic_diamond undefined_subs regexp_variables);
255 qw(context implicit_read implicit_write dollar_underscore
256 private_names bare_subs undefined_subs regexp_variables
260 $valid_check{$check} = __PACKAGE__;
266 my %done_cv; # used to mark which subs have already been linted
267 my @extra_packages; # Lint checks mainline code and all subs which are
268 # in main:: or in one of these packages.
271 my $format = ( @_ < 2 ) ? "%s" : shift @_;
272 warn sprintf( "$format at %s line %d\n", @_, $file, $line );
273 return undef; ## no critic undef
276 # This gimme can't cope with context that's only determined
277 # at runtime via dowantarray().
280 my $flags = $op->flags;
281 if ( $flags & OPf_WANT ) {
282 return ( ( $flags & OPf_WANT ) == OPf_WANT_LIST ? 1 : 0 );
284 return undef; ## no critic undef
287 my @plugins = __PACKAGE__->plugins;
291 # A boolean function to be used while inside a B::walkoptree_slow
292 # call. If we are in the EXPR part of C<grep EXPR, ...> or C<grep
293 # { EXPR } ...>, this returns true.
294 return any { $_->name =~ m/\A(?:grep|map)/xms } @{ parents() };
297 sub inside_foreach_modifier {
301 # A boolean function to be used while inside a B::walkoptree_slow
302 # call. If we are in the EXPR part of C<EXPR foreach ...> this
304 for my $ancestor ( @{ parents() } ) {
305 next unless $ancestor->name eq 'leaveloop';
307 my $first = $ancestor->first;
308 next unless $first->name eq 'enteriter';
310 next if $first->redoop->name =~ m/\A(?:next|db|set)state\z/xms;
318 [qw[ B::PADOP::gv_harder gv padix]],
319 [qw[ B::SVOP::sv_harder sv targ]],
320 [qw[ B::SVOP::gv_harder gv padix]]
324 # I'm generating some functions here because they're mostly
325 # similar. It's all for compatibility with threaded
326 # perl. Perhaps... this code should inspect $Config{usethreads}
327 # and generate a *specific* function. I'm leaving it generic for
330 # In threaded perl SVs and GVs aren't used directly in the optrees
331 # like they are in non-threaded perls. The ops that would use a SV
332 # or GV keep an index into the subroutine's scratchpad. I'm
333 # currently ignoring $cv->DEPTH and that might be at my peril.
335 my ( $subname, $attr, $pad_attr ) = @$_;
336 my $target = do { ## no critic strict
344 if ( not $op->isa('B::PADOP') ) {
347 return $elt if eval { $elt->isa('B::SV') };
349 my $ix = $op->$pad_attr;
350 my @entire_pad = $curcv->PADLIST->ARRAY;
351 my @elts = map +( $_->ARRAY )[$ix], @entire_pad;
353 eval { $_->isa('B::SV') } ? $_ : ();
355 @elts[ 0, reverse 1 .. $#elts ];
363 # This is a fallback ->lint for all the ops where I haven't
364 # defined something more specific. Nothing happens here.
366 # Call all registered plugins
368 $m = $_->can('match'), $op->$m( \%check ) for @plugins;
375 # nextstate ops sit between statements. Whenever I see one I
376 # update the current info on file, line, and stash. This code also
377 # updates it when it sees a dbstate or setstate op. I have no idea
378 # what those are but having seen them mentioned together in other
379 # parts of the perl I think they're kind of equivalent.
380 if ( $op->name =~ m/\A(?:next|db|set)state\z/ ) {
383 $curstash = $op->stash->NAME;
386 # Call all registered plugins
388 $m = $_->can('match'), $op->$m( \%check ) for @plugins;
395 my $opname = $op->name;
399 # Check arrays and hashes in scalar or void context where
400 # scalar() hasn't been used.
403 unless $check{context}
404 and $opname =~ m/\Arv2[ah]v\z/xms
407 my ( $parent, $gparent ) = @{ parents() }[ 0, 1 ];
408 my $pname = $parent->name;
410 next if $implies_ok_context{$pname};
412 # Three special cases to deal with: "foreach (@foo)", "delete
413 # $a{$b}", and "exists $a{$b}" null out the parent so we have to
414 # check for a parent of pp_null and a grandparent of
415 # pp_enteriter, pp_delete, pp_exists
419 and $gparent->name =~ m/\A(?:delete|enteriter|exists)\z/xms;
421 # our( @bar ); would also trigger this error so I exclude
424 if $op->private & OPpOUR_INTRO
425 and ( $op->flags & OPf_WANT ) == OPf_WANT_VOID;
427 warning 'Implicit scalar context for %s in %s',
428 $opname eq "rv2av" ? "array" : "hash", $parent->desc;
433 # Looks for calls to methods with names that begin with _ and
434 # that aren't visible within the current package. Maybe this
435 # should look at @ISA.
437 unless $check{private_names}
438 and $opname =~ m/\Amethod/xms;
440 my $methop = $op->first;
441 next unless $methop->name eq "const";
443 my $method = $methop->sv_harder->PV;
445 unless $method =~ m/\A_/xms
446 and not defined &{"$curstash\::$method"};
448 warning q[Illegal reference to private method name '%s'], $method;
451 # Call all registered plugins
453 $m = $_->can('match'), $op->$m( \%check ) for @plugins;
462 # Look for /.../ that doesn't use =~ to bind to something.
464 unless $check{implicit_read}
465 and $op->name eq "match"
466 and not( $op->flags & OPf_STACKED
467 or inside_grepmap() );
468 warning 'Implicit match on $_';
473 # Look for s/.../.../ that doesn't use =~ to bind to
476 unless $check{implicit_write}
477 and $op->name eq "subst"
478 and not $op->flags & OPf_STACKED;
479 warning 'Implicit substitution on $_';
482 # Call all registered plugins
484 $m = $_->can('match'), $op->$m( \%check ) for @plugins;
493 # Look for C<for ( ... )>.
495 unless ( $check{implicit_read} or $check{implicit_write} )
496 and $op->name eq "enteriter";
498 my $last = $op->last;
500 unless $last->name eq "gv"
501 and $last->gv_harder->NAME eq "_"
502 and $op->redoop->name =~ m/\A(?:next|db|set)state\z/xms;
504 warning 'Implicit use of $_ in foreach';
507 # Call all registered plugins
509 $m = $_->can('match'), $op->$m( \%check ) for @plugins;
513 # In threaded vs non-threaded perls you'll find that threaded perls
514 # use PADOP in place of SVOPs so they can do lookups into the
515 # scratchpad to find things. I suppose this is so a optree can be
516 # shared between threads and all symbol table muckery will just get
517 # written to a scratchpad.
518 *B::PADOP::lint = *B::PADOP::lint = \&B::SVOP::lint;
525 unless $check{magic_diamond}
526 and parents()->[0]->name eq 'readline'
527 and $op->gv_harder->NAME eq 'ARGV';
534 unless $check{bare_subs}
535 and $op->name eq 'const'
536 and $op->private & OPpCONST_BARE;
538 my $sv = $op->sv_harder;
539 next unless $sv->FLAGS & SVf_POK;
542 my $subname = "$curstash\::$sub";
544 # I want to skip over things that were declared with the
545 # constant pragma. Well... sometimes. Hmm. I want to ignore
546 # C<<use constant FOO => ...>> but warn on C<<FOO => ...>>
547 # later. The former is typical declaration syntax and the
548 # latter would be an error.
550 # Skipping over both could be handled by looking if
551 # $constant::declared{$subname} is true.
553 # Check that it's a function.
555 unless exists &{"$curstash\::$sub"};
557 warning q[Bare sub name '%s' interpreted as string], $sub;
561 next unless $check{private_names};
563 my $opname = $op->name;
564 if ( $opname =~ m/\Agv(?:sv)?\z/xms ) {
566 # Looks for uses of variables and stuff that are named
567 # private and we're not in the same package.
568 my $gv = $op->gv_harder;
569 my $name = $gv->NAME;
571 unless $name =~ m/\A_./xms
572 and $gv->STASH->NAME ne $curstash;
574 warning q[Illegal reference to private name '%s'], $name;
576 elsif ( $opname eq "method_named" ) {
577 my $method = $op->sv_harder->PV;
578 next unless $method =~ m/\A_./xms;
580 warning q[Illegal reference to private method name '%s'], $method;
586 # Warn on uses of $_ with a few exceptions. I'm not warning on
587 # $_ inside grep, map, or statement modifier foreach because
588 # they localize $_ and it'd be impossible to use these
589 # features without getting warnings.
592 unless $check{dollar_underscore}
593 and $op->name eq "gvsv"
594 and $op->gv_harder->NAME eq "_"
595 and not( inside_grepmap
596 or inside_foreach_modifier );
603 # Look for any uses of $`, $&, or $'.
605 unless $check{regexp_variables}
606 and $op->name eq "gvsv";
608 my $name = $op->gv_harder->NAME;
609 next unless $name =~ m/\A[\&\'\`]\z/xms;
611 warning 'Use of regexp variable $%s', $name;
616 # Look for calls to functions that either don't exist or don't
619 unless $check{undefined_subs}
620 and $op->name eq "gv"
621 and $op->next->name eq "entersub";
623 my $gv = $op->gv_harder;
624 my $subname = $gv->STASH->NAME . "::" . $gv->NAME;
626 no strict 'refs'; ## no critic strict
627 if ( not exists &$subname ) {
628 $subname =~ s/\Amain:://;
629 warning q[Nonexistent subroutine '%s' called], $subname;
631 elsif ( not defined &$subname ) {
632 $subname =~ s/\A\&?main:://;
633 warning q[Undefined subroutine '%s' called], $subname;
637 # Call all registered plugins
639 $m = $_->can('match'), $op->$m( \%check ) for @plugins;
645 # Example: B::svref_2object( \ *A::Glob )->lintcv
649 return unless $cv->can('lintcv');
656 # Example: B::svref_2object( \ &foo )->lintcv
658 # Write to the *global* $
661 #warn sprintf("lintcv: %s::%s (done=%d)\n",
662 # $gv->STASH->NAME, $gv->NAME, $done_cv{$$curcv});#debug
663 return unless ref($curcv) and $$curcv and not $done_cv{$$curcv}++;
664 my $root = $curcv->ROOT;
666 #warn " root = $root (0x$$root)\n";#debug
667 walkoptree_slow( $root, "lint" ) if $$root;
674 # Copy to the global $curcv for use in pad lookups.
676 walkoptree_slow( main_root, "lint" ) if ${ main_root() };
678 # Do all the miscellaneous non-sub blocks.
679 for my $av ( begin_av, init_av, check_av, end_av ) {
680 next unless eval { $av->isa('B::AV') };
681 for my $cv ( $av->ARRAY ) {
682 next unless ref($cv) and $cv->FILE eq $0;
690 if ( $_[0]->FILE eq $0 ) { $_[0]->lintcv }
700 # Turn on default lint checks
701 for my $opt (@default_checks) {
706 while ( my $option = shift @options ) {
708 unless ( ( $opt, $arg ) = $option =~ m/\A-(.)(.*)/xms ) {
709 unshift @options, $option;
713 if ( $opt eq "-" && $arg eq "-" ) {
717 elsif ( $opt eq "D" ) {
718 $arg ||= shift @options;
719 foreach my $arg ( split //, $arg ) {
723 elsif ( $arg eq "O" ) {
728 elsif ( $opt eq "u" ) {
729 $arg ||= shift @options;
730 push @extra_packages, $arg;
734 foreach my $opt ( @default_checks, @options ) {
736 if ( $opt eq "all" ) {
737 %check = %valid_check;
739 elsif ( $opt eq "none" ) {
743 if ( $opt =~ s/\Ano_//xms ) {
749 carp "No such check: $opt"
750 unless defined $valid_check{$opt};
754 # Remaining arguments are things to check. So why aren't I
755 # capturing them or something? I don't know.
760 sub register_plugin {
761 my ( undef, $plugin, $new_checks ) = @_;
763 # Allow the user to be lazy and not give us a name.
764 $plugin = caller unless defined $plugin;
766 # Register the plugin's named checks, if any.
767 for my $check ( eval {@$new_checks} ) {
768 if ( not defined $check ) {
769 carp 'Undefined value in checks.';
772 if ( exists $valid_check{$check} ) {
774 "$check is already registered as a $valid_check{$check} feature.";
778 $valid_check{$check} = $plugin;
781 # Register a non-Module::Pluggable loaded module. @plugins already
782 # contains whatever M::P found on disk. The user might load a
783 # plugin manually from some arbitrary namespace and ask for it to
785 if ( not any { $_ eq $plugin } @plugins ) {
786 push @plugins, $plugin;