.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PPI::Statement::Compound 3pm"
.TH PPI::Statement::Compound 3pm "2019-07-21" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
PPI::Statement::Compound \- Describes all compound statements
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&  # A compound if statement
\&  if ( foo ) {
\&      bar();
\&  } else {
\&      baz();
\&  }
\&
\&  # A compound loop statement
\&  foreach ( @list ) {
\&      bar($_);
\&  }
.Ve
.SH "INHERITANCE"
.IX Header "INHERITANCE"
.Vb 4
\&  PPI::Statement::Compound
\&  isa PPI::Statement
\&      isa PPI::Node
\&          isa PPI::Element
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`PPI::Statement::Compound\*(C'\fR objects are used to describe all current forms
of compound statements, as described in perlsyn.
.PP
This covers blocks using \f(CW\*(C`if\*(C'\fR, \f(CW\*(C`unless\*(C'\fR, \f(CW\*(C`for\*(C'\fR, \f(CW\*(C`foreach\*(C'\fR, \f(CW\*(C`while\*(C'\fR,
and \f(CW\*(C`continue\*(C'\fR. Please note this does \fBnot\fR cover \*(L"simple\*(R" statements
with trailing conditions. Please note also that \*(L"do\*(R" is also not part of
a compound statement.
.PP
.Vb 2
\&  # This is NOT a compound statement
\&  my $foo = 1 if $condition;
\&
\&  # This is also not a compound statement
\&  do { ... } until $condition;
.Ve
.SH "METHODS"
.IX Header "METHODS"
\&\f(CW\*(C`PPI::Statement::Compound\*(C'\fR has a number of methods in addition to the
standard PPI::Statement, PPI::Node and PPI::Element methods.
.SS "type"
.IX Subsection "type"
The \f(CW\*(C`type\*(C'\fR method returns the syntactic type of the compound statement.
.PP
There are four basic compound statement types.
.PP
The \f(CW\*(Aqif\*(Aq\fR type includes all variations of the if and unless statements,
including any \f(CW\*(Aqelsif\*(Aq\fR or \f(CW\*(Aqelse\*(Aq\fR parts of the compound statement.
.PP
The \f(CW\*(Aqwhile\*(Aq\fR type describes the standard while and until statements, but
again does \fBnot\fR describes simple statements with a trailing while.
.PP
The \f(CW\*(Aqfor\*(Aq\fR type covers the C\-style for loops, regardless of whether they
were declared using \f(CW\*(Aqfor\*(Aq\fR or \f(CW\*(Aqforeach\*(Aq\fR.
.PP
The \f(CW\*(Aqforeach\*(Aq\fR type covers loops that iterate over collections,
regardless of whether they were declared using \f(CW\*(Aqfor\*(Aq\fR or \f(CW\*(Aqforeach\*(Aq\fR.
.PP
All of the compounds are a variation on one of these four.
.PP
Returns the simple string \f(CW\*(Aqif\*(Aq\fR, \f(CW\*(Aqfor\*(Aq\fR, \f(CW\*(Aqforeach\*(Aq\fR or \f(CW\*(Aqwhile\*(Aq\fR,
or \f(CW\*(C`undef\*(C'\fR if the type cannot be determined.
.SH "TO DO"
.IX Header "TO DO"
\&\- Write unit tests for this package
.SH "SUPPORT"
.IX Header "SUPPORT"
See the support section in the main module.
.SH "AUTHOR"
.IX Header "AUTHOR"
Adam Kennedy <adamk@cpan.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2001 \- 2011 Adam Kennedy.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.