1b2a309e1bef27a55b41bcf4a975e9d81e913e90
[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 #ifdef HAVE_NTGUI
128 #define HAVE_WINDOW_SYSTEM 1
129 #define HAVE_MENUS 1
130 #endif
131
132 /* Get some redefinitions in place. */
133
134 #ifdef emacs
135
136 #ifdef _MSC_VER
137 #include <sys/timeb.h>
138 #include <sys/stat.h>
139 #include <signal.h>
140
141 /* MSVC gets link-time errors without these redirections. */
142 #define fstat(a, b) sys_fstat(a, b)
143 #define stat(a, b) sys_stat(a, b)
144 #define utime sys_utime
145 #endif
146
147 /* Calls that are emulated or shadowed. */
148 #undef chdir
149 #define chdir sys_chdir
150 #undef chmod
151 #define chmod sys_chmod
152 #define chown sys_chown
153 #undef close
154 #define close sys_close
155 #undef creat
156 #define creat sys_creat
157 #define ctime sys_ctime
158 #undef dup
159 #define dup sys_dup
160 #undef dup2
161 #define dup2 sys_dup2
162 #define fopen sys_fopen
163 #define link sys_link
164 #define localtime sys_localtime
165 #define mkdir sys_mkdir
166 #undef mktemp
167 #define mktemp sys_mktemp
168 #undef open
169 #define open sys_open
170 #define pipe sys_pipe
171 #undef read
172 #define read sys_read
173 #define rename sys_rename
174 #define rmdir sys_rmdir
175 #define select sys_select
176 #define pselect sys_select
177 #define sleep sys_sleep
178 #define strerror sys_strerror
179 #undef unlink
180 #define unlink sys_unlink
181 #undef write
182 #define write sys_write
183
184 /* Subprocess calls that are emulated. */
185 #define spawnve sys_spawnve
186 #define wait sys_wait
187 #define kill sys_kill
188 #define signal sys_signal
189
190 /* Internal signals. */
191 #define emacs_raise(sig) emacs_abort()
192
193 extern int sys_wait (int *);
194
195 /* termcap.c calls that are emulated. */
196 #define tputs sys_tputs
197 #define tgetstr sys_tgetstr
198
199 /* cm.c calls that are emulated. */
200 #define chcheckmagic sys_chcheckmagic
201 #define cmcostinit sys_cmcostinit
202 #define cmgoto sys_cmgoto
203 #define cmputc sys_cmputc
204 #define Wcm_clear sys_Wcm_clear
205
206 #endif /* emacs */
207
208 /* Map to MSVC names. */
209 #define execlp _execlp
210 #define execvp _execvp
211 #define fdopen _fdopen
212 #ifndef fileno
213 #define fileno _fileno
214 #endif
215 #define fsync _commit
216 #define ftruncate _chsize
217 #define getpid _getpid
218 #ifdef _MSC_VER
219 typedef int pid_t;
220 #define snprintf _snprintf
221 #define strtoll _strtoi64
222 #endif
223 #define isatty _isatty
224 #define logb _logb
225 #define _longjmp longjmp
226 #define lseek _lseek
227 #define popen _popen
228 #define pclose _pclose
229 #define umask _umask
230 #ifndef _MSC_VER
231 #define utimbuf _utimbuf
232 #endif
233 #define strdup _strdup
234 #define strupr _strupr
235 #define strnicmp _strnicmp
236 #define stricmp _stricmp
237 #define tzset _tzset
238
239 /* We cannot include system header process.h, since there's src/process.h. */
240 int _getpid (void);
241
242 /* Include time.h before redirecting tzname, since MSVC's time.h
243 defines _tzname to call a function, but also declares tzname a
244 2-element array. Having the redirection before including the
245 header thus has the effect of declaring a function that returns an
246 array, and triggers an error message. */
247 #include <time.h>
248 #define tzname _tzname
249 #if !defined (_MSC_VER) || (_MSC_VER < 1400)
250 #undef utime
251 #define utime _utime
252 #endif
253
254 /* 'struct timespec' is used by time-related functions in lib/ and
255 elsewhere, but we don't use lib/time.h where the structure is
256 defined. */
257 struct timespec
258 {
259 time_t tv_sec; /* seconds */
260 long int tv_nsec; /* nanoseconds */
261 };
262
263 /* Required for functions in lib/time_r.c, since we don't use lib/time.h. */
264 extern struct tm *gmtime_r (time_t const * restrict, struct tm * restrict);
265 extern struct tm *localtime_r (time_t const * restrict, struct tm * restrict);
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 #define SIGPROF 19 /* Profiling */
290
291 #ifndef NSIG
292 #define NSIG 23
293 #endif
294
295 #ifdef _MSC_VER
296 typedef int sigset_t;
297 typedef int ssize_t;
298 #endif
299
300 typedef void (_CALLBACK_ *signal_handler) (int);
301 extern signal_handler sys_signal (int, signal_handler);
302
303 struct sigaction {
304 int sa_flags;
305 void (_CALLBACK_ *sa_handler)(int);
306 sigset_t sa_mask;
307 };
308 #define SA_RESTART 0
309 #define SIG_BLOCK 1
310 #define SIG_SETMASK 2
311 #define SIG_UNBLOCK 3
312
313 extern int sigemptyset (sigset_t *);
314 extern int sigaddset (sigset_t *, int);
315 extern int sigfillset (sigset_t *);
316 extern int sigprocmask (int, const sigset_t *, sigset_t *);
317 extern int pthread_sigmask (int, const sigset_t *, sigset_t *);
318 extern int sigismember (const sigset_t *, int);
319 extern int setpgrp (int, int);
320 extern int sigaction (int, const struct sigaction *, struct sigaction *);
321 extern int alarm (int);
322
323 extern int sys_kill (int, int);
324
325
326 /* For integration with MSDOS support. */
327 #define getdisk() (_getdrive () - 1)
328 #ifdef emacs
329 #define getdefdir(_drv, _buf) ((_buf[0] = (_drv + 'A' - 1), _buf[1] = ':', _buf[2] = '/', _buf[3] = 0), 1)
330 #else
331 #define getdefdir(_drv, _buf) _getdcwd (_drv, _buf, MAXPATHLEN)
332 #endif
333
334 extern char *get_emacs_configuration (void);
335 extern char *get_emacs_configuration_options (void);
336 #define EMACS_CONFIGURATION get_emacs_configuration ()
337 #define EMACS_CONFIG_OPTIONS get_emacs_configuration_options ()
338
339 /* Define this so that winsock.h definitions don't get included with
340 windows.h. For this to have proper effect, config.h must always be
341 included before windows.h. */
342 #define _WINSOCKAPI_ 1
343 #define _WINSOCK_H
344
345 /* Prevent accidental use of features unavailable in
346 older Windows versions we still support. */
347 #define _WIN32_WINNT 0x0400
348
349 /* Make a leaner executable. */
350 #define WIN32_LEAN_AND_MEAN 1
351
352 /* Defines size_t and alloca (). */
353 #ifdef emacs
354 #define malloc e_malloc
355 #define free e_free
356 #define realloc e_realloc
357 #define calloc e_calloc
358 #endif
359 #ifdef _MSC_VER
360 #define alloca _alloca
361 #else
362 #include <malloc.h>
363 #endif
364
365 #include <stdlib.h>
366 #include <sys/stat.h>
367
368 /* Define for those source files that do not include enough NT system files. */
369 #ifndef NULL
370 #ifdef __cplusplus
371 #define NULL 0
372 #else
373 #define NULL ((void *)0)
374 #endif
375 #endif
376
377 /* For proper declaration of environ. */
378 #ifndef sys_nerr
379 #define sys_nerr _sys_nerr
380 #endif
381
382 extern int getloadavg (double *, int);
383 extern int getpagesize (void);
384
385 #if defined (__MINGW32__)
386
387 /* Define to 1 if the system has the type `long long int'. */
388 # define HAVE_LONG_LONG_INT 1
389
390 /* Define to 1 if the system has the type `unsigned long long int'. */
391 # define HAVE_UNSIGNED_LONG_LONG_INT 1
392
393 #endif
394
395 #ifdef _MSC_VER
396 # if defined(_WIN64)
397 typedef __int64 EMACS_INT;
398 typedef unsigned __int64 EMACS_UINT;
399 # define EMACS_INT_MAX LLONG_MAX
400 # define PRIuMAX "llu"
401 # define pI "ll"
402 /* Fix a bug in MSVC headers : stdint.h */
403 # define _INTPTR 2
404 # elif defined(_WIN32)
405 /* Temporarily disable wider-than-pointer integers until they're tested more.
406 Build with CFLAGS='-DWIDE_EMACS_INT' to try them out. */
407
408 # ifdef WIDE_EMACS_INT
409
410 /* Use pre-C99-style 64-bit integers. */
411 typedef __int64 EMACS_INT;
412 typedef unsigned __int64 EMACS_UINT;
413 # define EMACS_INT_MAX LLONG_MAX
414 # define PRIuMAX "llu"
415 # define pI "I64"
416 # else
417 typedef int EMACS_INT;
418 typedef unsigned int EMACS_UINT;
419 # define EMACS_INT_MAX LONG_MAX
420 # define PRIuMAX "lu"
421 # define pI "l"
422 # endif
423 # endif
424 #endif
425
426 /* We need a little extra space, see ../../lisp/loadup.el. */
427 #define SYSTEM_PURESIZE_EXTRA 50000
428
429 #define DATA_START get_data_start ()
430
431 /* For unexec to work on Alpha systems, we need to put Emacs'
432 initialized data into a separate section from the CRT initialized
433 data (because the Alpha linker freely reorders data variables, even
434 across libraries, so our data and the CRT data get intermingled).
435
436 Starting with MSVC 5.0, we must also place the uninitialized data
437 into its own section. VC5 intermingles uninitialized data from the CRT
438 between Emacs' static uninitialized data and its public uninitialized
439 data. A separate .bss section for Emacs groups both static and
440 public uninitialized together.
441
442 Note that unexw32.c relies on this fact, and must be modified
443 accordingly if this section name is changed, or if this pragma is
444 removed. Also, obviously, all files that define initialized data
445 must include config.h to pick up this pragma. */
446
447 /* Names must be < 8 bytes. */
448 #ifdef _MSC_VER
449 #pragma data_seg("EMDATA")
450 #pragma bss_seg("EMBSS")
451 #endif
452
453 /* #define FULL_DEBUG */
454 /* #define EMACSDEBUG */
455
456 #ifdef EMACSDEBUG
457 extern void _DebPrint (const char *fmt, ...);
458 #define DebPrint(stuff) _DebPrint stuff
459 #else
460 #define DebPrint(stuff)
461 #endif
462
463 #ifdef _MSC_VER
464 #if _MSC_VER >= 800 && !defined(__cplusplus)
465 /* Unnamed type definition in parentheses.
466 A structure, union, or enumerated type with no name is defined in a
467 parenthetical expression. The type definition is meaningless. */
468 #pragma warning(disable:4116)
469 /* 'argument' : conversion from 'type1' to 'type2', possible loss of
470 data A floating point type was converted to an integer type. A
471 possible loss of data may have occurred. */
472 #pragma warning(disable:4244)
473 /* Negative integral constant converted to unsigned type.
474 An expression converts a negative integer constant to an unsigned type.
475 The result of the expression is probably meaningless. */
476 #pragma warning(disable:4308)
477 #endif
478 #endif
479 #define TERM_HEADER "w32term.h"
480
481
482 /* ============================================================ */