.\" -*- 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::Theme 3pm"
.TH Perl::Critic::Theme 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::Theme \- Construct thematic sets of policies.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a helper class for evaluating theme expressions into sets of
Policy objects.  There are no user-serviceable parts here.
.SH "INTERFACE SUPPORT"
.IX Header "INTERFACE SUPPORT"
This is considered to be a non-public class.  Its interface is subject
to change without notice.
.SH METHODS
.IX Header "METHODS"
.ie n .IP """new( \-rule => $rule_expression )""" 4
.el .IP "\f(CWnew( \-rule => $rule_expression )\fR" 4
.IX Item "new( -rule => $rule_expression )"
Returns a reference to a new Perl::Critic::Theme object.  \f(CW\*(C`\-rule\*(C'\fR is
a string expression that evaluates to true or false for each Policy..
See "THEME RULES" for more information.
.ie n .IP """policy_is_thematic( \-policy => $policy )""" 4
.el .IP "\f(CWpolicy_is_thematic( \-policy => $policy )\fR" 4
.IX Item "policy_is_thematic( -policy => $policy )"
Given a reference to a Perl::Critic::Policy
object, this method returns evaluates the rule against the themes that
are associated with the Policy.  Returns 1 if the Policy satisfies the
rule, 0 otherwise.
.ie n .IP " rule() " 4
.el .IP "\f(CW rule() \fR" 4
.IX Item " rule() "
Returns the rule expression that was used to construct this Theme.
The rule may have been translated into a normalized expression.  See
"THEME RULES" for more information.
.SS "THEME RULES"
.IX Subsection "THEME RULES"
A theme rule is a simple boolean expression, where the operands are
the names of any of the themes associated with the
Perl::Critic::Polices.
.PP
Theme names can be combined with logical operators to form arbitrarily
complex expressions.  Precedence is the same as normal mathematics,
but you can use parentheses to enforce precedence as well.  Supported
operators are:
.PP
.Vb 5
\&   Operator    Altertative    Example
\&   \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\&   &&          and            \*(Aqpbp && core\*(Aq
\&   ||          or             \*(Aqpbp || (bugs && security)\*(Aq
\&   !           not            \*(Aqpbp && ! (portability || complexity)
.Ve
.PP
See "CONFIGURATION" in Perl::Critic for more information about
customizing the themes for each Policy.
.SH SUBROUTINES
.IX Header "SUBROUTINES"
.ie n .IP "cook_rule( $rule )" 4
.el .IP "\f(CWcook_rule( $rule )\fR" 4
.IX Item "cook_rule( $rule )"
Standardize a rule into almost executable Perl code.  The "almost"
comes from the fact that theme names are left as is.
.SH CONSTANTS
.IX Header "CONSTANTS"
.ie n .IP $RULE_INVALID_CHARACTER_REGEX 4
.el .IP \f(CW$RULE_INVALID_CHARACTER_REGEX\fR 4
.IX Item "$RULE_INVALID_CHARACTER_REGEX"
A regular expression that will return the first character in the
matched expression that is not valid in a rule.
.SH AUTHOR
.IX Header "AUTHOR"
Jeffrey Ryan Thalhammer  <jeff@imaginative\-software.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2006\-2011 Imaginative Software Systems
.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.