Move NT-specific include file to the NT include directory
[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 #ifndef DOS_NT
27 #define DOS_NT /* MSDOS or WINDOWSNT */
28 #endif
29
30 /* #undef const */
31
32 /* If you are compiling with a non-C calling convention but need to
33 declare vararg routines differently, put it here. */
34 #define _VARARGS_ __cdecl
35
36 /* If you are providing a function to something that will call the
37 function back (like a signal handler and signal, or main) its calling
38 convention must be whatever standard the libraries expect. */
39 #define _CALLBACK_ __cdecl
40
41 /* Define HAVE_TIMEVAL if the system supports the BSD style clock values.
42 Look in <sys/time.h> for a timeval structure. */
43 #define HAVE_TIMEVAL 1
44
45 /* But our select implementation doesn't allow us to make non-blocking
46 connects. So until that is fixed, this is necessary: */
47 #define BROKEN_NON_BLOCKING_CONNECT 1
48
49 /* And the select implementation does 1-byte read-ahead waiting
50 for received packets, so datagrams are broken too. */
51 #define BROKEN_DATAGRAM_SOCKETS 1
52
53 #define MAIL_USE_SYSTEM_LOCK 1
54
55 /* Define to 1 if GCC-style __attribute__ ((__aligned__ (expr))) works. */
56 #ifdef __GNUC__
57 #define HAVE_ATTRIBUTE_ALIGNED 1
58 #endif
59
60 /* Define to 1 if strtold conforms to C99. */
61 #ifdef __GNUC__
62 #define HAVE_C99_STRTOLD 1
63 #endif
64
65 #if (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8))
66 #define HAVE___BUILTIN_UNWIND_INIT 1
67 #endif
68
69 /* ============================================================ */
70
71 /* Here, add any special hacks needed to make Emacs work on this
72 system. For example, you might define certain system call names
73 that don't exist on your system, or that do different things on
74 your system and must be used only through an encapsulation (which
75 you should place, by convention, in sysdep.c). */
76
77 #ifdef __GNUC__
78 #ifndef __cplusplus
79 #undef inline
80 #endif
81 #else /* MSVC */
82 #define inline __inline
83 #endif
84
85 #ifdef __GNUC__
86 # define restrict __restrict__
87 #else
88 # define restrict
89 #endif
90
91 /* `mode_t' is not defined for MSVC. Define. */
92 #ifdef _MSC_VER
93 typedef unsigned short mode_t;
94 #endif
95
96 /* A va_copy replacement for MSVC. */
97 #ifdef _MSC_VER
98 # ifdef _WIN64
99 # ifndef va_copy /* Need to be checked (?) */
100 # define va_copy(d,s) ((d) = (s))
101 # endif
102 # else /* not _WIN64 */
103 # define va_copy(d,s) ((d) = (s))
104 # endif /* not _WIN64 */
105 #endif /* _MSC_VER */
106
107 #ifndef WINDOWSNT
108 /* Some of the files of Emacs which are intended for use with other
109 programs assume that if you have a config.h file, you must declare
110 the type of getenv. */
111 extern char *getenv ();
112 #endif
113
114 #ifdef HAVE_STRINGS_H
115 #include "strings.h"
116 #endif
117 #include <sys/types.h>
118
119 #ifdef _MSC_VER
120 typedef unsigned long sigset_t;
121 typedef int ssize_t;
122 #endif
123
124 struct sigaction {
125 int sa_flags;
126 void (*sa_handler)(int);
127 sigset_t sa_mask;
128 };
129 #define SIG_BLOCK 1
130 #define SIG_SETMASK 2
131 #define SIG_UNBLOCK 3
132
133 #ifndef MAXPATHLEN
134 #define MAXPATHLEN _MAX_PATH
135 #endif
136
137 #ifdef HAVE_NTGUI
138 #define HAVE_WINDOW_SYSTEM 1
139 #define HAVE_MENUS 1
140 #endif
141
142 /* Get some redefinitions in place. */
143
144 #ifdef emacs
145
146 #ifdef _MSC_VER
147 #include <sys/timeb.h>
148 #include <sys/stat.h>
149 #include <signal.h>
150
151 /* MSVC gets link-time errors without these redirections. */
152 #define fstat(a, b) sys_fstat(a, b)
153 #define stat(a, b) sys_stat(a, b)
154 #define utime sys_utime
155 #endif
156
157 /* Calls that are emulated or shadowed. */
158 #undef access
159 #define access sys_access
160 #undef chdir
161 #define chdir sys_chdir
162 #undef chmod
163 #define chmod sys_chmod
164 #define chown sys_chown
165 #undef close
166 #define close sys_close
167 #undef creat
168 #define creat sys_creat
169 #define ctime sys_ctime
170 #undef dup
171 #define dup sys_dup
172 #undef dup2
173 #define dup2 sys_dup2
174 #define fopen sys_fopen
175 #define link sys_link
176 #define localtime sys_localtime
177 #define mkdir sys_mkdir
178 #undef mktemp
179 #define mktemp sys_mktemp
180 #undef open
181 #define open sys_open
182 #define pipe sys_pipe
183 #undef read
184 #define read sys_read
185 #define rename sys_rename
186 #define rmdir sys_rmdir
187 #define select sys_select
188 #define pselect sys_select
189 #define sleep sys_sleep
190 #define strerror sys_strerror
191 #undef unlink
192 #define unlink sys_unlink
193 #undef write
194 #define write sys_write
195
196 /* Subprocess calls that are emulated. */
197 #define spawnve sys_spawnve
198 #define wait sys_wait
199 #define kill sys_kill
200 #define signal sys_signal
201
202 /* termcap.c calls that are emulated. */
203 #define tputs sys_tputs
204 #define tgetstr sys_tgetstr
205
206 /* cm.c calls that are emulated. */
207 #define chcheckmagic sys_chcheckmagic
208 #define cmcostinit sys_cmcostinit
209 #define cmgoto sys_cmgoto
210 #define cmputc sys_cmputc
211 #define Wcm_clear sys_Wcm_clear
212
213 #endif /* emacs */
214
215 /* Map to MSVC names. */
216 #define execlp _execlp
217 #define execvp _execvp
218 #define fdopen _fdopen
219 #ifndef fileno
220 #define fileno _fileno
221 #endif
222 #define fsync _commit
223 #define ftruncate _chsize
224 #define getpid _getpid
225 #ifdef _MSC_VER
226 typedef int pid_t;
227 #define snprintf _snprintf
228 #define strtoll _strtoi64
229 #endif
230 #define isatty _isatty
231 #define logb _logb
232 #define _longjmp longjmp
233 #define lseek _lseek
234 #define popen _popen
235 #define pclose _pclose
236 #define umask _umask
237 #ifndef _MSC_VER
238 #define utimbuf _utimbuf
239 #endif
240 #define strdup _strdup
241 #define strupr _strupr
242 #define strnicmp _strnicmp
243 #define stricmp _stricmp
244 #define tzset _tzset
245
246 /* Include time.h before redirecting tzname, since MSVC's time.h
247 defines _tzname to call a function, but also declares tzname a
248 2-element array. Having the redirection before including the
249 header thus has the effect of declaring a function that returns an
250 array, and triggers an error message. */
251 #include <time.h>
252 #define tzname _tzname
253 #if !defined (_MSC_VER) || (_MSC_VER < 1400)
254 #undef utime
255 #define utime _utime
256 #endif
257
258 /* 'struct timespec' is used by time-related functions in lib/ and
259 elsewhere, but we don't use lib/time.h where the structure is
260 defined. */
261 struct timespec
262 {
263 time_t tv_sec; /* seconds */
264 long int tv_nsec; /* nanoseconds */
265 };
266
267 /* This is hacky, but is necessary to avoid warnings about macro
268 redefinitions using the SDK compilers. */
269 #ifndef __STDC__
270 #define __STDC__ 1
271 #define MUST_UNDEF__STDC__
272 #endif
273 #include <direct.h>
274 #include <io.h>
275 #include <stdio.h>
276 #ifdef MUST_UNDEF__STDC__
277 #undef __STDC__
278 #undef MUST_UNDEF__STDC__
279 #endif
280
281 /* Defines that we need that aren't in the standard signal.h. */
282 #define SIGHUP 1 /* Hang up */
283 #define SIGQUIT 3 /* Quit process */
284 #define SIGTRAP 5 /* Trace trap */
285 #define SIGKILL 9 /* Die, die die */
286 #define SIGPIPE 13 /* Write on pipe with no readers */
287 #define SIGALRM 14 /* Alarm */
288 #define SIGCHLD 18 /* Death of child */
289
290 #ifndef NSIG
291 #define NSIG 23
292 #endif
293
294 /* For integration with MSDOS support. */
295 #define getdisk() (_getdrive () - 1)
296 #ifdef emacs
297 #define getdefdir(_drv, _buf) ((_buf[0] = (_drv + 'A' - 1), _buf[1] = ':', _buf[2] = '/', _buf[3] = 0), 1)
298 #else
299 #define getdefdir(_drv, _buf) _getdcwd (_drv, _buf, MAXPATHLEN)
300 #endif
301
302 extern char *get_emacs_configuration (void);
303 extern char *get_emacs_configuration_options (void);
304 #define EMACS_CONFIGURATION get_emacs_configuration ()
305 #define EMACS_CONFIG_OPTIONS get_emacs_configuration_options ()
306
307 /* Define this so that winsock.h definitions don't get included with
308 windows.h. For this to have proper effect, config.h must always be
309 included before windows.h. */
310 #define _WINSOCKAPI_ 1
311 #define _WINSOCK_H
312
313 /* Prevent accidental use of features unavailable in
314 older Windows versions we still support. */
315 #define _WIN32_WINNT 0x0400
316
317 /* Make a leaner executable. */
318 #define WIN32_LEAN_AND_MEAN 1
319
320 /* Defines size_t and alloca (). */
321 #ifdef emacs
322 #define malloc e_malloc
323 #define free e_free
324 #define realloc e_realloc
325 #define calloc e_calloc
326 #endif
327 #ifdef _MSC_VER
328 #define alloca _alloca
329 #else
330 #include <malloc.h>
331 #endif
332
333 /* stdlib.h must be included after redefining malloc & friends, but
334 before redefining abort. Isn't library redefinition funny? */
335 #include <stdlib.h>
336
337 /* Redefine abort. */
338 #ifdef HAVE_NTGUI
339 #define abort w32_abort
340 extern _Noreturn void w32_abort (void);
341 #endif
342
343 #include <sys/stat.h>
344
345 /* Define for those source files that do not include enough NT system files. */
346 #ifndef NULL
347 #ifdef __cplusplus
348 #define NULL 0
349 #else
350 #define NULL ((void *)0)
351 #endif
352 #endif
353
354 /* For proper declaration of environ. */
355 #ifndef sys_nerr
356 #define sys_nerr _sys_nerr
357 #endif
358
359 extern int getloadavg (double *, int);
360
361 #if defined (__MINGW32__) || _MSC_VER >= 1400
362
363 /* Define to 1 if the system has the type `long long int'. */
364 # define HAVE_LONG_LONG_INT 1
365
366 /* Define to 1 if the system has the type `unsigned long long int'. */
367 # define HAVE_UNSIGNED_LONG_LONG_INT 1
368
369 #elif _MSC_VER >= 1200
370
371 /* Temporarily disable wider-than-pointer integers until they're tested more.
372 Build with CFLAGS='-DWIDE_EMACS_INT' to try them out. */
373
374 # ifdef WIDE_EMACS_INT
375
376 /* Use pre-C99-style 64-bit integers. */
377 typedef __int64 EMACS_INT;
378 typedef unsigned __int64 EMACS_UINT;
379 # define EMACS_INT_MAX _I64_MAX
380 # define pI "I64"
381
382 # endif
383
384 #endif
385
386 /* We need a little extra space, see ../../lisp/loadup.el. */
387 #define SYSTEM_PURESIZE_EXTRA 50000
388
389 #define DATA_START get_data_start ()
390
391 /* For unexec to work on Alpha systems, we need to put Emacs'
392 initialized data into a separate section from the CRT initialized
393 data (because the Alpha linker freely reorders data variables, even
394 across libraries, so our data and the CRT data get intermingled).
395
396 Starting with MSVC 5.0, we must also place the uninitialized data
397 into its own section. VC5 intermingles uninitialized data from the CRT
398 between Emacs' static uninitialized data and its public uninitialized
399 data. A separate .bss section for Emacs groups both static and
400 public uninitialized together.
401
402 Note that unexw32.c relies on this fact, and must be modified
403 accordingly if this section name is changed, or if this pragma is
404 removed. Also, obviously, all files that define initialized data
405 must include config.h to pick up this pragma. */
406
407 /* Names must be < 8 bytes. */
408 #ifdef _MSC_VER
409 #pragma data_seg("EMDATA")
410 #pragma bss_seg("EMBSS")
411 #endif
412
413 /* #define FULL_DEBUG */
414 /* #define EMACSDEBUG */
415
416 #ifdef EMACSDEBUG
417 extern void _DebPrint (const char *fmt, ...);
418 #define DebPrint(stuff) _DebPrint stuff
419 #else
420 #define DebPrint(stuff)
421 #endif
422
423 /* ============================================================ */