.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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::ValuesAndExpressions::ProhibitBarewordDoubleColon 3pm" .TH Perl::Critic::Policy::ValuesAndExpressions::ProhibitBarewordDoubleColon 3pm "2021-02-28" "perl v5.32.1" "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::ValuesAndExpressions::ProhibitBarewordDoubleColon \- don't use Foo:: style barewords .SH "DESCRIPTION" .IX Header "DESCRIPTION" This policy is part of the \f(CW\*(C`Perl::Critic::Pulp\*(C'\fR add-on. It asks you not to use the double-colon bareword like .PP .Vb 1 \& $class = Foo::Bar::; # bad .Ve .PP but instead a plain string .PP .Vb 1 \& $class = \*(AqFoo::Bar\*(Aq; # ok .Ve .PP This is intended as a building block for a restricted coding style, or a matter of personal preference if you think the \f(CW\*(C`::\*(C'\fR is a bit obscure and that it's clearer to write a string when you mean a string. On that basis the policy is lowest severity and under the \*(L"cosmetic\*(R" theme (see \&\*(L"\s-1POLICY THEMES\*(R"\s0 in Perl::Critic). .SS "Indirect Object Syntax" .IX Subsection "Indirect Object Syntax" By default a double-colon is allowed in the indirect object syntax (see \&\*(L"Indirect Object Syntax\*(R" in perlobj). .PP .Vb 1 \& my $obj = new Foo::Bar:: $arg1,$arg2; # ok .Ve .PP This is because \f(CW\*(C`::\*(C'\fR there is important to disambiguate a class name \&\f(CW\*(C`Foo::Bar\*(C'\fR from a function \f(CW\*(C`Foo::Bar()\*(C'\fR, ie. function \f(CW\*(C`Bar()\*(C'\fR in package \&\f(CW\*(C`Foo\*(C'\fR. .PP Whether you actually want indirect object syntax is a matter for other policies, like \&\f(CW\*(C`ProhibitIndirectSyntax\*(C'\fR. If you don't want the double-colon bareword then change to arrow style \&\f(CW\*(C`Foo::Bar\->new($arg,...)\*(C'\fR. .SS "Double-Colon Advantages" .IX Subsection "Double-Colon Advantages" The \f(CW\*(C`::\*(C'\fR bareword is for use on package names, not general bareword quoting. If there's no such package at compile time a warning is given (see \&\*(L"Bareword \*(R"%s\*(L" refers to nonexistent package\*(R" in perldiag) .PP .Vb 1 \& my $class = No::Such::Package::; # Perl warning .Ve .PP This warning can help pick up typos, though it relies on relevant packages being loaded at compile-time (ie. \f(CW\*(C`BEGIN\*(C'\fR). If the package is loaded by a \&\f(CW\*(C`require\*(C'\fR at runtime then the warning fires even though the code runs correctly. For reference, a warning isn't given for the indirect object syntax, which rather limits its benefit. .SS "Disabling" .IX Subsection "Disabling" If you don't care about this you can always disable \&\f(CW\*(C`ProhibitBarewordDoubleColon\*(C'\fR from your \fI.perlcriticrc\fR in the usual way (see \*(L"\s-1CONFIGURATION\*(R"\s0 in Perl::Critic), .PP .Vb 1 \& [\-ValuesAndExpressions::ProhibitBarewordDoubleColon] .Ve .SH "CONFIGURATION" .IX Header "CONFIGURATION" .ie n .IP """allow_indirect_syntax"" (boolean, default true)" 4 .el .IP "\f(CWallow_indirect_syntax\fR (boolean, default true)" 4 .IX Item "allow_indirect_syntax (boolean, default true)" If true then allow double-colon in the indirect object syntax as shown above. If false then report double-colons everywhere as violations .Sp .Vb 2 \& # bad under allow_indirect_syntax=false \& my $obj = new Foo::Bar:: $arg1,$arg2; .Ve .Sp This can be controlled from your \fI~/.perlcriticrc\fR in the usual way. For example .Sp .Vb 2 \& [ValuesAndExpressions::ProhibitBarewordDoubleColon] \& allow_indirect_syntax=no .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" Perl::Critic::Pulp, Perl::Critic, Perl::Critic::Policy::Objects::ProhibitIndirectSyntax .PP "\f(CW\*(C`Foo::\*(C'\fR can be used as implicitly quoted package name" in perl5005delta .SH "HOME PAGE" .IX Header "HOME PAGE" http://user42.tuxfamily.org/perl\-critic\-pulp/index.html .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2019, 2021 Kevin Ryde .PP Perl-Critic-Pulp is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version. .PP Perl-Critic-Pulp is distributed in the hope that it will be useful, but \&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with Perl-Critic-Pulp. If not, see .