This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[inseparable changes from changes to perl-5.004_01-mt2]
[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
27By default your system's F_* and O_* constants (eg, F_DUPFD and O_CREAT)
28are exported into your namespace. You can request that the flock()
29constants (LOCK_SH, LOCK_EX, LOCK_NB and LOCK_UN) be provided by using
30the tag C<:flock>. See L<Exporter>.
31
705af498
JH
32Please refer to your native fcntl() and open() documentation to see
33what constants are implemented in your system.
34
3b35bae3
AD
35=cut
36
7e1af8bc 37use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $AUTOLOAD);
73c78b0a 38
a0d0e21e 39require Exporter;
a0d0e21e 40require DynaLoader;
fec02dd3 41@ISA = qw(Exporter DynaLoader);
5f832ef3 42$VERSION = "1.03";
a0d0e21e
LW
43# Items to export into callers namespace by default
44# (move infrequently used names to @EXPORT_OK below)
45@EXPORT =
46 qw(
47 F_DUPFD F_GETFD F_GETLK F_SETFD F_GETFL F_SETFL F_SETLK F_SETLKW
48 FD_CLOEXEC F_RDLCK F_UNLCK F_WRLCK
49 O_CREAT O_EXCL O_NOCTTY O_TRUNC
50 O_APPEND O_NONBLOCK
705af498 51 O_NDELAY O_DEFER
a0d0e21e 52 O_RDONLY O_RDWR O_WRONLY
705af498
JH
53 O_EXLOCK O_SHLOCK O_ASYNC O_DSYNC O_RSYNC O_SYNC
54 F_SETOWN F_GETOWN
a0d0e21e 55 );
705af498 56
a0d0e21e
LW
57# Other items we are prepared to export if requested
58@EXPORT_OK = qw(
7e1af8bc
PP
59 LOCK_SH LOCK_EX LOCK_NB LOCK_UN
60);
61# Named groups of exports
62%EXPORT_TAGS = (
63 'flock' => [qw(LOCK_SH LOCK_EX LOCK_NB LOCK_UN)],
a0d0e21e
LW
64);
65
66sub AUTOLOAD {
73c78b0a 67 my($constname);
a0d0e21e 68 ($constname = $AUTOLOAD) =~ s/.*:://;
73c78b0a 69 my $val = constant($constname, @_ ? $_[0] : 0);
a0d0e21e
LW
70 if ($! != 0) {
71 if ($! =~ /Invalid/) {
72 $AutoLoader::AUTOLOAD = $AUTOLOAD;
73 goto &AutoLoader::AUTOLOAD;
74 }
75 else {
73c78b0a 76 my ($pack,$file,$line) = caller;
a0d0e21e
LW
77 die "Your vendor has not defined Fcntl macro $constname, used at $file line $line.
78";
79 }
80 }
81 eval "sub $AUTOLOAD { $val }";
82 goto &$AUTOLOAD;
83}
84
73c78b0a 85bootstrap Fcntl $VERSION;
a0d0e21e 86
a0d0e21e 871;