git.maemo.org Git - pkg-perl/blob - deb-src/libperl-critic-perl/libperl-critic-perl-1.088/lib/Perl/Critic/Policy/InputOutput/ProhibitReadlineInForLoop.pm

   1 ##############################################################################
   2 #      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Policy/InputOutput/ProhibitReadlineInForLoop.pm $
   3 #     $Date: 2008-07-03 10:19:10 -0500 (Thu, 03 Jul 2008) $
   4 #   $Author: clonezone $
   5 # $Revision: 2489 $
   6 ##############################################################################
   7
   8 package Perl::Critic::Policy::InputOutput::ProhibitReadlineInForLoop;
   9
  10 use 5.006001;
  11 use strict;
  12 use warnings;
  13 use Readonly;
  14
  15 use Perl::Critic::Utils qw{ :severities };
  16 use base 'Perl::Critic::Policy';
  17
  18 our $VERSION = '1.088';
  19
  20 #-----------------------------------------------------------------------------
  21
  22 Readonly::Scalar my $DESC => q{Readline inside "for" loop};
  23 Readonly::Scalar my $EXPL => [ 211 ];
  24
  25 #-----------------------------------------------------------------------------
  26
  27 sub supported_parameters { return ()                           }
  28 sub default_severity     { return $SEVERITY_HIGH               }
  29 sub default_themes       { return qw( core bugs pbp )          }
  30 sub applies_to           { return qw( PPI::Structure::ForLoop) }
  31
  32 #-----------------------------------------------------------------------------
  33
  34 sub violates {
  35     my ( $self, $elem, undef ) = @_;
  36
  37     if ( my $rl = $elem->find_first('PPI::Token::QuoteLike::Readline') ) {
  38         return $self->violation( $DESC, $EXPL, $rl );
  39     }
  40
  41     return;  #ok!
  42 }
  43
  44 1;
  45
  46 __END__
  47
  48 #-----------------------------------------------------------------------------
  49
  50 =pod
  51
  52 =head1 NAME
  53
  54 Perl::Critic::Policy::InputOutput::ProhibitReadlineInForLoop - Write C<< while( $line = <> ){...} >> instead of C<< for(<>){...} >>.
  55
  56 =head1 AFFILIATION
  57
  58 This Policy is part of the core L<Perl::Critic> distribution.
  59
  60
  61 =head1 DESCRIPTION
  62
  63 Using the readline operator in a C<for> or C<foreach> loop is very
  64 slow.  The iteration list of the loop creates a list context,
  65 which causes the readline operator to read the entire input stream
  66 before iteration even starts.  Instead, just use a C<while> loop,
  67 which only reads one line at a time.
  68
  69   for my $line ( <$file_handle> ){ do_something($line) }      #not ok
  70   while ( my $line = <$file_handle> ){ do_something($line) }  #ok
  71
  72
  73 =head1 CONFIGURATION
  74
  75 This Policy is not configurable except for the standard options.
  76
  77
  78 =head1 AUTHOR
  79
  80 Jeffrey Ryan Thalhammer <thaljef@cpan.org>
  81
  82 =head1 COPYRIGHT
  83
  84 Copyright (c) 2005-2008 Jeffrey Ryan Thalhammer.  All rights reserved.
  85
  86 This program is free software; you can redistribute it and/or modify
  87 it under the same terms as Perl itself.  The full text of this license
  88 can be found in the LICENSE file included with this module.
  89
  90 =cut
  91
  92 # Local Variables:
  93 #   mode: cperl
  94 #   cperl-indent-level: 4
  95 #   fill-column: 78
  96 #   indent-tabs-mode: nil
  97 #   c-indentation-style: bsd
  98 # End:
  99 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :