ext/Fcntl/Fcntl.pm

   1 package Fcntl;
   2
   3 =head1 NAME
   4
   5 Fcntl - load the C Fcntl.h defines
   6
   7 =head1 SYNOPSIS
   8
   9     use Fcntl;
  10     use Fcntl qw(:DEFAULT :flock);
  11
  12 =head1 DESCRIPTION
  13
  14 This module is just a translation of the C F<fnctl.h> file.
  15 Unlike the old mechanism of requiring a translated F<fnctl.ph>
  16 file, this uses the B<h2xs> program (see the Perl source distribution)
  17 and your native C compiler.  This means that it has a
  18 far more likely chance of getting the numbers right.
  19
  20 =head1 NOTE
  21
  22 Only C<#define> symbols get translated; you must still correctly
  23 pack up your own arguments to pass as args for locking functions, etc.
  24
  25 =head1 EXPORTED SYMBOLS
  26
  27 By default your system's F_* and O_* constants (eg, F_DUPFD and
  28 O_CREAT) and the FD_CLOEXEC constant are exported into your namespace.
  29
  30 You can request that the flock() constants (LOCK_SH, LOCK_EX, LOCK_NB
  31 and LOCK_UN) be provided by using the tag C<:flock>.  See L<Exporter>.
  32
  33 You can request that the old constants (FAPPEND, FASYNC, FCREAT,
  34 FDEFER, FEXCL, FNDELAY, FNONBLOCK, FSYNC, FTRUNC) be provided for
  35 compatibility reasons by using the tag C<:Fcompat>.  For new
  36 applications the newer versions of these constants are suggested
  37 (O_APPEND, O_ASYNC, O_CREAT, O_DEFER, O_EXCL, O_NDELAY, O_NONBLOCK,
  38 O_SYNC, O_TRUNC).
  39
  40 Please refer to your native fcntl() and open() documentation to see
  41 what constants are implemented in your system.
  42
  43 =cut
  44
  45 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $AUTOLOAD);
  46
  47 use Errno;
  48 require Exporter;
  49 require DynaLoader;
  50 @ISA = qw(Exporter DynaLoader);
  51 $VERSION = "1.03";
  52 # Items to export into callers namespace by default
  53 # (move infrequently used names to @EXPORT_OK below)
  54 @EXPORT =
  55   qw(
  56         FD_CLOEXEC
  57         F_DUPFD
  58         F_EXLCK
  59         F_GETFD
  60         F_GETFL
  61         F_GETLK
  62         F_GETLK64
  63         F_GETOWN
  64         F_POSIX
  65         F_RDLCK
  66         F_SETFD
  67         F_SETFL
  68         F_SETLK
  69         F_SETLK64
  70         F_SETLKW
  71         F_SETLKW64
  72         F_SETOWN
  73         F_SHLCK
  74         F_UNLCK
  75         F_WRLCK
  76         O_ACCMODE
  77         O_APPEND
  78         O_ASYNC
  79         O_BINARY
  80         O_CREAT
  81         O_DEFER
  82         O_DSYNC
  83         O_EXCL
  84         O_EXLOCK
  85         O_LARGEFILE
  86         O_NDELAY
  87         O_NOCTTY
  88         O_NONBLOCK
  89         O_RDONLY
  90         O_RDWR
  91         O_RSYNC
  92         O_SHLOCK
  93         O_SYNC
  94         O_TEXT
  95         O_TRUNC
  96         O_WRONLY
  97      );
  98
  99 # Other items we are prepared to export if requested
 100 @EXPORT_OK = qw(
 101         FAPPEND
 102         FASYNC
 103         FCREAT
 104         FDEFER
 105         FEXCL
 106         FNDELAY
 107         FNONBLOCK
 108         FSYNC
 109         FTRUNC
 110         LOCK_EX
 111         LOCK_NB
 112         LOCK_SH
 113         LOCK_UN
 114 );
 115 # Named groups of exports
 116 %EXPORT_TAGS = (
 117     'flock'   => [qw(LOCK_SH LOCK_EX LOCK_NB LOCK_UN)],
 118     'Fcompat' => [qw(FAPPEND FASYNC FCREAT FDEFER FEXCL
 119                      FNDELAY FNONBLOCK FSYNC FTRUNC)],
 120 );
 121
 122 sub AUTOLOAD {
 123     (my $constname = $AUTOLOAD) =~ s/.*:://;
 124     my $val = constant($constname, 0);
 125     if ($! != 0) {
 126         if ($!{EINVAL} || $! =~ /Invalid/) {
 127             $AutoLoader::AUTOLOAD = $AUTOLOAD;
 128             goto &AutoLoader::AUTOLOAD;
 129         }
 130         else {
 131             my ($pack,$file,$line) = caller;
 132             die "Your vendor has not defined Fcntl macro $constname, used at $file line $line.
 133 ";
 134         }
 135     }
 136     *$AUTOLOAD = sub { $val };
 137     goto &$AUTOLOAD;
 138 }
 139
 140 bootstrap Fcntl $VERSION;
 141
 142 1;