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