# IO::Dir.pm## Copyright (c) 1997-8 Graham Barr <gbarr@pobox.com>. All rights reserved.# This program is free software; you can redistribute it and/or# modify it under the same terms as Perl itself.package IO::Dir;use 5.003_26;use strict;use Carp;use Symbol;use Exporter;use IO::File;our(@ISA, $VERSION, @EXPORT_OK);use Tie::Hash;use File::stat;@ISA = qw(Tie::Hash Exporter);$VERSION = "1.03";@EXPORT_OK = qw(DIR_UNLINK);sub DIR_UNLINK () { 1 }sub new {    @_ >= 1 && @_ <= 2 or croak 'usage: new IO::Dir [DIRNAME]';    my $class = shift;    my $dh = gensym;    if (@_) {	IO::Dir::open($dh, $_[0])	    or return undef;    }    bless $dh, $class;}sub DESTROY {    my ($dh) = @_;    closedir($dh);}sub open {    @_ == 2 or croak 'usage: $dh->open(DIRNAME)';    my ($dh, $dirname) = @_;    return undef	unless opendir($dh, $dirname);    ${*$dh}{io_dir_path} = $dirname;    1;}sub close {    @_ == 1 or croak 'usage: $dh->close()';    my ($dh) = @_;    closedir($dh);}sub read {    @_ == 1 or croak 'usage: $dh->read()';    my ($dh) = @_;    readdir($dh);}sub seek {    @_ == 2 or croak 'usage: $dh->seek(POS)';    my ($dh,$pos) = @_;    seekdir($dh,$pos);}sub tell {    @_ == 1 or croak 'usage: $dh->tell()';    my ($dh) = @_;    telldir($dh);}sub rewind {    @_ == 1 or croak 'usage: $dh->rewind()';    my ($dh) = @_;    rewinddir($dh);}sub TIEHASH {    my($class,$dir,$options) = @_;    my $dh = $class->new($dir)	or return undef;    $options ||= 0;    ${*$dh}{io_dir_unlink} = $options & DIR_UNLINK;    $dh;}sub FIRSTKEY {    my($dh) = @_;    $dh->rewind;    scalar $dh->read;}sub NEXTKEY {    my($dh) = @_;    scalar $dh->read;}sub EXISTS {    my($dh,$key) = @_;    -e ${*$dh}{io_dir_path} . "/" . $key;}sub FETCH {    my($dh,$key) = @_;    &lstat(${*$dh}{io_dir_path} . "/" . $key);}sub STORE {    my($dh,$key,$data) = @_;    my($atime,$mtime) = ref($data) ? @$data : ($data,$data);    my $file = ${*$dh}{io_dir_path} . "/" . $key;    unless(-e $file) {	my $io = IO::File->new($file,O_CREAT | O_RDWR);	$io->close if $io;    }    utime($atime,$mtime, $file);}sub DELETE {    my($dh,$key) = @_;    # Only unlink if unlink-ing is enabled    my $file = ${*$dh}{io_dir_path} . "/" . $key;    return 0	unless ${*$dh}{io_dir_unlink};    -d $file	? rmdir($file)	: unlink($file);}1;__END__=head1 NAME IO::Dir - supply object methods for directory handles=head1 SYNOPSIS    use IO::Dir;    $d = new IO::Dir ".";    if (defined $d) {        while (defined($_ = $d->read)) { something($_); }        $d->rewind;        while (defined($_ = $d->read)) { something_else($_); }        undef $d;    }    tie %dir, IO::Dir, ".";    foreach (keys %dir) {	print $_, " " , $dir{$_}->size,"\n";    }=head1 DESCRIPTIONThe C<IO::Dir> package provides two interfaces to perl's directory readingroutines.The first interface is an object approach. C<IO::Dir> provides an objectconstructor and methods, which are just wrappers around perl's built indirectory reading routines.=over 4=item new ( [ DIRNAME ] )C<new> is the constuctor for C<IO::Dir> objects. It accepts one optionalargument which,  if given, C<new> will pass to C<open>=backThe following methods are wrappers for the directory related functions builtinto perl (the trailing `dir' has been removed from the names). See L<perlfunc>for details of these functions.=over 4=item open ( DIRNAME )=item read ()=item seek ( POS )=item tell ()=item rewind ()=item close ()=backC<IO::Dir> also provides a interface to reading directories via a tiedHASH. The tied HASH extends the interface beyond just the directoryreading routines by the use of C<lstat>, from the C<File::stat> package,C<unlink>, C<rmdir> and C<utime>.=over 4=item tie %hash, IO::Dir, DIRNAME [, OPTIONS ]=backThe keys of the HASH will be the names of the entries in the directory. Reading a value from the hash will be the result of callingC<File::stat::lstat>. Deleting an element from the hash will call C<unlink>providing that C<DIR_UNLINK> is passed in the C<OPTIONS>.Assigning to an entry in the HASH will cause the time stamps of the fileto be modified. If the file does not exist then it will be created. Assigninga single integer to a HASH element will cause both the access and modification times to be changed to that value. Alternatively a reference toan array of two values can be passed. The first array element will be used toset the access time and the second element will be used to set the modificationtime.=head1 SEE ALSOL<File::stat>=head1 AUTHORGraham Barr. Currently maintained by the Perl Porters.  Please report allbugs to <perl5-porters@perl.org>.=head1 COPYRIGHTCopyright (c) 1997-8 Graham Barr <gbarr@pobox.com>. All rights reserved.This program is free software; you can redistribute it and/ormodify it under the same terms as Perl itself.=cut