NAME

       Perl::Critic::Theme - Construct thematic sets of policies.

DESCRIPTION

       This is a helper class for evaluating theme expressions into sets of Policy objects.  There are no user-
       serviceable parts here.

INTERFACE SUPPORT

       This is considered to be a non-public class.  Its interface is subject to change without notice.

METHODS

       "new( -rule => $rule_expression )"
           Returns  a  reference  to  a  new  Perl::Critic::Theme  object.   "-rule" is a string expression that
           evaluates to true or false for each Policy..  See "THEME RULES" for more information.

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

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

   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.

       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:

          Operator    Altertative    Example
          ----------------------------------------------------------------
          &&          and            'pbp && core'
          ||          or             'pbp || (bugs && security)'
          !           not            'pbp && ! (portability || complexity)

       See "CONFIGURATION" in Perl::Critic for more information about customizing the themes for each Policy.

SUBROUTINES

       "cook_rule( $rule )"
           Standardize  a  rule  into  almost executable Perl code.  The "almost" comes from the fact that theme
           names are left as is.

CONSTANTS

       $RULE_INVALID_CHARACTER_REGEX
           A regular expression that will return the first character in the matched expression that is not valid
           in a rule.

AUTHOR

       Jeffrey Ryan Thalhammer  <jeff@imaginative-software.com>

COPYRIGHT

       Copyright (c) 2006-2023 Imaginative Software Systems

       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.36.0                                       2023-10-27                           Perl::Critic::Theme(3pm)