.\" -*- 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::ProtectPrivateSubs 3pm"
.TH Perl::Critic::Policy::Subroutines::ProtectPrivateSubs 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::ProtectPrivateSubs \- Prevent access to private subs in other packages.
.SH AFFILIATION
.IX Header "AFFILIATION"
This Policy is part of the core Perl::Critic
distribution.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
By convention Perl authors (like authors in many other languages)
indicate private methods and variables by inserting a leading
underscore before the identifier.  This policy catches attempts to
access private variables from outside the package itself.
.PP
The subroutines in the POSIX package which begin with an underscore
(e.g. \f(CW\*(C`POSIX::_POSIX_ARG_MAX\*(C'\fR) are not flagged as errors by this
policy.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
You can define what a private subroutine name looks like by specifying
a regular expression for the \f(CW\*(C`private_name_regex\*(C'\fR option in your
\&\fI.perlcriticrc\fR:
.PP
.Vb 2
\&    [Subroutines::ProtectPrivateSubs]
\&    private_name_regex = _(?!_)\ew+
.Ve
.PP
The above example is a way of saying that subroutines that start with
a double underscore are not considered to be private.  (Perl::Critic,
in its implementation, uses leading double underscores to indicate a
distribution-private subroutine\-\- one that is allowed to be invoked by
other Perl::Critic modules, but not by anything outside of
Perl::Critic.)
.PP
You can configure additional subroutines to accept by specifying them
in a space-delimited list to the \f(CW\*(C`allow\*(C'\fR option:
.PP
.Vb 2
\&    [Subroutines::ProtectPrivateSubs]
\&    allow = FOO::_bar FOO::_baz
.Ve
.PP
These are added to the default list of exemptions from this policy.
Allowing a subroutine also allows the corresponding method call. So
\&\f(CW\*(C`FOO::_bar\*(C'\fR in the above example allows both \f(CWFOO::_bar()\fR
and \f(CW\*(C`FOO\->_bar()\*(C'\fR.
.SH HISTORY
.IX Header "HISTORY"
This policy is inspired by a similar test in B::Lint.
.SH BUGS
.IX Header "BUGS"
Doesn't forbid \f(CW\*(C`$pkg\->_foo()\*(C'\fR because it can't tell the
difference between that and \f(CW\*(C`$self\->_foo()\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Perl::Critic::Policy::Variables::ProtectPrivateVars
.SH AUTHOR
.IX Header "AUTHOR"
Chris Dolan <cdolan@cpan.org>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2006\-2011 Chris Dolan.
.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.