Use faccessat, not access, when checking file permissions.
[bpt/emacs.git] / nt / inc / ms-w32.h
1 /* System description file for Windows NT.
2
3 Copyright (C) 1993-1995, 2001-2012 Free Software Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
11
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
19
20 /* Define symbols to identify the version of Unix this is.
21 Define all the symbols that apply correctly. */
22
23 #ifndef WINDOWSNT
24 #define WINDOWSNT
25 #endif
26
27 /* #undef const */
28
29 /* Number of chars of output in the buffer of a stdio stream. */
30 #ifdef __GNU_LIBRARY__
31 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
32 #else
33 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
34 #endif
35
36 /* If you are compiling with a non-C calling convention but need to
37 declare vararg routines differently, put it here. */
38 #define _VARARGS_ __cdecl
39
40 /* If you are providing a function to something that will call the
41 function back (like a signal handler and signal, or main) its calling
42 convention must be whatever standard the libraries expect. */
43 #define _CALLBACK_ __cdecl
44
45 /* Define HAVE_TIMEVAL if the system supports the BSD style clock values.
46 Look in <sys/time.h> for a timeval structure. */
47 #define HAVE_TIMEVAL 1
48
49 /* But our select implementation doesn't allow us to make non-blocking
50 connects. So until that is fixed, this is necessary: */
51 #define BROKEN_NON_BLOCKING_CONNECT 1
52
53 /* And the select implementation does 1-byte read-ahead waiting
54 for received packets, so datagrams are broken too. */
55 #define BROKEN_DATAGRAM_SOCKETS 1
56
57 #define MAIL_USE_SYSTEM_LOCK 1
58
59 /* Define to 1 if GCC-style __attribute__ ((__aligned__ (expr))) works. */
60 #ifdef __GNUC__
61 #define HAVE_ATTRIBUTE_ALIGNED 1
62 #endif
63
64 /* Define to 1 if strtold conforms to C99. */
65 #ifdef __GNUC__
66 #define HAVE_C99_STRTOLD 1
67 #endif
68
69 #if (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8))
70 #define HAVE___BUILTIN_UNWIND_INIT 1
71 #endif
72
73 /* ============================================================ */
74
75 /* Here, add any special hacks needed to make Emacs work on this
76 system. For example, you might define certain system call names
77 that don't exist on your system, or that do different things on
78 your system and must be used only through an encapsulation (which
79 you should place, by convention, in sysdep.c). */
80
81 #ifdef __GNUC__
82 #ifndef __cplusplus
83 #undef inline
84 #endif
85 #else /* MSVC */
86 #define inline __inline
87 #endif
88
89 #ifdef __GNUC__
90 # define restrict __restrict__
91 #else
92 # define restrict
93 #endif
94
95 /* `mode_t' is not defined for MSVC. Define. */
96 #ifdef _MSC_VER
97 typedef unsigned short mode_t;
98 #endif
99
100 /* A va_copy replacement for MSVC. */
101 #ifdef _MSC_VER
102 # ifdef _WIN64
103 # ifndef va_copy /* Need to be checked (?) */
104 # define va_copy(d,s) ((d) = (s))
105 # endif
106 # else /* not _WIN64 */
107 # define va_copy(d,s) ((d) = (s))
108 # endif /* not _WIN64 */
109 #endif /* _MSC_VER */
110
111 #ifndef WINDOWSNT
112 /* Some of the files of Emacs which are intended for use with other
113 programs assume that if you have a config.h file, you must declare
114 the type of getenv. */
115 extern char *getenv ();
116 #endif
117
118 #ifdef HAVE_STRINGS_H
119 #include "strings.h"
120 #endif
121 #include <sys/types.h>
122
123 #ifndef MAXPATHLEN
124 #define MAXPATHLEN _MAX_PATH
125 #endif
126
127 /* Use values compatible with gnulib, as there's no reason to differ. */
128 #define AT_FDCWD (-3041965)
129 #define AT_EACCESS 4
130
131 #ifdef HAVE_NTGUI
132 #define HAVE_WINDOW_SYSTEM 1
133 #define HAVE_MENUS 1
134 #endif
135
136 /* Get some redefinitions in place. */
137
138 #ifdef emacs
139
140 #ifdef _MSC_VER
141 #include <sys/timeb.h>
142 #include <sys/stat.h>
143 #include <signal.h>
144
145 /* MSVC gets link-time errors without these redirections. */
146 #define fstat(a, b) sys_fstat(a, b)
147 #define stat(a, b) sys_stat(a, b)
148 #define utime sys_utime
149 #endif
150
151 /* Calls that are emulated or shadowed. */
152 #undef chdir
153 #define chdir sys_chdir
154 #undef chmod
155 #define chmod sys_chmod
156 #define chown sys_chown
157 #undef close
158 #define close sys_close
159 #undef creat
160 #define creat sys_creat
161 #define ctime sys_ctime
162 #undef dup
163 #define dup sys_dup
164 #undef dup2
165 #define dup2 sys_dup2
166 #define faccessat sys_faccessat
167 #define fopen sys_fopen
168 #define link sys_link
169 #define localtime sys_localtime
170 #define mkdir sys_mkdir
171 #undef mktemp
172 #define mktemp sys_mktemp
173 #undef open
174 #define open sys_open
175 #define pipe sys_pipe
176 #undef read
177 #define read sys_read
178 #define rename sys_rename
179 #define rmdir sys_rmdir
180 #define select sys_select
181 #define pselect sys_select
182 #define sleep sys_sleep
183 #define strerror sys_strerror
184 #undef unlink
185 #define unlink sys_unlink
186 #undef write
187 #define write sys_write
188
189 /* Subprocess calls that are emulated. */
190 #define spawnve sys_spawnve
191 #define wait sys_wait
192 #define kill sys_kill
193 #define signal sys_signal
194
195 /* Internal signals. */
196 #define emacs_raise(sig) emacs_abort()
197
198 extern int sys_wait (int *);
199
200 /* termcap.c calls that are emulated. */
201 #define tputs sys_tputs
202 #define tgetstr sys_tgetstr
203
204 /* cm.c calls that are emulated. */
205 #define chcheckmagic sys_chcheckmagic
206 #define cmcostinit sys_cmcostinit
207 #define cmgoto sys_cmgoto
208 #define cmputc sys_cmputc
209 #define Wcm_clear sys_Wcm_clear
210
211 #endif /* emacs */
212
213 /* Map to MSVC names. */
214 #define execlp _execlp
215 #define execvp _execvp
216 #define fdopen _fdopen
217 #ifndef fileno
218 #define fileno _fileno
219 #endif
220 #define fsync _commit
221 #define ftruncate _chsize
222 #define getpid _getpid
223 #ifdef _MSC_VER
224 typedef int pid_t;
225 #define snprintf _snprintf
226 #define strtoll _strtoi64
227 #endif
228 #define isatty _isatty
229 #define logb _logb
230 #define _longjmp longjmp
231 #define lseek _lseek
232 #define popen _popen
233 #define pclose _pclose
234 #define umask _umask
235 #ifndef _MSC_VER
236 #define utimbuf _utimbuf
237 #endif
238 #define strdup _strdup
239 #define strupr _strupr
240 #define strnicmp _strnicmp
241 #define stricmp _stricmp
242 #define tzset _tzset
243
244 /* We cannot include system header process.h, since there's src/process.h. */
245 int _getpid (void);
246
247 /* Include time.h before redirecting tzname, since MSVC's time.h
248 defines _tzname to call a function, but also declares tzname a
249 2-element array. Having the redirection before including the
250 header thus has the effect of declaring a function that returns an
251 array, and triggers an error message. */
252 #include <time.h>
253 #define tzname _tzname
254 #if !defined (_MSC_VER) || (_MSC_VER < 1400)
255 #undef utime
256 #define utime _utime
257 #endif
258
259 /* 'struct timespec' is used by time-related functions in lib/ and
260 elsewhere, but we don't use lib/time.h where the structure is
261 defined. */
262 struct timespec
263 {
264 time_t tv_sec; /* seconds */
265 long int tv_nsec; /* nanoseconds */
266 };
267
268 /* Required for functions in lib/time_r.c, since we don't use lib/time.h. */
269 extern struct tm *gmtime_r (time_t const * restrict, struct tm * restrict);
270 extern struct tm *localtime_r (time_t const * restrict, struct tm * restrict);
271
272 /* This is hacky, but is necessary to avoid warnings about macro
273 redefinitions using the SDK compilers. */
274 #ifndef __STDC__
275 #define __STDC__ 1
276 #define MUST_UNDEF__STDC__
277 #endif
278 #include <direct.h>
279 #include <io.h>
280 #include <stdio.h>
281 #ifdef MUST_UNDEF__STDC__
282 #undef __STDC__
283 #undef MUST_UNDEF__STDC__
284 #endif
285
286 /* Defines that we need that aren't in the standard signal.h. */
287 #define SIGHUP 1 /* Hang up */
288 #define SIGQUIT 3 /* Quit process */
289 #define SIGTRAP 5 /* Trace trap */
290 #define SIGKILL 9 /* Die, die die */
291 #define SIGPIPE 13 /* Write on pipe with no readers */
292 #define SIGALRM 14 /* Alarm */
293 #define SIGCHLD 18 /* Death of child */
294 #define SIGPROF 19 /* Profiling */
295
296 #ifndef NSIG
297 #define NSIG 23
298 #endif
299
300 #ifdef _MSC_VER
301 typedef int sigset_t;
302 typedef int ssize_t;
303 #endif
304
305 typedef void (_CALLBACK_ *signal_handler) (int);
306 extern signal_handler sys_signal (int, signal_handler);
307
308 struct sigaction {
309 int sa_flags;
310 void (_CALLBACK_ *sa_handler)(int);
311 sigset_t sa_mask;
312 };
313 #define SA_RESTART 0
314 #define SIG_BLOCK 1
315 #define SIG_SETMASK 2
316 #define SIG_UNBLOCK 3
317
318 extern int sigemptyset (sigset_t *);
319 extern int sigaddset (sigset_t *, int);
320 extern int sigfillset (sigset_t *);
321 extern int sigprocmask (int, const sigset_t *, sigset_t *);
322 extern int pthread_sigmask (int, const sigset_t *, sigset_t *);
323 extern int sigismember (const sigset_t *, int);
324 extern int setpgrp (int, int);
325 extern int sigaction (int, const struct sigaction *, struct sigaction *);
326 extern int alarm (int);
327
328 extern int sys_kill (int, int);
329
330
331 /* For integration with MSDOS support. */
332 #define getdisk() (_getdrive () - 1)
333 #ifdef emacs
334 #define getdefdir(_drv, _buf) ((_buf[0] = (_drv + 'A' - 1), _buf[1] = ':', _buf[2] = '/', _buf[3] = 0), 1)
335 #else
336 #define getdefdir(_drv, _buf) _getdcwd (_drv, _buf, MAXPATHLEN)
337 #endif
338
339 extern char *get_emacs_configuration (void);
340 extern char *get_emacs_configuration_options (void);
341 #define EMACS_CONFIGURATION get_emacs_configuration ()
342 #define EMACS_CONFIG_OPTIONS get_emacs_configuration_options ()
343
344 /* Define this so that winsock.h definitions don't get included with
345 windows.h. For this to have proper effect, config.h must always be
346 included before windows.h. */
347 #define _WINSOCKAPI_ 1
348 #define _WINSOCK_H
349
350 /* Prevent accidental use of features unavailable in
351 older Windows versions we still support. */
352 #define _WIN32_WINNT 0x0400
353
354 /* Make a leaner executable. */
355 #define WIN32_LEAN_AND_MEAN 1
356
357 /* Defines size_t and alloca (). */
358 #ifdef emacs
359 #define malloc e_malloc
360 #define free e_free
361 #define realloc e_realloc
362 #define calloc e_calloc
363 #endif
364 #ifdef _MSC_VER
365 #define alloca _alloca
366 #else
367 #include <malloc.h>
368 #endif
369
370 #include <stdlib.h>
371 #include <sys/stat.h>
372
373 /* Define for those source files that do not include enough NT system files. */
374 #ifndef NULL
375 #ifdef __cplusplus
376 #define NULL 0
377 #else
378 #define NULL ((void *)0)
379 #endif
380 #endif
381
382 /* For proper declaration of environ. */
383 #ifndef sys_nerr
384 #define sys_nerr _sys_nerr
385 #endif
386
387 extern int getloadavg (double *, int);
388 extern int getpagesize (void);
389
390 #if defined (__MINGW32__)
391
392 /* Define to 1 if the system has the type `long long int'. */
393 # define HAVE_LONG_LONG_INT 1
394
395 /* Define to 1 if the system has the type `unsigned long long int'. */
396 # define HAVE_UNSIGNED_LONG_LONG_INT 1
397
398 #endif
399
400 #ifdef _MSC_VER
401 # if defined(_WIN64)
402 typedef __int64 EMACS_INT;
403 typedef unsigned __int64 EMACS_UINT;
404 # define EMACS_INT_MAX LLONG_MAX
405 # define PRIuMAX "llu"
406 # define pI "ll"
407 /* Fix a bug in MSVC headers : stdint.h */
408 # define _INTPTR 2
409 # elif defined(_WIN32)
410 /* Temporarily disable wider-than-pointer integers until they're tested more.
411 Build with CFLAGS='-DWIDE_EMACS_INT' to try them out. */
412
413 # ifdef WIDE_EMACS_INT
414
415 /* Use pre-C99-style 64-bit integers. */
416 typedef __int64 EMACS_INT;
417 typedef unsigned __int64 EMACS_UINT;
418 # define EMACS_INT_MAX LLONG_MAX
419 # define PRIuMAX "llu"
420 # define pI "I64"
421 # else
422 typedef int EMACS_INT;
423 typedef unsigned int EMACS_UINT;
424 # define EMACS_INT_MAX LONG_MAX
425 # define PRIuMAX "lu"
426 # define pI "l"
427 # endif
428 # endif
429 #endif
430
431 /* We need a little extra space, see ../../lisp/loadup.el. */
432 #define SYSTEM_PURESIZE_EXTRA 50000
433
434 #define DATA_START get_data_start ()
435
436 /* For unexec to work on Alpha systems, we need to put Emacs'
437 initialized data into a separate section from the CRT initialized
438 data (because the Alpha linker freely reorders data variables, even
439 across libraries, so our data and the CRT data get intermingled).
440
441 Starting with MSVC 5.0, we must also place the uninitialized data
442 into its own section. VC5 intermingles uninitialized data from the CRT
443 between Emacs' static uninitialized data and its public uninitialized
444 data. A separate .bss section for Emacs groups both static and
445 public uninitialized together.
446
447 Note that unexw32.c relies on this fact, and must be modified
448 accordingly if this section name is changed, or if this pragma is
449 removed. Also, obviously, all files that define initialized data
450 must include config.h to pick up this pragma. */
451
452 /* Names must be < 8 bytes. */
453 #ifdef _MSC_VER
454 #pragma data_seg("EMDATA")
455 #pragma bss_seg("EMBSS")
456 #endif
457
458 /* #define FULL_DEBUG */
459 /* #define EMACSDEBUG */
460
461 #ifdef EMACSDEBUG
462 extern void _DebPrint (const char *fmt, ...);
463 #define DebPrint(stuff) _DebPrint stuff
464 #else
465 #define DebPrint(stuff)
466 #endif
467
468 #ifdef _MSC_VER
469 #if _MSC_VER >= 800 && !defined(__cplusplus)
470 /* Unnamed type definition in parentheses.
471 A structure, union, or enumerated type with no name is defined in a
472 parenthetical expression. The type definition is meaningless. */
473 #pragma warning(disable:4116)
474 /* 'argument' : conversion from 'type1' to 'type2', possible loss of
475 data A floating point type was converted to an integer type. A
476 possible loss of data may have occurred. */
477 #pragma warning(disable:4244)
478 /* Negative integral constant converted to unsigned type.
479 An expression converts a negative integer constant to an unsigned type.
480 The result of the expression is probably meaningless. */
481 #pragma warning(disable:4308)
482 #endif
483 #endif
484 #define TERM_HEADER "w32term.h"
485
486
487 /* ============================================================ */