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