More NEWS copyedits, and some reordering
[emacs.git] / nt / inc / ms-w32.h
blobdd2ae781cb8a11a5fb4e652ec5058ab23ccfa866
1 /* System description file for Windows NT.
3 Copyright (C) 1993-1995, 2001-2012 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
10 (at 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 <http://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 /* #undef const */
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
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
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
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
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
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
57 #define MAIL_USE_SYSTEM_LOCK 1
59 /* Define to 1 if GCC-style __attribute__ ((__aligned__ (expr))) works. */
60 #ifdef __GNUC__
61 #define HAVE_ATTRIBUTE_ALIGNED 1
62 #endif
64 /* Define to 1 if strtold conforms to C99. */
65 #ifdef __GNUC__
66 #define HAVE_C99_STRTOLD 1
67 #endif
69 #if (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8))
70 #define HAVE___BUILTIN_UNWIND_INIT 1
71 #endif
73 /* ============================================================ */
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). */
81 #ifdef __GNUC__
82 #ifndef __cplusplus
83 #undef inline
84 #endif
85 #else /* MSVC */
86 #define inline __inline
87 #endif
89 #ifdef __GNUC__
90 # define restrict __restrict__
91 #else
92 # define restrict
93 #endif
95 /* `mode_t' is not defined for MSVC. Define. */
96 #ifdef _MSC_VER
97 typedef unsigned short mode_t;
98 #endif
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 */
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
118 #ifdef HAVE_STRINGS_H
119 #include "strings.h"
120 #endif
121 #include <sys/types.h>
123 #ifndef MAXPATHLEN
124 #define MAXPATHLEN _MAX_PATH
125 #endif
127 #ifdef HAVE_NTGUI
128 #define HAVE_WINDOW_SYSTEM 1
129 #define HAVE_MENUS 1
130 #endif
132 /* Get some redefinitions in place. */
134 #ifdef emacs
136 #ifdef _MSC_VER
137 #include <sys/timeb.h>
138 #include <sys/stat.h>
139 #include <signal.h>
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
147 /* Calls that are emulated or shadowed. */
148 #undef access
149 #define access sys_access
150 #undef chdir
151 #define chdir sys_chdir
152 #undef chmod
153 #define chmod sys_chmod
154 #define chown sys_chown
155 #undef close
156 #define close sys_close
157 #undef creat
158 #define creat sys_creat
159 #define ctime sys_ctime
160 #undef dup
161 #define dup sys_dup
162 #undef dup2
163 #define dup2 sys_dup2
164 #define fopen sys_fopen
165 #define link sys_link
166 #define localtime sys_localtime
167 #define mkdir sys_mkdir
168 #undef mktemp
169 #define mktemp sys_mktemp
170 #undef open
171 #define open sys_open
172 #define pipe sys_pipe
173 #undef read
174 #define read sys_read
175 #define rename sys_rename
176 #define rmdir sys_rmdir
177 #define select sys_select
178 #define pselect sys_select
179 #define sleep sys_sleep
180 #define strerror sys_strerror
181 #undef unlink
182 #define unlink sys_unlink
183 #undef write
184 #define write sys_write
186 /* Subprocess calls that are emulated. */
187 #define spawnve sys_spawnve
188 #define wait sys_wait
189 #define kill sys_kill
190 #define signal sys_signal
192 /* Internal signals. */
193 #define emacs_raise(sig) emacs_abort()
195 extern int sys_wait (int *);
197 /* termcap.c calls that are emulated. */
198 #define tputs sys_tputs
199 #define tgetstr sys_tgetstr
201 /* cm.c calls that are emulated. */
202 #define chcheckmagic sys_chcheckmagic
203 #define cmcostinit sys_cmcostinit
204 #define cmgoto sys_cmgoto
205 #define cmputc sys_cmputc
206 #define Wcm_clear sys_Wcm_clear
208 #endif /* emacs */
210 /* Map to MSVC names. */
211 #define execlp _execlp
212 #define execvp _execvp
213 #define fdopen _fdopen
214 #ifndef fileno
215 #define fileno _fileno
216 #endif
217 #define fsync _commit
218 #define ftruncate _chsize
219 #define getpid _getpid
220 #ifdef _MSC_VER
221 typedef int pid_t;
222 #define snprintf _snprintf
223 #define strtoll _strtoi64
224 #endif
225 #define isatty _isatty
226 #define logb _logb
227 #define _longjmp longjmp
228 #define lseek _lseek
229 #define popen _popen
230 #define pclose _pclose
231 #define umask _umask
232 #ifndef _MSC_VER
233 #define utimbuf _utimbuf
234 #endif
235 #define strdup _strdup
236 #define strupr _strupr
237 #define strnicmp _strnicmp
238 #define stricmp _stricmp
239 #define tzset _tzset
241 /* We cannot include system header process.h, since there's src/process.h. */
242 int _getpid (void);
244 /* Include time.h before redirecting tzname, since MSVC's time.h
245 defines _tzname to call a function, but also declares tzname a
246 2-element array. Having the redirection before including the
247 header thus has the effect of declaring a function that returns an
248 array, and triggers an error message. */
249 #include <time.h>
250 #define tzname _tzname
251 #if !defined (_MSC_VER) || (_MSC_VER < 1400)
252 #undef utime
253 #define utime _utime
254 #endif
256 /* 'struct timespec' is used by time-related functions in lib/ and
257 elsewhere, but we don't use lib/time.h where the structure is
258 defined. */
259 struct timespec
261 time_t tv_sec; /* seconds */
262 long int tv_nsec; /* nanoseconds */
265 /* Required for functions in lib/time_r.c, since we don't use lib/time.h. */
266 extern struct tm *gmtime_r (time_t const * restrict, struct tm * restrict);
267 extern struct tm *localtime_r (time_t const * restrict, struct tm * restrict);
269 /* This is hacky, but is necessary to avoid warnings about macro
270 redefinitions using the SDK compilers. */
271 #ifndef __STDC__
272 #define __STDC__ 1
273 #define MUST_UNDEF__STDC__
274 #endif
275 #include <direct.h>
276 #include <io.h>
277 #include <stdio.h>
278 #ifdef MUST_UNDEF__STDC__
279 #undef __STDC__
280 #undef MUST_UNDEF__STDC__
281 #endif
283 /* Defines that we need that aren't in the standard signal.h. */
284 #define SIGHUP 1 /* Hang up */
285 #define SIGQUIT 3 /* Quit process */
286 #define SIGTRAP 5 /* Trace trap */
287 #define SIGKILL 9 /* Die, die die */
288 #define SIGPIPE 13 /* Write on pipe with no readers */
289 #define SIGALRM 14 /* Alarm */
290 #define SIGCHLD 18 /* Death of child */
291 #define SIGPROF 19 /* Profiling */
293 #ifndef NSIG
294 #define NSIG 23
295 #endif
297 #ifdef _MSC_VER
298 typedef int sigset_t;
299 typedef int ssize_t;
300 #endif
302 typedef void (_CALLBACK_ *signal_handler) (int);
303 extern signal_handler sys_signal (int, signal_handler);
305 struct sigaction {
306 int sa_flags;
307 void (_CALLBACK_ *sa_handler)(int);
308 sigset_t sa_mask;
310 #define SA_RESTART 0
311 #define SIG_BLOCK 1
312 #define SIG_SETMASK 2
313 #define SIG_UNBLOCK 3
315 extern int sigemptyset (sigset_t *);
316 extern int sigaddset (sigset_t *, int);
317 extern int sigfillset (sigset_t *);
318 extern int sigprocmask (int, const sigset_t *, sigset_t *);
319 extern int pthread_sigmask (int, const sigset_t *, sigset_t *);
320 extern int sigismember (const sigset_t *, int);
321 extern int setpgrp (int, int);
322 extern int sigaction (int, const struct sigaction *, struct sigaction *);
323 extern int alarm (int);
325 extern int sys_kill (int, int);
328 /* For integration with MSDOS support. */
329 #define getdisk() (_getdrive () - 1)
330 #ifdef emacs
331 #define getdefdir(_drv, _buf) ((_buf[0] = (_drv + 'A' - 1), _buf[1] = ':', _buf[2] = '/', _buf[3] = 0), 1)
332 #else
333 #define getdefdir(_drv, _buf) _getdcwd (_drv, _buf, MAXPATHLEN)
334 #endif
336 extern char *get_emacs_configuration (void);
337 extern char *get_emacs_configuration_options (void);
338 #define EMACS_CONFIGURATION get_emacs_configuration ()
339 #define EMACS_CONFIG_OPTIONS get_emacs_configuration_options ()
341 /* Define this so that winsock.h definitions don't get included with
342 windows.h. For this to have proper effect, config.h must always be
343 included before windows.h. */
344 #define _WINSOCKAPI_ 1
345 #define _WINSOCK_H
347 /* Prevent accidental use of features unavailable in
348 older Windows versions we still support. */
349 #define _WIN32_WINNT 0x0400
351 /* Make a leaner executable. */
352 #define WIN32_LEAN_AND_MEAN 1
354 /* Defines size_t and alloca (). */
355 #ifdef emacs
356 #define malloc e_malloc
357 #define free e_free
358 #define realloc e_realloc
359 #define calloc e_calloc
360 #endif
361 #ifdef _MSC_VER
362 #define alloca _alloca
363 #else
364 #include <malloc.h>
365 #endif
367 #include <stdlib.h>
368 #include <sys/stat.h>
370 /* Define for those source files that do not include enough NT system files. */
371 #ifndef NULL
372 #ifdef __cplusplus
373 #define NULL 0
374 #else
375 #define NULL ((void *)0)
376 #endif
377 #endif
379 /* For proper declaration of environ. */
380 #ifndef sys_nerr
381 #define sys_nerr _sys_nerr
382 #endif
384 extern int getloadavg (double *, int);
385 extern int getpagesize (void);
387 #if defined (__MINGW32__)
389 /* Define to 1 if the system has the type `long long int'. */
390 # define HAVE_LONG_LONG_INT 1
392 /* Define to 1 if the system has the type `unsigned long long int'. */
393 # define HAVE_UNSIGNED_LONG_LONG_INT 1
395 #endif
397 #ifdef _MSC_VER
398 # if defined(_WIN64)
399 typedef __int64 EMACS_INT;
400 typedef unsigned __int64 EMACS_UINT;
401 # define EMACS_INT_MAX LLONG_MAX
402 # define PRIuMAX "llu"
403 # define pI "ll"
404 /* Fix a bug in MSVC headers : stdint.h */
405 # define _INTPTR 2
406 # elif defined(_WIN32)
407 /* Temporarily disable wider-than-pointer integers until they're tested more.
408 Build with CFLAGS='-DWIDE_EMACS_INT' to try them out. */
410 # ifdef WIDE_EMACS_INT
412 /* Use pre-C99-style 64-bit integers. */
413 typedef __int64 EMACS_INT;
414 typedef unsigned __int64 EMACS_UINT;
415 # define EMACS_INT_MAX LLONG_MAX
416 # define PRIuMAX "llu"
417 # define pI "I64"
418 # else
419 typedef int EMACS_INT;
420 typedef unsigned int EMACS_UINT;
421 # define EMACS_INT_MAX LONG_MAX
422 # define PRIuMAX "lu"
423 # define pI "l"
424 # endif
425 # endif
426 #endif
428 /* We need a little extra space, see ../../lisp/loadup.el. */
429 #define SYSTEM_PURESIZE_EXTRA 50000
431 #define DATA_START get_data_start ()
433 /* For unexec to work on Alpha systems, we need to put Emacs'
434 initialized data into a separate section from the CRT initialized
435 data (because the Alpha linker freely reorders data variables, even
436 across libraries, so our data and the CRT data get intermingled).
438 Starting with MSVC 5.0, we must also place the uninitialized data
439 into its own section. VC5 intermingles uninitialized data from the CRT
440 between Emacs' static uninitialized data and its public uninitialized
441 data. A separate .bss section for Emacs groups both static and
442 public uninitialized together.
444 Note that unexw32.c relies on this fact, and must be modified
445 accordingly if this section name is changed, or if this pragma is
446 removed. Also, obviously, all files that define initialized data
447 must include config.h to pick up this pragma. */
449 /* Names must be < 8 bytes. */
450 #ifdef _MSC_VER
451 #pragma data_seg("EMDATA")
452 #pragma bss_seg("EMBSS")
453 #endif
455 /* #define FULL_DEBUG */
456 /* #define EMACSDEBUG */
458 #ifdef EMACSDEBUG
459 extern void _DebPrint (const char *fmt, ...);
460 #define DebPrint(stuff) _DebPrint stuff
461 #else
462 #define DebPrint(stuff)
463 #endif
465 #ifdef _MSC_VER
466 #if _MSC_VER >= 800 && !defined(__cplusplus)
467 /* Unnamed type definition in parentheses.
468 A structure, union, or enumerated type with no name is defined in a
469 parenthetical expression. The type definition is meaningless. */
470 #pragma warning(disable:4116)
471 /* 'argument' : conversion from 'type1' to 'type2', possible loss of
472 data A floating point type was converted to an integer type. A
473 possible loss of data may have occurred. */
474 #pragma warning(disable:4244)
475 /* Negative integral constant converted to unsigned type.
476 An expression converts a negative integer constant to an unsigned type.
477 The result of the expression is probably meaningless. */
478 #pragma warning(disable:4308)
479 #endif
480 #endif
481 #define TERM_HEADER "w32term.h"
484 /* ============================================================ */