This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix various details in win32 makefiles and Config.pm setup.
[perl5.git] / ext / Fcntl / Fcntl.pm
CommitLineData
a0d0e21e
LW
1package Fcntl;
2
3b35bae3
AD
3=head1 NAME
4
5Fcntl - load the C Fcntl.h defines
6
7=head1 SYNOPSIS
8
9 use Fcntl;
7e1af8bc 10 use Fcntl qw(:DEFAULT :flock);
3b35bae3
AD
11
12=head1 DESCRIPTION
13
14This module is just a translation of the C F<fnctl.h> file.
15Unlike the old mechanism of requiring a translated F<fnctl.ph>
16file, this uses the B<h2xs> program (see the Perl source distribution)
17and your native C compiler. This means that it has a
18far more likely chance of getting the numbers right.
19
20=head1 NOTE
21
22Only C<#define> symbols get translated; you must still correctly
23pack up your own arguments to pass as args for locking functions, etc.
24
7e1af8bc
PP
25=head1 EXPORTED SYMBOLS
26
3e3baf6d
TB
27By default your system's F_* and O_* constants (eg, F_DUPFD and
28O_CREAT) and the FD_CLOEXEC constant are exported into your namespace.
29
30You can request that the flock() constants (LOCK_SH, LOCK_EX, LOCK_NB
31and LOCK_UN) be provided by using the tag C<:flock>. See L<Exporter>.
32
33You can request that the old constants (FAPPEND, FASYNC, FCREAT,
34FDEFER, FEXCL, FNDELAY, FNONBLOCK, FSYNC, FTRUNC) be provided for
35compatibility reasons by using the tag C<:Fcompat>. For new
36applications the newer versions of these constants are suggested
37(O_APPEND, O_ASYNC, O_CREAT, O_DEFER, O_EXCL, O_NDELAY, O_NONBLOCK,
38O_SYNC, O_TRUNC).
7e1af8bc 39
705af498
JH
40Please refer to your native fcntl() and open() documentation to see
41what constants are implemented in your system.
42
3b35bae3
AD
43=cut
44
7e1af8bc 45use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $AUTOLOAD);
73c78b0a 46
a0d0e21e 47require Exporter;
a0d0e21e 48require DynaLoader;
fec02dd3 49@ISA = qw(Exporter DynaLoader);
5f832ef3 50$VERSION = "1.03";
a0d0e21e
LW
51# Items to export into callers namespace by default
52# (move infrequently used names to @EXPORT_OK below)
53@EXPORT =
54 qw(
55 F_DUPFD F_GETFD F_GETLK F_SETFD F_GETFL F_SETFL F_SETLK F_SETLKW
3e3baf6d 56 FD_CLOEXEC F_RDLCK F_UNLCK F_WRLCK F_POSIX
a0d0e21e
LW
57 O_CREAT O_EXCL O_NOCTTY O_TRUNC
58 O_APPEND O_NONBLOCK
705af498 59 O_NDELAY O_DEFER
a0d0e21e 60 O_RDONLY O_RDWR O_WRONLY
3e3baf6d 61 O_BINARY O_TEXT
705af498
JH
62 O_EXLOCK O_SHLOCK O_ASYNC O_DSYNC O_RSYNC O_SYNC
63 F_SETOWN F_GETOWN
a0d0e21e 64 );
705af498 65
a0d0e21e
LW
66# Other items we are prepared to export if requested
67@EXPORT_OK = qw(
7e1af8bc 68 LOCK_SH LOCK_EX LOCK_NB LOCK_UN
3e3baf6d 69 FAPPEND FASYNC FCREAT FDEFER FEXCL FNDELAY FNONBLOCK FSYNC FTRUNC
7e1af8bc
PP
70);
71# Named groups of exports
72%EXPORT_TAGS = (
3e3baf6d
TB
73 'flock' => [qw(LOCK_SH LOCK_EX LOCK_NB LOCK_UN)],
74 'Fcompat' => [qw(FAPPEND FASYNC FCREAT FDEFER FEXCL
75 FNDELAY FNONBLOCK FSYNC FTRUNC)],
a0d0e21e
LW
76);
77
78sub AUTOLOAD {
73c78b0a 79 my($constname);
a0d0e21e 80 ($constname = $AUTOLOAD) =~ s/.*:://;
73c78b0a 81 my $val = constant($constname, @_ ? $_[0] : 0);
a0d0e21e
LW
82 if ($! != 0) {
83 if ($! =~ /Invalid/) {
84 $AutoLoader::AUTOLOAD = $AUTOLOAD;
85 goto &AutoLoader::AUTOLOAD;
86 }
87 else {
73c78b0a 88 my ($pack,$file,$line) = caller;
a0d0e21e
LW
89 die "Your vendor has not defined Fcntl macro $constname, used at $file line $line.
90";
91 }
92 }
93 eval "sub $AUTOLOAD { $val }";
94 goto &$AUTOLOAD;
95}
96
73c78b0a 97bootstrap Fcntl $VERSION;
a0d0e21e 98
a0d0e21e 991;