3 # Copyright (c) 1997-8 Graham Barr <gbarr@pobox.com>. All rights reserved.
4 # This program is free software; you can redistribute it and/or
5 # modify it under the same terms as Perl itself.
16 our(@ISA, $VERSION, @EXPORT_OK);
21 @ISA = qw(Tie::Hash Exporter);
23 $VERSION = eval $VERSION;
24 @EXPORT_OK = qw(DIR_UNLINK);
26 sub DIR_UNLINK () { 1 }
29 @_ >= 1 && @_ <= 2 or croak 'usage: new IO::Dir [DIRNAME]';
33 IO::Dir::open($dh, $_[0])
45 @_ == 2 or croak 'usage: $dh->open(DIRNAME)';
46 my ($dh, $dirname) = @_;
48 unless opendir($dh, $dirname);
49 # a dir name should always have a ":" in it; assume dirname is
50 # in current directory
51 $dirname = ':' . $dirname if ( ($^O eq 'MacOS') && ($dirname !~ /:/) );
52 ${*$dh}{io_dir_path} = $dirname;
57 @_ == 1 or croak 'usage: $dh->close()';
63 @_ == 1 or croak 'usage: $dh->read()';
69 @_ == 2 or croak 'usage: $dh->seek(POS)';
75 @_ == 1 or croak 'usage: $dh->tell()';
81 @_ == 1 or croak 'usage: $dh->rewind()';
87 my($class,$dir,$options) = @_;
89 my $dh = $class->new($dir)
94 ${*$dh}{io_dir_unlink} = $options & DIR_UNLINK;
111 -e File::Spec->catfile(${*$dh}{io_dir_path}, $key);
116 &lstat(File::Spec->catfile(${*$dh}{io_dir_path}, $key));
120 my($dh,$key,$data) = @_;
121 my($atime,$mtime) = ref($data) ? @$data : ($data,$data);
122 my $file = File::Spec->catfile(${*$dh}{io_dir_path}, $key);
124 my $io = IO::File->new($file,O_CREAT | O_RDWR);
127 utime($atime,$mtime, $file);
133 # Only unlink if unlink-ing is enabled
135 unless ${*$dh}{io_dir_unlink};
137 my $file = File::Spec->catfile(${*$dh}{io_dir_path}, $key);
150 IO::Dir - supply object methods for directory handles
155 $d = IO::Dir->new(".");
157 while (defined($_ = $d->read)) { something($_); }
159 while (defined($_ = $d->read)) { something_else($_); }
163 tie %dir, 'IO::Dir', ".";
164 foreach (keys %dir) {
165 print $_, " " , $dir{$_}->size,"\n";
170 The C<IO::Dir> package provides two interfaces to perl's directory reading
173 The first interface is an object approach. C<IO::Dir> provides an object
174 constructor and methods, which are just wrappers around perl's built in
175 directory reading routines.
179 =item new ( [ DIRNAME ] )
181 C<new> is the constructor for C<IO::Dir> objects. It accepts one optional
182 argument which, if given, C<new> will pass to C<open>
186 The following methods are wrappers for the directory related functions built
187 into perl (the trailing `dir' has been removed from the names). See L<perlfunc>
188 for details of these functions.
192 =item open ( DIRNAME )
206 C<IO::Dir> also provides an interface to reading directories via a tied
207 hash. The tied hash extends the interface beyond just the directory
208 reading routines by the use of C<lstat>, from the C<File::stat> package,
209 C<unlink>, C<rmdir> and C<utime>.
213 =item tie %hash, 'IO::Dir', DIRNAME [, OPTIONS ]
217 The keys of the hash will be the names of the entries in the directory.
218 Reading a value from the hash will be the result of calling
219 C<File::stat::lstat>. Deleting an element from the hash will
220 delete the corresponding file or subdirectory,
221 provided that C<DIR_UNLINK> is included in the C<OPTIONS>.
223 Assigning to an entry in the hash will cause the time stamps of the file
224 to be modified. If the file does not exist then it will be created. Assigning
225 a single integer to a hash element will cause both the access and
226 modification times to be changed to that value. Alternatively a reference to
227 an array of two values can be passed. The first array element will be used to
228 set the access time and the second element will be used to set the modification
237 Graham Barr. Currently maintained by the Perl Porters. Please report all
238 bugs to <perl5-porters@perl.org>.
242 Copyright (c) 1997-2003 Graham Barr <gbarr@pobox.com>. All rights reserved.
243 This program is free software; you can redistribute it and/or
244 modify it under the same terms as Perl itself.