6d1888de47359a597f021f3790752d1d30b34ca7
[gnulib.git] / lib / fcntl.in.h
1 /* Like <fcntl.h>, but with non-working flags defined to 0.
2
3    Copyright (C) 2006-2010 Free Software Foundation, Inc.
4
5    This program is free software: you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation; either version 3 of the License, or
8    (at your option) any later version.
9
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
17
18 /* written by Paul Eggert */
19
20 #if __GNUC__ >= 3
21 @PRAGMA_SYSTEM_HEADER@
22 #endif
23 @PRAGMA_COLUMNS@
24
25 #if defined __need_system_fcntl_h
26 /* Special invocation convention.  */
27
28 #include <sys/types.h>
29 /* On some systems other than glibc, <sys/stat.h> is a prerequisite of
30    <fcntl.h>.  On glibc systems, we would like to avoid namespace pollution.
31    But on glibc systems, <fcntl.h> includes <sys/stat.h> inside an
32    extern "C" { ... } block, which leads to errors in C++ mode with the
33    overridden <sys/stat.h> from gnulib.  These errors are known to be gone
34    with g++ version >= 4.3.  */
35 #if !(defined __GLIBC__ || defined __UCLIBC__) || (defined __cplusplus && defined GNULIB_NAMESPACE && !(__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)))
36 # include <sys/stat.h>
37 #endif
38 #@INCLUDE_NEXT@ @NEXT_FCNTL_H@
39
40 #else
41 /* Normal invocation convention.  */
42
43 #ifndef _GL_FCNTL_H
44
45 #include <sys/types.h>
46 #ifndef __GLIBC__ /* Avoid namespace pollution on glibc systems.  */
47 # include <sys/stat.h>
48 #endif
49 /* The include_next requires a split double-inclusion guard.  */
50 #@INCLUDE_NEXT@ @NEXT_FCNTL_H@
51
52 #ifndef _GL_FCNTL_H
53 #define _GL_FCNTL_H
54
55 #ifndef __GLIBC__ /* Avoid namespace pollution on glibc systems.  */
56 # include <unistd.h>
57 #endif
58
59
60 /* The definitions of _GL_FUNCDECL_RPL etc. are copied here.  */
61
62 /* The definition of _GL_ARG_NONNULL is copied here.  */
63
64 /* The definition of _GL_WARN_ON_USE is copied here.  */
65
66
67 /* Declare overridden functions.  */
68
69 #if @GNULIB_FCNTL@
70 # if @REPLACE_FCNTL@
71 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
72 #   undef fcntl
73 #   define fcntl rpl_fcntl
74 #  endif
75 _GL_FUNCDECL_RPL (fcntl, int, (int fd, int action, ...));
76 _GL_CXXALIAS_RPL (fcntl, int, (int fd, int action, ...));
77 # else
78 #  if !@HAVE_FCNTL@
79 _GL_FUNCDECL_SYS (fcntl, int, (int fd, int action, ...));
80 #  endif
81 _GL_CXXALIAS_SYS (fcntl, int, (int fd, int action, ...));
82 # endif
83 _GL_CXXALIASWARN (fcntl);
84 #elif defined GNULIB_POSIXCHECK
85 # undef fcntl
86 # if HAVE_RAW_DECL_FCNTL
87 _GL_WARN_ON_USE (fcntl, "fcntl is not always POSIX compliant - "
88                  "use gnulib module fcntl for portability");
89 # endif
90 #endif
91
92 #if @GNULIB_OPEN@
93 # if @REPLACE_OPEN@
94 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
95 #   undef open
96 #   define open rpl_open
97 #  endif
98 _GL_FUNCDECL_RPL (open, int, (const char *filename, int flags, ...)
99                              _GL_ARG_NONNULL ((1)));
100 _GL_CXXALIAS_RPL (open, int, (const char *filename, int flags, ...));
101 # else
102 _GL_CXXALIAS_SYS (open, int, (const char *filename, int flags, ...));
103 # endif
104 _GL_CXXALIASWARN (open);
105 #elif defined GNULIB_POSIXCHECK
106 # undef open
107 /* Assume open is always declared.  */
108 _GL_WARN_ON_USE (open, "open is not always POSIX compliant - "
109                  "use gnulib module open for portability");
110 #endif
111
112 #if @GNULIB_OPENAT@
113 # if @REPLACE_OPENAT@
114 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
115 #   undef openat
116 #   define openat rpl_openat
117 #  endif
118 _GL_FUNCDECL_RPL (openat, int,
119                   (int fd, char const *file, int flags, /* mode_t mode */ ...)
120                   _GL_ARG_NONNULL ((2)));
121 _GL_CXXALIAS_RPL (openat, int,
122                   (int fd, char const *file, int flags, /* mode_t mode */ ...));
123 # else
124 #  if !@HAVE_OPENAT@
125 _GL_FUNCDECL_SYS (openat, int,
126                   (int fd, char const *file, int flags, /* mode_t mode */ ...)
127                   _GL_ARG_NONNULL ((2)));
128 #  endif
129 _GL_CXXALIAS_SYS (openat, int,
130                   (int fd, char const *file, int flags, /* mode_t mode */ ...));
131 # endif
132 _GL_CXXALIASWARN (openat);
133 #elif defined GNULIB_POSIXCHECK
134 # undef openat
135 # if HAVE_RAW_DECL_OPENAT
136 _GL_WARN_ON_USE (openat, "openat is not portable - "
137                  "use gnulib module openat for portability");
138 # endif
139 #endif
140
141
142 /* Fix up the FD_* macros, only known to be missing on mingw.  */
143
144 #ifndef FD_CLOEXEC
145 # define FD_CLOEXEC 1
146 #endif
147
148 /* Fix up the supported F_* macros.  Intentionally leave other F_*
149    macros undefined.  Only known to be missing on mingw.  */
150
151 #ifndef F_DUPFD_CLOEXEC
152 # define F_DUPFD_CLOEXEC 0x40000000
153 /* Witness variable: 1 if gnulib defined F_DUPFD_CLOEXEC, 0 otherwise.  */
154 # define GNULIB_defined_F_DUPFD_CLOEXEC 1
155 #else
156 # define GNULIB_defined_F_DUPFD_CLOEXEC 0
157 #endif
158
159 #ifndef F_DUPFD
160 # define F_DUPFD 1
161 #endif
162
163 #ifndef F_GETFD
164 # define F_GETFD 2
165 #endif
166
167 /* Fix up the O_* macros.  */
168
169 #if !defined O_DIRECT && defined O_DIRECTIO
170 /* Tru64 spells it `O_DIRECTIO'.  */
171 # define O_DIRECT O_DIRECTIO
172 #endif
173
174 #if !defined O_CLOEXEC && defined O_NOINHERIT
175 /* Mingw spells it `O_NOINHERIT'.  Intentionally leave it
176    undefined if not available.  */
177 # define O_CLOEXEC O_NOINHERIT
178 #endif
179
180 #ifndef O_CLOEXEC
181 # define O_CLOEXEC 0
182 #endif
183
184 #ifndef O_DIRECT
185 # define O_DIRECT 0
186 #endif
187
188 #ifndef O_DIRECTORY
189 # define O_DIRECTORY 0
190 #endif
191
192 #ifndef O_DSYNC
193 # define O_DSYNC 0
194 #endif
195
196 #ifndef O_EXEC
197 # define O_EXEC O_RDONLY /* This is often close enough in older systems.  */
198 #endif
199
200 #ifndef O_NDELAY
201 # define O_NDELAY 0
202 #endif
203
204 #ifndef O_NOATIME
205 # define O_NOATIME 0
206 #endif
207
208 #ifndef O_NONBLOCK
209 # define O_NONBLOCK O_NDELAY
210 #endif
211
212 #ifndef O_NOCTTY
213 # define O_NOCTTY 0
214 #endif
215
216 #ifndef O_NOFOLLOW
217 # define O_NOFOLLOW 0
218 #endif
219
220 #ifndef O_NOLINKS
221 # define O_NOLINKS 0
222 #endif
223
224 #ifndef O_RSYNC
225 # define O_RSYNC 0
226 #endif
227
228 #ifndef O_SEARCH
229 # define O_SEARCH O_RDONLY /* This is often close enough in older systems.  */
230 #endif
231
232 #ifndef O_SYNC
233 # define O_SYNC 0
234 #endif
235
236 #ifndef O_TTY_INIT
237 # define O_TTY_INIT 0
238 #endif
239
240 /* For systems that distinguish between text and binary I/O.
241    O_BINARY is usually declared in fcntl.h  */
242 #if !defined O_BINARY && defined _O_BINARY
243   /* For MSC-compatible compilers.  */
244 # define O_BINARY _O_BINARY
245 # define O_TEXT _O_TEXT
246 #endif
247
248 #if defined __BEOS__ || defined __HAIKU__
249   /* BeOS 5 and Haiku have O_BINARY and O_TEXT, but they have no effect.  */
250 # undef O_BINARY
251 # undef O_TEXT
252 #endif
253
254 #ifndef O_BINARY
255 # define O_BINARY 0
256 # define O_TEXT 0
257 #endif
258
259 /* Fix up the AT_* macros.  */
260
261 /* Work around a bug in Solaris 9 and 10: AT_FDCWD is positive.  Its
262    value exceeds INT_MAX, so its use as an int doesn't conform to the
263    C standard, and GCC and Sun C complain in some cases.  If the bug
264    is present, undef AT_FDCWD here, so it can be redefined below.  */
265 #if 0 < AT_FDCWD && AT_FDCWD == 0xffd19553
266 # undef AT_FDCWD
267 #endif
268
269 /* Use the same bit pattern as Solaris 9, but with the proper
270    signedness.  The bit pattern is important, in case this actually is
271    Solaris with the above workaround.  */
272 #ifndef AT_FDCWD
273 # define AT_FDCWD (-3041965)
274 #endif
275
276 /* Use the same values as Solaris 9.  This shouldn't matter, but
277    there's no real reason to differ.  */
278 #ifndef AT_SYMLINK_NOFOLLOW
279 # define AT_SYMLINK_NOFOLLOW 4096
280 #endif
281
282 #ifndef AT_REMOVEDIR
283 # define AT_REMOVEDIR 1
284 #endif
285
286 /* Solaris 9 lacks these two, so just pick unique values.  */
287 #ifndef AT_SYMLINK_FOLLOW
288 # define AT_SYMLINK_FOLLOW 2
289 #endif
290
291 #ifndef AT_EACCESS
292 # define AT_EACCESS 4
293 #endif
294
295
296 #endif /* _GL_FCNTL_H */
297 #endif /* _GL_FCNTL_H */
298 #endif