File::Stat::Bits 1.00 review

File::Stat::Bits - stat bit mask constants. SYNOPSIS: use File::stat; use File::Stat::Bits; my $st = stat($f

License: Perl Artistic License File size: 0K Developer: Dmitry Fedorov

0

File::Stat::Bits - stat bit mask constants.

SYNOPSIS:

use File::stat;
use File::Stat::Bits;

my $st = stat($file) or die "Can't stat $file: $!";

if ( S_ISCHR($st->mode) ) {
my ($major, $minor) = dev_split( $st->rdev );

print "$file is character device $major:$minorn";
}

printf "Permissions are %04on", $st->mode & ALLPERMS;

(Too many S_IF* constants to example)

Lots of Perl modules use the Unix file permissions and type bits directly in binary form with risk of non-portability for some exotic bits. Note that the POSIX module does not provides all needed constants and I can't wait when the POSIX module will be updated.

This separate module provides file type/mode bit and more constants from sys/stat.ph and sys/sysmacros.ph without pollution caller's namespace by other unneeded symbols from these headers. Most of these constants exported by this module are Constant Functions (see perlsub).

Since some of Perl builds does not include these converted headers, the build procedure will generate it for itself in the its own lib directory.

This module also should concentrate all portability and compatibility issues.

CONSTANTS

File type bit masks (for the st_mode field):

S_IFMT bitmask for the file type bitfields
S_IFDIR directory
S_IFCHR character device
S_IFBLK block device
S_IFREG regular file
S_IFIFO fifo (named pipe)
S_IFLNK symbolic link
S_IFSOCK socket
=cut

sub S_IFMT () { File::Stat::Bits::dirty::S_IFMT () }
sub S_IFDIR () { File::Stat::Bits::dirty::S_IFDIR () }
sub S_IFCHR () { File::Stat::Bits::dirty::S_IFCHR () }
sub S_IFBLK () { File::Stat::Bits::dirty::S_IFBLK () }
sub S_IFREG () { File::Stat::Bits::dirty::S_IFREG () }
sub S_IFIFO () { File::Stat::Bits::dirty::S_IFIFO () }
sub S_IFLNK () { File::Stat::Bits::dirty::S_IFLNK () }
sub S_IFSOCK() { File::Stat::Bits::dirty::S_IFSOCK() }


File access permission bit masks (for the st_mode field):

S_IRWXU mask for file owner permissions
S_IRUSR owner has read permission
S_IWUSR owner has write permission
S_IXUSR owner has execute permission
S_ISUID set UID bit

S_IRWXG mask for group permissions
S_IRGRP group has read permission
S_IWGRP group has write permission
S_IXGRP group has execute permission
S_ISGID set GID bit

S_IRWXO mask for permissions for others
S_IROTH others have read permission
S_IWOTH others have write permisson
S_IXOTH others have execute permission
S_ISVTX sticky bit

Common mode bit masks:

ACCESSPERMS 0777
ALLPERMS 07777
DEFFILEMODE 0666
=cut

sub S_IRWXU() { File::Stat::Bits::dirty::S_IRWXU() }
sub S_IRUSR() { File::Stat::Bits::dirty::S_IRUSR() }
sub S_IWUSR() { File::Stat::Bits::dirty::S_IWUSR() }
sub S_IXUSR() { File::Stat::Bits::dirty::S_IXUSR() }
sub S_ISUID() { File::Stat::Bits::dirty::S_ISUID() }

sub S_IRWXG() { File::Stat::Bits::dirty::S_IRWXG() }
sub S_IRGRP() { File::Stat::Bits::dirty::S_IRGRP() }
sub S_IWGRP() { File::Stat::Bits::dirty::S_IWGRP() }
sub S_IXGRP() { File::Stat::Bits::dirty::S_IXGRP() }
sub S_ISGID() { File::Stat::Bits::dirty::S_ISGID() }

sub S_IRWXO() { File::Stat::Bits::dirty::S_IRWXO() }
sub S_IROTH() { File::Stat::Bits::dirty::S_IROTH() }
sub S_IWOTH() { File::Stat::Bits::dirty::S_IWOTH() }
sub S_IXOTH() { File::Stat::Bits::dirty::S_IXOTH() }
sub S_ISVTX() { File::Stat::Bits::dirty::S_ISVTX() }

sub ACCESSPERMS() { S_IRWXU|S_IRWXG|S_IRWXO }
sub ALLPERMS() { S_ISUID|S_ISGID|S_ISVTX|ACCESSPERMS }
sub DEFFILEMODE() { S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH }

FUNCTIONS

File type test macros (for the st_mode field):

S_ISDIR ( mode ) directory?
S_ISCHR ( mode ) character device?
S_ISBLK ( mode ) block device?
S_ISREG ( mode ) regular file?
S_ISFIFO( mode ) fifo (named pipe)?
S_ISLNK ( mode ) is it a symbolic link?
S_ISSOCK( mode ) socket?

All returns boolean value.


$major = major( $st_rdev )

Returns major device number of st_rdev


$minor = minor( $st_rdev )

Returns minor device number of st_rdev


($major, $minor) = dev_split( $st_rdev )

Splits st_rdev to major and minor device numbers


$st_rdev = dev_join( $major, $minor )

Makes st_rdev from major and minor device numbers (makedev())

Requirements:
Perl