NAME

PPI::Statement::Compound - Describes all compound statements

SYNOPSIS

  # A compound if statement
  if ( foo ) {
      bar();
  } else {
      baz();
  }

  # A compound loop statement
  foreach ( @list ) {
      bar($_);
  }

INHERITANCE

  PPI::Statement::Compound
  isa PPI::Statement
      isa PPI::Node
          isa PPI::Element

DESCRIPTION

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;

METHODS

PPI::Statement::Compound has a number of methods in addition to the standard PPI::Statement, PPI::Node and PPI::Element methods.

type

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 the C-style for loops, regardless of whether they were declared using 'for' or 'foreach'.

The 'foreach' type covers loops that iterate over collections, regardless of whether they were declared using 'for' or 'foreach'.

All of the compounds are a variation on one of these three.

Returns the simple string 'if', 'for', 'foreach' or 'while', or undef if the type cannot be determined.

my $Document = PPI::Document->new(\<<'END_PERL'); while (1) { } until (1) { } LABEL: while (1) { } LABEL: until (1) { }

if (1) { } unless (1) { }

       for              (@foo) { }
       foreach          (@foo) { }
       for     $x       (@foo) { }
       foreach $x       (@foo) { }
       for     my $x    (@foo) { }
       foreach my $x    (@foo) { }
       for     state $x (@foo) { }
       foreach state $x (@foo) { }
LABEL: for              (@foo) { }
LABEL: foreach          (@foo) { }
LABEL: for     $x       (@foo) { }
LABEL: foreach $x       (@foo) { }
LABEL: for     my $x    (@foo) { }
LABEL: foreach my $x    (@foo) { }
LABEL: for     state $x (@foo) { }
LABEL: foreach state $x (@foo) { }

       for              qw{foo} { }
       foreach          qw{foo} { }
       for     $x       qw{foo} { }
       foreach $x       qw{foo} { }
       for     my $x    qw{foo} { }
       foreach my $x    qw{foo} { }
       for     state $x qw{foo} { }
       foreach state $x qw{foo} { }
LABEL: for              qw{foo} { }
LABEL: foreach          qw{foo} { }
LABEL: for     $x       qw{foo} { }
LABEL: foreach $x       qw{foo} { }
LABEL: for     my $x    qw{foo} { }
LABEL: foreach my $x    qw{foo} { }
LABEL: for     state $x qw{foo} { }
LABEL: foreach state $x qw{foo} { }

       for     (             ;       ;     ) { }
       foreach (             ;       ;     ) { }
       for     ($x = 0       ; $x < 1; $x++) { }
       foreach ($x = 0       ; $x < 1; $x++) { }
       for     (my $x = 0    ; $x < 1; $x++) { }
       foreach (my $x = 0    ; $x < 1; $x++) { }
LABEL: for     (             ;       ;     ) { }
LABEL: foreach (             ;       ;     ) { }
LABEL: for     ($x = 0       ; $x < 1; $x++) { }
LABEL: foreach ($x = 0       ; $x < 1; $x++) { }
LABEL: for     (my $x = 0    ; $x < 1; $x++) { }
LABEL: foreach (my $x = 0    ; $x < 1; $x++) { }
END_PERL
isa_ok( $Document, 'PPI::Document' );

my $statements = $Document->find('Statement::Compound'); is( scalar @{$statements}, 50, 'Found the 50 test statements' );

is( $statements->[0]->type(), 'while', q<Type of while is "while"> ); is( $statements->[1]->type(), 'while', q<Type of until is "while"> ); is( $statements->[2]->type(), 'while', q<Type of while with label is "while"> ); is( $statements->[3]->type(), 'while', q<Type of until with label is "while"> ); is( $statements->[4]->type(), 'if', q<Type of if is "if"> ); is( $statements->[5]->type(), 'if', q<Type of unless is "if"> );

foreach my $index (6..37) { my $statement = $statements->[$index]; is( $statement->type(), 'foreach', qq<Type is "foreach": $statement> ); }

foreach my $index (38..49) { my $statement = $statements->[$index]; is( $statement->type(), 'for', qq<Type is "for": $statement> ); }

TO DO

- Write unit tests for this package

SUPPORT

See the support section in the main module.

AUTHOR

Adam Kennedy <adamk@cpan.org>

COPYRIGHT

Copyright 2001 - 2009 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.