lib/indirect.pm

   1 package indirect;
   2
   3 use 5.008;
   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.11
  15
  16 =cut
  17
  18 our $VERSION;
  19 BEGIN {
  20  $VERSION = '0.11';
  21 }
  22
  23 =head1 SYNOPSIS
  24
  25     no indirect;
  26     my $x = new Apple 1, 2, 3; # warns
  27     {
  28      use indirect;
  29      my $y = new Pear; # ok
  30     }
  31     no indirect ':fatal';
  32     if (defied $foo) { ... } # croaks, note the typo
  33
  34 =head1 DESCRIPTION
  35
  36 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<sub> isn't defined, C<sub $x> is actually interpreted as C<< $x->sub >>).
  37
  38 It currently does not warn when the object is enclosed between braces (like C<meth { $obj } @args>) or for core functions (C<print> or C<say>). This may change in the future, or may be added as optional features that would be enabled by passing options to C<unimport>.
  39
  40 This module is B<not> a source filter.
  41
  42 =cut
  43
  44 BEGIN {
  45  require XSLoader;
  46  XSLoader::load(__PACKAGE__, $VERSION);
  47 }
  48
  49 =head1 METHODS
  50
  51 =head2 C<< unimport [ hook => $hook | ':fatal' ] >>
  52
  53 Magically called when C<no indirect @opts> is encountered.
  54 Turns the module on.
  55 The policy to apply depends on what is first found in C<@opts> :
  56
  57 =over 4
  58
  59 =item *
  60
  61 If it's the string C<':fatal'>, the compilation will croak on the first indirect syntax met.
  62
  63 =item *
  64
  65 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]>.
  66
  67 =item *
  68
  69 Otherwise, a warning will be emitted for each indirect construct.
  70
  71 =back
  72
  73 =cut
  74
  75 my $msg = sub { "Indirect call of method \"$_[1]\" on object \"$_[0]\"" };
  76
  77 sub unimport {
  78  shift;
  79
  80  my $hook;
  81  while (@_) {
  82   my $arg = shift;
  83   if ($arg eq 'hook') {
  84    $hook = shift;
  85   } elsif ($arg eq ':fatal') {
  86    $hook = sub { die $msg->(@_) };
  87   }
  88   last if $hook;
  89  }
  90  $hook = sub { warn $msg->(@_) } unless defined $hook;
  91
  92  $^H |= 0x00020000;
  93  $^H{+(__PACKAGE__)} = _tag($hook);
  94
  95  ();
  96 }
  97
  98 =head2 C<import>
  99
 100 Magically called at each C<use indirect>. Turns the module off.
 101
 102 =cut
 103
 104 sub import {
 105  $^H{+(__PACKAGE__)} = undef;
 106  ();
 107 }
 108
 109 =head1 CONSTANTS
 110
 111 =head2 C<I_THREADSAFE>
 112
 113 True iff the module could have been built when thread-safety features.
 114
 115 =head1 CAVEATS
 116
 117 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>).
 118
 119 With 5.8 perls, the pragma does not propagate into C<eval STRING>.
 120 This is due to a shortcoming in the way perl handles the hints hash, which is addressed in perl 5.10.
 121
 122 =head1 DEPENDENCIES
 123
 124 L<perl> 5.8.
 125
 126 L<XSLoader> (standard since perl 5.006).
 127
 128 =head1 AUTHOR
 129
 130 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
 131
 132 You can contact me by mail or on C<irc.perl.org> (vincent).
 133
 134 =head1 BUGS
 135
 136 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>.  I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
 137
 138 =head1 SUPPORT
 139
 140 You can find documentation for this module with the perldoc command.
 141
 142     perldoc indirect
 143
 144 Tests code coverage report is available at L<http://www.profvince.com/perl/cover/indirect>.
 145
 146 =head1 ACKNOWLEDGEMENTS
 147
 148 Bram, for motivation and advices.
 149
 150 =head1 COPYRIGHT & LICENSE
 151
 152 Copyright 2008-2009 Vincent Pit, all rights reserved.
 153
 154 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
 155
 156 =cut
 157
 158 1; # End of indirect