xref: /onnv-gate/usr/src/cmd/perl/5.8.4/distrib/lib/File/stat.pm (revision 0:68f95e015346)
1package File::stat;
2use 5.006;
3
4use strict;
5use warnings;
6
7our(@EXPORT, @EXPORT_OK, %EXPORT_TAGS);
8
9our $VERSION = '1.00';
10
11BEGIN {
12    use Exporter   ();
13    @EXPORT      = qw(stat lstat);
14    @EXPORT_OK   = qw( $st_dev	   $st_ino    $st_mode
15		       $st_nlink   $st_uid    $st_gid
16		       $st_rdev    $st_size
17		       $st_atime   $st_mtime  $st_ctime
18		       $st_blksize $st_blocks
19		    );
20    %EXPORT_TAGS = ( FIELDS => [ @EXPORT_OK, @EXPORT ] );
21}
22use vars @EXPORT_OK;
23
24# Class::Struct forbids use of @ISA
25sub import { goto &Exporter::import }
26
27use Class::Struct qw(struct);
28struct 'File::stat' => [
29     map { $_ => '$' } qw{
30	 dev ino mode nlink uid gid rdev size
31	 atime mtime ctime blksize blocks
32     }
33];
34
35sub populate (@) {
36    return unless @_;
37    my $stob = new();
38    @$stob = (
39	$st_dev, $st_ino, $st_mode, $st_nlink, $st_uid, $st_gid, $st_rdev,
40        $st_size, $st_atime, $st_mtime, $st_ctime, $st_blksize, $st_blocks )
41	    = @_;
42    return $stob;
43}
44
45sub lstat ($)  { populate(CORE::lstat(shift)) }
46
47sub stat ($) {
48    my $arg = shift;
49    my $st = populate(CORE::stat $arg);
50    return $st if $st;
51	my $fh;
52    {
53		local $!;
54		no strict 'refs';
55		require Symbol;
56		$fh = \*{ Symbol::qualify( $arg, caller() )};
57		return unless defined fileno $fh;
58	}
59    return populate(CORE::stat $fh);
60}
61
621;
63__END__
64
65=head1 NAME
66
67File::stat - by-name interface to Perl's built-in stat() functions
68
69=head1 SYNOPSIS
70
71 use File::stat;
72 $st = stat($file) or die "No $file: $!";
73 if ( ($st->mode & 0111) && $st->nlink > 1) ) {
74     print "$file is executable with lotsa links\n";
75 }
76
77 use File::stat qw(:FIELDS);
78 stat($file) or die "No $file: $!";
79 if ( ($st_mode & 0111) && $st_nlink > 1) ) {
80     print "$file is executable with lotsa links\n";
81 }
82
83=head1 DESCRIPTION
84
85This module's default exports override the core stat()
86and lstat() functions, replacing them with versions that return
87"File::stat" objects.  This object has methods that
88return the similarly named structure field name from the
89stat(2) function; namely,
90dev,
91ino,
92mode,
93nlink,
94uid,
95gid,
96rdev,
97size,
98atime,
99mtime,
100ctime,
101blksize,
102and
103blocks.
104
105You may also import all the structure fields directly into your namespace
106as regular variables using the :FIELDS import tag.  (Note that this still
107overrides your stat() and lstat() functions.)  Access these fields as
108variables named with a preceding C<st_> in front their method names.
109Thus, C<$stat_obj-E<gt>dev()> corresponds to $st_dev if you import
110the fields.
111
112To access this functionality without the core overrides,
113pass the C<use> an empty import list, and then access
114function functions with their full qualified names.
115On the other hand, the built-ins are still available
116via the C<CORE::> pseudo-package.
117
118=head1 BUGS
119
120As of Perl 5.8.0 after using this module you cannot use the implicit
121C<$_> or the special filehandle C<_> with stat() or lstat(), trying
122to do so leads into strange errors.  The workaround is for C<$_> to
123be explicit
124
125    my $stat_obj = stat $_;
126
127and for C<_> to explicitly populate the object using the unexported
128and undocumented populate() function with CORE::stat():
129
130    my $stat_obj = File::stat::populate(CORE::stat(_));
131
132=head1 NOTE
133
134While this class is currently implemented using the Class::Struct
135module to build a struct-like class, you shouldn't rely upon this.
136
137=head1 AUTHOR
138
139Tom Christiansen
140