This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
pumpkin.pod: Add L<> around html link
[perl5.git] / ext / Fcntl / Fcntl.pm
index 43bec99..cc35ff0 100644 (file)
@@ -11,8 +11,8 @@ Fcntl - load the C Fcntl.h defines
 
 =head1 DESCRIPTION
 
-This module is just a translation of the C F<fnctl.h> file.
-Unlike the old mechanism of requiring a translated F<fnctl.ph>
+This module is just a translation of the C F<fcntl.h> file.
+Unlike the old mechanism of requiring a translated F<fcntl.ph>
 file, this uses the B<h2xs> program (see the Perl source distribution)
 and your native C compiler.  This means that it has a 
 far more likely chance of getting the numbers right.
@@ -37,17 +37,54 @@ applications the newer versions of these constants are suggested
 (O_APPEND, O_ASYNC, O_CREAT, O_DEFER, O_EXCL, O_NDELAY, O_NONBLOCK,
 O_SYNC, O_TRUNC).
 
-Please refer to your native fcntl() and open() documentation to see
-what constants are implemented in your system.
+For ease of use also the SEEK_* constants (for seek() and sysseek(),
+e.g. SEEK_END) and the S_I* constants (for chmod() and stat()) are
+available for import.  They can be imported either separately or using
+the tags C<:seek> and C<:mode>.
+
+Please refer to your native fcntl(2), open(2), fseek(3), lseek(2)
+(equal to Perl's seek() and sysseek(), respectively), and chmod(2)
+documentation to see what constants are implemented in your system.
+
+See L<perlopentut> to learn about the uses of the O_* constants
+with sysopen().
+
+See L<perlfunc/seek> and L<perlfunc/sysseek> about the SEEK_* constants.
+
+See L<perlfunc/stat> about the S_I* constants.
 
 =cut
 
-our($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS, $AUTOLOAD);
+use strict;
+our($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
 
 require Exporter;
-use XSLoader ();
+require XSLoader;
 @ISA = qw(Exporter);
-$VERSION = "1.03";
+$VERSION = '1.11';
+
+XSLoader::load();
+
+# Named groups of exports
+%EXPORT_TAGS = (
+    'flock'   => [qw(LOCK_SH LOCK_EX LOCK_NB LOCK_UN)],
+    'Fcompat' => [qw(FAPPEND FASYNC FCREAT FDEFER FDSYNC FEXCL FLARGEFILE
+                    FNDELAY FNONBLOCK FRSYNC FSYNC FTRUNC)],
+    'seek'    => [qw(SEEK_SET SEEK_CUR SEEK_END)],
+    'mode'    => [qw(S_ISUID S_ISGID S_ISVTX S_ISTXT
+                    _S_IFMT S_IFREG S_IFDIR S_IFLNK
+                    S_IFSOCK S_IFBLK S_IFCHR S_IFIFO S_IFWHT S_ENFMT
+                    S_IRUSR S_IWUSR S_IXUSR S_IRWXU
+                    S_IRGRP S_IWGRP S_IXGRP S_IRWXG
+                    S_IROTH S_IWOTH S_IXOTH S_IRWXO
+                    S_IREAD S_IWRITE S_IEXEC
+                    S_ISREG S_ISDIR S_ISLNK S_ISSOCK
+                    S_ISBLK S_ISCHR S_ISFIFO
+                    S_ISWHT S_ISENFMT          
+                    S_IFMT S_IMODE
+                  )],
+);
+
 # Items to export into callers namespace by default
 # (move infrequently used names to @EXPORT_OK below)
 @EXPORT =
@@ -90,77 +127,60 @@ $VERSION = "1.03";
        F_WRDNY
        F_WRLCK
        O_ACCMODE
+       O_ALIAS
        O_APPEND
        O_ASYNC
        O_BINARY
        O_CREAT
        O_DEFER
+       O_DIRECT
+       O_DIRECTORY
        O_DSYNC
        O_EXCL
        O_EXLOCK
        O_LARGEFILE
        O_NDELAY
        O_NOCTTY
+       O_NOFOLLOW
+       O_NOINHERIT
        O_NONBLOCK
+       O_RANDOM
+       O_RAW
        O_RDONLY
        O_RDWR
+       O_RSRC
        O_RSYNC
+       O_SEQUENTIAL
        O_SHLOCK
        O_SYNC
+       O_TEMPORARY
        O_TEXT
        O_TRUNC
        O_WRONLY
-       O_ALIAS
-       O_RSRC
-       SEEK_SET
-       SEEK_CUR
-       SEEK_END
      );
 
 # Other items we are prepared to export if requested
-@EXPORT_OK = qw(
-       FAPPEND
-       FASYNC
-       FCREAT
-       FDEFER
-       FDSYNC
-       FEXCL
-       FLARGEFILE
-       FNDELAY
-       FNONBLOCK
-       FRSYNC
-       FSYNC
-       FTRUNC
-       LOCK_EX
-       LOCK_NB
-       LOCK_SH
-       LOCK_UN
-);
-# Named groups of exports
-%EXPORT_TAGS = (
-    'flock'   => [qw(LOCK_SH LOCK_EX LOCK_NB LOCK_UN)],
-    'Fcompat' => [qw(FAPPEND FASYNC FCREAT FDEFER FDSYNC FEXCL FLARGEFILE
-                    FNDELAY FNONBLOCK FRSYNC FSYNC FTRUNC)],
-);
-
-sub AUTOLOAD {
-    (my $constname = $AUTOLOAD) =~ s/.*:://;
-    my $val = constant($constname, 0);
-    if ($! != 0) {
-       if ($! =~ /Invalid/ || $!{EINVAL}) {
-           $AutoLoader::AUTOLOAD = $AUTOLOAD;
-           goto &AutoLoader::AUTOLOAD;
-       }
-       else {
-           my ($pack,$file,$line) = caller;
-           die "Your vendor has not defined Fcntl macro $constname, used at $file line $line.
-";
-       }
-    }
-    *$AUTOLOAD = sub { $val };
-    goto &$AUTOLOAD;
-}
-
-XSLoader::load 'Fcntl', $VERSION;
+@EXPORT_OK = (qw(
+       DN_ACCESS
+       DN_ATTRIB
+       DN_CREATE
+       DN_DELETE
+       DN_MODIFY
+       DN_MULTISHOT
+       DN_RENAME
+       F_GETLEASE
+       F_GETSIG
+       F_NOTIFY
+       F_SETLEASE
+       F_SETSIG
+       LOCK_MAND
+       LOCK_READ
+       LOCK_RW
+       LOCK_WRITE
+       O_IGNORE_CTTY
+       O_NOATIME
+       O_NOLINK
+       O_NOTRANS
+), map {@{$_}} values %EXPORT_TAGS);
 
 1;