DirHandle.pm 2.04 KB
Newer Older
1 2
package DirHandle;

3
our $VERSION = '1.05';
4

5 6
=head1 NAME 

7
DirHandle - (obsolete) supply object methods for directory handles
8 9 10

=head1 SYNOPSIS

11 12 13 14 15 16 17 18
    # recommended approach since Perl 5.6: do not use DirHandle
    if (opendir my $d, '.') {
        while (readdir $d) { something($_); }
        rewind $d;
        while (readdir $d) { something_else($_); }
    }

    # how you would use this module if you were going to
19
    use DirHandle;
20
    if (my $d = DirHandle->new(".")) {
21 22 23 24 25 26 27
        while (defined($_ = $d->read)) { something($_); }
        $d->rewind;
        while (defined($_ = $d->read)) { something_else($_); }
    }

=head1 DESCRIPTION

28 29
B<There is no reason to use this module nowadays.>

30 31 32
The C<DirHandle> method provide an alternative interface to the
opendir(), closedir(), readdir(), and rewinddir() functions.

33 34 35 36 37
Up to Perl 5.5, opendir() could not autovivify a directory handle from
C<undef>, so using a lexical handle required using a function from L<Symbol>
to create an anonymous glob, which took a separate step.
C<DirHandle> encapsulates this, which allowed cleaner code than opendir().
Since Perl 5.6, opendir() alone has been all you need for lexical handles.
38 39 40 41 42 43 44 45

=cut

require 5.000;
use Carp;
use Symbol;

sub new {
46
    @_ >= 1 && @_ <= 2 or croak 'usage: DirHandle->new( [DIRNAME] )';
47 48 49 50 51 52 53 54 55 56 57
    my $class = shift;
    my $dh = gensym;
    if (@_) {
	DirHandle::open($dh, $_[0])
	    or return undef;
    }
    bless $dh, $class;
}

sub DESTROY {
    my ($dh) = @_;
58 59
    # Don't warn about already being closed as it may have been closed 
    # correctly, or maybe never opened at all.
60
    local($., $@, $!, $^E, $?);
61
    no warnings 'io';
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
    closedir($dh);
}

sub open {
    @_ == 2 or croak 'usage: $dh->open(DIRNAME)';
    my ($dh, $dirname) = @_;
    opendir($dh, $dirname);
}

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 rewind {
    @_ == 1 or croak 'usage: $dh->rewind()';
    my ($dh) = @_;
    rewinddir($dh);
}

1;