lib/indirect.pm

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