From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

FLORA / IO-Dir-Recursive-0.03 / lib / IO / Dir / Recursive.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
137
138
139
140
141
142
143
144
145
146
147
148
—
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

              
package IO::Dir::Recursive;
use strict;
use warnings;
use Symbol;
use IO::All;
use IO::Dir qw(DIR_UNLINK);
use File::Spec;
our @ISA = qw(IO::Dir);
our $VERSION = '0.03';
=head1 NAME
IO::Dir::Recursive - IO::Dir working recursive
=head1 SYNOPSIS
  use IO::Dir::Recursive;
   
  my $dh = IO::Dir::Recursive->new('.');
  print "$_\n" while $dh->read();
  tie my %dir, 'IO::Dir::Recursive', '.';
   
  print $dir{subdir1}->{subdir2}->{file}->slurp();
=head1 DESCRIPTION
IO::Dir::Recursive gives IO::Dir the ability to work recursive.
=head1 EXPORT
The following constans may be imported on request.
=over 2
=item * DIR_NOUPWARDS
This constant can be passed as option to tie to strip out parent directories.
=item * DIR_UNLINK
This is inherited from IO::Dir. Deleting an element from the hash will delete
the corresponding file or subdirectory if this constant is passed as a tie
option.
=cut
our @EXPORT_OK = qw(DIR_NOUPWARDS);
sub DIR_NOUPWARDS () { 2 }
=head1 METHODS
IO::Dir::Recursive inherits from IO::Dir and therefor inherits all its methods
with the following exceptions.
=head2 read 
 my $item = $dh->read();
Reads the next item in $dh and returns the coresponding object for the item: an
IO::Dir::Recursive instance for directories, an IO::All instance for files or
undef if there are no other items left.
=cut
sub read {
        my $dh = shift;
        return $dh->_create_io_obj(scalar $dh->_read(@_));
}
=head2 _read
 my $next = $dh->_read();
Same as read() above, but returns a string describing the next item instead of
an object. Mainly for internal use, but maybe it's useful in some other places,
too.
=cut
sub _read {
        my $dh = shift;
        return $dh->SUPER::read();
}
sub _create_io_obj {
        my ($dh, $key) = @_;
        return undef unless $key;
        return $dh if $key eq '.';
        my $file = File::Spec->catdir(${*$dh}{io_dir_path}, $key);
        return IO::Dir::Recursive->new(File::Spec->updir($file)) if $key eq '..';
        if (-d $file) {
                tie my %subdir, 'IO::Dir::Recursive', $file, (${*$dh}{io_dir_unlink} | ${*$dh}{io_dir_noupwards});
                return \%subdir;
        }
        $file = File::Spec->catfile(${*$dh}{io_dir_path}, $key);
        return IO::All->new($file) if -e $file;
        return undef;
}
sub TIEHASH {
        my ($class, $dir, $options) = @_;
         
        my $dh = $class->new($dir) or return undef;
         
        $options ||= 0;
        ${*$dh}{io_dir_unlink} = $options & DIR_UNLINK;
        ${*$dh}{io_dir_noupwards} = $options & DIR_NOUPWARDS;
        return $dh;
}
sub FIRSTKEY {
        my $dh = shift;
        $dh->rewind();
        my $key = $dh->_read(@_);
        return undef unless defined $key;
        while (${*$dh}{io_dir_noupwards} && defined $key && ($key eq '.' || $key eq '..')) {
                $key = $dh->NEXTKEY(@_);
        }
        return $key;
}
sub NEXTKEY {
        my $dh = shift;
        my $key;
        {
                $key = $dh->_read(@_);
                return undef unless defined $key;
                redo if ${*$dh}{io_dir_noupwards} && ($key eq '.' || $key eq '..');
        }
        return $key;
}
sub FETCH {
        my ($dh, $key) = @_;
        $dh->_create_io_obj($key);
}
1;
=head1 SEE ALSO
L<IO::Dir>, L<IO::All>
=head1 AUTHOR
Florian Ragwitz, E<lt>flora@cpan.orgE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2005 by Florian Ragwitz
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.7 or,
at your option, any later version of Perl 5 you may have available.
=cut