The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

MITHALDU / PPI-1.281 / lib / PPI / Document / File.pm 

            

              
1
—
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
—
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
—
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
—
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

              
package PPI::Document::File;
=pod
=head1 NAME
PPI::Document::File - A Perl Document located in a specific file
=head1 DESCRIPTION
B<WARNING: This class is experimental, and may change without notice>
B<PPI::Document::File> provides a L<PPI::Document> subclass that represents
a Perl document stored in a specific named file.
=head1 METHODS
=cut
use strict;
use Carp          ();
use Params::Util  qw{_STRING _INSTANCE};
use PPI::Document ();
our $VERSION = '1.281';
our @ISA = 'PPI::Document';
#####################################################################
# Constructor and Accessors
=pod
=head2 new
  my $file = PPI::Document::File->new( 'Module.pm' );
The C<new> constructor works the same as for the regular one, except
that the only params allowed is a file name. You cannot create an
"anonymous" PPI::Document::File object, not can you create an empty one.
Returns a new PPI::Document::File object, or C<undef> on error.
=cut
sub new {
        my $class    = shift;
        my $filename = _STRING(shift);
        unless ( defined $filename ) {
                # Perl::Critic got a complaint about not handling a file
                # named "0".
                return $class->_error("Did not provide a file name to load");
        }
        # Load the Document
        my $self = $class->SUPER::new( $filename, @_ ) or return undef;
        # Unlike a normal inheritance situation, due to our need to stay
        # compatible with caching magic, this actually returns a regular
        # anonymous document. We need to rebless if
        if ( _INSTANCE($self, 'PPI::Document') ) {
                bless $self, 'PPI::Document::File';
        } else {
                die "PPI::Document::File SUPER call returned an object of the wrong type";
        }
        $self;
}
=pod
=head2 save
  # Save to the file we were loaded from
  $file->save;
   
  # Save a copy to somewhere else
  $file->save( 'Module2.pm' );
The C<save> method works similarly to the one in the parent L<PPI::Document>
class, saving a copy of the document to a file.
The difference with this subclass is that if C<save> is not passed any
filename, it will save it back to the file it was loaded from.
Note: When saving to a different file, it is considered to be saving a
B<copy> and so the value returned by the C<filename> accessor will stay
the same, and not change to the new filename.
=cut
sub save {
        my $self = shift;
        # Save to where?
        my $filename = shift;
        unless ( defined $filename ) {
                $filename = $self->filename;
        }
        # Hand off to main save method
        $self->SUPER::save( $filename, @_ );
}
1;
=pod
=head1 TO DO
- May need to overload some methods to forcefully prevent Document
objects becoming children of another Node.
=head1 SUPPORT
See the L<support section|PPI/SUPPORT> in the main module.
=head1 AUTHOR
Adam Kennedy E<lt>adamk@cpan.orgE<gt>
=head1 COPYRIGHT
Copyright 2001 - 2011 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.
=cut