]> git.vpit.fr Git - perl/modules/indirect.git/blobdiff - lib/indirect.pm
This is 0.21
[perl/modules/indirect.git] / lib / indirect.pm
index 734896a4d6db6bd5ac02a1a971996d13b8b7ae63..239773f9a6d7b65c66394f290151786db027ef06 100644 (file)
@@ -1,6 +1,6 @@
 package indirect;
 
-use 5.008;
+use 5.008001;
 
 use strict;
 use warnings;
@@ -11,13 +11,13 @@ indirect - Lexically warn about using the indirect object syntax.
 
 =head1 VERSION
 
-Version 0.16
+Version 0.21
 
 =cut
 
 our $VERSION;
 BEGIN {
- $VERSION = '0.16';
+ $VERSION = '0.21';
 }
 
 =head1 SYNOPSIS
@@ -48,7 +48,9 @@ BEGIN {
 =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<swoosh> isn't defined, C<swoosh $x> actually compiles to C<< $x->swoosh >>).
+In L<http://www.shadowcat.co.uk/blog/matt-s-trout/indirect-but-still-fatal>, Matt S. Trout gives an example of an indirect construct that can cause a particularly bewildering error.
 
 It currently does not warn for core functions (C<print>, C<say>, C<exec> or C<system>).
 This may change in the future, or may be added as optional features that would be enabled by passing options to C<unimport>.
@@ -58,8 +60,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
@@ -143,6 +151,11 @@ 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.>
@@ -153,6 +166,17 @@ The default warning/exception message thrown when an indirect call on an object
 
 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.
@@ -162,9 +186,12 @@ 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.
+L<perl> 5.8.1.
 
 L<XSLoader> (standard since perl 5.006).
 
@@ -195,7 +222,7 @@ Andrew Main and Florian Ragwitz, for testing on real-life code and reporting iss
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright 2008-2009 Vincent Pit, all rights reserved.
+Copyright 2008,2009,2010 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.