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

   1 package PPI::Statement::Data;
   2
   3 =pod
   4
   5 =head1 NAME
   6
   7 PPI::Statement::Data - The __DATA__ section of a file
   8
   9 =head1 SYNOPSIS
  10
  11   # Normal content
  12
  13   __DATA__
  14   This: data
  15   is: part
  16   of: the
  17   PPI::Statement::Data: object
  18
  19 =head1 INHERITANCE
  20
  21   PPI::Statement::Compound
  22   isa PPI::Statement
  23       isa PPI::Node
  24           isa PPI::Element
  25
  26 =head1 DESCRIPTION
  27
  28 C<PPI::Statement::Data> is a utility class designed to hold content in
  29 the __DATA__ section of a file. It provides a single statement to hold
  30 B<all> of the data.
  31
  32 =head1 METHODS
  33
  34 C<PPI::Statement::Data> has no additional methods beyond the default ones
  35 provided by L<PPI::Statement>, L<PPI::Node> and L<PPI::Element>.
  36
  37 However, it is expected to gain methods for accessing the data directly,
  38 (as a filehandle for example) just as you would access the data in the
  39 Perl code itself.
  40
  41 =cut
  42
  43 use strict;
  44 use PPI::Statement ();
  45
  46 use vars qw{$VERSION @ISA};
  47 BEGIN {
  48         $VERSION = '1.206';
  49         @ISA     = 'PPI::Statement';
  50 }
  51
  52 # Data is never complete
  53 sub _complete () { '' }
  54
  55 1;
  56
  57 =pod
  58
  59 =head1 TO DO
  60
  61 - Add the methods to read in the data
  62
  63 - Add some proper unit testing
  64
  65 =head1 SUPPORT
  66
  67 See the L<support section|PPI/SUPPORT> in the main module.
  68
  69 =head1 AUTHOR
  70
  71 Adam Kennedy E<lt>adamk@cpan.orgE<gt>
  72
  73 =head1 COPYRIGHT
  74
  75 Copyright 2001 - 2009 Adam Kennedy.
  76
  77 This program is free software; you can redistribute
  78 it and/or modify it under the same terms as Perl itself.
  79
  80 The full text of the license can be found in the
  81 LICENSE file included with this module.
  82
  83 =cut