This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Re: Pluggable lint patch
authorJoshua ben Jore <jjore@cpan.org>
Mon, 19 Dec 2005 09:22:04 +0000 (03:22 -0600)
committerRafael Garcia-Suarez <rgarciasuarez@gmail.com>
Tue, 20 Dec 2005 14:48:34 +0000 (14:48 +0000)
Message-ID: <dc5c751d0512190722s1e73ef88l5ae82bd7aa075c51@mail.gmail.com>

p4raw-id: //depot/perl@26420

ext/B/B/Lint.pm
ext/B/t/lint.t

index 3475bd2..253044d 100644 (file)
@@ -1,6 +1,6 @@
 package B::Lint;
 
-our $VERSION = '1.03';
+our $VERSION = '1.04';
 
 =head1 NAME
 
@@ -120,6 +120,35 @@ include other package names whose subs are then checked by Lint.
 
 =back
 
+=head1 EXTENDING LINT
+
+Lint can be extended by registering plugins.
+
+The C<B::Lint->register_plugin( MyPlugin => \ @new_checks ) method
+adds the class C<MyPlugin> to the list of plugins. It also adds the
+list of C<@new_checks> to the list of valid checks.
+
+You must create a C<match( \ %checks )> method in your plugin class or
+one of its inheritence parents. It will be called on every op as a
+regular method call with a hash ref of checks as its parameter.
+
+You may not alter the check hash reference.
+
+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 BUGS
 
 This is only a very preliminary version.
@@ -134,6 +163,7 @@ Malcolm Beattie, mbeattie@sable.ox.ac.uk.
 
 use strict;
 use B qw(walkoptree_slow main_root walksymtable svref_2object parents
+         class
          OPf_WANT_LIST OPf_WANT OPf_STACKED G_ARRAY SVf_POK
         );
 
@@ -141,6 +171,9 @@ my $file = "unknown";               # shadows current filename
 my $line = 0;                  # shadows current line number
 my $curstash = "main";         # shadows current stash
 
+sub file { $file }
+sub line { $line }
+
 # Lint checks
 my %check;
 my %implies_ok_context;
@@ -154,6 +187,7 @@ BEGIN {
 my @default_checks = qw(context);
 
 my %valid_check;
+my %plugin_valid_check;
 # All valid checks
 BEGIN {
     map($valid_check{$_}++,
@@ -184,7 +218,19 @@ sub gimme {
     return undef;
 }
 
-sub B::OP::lint {}
+my @plugins;
+
+sub B::OP::lint {
+    my $op = shift;
+    my $m;
+    $m = $_->can('match'), $op->$m( \ %check ) for @plugins;
+    return;
+}
+*$_ = *B::OP::lint
+  for \ ( *B::PADOP::lint,
+          *B::LOGOP::lint,
+          *B::BINOP::lint,
+          *B::LISTOP::lint );
 
 sub B::COP::lint {
     my $op = shift;
@@ -193,6 +239,10 @@ sub B::COP::lint {
        $line = $op->line;
        $curstash = $op->stash->NAME;
     }
+
+    my $m;
+    $m = $_->can('match'), $op->$m( \ %check ) for @plugins;
+    return;
 }
 
 sub B::UNOP::lint {
@@ -221,6 +271,10 @@ sub B::UNOP::lint {
            }
        }
     }
+
+    my $m;
+    $m = $_->can('match'), $op->$m( \ %check ) for @plugins;
+    return;
 }
 
 sub B::PMOP::lint {
@@ -235,6 +289,10 @@ sub B::PMOP::lint {
            warning('Implicit substitution on $_');
        }
     }
+
+    my $m;
+    $m = $_->can('match'), $op->$m( \ %check ) for @plugins;
+    return;
 }
 
 sub B::LOOP::lint {
@@ -247,6 +305,10 @@ sub B::LOOP::lint {
            }
        }
     }
+    
+    my $m;
+    $m = $_->can('match'), $op->$m( \ %check ) for @plugins;
+    return;
 }
 
 sub B::SVOP::lint {
@@ -297,6 +359,10 @@ sub B::SVOP::lint {
            warning('Use of regexp variable $%s', $name);
        }
     }
+    
+    my $m;
+    $m = $_->can('match'), $op->$m( \ %check ) for @plugins;
+    return;
 }
 
 sub B::GV::lintcv {
@@ -320,7 +386,11 @@ sub do_lint {
     for my $sym (keys %main::) {
        next if $sym =~ /::$/;
        *glob = $main::{$sym};
-        svref_2object(\*glob)->EGV->lintcv;
+       
+        # When is EGV a special value?
+        my $gv = svref_2object(\*glob)->EGV;
+        next if class( $gv ) eq 'SPECIAL';
+        $gv->lintcv;
     }
 
     # Now do subs in non-main packages given by -u options
@@ -369,7 +439,7 @@ sub compile {
     foreach $opt (@default_checks, @options) {
        $opt =~ tr/-/_/;
        if ($opt eq "all") {
-           %check = %valid_check;
+            %check = ( %valid_check, %plugin_valid_check );
        }
        elsif ($opt eq "none") {
            %check = ();
@@ -381,7 +451,8 @@ sub compile {
            else {
                $check{$opt} = 1;
            }
-           warn "No such check: $opt\n" unless defined $valid_check{$opt};
+           warn "No such check: $opt\n" unless defined $valid_check{$opt}
+                                             or defined $plugin_valid_check{$opt};
        }
     }
     # Remaining arguments are things to check
@@ -389,4 +460,24 @@ sub compile {
     return \&do_lint;
 }
 
+sub register_plugin {
+    my ( undef, $plugin, $new_checks ) = @_;
+    
+    # Register the plugin
+    for my $check ( @$new_checks ) {
+        defined $check
+          or warn "Undefined value in checks.";
+        not $valid_check{ $check }
+          or warn "$check is already registered as a B::Lint feature.";
+        not $plugin_valid_check{ $check }
+          or warn "$check is already registered as a $plugin_valid_check{$check} feature.";
+         
+        $plugin_valid_check{$check} = $plugin;
+    }
+    
+    push @plugins, $plugin;
+    
+    return;
+}
+
 1;
index bd76216..621649e 100644 (file)
@@ -16,7 +16,7 @@ BEGIN {
     require 'test.pl';
 }
 
-plan tests => 15; # adjust also number of skipped tests !
+plan tests => 16; # adjust also number of skipped tests !
 
 # Runs a separate perl interpreter with the appropriate lint options
 # turned on
@@ -47,6 +47,15 @@ runlint 'implicit-write', 's/foo/bar/', <<'RESULT';
 Implicit substitution on $_ at -e line 1
 RESULT
 
+{
+    my $res = runperl(
+        switches => [ "-MB::Lint" ],
+        prog => "BEGIN{B::Lint->register_plugin(X=>[q[x]])};use O(qw[Lint x]);sub X::match{warn q[X ok.\n]};dummy()",
+       stderr => 1,
+    );
+    like( $res, qr/X ok\./, 'Lint plugin' );
+}
+
 SKIP : {
 
     use Config;