Commit | Line | Data |
36477c24 |
1 | package File::stat; |
2 | use strict; |
3 | |
17f410f9 |
4 | use 5.005_64; |
5 | our(@EXPORT, @EXPORT_OK, %EXPORT_TAGS); |
6 | |
36477c24 |
7 | BEGIN { |
8 | use Exporter (); |
36477c24 |
9 | @EXPORT = qw(stat lstat); |
10 | @EXPORT_OK = qw( $st_dev $st_ino $st_mode |
11 | $st_nlink $st_uid $st_gid |
12 | $st_rdev $st_size |
13 | $st_atime $st_mtime $st_ctime |
14 | $st_blksize $st_blocks |
15 | ); |
16 | %EXPORT_TAGS = ( FIELDS => [ @EXPORT_OK, @EXPORT ] ); |
17 | } |
d8574e8f |
18 | use vars @EXPORT_OK; |
36477c24 |
19 | |
8cc95fdb |
20 | # Class::Struct forbids use of @ISA |
21 | sub import { goto &Exporter::import } |
22 | |
23 | use Class::Struct qw(struct); |
36477c24 |
24 | struct 'File::stat' => [ |
25 | map { $_ => '$' } qw{ |
26 | dev ino mode nlink uid gid rdev size |
27 | atime mtime ctime blksize blocks |
28 | } |
29 | ]; |
30 | |
31 | sub populate (@) { |
32 | return unless @_; |
33 | my $stob = new(); |
34 | @$stob = ( |
35 | $st_dev, $st_ino, $st_mode, $st_nlink, $st_uid, $st_gid, $st_rdev, |
36 | $st_size, $st_atime, $st_mtime, $st_ctime, $st_blksize, $st_blocks ) |
37 | = @_; |
38 | return $stob; |
39 | } |
40 | |
14d597e2 |
41 | sub lstat ($) { populate(CORE::lstat(shift)) } |
36477c24 |
42 | |
43 | sub stat ($) { |
44 | my $arg = shift; |
45 | my $st = populate(CORE::stat $arg); |
46 | return $st if $st; |
47 | no strict 'refs'; |
48 | require Symbol; |
49 | return populate(CORE::stat \*{Symbol::qualify($arg)}); |
50 | } |
51 | |
52 | 1; |
53 | __END__ |
54 | |
55 | =head1 NAME |
56 | |
2ae324a7 |
57 | File::stat - by-name interface to Perl's built-in stat() functions |
36477c24 |
58 | |
59 | =head1 SYNOPSIS |
60 | |
61 | use File::stat; |
62 | $st = stat($file) or die "No $file: $!"; |
63 | if ( ($st->mode & 0111) && $st->nlink > 1) ) { |
64 | print "$file is executable with lotsa links\n"; |
65 | } |
66 | |
67 | use File::stat qw(:FIELDS); |
68 | stat($file) or die "No $file: $!"; |
69 | if ( ($st_mode & 0111) && $st_nlink > 1) ) { |
70 | print "$file is executable with lotsa links\n"; |
71 | } |
72 | |
73 | =head1 DESCRIPTION |
74 | |
75 | This module's default exports override the core stat() |
76 | and lstat() functions, replacing them with versions that return |
77 | "File::stat" objects. This object has methods that |
78 | return the similarly named structure field name from the |
79 | stat(2) function; namely, |
80 | dev, |
81 | ino, |
82 | mode, |
83 | nlink, |
84 | uid, |
85 | gid, |
86 | rdev, |
87 | size, |
88 | atime, |
89 | mtime, |
90 | ctime, |
91 | blksize, |
92 | and |
93 | blocks. |
94 | |
95 | You may also import all the structure fields directly into your namespace |
96 | as regular variables using the :FIELDS import tag. (Note that this still |
97 | overrides your stat() and lstat() functions.) Access these fields as |
98 | variables named with a preceding C<st_> in front their method names. |
99 | Thus, C<$stat_obj-E<gt>dev()> corresponds to $st_dev if you import |
100 | the fields. |
101 | |
102 | To access this functionality without the core overrides, |
103 | pass the C<use> an empty import list, and then access |
104 | function functions with their full qualified names. |
105 | On the other hand, the built-ins are still available |
106 | via the C<CORE::> pseudo-package. |
107 | |
108 | =head1 NOTE |
109 | |
8cc95fdb |
110 | While this class is currently implemented using the Class::Struct |
36477c24 |
111 | module to build a struct-like class, you shouldn't rely upon this. |
112 | |
113 | =head1 AUTHOR |
114 | |
115 | Tom Christiansen |