README

   1 NAME
   2     indirect - Lexically warn about using the indirect method call syntax.
   3
   4 VERSION
   5     Version 0.28
   6
   7 SYNOPSIS
   8     In a script :
   9
  10         no indirect;               # lexically enables the pragma
  11         my $x = new Apple 1, 2, 3; # warns
  12         {
  13          use indirect;     # lexically disables the pragma
  14          my $y = new Pear; # legit, does not warn
  15          {
  16           # lexically specify an hook called for each indirect construct
  17           no indirect hook => sub {
  18            die "You really wanted $_[0]\->$_[1] at $_[2]:$_[3]"
  19           };
  20           my $z = new Pineapple 'fresh'; # croaks 'You really wanted...'
  21          }
  22         }
  23         try { ... }; # warns if try() hasn't been declared in this package
  24
  25         no indirect 'fatal';     # or ':fatal', 'FATAL', ':Fatal' ...
  26         if (defied $foo) { ... } # croaks, note the typo
  27
  28     Global uses :
  29
  30         # Globally enable the pragma from the command-line
  31         perl -M-indirect=global -e 'my $x = new Banana;' # warns
  32
  33         # Globally enforce the pragma each time perl is executed
  34         export PERL5OPT="-M-indirect=global,fatal"
  35         perl -e 'my $y = new Coconut;' # croaks
  36
  37 DESCRIPTION
  38     When enabled, this pragma warns about indirect method calls that are
  39     present in your code.
  40
  41     The indirect syntax is now considered harmful, since its parsing has
  42     many quirks and its use is error prone : when the subroutine "foo" has
  43     not been declared in the current package, "foo $x" actually compiles to
  44     "$x->foo", and "foo { key => 1 }" to "'key'->foo(1)". In
  45     <http://www.shadowcat.co.uk/blog/matt-s-trout/indirect-but-still-fatal>,
  46     Matt S. Trout gives an example of an undesirable indirect method call on
  47     a block that can cause a particularly bewildering error.
  48
  49     This pragma currently does not warn for core functions ("print", "say",
  50     "exec" or "system"). This may change in the future, or may be added as
  51     optional features that would be enabled by passing options to
  52     "unimport".
  53
  54     This module is not a source filter.
  55
  56 METHODS
  57   "unimport"
  58         no indirect;
  59         no indirect 'fatal';
  60         no indirect hook => sub { my ($obj, $name, $file, $line) = @_; ... };
  61         no indirect 'global';
  62         no indirect 'global, 'fatal';
  63         no indirect 'global', hook => sub { ... };
  64
  65     Magically called when "no indirect @opts" is encountered. Turns the
  66     module on. The policy to apply depends on what is first found in @opts :
  67
  68     *   If it is a string that matches "/^:?fatal$/i", the compilation will
  69         croak when the first indirect method call is found.
  70
  71         This option is mutually exclusive with the 'hook' option.
  72
  73     *   If the key/value pair "hook => $hook" comes first, $hook will be
  74         called for each error with a string representation of the object as
  75         $_[0], the method name as $_[1], the current file as $_[2] and the
  76         line number as $_[3]. If and only if the object is actually a block,
  77         $_[0] is assured to start by '{'.
  78
  79         This option is mutually exclusive with the 'fatal' option.
  80
  81     *   If none of "fatal" and "hook" are specified, a warning will be
  82         emitted for each indirect method call.
  83
  84     *   If @opts contains a string that matches "/^:?global$/i", the pragma
  85         will be globally enabled for all code compiled after the current "no
  86         indirect" statement, except for code that is in the lexical scope of
  87         "use indirect". This option may come indifferently before or after
  88         the "fatal" or "hook" options, in the case they are also passed to
  89         "unimport".
  90
  91         The global policy applied is the one resulting of the "fatal" or
  92         "hook" options, thus defaults to a warning when none of those are
  93         specified :
  94
  95             no indirect 'global';                # warn for any indirect call
  96             no indirect qw<global fatal>;        # die on any indirect call
  97             no indirect 'global', hook => \&hook # custom global action
  98
  99         Note that if another policy is installed by a "no indirect"
 100         statement further in the code, it will overrule the global policy :
 101
 102             no indirect 'global';  # warn globally
 103             {
 104              no indirect 'fatal';  # throw exceptions for this lexical scope
 105              ...
 106              require Some::Module; # the global policy will apply for the
 107                                    # compilation phase of this module
 108             }
 109
 110   "import"
 111         use indirect;
 112
 113     Magically called at each "use indirect". Turns the module off.
 114
 115     As explained in "unimport"'s description, an "use indirect" statement
 116     will lexically override a global policy previously installed by "no
 117     indirect 'global', ..." (if there's one).
 118
 119 FUNCTIONS
 120   "msg"
 121         my $msg = msg($object, $method, $file, $line);
 122
 123     Returns the default error message that "indirect" generates when an
 124     indirect method call is reported.
 125
 126 CONSTANTS
 127   "I_THREADSAFE"
 128     True iff the module could have been built with thread-safety features
 129     enabled.
 130
 131   "I_FORKSAFE"
 132     True iff this module could have been built with fork-safety features
 133     enabled. This will always be true except on Windows where it's false for
 134     perl 5.10.0 and below .
 135
 136 DIAGNOSTICS
 137   "Indirect call of method "%s" on object "%s" at %s line %d."
 138     The default warning/exception message thrown when an indirect method
 139     call on an object is found.
 140
 141   "Indirect call of method "%s" on a block at %s line %d."
 142     The default warning/exception message thrown when an indirect method
 143     call on a block is found.
 144
 145 ENVIRONMENT
 146   "PERL_INDIRECT_PM_DISABLE"
 147     If this environment variable is set to true when the pragma is used for
 148     the first time, the XS code won't be loaded and, although the 'indirect'
 149     lexical hint will be set to true in the scope of use, the pragma itself
 150     won't do anything. In this case, the pragma will always be considered to
 151     be thread-safe, and as such "I_THREADSAFE" will be true. This is useful
 152     for disabling "indirect" in production environments.
 153
 154     Note that clearing this variable after "indirect" was loaded has no
 155     effect. If you want to re-enable the pragma later, you also need to
 156     reload it by deleting the 'indirect.pm' entry from %INC.
 157
 158 CAVEATS
 159     The implementation was tweaked to work around several limitations of
 160     vanilla "perl" pragmas : it's thread safe, and does not suffer from a
 161     "perl 5.8.x-5.10.0" bug that causes all pragmas to propagate into
 162     "require"d scopes.
 163
 164     Before "perl" 5.12, "meth $obj" (no semicolon) at the end of a file is
 165     not seen as an indirect method call, although it is as soon as there is
 166     another token before the end (as in "meth $obj;" or "meth $obj 1"). If
 167     you use "perl" 5.12 or greater, those constructs are correctly reported.
 168
 169     With 5.8 perls, the pragma does not propagate into "eval STRING". This
 170     is due to a shortcoming in the way perl handles the hints hash, which is
 171     addressed in perl 5.10.
 172
 173     The search for indirect method calls happens before constant folding.
 174     Hence "my $x = new Class if 0" will be caught.
 175
 176 DEPENDENCIES
 177     perl 5.8.1.
 178
 179     A C compiler. This module may happen to build with a C++ compiler as
 180     well, but don't rely on it, as no guarantee is made in this regard.
 181
 182     Carp (standard since perl 5), XSLoader (since perl 5.006).
 183
 184 AUTHOR
 185     Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
 186
 187     You can contact me by mail or on "irc.perl.org" (vincent).
 188
 189 BUGS
 190     Please report any bugs or feature requests to "bug-indirect at
 191     rt.cpan.org", or through the web interface at
 192     <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=indirect>. I will be
 193     notified, and then you'll automatically be notified of progress on your
 194     bug as I make changes.
 195
 196 SUPPORT
 197     You can find documentation for this module with the perldoc command.
 198
 199         perldoc indirect
 200
 201     Tests code coverage report is available at
 202     <http://www.profvince.com/perl/cover/indirect>.
 203
 204 ACKNOWLEDGEMENTS
 205     Bram, for motivation and advices.
 206
 207     Andrew Main and Florian Ragwitz, for testing on real-life code and
 208     reporting issues.
 209
 210 COPYRIGHT & LICENSE
 211     Copyright 2008,2009,2010,2011,2012,2013 Vincent Pit, all rights
 212     reserved.
 213
 214     This program is free software; you can redistribute it and/or modify it
 215     under the same terms as Perl itself.
 216