Introduce the 'hook' unimport option

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

diff --git a/lib/indirect.pm b/lib/indirect.pm
index e7347813c5a87256f5c5250857b7ca8bcc22601c..6354a1361f30c36af3a672f88a8579d03b9928e0 100644 (file)
--- a/lib/indirect.pm
+++ b/lib/indirect.pm
@@ -1,5 +1,7 @@
 package indirect;
 
+use 5.008;
+
 use strict;
 use warnings;
 
@@ -9,13 +11,13 @@ indirect - Lexically warn about using the indirect object syntax.
 
 =head1 VERSION
 
-Version 0.06
+Version 0.11
 
 =cut
 
 our $VERSION;
 BEGIN {
- $VERSION = '0.06';
+ $VERSION = '0.11';
 }
 
 =head1 SYNOPSIS
@@ -37,35 +39,89 @@ 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{indirect} = undef;
+ $^H{+(__PACKAGE__)} = undef;
+ ();
 }
 
-sub unimport {
- (undef, my $type) = @_;
- $^H{indirect} = (defined $type and $type eq ':fatal') ? 2 : 1;
-}
+=head1 CONSTANTS
+
+=head2 C<I_THREADSAFE>
+
+True iff the module could have been built when thread-safety features.
+
+=head1 CAVEATS
+
+C<meth $obj> (no semicolon) at the end of a file won't be seen as an indirect object syntax, although it will as soon as there is another token before the end (as in C<meth $obj;> or C<meth $obj 1>).
+
+With 5.8 perls, the pragma does not propagate into C<eval STRING>.
+This is due to a shortcoming in the way perl handles the hints hash, which is addressed in perl 5.10.
 
 =head1 DEPENDENCIES
 
-L<perl> 5.9.4.
+L<perl> 5.8.
 
 L<XSLoader> (standard since perl 5.006).
 
@@ -93,7 +149,7 @@ Bram, for motivation and advices.
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright 2008 Vincent Pit, all rights reserved.
+Copyright 2008-2009 Vincent Pit, all rights reserved.
 
 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.