.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Perl::Critic::Policy::Subroutines::ProhibitBuiltinHomonyms 3pm"
.TH Perl::Critic::Policy::Subroutines::ProhibitBuiltinHomonyms 3pm 2023-07-26 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Perl::Critic::Policy::Subroutines::ProhibitBuiltinHomonyms \- Don't declare your own "open" function.
.SH AFFILIATION
.IX Header "AFFILIATION"
This Policy is part of the core Perl::Critic
distribution.
.SH DESCRIPTION
.IX Header "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
perlfunc for a list of built-in functions; see perlsyn
for keywords.
.PP
.Vb 5
\&  sub open {}    #not ok
\&  sub exit {}    #not ok
\&  sub print {}   #not ok
\&  sub foreach {} #not ok
\&  sub if {}      #not ok
\&
\&  #You get the idea...
.Ve
.PP
Exceptions are made for \f(CW\*(C`BEGIN\*(C'\fR, \f(CW\*(C`END\*(C'\fR, \f(CW\*(C`INIT\*(C'\fR and \f(CW\*(C`CHECK\*(C'\fR blocks,
as well as \f(CW\*(C`AUTOLOAD\*(C'\fR, \f(CW\*(C`DESTROY\*(C'\fR, and \f(CW\*(C`import\*(C'\fR subroutines.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
You can configure additional builtin homonyms to accept by specifying them
in a space-delimited list to the \f(CW\*(C`allow\*(C'\fR option:
.PP
.Vb 2
\&    [Subroutines::ProhibitUnusedPrivateSubroutines]
\&    allow = default index
.Ve
.PP
These are added to the default list of exemptions from this policy. So the
above allows \f(CW\*(C`sub default {}\*(C'\fR and \f(CW\*(C`sub index {}\*(C'\fR.
.SH CAVEATS
.IX Header "CAVEATS"
It is reasonable to declare an \fBobject\fR 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.
.SH AUTHOR
.IX Header "AUTHOR"
Jeffrey Ryan Thalhammer <jeff@imaginative\-software.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2005\-2022 Imaginative Software Systems.  All rights reserved.
.PP
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.