]> git.vpit.fr Git - perl/modules/indirect.git/blobdiff - lib/indirect.pm
This is 0.19
[perl/modules/indirect.git] / lib / indirect.pm
index af8d4f7a8c71efaacbbc40e5ee60ae42fed3be68..96ff670451cfdb73751bf28cb2a6adc0e5339ab4 100644 (file)
@@ -11,13 +11,13 @@ indirect - Lexically warn about using the indirect object syntax.
 
 =head1 VERSION
 
-Version 0.15
+Version 0.19
 
 =cut
 
 our $VERSION;
 BEGIN {
- $VERSION = '0.15';
+ $VERSION = '0.19';
 }
 
 =head1 SYNOPSIS
@@ -33,6 +33,8 @@ BEGIN {
       my $z = new Pineapple 'fresh'; # croaks 'You really wanted Pineapple->new at blurp.pm:13'
      }
     }
+    try { ... }; # warns
+
     no indirect ':fatal';
     if (defied $foo) { ... } # croaks, note the typo
 
@@ -56,8 +58,14 @@ This module is B<not> a source filter.
 =cut
 
 BEGIN {
- require XSLoader;
- XSLoader::load(__PACKAGE__, $VERSION);
+ if ($ENV{PERL_INDIRECT_PM_DISABLE}) {
+  *_tag = sub ($) { 1 };
+  *I_THREADSAFE = sub () { 1 };
+  *I_FORKSAFE   = sub () { 1 };
+ } else {
+  require XSLoader;
+  XSLoader::load(__PACKAGE__, $VERSION);
+ }
 }
 
 =head1 METHODS
@@ -76,7 +84,8 @@ If it's the string C<':fatal'>, the compilation will croak on the first indirect
 
 =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]>, the method name as C<$_[1]>, the current file as C<$_[2]> and the line number as C<$_[3]>.
+If the key/value pair C<< hook => $hook >> comes first, C<$hook> will be called for each error with a string representation of the object as C<$_[0]>, the method name as C<$_[1]>, the current file as C<$_[2]> and the line number as C<$_[3]>.
+If and only if the object is actually a block, C<$_[0]> is assured to start by C<'{'>.
 
 =item *
 
@@ -140,6 +149,32 @@ sub msg {
 
 True iff the module could have been built with thread-safety features enabled.
 
+=head2 C<I_FORKSAFE>
+
+True iff this module could have been built with fork-safety features enabled.
+This will always be true except on Windows where it's false for perl 5.10.0 and below .
+
+=head1 DIAGNOSTICS
+
+=head2 C<Indirect call of method "%s" on object "%s" at %s line %d.>
+
+The default warning/exception message thrown when an indirect call on an object is found.
+
+=head2 C<Indirect call of method "%s" on a block at %s line %d.>
+
+The default warning/exception message thrown when an indirect call on a block is found.
+
+=head1 ENVIRONMENT
+
+=head2 C<PERL_INDIRECT_PM_DISABLE>
+
+If this environment variable is set to true when the pragma is used for the first time, the XS code won't be loaded and, although the C<'indirect'> lexical hint will be set to true in the scope of use, the pragma itself won't do anything.
+In this case, the pragma will always be considered to be thread-safe, and as such L</I_THREADSAFE> will be true.
+This is useful for disabling C<indirect> in production environments.
+
+Note that clearing this variable after C<indirect> was loaded has no effect.
+If you want to reenable the pragma later, you also need to reload it by deleting the C<'indirect.pm'> entry from C<%INC>.
+
 =head1 CAVEATS
 
 The implementation was tweaked to work around several limitations of vanilla C<perl> pragmas : it's thread safe, and doesn't suffer from a C<perl 5.8.x-5.10.0> bug that causes all pragmas to propagate into C<require>d scopes.
@@ -149,6 +184,9 @@ C<meth $obj> (no semicolon) at the end of a file won't be seen as an indirect ob
 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.
 
+The search for indirect method calls happens before constant folding.
+Hence C<my $x = new Class if 0> will be caught.
+
 =head1 DEPENDENCIES
 
 L<perl> 5.8.
@@ -178,6 +216,8 @@ Tests code coverage report is available at L<http://www.profvince.com/perl/cover
 
 Bram, for motivation and advices.
 
+Andrew Main and Florian Ragwitz, for testing on real-life code and reporting issues.
+
 =head1 COPYRIGHT & LICENSE
 
 Copyright 2008-2009 Vincent Pit, all rights reserved.