1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
package Perl::Critic::Policy::Subroutines::ProhibitBuiltinHomonyms;
use 5.010001;
use strict;
use warnings;
use Readonly;
use Perl::Critic::Utils qw{ :severities :data_conversion
:classification :characters $EMPTY };
use parent 'Perl::Critic::Policy';
our $VERSION = '1.156';
#-----------------------------------------------------------------------------
Readonly::Array my @ALLOW => qw( import unimport AUTOLOAD DESTROY );
Readonly::Hash my %ALLOW => hashify( @ALLOW );
Readonly::Scalar my $DESC => q{Subroutine name is a homonym for builtin %s %s};
Readonly::Scalar my $EXPL => [177];
#-----------------------------------------------------------------------------
sub supported_parameters {
return (
{
name => 'allow',
description => q<Subroutines matching the name regex to allow under this policy.>,
default_string => $EMPTY,
behavior => 'string list',
},
);
}
sub default_severity { return $SEVERITY_HIGH }
sub default_themes { return qw( core bugs pbp certrule ) }
sub applies_to { return 'PPI::Statement::Sub' }
#-----------------------------------------------------------------------------
sub violates {
my ( $self, $elem, undef ) = @_;
return if $elem->isa('PPI::Statement::Scheduled'); #e.g. BEGIN, INIT, END
return if exists $ALLOW{ $elem->name() } and not defined $elem->type();
return if exists $self->{_allow}{ $elem->name() };
my $homonym_type = $EMPTY;
if ( is_perl_builtin( $elem ) ) {
$homonym_type = 'function';
}
elsif ( is_perl_bareword( $elem ) ) {
$homonym_type = 'keyword';
}
else {
return; #ok!
}
my $desc = sprintf $DESC, $homonym_type, $elem->name();
return $self->violation($desc, $EXPL, $elem);
}
1;
__END__
#-----------------------------------------------------------------------------
=pod
=for stopwords perlfunc perlsyn
=head1 NAME
Perl::Critic::Policy::Subroutines::ProhibitBuiltinHomonyms - Don't declare your own C<open> function.
=head1 AFFILIATION
This Policy is part of the core L<Perl::Critic|Perl::Critic>
distribution.
=head1 DESCRIPTION
Common sense dictates that you shouldn't declare subroutines with the same
name as one of Perl's built-in functions or keywords. See
L<perlfunc|perlfunc> for a list of built-in functions; see L<perlsyn|perlsyn>
for keywords.
sub open {} #not ok
sub exit {} #not ok
sub print {} #not ok
sub foreach {} #not ok
sub if {} #not ok
#You get the idea...
Exceptions are made for C<BEGIN>, C<END>, C<INIT> and C<CHECK> blocks,
as well as C<AUTOLOAD>, C<DESTROY>, and C<import> subroutines.
=head1 CONFIGURATION
You can configure additional builtin homonyms to accept by specifying them
in a space-delimited list to the C<allow> option:
[Subroutines::ProhibitBuiltinHomonyms]
allow = default index
These are added to the default list of exemptions from this policy. So the
above allows C<< sub default {} >> and C<< sub index {} >>.
=head1 CAVEATS
It is reasonable to declare an B<object> method with the same name as
a Perl built-in function, since they are easily distinguished from
each other. However, at this time, Perl::Critic cannot tell whether a
subroutine is static or an object method.
=head1 AUTHOR
Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>
=head1 COPYRIGHT
Copyright (c) 2005-2022 Imaginative Software Systems. All rights reserved.
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself. The full text of this license
can be found in the LICENSE file included with this module.
=cut
# Local Variables:
# mode: cperl
# cperl-indent-level: 4
# fill-column: 78
# indent-tabs-mode: nil
# c-indentation-style: bsd
# End:
# ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :
|
