big Configure update from Jarkko: sync metaconfig units; d_statblks fix

[perl5.git] / ext / Fcntl / Fcntl.pm

diff --git a/ext/Fcntl/Fcntl.pm b/ext/Fcntl/Fcntl.pm
index d55d4e3..00f834d 100644 (file)
--- a/ext/Fcntl/Fcntl.pm
+++ b/ext/Fcntl/Fcntl.pm
@@ -1,51 +1,141 @@
 package Fcntl;
 
+=head1 NAME
+
+Fcntl - load the C Fcntl.h defines
+
+=head1 SYNOPSIS
+
+    use Fcntl;
+    use Fcntl qw(:DEFAULT :flock);
+
+=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>
+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.
+
+=head1 NOTE
+
+Only C<#define> symbols get translated; you must still correctly
+pack up your own arguments to pass as args for locking functions, etc.
+
+=head1 EXPORTED SYMBOLS
+
+By default your system's F_* and O_* constants (eg, F_DUPFD and
+O_CREAT) and the FD_CLOEXEC constant are exported into your namespace.
+
+You can request that the flock() constants (LOCK_SH, LOCK_EX, LOCK_NB
+and LOCK_UN) be provided by using the tag C<:flock>.  See L<Exporter>.
+
+You can request that the old constants (FAPPEND, FASYNC, FCREAT,
+FDEFER, FEXCL, FNDELAY, FNONBLOCK, FSYNC, FTRUNC) be provided for
+compatibility reasons by using the tag C<:Fcompat>.  For new
+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.
+
+=cut
+
+use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $AUTOLOAD);
+
 require Exporter;
-require AutoLoader;
 require DynaLoader;
-@ISA = (Exporter, DynaLoader);
+@ISA = qw(Exporter DynaLoader);
+$VERSION = "1.03";
 # Items to export into callers namespace by default
 # (move infrequently used names to @EXPORT_OK below)
 @EXPORT =
   qw(
-     F_DUPFD F_GETFD F_GETLK F_SETFD F_GETFL F_SETFL F_SETLK F_SETLKW
-     FD_CLOEXEC F_RDLCK F_UNLCK F_WRLCK
-     O_CREAT O_EXCL O_NOCTTY O_TRUNC
-     O_APPEND O_NONBLOCK
-     O_NDELAY
-     O_RDONLY O_RDWR O_WRONLY
+       FD_CLOEXEC
+       F_DUPFD
+       F_EXLCK
+       F_GETFD
+       F_GETFL
+       F_GETLK
+       F_GETLK64
+       F_GETOWN
+       F_POSIX
+       F_RDLCK
+       F_SETFD
+       F_SETFL
+       F_SETLK
+       F_SETLK64
+       F_SETLKW
+       F_SETLKW64
+       F_SETOWN
+       F_SHLCK
+       F_UNLCK
+       F_WRLCK
+       O_ACCMODE
+       O_APPEND
+       O_ASYNC
+       O_BINARY
+       O_CREAT
+       O_DEFER
+       O_DSYNC
+       O_EXCL
+       O_EXLOCK
+       O_LARGEFILE
+       O_NDELAY
+       O_NOCTTY
+       O_NONBLOCK
+       O_RDONLY
+       O_RDWR
+       O_RSYNC
+       O_SHLOCK
+       O_SYNC
+       O_TEXT
+       O_TRUNC
+       O_WRONLY
      );
+
 # Other items we are prepared to export if requested
 @EXPORT_OK = qw(
+       FAPPEND
+       FASYNC
+       FCREAT
+       FDEFER
+       FEXCL
+       FNDELAY
+       FNONBLOCK
+       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 FEXCL
+                    FNDELAY FNONBLOCK FSYNC FTRUNC)],
 );
 
 sub AUTOLOAD {
-    if (@_ > 1) {
-       $AutoLoader::AUTOLOAD = $AUTOLOAD;
-       goto &AutoLoader::AUTOLOAD;
-    }
-    local($constname);
-    ($constname = $AUTOLOAD) =~ s/.*:://;
-    $val = constant($constname, @_ ? $_[0] : 0);
+    (my $constname = $AUTOLOAD) =~ s/.*:://;
+    my $val = constant($constname, 0);
     if ($! != 0) {
        if ($! =~ /Invalid/) {
            $AutoLoader::AUTOLOAD = $AUTOLOAD;
            goto &AutoLoader::AUTOLOAD;
        }
        else {
-           ($pack,$file,$line) = caller;
+           my ($pack,$file,$line) = caller;
            die "Your vendor has not defined Fcntl macro $constname, used at $file line $line.
 ";
        }
     }
-    eval "sub $AUTOLOAD { $val }";
+    *$AUTOLOAD = sub { $val };
     goto &$AUTOLOAD;
 }
 
-bootstrap Fcntl;
+bootstrap Fcntl $VERSION;
 
-# Preloaded methods go here.  Autoload methods go after __END__, and are
-# processed by the autosplit program.
-package Fcntl; # return to package Fcntl so AutoSplit is happy
 1;
-__END__