1 package ExtUtils::Packlist;
7 # Used for generating filehandle globs. IO::File might not be available!
13 my $fh = \*{$fhname++};
20 my ($class, $packfile) = @_;
21 $class = ref($class) || $class;
23 tie(%self, $class, $packfile);
24 return(bless(\%self, $class));
29 my ($class, $packfile) = @_;
30 my $self = { packfile => $packfile };
32 $self->read($packfile) if (defined($packfile) && -f $packfile);
38 $_[0]->{data}->{$_[1]} = $_[2];
43 return($_[0]->{data}->{$_[1]});
48 my $reset = scalar(keys(%{$_[0]->{data}}));
49 return(each(%{$_[0]->{data}}));
54 return(each(%{$_[0]->{data}}));
59 return(exists($_[0]->{data}->{$_[1]}));
64 return(delete($_[0]->{data}->{$_[1]}));
69 %{$_[0]->{data}} = ();
78 my ($self, $packfile) = @_;
79 $self = tied(%$self) || $self;
81 if (defined($packfile)) { $self->{packfile} = $packfile; }
82 else { $packfile = $self->{packfile}; }
83 Carp::croak("No packlist filename specified") if (! defined($packfile));
85 open($fh, "<$packfile") || Carp::croak("Can't open file $packfile: $!");
88 while (defined($line = <$fh>))
91 my ($key, @kvs) = split(' ', $line);
92 $key =~ s!/./!/!g; # Some .packlists have spurious '/./' bits in the paths
95 $self->{data}->{$key} = undef;
100 foreach my $kv (@kvs)
102 my ($k, $v) = split('=', $kv);
105 $self->{data}->{$key} = $data;
113 my ($self, $packfile) = @_;
114 $self = tied(%$self) || $self;
115 if (defined($packfile)) { $self->{packfile} = $packfile; }
116 else { $packfile = $self->{packfile}; }
117 Carp::croak("No packlist filename specified") if (! defined($packfile));
119 open($fh, ">$packfile") || Carp::croak("Can't open file $packfile: $!");
120 foreach my $key (sort(keys(%{$self->{data}})))
123 if (ref($self->{data}->{$key}))
125 my $data = $self->{data}->{$key};
126 foreach my $k (sort(keys(%$data)))
128 print $fh (" $k=$data->{$k}");
138 my ($self, $remove) = @_;
139 $self = tied(%$self) || $self;
141 foreach my $key (sort(keys(%{$self->{data}})))
145 push(@missing, $key);
146 delete($self->{data}{$key}) if ($remove);
158 ExtUtils::Packlist - manage .packlist files
162 use ExtUtils::Packlist;
163 my ($pl) = ExtUtils::Packlist->new('.packlist');
164 $pl->read('/an/old/.packlist');
165 my @missing_files = $pl->validate();
166 $pl->write('/a/new/.packlist');
168 $pl->{'/some/file/name'}++;
170 $pl->{'/some/other/file/name'} = { type => 'file',
171 from => '/some/file' };
175 ExtUtils::Packlist provides a standard way to manage .packlist files.
176 Functions are provided to read and write .packlist files. The original
177 .packlist format is a simple list of absolute pathnames, one per line. In
178 addition, this package supports an extended format, where as well as a filename
179 each line may contain a list of attributes in the form of a space separated
180 list of key=value pairs. This is used by the installperl script to
181 differentiate between files and links, for example.
185 The hash reference returned by the new() function can be used to examine and
186 modify the contents of the .packlist. Items may be added/deleted from the
187 .packlist by modifying the hash. If the value associated with a hash key is a
188 scalar, the entry written to the .packlist by any subsequent write() will be a
189 simple filename. If the value is a hash, the entry written will be the
190 filename followed by the key=value pairs from the hash. Reading back the
191 .packlist will recreate the original entries.
199 This takes an optional parameter, the name of a .packlist. If the file exists,
200 it will be opened and the contents of the file will be read. The new() method
201 returns a reference to a hash. This hash holds an entry for each line in the
202 .packlist. In the case of old-style .packlists, the value associated with each
203 key is undef. In the case of new-style .packlists, the value associated with
204 each key is a hash containing the key=value pairs following the filename in the
209 This takes an optional parameter, the name of the .packlist to be read. If
210 no file is specified, the .packlist specified to new() will be read. If the
211 .packlist does not exist, Carp::croak will be called.
215 This takes an optional parameter, the name of the .packlist to be written. If
216 no file is specified, the .packlist specified to new() will be overwritten.
220 This checks that every file listed in the .packlist actually exists. If an
221 argument which evaluates to true is given, any missing files will be removed
222 from the internal hash. The return value is a list of the missing files, which
223 will be empty if they all exist.
229 Alan Burlison <Alan.Burlison@uk.sun.com>