vcs.maemo.org Git - pkg-perl/blob - deb-src/libperl-critic-perl/libperl-critic-perl-1.088/lib/Perl/Critic/Policy/BuiltinFunctions/ProhibitLvalueSubstr.pm

   1 ##############################################################################
   2 #      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Policy/BuiltinFunctions/ProhibitLvalueSubstr.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::BuiltinFunctions::ProhibitLvalueSubstr;
   9
  10 use 5.006001;
  11 use strict;
  12 use warnings;
  13 use Readonly;
  14
  15 use Perl::Critic::Utils qw{ :severities :classification };
  16 use base 'Perl::Critic::Policy';
  17
  18 our $VERSION = '1.088';
  19
  20 #-----------------------------------------------------------------------------
  21
  22 Readonly::Scalar my $DESC => q{Lvalue form of "substr" used};
  23 Readonly::Scalar my $EXPL => [ 165 ];
  24
  25 #-----------------------------------------------------------------------------
  26
  27 sub supported_parameters { return ()                         }
  28 sub default_severity     { return $SEVERITY_MEDIUM           }
  29 sub default_themes       { return qw( core maintenance pbp ) }
  30 sub applies_to           { return 'PPI::Token::Word'         }
  31
  32 #-----------------------------------------------------------------------------
  33
  34 sub violates {
  35     my ($self, $elem, undef) = @_;
  36
  37     return if $elem ne 'substr';
  38     return if ! is_function_call($elem);
  39
  40     my $sib = $elem;
  41     while ($sib = $sib->snext_sibling()) {
  42         if ( $sib->isa( 'PPI::Token::Operator') && $sib eq q{=} ) {
  43             return $self->violation( $DESC, $EXPL, $sib );
  44         }
  45     }
  46     return; #ok!
  47 }
  48
  49 1;
  50
  51 #-----------------------------------------------------------------------------
  52
  53 __END__
  54
  55 =pod
  56
  57 =head1 NAME
  58
  59 Perl::Critic::Policy::BuiltinFunctions::ProhibitLvalueSubstr - Use 4-argument C<substr> instead of writing C<substr($foo, 2, 6) = $bar>.
  60
  61 =head1 AFFILIATION
  62
  63 This Policy is part of the core L<Perl::Critic> distribution.
  64
  65
  66 =head1 DESCRIPTION
  67
  68 Conway discourages the use of C<substr()> as an lvalue, instead
  69 recommending that the 4-argument version of C<substr()> be used instead.
  70
  71   substr($something, 1, 2) = $newvalue;     # not ok
  72   substr($something, 1, 2, $newvalue);      # ok
  73
  74
  75 =head1 CONFIGURATION
  76
  77 This Policy is not configurable except for the standard options.
  78
  79
  80 =head1 AUTHOR
  81
  82 Graham TerMarsch <graham@howlingfrog.com>
  83
  84 =head1 COPYRIGHT
  85
  86 Copyright (C) 2005-2007 Graham TerMarsch.  All rights reserved.
  87
  88 This program is free software; you can redistribute it and/or modify
  89 it under the same terms as Perl itself.
  90
  91 =cut
  92
  93 # Local Variables:
  94 #   mode: cperl
  95 #   cperl-indent-level: 4
  96 #   fill-column: 78
  97 #   indent-tabs-mode: nil
  98 #   c-indentation-style: bsd
  99 # End:
 100 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :