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