An electric test is now passing
[emacs.git] / nt / inc / ms-w32.h
blob7de94ca01531637cef6de71d53db1a39a2a97e58
1 /* System description file for Windows NT.
3 Copyright (C) 1993-1995, 2001-2019 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
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 (at
10 your option) any later version.
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.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. */
20 /* Define symbols to identify the version of Unix this is.
21 Define all the symbols that apply correctly. */
23 #ifndef WINDOWSNT
24 #define WINDOWSNT
25 #endif
27 #include <mingw_time.h>
29 /* MinGW-w64 gcc does not automotically define a macro for
30 differentiating it fom MinGW gcc. We need to test the presence of
31 __MINGW64_VERSION_MAJOR in _mingw.h: */
32 #ifdef __MINGW32__
33 # include <_mingw.h>
34 # ifdef __MINGW64_VERSION_MAJOR
35 # define MINGW_W64
36 # endif
37 # if defined __MINGW32_VERSION && __MINGW32_VERSION >= 5001000L
38 /* Avoid warnings about gettimeofday being deprecated. */
39 # undef __POSIX_2008_DEPRECATED
40 # define __POSIX_2008_DEPRECATED
41 # endif
42 #endif
44 /* #undef const */
46 /* Number of chars of output in the buffer of a stdio stream. */
47 #ifdef __GNU_LIBRARY__
48 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
49 #else
50 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
51 #endif
53 /* If you are compiling with a non-C calling convention but need to
54 declare vararg routines differently, put it here. */
55 #define _VARARGS_ __cdecl
57 /* If you are providing a function to something that will call the
58 function back (like a signal handler and signal, or main) its calling
59 convention must be whatever standard the libraries expect. */
60 #define _CALLBACK_ __cdecl
62 /* Define HAVE_TIMEVAL if the system supports the BSD style clock values.
63 Look in <sys/time.h> for a timeval structure. */
64 #define HAVE_TIMEVAL 1
66 /* And the select implementation does 1-byte read-ahead waiting
67 for received packets, so datagrams are broken too. */
68 #define BROKEN_DATAGRAM_SOCKETS 1
70 #define MAIL_USE_SYSTEM_LOCK 1
72 /* Define to 1 if GCC-style __attribute__ ((__aligned__ (expr))) works. */
73 #ifdef __GNUC__
74 #define HAVE_ATTRIBUTE_ALIGNED 1
75 #endif
77 /* Define to 1 if strtold conforms to C99. */
78 #ifdef __GNUC__
79 #define HAVE_C99_STRTOLD 1
80 #endif
82 #if (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8))
83 # ifndef HAVE___BUILTIN_UNWIND_INIT
84 # define HAVE___BUILTIN_UNWIND_INIT 1
85 # endif
86 #endif
88 /* This isn't perfect, as some systems might have the page file in
89 another place. Also, I suspect that the time stamp of that file
90 might also change when Windows enlarges the file due to
91 insufficient VM. Still, this seems to be the most reliable way;
92 the alternative (of using GetSystemTimes) won't work on laptops
93 that hibernate, because the system clock is stopped then. Other
94 possibility would be to run "net statistics workstation" and parse
95 the output, but that's gross. So this should do; if the file is
96 not there, the boot time will be returned as zero, and filelock.c
97 already handles that. */
98 #define BOOT_TIME_FILE "C:/pagefile.sys"
100 /* ============================================================ */
102 /* Here, add any special hacks needed to make Emacs work on this
103 system. For example, you might define certain system call names
104 that don't exist on your system, or that do different things on
105 your system and must be used only through an encapsulation (which
106 you should place, by convention, in sysdep.c). */
108 #ifdef __GNUC__
109 #ifndef __cplusplus
110 #undef inline
111 #endif
112 #else /* MSVC */
113 #define inline __inline
114 #endif
116 #ifdef __GNUC__
117 /* config.h may have defined already. */
118 # ifndef restrict
119 # define restrict __restrict__
120 # endif
121 #else
122 /* FIXME: should we define to __restrict, which MSVC supports? */
123 # define restrict
124 #endif
126 /* `mode_t' is not defined for MSVC. Define. */
127 #ifdef _MSC_VER
128 typedef unsigned short mode_t;
129 #endif
131 /* A va_copy replacement for MSVC. */
132 #ifdef _MSC_VER
133 # ifdef _WIN64
134 # ifndef va_copy /* Need to be checked (?) */
135 # define va_copy(d,s) ((d) = (s))
136 # endif
137 # else /* not _WIN64 */
138 # define va_copy(d,s) ((d) = (s))
139 # endif /* not _WIN64 */
140 #endif /* _MSC_VER */
142 #ifndef WINDOWSNT
143 /* Some of the files of Emacs which are intended for use with other
144 programs assume that if you have a config.h file, you must declare
145 the type of getenv. */
146 extern char *getenv ();
147 #endif
149 /* Prevent accidental use of features unavailable in older Windows
150 versions we still support. MinGW64 defines this to a higher value
151 in its system headers, and is not really compatible with values
152 lower than 0x0500, so leave it alone. */
153 #ifndef MINGW_W64
154 # undef _WIN32_WINNT
155 # define _WIN32_WINNT 0x0400
156 #endif
158 /* Make a leaner executable. */
159 #define WIN32_LEAN_AND_MEAN
161 #include <sys/types.h>
163 #ifndef MAXPATHLEN
164 #define MAXPATHLEN _MAX_PATH
165 #endif
167 /* This is used to hold UTF-8 encoded file names. */
168 #define MAX_UTF8_PATH (MAXPATHLEN * 4)
170 #ifdef HAVE_NTGUI
171 # ifndef HAVE_WINDOW_SYSTEM
172 # define HAVE_WINDOW_SYSTEM 1
173 # define POLL_FOR_INPUT 1
174 # endif
175 #endif
177 /* Get some redefinitions in place. */
179 #ifdef emacs
181 #ifdef MINGW_W64
182 /* MinGW64 specific stuff. */
183 /* Make sure 'struct timespec' and 'struct timezone' are defined. */
184 #include <sys/types.h>
185 #include <time.h>
186 /* This prototype avoids MinGW64 compiler warnings due to the fact
187 that time.h is included before localtime is redirected to
188 sys_localtime below. */
189 extern struct tm * sys_localtime (const time_t *);
190 /* MinGW64 uses a 2-argument _setjmp, and setjmp is a macro defined to
191 supply the 2nd arg correctly, so don't use _setjmp directly in that
192 case. */
193 #undef HAVE__SETJMP
195 /* Unlike MS and mingw.org, MinGW64 doesn't define gai_strerror as an
196 inline function in a system header file, and instead seems to
197 require to link against ws2_32.a. But we don't want to link with
198 -lws2_32, as that would make Emacs dependent on the respective DLL.
199 So MinGW64 is amply punished here by the following: */
200 #undef HAVE_GAI_STRERROR
201 #endif
203 /* The following is needed for recovery from C stack overflows. */
204 #include <setjmp.h>
205 typedef jmp_buf sigjmp_buf;
206 #ifdef MINGW_W64
207 /* Evidently, MinGW64's longjmp crashes when invoked from an exception
208 handler, see https://sourceforge.net/p/mingw-w64/mailman/message/32421953/.
209 This seems to be an unsolved problem in the MinGW64 runtime. So we
210 use the GCC intrinsics instead. FIXME. */
211 #define sigsetjmp(j,m) __builtin_setjmp(j)
212 #else
213 #define sigsetjmp(j,m) setjmp(j)
214 #endif
215 extern void w32_reset_stack_overflow_guard (void);
217 #ifdef _MSC_VER
218 #include <sys/timeb.h>
219 #include <sys/stat.h>
220 #include <signal.h>
222 /* MSVC gets link-time errors without these redirections. */
223 #define fstat(a, b) sys_fstat(a, b)
224 #define stat(a, b) sys_stat(a, b)
225 #define utime sys_utime
226 #endif
228 /* Calls that are emulated or shadowed. */
229 #undef chdir
230 #define chdir sys_chdir
231 #undef chmod
232 #define chmod sys_chmod
233 #undef close
234 #define close sys_close
235 #undef creat
236 #define creat sys_creat
237 #define ctime sys_ctime
238 #undef dup
239 #define dup sys_dup
240 #undef dup2
241 #define dup2 sys_dup2
242 #define fopen sys_fopen
243 #define link sys_link
244 #define localtime sys_localtime
245 #undef read
246 #define read sys_read
247 #define rename sys_rename
248 #define rmdir sys_rmdir
249 #define select sys_select
250 #define pselect sys_select
251 #define sleep sys_sleep
252 #define strerror sys_strerror
253 #undef unlink
254 #define unlink sys_unlink
255 #undef opendir
256 #define opendir sys_opendir
257 #undef closedir
258 #define closedir sys_closedir
259 #undef readdir
260 #define readdir sys_readdir
261 #undef seekdir
262 #define seekdir sys_seekdir
263 /* This prototype is needed because some files include config.h
264 _after_ the standard headers, so sys_unlink gets no prototype from
265 stdio.h or io.h. */
266 extern int sys_unlink (const char *);
267 #undef write
268 #define write sys_write
269 #undef umask
270 #define umask sys_umask
271 extern int sys_umask (int);
273 /* Subprocess calls that are emulated. */
274 #define spawnve sys_spawnve
275 #define kill sys_kill
276 #define signal sys_signal
278 /* Internal signals. */
279 #define emacs_raise(sig) emacs_abort()
281 /* termcap.c calls that are emulated. */
282 #define tputs sys_tputs
283 #define tgetstr sys_tgetstr
285 /* cm.c calls that are emulated. */
286 #define chcheckmagic sys_chcheckmagic
287 #define cmcostinit sys_cmcostinit
288 #define cmgoto sys_cmgoto
289 #define cmputc sys_cmputc
290 #define Wcm_clear sys_Wcm_clear
292 #endif /* emacs */
294 /* Used both in Emacs, in lib-src, and in Gnulib. */
295 #undef open
296 #define open sys_open
298 /* Map to MSVC names. */
299 #define execlp _execlp
300 #define execvp _execvp
301 #include <stdint.h> /* for intptr_t */
302 extern intptr_t _execvp (const char *, char **);
303 #ifdef MINGW_W64
304 /* GCC 6 has a builtin execve with the prototype shown below. MinGW64
305 changed the prototype in its process.h to match that, although the
306 library function still calls _execve, which still returns intptr_t.
307 However, using the prototype with intptr_t causes GCC to emit
308 warnings. Fortunately, execve is not used in the MinGW build, but
309 the code that references it is still compiled. */
310 extern int execve (const char *, char * const *, char * const *);
311 #else
312 extern intptr_t execve (const char *, char * const *, char * const *);
313 #endif
314 #define tcdrain _commit
315 #define fdopen _fdopen
316 #define fsync _commit
317 #define ftruncate _chsize
318 #define getpid _getpid
319 #ifdef _MSC_VER
320 typedef int pid_t;
321 #define snprintf _snprintf
322 #define strtoll _strtoi64
323 #define copysign _copysign
324 #endif
325 #define isatty _isatty
326 #define _longjmp longjmp
327 /* MinGW64 defines lseek to invoke lseek64. */
328 #ifndef lseek
329 #define lseek _lseek
330 #endif
331 #define popen _popen
332 #define pclose _pclose
333 #define strdup _strdup
334 #define strupr _strupr
335 #define strnicmp _strnicmp
336 #define stricmp _stricmp
337 #define tzset _tzset
339 /* We cannot include system header process.h, since there's src/process.h. */
340 int _getpid (void);
342 /* Include time.h before redirecting tzname, since MSVC's time.h
343 defines _tzname to call a function, but also declares tzname a
344 2-element array. Having the redirection before including the
345 header thus has the effect of declaring a function that returns an
346 array, and triggers an error message. */
347 #include <time.h>
348 #define tzname _tzname
350 /* Required for functions in lib/time_r.c, since we don't use lib/time.h. */
351 extern struct tm *gmtime_r (time_t const * restrict, struct tm * restrict);
352 extern struct tm *localtime_r (time_t const * restrict, struct tm * restrict);
354 #ifdef _MSC_VER
355 /* This is hacky, but is necessary to avoid warnings about macro
356 redefinitions using the MSVC compilers, since, when __STDC__ is
357 undefined or zero, those compilers declare functions like fileno,
358 lseek, and chdir, for which we defined macros above. */
359 #ifndef __STDC__
360 #define __STDC__ 1
361 #define MUST_UNDEF__STDC__
362 #endif
363 #include <direct.h>
364 #include <io.h>
365 #include <stdio.h>
366 #ifdef MUST_UNDEF__STDC__
367 #undef __STDC__
368 #undef MUST_UNDEF__STDC__
369 #endif
370 #else /* !_MSC_VER */
371 #include <direct.h>
372 #include <io.h>
373 #include <stdio.h>
374 #endif /* !_MSC_VER */
375 #ifndef fileno
376 #define fileno _fileno
377 #endif
379 /* Defines that we need that aren't in the standard signal.h. */
380 #define SIGHUP 1 /* Hang up */
381 #define SIGQUIT 3 /* Quit process */
382 #define SIGTRAP 5 /* Trace trap */
383 #define SIGKILL 9 /* Die, die die */
384 #define SIGPIPE 13 /* Write on pipe with no readers */
385 #define SIGALRM 14 /* Alarm */
386 #define SIGCHLD 18 /* Death of child */
387 #define SIGPROF 19 /* Profiling */
389 #ifndef NSIG
390 #define NSIG 23
391 #endif
393 #ifndef ENOTSUP
394 #define ENOTSUP ENOSYS
395 #endif
397 /* In case lib/errno.h is not used. */
398 #ifndef EOPNOTSUPP
399 #define EOPNOTSUPP 130
400 #endif
402 #ifdef _MSC_VER
403 typedef int sigset_t;
404 typedef int ssize_t;
405 #endif
407 #ifdef MINGW_W64
408 #ifndef _POSIX
409 typedef _sigset_t sigset_t;
410 #endif
411 #endif
413 typedef void (_CALLBACK_ *signal_handler) (int);
414 extern signal_handler sys_signal (int, signal_handler);
416 struct sigaction {
417 int sa_flags;
418 void (_CALLBACK_ *sa_handler)(int);
419 sigset_t sa_mask;
421 #define SA_RESTART 0
422 #define SIG_BLOCK 1
423 #define SIG_SETMASK 2
424 #define SIG_UNBLOCK 3
426 extern int sigemptyset (sigset_t *);
427 extern int sigaddset (sigset_t *, int);
428 extern int sigfillset (sigset_t *);
429 extern int sigprocmask (int, const sigset_t *, sigset_t *);
430 /* MinGW64 defines pthread_sigmask as zero in its pthread_signal.h
431 header, but we have an implementation for that function in w32proc.c. */
432 #ifdef pthread_sigmask
433 #undef pthread_sigmask
434 #endif
435 extern int pthread_sigmask (int, const sigset_t *, sigset_t *);
436 extern int sigismember (const sigset_t *, int);
437 extern int setpgrp (int, int);
438 extern int sigaction (int, const struct sigaction *, struct sigaction *);
439 extern int alarm (int);
441 extern int sys_kill (pid_t, int);
444 /* For integration with MSDOS support. */
445 #define getdisk() (_getdrive () - 1)
446 #ifdef emacs
447 #define getdefdir(_drv, _buf) ((_buf[0] = (_drv + 'A' - 1), _buf[1] = ':', _buf[2] = '/', _buf[3] = 0), 1)
448 #else
449 #define getdefdir(_drv, _buf) _getdcwd (_drv, _buf, MAXPATHLEN)
450 #endif
452 #ifndef EMACS_CONFIGURATION
453 extern char *get_emacs_configuration (void);
454 extern char *get_emacs_configuration_options (void);
455 #define EMACS_CONFIGURATION get_emacs_configuration ()
456 #define EMACS_CONFIG_OPTIONS get_emacs_configuration_options ()
457 #endif
459 /* Define this so that winsock.h definitions don't get included with
460 windows.h. For this to have proper effect, config.h must always be
461 included before windows.h. */
462 #define _WINSOCKAPI_ 1
463 #if !(defined __MINGW32_VERSION && __MINGW32_VERSION >= 5000002L)
464 /* mingw.org's MinGW 5.x changed how it includes winsock.h and time.h,
465 and now defining _WINSOCK_H skips the definition of struct timeval,
466 which we don't want. */
467 # define _WINSOCK_H
468 #endif
470 /* Defines size_t and alloca (). */
471 #include <stdlib.h>
472 #include <sys/stat.h>
473 #ifdef _MSC_VER
474 #define alloca _alloca
475 #else
476 #include <malloc.h>
477 #endif
479 /* Needed in Emacs and in Gnulib. */
480 /* This must be after including sys/stat.h, because we need mode_t. */
481 #undef mkdir
482 #define mkdir(d,f) sys_mkdir(d,f)
483 int sys_mkdir (const char *, mode_t);
485 #ifdef emacs
487 typedef void * (* malloc_fn)(size_t);
488 typedef void * (* realloc_fn)(void *, size_t);
489 typedef void (* free_fn)(void *);
491 extern void *malloc_before_dump(size_t);
492 extern void *realloc_before_dump(void *, size_t);
493 extern void free_before_dump(void *);
494 extern void *malloc_after_dump(size_t);
495 extern void *realloc_after_dump(void *, size_t);
496 extern void free_after_dump(void *);
498 extern void *malloc_after_dump_9x(size_t);
499 extern void *realloc_after_dump_9x(void *, size_t);
500 extern void free_after_dump_9x(void *);
502 extern malloc_fn the_malloc_fn;
503 extern realloc_fn the_realloc_fn;
504 extern free_fn the_free_fn;
506 #define malloc(size) (*the_malloc_fn)(size)
507 #define free(ptr) (*the_free_fn)(ptr)
508 #define realloc(ptr, size) (*the_realloc_fn)(ptr, size)
510 #endif
512 /* Define for those source files that do not include enough NT system files. */
513 #ifndef NULL
514 #ifdef __cplusplus
515 #define NULL 0
516 #else
517 #define NULL ((void *)0)
518 #endif
519 #endif
521 /* For proper declaration of environ. */
522 #ifndef sys_nerr
523 #define sys_nerr _sys_nerr
524 #endif
526 /* This must be after including stdlib.h, which defines putenv on MinGW. */
527 #ifdef putenv
528 # undef putenv
529 #endif
530 #define putenv sys_putenv
531 extern int sys_putenv (char *);
533 extern int getloadavg (double *, int);
534 extern int getpagesize (void);
536 extern void * memrchr (void const *, int, size_t);
538 /* Declared here, since we don't use Gnulib's stdlib.h. */
539 extern int mkostemp (char *, int);
541 #if defined (__MINGW32__)
543 /* Define to 1 if the system has the type `long long int'. */
544 # ifndef HAVE_LONG_LONG_INT
545 # define HAVE_LONG_LONG_INT 1
546 # endif
548 /* Define to 1 if the system has the type `unsigned long long int'. */
549 # ifndef HAVE_UNSIGNED_LONG_LONG_INT
550 # define HAVE_UNSIGNED_LONG_LONG_INT 1
551 # endif
553 #endif
555 #ifdef _MSC_VER
556 # if defined(_WIN64)
557 typedef __int64 EMACS_INT;
558 typedef unsigned __int64 EMACS_UINT;
559 # define EMACS_INT_MAX LLONG_MAX
560 # define PRIuMAX "llu"
561 # define pI "ll"
562 /* Fix a bug in MSVC headers : stdint.h */
563 # define _INTPTR 2
564 # elif defined(_WIN32)
565 /* Temporarily disable wider-than-pointer integers until they're tested more.
566 Build with CFLAGS='-DWIDE_EMACS_INT' to try them out. */
568 # ifdef WIDE_EMACS_INT
570 /* Use pre-C99-style 64-bit integers. */
571 typedef __int64 EMACS_INT;
572 typedef unsigned __int64 EMACS_UINT;
573 # define EMACS_INT_MAX LLONG_MAX
574 # define PRIuMAX "llu"
575 # define pI "I64"
576 # else
577 typedef int EMACS_INT;
578 typedef unsigned int EMACS_UINT;
579 # define EMACS_INT_MAX LONG_MAX
580 # define PRIuMAX "lu"
581 # define pI "l"
582 # endif
583 # endif
584 #endif
586 /* We need a little extra space, see ../../lisp/loadup.el. */
587 #define SYSTEM_PURESIZE_EXTRA 50000
589 #define DATA_START get_data_start ()
591 /* For unexec to work on Alpha systems, we need to put Emacs'
592 initialized data into a separate section from the CRT initialized
593 data (because the Alpha linker freely reorders data variables, even
594 across libraries, so our data and the CRT data get intermingled).
596 Starting with MSVC 5.0, we must also place the uninitialized data
597 into its own section. VC5 intermingles uninitialized data from the CRT
598 between Emacs' static uninitialized data and its public uninitialized
599 data. A separate .bss section for Emacs groups both static and
600 public uninitialized together.
602 Note that unexw32.c relies on this fact, and must be modified
603 accordingly if this section name is changed, or if this pragma is
604 removed. Also, obviously, all files that define initialized data
605 must include config.h to pick up this pragma. */
607 /* Names must be < 8 bytes. */
608 #ifdef _MSC_VER
609 #pragma data_seg("EMDATA")
610 #pragma bss_seg("EMBSS")
611 #endif
613 /* #define FULL_DEBUG */
614 /* #define EMACSDEBUG */
616 #ifdef _MSC_VER
617 #if _MSC_VER >= 800 && !defined(__cplusplus)
618 /* Unnamed type definition in parentheses.
619 A structure, union, or enumerated type with no name is defined in a
620 parenthetical expression. The type definition is meaningless. */
621 #pragma warning(disable:4116)
622 /* 'argument' : conversion from 'type1' to 'type2', possible loss of
623 data A floating point type was converted to an integer type. A
624 possible loss of data may have occurred. */
625 #pragma warning(disable:4244)
626 /* Negative integral constant converted to unsigned type.
627 An expression converts a negative integer constant to an unsigned type.
628 The result of the expression is probably meaningless. */
629 #pragma warning(disable:4308)
630 #endif
631 #endif
633 /* Event name for when emacsclient starts the Emacs daemon on Windows. */
634 #define W32_DAEMON_EVENT "EmacsServerEvent"
636 /* ============================================================ */