lib/indirect.pm

   1 package indirect;
   2
   3 use strict;
   4 use warnings;
   5
   6 =head1 NAME
   7
   8 indirect - Lexically warn about using the indirect object syntax.
   9
  10 =head1 VERSION
  11
  12 Version 0.08
  13
  14 =cut
  15
  16 our $VERSION;
  17 BEGIN {
  18  $VERSION = '0.08';
  19 }
  20
  21 =head1 SYNOPSIS
  22
  23     no indirect;
  24     my $x = new Apple 1, 2, 3; # warns
  25     {
  26      use indirect;
  27      my $y = new Pear; # ok
  28     }
  29     no indirect ':fatal';
  30     if (defied $foo) { ... } # croaks, note the typo
  31
  32 =head1 DESCRIPTION
  33
  34 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 >>).
  35
  36 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>.
  37
  38 This module is B<not> a source filter.
  39
  40 =head1 METHODS
  41
  42 =head2 C<unimport @opts>
  43
  44 Magically called when C<no indirect @opts> is encountered. Turns the module on. If C<@opts> contains C<':fatal'>, the module will croak on the first indirect syntax met.
  45
  46 =head2 C<import>
  47
  48 Magically called at each C<use indirect>. Turns the module off.
  49
  50 =cut
  51
  52 BEGIN {
  53  require XSLoader;
  54  XSLoader::load(__PACKAGE__, $VERSION);
  55 }
  56
  57 sub import {
  58  $^H{indirect} = undef;
  59 }
  60
  61 sub unimport {
  62  (undef, my $type) = @_;
  63  $^H{indirect} = (defined $type and $type eq ':fatal') ? 2 : 1;
  64 }
  65
  66 =head1 DEPENDENCIES
  67
  68 L<perl> 5.9.4.
  69
  70 L<XSLoader> (standard since perl 5.006).
  71
  72 =head1 CAVEATS
  73
  74 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>).
  75
  76 =head1 AUTHOR
  77
  78 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
  79
  80 You can contact me by mail or on C<irc.perl.org> (vincent).
  81
  82 =head1 BUGS
  83
  84 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.
  85
  86 =head1 SUPPORT
  87
  88 You can find documentation for this module with the perldoc command.
  89
  90     perldoc indirect
  91
  92 Tests code coverage report is available at L<http://www.profvince.com/perl/cover/indirect>.
  93
  94 =head1 ACKNOWLEDGEMENTS
  95
  96 Bram, for motivation and advices.
  97
  98 =head1 COPYRIGHT & LICENSE
  99
 100 Copyright 2008 Vincent Pit, all rights reserved.
 101
 102 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
 103
 104 =cut
 105
 106 1; # End of indirect