New module 'write'.
[pspp] / lib / unistd.in.h
1 /* Substitute for and wrapper around <unistd.h>.
2    Copyright (C) 2004-2008 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 #ifndef _GL_UNISTD_H
19
20 @PRAGMA_SYSTEM_HEADER@
21
22 /* The include_next requires a split double-inclusion guard.  */
23 #if @HAVE_UNISTD_H@
24 # @INCLUDE_NEXT@ @NEXT_UNISTD_H@
25 #endif
26
27 #ifndef _GL_UNISTD_H
28 #define _GL_UNISTD_H
29
30 /* mingw doesn't define the SEEK_* macros in <unistd.h>.  */
31 #if !(defined SEEK_CUR && defined SEEK_END && defined SEEK_SET)
32 # include <stdio.h>
33 #endif
34
35 /* mingw fails to declare _exit in <unistd.h>.  */
36 #include <stdlib.h>
37
38 #if @GNULIB_WRITE@ && @REPLACE_WRITE@ && @GNULIB_UNISTD_H_SIGPIPE@
39 /* Get ssize_t.  */
40 # include <sys/types.h>
41 #endif
42
43 /* The definition of GL_LINK_WARNING is copied here.  */
44
45
46 /* Declare overridden functions.  */
47
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51
52
53 #if @GNULIB_CHOWN@
54 # if @REPLACE_CHOWN@
55 #  ifndef REPLACE_CHOWN
56 #   define REPLACE_CHOWN 1
57 #  endif
58 #  if REPLACE_CHOWN
59 /* Change the owner of FILE to UID (if UID is not -1) and the group of FILE
60    to GID (if GID is not -1).  Follow symbolic links.
61    Return 0 if successful, otherwise -1 and errno set.
62    See the POSIX:2001 specification
63    <http://www.opengroup.org/susv3xsh/chown.html>.  */
64 #   define chown rpl_chown
65 extern int chown (const char *file, uid_t uid, gid_t gid);
66 #  endif
67 # endif
68 #elif defined GNULIB_POSIXCHECK
69 # undef chown
70 # define chown(f,u,g) \
71     (GL_LINK_WARNING ("chown fails to follow symlinks on some systems and " \
72                       "doesn't treat a uid or gid of -1 on some systems - " \
73                       "use gnulib module chown for portability"), \
74      chown (f, u, g))
75 #endif
76
77
78 #if @GNULIB_DUP2@
79 # if !@HAVE_DUP2@
80 /* Copy the file descriptor OLDFD into file descriptor NEWFD.  Do nothing if
81    NEWFD = OLDFD, otherwise close NEWFD first if it is open.
82    Return 0 if successful, otherwise -1 and errno set.
83    See the POSIX:2001 specification
84    <http://www.opengroup.org/susv3xsh/dup2.html>.  */
85 extern int dup2 (int oldfd, int newfd);
86 # endif
87 #elif defined GNULIB_POSIXCHECK
88 # undef dup2
89 # define dup2(o,n) \
90     (GL_LINK_WARNING ("dup2 is unportable - " \
91                       "use gnulib module dup2 for portability"), \
92      dup2 (o, n))
93 #endif
94
95
96 #if @GNULIB_ENVIRON@
97 # if !@HAVE_DECL_ENVIRON@
98 /* Set of environment variables and values.  An array of strings of the form
99    "VARIABLE=VALUE", terminated with a NULL.  */
100 #  if defined __APPLE__ && defined __MACH__
101 #   include <crt_externs.h>
102 #   define environ (*_NSGetEnviron ())
103 #  else
104 extern char **environ;
105 #  endif
106 # endif
107 #elif defined GNULIB_POSIXCHECK
108 # undef environ
109 # define environ \
110     (GL_LINK_WARNING ("environ is unportable - " \
111                       "use gnulib module environ for portability"), \
112      environ)
113 #endif
114
115
116 #if @GNULIB_FCHDIR@
117 # if @REPLACE_FCHDIR@
118
119 /* Change the process' current working directory to the directory on which
120    the given file descriptor is open.
121    Return 0 if successful, otherwise -1 and errno set.
122    See the POSIX:2001 specification
123    <http://www.opengroup.org/susv3xsh/fchdir.html>.  */
124 extern int fchdir (int /*fd*/);
125
126 #  define close rpl_close
127 extern int close (int);
128 #  define dup rpl_dup
129 extern int dup (int);
130 #  define dup2 rpl_dup2
131 extern int dup2 (int, int);
132
133 # endif
134 #elif defined GNULIB_POSIXCHECK
135 # undef fchdir
136 # define fchdir(f) \
137     (GL_LINK_WARNING ("fchdir is unportable - " \
138                       "use gnulib module fchdir for portability"), \
139      fchdir (f))
140 #endif
141
142
143 #if @GNULIB_FTRUNCATE@
144 # if !@HAVE_FTRUNCATE@
145 /* Change the size of the file to which FD is opened to become equal to LENGTH.
146    Return 0 if successful, otherwise -1 and errno set.
147    See the POSIX:2001 specification
148    <http://www.opengroup.org/susv3xsh/ftruncate.html>.  */
149 extern int ftruncate (int fd, off_t length);
150 # endif
151 #elif defined GNULIB_POSIXCHECK
152 # undef ftruncate
153 # define ftruncate(f,l) \
154     (GL_LINK_WARNING ("ftruncate is unportable - " \
155                       "use gnulib module ftruncate for portability"), \
156      ftruncate (f, l))
157 #endif
158
159
160 #if @GNULIB_GETCWD@
161 /* Include the headers that might declare getcwd so that they will not
162    cause confusion if included after this file.  */
163 # include <stdlib.h>
164 # if @REPLACE_GETCWD@
165 /* Get the name of the current working directory, and put it in SIZE bytes
166    of BUF.
167    Return BUF if successful, or NULL if the directory couldn't be determined
168    or SIZE was too small.
169    See the POSIX:2001 specification
170    <http://www.opengroup.org/susv3xsh/getcwd.html>.
171    Additionally, the gnulib module 'getcwd' guarantees the following GNU
172    extension: If BUF is NULL, an array is allocated with 'malloc'; the array
173    is SIZE bytes long, unless SIZE == 0, in which case it is as big as
174    necessary.  */
175 #  define getcwd rpl_getcwd
176 extern char * getcwd (char *buf, size_t size);
177 # endif
178 #elif defined GNULIB_POSIXCHECK
179 # undef getcwd
180 # define getcwd(b,s) \
181     (GL_LINK_WARNING ("getcwd is unportable - " \
182                       "use gnulib module getcwd for portability"), \
183      getcwd (b, s))
184 #endif
185
186
187 #if @GNULIB_GETLOGIN_R@
188 /* Copies the user's login name to NAME.
189    The array pointed to by NAME has room for SIZE bytes.
190
191    Returns 0 if successful.  Upon error, an error number is returned, or -1 in
192    the case that the login name cannot be found but no specific error is
193    provided (this case is hopefully rare but is left open by the POSIX spec).
194
195    See <http://www.opengroup.org/susv3xsh/getlogin.html>.
196  */
197 # if !@HAVE_DECL_GETLOGIN_R@
198 #  include <stddef.h>
199 extern int getlogin_r (char *name, size_t size);
200 # endif
201 #elif defined GNULIB_POSIXCHECK
202 # undef getlogin_r
203 # define getlogin_r(n,s) \
204     (GL_LINK_WARNING ("getlogin_r is unportable - " \
205                       "use gnulib module getlogin_r for portability"), \
206      getlogin_r (n, s))
207 #endif
208
209
210 #if @GNULIB_GETPAGESIZE@
211 # if @REPLACE_GETPAGESIZE@
212 #  define getpagesize rpl_getpagesize
213 extern int getpagesize (void);
214 # elif !@HAVE_GETPAGESIZE@
215 /* This is for POSIX systems.  */
216 #  if !defined getpagesize && defined _SC_PAGESIZE
217 #   if ! (defined __VMS && __VMS_VER < 70000000)
218 #    define getpagesize() sysconf (_SC_PAGESIZE)
219 #   endif
220 #  endif
221 /* This is for older VMS.  */
222 #  if !defined getpagesize && defined __VMS
223 #   ifdef __ALPHA
224 #    define getpagesize() 8192
225 #   else
226 #    define getpagesize() 512
227 #   endif
228 #  endif
229 /* This is for BeOS.  */
230 #  if !defined getpagesize && @HAVE_OS_H@
231 #   include <OS.h>
232 #   if defined B_PAGE_SIZE
233 #    define getpagesize() B_PAGE_SIZE
234 #   endif
235 #  endif
236 /* This is for AmigaOS4.0.  */
237 #  if !defined getpagesize && defined __amigaos4__
238 #   define getpagesize() 2048
239 #  endif
240 /* This is for older Unix systems.  */
241 #  if !defined getpagesize && @HAVE_SYS_PARAM_H@
242 #   include <sys/param.h>
243 #   ifdef EXEC_PAGESIZE
244 #    define getpagesize() EXEC_PAGESIZE
245 #   else
246 #    ifdef NBPG
247 #     ifndef CLSIZE
248 #      define CLSIZE 1
249 #     endif
250 #     define getpagesize() (NBPG * CLSIZE)
251 #    else
252 #     ifdef NBPC
253 #      define getpagesize() NBPC
254 #     endif
255 #    endif
256 #   endif
257 #  endif
258 # endif
259 #elif defined GNULIB_POSIXCHECK
260 # undef getpagesize
261 # define getpagesize() \
262     (GL_LINK_WARNING ("getpagesize is unportable - " \
263                       "use gnulib module getpagesize for portability"), \
264      getpagesize ())
265 #endif
266
267
268 #if @GNULIB_LCHOWN@
269 # if @REPLACE_LCHOWN@
270 /* Change the owner of FILE to UID (if UID is not -1) and the group of FILE
271    to GID (if GID is not -1).  Do not follow symbolic links.
272    Return 0 if successful, otherwise -1 and errno set.
273    See the POSIX:2001 specification
274    <http://www.opengroup.org/susv3xsh/lchown.html>.  */
275 #  define lchown rpl_lchown
276 extern int lchown (char const *file, uid_t owner, gid_t group);
277 # endif
278 #elif defined GNULIB_POSIXCHECK
279 # undef lchown
280 # define lchown(f,u,g) \
281     (GL_LINK_WARNING ("lchown is unportable to pre-POSIX.1-2001 " \
282                       "systems - use gnulib module lchown for portability"), \
283      lchown (f, u, g))
284 #endif
285
286
287 #if @GNULIB_LSEEK@
288 # if @REPLACE_LSEEK@
289 /* Set the offset of FD relative to SEEK_SET, SEEK_CUR, or SEEK_END.
290    Return the new offset if successful, otherwise -1 and errno set.
291    See the POSIX:2001 specification
292    <http://www.opengroup.org/susv3xsh/lseek.html>.  */
293 #  define lseek rpl_lseek
294    extern off_t lseek (int fd, off_t offset, int whence);
295 # endif
296 #elif defined GNULIB_POSIXCHECK
297 # undef lseek
298 # define lseek(f,o,w) \
299     (GL_LINK_WARNING ("lseek does not fail with ESPIPE on pipes on some " \
300                       "systems - use gnulib module lseek for portability"), \
301      lseek (f, o, w))
302 #endif
303
304
305 #if @GNULIB_READLINK@
306 /* Read the contents of the symbolic link FILE and place the first BUFSIZE
307    bytes of it into BUF.  Return the number of bytes placed into BUF if
308    successful, otherwise -1 and errno set.
309    See the POSIX:2001 specification
310    <http://www.opengroup.org/susv3xsh/readlink.html>.  */
311 # if !@HAVE_READLINK@
312 #  include <stddef.h>
313 extern int readlink (const char *file, char *buf, size_t bufsize);
314 # endif
315 #elif defined GNULIB_POSIXCHECK
316 # undef readlink
317 # define readlink(f,b,s) \
318     (GL_LINK_WARNING ("readlink is unportable - " \
319                       "use gnulib module readlink for portability"), \
320      readlink (f, b, s))
321 #endif
322
323
324 #if @GNULIB_SLEEP@
325 /* Pause the execution of the current thread for N seconds.
326    Returns the number of seconds left to sleep.
327    See the POSIX:2001 specification
328    <http://www.opengroup.org/susv3xsh/sleep.html>.  */
329 # if !@HAVE_SLEEP@
330 extern unsigned int sleep (unsigned int n);
331 # endif
332 #elif defined GNULIB_POSIXCHECK
333 # undef sleep
334 # define sleep(n) \
335     (GL_LINK_WARNING ("sleep is unportable - " \
336                       "use gnulib module sleep for portability"), \
337      sleep (n))
338 #endif
339
340
341 #if @GNULIB_WRITE@ && @REPLACE_WRITE@ && @GNULIB_UNISTD_H_SIGPIPE@
342 /* Write up to COUNT bytes starting at BUF to file descriptor FD.
343    See the POSIX:2001 specification
344    <http://www.opengroup.org/susv3xsh/write.html>.  */
345 # undef write
346 # define write rpl_write
347 extern ssize_t write (int fd, const void *buf, size_t count);
348 #endif
349
350
351 #ifdef __cplusplus
352 }
353 #endif
354
355
356 #endif /* _GL_UNISTD_H */
357 #endif /* _GL_UNISTD_H */