Update years in copyright notice; nfc.
[bpt/emacs.git] / src / s / ms-w32.h
1 /* System description file for Windows NT.
2 Copyright (C) 1993, 1994, 1995, 2002, 2003, 2004,
3 2005, 2006 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 2, or (at your option)
10 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; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
21
22 /*
23 * Define symbols to identify the version of Unix this is.
24 * Define all the symbols that apply correctly.
25 */
26
27 /* #define UNIPLUS */
28 /* #define USG5 */
29 /* #define USG */
30 /* #define HPUX */
31 /* #define UMAX */
32 /* #define BSD4_1 */
33 /* #define BSD4_2 */
34 /* #define BSD4_3 */
35 /* #define BSD_SYSTEM */
36 /* #define VMS */
37 #ifndef WINDOWSNT
38 #define WINDOWSNT
39 #endif
40 #ifndef DOS_NT
41 #define DOS_NT /* MSDOS or WINDOWSNT */
42 #endif
43
44 /* If you are compiling with a non-C calling convention but need to
45 declare vararg routines differently, put it here */
46 #define _VARARGS_ __cdecl
47
48 /* If you are providing a function to something that will call the
49 function back (like a signal handler and signal, or main) its calling
50 convention must be whatever standard the libraries expect */
51 #define _CALLBACK_ __cdecl
52
53 /* SYSTEM_TYPE should indicate the kind of system you are using.
54 It sets the Lisp variable system-type. */
55
56 #define SYSTEM_TYPE "windows-nt"
57 #define SYMS_SYSTEM syms_of_ntterm ()
58
59 #define NO_MATHERR 1
60
61 /* NOMULTIPLEJOBS should be defined if your system's shell
62 does not have "job control" (the ability to stop a program,
63 run some other program, then continue the first one). */
64
65 /* #define NOMULTIPLEJOBS 1 */
66
67 /* Emacs can read input using SIGIO and buffering characters itself,
68 or using CBREAK mode and making C-g cause SIGINT.
69 The choice is controlled by the variable interrupt_input.
70
71 Define INTERRUPT_INPUT to make interrupt_input = 1 the default (use SIGIO)
72
73 Emacs uses the presence or absence of the SIGIO macro to indicate
74 whether or not signal-driven I/O is possible. It uses
75 INTERRUPT_INPUT to decide whether to use it by default.
76
77 SIGIO can be used only on systems that implement it (4.2 and 4.3).
78 CBREAK mode has two disadvantages
79 1) At least in 4.2, it is impossible to handle the Meta key properly.
80 I hear that in system V this problem does not exist.
81 2) Control-G causes output to be discarded.
82 I do not know whether this can be fixed in system V.
83
84 Another method of doing input is planned but not implemented.
85 It would have Emacs fork off a separate process
86 to read the input and send it to the true Emacs process
87 through a pipe. */
88
89 /* #define INTERRUPT_INPUT 1 */
90
91 /* Letter to use in finding device name of first pty,
92 if system supports pty's. 'a' means it is /dev/ptya0 */
93
94 #define FIRST_PTY_LETTER 'a'
95
96 /*
97 * Define HAVE_TERMIOS if the system provides POSIX-style
98 * functions and macros for terminal control.
99 *
100 * Define HAVE_TERMIO if the system provides sysV-style ioctls
101 * for terminal control.
102 *
103 * Do not define both. HAVE_TERMIOS is preferred, if it is
104 * supported on your system.
105 */
106
107 /* #define HAVE_TERMIOS 1 */
108 /* #define HAVE_TERMIO 1 */
109
110 /*
111 * Define HAVE_TIMEVAL if the system supports the BSD style clock values.
112 * Look in <sys/time.h> for a timeval structure.
113 */
114
115 #define HAVE_TIMEVAL 1
116
117 /*
118 * Define HAVE_SELECT if the system supports the `select' system call.
119 */
120
121 /* #define HAVE_SELECT 1 */
122
123 /*
124 * Define HAVE_PTYS if the system supports pty devices.
125 */
126
127 /* #define HAVE_PTYS 1 */
128
129 /*
130 * Define NONSYSTEM_DIR_LIBRARY to make Emacs emulate
131 * The 4.2 opendir, etc., library functions.
132 */
133
134 /* #define NONSYSTEM_DIR_LIBRARY */
135
136 /* NT supports Winsock which is close enough (with some hacks) */
137
138 #define HAVE_SOCKETS 1
139
140 /* Define this symbol if your system has the functions bcopy, etc. */
141
142 #define BSTRING
143 #define bzero(b, l) memset(b, 0, l)
144 #define bcopy(s, d, l) memmove(d, s, l)
145 #define bcmp(a, b, l) memcmp(a, b, l)
146
147 /* bcopy (aka memmove aka memcpy at least on x86) under MSVC is quite safe */
148 #define GAP_USE_BCOPY 1
149 #define BCOPY_UPWARD_SAFE 1
150 #define BCOPY_DOWNWARD_SAFE 1
151
152 /* subprocesses should be defined if you want to
153 have code for asynchronous subprocesses
154 (as used in M-x compile and M-x shell).
155 This is generally OS dependent, and not supported
156 under most USG systems. */
157
158 #define subprocesses 1
159
160 /* If your system uses COFF (Common Object File Format) then define the
161 preprocessor symbol "COFF". */
162
163 #define COFF 1
164
165 /* define MAIL_USE_FLOCK if the mailer uses flock
166 to interlock access to /usr/spool/mail/$USER.
167 The alternative is that a lock file named
168 /usr/spool/mail/$USER.lock. */
169
170 /* #define MAIL_USE_FLOCK */
171 #define MAIL_USE_POP 1
172 #define MAIL_USE_SYSTEM_LOCK 1
173
174 /* Define CLASH_DETECTION if you want lock files to be written
175 so that Emacs can tell instantly when you try to modify
176 a file that someone else has modified in his Emacs. */
177
178 /* #define CLASH_DETECTION 1 */
179
180 /* Define this if your operating system declares signal handlers to
181 have a type other than the usual. `The usual' is `void' for ANSI C
182 systems (i.e. when the __STDC__ macro is defined), and `int' for
183 pre-ANSI systems. If you're using GCC on an older system, __STDC__
184 will be defined, but the system's include files will still say that
185 signal returns int or whatever; in situations like that, define
186 this to be what the system's include files want. */
187 /* #define SIGTYPE int */
188
189 /* If the character used to separate elements of the executable path
190 is not ':', #define this to be the appropriate character constant. */
191 #define SEPCHAR ';'
192
193 #define ORDINARY_LINK 1
194
195 /* ============================================================ */
196
197 /* Here, add any special hacks needed
198 to make Emacs work on this system. For example,
199 you might define certain system call names that don't
200 exist on your system, or that do different things on
201 your system and must be used only through an encapsulation
202 (Which you should place, by convention, in sysdep.c). */
203
204 /* Define this to be the separator between path elements */
205 #define DIRECTORY_SEP XINT (Vdirectory_sep_char)
206
207 /* Define this to be the separator between devices and paths */
208 #define DEVICE_SEP ':'
209
210 /* We'll support either convention on NT. */
211 #define IS_DIRECTORY_SEP(_c_) ((_c_) == '/' || (_c_) == '\\')
212 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_) || IS_DEVICE_SEP (_c_))
213
214 /* The null device on Windows NT. */
215 #define NULL_DEVICE "NUL:"
216
217 #ifndef MAXPATHLEN
218 #define MAXPATHLEN _MAX_PATH
219 #endif
220
221 #define HAVE_SOUND 1
222 #define LISP_FLOAT_TYPE 1
223
224 #undef HAVE_SYS_SELECT_H
225 #define HAVE_SYS_TIMEB_H 1
226 #define HAVE_SYS_TIME_H 1
227 #define HAVE_UNISTD_H 1
228 #undef HAVE_UTIME_H
229 #undef HAVE_LINUX_VERSION_H
230 #undef HAVE_SYS_SYSTEMINFO_H
231 #undef HAVE_TERMIOS_H
232 #define HAVE_LIMITS_H 1
233 #define HAVE_STRING_H 1
234 #define HAVE_PWD_H 1
235 #define STDC_HEADERS 1
236 #define TIME_WITH_SYS_TIME 1
237
238 #define HAVE_GETTIMEOFDAY 1
239 #define HAVE_GETHOSTNAME 1
240 #undef HAVE_GETDOMAINNAME
241 #define HAVE_DUP2 1
242 #define HAVE_RENAME 1
243 #define HAVE_CLOSEDIR 1
244 #define HAVE_FSYNC 1 /* fsync is called _commit in MSVC. */
245
246 #undef TM_IN_SYS_TIME
247 #undef HAVE_TM_ZONE
248 #define HAVE_TZNAME 1
249
250 #define HAVE_LONG_FILE_NAMES 1
251
252 #define HAVE_MKDIR 1
253 #define HAVE_RMDIR 1
254 #define HAVE_RANDOM 1
255 #undef HAVE_SYSINFO
256 #undef HAVE_LRAND48
257 #define HAVE_BCOPY 1
258 #define HAVE_BCMP 1
259 #define HAVE_LOGB 1
260 #define HAVE_FREXP 1
261 #define HAVE_FMOD 1
262 #undef HAVE_RINT
263 #undef HAVE_CBRT
264 #define HAVE_FTIME 1
265 #undef HAVE_RES_INIT /* For -lresolv on Suns. */
266 #undef HAVE_SETSID
267 #undef HAVE_FPATHCONF
268 #define HAVE_SELECT 1
269 #define HAVE_MKTIME 1
270 #undef HAVE_EUIDACCESS
271 #define HAVE_GETPAGESIZE 1
272 #define HAVE_TZSET 1
273 #define HAVE_SETLOCALE 1
274 #undef HAVE_UTIMES
275 #undef HAVE_SETRLIMIT
276 #undef HAVE_SETPGID
277 #undef HAVE_GETCWD
278 #define HAVE_SHUTDOWN 1
279 #define HAVE_STRFTIME 1
280
281 #define LOCALTIME_CACHE
282 #undef HAVE_INET_SOCKETS
283
284 #undef HAVE_AIX_SMT_EXP
285
286 /* Define if you have the ANSI `strerror' function.
287 Otherwise you must have the variable `char *sys_errlist[]'. */
288 #define HAVE_STRERROR 1
289
290 /* Define if `struct utimbuf' is declared by <utime.h>. */
291 #undef HAVE_STRUCT_UTIMBUF
292
293 #define HAVE_MOUSE 1
294 #define HAVE_H_ERRNO 1
295
296 #ifdef HAVE_NTGUI
297 #define HAVE_WINDOW_SYSTEM 1
298 #define HAVE_FACES 1
299 #define HAVE_MENUS 1
300 #endif
301
302 #define MODE_LINE_BINARY_TEXT(_b_) (NILP ((_b_)->buffer_file_type) ? "T" : "B")
303
304 /* get some redefinitions in place */
305
306 #ifdef emacs
307
308 /* calls that are emulated or shadowed */
309 #undef access
310 #define access sys_access
311 #undef chdir
312 #define chdir sys_chdir
313 #undef chmod
314 #define chmod sys_chmod
315 #define chown sys_chown
316 #undef close
317 #define close sys_close
318 #undef creat
319 #define creat sys_creat
320 #define ctime sys_ctime
321 #undef dup
322 #define dup sys_dup
323 #undef dup2
324 #define dup2 sys_dup2
325 #define fopen sys_fopen
326 #define link sys_link
327 #define mkdir sys_mkdir
328 #undef mktemp
329 #define mktemp sys_mktemp
330 #undef open
331 #define open sys_open
332 #define pipe sys_pipe
333 #undef read
334 #define read sys_read
335 #define rename sys_rename
336 #define rmdir sys_rmdir
337 #define select sys_select
338 #define sleep sys_sleep
339 #define strerror sys_strerror
340 #undef unlink
341 #define unlink sys_unlink
342 #undef write
343 #define write sys_write
344
345 /* subprocess calls that are emulated */
346 #define spawnve sys_spawnve
347 #define wait sys_wait
348 #define kill sys_kill
349 #define signal sys_signal
350
351 #endif /* emacs */
352
353 /* map to MSVC names */
354 #define execlp _execlp
355 #define execvp _execvp
356 #define fcloseall _fcloseall
357 #define fdopen _fdopen
358 #define fgetchar _fgetchar
359 #ifndef fileno
360 #define fileno _fileno
361 #endif
362 #define flushall _flushall
363 #define fputchar _fputchar
364 #define fsync _commit
365 #define ftruncate _chsize
366 #define getw _getw
367 #define getpid _getpid
368 #define isatty _isatty
369 #define logb _logb
370 #define _longjmp longjmp
371 #define lseek _lseek
372 #define popen _popen
373 #define pclose _pclose
374 #define putw _putw
375 #define umask _umask
376 #define utime _utime
377 #define utimbuf _utimbuf
378 #define index strchr
379 #define rindex strrchr
380 #define strdup _strdup
381 #define strupr _strupr
382 #define strnicmp _strnicmp
383 #define stricmp _stricmp
384 #define tzset _tzset
385 #define tzname _tzname
386
387 #ifdef HAVE_NTGUI
388 #define abort w32_abort
389 #endif
390
391 /* this is hacky, but is necessary to avoid warnings about macro
392 redefinitions using the SDK compilers */
393 #ifndef __STDC__
394 #define __STDC__ 1
395 #define MUST_UNDEF__STDC__
396 #endif
397 #include <direct.h>
398 #include <io.h>
399 #include <stdio.h>
400 #ifdef MUST_UNDEF__STDC__
401 #undef __STDC__
402 #undef MUST_UNDEF__STDC__
403 #endif
404
405 /* Defines that we need that aren't in the standard signal.h */
406 #define SIGHUP 1 /* Hang up */
407 #define SIGQUIT 3 /* Quit process */
408 #define SIGTRAP 5 /* Trace trap */
409 #define SIGKILL 9 /* Die, die die */
410 #define SIGPIPE 13 /* Write on pipe with no readers */
411 #define SIGALRM 14 /* Alarm */
412 #define SIGCHLD 18 /* Death of child */
413
414 #ifndef NSIG
415 #define NSIG 23
416 #endif
417
418 /* For integration with MSDOS support. */
419 #define getdisk() (_getdrive () - 1)
420 #ifdef emacs
421 #define getdefdir(_drv, _buf) ((_buf[0] = (_drv + 'A' - 1), _buf[1] = ':', _buf[2] = '/', _buf[3] = 0), 1)
422 #else
423 #define getdefdir(_drv, _buf) _getdcwd (_drv, _buf, MAXPATHLEN)
424 #endif
425
426 extern char *get_emacs_configuration (void);
427 extern char *get_emacs_configuration_options (void);
428 #define EMACS_CONFIGURATION get_emacs_configuration ()
429 #define EMACS_CONFIG_OPTIONS get_emacs_configuration_options ()
430
431 /* Define this so that winsock.h definitions don't get included with
432 windows.h. For this to have proper effect, config.h must always be
433 included before windows.h. */
434 #define _WINSOCKAPI_ 1
435 #define _WINSOCK_H
436
437 /* Defines size_t and alloca (). */
438 #ifdef USE_CRT_DLL
439 #define malloc e_malloc
440 #define free e_free
441 #define realloc e_realloc
442 #define calloc e_calloc
443 #endif
444 #include <malloc.h>
445
446 #include <sys/stat.h>
447
448 /* Define for those source files that do not include enough NT
449 system files. */
450 #ifndef NULL
451 #ifdef __cplusplus
452 #define NULL 0
453 #else
454 #define NULL ((void *)0)
455 #endif
456 #endif
457
458 /* For proper declaration of environ. */
459 #include <stdlib.h>
460 #ifndef sys_nerr
461 #define sys_nerr _sys_nerr
462 #endif
463 #include <string.h>
464
465 /* We need a little extra space, see ../../lisp/loadup.el */
466 #define SYSTEM_PURESIZE_EXTRA 137500
467
468 /* For unexec to work on Alpha systems, we need to put Emacs'
469 initialized data into a separate section from the CRT initialized
470 data (because the Alpha linker freely reorders data variables, even
471 across libraries, so our data and the CRT data get intermingled).
472
473 Starting with MSVC 5.0, we must also place the uninitialized data
474 into its own section. VC5 intermingles uninitialized data from the CRT
475 between Emacs' static uninitialized data and its public uninitialized
476 data. A separate .bss section for Emacs groups both static and
477 public uninitalized together.
478
479 Note that unexnt.c relies on this fact, and must be modified
480 accordingly if this section name is changed, or if this pragma is
481 removed. Also, obviously, all files that define initialized data
482 must include config.h to pick up this pragma. */
483
484 /* Names must be < 8 bytes */
485 #ifdef _MSC_VER
486 #pragma data_seg("EMDATA")
487 #pragma bss_seg("EMBSS")
488 #endif
489
490 /* #define FULL_DEBUG */
491 /* #define EMACSDEBUG */
492
493 #ifdef EMACSDEBUG
494 extern void _DebPrint (const char *fmt, ...);
495 #define DebPrint(stuff) _DebPrint stuff
496 #else
497 #define DebPrint(stuff)
498 #endif
499
500
501 /* ============================================================ */
502
503 /* arch-tag: 5d4a3a1c-40dc-4dea-9c7c-38fed9ae0eae
504 (do not change this comment) */