The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

ELLIOTJS / Perl-Critic-1.083_004 / lib / Perl / Critic / Utils / PPI.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
—
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

              
##############################################################################
#      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Utils/PPI.pm $
#     $Date: 2008-05-18 18:49:57 -0500 (Sun, 18 May 2008) $
#   $Author: clonezone $
# $Revision: 2367 $
##############################################################################
package Perl::Critic::Utils::PPI;
use strict;
use warnings;
use base 'Exporter';
our $VERSION = '1.083_004';
#-----------------------------------------------------------------------------
our @EXPORT_OK = qw(
    is_ppi_expression_or_generic_statement
    is_ppi_generic_statement
    is_ppi_statement_subclass
);
our %EXPORT_TAGS = (
    all => \@EXPORT_OK,
);
#-----------------------------------------------------------------------------
sub is_ppi_expression_or_generic_statement {
    my $element = shift;
    my $element_class = ref $element;
    return 0 if not $element_class;
    return 0 if not $element->isa('PPI::Statement');
    return 1 if $element->isa('PPI::Statement::Expression');
    return $element_class eq 'PPI::Statement';
}
#-----------------------------------------------------------------------------
sub is_ppi_generic_statement {
    my $element = shift;
    my $element_class = ref $element;
    return 0 if not $element_class;
    return 0 if not $element->isa('PPI::Statement');
    return $element_class eq 'PPI::Statement';
}
#-----------------------------------------------------------------------------
sub is_ppi_statement_subclass {
    my $element = shift;
    my $element_class = ref $element;
    return 0 if not $element_class;
    return 0 if not $element->isa('PPI::Statement');
    return $element_class ne 'PPI::Statement';
}
1;
__END__
#-----------------------------------------------------------------------------
=pod
=for stopwords
=head1 NAME
Perl::Critic::Utils::PPI - Utility functions for dealing with PPI objects.
=head1 DESCRIPTION
Provides classification of L<PPI::Elements>.
=head1 IMPORTABLE SUBS
=over
=item C<is_ppi_expression_or_generic_statement( $element )>
Answers whether the parameter is an expression or an undifferentiated
statement.  I.e. the parameter either is a
L<PPI::Statement::Expression> or the class of the parameter is
L<PPI::Statement> and not one of its subclasses other than
C<Expression>.
=item C<is_ppi_generic_statement( $element )>
Answers whether the parameter is an undifferentiated statement, i.e.
the parameter is a L<PPI::Statement> but not one of its subclasses.
=item C<is_ppi_statement_subclass( $element )>
Answers whether the parameter is a specialized statement, i.e. the
parameter is a L<PPI::Statement> but the class of the parameter is not
L<PPI::Statement>.
=back
=head1 AUTHOR
Elliot Shank <perl@galumph.com>
=head1 COPYRIGHT
Copyright (c) 2007-2008 Elliot Shank.  All 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.
=cut
# Local Variables:
#   mode: cperl
#   cperl-indent-level: 4
#   fill-column: 78
#   indent-tabs-mode: nil
#   c-indentation-style: bsd
# End:
# ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :