; * etc/NEWS: Some more minor copyedits.
[emacs.git] / lib / fcntl.in.h
blob076d1ac34a7b0d94e89f143efd4a11a369ffad01
1 /* Like <fcntl.h>, but with non-working flags defined to 0.
3 Copyright (C) 2006-2017 Free Software Foundation, Inc.
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.
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.
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/>. */
18 /* written by Paul Eggert */
20 #if __GNUC__ >= 3
21 @PRAGMA_SYSTEM_HEADER@
22 #endif
23 @PRAGMA_COLUMNS@
25 #if defined __need_system_fcntl_h
26 /* Special invocation convention. */
28 /* Needed before <sys/stat.h>.
29 May also define off_t to a 64-bit type on native Windows. */
30 #include <sys/types.h>
31 /* On some systems other than glibc, <sys/stat.h> is a prerequisite of
32 <fcntl.h>. On glibc systems, we would like to avoid namespace pollution.
33 But on glibc systems, <fcntl.h> includes <sys/stat.h> inside an
34 extern "C" { ... } block, which leads to errors in C++ mode with the
35 overridden <sys/stat.h> from gnulib. These errors are known to be gone
36 with g++ version >= 4.3. */
37 #if !(defined __GLIBC__ || defined __UCLIBC__) || (defined __cplusplus && defined GNULIB_NAMESPACE && (defined __ICC || !(__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3))))
38 # include <sys/stat.h>
39 #endif
40 #@INCLUDE_NEXT@ @NEXT_FCNTL_H@
42 #else
43 /* Normal invocation convention. */
45 #ifndef _@GUARD_PREFIX@_FCNTL_H
47 /* Needed before <sys/stat.h>.
48 May also define off_t to a 64-bit type on native Windows. */
49 #include <sys/types.h>
50 /* On some systems other than glibc, <sys/stat.h> is a prerequisite of
51 <fcntl.h>. On glibc systems, we would like to avoid namespace pollution.
52 But on glibc systems, <fcntl.h> includes <sys/stat.h> inside an
53 extern "C" { ... } block, which leads to errors in C++ mode with the
54 overridden <sys/stat.h> from gnulib. These errors are known to be gone
55 with g++ version >= 4.3. */
56 #if !(defined __GLIBC__ || defined __UCLIBC__) || (defined __cplusplus && defined GNULIB_NAMESPACE && (defined __ICC || !(__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3))))
57 # include <sys/stat.h>
58 #endif
59 /* The include_next requires a split double-inclusion guard. */
60 #@INCLUDE_NEXT@ @NEXT_FCNTL_H@
62 #ifndef _@GUARD_PREFIX@_FCNTL_H
63 #define _@GUARD_PREFIX@_FCNTL_H
65 #ifndef __GLIBC__ /* Avoid namespace pollution on glibc systems. */
66 # include <unistd.h>
67 #endif
69 /* Native Windows platforms declare open(), creat() in <io.h>. */
70 #if (@GNULIB_OPEN@ || defined GNULIB_POSIXCHECK) \
71 && ((defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__)
72 # include <io.h>
73 #endif
76 /* The definitions of _GL_FUNCDECL_RPL etc. are copied here. */
78 /* The definition of _GL_ARG_NONNULL is copied here. */
80 /* The definition of _GL_WARN_ON_USE is copied here. */
83 /* Declare overridden functions. */
85 #if @GNULIB_FCNTL@
86 # if @REPLACE_FCNTL@
87 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
88 # undef fcntl
89 # define fcntl rpl_fcntl
90 # endif
91 _GL_FUNCDECL_RPL (fcntl, int, (int fd, int action, ...));
92 _GL_CXXALIAS_RPL (fcntl, int, (int fd, int action, ...));
93 # else
94 # if !@HAVE_FCNTL@
95 _GL_FUNCDECL_SYS (fcntl, int, (int fd, int action, ...));
96 # endif
97 _GL_CXXALIAS_SYS (fcntl, int, (int fd, int action, ...));
98 # endif
99 _GL_CXXALIASWARN (fcntl);
100 #elif defined GNULIB_POSIXCHECK
101 # undef fcntl
102 # if HAVE_RAW_DECL_FCNTL
103 _GL_WARN_ON_USE (fcntl, "fcntl is not always POSIX compliant - "
104 "use gnulib module fcntl for portability");
105 # endif
106 #endif
108 #if @GNULIB_OPEN@
109 # if @REPLACE_OPEN@
110 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
111 # undef open
112 # define open rpl_open
113 # endif
114 _GL_FUNCDECL_RPL (open, int, (const char *filename, int flags, ...)
115 _GL_ARG_NONNULL ((1)));
116 _GL_CXXALIAS_RPL (open, int, (const char *filename, int flags, ...));
117 # else
118 _GL_CXXALIAS_SYS (open, int, (const char *filename, int flags, ...));
119 # endif
120 /* On HP-UX 11, in C++ mode, open() is defined as an inline function with a
121 default argument. _GL_CXXALIASWARN does not work in this case. */
122 # if !defined __hpux
123 _GL_CXXALIASWARN (open);
124 # endif
125 #elif defined GNULIB_POSIXCHECK
126 # undef open
127 /* Assume open is always declared. */
128 _GL_WARN_ON_USE (open, "open is not always POSIX compliant - "
129 "use gnulib module open for portability");
130 #endif
132 #if @GNULIB_OPENAT@
133 # if @REPLACE_OPENAT@
134 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
135 # undef openat
136 # define openat rpl_openat
137 # endif
138 _GL_FUNCDECL_RPL (openat, int,
139 (int fd, char const *file, int flags, /* mode_t mode */ ...)
140 _GL_ARG_NONNULL ((2)));
141 _GL_CXXALIAS_RPL (openat, int,
142 (int fd, char const *file, int flags, /* mode_t mode */ ...));
143 # else
144 # if !@HAVE_OPENAT@
145 _GL_FUNCDECL_SYS (openat, int,
146 (int fd, char const *file, int flags, /* mode_t mode */ ...)
147 _GL_ARG_NONNULL ((2)));
148 # endif
149 _GL_CXXALIAS_SYS (openat, int,
150 (int fd, char const *file, int flags, /* mode_t mode */ ...));
151 # endif
152 _GL_CXXALIASWARN (openat);
153 #elif defined GNULIB_POSIXCHECK
154 # undef openat
155 # if HAVE_RAW_DECL_OPENAT
156 _GL_WARN_ON_USE (openat, "openat is not portable - "
157 "use gnulib module openat for portability");
158 # endif
159 #endif
162 /* Fix up the FD_* macros, only known to be missing on mingw. */
164 #ifndef FD_CLOEXEC
165 # define FD_CLOEXEC 1
166 #endif
168 /* Fix up the supported F_* macros. Intentionally leave other F_*
169 macros undefined. Only known to be missing on mingw. */
171 #ifndef F_DUPFD_CLOEXEC
172 # define F_DUPFD_CLOEXEC 0x40000000
173 /* Witness variable: 1 if gnulib defined F_DUPFD_CLOEXEC, 0 otherwise. */
174 # define GNULIB_defined_F_DUPFD_CLOEXEC 1
175 #else
176 # define GNULIB_defined_F_DUPFD_CLOEXEC 0
177 #endif
179 #ifndef F_DUPFD
180 # define F_DUPFD 1
181 #endif
183 #ifndef F_GETFD
184 # define F_GETFD 2
185 #endif
187 /* Fix up the O_* macros. */
189 /* AIX 7.1 with XL C 12.1 defines O_CLOEXEC, O_NOFOLLOW, and O_TTY_INIT
190 to values outside 'int' range, so omit these misdefinitions.
191 But avoid namespace pollution on non-AIX systems. */
192 #ifdef _AIX
193 # include <limits.h>
194 # if defined O_CLOEXEC && ! (INT_MIN <= O_CLOEXEC && O_CLOEXEC <= INT_MAX)
195 # undef O_CLOEXEC
196 # endif
197 # if defined O_NOFOLLOW && ! (INT_MIN <= O_NOFOLLOW && O_NOFOLLOW <= INT_MAX)
198 # undef O_NOFOLLOW
199 # endif
200 # if defined O_TTY_INIT && ! (INT_MIN <= O_TTY_INIT && O_TTY_INIT <= INT_MAX)
201 # undef O_TTY_INIT
202 # endif
203 #endif
205 #if !defined O_DIRECT && defined O_DIRECTIO
206 /* Tru64 spells it 'O_DIRECTIO'. */
207 # define O_DIRECT O_DIRECTIO
208 #endif
210 #if !defined O_CLOEXEC && defined O_NOINHERIT
211 /* Mingw spells it 'O_NOINHERIT'. */
212 # define O_CLOEXEC O_NOINHERIT
213 #endif
215 #ifndef O_CLOEXEC
216 # define O_CLOEXEC 0x40000000 /* Try to not collide with system O_* flags. */
217 # define GNULIB_defined_O_CLOEXEC 1
218 #else
219 # define GNULIB_defined_O_CLOEXEC 0
220 #endif
222 #ifndef O_DIRECT
223 # define O_DIRECT 0
224 #endif
226 #ifndef O_DIRECTORY
227 # define O_DIRECTORY 0
228 #endif
230 #ifndef O_DSYNC
231 # define O_DSYNC 0
232 #endif
234 #ifndef O_EXEC
235 # define O_EXEC O_RDONLY /* This is often close enough in older systems. */
236 #endif
238 #ifndef O_IGNORE_CTTY
239 # define O_IGNORE_CTTY 0
240 #endif
242 #ifndef O_NDELAY
243 # define O_NDELAY 0
244 #endif
246 #ifndef O_NOATIME
247 # define O_NOATIME 0
248 #endif
250 #ifndef O_NONBLOCK
251 # define O_NONBLOCK O_NDELAY
252 #endif
254 /* If the gnulib module 'nonblocking' is in use, guarantee a working non-zero
255 value of O_NONBLOCK. Otherwise, O_NONBLOCK is defined (above) to O_NDELAY
256 or to 0 as fallback. */
257 #if @GNULIB_NONBLOCKING@
258 # if O_NONBLOCK
259 # define GNULIB_defined_O_NONBLOCK 0
260 # else
261 # define GNULIB_defined_O_NONBLOCK 1
262 # undef O_NONBLOCK
263 # define O_NONBLOCK 0x40000000
264 # endif
265 #endif
267 #ifndef O_NOCTTY
268 # define O_NOCTTY 0
269 #endif
271 #ifndef O_NOFOLLOW
272 # define O_NOFOLLOW 0
273 #endif
275 #ifndef O_NOLINK
276 # define O_NOLINK 0
277 #endif
279 #ifndef O_NOLINKS
280 # define O_NOLINKS 0
281 #endif
283 #ifndef O_NOTRANS
284 # define O_NOTRANS 0
285 #endif
287 #ifndef O_RSYNC
288 # define O_RSYNC 0
289 #endif
291 #ifndef O_SEARCH
292 # define O_SEARCH O_RDONLY /* This is often close enough in older systems. */
293 #endif
295 #ifndef O_SYNC
296 # define O_SYNC 0
297 #endif
299 #ifndef O_TTY_INIT
300 # define O_TTY_INIT 0
301 #endif
303 #if ~O_ACCMODE & (O_RDONLY | O_WRONLY | O_RDWR | O_EXEC | O_SEARCH)
304 # undef O_ACCMODE
305 # define O_ACCMODE (O_RDONLY | O_WRONLY | O_RDWR | O_EXEC | O_SEARCH)
306 #endif
308 /* For systems that distinguish between text and binary I/O.
309 O_BINARY is usually declared in fcntl.h */
310 #if !defined O_BINARY && defined _O_BINARY
311 /* For MSC-compatible compilers. */
312 # define O_BINARY _O_BINARY
313 # define O_TEXT _O_TEXT
314 #endif
316 #if defined __BEOS__ || defined __HAIKU__
317 /* BeOS 5 and Haiku have O_BINARY and O_TEXT, but they have no effect. */
318 # undef O_BINARY
319 # undef O_TEXT
320 #endif
322 #ifndef O_BINARY
323 # define O_BINARY 0
324 # define O_TEXT 0
325 #endif
327 /* Fix up the AT_* macros. */
329 /* Work around a bug in Solaris 9 and 10: AT_FDCWD is positive. Its
330 value exceeds INT_MAX, so its use as an int doesn't conform to the
331 C standard, and GCC and Sun C complain in some cases. If the bug
332 is present, undef AT_FDCWD here, so it can be redefined below. */
333 #if 0 < AT_FDCWD && AT_FDCWD == 0xffd19553
334 # undef AT_FDCWD
335 #endif
337 /* Use the same bit pattern as Solaris 9, but with the proper
338 signedness. The bit pattern is important, in case this actually is
339 Solaris with the above workaround. */
340 #ifndef AT_FDCWD
341 # define AT_FDCWD (-3041965)
342 #endif
344 /* Use the same values as Solaris 9. This shouldn't matter, but
345 there's no real reason to differ. */
346 #ifndef AT_SYMLINK_NOFOLLOW
347 # define AT_SYMLINK_NOFOLLOW 4096
348 #endif
350 #ifndef AT_REMOVEDIR
351 # define AT_REMOVEDIR 1
352 #endif
354 /* Solaris 9 lacks these two, so just pick unique values. */
355 #ifndef AT_SYMLINK_FOLLOW
356 # define AT_SYMLINK_FOLLOW 2
357 #endif
359 #ifndef AT_EACCESS
360 # define AT_EACCESS 4
361 #endif
364 #endif /* _@GUARD_PREFIX@_FCNTL_H */
365 #endif /* _@GUARD_PREFIX@_FCNTL_H */
366 #endif