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 | |
705af498 |
40 | Please refer to your native fcntl() and open() documentation to see |
41 | what constants are implemented in your system. |
42 | |
3b35bae3 |
43 | =cut |
44 | |
7e1af8bc |
45 | use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $AUTOLOAD); |
73c78b0a |
46 | |
a0d0e21e |
47 | require Exporter; |
a0d0e21e |
48 | require DynaLoader; |
fec02dd3 |
49 | @ISA = qw(Exporter DynaLoader); |
5f832ef3 |
50 | $VERSION = "1.03"; |
a0d0e21e |
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 |
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 |
62 | O_EXLOCK O_SHLOCK O_ASYNC O_DSYNC O_RSYNC O_SYNC |
63 | F_SETOWN F_GETOWN |
a0d0e21e |
64 | ); |
705af498 |
65 | |
a0d0e21e |
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 |
70 | ); |
71 | # Named groups of exports |
72 | %EXPORT_TAGS = ( |
3e3baf6d |
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 |
76 | ); |
77 | |
78 | sub AUTOLOAD { |
36c2d165 |
79 | (my $constname = $AUTOLOAD) =~ s/.*:://; |
80 | my $val = constant($constname, 0); |
a0d0e21e |
81 | if ($! != 0) { |
82 | if ($! =~ /Invalid/) { |
83 | $AutoLoader::AUTOLOAD = $AUTOLOAD; |
84 | goto &AutoLoader::AUTOLOAD; |
85 | } |
86 | else { |
73c78b0a |
87 | my ($pack,$file,$line) = caller; |
a0d0e21e |
88 | die "Your vendor has not defined Fcntl macro $constname, used at $file line $line. |
89 | "; |
90 | } |
91 | } |
36c2d165 |
92 | *$AUTOLOAD = sub { $val }; |
a0d0e21e |
93 | goto &$AUTOLOAD; |
94 | } |
95 | |
73c78b0a |
96 | bootstrap Fcntl $VERSION; |
a0d0e21e |
97 | |
a0d0e21e |
98 | 1; |