Freshen the synopsis

[perl/modules/indirect.git] / lib / indirect.pm

diff --git a/lib/indirect.pm b/lib/indirect.pm
index c068be73fa8e42e43bbf961f4343ff698cc3c1ec..3794554e967a0e3e6ae08afeda4173267ebb2c21 100644 (file)
--- a/lib/indirect.pm
+++ b/lib/indirect.pm
@@ -22,15 +22,27 @@ BEGIN {
 
 =head1 SYNOPSIS
 
+    # In a script
     no indirect;
     my $x = new Apple 1, 2, 3; # warns
     {
      use indirect;
      my $y = new Pear; # ok
+     {
+      no indirect hook => sub { die "You really wanted $_[0]\->$_[1]" };
+      my $z = new Pineapple 'fresh'; # croaks 'You really wanted Pineapple->new'
+     }
     }
     no indirect ':fatal';
     if (defied $foo) { ... } # croaks, note the typo
 
+    # From the command-line
+    perl -M-indirect -e 'my $x = new Banana;' # warns
+
+    # Or each time perl is ran
+    export PERL5OPT="-M-indirect"
+    perl -e 'my $y = new Coconut;' # warns
+
 =head1 DESCRIPTION
 
 When enabled (or disabled as some may prefer to say, since you actually turn it on by calling C<no indirect>), this pragma warns about indirect object syntax constructs that may have slipped into your code. This syntax is now considered harmful, since its parsing has many quirks and its use is error prone (when C<sub> isn't defined, C<sub $x> is actually interpreted as C<< $x->sub >>).
@@ -39,39 +51,78 @@ It currently does not warn when the object is enclosed between braces (like C<me
 
 This module is B<not> a source filter.
 
+=cut
+
+BEGIN {
+ require XSLoader;
+ XSLoader::load(__PACKAGE__, $VERSION);
+}
+
 =head1 METHODS
 
-=head2 C<unimport @opts>
+=head2 C<< unimport [ hook => $hook | ':fatal' ] >>
 
-Magically called when C<no indirect @opts> is encountered. Turns the module on. If C<@opts> contains C<':fatal'>, the module will croak on the first indirect syntax met.
+Magically called when C<no indirect @opts> is encountered.
+Turns the module on.
+The policy to apply depends on what is first found in C<@opts> :
 
-=head2 C<import>
+=over 4
 
-Magically called at each C<use indirect>. Turns the module off.
+=item *
+
+If it's the string C<':fatal'>, the compilation will croak on the first indirect syntax met.
+
+=item *
+
+If the key/value pair C<< hook => $hook >> comes first, C<$hook> will be called for each error with the object name as C<$_[0]> and the method name as C<$_[1]>.
+
+=item *
+
+Otherwise, a warning will be emitted for each indirect construct.
+
+=back
 
 =cut
 
-BEGIN {
- require XSLoader;
- XSLoader::load(__PACKAGE__, $VERSION);
+my $msg = sub { "Indirect call of method \"$_[1]\" on object \"$_[0]\"" };
+
+sub unimport {
+ shift;
+
+ my $hook;
+ while (@_) {
+  my $arg = shift;
+  if ($arg eq 'hook') {
+   $hook = shift;
+  } elsif ($arg eq ':fatal') {
+   $hook = sub { die $msg->(@_) };
+  }
+  last if $hook;
+ }
+ $hook = sub { warn $msg->(@_) } unless defined $hook;
+
+ $^H |= 0x00020000;
+ $^H{+(__PACKAGE__)} = _tag($hook);
+
+ ();
 }
 
+=head2 C<import>
+
+Magically called at each C<use indirect>. Turns the module off.
+
+=cut
+
 sub import {
  $^H{+(__PACKAGE__)} = undef;
  ();
 }
 
-my $msg = sub { "Indirect call of method \"$_[1]\" on object \"$_[0]\"" };
+=head1 CONSTANTS
 
-sub unimport {
- (undef, my $type) = @_;
- $^H |= 0x00020000;
- my $cb = (defined $type and $type eq ':fatal')
-           ? sub { die  $msg->(@_) }
-           : sub { warn $msg->(@_) };
- $^H{+(__PACKAGE__)} = _tag($cb);
- ();
-}
+=head2 C<I_THREADSAFE>
+
+True iff the module could have been built when thread-safety features.
 
 =head1 CAVEATS