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::regularexpressions::prohibitunusedcapture(3) [centos man page]

Perl::Critic::Policy::RegularExpressions::ProhibitUnusedUseruContributed Perl DoPerl::Critic::Policy::RegularExpressions::ProhibitUnusedCapture(3)

NAME

       Perl::Critic::Policy::RegularExpressions::ProhibitUnusedCapture - Only use a capturing group if you plan to use the captured value.

AFFILIATION

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

DESCRIPTION

       Perl regular expressions have multiple types of grouping syntax.  The basic parentheses (e.g. "m/(foo)/") captures into the magic variable
       $1.  Non-capturing groups (e.g. "m/(?:foo)/" are useful because they have better runtime performance and do not copy strings to the magic
       global capture variables.

       It's also easier on the maintenance programmer if you consistently use capturing vs. non-capturing groups, because that programmer can tell
       more easily which regexps can be refactored without breaking surrounding code which may use the captured values.

CONFIGURATION

       This Policy is not configurable except for the standard options.

CAVEATS

   "qr//" interpolation
       This policy can be confused by interpolation of "qr//" elements, but those are always false negatives.  For example:

	   my $foo_re = qr/(foo)/;
	   my ($foo) = m/$foo_re (bar)/x;

       A human can tell that this should be a violation because there are two captures but only the first capture is used, not the second.  The
       policy only notices that there is one capture in the regexp and remains happy.

   "@-", "@+", $LAST_MATCH_START and $LAST_MATCH_END
       This policy will only recognize capture groups referred to by these variables if the use is subscripted by a literal integer.

   $^N and $LAST_SUBMATCH_RESULT
       This policy will not recognize capture groups referred to only by these variables, because there is in general no way by static analysis to
       determine which capture group is referred to.  For example,

	   m/ (?: (A[[:alpha:]]+) | (Nd+) ) (?{$foo=$^N}) /smx

       makes use of the first capture group if it matches, or the second capture group if the first does not match but the second does.

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-09	Perl::Critic::Policy::RegularExpressions::ProhibitUnusedCapture(3)

Check Out this Related Man Page

Perl::Critic::Policy::RegularExpressions::RequireBracesFUserlContributed PPerl::Critic::Policy::RegularExpressions::RequireBracesForMultiline(3pm)

NAME

       Perl::Critic::Policy::RegularExpressions::RequireBracesForMultiline - Use "{" and "}" to delimit multi-line regexps.

AFFILIATION

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

DESCRIPTION

       Long regular expressions are hard to read.  A good practice is to use the "x" modifier and break the regex into multiple lines with
       comments explaining the parts.  But, with the usual "//" delimiters, the beginning and end can be hard to match, especially in a "s///"
       regexp.	Instead, try using "{}" characters to delimit your expressions.

       Compare these:

	   s/
	      <a s+ href="([^"]+)">
	       (.*?)
	      </a>
	    /link=$1, text=$2/xms;

       vs.

	   s{
	      <a s+ href="([^"]+)">
	       (.*?)
	      </a>
	    }
	    {link=$1, text=$2}xms;

       Is that an improvement?	Marginally, but yes.  The curly braces lead the eye better.

CONFIGURATION

       There is one option for this policy, "allow_all_brackets".  If this is true, then, in addition to allowing "{}", the other matched pairs of
       "()", "[]", and "<>" are allowed.

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.14.2							    2012-0Perl::Critic::Policy::RegularExpressions::RequireBracesForMultiline(3pm)
Man Page