This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
On second thoughts show to utf8 skippage message only
[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
ca6e1c26
JH
40For ease of use also the SEEK_* constants (for seek() and sysseek(),
41e.g. SEEK_END) and the S_I* constants (for chmod() and stat()) are
42available for import. They can be imported either separately or using
43the tags C<:seek> and C<:mode>.
44
45Please refer to your native fcntl(2), open(2), fseek(3), lseek(2)
46(equal to Perl's seek() and sysseek(), respectively), and chmod(2)
47documentation to see what constants are implemented in your system.
48
49See L<perlopentut> to learn about the uses of the O_* constants
50with sysopen().
51
52See L<perlfunc/seek> and L<perlfunc/sysseek> about the SEEK_* constants.
53
54See L<perlfunc/stat> about the S_I* constants.
705af498 55
3b35bae3
AD
56=cut
57
17f410f9 58our($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS, $AUTOLOAD);
73c78b0a 59
a0d0e21e 60require Exporter;
9426adcd
IZ
61use XSLoader ();
62@ISA = qw(Exporter);
5f832ef3 63$VERSION = "1.03";
a0d0e21e
LW
64# Items to export into callers namespace by default
65# (move infrequently used names to @EXPORT_OK below)
66@EXPORT =
67 qw(
0fd60c2a 68 FD_CLOEXEC
ac88732c
JH
69 F_ALLOCSP
70 F_ALLOCSP64
71 F_COMPAT
72 F_DUP2FD
0fd60c2a
JH
73 F_DUPFD
74 F_EXLCK
ac88732c
JH
75 F_FREESP
76 F_FREESP64
77 F_FSYNC
78 F_FSYNC64
0fd60c2a
JH
79 F_GETFD
80 F_GETFL
81 F_GETLK
5ff3f7a4 82 F_GETLK64
0fd60c2a 83 F_GETOWN
ac88732c 84 F_NODNY
0fd60c2a 85 F_POSIX
ac88732c
JH
86 F_RDACC
87 F_RDDNY
0fd60c2a 88 F_RDLCK
ac88732c
JH
89 F_RWACC
90 F_RWDNY
0fd60c2a
JH
91 F_SETFD
92 F_SETFL
93 F_SETLK
5ff3f7a4 94 F_SETLK64
0fd60c2a 95 F_SETLKW
5ff3f7a4 96 F_SETLKW64
0fd60c2a 97 F_SETOWN
ac88732c 98 F_SHARE
0fd60c2a
JH
99 F_SHLCK
100 F_UNLCK
ac88732c
JH
101 F_UNSHARE
102 F_WRACC
103 F_WRDNY
0fd60c2a
JH
104 F_WRLCK
105 O_ACCMODE
ca6e1c26 106 O_ALIAS
0fd60c2a
JH
107 O_APPEND
108 O_ASYNC
109 O_BINARY
110 O_CREAT
111 O_DEFER
ca6e1c26
JH
112 O_DIRECT
113 O_DIRECTORY
0fd60c2a
JH
114 O_DSYNC
115 O_EXCL
116 O_EXLOCK
5ff3f7a4 117 O_LARGEFILE
0fd60c2a
JH
118 O_NDELAY
119 O_NOCTTY
ca6e1c26 120 O_NOFOLLOW
8c99d73e 121 O_NOINHERIT
0fd60c2a 122 O_NONBLOCK
8c99d73e
GS
123 O_RANDOM
124 O_RAW
0fd60c2a
JH
125 O_RDONLY
126 O_RDWR
ca6e1c26 127 O_RSRC
0fd60c2a 128 O_RSYNC
8c99d73e 129 O_SEQUENTIAL
0fd60c2a
JH
130 O_SHLOCK
131 O_SYNC
ca6e1c26 132 O_TEMPORARY
0fd60c2a
JH
133 O_TEXT
134 O_TRUNC
135 O_WRONLY
a0d0e21e 136 );
705af498 137
a0d0e21e
LW
138# Other items we are prepared to export if requested
139@EXPORT_OK = qw(
0fd60c2a
JH
140 FAPPEND
141 FASYNC
142 FCREAT
143 FDEFER
ac88732c 144 FDSYNC
0fd60c2a 145 FEXCL
ac88732c 146 FLARGEFILE
0fd60c2a
JH
147 FNDELAY
148 FNONBLOCK
ac88732c 149 FRSYNC
0fd60c2a
JH
150 FSYNC
151 FTRUNC
152 LOCK_EX
153 LOCK_NB
154 LOCK_SH
155 LOCK_UN
ca6e1c26
JH
156 S_ISUID S_ISGID S_ISVTX S_ISTXT
157 _S_IFMT S_IFREG S_IFDIR S_IFLNK
158 S_IFSOCK S_IFBLK S_IFCHR S_IFIFO S_IFWHT S_ENFMT
159 S_IRUSR S_IWUSR S_IXUSR S_IRWXU
160 S_IRGRP S_IWGRP S_IXGRP S_IRWXG
161 S_IROTH S_IWOTH S_IXOTH S_IRWXO
162 S_IREAD S_IWRITE S_IEXEC
163 &S_ISREG &S_ISDIR &S_ISLNK &S_ISSOCK &S_ISBLK &S_ISCHR &S_ISFIFO
164 &S_ISWHT &S_ISENFMT &S_IFMT &S_IMODE
165 SEEK_SET
166 SEEK_CUR
167 SEEK_END
7e1af8bc
PP
168);
169# Named groups of exports
170%EXPORT_TAGS = (
3e3baf6d 171 'flock' => [qw(LOCK_SH LOCK_EX LOCK_NB LOCK_UN)],
ac88732c 172 'Fcompat' => [qw(FAPPEND FASYNC FCREAT FDEFER FDSYNC FEXCL FLARGEFILE
ca6e1c26
JH
173 FNDELAY FNONBLOCK FRSYNC FSYNC FTRUNC)],
174 'seek' => [qw(SEEK_SET SEEK_CUR SEEK_END)],
175 'mode' => [qw(S_ISUID S_ISGID S_ISVTX S_ISTXT
176 _S_IFMT S_IFREG S_IFDIR S_IFLNK
177 S_IFSOCK S_IFBLK S_IFCHR S_IFIFO S_IFWHT S_ENFMT
178 S_IRUSR S_IWUSR S_IXUSR S_IRWXU
179 S_IRGRP S_IWGRP S_IXGRP S_IRWXG
180 S_IROTH S_IWOTH S_IXOTH S_IRWXO
181 S_IREAD S_IWRITE S_IEXEC
0c634585
JH
182 S_ISREG S_ISDIR S_ISLNK S_ISSOCK
183 S_ISBLK S_ISCHR S_ISFIFO
184 S_ISWHT S_ISENFMT
185 S_IFMT S_IMODE
ca6e1c26 186 )],
a0d0e21e
LW
187);
188
0c634585
JH
189sub S_IFMT { @_ ? ( $_[0] & _S_IFMT() ) : _S_IFMT() }
190sub S_IMODE { $_[0] & 07777 }
ca6e1c26 191
0c634585
JH
192sub S_ISREG { ( $_[0] & _S_IFMT() ) == S_IFREG() }
193sub S_ISDIR { ( $_[0] & _S_IFMT() ) == S_IFDIR() }
194sub S_ISLNK { ( $_[0] & _S_IFMT() ) == S_IFLNK() }
195sub S_ISSOCK { ( $_[0] & _S_IFMT() ) == S_IFSOCK() }
196sub S_ISBLK { ( $_[0] & _S_IFMT() ) == S_IFBLK() }
197sub S_ISCHR { ( $_[0] & _S_IFMT() ) == S_IFCHR() }
198sub S_ISFIFO { ( $_[0] & _S_IFMT() ) == S_IFIFO() }
1a16747c
DM
199sub S_ISWHT { ( $_[0] & _S_IFMT() ) == S_IFWHT() }
200sub S_ISENFMT { ( $_[0] & _S_IFMT() ) == S_IFENFMT() }
ca6e1c26 201
a0d0e21e 202sub AUTOLOAD {
36c2d165 203 (my $constname = $AUTOLOAD) =~ s/.*:://;
59d526a3 204 my $val = constant($constname);
a0d0e21e 205 if ($! != 0) {
265f5c4a 206 if ($! =~ /Invalid/ || $!{EINVAL}) {
a0d0e21e
LW
207 $AutoLoader::AUTOLOAD = $AUTOLOAD;
208 goto &AutoLoader::AUTOLOAD;
209 }
210 else {
73c78b0a 211 my ($pack,$file,$line) = caller;
a0d0e21e
LW
212 die "Your vendor has not defined Fcntl macro $constname, used at $file line $line.
213";
214 }
215 }
0c634585 216 *$AUTOLOAD = sub { $val };
a0d0e21e
LW
217 goto &$AUTOLOAD;
218}
219
9426adcd 220XSLoader::load 'Fcntl', $VERSION;
a0d0e21e 221
a0d0e21e 2221;