/usr/share/perl5/B/Lint.pm is in libb-lint-perl 1.20-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 | package B::Lint;
use if $] > 5.017, 'deprecate';
our $VERSION = '1.20'; ## no critic
=head1 NAME
B::Lint - Perl lint
=head1 SYNOPSIS
perl -MO=Lint[,OPTIONS] foo.pl
=head1 DESCRIPTION
The B::Lint module is equivalent to an extended version of the B<-w>
option of B<perl>. It is named after the program F<lint> which carries
out a similar process for C programs.
=head1 OPTIONS AND LINT CHECKS
Option words are separated by commas (not whitespace) and follow the
usual conventions of compiler backend options. Following any options
(indicated by a leading B<->) come lint check arguments. Each such
argument (apart from the special B<all> and B<none> options) is a
word representing one possible lint check (turning on that check) or
is B<no-foo> (turning off that check). Before processing the check
arguments, a standard list of checks is turned on. Later options
override earlier ones. Available options are:
=over 8
=item B<magic-diamond>
Produces a warning whenever the magic C<E<lt>E<gt>> readline is
used. Internally it uses perl's two-argument open which itself treats
filenames with special characters specially. This could allow
interestingly named files to have unexpected effects when reading.
% touch 'rm *|'
% perl -pe 1
The above creates a file named C<rm *|>. When perl opens it with
C<E<lt>E<gt>> it actually executes the shell program C<rm *>. This
makes C<E<lt>E<gt>> dangerous to use carelessly.
=item B<context>
Produces a warning whenever an array is used in an implicit scalar
context. For example, both of the lines
$foo = length(@bar);
$foo = @bar;
will elicit a warning. Using an explicit B<scalar()> silences the
warning. For example,
$foo = scalar(@bar);
=item B<implicit-read> and B<implicit-write>
These options produce a warning whenever an operation implicitly
reads or (respectively) writes to one of Perl's special variables.
For example, B<implicit-read> will warn about these:
/foo/;
and B<implicit-write> will warn about these:
s/foo/bar/;
Both B<implicit-read> and B<implicit-write> warn about this:
for (@a) { ... }
=item B<bare-subs>
This option warns whenever a bareword is implicitly quoted, but is also
the name of a subroutine in the current package. Typical mistakes that it will
trap are:
use constant foo => 'bar';
@a = ( foo => 1 );
$b{foo} = 2;
Neither of these will do what a naive user would expect.
Notice: Perl 5.22.0 does not report C<foo> in C<$b{foo}> as BARE token
anymore. Therefore L<B::Lint> test is not reliable here. See
L<CPAN RT#101115|https://rt.cpan.org/Public/Bug/Display.html?id=101115>.
=item B<dollar-underscore>
This option warns whenever C<$_> is used either explicitly anywhere or
as the implicit argument of a B<print> statement.
=item B<private-names>
This option warns on each use of any variable, subroutine or
method name that lives in a non-current package but begins with
an underscore ("_"). Warnings aren't issued for the special case
of the single character name "_" by itself (e.g. C<$_> and C<@_>).
=item B<undefined-subs>
This option warns whenever an undefined subroutine is invoked.
This option will only catch explicitly invoked subroutines such
as C<foo()> and not indirect invocations such as C<&$subref()>
or C<$obj-E<gt>meth()>. Note that some programs or modules delay
definition of subs until runtime by means of the AUTOLOAD
mechanism.
=item B<regexp-variables>
This option warns whenever one of the regexp variables C<$`>, C<$&> or C<$'>
is used. Any occurrence of any of these variables in your
program can slow your whole program down. See L<perlre> for
details.
=item B<all>
Turn all warnings on.
=item B<none>
Turn all warnings off.
=back
=head1 NON LINT-CHECK OPTIONS
=over 8
=item B<-u Package>
Normally, Lint only checks the main code of the program together
with all subs defined in package main. The B<-u> option lets you
include other package names whose subs are then checked by Lint.
=back
=head1 EXTENDING LINT
Lint can be extended by with plugins. Lint uses L<Module::Pluggable>
to find available plugins. Plugins are expected but not required to
inform Lint of which checks they are adding.
The C<< B::Lint->register_plugin( MyPlugin => \@new_checks ) >> method
adds the list of C<@new_checks> to the list of valid checks. If your
module wasn't loaded by L<Module::Pluggable> then your class name is
added to the list of plugins.
You must create a C<match( \%checks )> method in your plugin class or one
of its parents. It will be called on every op as a regular method call
with a hash ref of checks as its parameter.
The class methods C<< B::Lint->file >> and C<< B::Lint->line >> contain
the current filename and line number.
package Sample;
use B::Lint;
B::Lint->register_plugin( Sample => [ 'good_taste' ] );
sub match {
my ( $op, $checks_href ) = shift @_;
if ( $checks_href->{good_taste} ) {
...
}
}
=head1 TODO
=over
=item while(<FH>) stomps $_
=item strict oo
=item unchecked system calls
=item more tests, validate against older perls
=back
=head1 BUGS
This is only a very preliminary version.
=head1 AUTHOR
Malcolm Beattie, mbeattie@sable.ox.ac.uk.
=head1 ACKNOWLEDGEMENTS
Sebastien Aperghis-Tramoni - bug fixes
=cut
use strict;
use B qw( walkoptree_slow
main_root main_cv walksymtable parents
OPpOUR_INTRO
OPf_WANT_VOID OPf_WANT_LIST OPf_WANT OPf_STACKED SVf_POK SVf_ROK );
use Carp 'carp';
# The current M::P doesn't know about .pmc files.
use Module::Pluggable ( require => 1 );
use List::Util 'first';
## no critic Prototypes
sub any (&@) { my $test = shift @_; $test->() and return 1 for @_; return 0 }
BEGIN {
# Import or create some constants from B. B doesn't provide
# everything I need so some things like OPpCONST_BARE are defined
# here.
for my $sym ( qw( begin_av check_av init_av end_av ),
[ 'OPpCONST_BARE' => 64 ] )
{
my $val;
( $sym, $val ) = @$sym if ref $sym;
if ( any { $sym eq $_ } @B::EXPORT_OK, @B::EXPORT ) {
B->import($sym);
}
else {
require constant;
constant->import( $sym => $val );
}
}
}
my $file = "unknown"; # shadows current filename
my $line = 0; # shadows current line number
my $curstash = "main"; # shadows current stash
my $curcv; # shadows current B::CV for pad lookups
sub file {$file}
sub line {$line}
sub curstash {$curstash}
sub curcv {$curcv}
# Lint checks
my %check;
my %implies_ok_context;
map( $implies_ok_context{$_}++,
qw(scalar av2arylen aelem aslice helem hslice
keys values hslice defined undef delete) );
# Lint checks turned on by default
my @default_checks
= qw(context magic_diamond undefined_subs regexp_variables);
my %valid_check;
# All valid checks
for my $check (
qw(context implicit_read implicit_write dollar_underscore
private_names bare_subs undefined_subs regexp_variables
magic_diamond )
)
{
$valid_check{$check} = __PACKAGE__;
}
# Debugging options
my ($debug_op);
my %done_cv; # used to mark which subs have already been linted
my @extra_packages; # Lint checks mainline code and all subs which are
# in main:: or in one of these packages.
sub warning {
my $format = ( @_ < 2 ) ? "%s" : shift @_;
warn sprintf( "$format at %s line %d\n", @_, $file, $line );
return undef; ## no critic undef
}
# This gimme can't cope with context that's only determined
# at runtime via dowantarray().
sub gimme {
my $op = shift @_;
my $flags = $op->flags;
if ( $flags & OPf_WANT ) {
return ( ( $flags & OPf_WANT ) == OPf_WANT_LIST ? 1 : 0 );
}
return undef; ## no critic undef
}
my @plugins = __PACKAGE__->plugins;
sub inside_grepmap {
# A boolean function to be used while inside a B::walkoptree_slow
# call. If we are in the EXPR part of C<grep EXPR, ...> or C<grep
# { EXPR } ...>, this returns true.
return any { $_->name =~ m/\A(?:grep|map)/xms } @{ parents() };
}
sub inside_foreach_modifier {
# TODO: use any()
# A boolean function to be used while inside a B::walkoptree_slow
# call. If we are in the EXPR part of C<EXPR foreach ...> this
# returns true.
for my $ancestor ( @{ parents() } ) {
next unless $ancestor->name eq 'leaveloop';
my $first = $ancestor->first;
next unless $first->name eq 'enteriter';
next if $first->redoop->name =~ m/\A(?:next|db|set)state\z/xms;
return 1;
}
return 0;
}
for (
[qw[ B::PADOP::gv_harder gv padix]],
[qw[ B::SVOP::sv_harder sv targ]],
[qw[ B::METHOP::sv_harder meth_sv targ]],
[qw[ B::SVOP::gv_harder gv padix]]
)
{
# I'm generating some functions here because they're mostly
# similar. It's all for compatibility with threaded
# perl. Perhaps... this code should inspect $Config{usethreads}
# and generate a *specific* function. I'm leaving it generic for
# the moment.
#
# In threaded perl SVs and GVs aren't used directly in the optrees
# like they are in non-threaded perls. The ops that would use a SV
# or GV keep an index into the subroutine's scratchpad. I'm
# currently ignoring $cv->DEPTH and that might be at my peril.
my ( $subname, $attr, $pad_attr ) = @$_;
my $target = do { ## no critic strict
no strict 'refs';
\*$subname;
};
*$target = sub {
my ($op) = @_;
my $elt;
if ( not $op->isa('B::PADOP') ) {
$elt = $op->$attr;
}
return $elt if eval { $elt->isa('B::SV') };
my $ix = $op->$pad_attr;
my @entire_pad = $curcv->PADLIST->ARRAY;
my @elts = map +( $_->ARRAY )[$ix], @entire_pad;
($elt) = first {
eval { $_->isa('B::SV') } ? $_ : ();
}
@elts[ 0, reverse 1 .. $#elts ];
return $elt;
};
}
sub B::OP::lint {
my ($op) = @_;
# This is a fallback ->lint for all the ops where I haven't
# defined something more specific. Nothing happens here.
# Call all registered plugins
my $m;
$m = $_->can('match'), $op->$m( \%check ) for @plugins;
return;
}
sub B::COP::lint {
my ($op) = @_;
# nextstate ops sit between statements. Whenever I see one I
# update the current info on file, line, and stash. This code also
# updates it when it sees a dbstate or setstate op. I have no idea
# what those are but having seen them mentioned together in other
# parts of the perl I think they're kind of equivalent.
if ( $op->name =~ m/\A(?:next|db|set)state\z/ ) {
$file = $op->file;
$line = $op->line;
$curstash = $op->stash->NAME;
}
# Call all registered plugins
my $m;
$m = $_->can('match'), $op->$m( \%check ) for @plugins;
return;
}
sub B::UNOP::lint {
my ($op) = @_;
my $opname = $op->name;
CONTEXT: {
# Check arrays and hashes in scalar or void context where
# scalar() hasn't been used.
next
unless $check{context}
and $opname =~ m/\Arv2[ah]v\z/xms
and not gimme($op);
my ( $parent, $gparent ) = @{ parents() }[ 0, 1 ];
my $pname = $parent->name;
next if $implies_ok_context{$pname};
# Three special cases to deal with: "foreach (@foo)", "delete
# $a{$b}", and "exists $a{$b}" null out the parent so we have to
# check for a parent of pp_null and a grandparent of
# pp_enteriter, pp_delete, pp_exists
next
if $pname eq "null"
and $gparent->name =~ m/\A(?:delete|enteriter|exists)\z/xms;
# our( @bar ); would also trigger this error so I exclude
# that.
next
if $op->private & OPpOUR_INTRO
and ( $op->flags & OPf_WANT ) == OPf_WANT_VOID;
warning 'Implicit scalar context for %s in %s',
$opname eq "rv2av" ? "array" : "hash", $parent->desc;
}
PRIVATE_NAMES: {
# Looks for calls to methods with names that begin with _ and
# that aren't visible within the current package. Maybe this
# should look at @ISA.
next
unless $check{private_names}
and $opname =~ m/\Amethod/xms;
my $methop = $op->first;
next unless $methop->name eq "const";
my $method = $methop->sv_harder->PV;
next
unless $method =~ m/\A_/xms
and not defined &{"$curstash\::$method"};
warning q[Illegal reference to private method name '%s'], $method;
}
# Call all registered plugins
my $m;
$m = $_->can('match'), $op->$m( \%check ) for @plugins;
return;
}
sub B::PMOP::lint {
my ($op) = @_;
IMPLICIT_READ: {
# Look for /.../ that doesn't use =~ to bind to something.
next
unless $check{implicit_read}
and $op->name eq "match"
and not( $op->flags & OPf_STACKED
or inside_grepmap() );
warning 'Implicit match on $_';
}
IMPLICIT_WRITE: {
# Look for s/.../.../ that doesn't use =~ to bind to
# something.
next
unless $check{implicit_write}
and $op->name eq "subst"
and not $op->flags & OPf_STACKED;
warning 'Implicit substitution on $_';
}
# Call all registered plugins
my $m;
$m = $_->can('match'), $op->$m( \%check ) for @plugins;
return;
}
sub B::LOOP::lint {
my ($op) = @_;
IMPLICIT_FOO: {
# Look for C<for ( ... )>.
next
unless ( $check{implicit_read} or $check{implicit_write} )
and $op->name eq "enteriter";
my $last = $op->last;
next
unless $last->name eq "gv"
and $last->gv_harder->NAME eq "_"
and $op->redoop->name =~ m/\A(?:next|db|set)state\z/xms;
warning 'Implicit use of $_ in foreach';
}
# Call all registered plugins
my $m;
$m = $_->can('match'), $op->$m( \%check ) for @plugins;
return;
}
# In threaded vs non-threaded perls you'll find that threaded perls
# use PADOP in place of SVOPs so they can do lookups into the
# scratchpad to find things. I suppose this is so a optree can be
# shared between threads and all symbol table muckery will just get
# written to a scratchpad.
*B::METHOP::lint = *B::PADOP::lint = *B::PADOP::lint = \&B::SVOP::lint;
sub B::SVOP::lint {
my ($op) = @_;
MAGIC_DIAMOND: {
next
unless $check{magic_diamond}
and parents()->[0]->name eq 'readline'
and $op->gv_harder->NAME eq 'ARGV';
warning 'Use of <>';
}
BARE_SUBS: {
next
unless $check{bare_subs}
and $op->name eq 'const'
and $op->private & OPpCONST_BARE;
my $sv = $op->sv_harder;
next unless $sv->FLAGS & SVf_POK;
my $sub = $sv->PV;
my $subname = "$curstash\::$sub";
# I want to skip over things that were declared with the
# constant pragma. Well... sometimes. Hmm. I want to ignore
# C<<use constant FOO => ...>> but warn on C<<FOO => ...>>
# later. The former is typical declaration syntax and the
# latter would be an error.
#
# Skipping over both could be handled by looking if
# $constant::declared{$subname} is true.
# Check that it's a function.
next
unless exists &{"$curstash\::$sub"};
warning q[Bare sub name '%s' interpreted as string], $sub;
}
PRIVATE_NAMES: {
next unless $check{private_names};
my $opname = $op->name;
if ( $opname =~ m/\Agv(?:sv)?\z/xms ) {
# Looks for uses of variables and stuff that are named
# private and we're not in the same package.
my $gv = $op->gv_harder;
my $name = $gv->NAME;
next
unless $name =~ m/\A_./xms
and $gv->STASH->NAME ne $curstash;
warning q[Illegal reference to private name '%s'], $name;
}
elsif ( $opname eq "method_named" ) {
my $method = $op->sv_harder->PV;
next unless $method =~ m/\A_./xms;
warning q[Illegal reference to private method name '%s'], $method;
}
}
DOLLAR_UNDERSCORE: {
# Warn on uses of $_ with a few exceptions. I'm not warning on
# $_ inside grep, map, or statement modifier foreach because
# they localize $_ and it'd be impossible to use these
# features without getting warnings.
next
unless $check{dollar_underscore}
and $op->name eq "gvsv"
and $op->gv_harder->NAME eq "_"
and not( inside_grepmap
or inside_foreach_modifier );
warning 'Use of $_';
}
REGEXP_VARIABLES: {
# Look for any uses of $`, $&, or $'.
next
unless $check{regexp_variables}
and $op->name eq "gvsv";
my $name = $op->gv_harder->NAME;
next unless $name =~ m/\A[\&\'\`]\z/xms;
warning 'Use of regexp variable $%s', $name;
}
UNDEFINED_SUBS: {
# Look for calls to functions that either don't exist or don't
# have a definition.
next
unless $check{undefined_subs}
and $op->name eq "gv"
and $op->next->name eq "entersub";
my $gv = $op->gv_harder;
my $cv = $gv->FLAGS & SVf_ROK ? $gv->RV : undef;
my $subname = ($cv || $gv)->STASH->NAME . "::"
. ($cv ? $cv->NAME_HEK || $cv->GV->NAME : $gv->NAME);
no strict 'refs'; ## no critic strict
if ( not exists &$subname ) {
$subname =~ s/\Amain:://;
warning q[Nonexistent subroutine '%s' called], $subname;
}
elsif ( not defined &$subname ) {
$subname =~ s/\A\&?main:://;
warning q[Undefined subroutine '%s' called], $subname;
}
}
# Call all registered plugins
my $m;
$m = $_->can('match'), $op->$m( \%check ) for @plugins;
return;
}
sub B::GV::lintcv {
# Example: B::svref_2object( \ *A::Glob )->lintcv
my $gv = shift @_;
my $cv = $gv->CV;
return unless $cv->can('lintcv');
$cv->lintcv;
return;
}
sub B::CV::lintcv {
# Example: B::svref_2object( \ &foo )->lintcv
# Write to the *global* $
$curcv = shift @_;
#warn sprintf("lintcv: %s::%s (done=%d)\n",
# $gv->STASH->NAME, $gv->NAME, $done_cv{$$curcv});#debug
return unless ref($curcv) and $$curcv and not $done_cv{$$curcv}++;
my $root = $curcv->ROOT;
#warn " root = $root (0x$$root)\n";#debug
walkoptree_slow( $root, "lint" ) if $$root;
return;
}
sub do_lint {
my %search_pack;
# Copy to the global $curcv for use in pad lookups.
$curcv = main_cv;
walkoptree_slow( main_root, "lint" ) if ${ main_root() };
# Do all the miscellaneous non-sub blocks.
for my $av ( begin_av, init_av, check_av, end_av ) {
next unless eval { $av->isa('B::AV') };
for my $cv ( $av->ARRAY ) {
next unless ref($cv) and $cv->FILE eq $0;
$cv->lintcv;
}
}
walksymtable(
\%main::,
sub {
if ( $_[0]->FILE eq $0 ) { $_[0]->lintcv }
},
sub {1}
);
return;
}
sub compile {
my @options = @_;
# Turn on default lint checks
for my $opt (@default_checks) {
$check{$opt} = 1;
}
OPTION:
while ( my $option = shift @options ) {
my ( $opt, $arg );
unless ( ( $opt, $arg ) = $option =~ m/\A-(.)(.*)/xms ) {
unshift @options, $option;
last OPTION;
}
if ( $opt eq "-" && $arg eq "-" ) {
shift @options;
last OPTION;
}
elsif ( $opt eq "D" ) {
$arg ||= shift @options;
foreach my $arg ( split //, $arg ) {
if ( $arg eq "o" ) {
B->debug(1);
}
elsif ( $arg eq "O" ) {
$debug_op = 1;
}
}
}
elsif ( $opt eq "u" ) {
$arg ||= shift @options;
push @extra_packages, $arg;
}
}
foreach my $opt ( @default_checks, @options ) {
$opt =~ tr/-/_/;
if ( $opt eq "all" ) {
%check = %valid_check;
}
elsif ( $opt eq "none" ) {
%check = ();
}
else {
if ( $opt =~ s/\Ano_//xms ) {
$check{$opt} = 0;
}
else {
$check{$opt} = 1;
}
carp "No such check: $opt"
unless defined $valid_check{$opt};
}
}
# Remaining arguments are things to check. So why aren't I
# capturing them or something? I don't know.
return \&do_lint;
}
sub register_plugin {
my ( undef, $plugin, $new_checks ) = @_;
# Allow the user to be lazy and not give us a name.
$plugin = caller unless defined $plugin;
# Register the plugin's named checks, if any.
for my $check ( eval {@$new_checks} ) {
if ( not defined $check ) {
carp 'Undefined value in checks.';
next;
}
if ( exists $valid_check{$check} ) {
carp
"$check is already registered as a $valid_check{$check} feature.";
next;
}
$valid_check{$check} = $plugin;
}
# Register a non-Module::Pluggable loaded module. @plugins already
# contains whatever M::P found on disk. The user might load a
# plugin manually from some arbitrary namespace and ask for it to
# be registered.
if ( not any { $_ eq $plugin } @plugins ) {
push @plugins, $plugin;
}
return;
}
1;
|