This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Merge branch 'fix-grammar' into blead
[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
554ad1fc
JH
14This module is just a translation of the C F<fcntl.h> file.
15Unlike the old mechanism of requiring a translated F<fcntl.ph>
3b35bae3
AD
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
0f680395 58use strict;
73c78b0a 59
c1081406 60use Exporter 'import';
923cc1bb 61require XSLoader;
c1081406 62our $VERSION = '1.15';
923cc1bb
NC
63
64XSLoader::load();
0e6f150f 65
b8a48bdd 66# Named groups of exports
c1081406 67our %EXPORT_TAGS = (
b8a48bdd
NC
68 'flock' => [qw(LOCK_SH LOCK_EX LOCK_NB LOCK_UN)],
69 'Fcompat' => [qw(FAPPEND FASYNC FCREAT FDEFER FDSYNC FEXCL FLARGEFILE
70 FNDELAY FNONBLOCK FRSYNC FSYNC FTRUNC)],
71 'seek' => [qw(SEEK_SET SEEK_CUR SEEK_END)],
72 'mode' => [qw(S_ISUID S_ISGID S_ISVTX S_ISTXT
73 _S_IFMT S_IFREG S_IFDIR S_IFLNK
74 S_IFSOCK S_IFBLK S_IFCHR S_IFIFO S_IFWHT S_ENFMT
75 S_IRUSR S_IWUSR S_IXUSR S_IRWXU
76 S_IRGRP S_IWGRP S_IXGRP S_IRWXG
77 S_IROTH S_IWOTH S_IXOTH S_IRWXO
78 S_IREAD S_IWRITE S_IEXEC
79 S_ISREG S_ISDIR S_ISLNK S_ISSOCK
80 S_ISBLK S_ISCHR S_ISFIFO
81 S_ISWHT S_ISENFMT
82 S_IFMT S_IMODE
83 )],
84);
85
a0d0e21e
LW
86# Items to export into callers namespace by default
87# (move infrequently used names to @EXPORT_OK below)
c1081406 88our @EXPORT =
a0d0e21e 89 qw(
0fd60c2a 90 FD_CLOEXEC
ac88732c
JH
91 F_ALLOCSP
92 F_ALLOCSP64
93 F_COMPAT
94 F_DUP2FD
0fd60c2a
JH
95 F_DUPFD
96 F_EXLCK
ac88732c
JH
97 F_FREESP
98 F_FREESP64
99 F_FSYNC
100 F_FSYNC64
0fd60c2a
JH
101 F_GETFD
102 F_GETFL
103 F_GETLK
5ff3f7a4 104 F_GETLK64
0fd60c2a 105 F_GETOWN
ac88732c 106 F_NODNY
0fd60c2a 107 F_POSIX
ac88732c
JH
108 F_RDACC
109 F_RDDNY
0fd60c2a 110 F_RDLCK
ac88732c
JH
111 F_RWACC
112 F_RWDNY
0fd60c2a
JH
113 F_SETFD
114 F_SETFL
115 F_SETLK
5ff3f7a4 116 F_SETLK64
0fd60c2a 117 F_SETLKW
5ff3f7a4 118 F_SETLKW64
0fd60c2a 119 F_SETOWN
ac88732c 120 F_SHARE
0fd60c2a
JH
121 F_SHLCK
122 F_UNLCK
ac88732c
JH
123 F_UNSHARE
124 F_WRACC
125 F_WRDNY
0fd60c2a
JH
126 F_WRLCK
127 O_ACCMODE
ca6e1c26 128 O_ALIAS
0fd60c2a
JH
129 O_APPEND
130 O_ASYNC
131 O_BINARY
132 O_CREAT
133 O_DEFER
ca6e1c26
JH
134 O_DIRECT
135 O_DIRECTORY
0fd60c2a
JH
136 O_DSYNC
137 O_EXCL
138 O_EXLOCK
5ff3f7a4 139 O_LARGEFILE
0fd60c2a
JH
140 O_NDELAY
141 O_NOCTTY
ca6e1c26 142 O_NOFOLLOW
8c99d73e 143 O_NOINHERIT
0fd60c2a 144 O_NONBLOCK
8c99d73e
GS
145 O_RANDOM
146 O_RAW
0fd60c2a
JH
147 O_RDONLY
148 O_RDWR
ca6e1c26 149 O_RSRC
0fd60c2a 150 O_RSYNC
8c99d73e 151 O_SEQUENTIAL
0fd60c2a
JH
152 O_SHLOCK
153 O_SYNC
ca6e1c26 154 O_TEMPORARY
0fd60c2a
JH
155 O_TEXT
156 O_TRUNC
157 O_WRONLY
a0d0e21e 158 );
705af498 159
a0d0e21e 160# Other items we are prepared to export if requested
c1081406 161our @EXPORT_OK = (qw(
5bb8c70c
JH
162 DN_ACCESS
163 DN_ATTRIB
164 DN_CREATE
165 DN_DELETE
166 DN_MODIFY
167 DN_MULTISHOT
168 DN_RENAME
5bb8c70c 169 F_GETLEASE
e78728e5 170 F_GETPIPE_SZ
5bb8c70c
JH
171 F_GETSIG
172 F_NOTIFY
173 F_SETLEASE
e78728e5 174 F_SETPIPE_SZ
5bb8c70c 175 F_SETSIG
5bb8c70c 176 LOCK_MAND
5bb8c70c
JH
177 LOCK_READ
178 LOCK_RW
5bb8c70c 179 LOCK_WRITE
e6425454
JH
180 O_ALT_IO
181 O_EVTONLY
5bb8c70c
JH
182 O_IGNORE_CTTY
183 O_NOATIME
184 O_NOLINK
e6425454 185 O_NOSIGPIPE
5bb8c70c 186 O_NOTRANS
e6425454
JH
187 O_SYMLINK
188 O_TTY_INIT
b8a48bdd 189), map {@{$_}} values %EXPORT_TAGS);
a0d0e21e 190
a0d0e21e 1911;