PPI::Statement::Compound - Describes all compound statements
# A compound if statement if ( foo ) { bar(); } else { baz(); } # A compound loop statement foreach ( @list ) { bar($_); }
PPI::Statement::Compound isa PPI::Statement isa PPI::Node isa PPI::Element
PPI::Statement::Compound
objects are used to describe all current forms
of compound statements, as described in perlsyn.
This covers blocks using if
, unless
, for
, foreach
, while
,
and continue
. Please note this does 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;
PPI::Statement::Compound
has a number of methods in addition to the
standard PPI::Statement, PPI::Node and PPI::Element methods.
The type
method returns the syntactic type of the compound statement.
There are three basic compound statement types.
The 'if'
type includes all variations of the if and unless statements,
including any 'elsif'
or 'else'
parts of the compound statement.
The 'while'
type describes the standard while statement, but again does
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 undef
if the type
cannot be determined.
- Write unit tests for this package
See the support section in the main module.
Adam Kennedy <adamk@cpan.org>
Copyright 2001 - 2008 Adam Kennedy.
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.