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 141
|
package PPI::Statement::Compound;
=pod
=head1 NAME
PPI::Statement::Compound - Describes all compound statements
=head1 INHERITANCE
PPI::Statement::Compound
isa PPI::Statement
isa PPI::Node
isa PPI::Element
=head1 DESCRIPTION
PPI::Statement::Compound objects are used to describe all current forms of
compound statements, as described in L<perlsyn>.
This covers blocks using C<if>, C<unless>, C<for>, C<foreach>, C<while>, and
C<continue>. Please note this does B<not> cover "simple" statements with
trailing conditions. Please note also that "do" is also not part of a
compound statement.
# This is NOT a compound statement
my $foo = 1 if $condition;
# This is also not a compound statement
do { ... } until $condition;
=head1 METHODS
=cut
use strict;
use UNIVERSAL 'isa';
use base 'PPI::Statement';
use vars qw{$VERSION %TYPES};
BEGIN {
$VERSION = '0.903';
# Keyword type map
%TYPES = (
'if' => 'if',
'unless' => 'if',
'while' => 'while',
'for' => 'for',
'foreach' => 'foreach',
);
}
# Lexer clues
sub __LEXER__normal { '' }
#####################################################################
# PPI::Statement::Compound analysis methods
=pod
=head2 type
The C<type> method returns the fundamental type of the compound statement.
There are three basic compound statement types.
The 'if' type includes all vatiations of the if and unless statements,
including any 'elsif' or 'else' parts of the compount statement.
The 'while' type describes the standard while statement, but again does
B<not> describes simple statements with a trailing while.
The 'for' type covers both of 'for' and 'foreach' statements.
All of the compounds are a variation on one of these three.
Returns the simple string 'if', 'for' or 'while', or C<undef> if the type
cannot be determined.
=cut
sub type {
my $self = shift;
my $Element = $self->schild(0);
# A labelled statement
if ( isa($Element, 'PPI::Token::Label') ) {
$Element = $self->schild(1) or return 'label';
}
# Most simple cases
return $TYPES{$Element->content} if isa($Element, 'PPI::Token::Word');
return 'continue' if isa($Element, 'PPI::Structure::Block');
# Unknown (shouldn't exist?)
undef;
}
#####################################################################
# PPI::Node Methods
sub scope {
}
1;
=pod
=head1 TO DO
- Write unit tests for this package
=head1 SUPPORT
See the L<support section|PPI/SUPPORT> in the main module
=head1 AUTHOR
Adam Kennedy (Maintainer), L<http://ali.as/>, cpan@ali.as
=head1 COPYRIGHT
Copyright (c) 2004 - 2005 Adam Kennedy. 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 the license can be found in the
LICENSE file included with this module.
=cut
|