local-lib5/lib/perl5/PPI/Statement/Break.pm

   1 package PPI::Statement::Break;
   2
   3 =pod
   4
   5 =head1 NAME
   6
   7 PPI::Statement::Break - Statements which break out of normal statement flow
   8
   9 =head1 SYNOPSIS
  10
  11   last;
  12   goto FOO;
  13   next if condition();
  14   return $foo;
  15   redo;
  16
  17 =head1 INHERITANCE
  18
  19   PPI::Statement::Break
  20   isa PPI::Statement
  21       isa PPI::Node
  22           isa PPI::Element
  23
  24 =head1 DESCRIPTION
  25
  26 C<PPI::Statement::Break> is intended to represent statements that break
  27 out of the normal statement flow control. This covers the basic
  28 types C<'redo'>, C<'goto'>, C<'next'>, C<'last'> and C<'return'>.
  29
  30 =head1 METHODS
  31
  32 C<PPI::Statement::Break> has no additional methods beyond the default ones
  33 provided by L<PPI::Statement>, L<PPI::Node> and L<PPI::Element>.
  34
  35 However, it is expected to gain methods for identifying the line to break
  36 to, or the structure to break out of.
  37
  38 =cut
  39
  40 use strict;
  41 use PPI::Statement ();
  42
  43 use vars qw{$VERSION @ISA};
  44 BEGIN {
  45         $VERSION = '1.206';
  46         @ISA     = 'PPI::Statement';
  47 }
  48
  49 1;
  50
  51 =pod
  52
  53 =head1 TO DO
  54
  55 - Add the methods to identify the break target
  56
  57 - Add some proper unit testing
  58
  59 =head1 SUPPORT
  60
  61 See the L<support section|PPI/SUPPORT> in the main module.
  62
  63 =head1 AUTHOR
  64
  65 Adam Kennedy E<lt>adamk@cpan.orgE<gt>
  66
  67 =head1 COPYRIGHT
  68
  69 Copyright 2001 - 2009 Adam Kennedy.
  70
  71 This program is free software; you can redistribute
  72 it and/or modify it under the same terms as Perl itself.
  73
  74 The full text of the license can be found in the
  75 LICENSE file included with this module.
  76
  77 =cut