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

   1 ##############################################################################
   2 #      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Policy/Subroutines/ProhibitSubroutinePrototypes.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::Subroutines::ProhibitSubroutinePrototypes;
   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{Subroutine prototypes used};
  23 Readonly::Scalar my $EXPL => [ 194 ];
  24
  25 #-----------------------------------------------------------------------------
  26
  27 sub supported_parameters { return ()                    }
  28 sub default_severity     { return $SEVERITY_HIGHEST     }
  29 sub default_themes       { return qw(core pbp bugs)     }
  30 sub applies_to           { return 'PPI::Statement::Sub' }
  31
  32 #-----------------------------------------------------------------------------
  33
  34 sub violates {
  35     my ( $self, $elem, undef ) = @_;
  36     if ( $elem->prototype() ) {
  37         return $self->violation( $DESC, $EXPL, $elem );
  38     }
  39     return;    #ok!
  40 }
  41
  42 1;
  43
  44 __END__
  45
  46 #-----------------------------------------------------------------------------
  47
  48 =pod
  49
  50 =head1 NAME
  51
  52 Perl::Critic::Policy::Subroutines::ProhibitSubroutinePrototypes - Don't write C<sub my_function (@@) {}>.
  53
  54 =head1 AFFILIATION
  55
  56 This Policy is part of the core L<Perl::Critic> distribution.
  57
  58
  59 =head1 DESCRIPTION
  60
  61 Contrary to common belief, subroutine prototypes do not enable
  62 compile-time checks for proper arguments.  Don't use them.
  63
  64
  65 =head1 CONFIGURATION
  66
  67 This Policy is not configurable except for the standard options.
  68
  69
  70 =head1 AUTHOR
  71
  72 Jeffrey Ryan Thalhammer <thaljef@cpan.org>
  73
  74 =head1 COPYRIGHT
  75
  76 Copyright (c) 2005-2008 Jeffrey Ryan Thalhammer.  All rights reserved.
  77
  78 This program is free software; you can redistribute it and/or modify
  79 it under the same terms as Perl itself.  The full text of this license
  80 can be found in the LICENSE file included with this module.
  81
  82 =cut
  83
  84 # Local Variables:
  85 #   mode: cperl
  86 #   cperl-indent-level: 4
  87 #   fill-column: 78
  88 #   indent-tabs-mode: nil
  89 #   c-indentation-style: bsd
  90 # End:
  91 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :