Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

perl::critic::policy::subroutines::protectprivatesubs(3pm) [debian man page]

Perl::Critic::Policy::Subroutines::ProtectPrivateSubs(3pUser Contributed Perl DocumentatPerl::Critic::Policy::Subroutines::ProtectPrivateSubs(3pm)

NAME

       Perl::Critic::Policy::Subroutines::ProtectPrivateSubs - Prevent access to private subs in other packages.

AFFILIATION

       This Policy is part of the core Perl::Critic distribution.

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.

       The subroutines in the POSIX package which begin with an underscore (e.g. "POSIX::_POSIX_ARG_MAX") are not flagged as errors by this
       policy.

CONFIGURATION

       You can define what a private subroutine name looks like by specifying a regular expression for the "private_name_regex" option in your
       .perlcriticrc:

	   [Subroutines::ProtectPrivateSubs]
	   private_name_regex = _(?!_)w+

       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.)

       You can configure additional subroutines to accept by specifying them in a space-delimited list to the "allow" option:

	   [Subroutines::ProtectPrivateSubs]
	   allow = FOO::_bar FOO::_baz

       These are added to the default list of exemptions from this policy.  Allowing a subroutine also allows the corresponding method call. So
       "FOO::_bar" in the above example allows both "FOO::_bar()" and "FOO->_bar()".

HISTORY

       This policy is inspired by a similar test in B::Lint.

BUGS

       Doesn't forbid "$pkg->_foo()" because it can't tell the difference between that and "$self->_foo()".

SEE ALSO

       Perl::Critic::Policy::Variables::ProtectPrivateVars

AUTHOR

       Chris Dolan <cdolan@cpan.org>

COPYRIGHT

       Copyright (c) 2006-2011 Chris Dolan.

       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.

perl v5.14.2							    2012-06-07		Perl::Critic::Policy::Subroutines::ProtectPrivateSubs(3pm)

Check Out this Related Man Page

Perl::Critic::Policy::RegularExpressions::ProhibitEnumerUserCContributed PerPerl::Critic::Policy::RegularExpressions::ProhibitEnumeratedClasses(3)

NAME

       Perl::Critic::Policy::RegularExpressions::ProhibitEnumeratedClasses - Use named character classes instead of explicit character lists.

AFFILIATION

       This Policy is part of the core Perl::Critic distribution.

DESCRIPTION

       This policy is not for everyone!  If you are working in pure ASCII, then disable it now or you may see some false violations.

       On the other hand many of us are working in a multilingual world with an extended character set, probably Unicode.  In that world, patterns
       like "m/[A-Z]/" can be a source of bugs when you really meant "m/p{IsUpper}/".	This policy catches a selection of possible incorrect
       character class usage.

       Specifically, the patterns are:

       "[	
f ]" vs. "s"

       "[	
 ]" vs. "s"   (because many people forget "f")

       "[A-Za-z0-9_]" vs. "w"

       "[A-Za-z]" vs. "p{IsAlphabetic}"

       "[A-Z]" vs. "p{IsUpper}"

       "[a-z]" vs. "p{IsLower}"

       "[0-9]" vs. "d"

       "[^w]" vs. "W"

       "[^s]" vs. "S"

CONFIGURATION

       This Policy is not configurable except for the standard options.

CREDITS

       Initial development of this policy was supported by a grant from the Perl Foundation.

AUTHOR

       Chris Dolan <cdolan@cpan.org>

COPYRIGHT

       Copyright (c) 2007-2011 Chris Dolan.  Many 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

perl v5.16.3							    2014-06-Perl::Critic::Policy::RegularExpressions::ProhibitEnumeratedClasses(3)
Man Page