Oops, fix mistake in last commit.
[gnulib.git] / lib / unistd.in.h
1 /* Substitute for and wrapper around <unistd.h>.
2    Copyright (C) 2003-2010 Free Software Foundation, Inc.
3
4    This program is free software; you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation; either version 2, or (at your option)
7    any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program; if not, write to the Free Software Foundation,
16    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
17
18 #if __GNUC__ >= 3
19 @PRAGMA_SYSTEM_HEADER@
20 #endif
21 @PRAGMA_COLUMNS@
22
23 /* Special invocation convention:
24    - On mingw, several headers, including <winsock2.h>, include <unistd.h>,
25      but we need to ensure that both the system <unistd.h> and <winsock2.h>
26      are completely included before we replace gethostname.  */
27 #if @GNULIB_GETHOSTNAME@ && @UNISTD_H_HAVE_WINSOCK2_H@ \
28   && !defined _GL_WINSOCK2_H_WITNESS && defined _WINSOCK2_H
29 /* <unistd.h> is being indirectly included for the first time from
30    <winsock2.h>; avoid declaring any overrides.  */
31 # if @HAVE_UNISTD_H@
32 #  @INCLUDE_NEXT@ @NEXT_UNISTD_H@
33 # else
34 #  error unexpected; report this to bug-gnulib@gnu.org
35 # endif
36 # define _GL_WINSOCK2_H_WITNESS
37
38 /* Normal invocation.  */
39 #elif !defined _GL_UNISTD_H
40
41 /* The include_next requires a split double-inclusion guard.  */
42 #if @HAVE_UNISTD_H@
43 # @INCLUDE_NEXT@ @NEXT_UNISTD_H@
44 #endif
45
46 /* Get all possible declarations of gethostname().  */
47 #if @GNULIB_GETHOSTNAME@ && @UNISTD_H_HAVE_WINSOCK2_H@ \
48   && !defined _GL_INCLUDING_WINSOCK2_H
49 # define _GL_INCLUDING_WINSOCK2_H
50 # include <winsock2.h>
51 # undef _GL_INCLUDING_WINSOCK2_H
52 #endif
53
54 #if !defined _GL_UNISTD_H && !defined _GL_INCLUDING_WINSOCK2_H
55 #define _GL_UNISTD_H
56
57 /* NetBSD 5.0 mis-defines NULL.  Also get size_t.  */
58 #include <stddef.h>
59
60 /* mingw doesn't define the SEEK_* or *_FILENO macros in <unistd.h>.  */
61 /* Cygwin 1.7.1 declares symlinkat in <stdio.h>, not in <unistd.h>.  */
62 /* But avoid namespace pollution on glibc systems.  */
63 #if (!(defined SEEK_CUR && defined SEEK_END && defined SEEK_SET) \
64      || ((@GNULIB_SYMLINKAT@ || defined GNULIB_POSIXCHECK) \
65          && defined __CYGWIN__)) \
66     && ! defined __GLIBC__
67 # include <stdio.h>
68 #endif
69
70 /* Cygwin 1.7.1 declares unlinkat in <fcntl.h>, not in <unistd.h>.  */
71 /* But avoid namespace pollution on glibc systems.  */
72 #if (@GNULIB_UNLINKAT@ || defined GNULIB_POSIXCHECK) && defined __CYGWIN__ \
73     && ! defined __GLIBC__
74 # include <fcntl.h>
75 #endif
76
77 /* mingw fails to declare _exit in <unistd.h>.  */
78 /* mingw, BeOS, Haiku declare environ in <stdlib.h>, not in <unistd.h>.  */
79 /* Solaris declares getcwd not only in <unistd.h> but also in <stdlib.h>.  */
80 /* But avoid namespace pollution on glibc systems.  */
81 #ifndef __GLIBC__
82 # include <stdlib.h>
83 #endif
84
85 /* mingw declares getcwd in <io.h>, not in <unistd.h>.  */
86 #if ((@GNULIB_GETCWD@ || defined GNULIB_POSIXCHECK) \
87      && ((defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__))
88 # include <io.h>
89 #endif
90
91 /* AIX and OSF/1 5.1 declare getdomainname in <netdb.h>, not in <unistd.h>.  */
92 /* But avoid namespace pollution on glibc systems.  */
93 #if @GNULIB_GETDOMAINNAME@ && (defined _AIX || defined __osf__) \
94     && !defined __GLIBC__
95 # include <netdb.h>
96 #endif
97
98 #if (@GNULIB_WRITE@ || @GNULIB_READLINK@ || @GNULIB_READLINKAT@ \
99      || @GNULIB_PREAD@ || @GNULIB_PWRITE@ || defined GNULIB_POSIXCHECK)
100 /* Get ssize_t.  */
101 # include <sys/types.h>
102 #endif
103
104 /* Get getopt(), optarg, optind, opterr, optopt.
105    But avoid namespace pollution on glibc systems.  */
106 #if @GNULIB_UNISTD_H_GETOPT@ && !defined __GLIBC__ && !defined _GL_SYSTEM_GETOPT
107 # include <getopt.h>
108 #endif
109
110 /* The definitions of _GL_FUNCDECL_RPL etc. are copied here.  */
111
112 /* The definition of _GL_ARG_NONNULL is copied here.  */
113
114 /* The definition of _GL_WARN_ON_USE is copied here.  */
115
116
117 #if @GNULIB_GETHOSTNAME@
118 /* Get all possible declarations of gethostname().  */
119 # if @UNISTD_H_HAVE_WINSOCK2_H@
120 #  if !defined _GL_SYS_SOCKET_H
121 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
122 #    undef socket
123 #    define socket              socket_used_without_including_sys_socket_h
124 #    undef connect
125 #    define connect             connect_used_without_including_sys_socket_h
126 #    undef accept
127 #    define accept              accept_used_without_including_sys_socket_h
128 #    undef bind
129 #    define bind                bind_used_without_including_sys_socket_h
130 #    undef getpeername
131 #    define getpeername         getpeername_used_without_including_sys_socket_h
132 #    undef getsockname
133 #    define getsockname         getsockname_used_without_including_sys_socket_h
134 #    undef getsockopt
135 #    define getsockopt          getsockopt_used_without_including_sys_socket_h
136 #    undef listen
137 #    define listen              listen_used_without_including_sys_socket_h
138 #    undef recv
139 #    define recv                recv_used_without_including_sys_socket_h
140 #    undef send
141 #    define send                send_used_without_including_sys_socket_h
142 #    undef recvfrom
143 #    define recvfrom            recvfrom_used_without_including_sys_socket_h
144 #    undef sendto
145 #    define sendto              sendto_used_without_including_sys_socket_h
146 #    undef setsockopt
147 #    define setsockopt          setsockopt_used_without_including_sys_socket_h
148 #    undef shutdown
149 #    define shutdown            shutdown_used_without_including_sys_socket_h
150 #   else
151      _GL_WARN_ON_USE (socket,
152                       "socket() used without including <sys/socket.h>");
153      _GL_WARN_ON_USE (connect,
154                       "connect() used without including <sys/socket.h>");
155      _GL_WARN_ON_USE (accept,
156                       "accept() used without including <sys/socket.h>");
157      _GL_WARN_ON_USE (bind,
158                       "bind() used without including <sys/socket.h>");
159      _GL_WARN_ON_USE (getpeername,
160                       "getpeername() used without including <sys/socket.h>");
161      _GL_WARN_ON_USE (getsockname,
162                       "getsockname() used without including <sys/socket.h>");
163      _GL_WARN_ON_USE (getsockopt,
164                       "getsockopt() used without including <sys/socket.h>");
165      _GL_WARN_ON_USE (listen,
166                       "listen() used without including <sys/socket.h>");
167      _GL_WARN_ON_USE (recv,
168                       "recv() used without including <sys/socket.h>");
169      _GL_WARN_ON_USE (send,
170                       "send() used without including <sys/socket.h>");
171      _GL_WARN_ON_USE (recvfrom,
172                       "recvfrom() used without including <sys/socket.h>");
173      _GL_WARN_ON_USE (sendto,
174                       "sendto() used without including <sys/socket.h>");
175      _GL_WARN_ON_USE (setsockopt,
176                       "setsockopt() used without including <sys/socket.h>");
177      _GL_WARN_ON_USE (shutdown,
178                       "shutdown() used without including <sys/socket.h>");
179 #   endif
180 #  endif
181 #  if !defined _GL_SYS_SELECT_H
182 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
183 #    undef select
184 #    define select              select_used_without_including_sys_select_h
185 #   else
186      _GL_WARN_ON_USE (select,
187                       "select() used without including <sys/select.h>");
188 #   endif
189 #  endif
190 # endif
191 #endif
192
193
194 /* OS/2 EMX lacks these macros.  */
195 #ifndef STDIN_FILENO
196 # define STDIN_FILENO 0
197 #endif
198 #ifndef STDOUT_FILENO
199 # define STDOUT_FILENO 1
200 #endif
201 #ifndef STDERR_FILENO
202 # define STDERR_FILENO 2
203 #endif
204
205 /* Ensure *_OK macros exist.  */
206 #ifndef F_OK
207 # define F_OK 0
208 # define X_OK 1
209 # define W_OK 2
210 # define R_OK 4
211 #endif
212
213
214 /* Declare overridden functions.  */
215
216
217 #if defined GNULIB_POSIXCHECK
218 /* The access() function is a security risk.  */
219 _GL_WARN_ON_USE (access, "the access function is a security risk - "
220                  "use the gnulib module faccessat instead");
221 #endif
222
223
224 #if @GNULIB_CHOWN@
225 /* Change the owner of FILE to UID (if UID is not -1) and the group of FILE
226    to GID (if GID is not -1).  Follow symbolic links.
227    Return 0 if successful, otherwise -1 and errno set.
228    See the POSIX:2001 specification
229    <http://www.opengroup.org/susv3xsh/chown.html>.  */
230 # if @REPLACE_CHOWN@
231 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
232 #   undef chown
233 #   define chown rpl_chown
234 #  endif
235 _GL_FUNCDECL_RPL (chown, int, (const char *file, uid_t uid, gid_t gid)
236                               _GL_ARG_NONNULL ((1)));
237 _GL_CXXALIAS_RPL (chown, int, (const char *file, uid_t uid, gid_t gid));
238 # else
239 #  if !@HAVE_CHOWN@
240 _GL_FUNCDECL_SYS (chown, int, (const char *file, uid_t uid, gid_t gid)
241                               _GL_ARG_NONNULL ((1)));
242 #  endif
243 _GL_CXXALIAS_SYS (chown, int, (const char *file, uid_t uid, gid_t gid));
244 # endif
245 _GL_CXXALIASWARN (chown);
246 #elif defined GNULIB_POSIXCHECK
247 # undef chown
248 # if HAVE_RAW_DECL_CHOWN
249 _GL_WARN_ON_USE (chown, "chown fails to follow symlinks on some systems and "
250                  "doesn't treat a uid or gid of -1 on some systems - "
251                  "use gnulib module chown for portability");
252 # endif
253 #endif
254
255
256 #if @GNULIB_CLOSE@
257 # if @REPLACE_CLOSE@
258 /* Automatically included by modules that need a replacement for close.  */
259 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
260 #   undef close
261 #   define close rpl_close
262 #  endif
263 _GL_FUNCDECL_RPL (close, int, (int fd));
264 _GL_CXXALIAS_RPL (close, int, (int fd));
265 # else
266 _GL_CXXALIAS_SYS (close, int, (int fd));
267 # endif
268 _GL_CXXALIASWARN (close);
269 #elif @UNISTD_H_HAVE_WINSOCK2_H_AND_USE_SOCKETS@
270 # undef close
271 # define close close_used_without_requesting_gnulib_module_close
272 #elif defined GNULIB_POSIXCHECK
273 # undef close
274 /* Assume close is always declared.  */
275 _GL_WARN_ON_USE (close, "close does not portably work on sockets - "
276                  "use gnulib module close for portability");
277 #endif
278
279
280 #if @REPLACE_DUP@
281 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
282 #  define dup rpl_dup
283 # endif
284 _GL_FUNCDECL_RPL (dup, int, (int oldfd));
285 _GL_CXXALIAS_RPL (dup, int, (int oldfd));
286 #else
287 _GL_CXXALIAS_SYS (dup, int, (int oldfd));
288 #endif
289 _GL_CXXALIASWARN (dup);
290
291
292 #if @GNULIB_DUP2@
293 /* Copy the file descriptor OLDFD into file descriptor NEWFD.  Do nothing if
294    NEWFD = OLDFD, otherwise close NEWFD first if it is open.
295    Return newfd if successful, otherwise -1 and errno set.
296    See the POSIX:2001 specification
297    <http://www.opengroup.org/susv3xsh/dup2.html>.  */
298 # if @REPLACE_DUP2@
299 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
300 #   define dup2 rpl_dup2
301 #  endif
302 _GL_FUNCDECL_RPL (dup2, int, (int oldfd, int newfd));
303 _GL_CXXALIAS_RPL (dup2, int, (int oldfd, int newfd));
304 # else
305 #  if !@HAVE_DUP2@
306 _GL_FUNCDECL_SYS (dup2, int, (int oldfd, int newfd));
307 #  endif
308 _GL_CXXALIAS_SYS (dup2, int, (int oldfd, int newfd));
309 # endif
310 _GL_CXXALIASWARN (dup2);
311 #elif defined GNULIB_POSIXCHECK
312 # undef dup2
313 # if HAVE_RAW_DECL_DUP2
314 _GL_WARN_ON_USE (dup2, "dup2 is unportable - "
315                  "use gnulib module dup2 for portability");
316 # endif
317 #endif
318
319
320 #if @GNULIB_DUP3@
321 /* Copy the file descriptor OLDFD into file descriptor NEWFD, with the
322    specified flags.
323    The flags are a bitmask, possibly including O_CLOEXEC (defined in <fcntl.h>)
324    and O_TEXT, O_BINARY (defined in "binary-io.h").
325    Close NEWFD first if it is open.
326    Return newfd if successful, otherwise -1 and errno set.
327    See the Linux man page at
328    <http://www.kernel.org/doc/man-pages/online/pages/man2/dup3.2.html>.  */
329 # if @HAVE_DUP3@
330 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
331 #   define dup3 rpl_dup3
332 #  endif
333 _GL_FUNCDECL_RPL (dup3, int, (int oldfd, int newfd, int flags));
334 _GL_CXXALIAS_RPL (dup3, int, (int oldfd, int newfd, int flags));
335 # else
336 _GL_FUNCDECL_SYS (dup3, int, (int oldfd, int newfd, int flags));
337 _GL_CXXALIAS_SYS (dup3, int, (int oldfd, int newfd, int flags));
338 # endif
339 _GL_CXXALIASWARN (dup3);
340 #elif defined GNULIB_POSIXCHECK
341 # undef dup3
342 # if HAVE_RAW_DECL_DUP3
343 _GL_WARN_ON_USE (dup3, "dup3 is unportable - "
344                  "use gnulib module dup3 for portability");
345 # endif
346 #endif
347
348
349 #if @GNULIB_ENVIRON@
350 # if !@HAVE_DECL_ENVIRON@
351 /* Set of environment variables and values.  An array of strings of the form
352    "VARIABLE=VALUE", terminated with a NULL.  */
353 #  if defined __APPLE__ && defined __MACH__
354 #   include <crt_externs.h>
355 #   define environ (*_NSGetEnviron ())
356 #  else
357 #   ifdef __cplusplus
358 extern "C" {
359 #   endif
360 extern char **environ;
361 #   ifdef __cplusplus
362 }
363 #   endif
364 #  endif
365 # endif
366 #elif defined GNULIB_POSIXCHECK
367 # if HAVE_RAW_DECL_ENVIRON
368 static inline char ***
369 rpl_environ (void)
370 {
371   return &environ;
372 }
373 _GL_WARN_ON_USE (rpl_environ, "environ is unportable - "
374                  "use gnulib module environ for portability");
375 #  undef environ
376 #  define environ (*rpl_environ ())
377 # endif
378 #endif
379
380
381 #if @GNULIB_EUIDACCESS@
382 /* Like access(), except that it uses the effective user id and group id of
383    the current process.  */
384 # if !@HAVE_EUIDACCESS@
385 _GL_FUNCDECL_SYS (euidaccess, int, (const char *filename, int mode)
386                                    _GL_ARG_NONNULL ((1)));
387 # endif
388 _GL_CXXALIAS_SYS (euidaccess, int, (const char *filename, int mode));
389 _GL_CXXALIASWARN (euidaccess);
390 # if defined GNULIB_POSIXCHECK
391 /* Like access(), this function is a security risk.  */
392 _GL_WARN_ON_USE (euidaccess, "the euidaccess function is a security risk - "
393                  "use the gnulib module faccessat instead");
394 # endif
395 #elif defined GNULIB_POSIXCHECK
396 # undef euidaccess
397 # if HAVE_RAW_DECL_EUIDACCESS
398 _GL_WARN_ON_USE (euidaccess, "euidaccess is unportable - "
399                  "use gnulib module euidaccess for portability");
400 # endif
401 #endif
402
403
404 #if @GNULIB_FACCESSAT@
405 # if !@HAVE_FACCESSAT@
406 _GL_FUNCDECL_SYS (faccessat, int,
407                   (int fd, char const *file, int mode, int flag)
408                   _GL_ARG_NONNULL ((2)));
409 # endif
410 _GL_CXXALIAS_SYS (faccessat, int,
411                   (int fd, char const *file, int mode, int flag));
412 _GL_CXXALIASWARN (faccessat);
413 #elif defined GNULIB_POSIXCHECK
414 # undef faccessat
415 # if HAVE_RAW_DECL_FACCESSAT
416 _GL_WARN_ON_USE (faccessat, "faccessat is not portable - "
417                  "use gnulib module faccessat for portability");
418 # endif
419 #endif
420
421
422 #if @GNULIB_FCHDIR@
423 /* Change the process' current working directory to the directory on which
424    the given file descriptor is open.
425    Return 0 if successful, otherwise -1 and errno set.
426    See the POSIX:2001 specification
427    <http://www.opengroup.org/susv3xsh/fchdir.html>.  */
428 # if ! @HAVE_FCHDIR@
429 _GL_FUNCDECL_SYS (fchdir, int, (int /*fd*/));
430
431 /* Gnulib internal hooks needed to maintain the fchdir metadata.  */
432 _GL_EXTERN_C int _gl_register_fd (int fd, const char *filename)
433      _GL_ARG_NONNULL ((2));
434 _GL_EXTERN_C void _gl_unregister_fd (int fd);
435 _GL_EXTERN_C int _gl_register_dup (int oldfd, int newfd);
436 _GL_EXTERN_C const char *_gl_directory_name (int fd);
437
438 # endif
439 _GL_CXXALIAS_SYS (fchdir, int, (int /*fd*/));
440 _GL_CXXALIASWARN (fchdir);
441 #elif defined GNULIB_POSIXCHECK
442 # undef fchdir
443 # if HAVE_RAW_DECL_FCHDIR
444 _GL_WARN_ON_USE (fchdir, "fchdir is unportable - "
445                  "use gnulib module fchdir for portability");
446 # endif
447 #endif
448
449
450 #if @GNULIB_FCHOWNAT@
451 # if @REPLACE_FCHOWNAT@
452 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
453 #   undef fchownat
454 #   define fchownat rpl_fchownat
455 #  endif
456 _GL_FUNCDECL_RPL (fchownat, int, (int fd, char const *file,
457                                   uid_t owner, gid_t group, int flag)
458                                  _GL_ARG_NONNULL ((2)));
459 _GL_CXXALIAS_RPL (fchownat, int, (int fd, char const *file,
460                                   uid_t owner, gid_t group, int flag));
461 # else
462 #  if !@HAVE_FCHOWNAT@
463 _GL_FUNCDECL_SYS (fchownat, int, (int fd, char const *file,
464                                   uid_t owner, gid_t group, int flag)
465                                  _GL_ARG_NONNULL ((2)));
466 #  endif
467 _GL_CXXALIAS_SYS (fchownat, int, (int fd, char const *file,
468                                   uid_t owner, gid_t group, int flag));
469 # endif
470 _GL_CXXALIASWARN (fchownat);
471 #elif defined GNULIB_POSIXCHECK
472 # undef fchownat
473 # if HAVE_RAW_DECL_FCHOWNAT
474 _GL_WARN_ON_USE (fchownat, "fchownat is not portable - "
475                  "use gnulib module openat for portability");
476 # endif
477 #endif
478
479
480 #if @GNULIB_FSYNC@
481 /* Synchronize changes to a file.
482    Return 0 if successful, otherwise -1 and errno set.
483    See POSIX:2001 specification
484    <http://www.opengroup.org/susv3xsh/fsync.html>.  */
485 # if !@HAVE_FSYNC@
486 _GL_FUNCDECL_SYS (fsync, int, (int fd));
487 # endif
488 _GL_CXXALIAS_SYS (fsync, int, (int fd));
489 _GL_CXXALIASWARN (fsync);
490 #elif defined GNULIB_POSIXCHECK
491 # undef fsync
492 # if HAVE_RAW_DECL_FSYNC
493 _GL_WARN_ON_USE (fsync, "fsync is unportable - "
494                  "use gnulib module fsync for portability");
495 # endif
496 #endif
497
498
499 #if @GNULIB_FTRUNCATE@
500 /* Change the size of the file to which FD is opened to become equal to LENGTH.
501    Return 0 if successful, otherwise -1 and errno set.
502    See the POSIX:2001 specification
503    <http://www.opengroup.org/susv3xsh/ftruncate.html>.  */
504 # if !@HAVE_FTRUNCATE@
505 _GL_FUNCDECL_SYS (ftruncate, int, (int fd, off_t length));
506 # endif
507 _GL_CXXALIAS_SYS (ftruncate, int, (int fd, off_t length));
508 _GL_CXXALIASWARN (ftruncate);
509 #elif defined GNULIB_POSIXCHECK
510 # undef ftruncate
511 # if HAVE_RAW_DECL_FTRUNCATE
512 _GL_WARN_ON_USE (ftruncate, "ftruncate is unportable - "
513                  "use gnulib module ftruncate for portability");
514 # endif
515 #endif
516
517
518 #if @GNULIB_GETCWD@
519 /* Get the name of the current working directory, and put it in SIZE bytes
520    of BUF.
521    Return BUF if successful, or NULL if the directory couldn't be determined
522    or SIZE was too small.
523    See the POSIX:2001 specification
524    <http://www.opengroup.org/susv3xsh/getcwd.html>.
525    Additionally, the gnulib module 'getcwd' guarantees the following GNU
526    extension: If BUF is NULL, an array is allocated with 'malloc'; the array
527    is SIZE bytes long, unless SIZE == 0, in which case it is as big as
528    necessary.  */
529 # if @REPLACE_GETCWD@
530 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
531 #   define getcwd rpl_getcwd
532 #  endif
533 _GL_FUNCDECL_RPL (getcwd, char *, (char *buf, size_t size));
534 _GL_CXXALIAS_RPL (getcwd, char *, (char *buf, size_t size));
535 # else
536 /* Need to cast, because on mingw, the second parameter is
537                                                    int size.  */
538 _GL_CXXALIAS_SYS_CAST (getcwd, char *, (char *buf, size_t size));
539 # endif
540 _GL_CXXALIASWARN (getcwd);
541 #elif defined GNULIB_POSIXCHECK
542 # undef getcwd
543 # if HAVE_RAW_DECL_GETCWD
544 _GL_WARN_ON_USE (getcwd, "getcwd is unportable - "
545                  "use gnulib module getcwd for portability");
546 # endif
547 #endif
548
549
550 #if @GNULIB_GETDOMAINNAME@
551 /* Return the NIS domain name of the machine.
552    WARNING! The NIS domain name is unrelated to the fully qualified host name
553             of the machine.  It is also unrelated to email addresses.
554    WARNING! The NIS domain name is usually the empty string or "(none)" when
555             not using NIS.
556
557    Put up to LEN bytes of the NIS domain name into NAME.
558    Null terminate it if the name is shorter than LEN.
559    If the NIS domain name is longer than LEN, set errno = EINVAL and return -1.
560    Return 0 if successful, otherwise set errno and return -1.  */
561 # if @REPLACE_GETDOMAINNAME@
562 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
563 #   undef getdomainname
564 #   define getdomainname rpl_getdomainname
565 #  endif
566 _GL_FUNCDECL_RPL (getdomainname, int, (char *name, size_t len)
567                                       _GL_ARG_NONNULL ((1)));
568 _GL_CXXALIAS_RPL (getdomainname, int, (char *name, size_t len));
569 # else
570 #  if !@HAVE_DECL_GETDOMAINNAME@
571 _GL_FUNCDECL_SYS (getdomainname, int, (char *name, size_t len)
572                                       _GL_ARG_NONNULL ((1)));
573 #  endif
574 _GL_CXXALIAS_SYS (getdomainname, int, (char *name, size_t len));
575 # endif
576 _GL_CXXALIASWARN (getdomainname);
577 #elif defined GNULIB_POSIXCHECK
578 # undef getdomainname
579 # if HAVE_RAW_DECL_GETDOMAINNAME
580 _GL_WARN_ON_USE (getdomainname, "getdomainname is unportable - "
581                  "use gnulib module getdomainname for portability");
582 # endif
583 #endif
584
585
586 #if @GNULIB_GETDTABLESIZE@
587 /* Return the maximum number of file descriptors in the current process.
588    In POSIX, this is same as sysconf (_SC_OPEN_MAX).  */
589 # if !@HAVE_GETDTABLESIZE@
590 _GL_FUNCDECL_SYS (getdtablesize, int, (void));
591 # endif
592 _GL_CXXALIAS_SYS (getdtablesize, int, (void));
593 _GL_CXXALIASWARN (getdtablesize);
594 #elif defined GNULIB_POSIXCHECK
595 # undef getdtablesize
596 # if HAVE_RAW_DECL_GETDTABLESIZE
597 _GL_WARN_ON_USE (getdtablesize, "getdtablesize is unportable - "
598                  "use gnulib module getdtablesize for portability");
599 # endif
600 #endif
601
602
603 #if @GNULIB_GETGROUPS@
604 /* Return the supplemental groups that the current process belongs to.
605    It is unspecified whether the effective group id is in the list.
606    If N is 0, return the group count; otherwise, N describes how many
607    entries are available in GROUPS.  Return -1 and set errno if N is
608    not 0 and not large enough.  Fails with ENOSYS on some systems.  */
609 # if @REPLACE_GETGROUPS@
610 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
611 #   undef getgroups
612 #   define getgroups rpl_getgroups
613 #  endif
614 _GL_FUNCDECL_RPL (getgroups, int, (int n, gid_t *groups));
615 _GL_CXXALIAS_RPL (getgroups, int, (int n, gid_t *groups));
616 # else
617 #  if !@HAVE_GETGROUPS@
618 _GL_FUNCDECL_SYS (getgroups, int, (int n, gid_t *groups));
619 #  endif
620 _GL_CXXALIAS_SYS (getgroups, int, (int n, gid_t *groups));
621 # endif
622 _GL_CXXALIASWARN (getgroups);
623 #elif defined GNULIB_POSIXCHECK
624 # undef getgroups
625 # if HAVE_RAW_DECL_GETGROUPS
626 _GL_WARN_ON_USE (getgroups, "getgroups is unportable - "
627                  "use gnulib module getgroups for portability");
628 # endif
629 #endif
630
631
632 #if @GNULIB_GETHOSTNAME@
633 /* Return the standard host name of the machine.
634    WARNING! The host name may or may not be fully qualified.
635
636    Put up to LEN bytes of the host name into NAME.
637    Null terminate it if the name is shorter than LEN.
638    If the host name is longer than LEN, set errno = EINVAL and return -1.
639    Return 0 if successful, otherwise set errno and return -1.  */
640 # if @UNISTD_H_HAVE_WINSOCK2_H@
641 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
642 #   undef gethostname
643 #   define gethostname rpl_gethostname
644 #  endif
645 _GL_FUNCDECL_RPL (gethostname, int, (char *name, size_t len)
646                                     _GL_ARG_NONNULL ((1)));
647 _GL_CXXALIAS_RPL (gethostname, int, (char *name, size_t len));
648 # else
649 #  if !@HAVE_GETHOSTNAME@
650 _GL_FUNCDECL_SYS (gethostname, int, (char *name, size_t len)
651                                     _GL_ARG_NONNULL ((1)));
652 #  endif
653 /* Need to cast, because on Solaris 10 systems, the second parameter is
654                                                       int len.  */
655 _GL_CXXALIAS_SYS_CAST (gethostname, int, (char *name, size_t len));
656 # endif
657 _GL_CXXALIASWARN (gethostname);
658 #elif @UNISTD_H_HAVE_WINSOCK2_H@
659 # undef gethostname
660 # define gethostname gethostname_used_without_requesting_gnulib_module_gethostname
661 #elif defined GNULIB_POSIXCHECK
662 # undef gethostname
663 # if HAVE_RAW_DECL_GETHOSTNAME
664 _GL_WARN_ON_USE (gethostname, "gethostname is unportable - "
665                  "use gnulib module gethostname for portability");
666 # endif
667 #endif
668
669
670 #if @GNULIB_GETLOGIN@
671 /* Returns the user's login name, or NULL if it cannot be found.  Upon error,
672    returns NULL with errno set.
673
674    See <http://www.opengroup.org/susv3xsh/getlogin.html>.
675
676    Most programs don't need to use this function, because the information is
677    available through environment variables:
678      ${LOGNAME-$USER}        on Unix platforms,
679      $USERNAME               on native Windows platforms.
680  */
681 # if !@HAVE_GETLOGIN@
682 _GL_FUNCDECL_SYS (getlogin, char *, (void));
683 # endif
684 _GL_CXXALIAS_SYS (getlogin, char *, (void));
685 _GL_CXXALIASWARN (getlogin);
686 #elif defined GNULIB_POSIXCHECK
687 # undef getlogin
688 # if HAVE_RAW_DECL_GETLOGIN
689 _GL_WARN_ON_USE (getlogin, "getlogin is unportable - "
690                  "use gnulib module getlogin for portability");
691 # endif
692 #endif
693
694
695 #if @GNULIB_GETLOGIN_R@
696 /* Copies the user's login name to NAME.
697    The array pointed to by NAME has room for SIZE bytes.
698
699    Returns 0 if successful.  Upon error, an error number is returned, or -1 in
700    the case that the login name cannot be found but no specific error is
701    provided (this case is hopefully rare but is left open by the POSIX spec).
702
703    See <http://www.opengroup.org/susv3xsh/getlogin.html>.
704
705    Most programs don't need to use this function, because the information is
706    available through environment variables:
707      ${LOGNAME-$USER}        on Unix platforms,
708      $USERNAME               on native Windows platforms.
709  */
710 # if !@HAVE_DECL_GETLOGIN_R@
711 _GL_FUNCDECL_SYS (getlogin_r, int, (char *name, size_t size)
712                                    _GL_ARG_NONNULL ((1)));
713 # endif
714 /* Need to cast, because on Solaris 10 systems, the second argument is
715                                                      int size.  */
716 _GL_CXXALIAS_SYS_CAST (getlogin_r, int, (char *name, size_t size));
717 _GL_CXXALIASWARN (getlogin_r);
718 #elif defined GNULIB_POSIXCHECK
719 # undef getlogin_r
720 # if HAVE_RAW_DECL_GETLOGIN_R
721 _GL_WARN_ON_USE (getlogin_r, "getlogin_r is unportable - "
722                  "use gnulib module getlogin_r for portability");
723 # endif
724 #endif
725
726
727 #if @GNULIB_GETPAGESIZE@
728 # if @REPLACE_GETPAGESIZE@
729 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
730 #   define getpagesize rpl_getpagesize
731 #  endif
732 _GL_FUNCDECL_RPL (getpagesize, int, (void));
733 _GL_CXXALIAS_RPL (getpagesize, int, (void));
734 # else
735 #  if !@HAVE_GETPAGESIZE@
736 #   if !defined getpagesize
737 /* This is for POSIX systems.  */
738 #    if !defined _gl_getpagesize && defined _SC_PAGESIZE
739 #     if ! (defined __VMS && __VMS_VER < 70000000)
740 #      define _gl_getpagesize() sysconf (_SC_PAGESIZE)
741 #     endif
742 #    endif
743 /* This is for older VMS.  */
744 #    if !defined _gl_getpagesize && defined __VMS
745 #     ifdef __ALPHA
746 #      define _gl_getpagesize() 8192
747 #     else
748 #      define _gl_getpagesize() 512
749 #     endif
750 #    endif
751 /* This is for BeOS.  */
752 #    if !defined _gl_getpagesize && @HAVE_OS_H@
753 #     include <OS.h>
754 #     if defined B_PAGE_SIZE
755 #      define _gl_getpagesize() B_PAGE_SIZE
756 #     endif
757 #    endif
758 /* This is for AmigaOS4.0.  */
759 #    if !defined _gl_getpagesize && defined __amigaos4__
760 #     define _gl_getpagesize() 2048
761 #    endif
762 /* This is for older Unix systems.  */
763 #    if !defined _gl_getpagesize && @HAVE_SYS_PARAM_H@
764 #     include <sys/param.h>
765 #     ifdef EXEC_PAGESIZE
766 #      define _gl_getpagesize() EXEC_PAGESIZE
767 #     else
768 #      ifdef NBPG
769 #       ifndef CLSIZE
770 #        define CLSIZE 1
771 #       endif
772 #       define _gl_getpagesize() (NBPG * CLSIZE)
773 #      else
774 #       ifdef NBPC
775 #        define _gl_getpagesize() NBPC
776 #       endif
777 #      endif
778 #     endif
779 #    endif
780 #    if !(defined __cplusplus && defined GNULIB_NAMESPACE)
781 #     define getpagesize() _gl_getpagesize ()
782 #    else
783 static inline int
784 getpagesize ()
785 {
786   return _gl_getpagesize ();
787 }
788 #    endif
789 #   endif
790 #  endif
791 /* Need to cast, because on Cygwin 1.5.x systems, the return type is size_t.  */
792 _GL_CXXALIAS_SYS_CAST (getpagesize, int, (void));
793 # endif
794 # if @HAVE_DECL_GETPAGESIZE@
795 _GL_CXXALIASWARN (getpagesize);
796 # endif
797 #elif defined GNULIB_POSIXCHECK
798 # undef getpagesize
799 # if HAVE_RAW_DECL_GETPAGESIZE
800 _GL_WARN_ON_USE (getpagesize, "getpagesize is unportable - "
801                  "use gnulib module getpagesize for portability");
802 # endif
803 #endif
804
805
806 #if @GNULIB_GETUSERSHELL@
807 /* Return the next valid login shell on the system, or NULL when the end of
808    the list has been reached.  */
809 # if !@HAVE_DECL_GETUSERSHELL@
810 _GL_FUNCDECL_SYS (getusershell, char *, (void));
811 # endif
812 _GL_CXXALIAS_SYS (getusershell, char *, (void));
813 _GL_CXXALIASWARN (getusershell);
814 #elif defined GNULIB_POSIXCHECK
815 # undef getusershell
816 # if HAVE_RAW_DECL_GETUSERSHELL
817 _GL_WARN_ON_USE (getusershell, "getusershell is unportable - "
818                  "use gnulib module getusershell for portability");
819 # endif
820 #endif
821
822 #if @GNULIB_GETUSERSHELL@
823 /* Rewind to pointer that is advanced at each getusershell() call.  */
824 # if !@HAVE_DECL_GETUSERSHELL@
825 _GL_FUNCDECL_SYS (setusershell, void, (void));
826 # endif
827 _GL_CXXALIAS_SYS (setusershell, void, (void));
828 _GL_CXXALIASWARN (setusershell);
829 #elif defined GNULIB_POSIXCHECK
830 # undef setusershell
831 # if HAVE_RAW_DECL_SETUSERSHELL
832 _GL_WARN_ON_USE (setusershell, "setusershell is unportable - "
833                  "use gnulib module getusershell for portability");
834 # endif
835 #endif
836
837 #if @GNULIB_GETUSERSHELL@
838 /* Free the pointer that is advanced at each getusershell() call and
839    associated resources.  */
840 # if !@HAVE_DECL_GETUSERSHELL@
841 _GL_FUNCDECL_SYS (endusershell, void, (void));
842 # endif
843 _GL_CXXALIAS_SYS (endusershell, void, (void));
844 _GL_CXXALIASWARN (endusershell);
845 #elif defined GNULIB_POSIXCHECK
846 # undef endusershell
847 # if HAVE_RAW_DECL_ENDUSERSHELL
848 _GL_WARN_ON_USE (endusershell, "endusershell is unportable - "
849                  "use gnulib module getusershell for portability");
850 # endif
851 #endif
852
853
854 #if @GNULIB_LCHOWN@
855 /* Change the owner of FILE to UID (if UID is not -1) and the group of FILE
856    to GID (if GID is not -1).  Do not follow symbolic links.
857    Return 0 if successful, otherwise -1 and errno set.
858    See the POSIX:2001 specification
859    <http://www.opengroup.org/susv3xsh/lchown.html>.  */
860 # if @REPLACE_LCHOWN@
861 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
862 #   undef lchown
863 #   define lchown rpl_lchown
864 #  endif
865 _GL_FUNCDECL_RPL (lchown, int, (char const *file, uid_t owner, gid_t group)
866                                _GL_ARG_NONNULL ((1)));
867 _GL_CXXALIAS_RPL (lchown, int, (char const *file, uid_t owner, gid_t group));
868 # else
869 #  if !@HAVE_LCHOWN@
870 _GL_FUNCDECL_SYS (lchown, int, (char const *file, uid_t owner, gid_t group)
871                                _GL_ARG_NONNULL ((1)));
872 #  endif
873 _GL_CXXALIAS_SYS (lchown, int, (char const *file, uid_t owner, gid_t group));
874 # endif
875 _GL_CXXALIASWARN (lchown);
876 #elif defined GNULIB_POSIXCHECK
877 # undef lchown
878 # if HAVE_RAW_DECL_LCHOWN
879 _GL_WARN_ON_USE (lchown, "lchown is unportable to pre-POSIX.1-2001 systems - "
880                  "use gnulib module lchown for portability");
881 # endif
882 #endif
883
884
885 #if @GNULIB_LINK@
886 /* Create a new hard link for an existing file.
887    Return 0 if successful, otherwise -1 and errno set.
888    See POSIX:2001 specification
889    <http://www.opengroup.org/susv3xsh/link.html>.  */
890 # if @REPLACE_LINK@
891 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
892 #   define link rpl_link
893 #  endif
894 _GL_FUNCDECL_RPL (link, int, (const char *path1, const char *path2)
895                              _GL_ARG_NONNULL ((1, 2)));
896 _GL_CXXALIAS_RPL (link, int, (const char *path1, const char *path2));
897 # else
898 #  if !@HAVE_LINK@
899 _GL_FUNCDECL_SYS (link, int, (const char *path1, const char *path2)
900                              _GL_ARG_NONNULL ((1, 2)));
901 #  endif
902 _GL_CXXALIAS_SYS (link, int, (const char *path1, const char *path2));
903 # endif
904 _GL_CXXALIASWARN (link);
905 #elif defined GNULIB_POSIXCHECK
906 # undef link
907 # if HAVE_RAW_DECL_LINK
908 _GL_WARN_ON_USE (link, "link is unportable - "
909                  "use gnulib module link for portability");
910 # endif
911 #endif
912
913
914 #if @GNULIB_LINKAT@
915 /* Create a new hard link for an existing file, relative to two
916    directories.  FLAG controls whether symlinks are followed.
917    Return 0 if successful, otherwise -1 and errno set.  */
918 # if @REPLACE_LINKAT@
919 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
920 #   undef linkat
921 #   define linkat rpl_linkat
922 #  endif
923 _GL_FUNCDECL_RPL (linkat, int,
924                   (int fd1, const char *path1, int fd2, const char *path2,
925                    int flag)
926                   _GL_ARG_NONNULL ((2, 4)));
927 _GL_CXXALIAS_RPL (linkat, int,
928                   (int fd1, const char *path1, int fd2, const char *path2,
929                    int flag));
930 # else
931 #  if !@HAVE_LINKAT@
932 _GL_FUNCDECL_SYS (linkat, int,
933                   (int fd1, const char *path1, int fd2, const char *path2,
934                    int flag)
935                   _GL_ARG_NONNULL ((2, 4)));
936 #  endif
937 _GL_CXXALIAS_SYS (linkat, int,
938                   (int fd1, const char *path1, int fd2, const char *path2,
939                    int flag));
940 # endif
941 _GL_CXXALIASWARN (linkat);
942 #elif defined GNULIB_POSIXCHECK
943 # undef linkat
944 # if HAVE_RAW_DECL_LINKAT
945 _GL_WARN_ON_USE (linkat, "linkat is unportable - "
946                  "use gnulib module linkat for portability");
947 # endif
948 #endif
949
950
951 #if @GNULIB_LSEEK@
952 /* Set the offset of FD relative to SEEK_SET, SEEK_CUR, or SEEK_END.
953    Return the new offset if successful, otherwise -1 and errno set.
954    See the POSIX:2001 specification
955    <http://www.opengroup.org/susv3xsh/lseek.html>.  */
956 # if @REPLACE_LSEEK@
957 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
958 #   define lseek rpl_lseek
959 #  endif
960 _GL_FUNCDECL_RPL (lseek, off_t, (int fd, off_t offset, int whence));
961 _GL_CXXALIAS_RPL (lseek, off_t, (int fd, off_t offset, int whence));
962 # else
963 _GL_CXXALIAS_SYS (lseek, off_t, (int fd, off_t offset, int whence));
964 # endif
965 _GL_CXXALIASWARN (lseek);
966 #elif defined GNULIB_POSIXCHECK
967 # undef lseek
968 # if HAVE_RAW_DECL_LSEEK
969 _GL_WARN_ON_USE (lseek, "lseek does not fail with ESPIPE on pipes on some "
970                  "systems - use gnulib module lseek for portability");
971 # endif
972 #endif
973
974
975 #if @GNULIB_PIPE@
976 /* Create a pipe, defaulting to O_BINARY mode.
977    Store the read-end as fd[0] and the write-end as fd[1].
978    Return 0 upon success, or -1 with errno set upon failure.  */
979 # if !@HAVE_PIPE@
980 _GL_FUNCDECL_SYS (pipe, int, (int fd[2]) _GL_ARG_NONNULL ((1)));
981 # endif
982 _GL_CXXALIAS_SYS (pipe, int, (int fd[2]));
983 _GL_CXXALIASWARN (pipe);
984 #elif defined GNULIB_POSIXCHECK
985 # undef pipe
986 # if HAVE_RAW_DECL_PIPE
987 _GL_WARN_ON_USE (pipe, "pipe is unportable - "
988                  "use gnulib module pipe-posix for portability");
989 # endif
990 #endif
991
992
993 #if @GNULIB_PIPE2@
994 /* Create a pipe, applying the given flags when opening the read-end of the
995    pipe and the write-end of the pipe.
996    The flags are a bitmask, possibly including O_CLOEXEC (defined in <fcntl.h>)
997    and O_TEXT, O_BINARY (defined in "binary-io.h").
998    Store the read-end as fd[0] and the write-end as fd[1].
999    Return 0 upon success, or -1 with errno set upon failure.
1000    See also the Linux man page at
1001    <http://www.kernel.org/doc/man-pages/online/pages/man2/pipe2.2.html>.  */
1002 # if @HAVE_PIPE2@
1003 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1004 #   define pipe2 rpl_pipe2
1005 #  endif
1006 _GL_FUNCDECL_RPL (pipe2, int, (int fd[2], int flags) _GL_ARG_NONNULL ((1)));
1007 _GL_CXXALIAS_RPL (pipe2, int, (int fd[2], int flags));
1008 # else
1009 _GL_FUNCDECL_SYS (pipe2, int, (int fd[2], int flags) _GL_ARG_NONNULL ((1)));
1010 _GL_CXXALIAS_SYS (pipe2, int, (int fd[2], int flags));
1011 # endif
1012 _GL_CXXALIASWARN (pipe2);
1013 #elif defined GNULIB_POSIXCHECK
1014 # undef pipe2
1015 # if HAVE_RAW_DECL_PIPE2
1016 _GL_WARN_ON_USE (pipe2, "pipe2 is unportable - "
1017                  "use gnulib module pipe2 for portability");
1018 # endif
1019 #endif
1020
1021
1022 #if @GNULIB_PREAD@
1023 /* Read at most BUFSIZE bytes from FD into BUF, starting at OFFSET.
1024    Return the number of bytes placed into BUF if successful, otherwise
1025    set errno and return -1.  0 indicates EOF.  See the POSIX:2001
1026    specification <http://www.opengroup.org/susv3xsh/pread.html>.  */
1027 # if @REPLACE_PREAD@
1028 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1029 #   define pread rpl_pread
1030 #  endif
1031 _GL_FUNCDECL_RPL (pread, ssize_t,
1032                   (int fd, void *buf, size_t bufsize, off_t offset)
1033                   _GL_ARG_NONNULL ((2)));
1034 _GL_CXXALIAS_RPL (pread, ssize_t,
1035                   (int fd, void *buf, size_t bufsize, off_t offset));
1036 # else
1037 #  if !@HAVE_PREAD@
1038 _GL_FUNCDECL_SYS (pread, ssize_t,
1039                   (int fd, void *buf, size_t bufsize, off_t offset)
1040                   _GL_ARG_NONNULL ((2)));
1041 #  endif
1042 _GL_CXXALIAS_SYS (pread, ssize_t,
1043                   (int fd, void *buf, size_t bufsize, off_t offset));
1044 # endif
1045 _GL_CXXALIASWARN (pread);
1046 #elif defined GNULIB_POSIXCHECK
1047 # undef pread
1048 # if HAVE_RAW_DECL_PREAD
1049 _GL_WARN_ON_USE (pread, "pread is unportable - "
1050                  "use gnulib module pread for portability");
1051 # endif
1052 #endif
1053
1054
1055 #if @GNULIB_PWRITE@
1056 /* Write at most BUFSIZE bytes from BUF into FD, starting at OFFSET.
1057    Return the number of bytes written if successful, otherwise
1058    set errno and return -1.  0 indicates nothing written.  See the
1059    POSIX:2001 specification
1060    <http://www.opengroup.org/susv3xsh/pwrite.html>.  */
1061 # if @REPLACE_PWRITE@
1062 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1063 #   define pwrite rpl_pwrite
1064 #  endif
1065 _GL_FUNCDECL_RPL (pwrite, ssize_t,
1066                   (int fd, const void *buf, size_t bufsize, off_t offset)
1067                   _GL_ARG_NONNULL ((2)));
1068 _GL_CXXALIAS_RPL (pwrite, ssize_t,
1069                   (int fd, const void *buf, size_t bufsize, off_t offset));
1070 # else
1071 #  if !@HAVE_PWRITE@
1072 _GL_FUNCDECL_SYS (pwrite, ssize_t,
1073                   (int fd, const void *buf, size_t bufsize, off_t offset)
1074                   _GL_ARG_NONNULL ((2)));
1075 #  endif
1076 _GL_CXXALIAS_SYS (pwrite, ssize_t,
1077                   (int fd, const void *buf, size_t bufsize, off_t offset));
1078 # endif
1079 _GL_CXXALIASWARN (pwrite);
1080 #elif defined GNULIB_POSIXCHECK
1081 # undef pwrite
1082 # if HAVE_RAW_DECL_PWRITE
1083 _GL_WARN_ON_USE (pwrite, "pwrite is unportable - "
1084                  "use gnulib module pwrite for portability");
1085 # endif
1086 #endif
1087
1088
1089 #if @GNULIB_READLINK@
1090 /* Read the contents of the symbolic link FILE and place the first BUFSIZE
1091    bytes of it into BUF.  Return the number of bytes placed into BUF if
1092    successful, otherwise -1 and errno set.
1093    See the POSIX:2001 specification
1094    <http://www.opengroup.org/susv3xsh/readlink.html>.  */
1095 # if @REPLACE_READLINK@
1096 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1097 #   define readlink rpl_readlink
1098 #  endif
1099 _GL_FUNCDECL_RPL (readlink, ssize_t,
1100                   (const char *file, char *buf, size_t bufsize)
1101                   _GL_ARG_NONNULL ((1, 2)));
1102 _GL_CXXALIAS_RPL (readlink, ssize_t,
1103                   (const char *file, char *buf, size_t bufsize));
1104 # else
1105 #  if !@HAVE_READLINK@
1106 _GL_FUNCDECL_SYS (readlink, ssize_t,
1107                   (const char *file, char *buf, size_t bufsize)
1108                   _GL_ARG_NONNULL ((1, 2)));
1109 #  endif
1110 _GL_CXXALIAS_SYS (readlink, ssize_t,
1111                   (const char *file, char *buf, size_t bufsize));
1112 # endif
1113 _GL_CXXALIASWARN (readlink);
1114 #elif defined GNULIB_POSIXCHECK
1115 # undef readlink
1116 # if HAVE_RAW_DECL_READLINK
1117 _GL_WARN_ON_USE (readlink, "readlink is unportable - "
1118                  "use gnulib module readlink for portability");
1119 # endif
1120 #endif
1121
1122
1123 #if @GNULIB_READLINKAT@
1124 # if !@HAVE_READLINKAT@
1125 _GL_FUNCDECL_SYS (readlinkat, ssize_t,
1126                   (int fd, char const *file, char *buf, size_t len)
1127                   _GL_ARG_NONNULL ((2, 3)));
1128 # endif
1129 _GL_CXXALIAS_SYS (readlinkat, ssize_t,
1130                   (int fd, char const *file, char *buf, size_t len));
1131 _GL_CXXALIASWARN (readlinkat);
1132 #elif defined GNULIB_POSIXCHECK
1133 # undef readlinkat
1134 # if HAVE_RAW_DECL_READLINKAT
1135 _GL_WARN_ON_USE (readlinkat, "readlinkat is not portable - "
1136                  "use gnulib module readlinkat for portability");
1137 # endif
1138 #endif
1139
1140
1141 #if @GNULIB_RMDIR@
1142 /* Remove the directory DIR.  */
1143 # if @REPLACE_RMDIR@
1144 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1145 #   define rmdir rpl_rmdir
1146 #  endif
1147 _GL_FUNCDECL_RPL (rmdir, int, (char const *name) _GL_ARG_NONNULL ((1)));
1148 _GL_CXXALIAS_RPL (rmdir, int, (char const *name));
1149 # else
1150 _GL_CXXALIAS_SYS (rmdir, int, (char const *name));
1151 # endif
1152 _GL_CXXALIASWARN (rmdir);
1153 #elif defined GNULIB_POSIXCHECK
1154 # undef rmdir
1155 # if HAVE_RAW_DECL_RMDIR
1156 _GL_WARN_ON_USE (rmdir, "rmdir is unportable - "
1157                  "use gnulib module rmdir for portability");
1158 # endif
1159 #endif
1160
1161
1162 #if @GNULIB_SLEEP@
1163 /* Pause the execution of the current thread for N seconds.
1164    Returns the number of seconds left to sleep.
1165    See the POSIX:2001 specification
1166    <http://www.opengroup.org/susv3xsh/sleep.html>.  */
1167 # if @REPLACE_SLEEP@
1168 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1169 #   undef sleep
1170 #   define sleep rpl_sleep
1171 #  endif
1172 _GL_FUNCDECL_RPL (sleep, unsigned int, (unsigned int n));
1173 _GL_CXXALIAS_RPL (sleep, unsigned int, (unsigned int n));
1174 # else
1175 #  if !@HAVE_SLEEP@
1176 _GL_FUNCDECL_SYS (sleep, unsigned int, (unsigned int n));
1177 #  endif
1178 _GL_CXXALIAS_SYS (sleep, unsigned int, (unsigned int n));
1179 # endif
1180 _GL_CXXALIASWARN (sleep);
1181 #elif defined GNULIB_POSIXCHECK
1182 # undef sleep
1183 # if HAVE_RAW_DECL_SLEEP
1184 _GL_WARN_ON_USE (sleep, "sleep is unportable - "
1185                  "use gnulib module sleep for portability");
1186 # endif
1187 #endif
1188
1189
1190 #if @GNULIB_SYMLINK@
1191 # if @REPLACE_SYMLINK@
1192 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1193 #   undef symlink
1194 #   define symlink rpl_symlink
1195 #  endif
1196 _GL_FUNCDECL_RPL (symlink, int, (char const *contents, char const *file)
1197                                 _GL_ARG_NONNULL ((1, 2)));
1198 _GL_CXXALIAS_RPL (symlink, int, (char const *contents, char const *file));
1199 # else
1200 #  if !@HAVE_SYMLINK@
1201 _GL_FUNCDECL_SYS (symlink, int, (char const *contents, char const *file)
1202                                 _GL_ARG_NONNULL ((1, 2)));
1203 #  endif
1204 _GL_CXXALIAS_SYS (symlink, int, (char const *contents, char const *file));
1205 # endif
1206 _GL_CXXALIASWARN (symlink);
1207 #elif defined GNULIB_POSIXCHECK
1208 # undef symlink
1209 # if HAVE_RAW_DECL_SYMLINK
1210 _GL_WARN_ON_USE (symlink, "symlink is not portable - "
1211                  "use gnulib module symlink for portability");
1212 # endif
1213 #endif
1214
1215
1216 #if @GNULIB_SYMLINKAT@
1217 # if !@HAVE_SYMLINKAT@
1218 _GL_FUNCDECL_SYS (symlinkat, int,
1219                   (char const *contents, int fd, char const *file)
1220                   _GL_ARG_NONNULL ((1, 3)));
1221 # endif
1222 _GL_CXXALIAS_SYS (symlinkat, int,
1223                   (char const *contents, int fd, char const *file));
1224 _GL_CXXALIASWARN (symlinkat);
1225 #elif defined GNULIB_POSIXCHECK
1226 # undef symlinkat
1227 # if HAVE_RAW_DECL_SYMLINKAT
1228 _GL_WARN_ON_USE (symlinkat, "symlinkat is not portable - "
1229                  "use gnulib module symlinkat for portability");
1230 # endif
1231 #endif
1232
1233
1234 #if @GNULIB_TTYNAME_R@
1235 /* Store at most BUFLEN characters of the pathname of the terminal FD is
1236    open on in BUF.  Return 0 on success, otherwise an error number.  */
1237 # if @REPLACE_TTYNAME_R@
1238 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1239 #   undef ttyname_r
1240 #   define ttyname_r rpl_ttyname_r
1241 #  endif
1242 _GL_FUNCDECL_RPL (ttyname_r, int,
1243                   (int fd, char *buf, size_t buflen) _GL_ARG_NONNULL ((2)));
1244 _GL_CXXALIAS_RPL (ttyname_r, int,
1245                   (int fd, char *buf, size_t buflen));
1246 # else
1247 #  if !@HAVE_TTYNAME_R@
1248 _GL_FUNCDECL_SYS (ttyname_r, int,
1249                   (int fd, char *buf, size_t buflen) _GL_ARG_NONNULL ((2)));
1250 #  endif
1251 _GL_CXXALIAS_SYS (ttyname_r, int,
1252                   (int fd, char *buf, size_t buflen));
1253 # endif
1254 _GL_CXXALIASWARN (ttyname_r);
1255 #elif defined GNULIB_POSIXCHECK
1256 # undef ttyname_r
1257 # if HAVE_RAW_DECL_TTYNAME_R
1258 _GL_WARN_ON_USE (ttyname_r, "ttyname_r is not portable - "
1259                  "use gnulib module ttyname_r for portability");
1260 # endif
1261 #endif
1262
1263
1264 #if @GNULIB_UNLINK@
1265 # if @REPLACE_UNLINK@
1266 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1267 #   undef unlink
1268 #   define unlink rpl_unlink
1269 #  endif
1270 _GL_FUNCDECL_RPL (unlink, int, (char const *file) _GL_ARG_NONNULL ((1)));
1271 _GL_CXXALIAS_RPL (unlink, int, (char const *file));
1272 # else
1273 _GL_CXXALIAS_SYS (unlink, int, (char const *file));
1274 # endif
1275 _GL_CXXALIASWARN (unlink);
1276 #elif defined GNULIB_POSIXCHECK
1277 # undef unlink
1278 # if HAVE_RAW_DECL_UNLINK
1279 _GL_WARN_ON_USE (unlink, "unlink is not portable - "
1280                  "use gnulib module unlink for portability");
1281 # endif
1282 #endif
1283
1284
1285 #if @GNULIB_UNLINKAT@
1286 # if @REPLACE_UNLINKAT@
1287 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1288 #   undef unlinkat
1289 #   define unlinkat rpl_unlinkat
1290 #  endif
1291 _GL_FUNCDECL_RPL (unlinkat, int, (int fd, char const *file, int flag)
1292                                  _GL_ARG_NONNULL ((2)));
1293 _GL_CXXALIAS_RPL (unlinkat, int, (int fd, char const *file, int flag));
1294 # else
1295 #  if !@HAVE_UNLINKAT@
1296 _GL_FUNCDECL_SYS (unlinkat, int, (int fd, char const *file, int flag)
1297                                  _GL_ARG_NONNULL ((2)));
1298 #  endif
1299 _GL_CXXALIAS_SYS (unlinkat, int, (int fd, char const *file, int flag));
1300 # endif
1301 _GL_CXXALIASWARN (unlinkat);
1302 #elif defined GNULIB_POSIXCHECK
1303 # undef unlinkat
1304 # if HAVE_RAW_DECL_UNLINKAT
1305 _GL_WARN_ON_USE (unlinkat, "unlinkat is not portable - "
1306                  "use gnulib module openat for portability");
1307 # endif
1308 #endif
1309
1310
1311 #if @GNULIB_USLEEP@
1312 /* Pause the execution of the current thread for N microseconds.
1313    Returns 0 on completion, or -1 on range error.
1314    See the POSIX:2001 specification
1315    <http://www.opengroup.org/susv3xsh/sleep.html>.  */
1316 # if @REPLACE_USLEEP@
1317 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1318 #   undef usleep
1319 #   define usleep rpl_usleep
1320 #  endif
1321 _GL_FUNCDECL_RPL (usleep, int, (useconds_t n));
1322 _GL_CXXALIAS_RPL (usleep, int, (useconds_t n));
1323 # else
1324 #  if !@HAVE_USLEEP@
1325 _GL_FUNCDECL_SYS (usleep, int, (useconds_t n));
1326 #  endif
1327 _GL_CXXALIAS_SYS (usleep, int, (useconds_t n));
1328 # endif
1329 _GL_CXXALIASWARN (usleep);
1330 #elif defined GNULIB_POSIXCHECK
1331 # undef usleep
1332 # if HAVE_RAW_DECL_USLEEP
1333 _GL_WARN_ON_USE (usleep, "usleep is unportable - "
1334                  "use gnulib module usleep for portability");
1335 # endif
1336 #endif
1337
1338
1339 #if @GNULIB_WRITE@
1340 /* Write up to COUNT bytes starting at BUF to file descriptor FD.
1341    See the POSIX:2001 specification
1342    <http://www.opengroup.org/susv3xsh/write.html>.  */
1343 # if @REPLACE_WRITE@ && @GNULIB_UNISTD_H_SIGPIPE@
1344 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1345 #   undef write
1346 #   define write rpl_write
1347 #  endif
1348 _GL_FUNCDECL_RPL (write, ssize_t, (int fd, const void *buf, size_t count)
1349                                   _GL_ARG_NONNULL ((2)));
1350 _GL_CXXALIAS_RPL (write, ssize_t, (int fd, const void *buf, size_t count));
1351 # else
1352 /* Need to cast, because on mingw, the third parameter is
1353                                                              unsigned int count
1354    and the return type is 'int'.  */
1355 _GL_CXXALIAS_SYS_CAST (write, ssize_t, (int fd, const void *buf, size_t count));
1356 # endif
1357 _GL_CXXALIASWARN (write);
1358 #endif
1359
1360
1361 #endif /* _GL_UNISTD_H */
1362 #endif /* _GL_UNISTD_H */