(MULTI_KBOARD): Define.
[bpt/emacs.git] / src / s / ms-w32.h
1 /* System description file for Windows NT.
2 Copyright (C) 1993, 1994, 1995, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007 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, 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 /* But our select implementation doesn't allow us to make non-blocking
141 connects. So until that is fixed, this is necessary: */
142
143 #define BROKEN_NON_BLOCKING_CONNECT 1
144
145 /* And the select implementation does 1-byte read-ahead waiting
146 for received packets, so datagrams are broken too. */
147
148 #define BROKEN_DATAGRAM_SOCKETS 1
149
150 /* Define this symbol if your system has the functions bcopy, etc. */
151
152 #define BSTRING
153 #define bzero(b, l) memset(b, 0, l)
154 #define bcopy(s, d, l) memmove(d, s, l)
155 #define bcmp(a, b, l) memcmp(a, b, l)
156
157 /* bcopy (aka memmove aka memcpy at least on x86) under MSVC is quite safe */
158 #define GAP_USE_BCOPY 1
159 #define BCOPY_UPWARD_SAFE 1
160 #define BCOPY_DOWNWARD_SAFE 1
161
162 /* subprocesses should be defined if you want to
163 have code for asynchronous subprocesses
164 (as used in M-x compile and M-x shell).
165 This is generally OS dependent, and not supported
166 under most USG systems. */
167
168 #define subprocesses 1
169
170 /* If your system uses COFF (Common Object File Format) then define the
171 preprocessor symbol "COFF". */
172
173 #define COFF 1
174
175 /* define MAIL_USE_FLOCK if the mailer uses flock
176 to interlock access to /usr/spool/mail/$USER.
177 The alternative is that a lock file named
178 /usr/spool/mail/$USER.lock. */
179
180 /* #define MAIL_USE_FLOCK */
181 #define MAIL_USE_POP 1
182 #define MAIL_USE_SYSTEM_LOCK 1
183
184 /* Define CLASH_DETECTION if you want lock files to be written
185 so that Emacs can tell instantly when you try to modify
186 a file that someone else has modified in his Emacs. */
187
188 /* #define CLASH_DETECTION 1 */
189
190 /* Define this if your operating system declares signal handlers to
191 have a type other than the usual. `The usual' is `void' for ANSI C
192 systems (i.e. when the __STDC__ macro is defined), and `int' for
193 pre-ANSI systems. If you're using GCC on an older system, __STDC__
194 will be defined, but the system's include files will still say that
195 signal returns int or whatever; in situations like that, define
196 this to be what the system's include files want. */
197 /* #define SIGTYPE int */
198
199 /* If the character used to separate elements of the executable path
200 is not ':', #define this to be the appropriate character constant. */
201 #define SEPCHAR ';'
202
203 #define ORDINARY_LINK 1
204
205 /* ============================================================ */
206
207 /* Here, add any special hacks needed
208 to make Emacs work on this system. For example,
209 you might define certain system call names that don't
210 exist on your system, or that do different things on
211 your system and must be used only through an encapsulation
212 (Which you should place, by convention, in sysdep.c). */
213
214 /* Define this to be the separator between path elements */
215 #define DIRECTORY_SEP XINT (Vdirectory_sep_char)
216
217 /* Define this to be the separator between devices and paths */
218 #define DEVICE_SEP ':'
219
220 /* We'll support either convention on NT. */
221 #define IS_DIRECTORY_SEP(_c_) ((_c_) == '/' || (_c_) == '\\')
222 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_) || IS_DEVICE_SEP (_c_))
223
224 /* The null device on Windows NT. */
225 #define NULL_DEVICE "NUL:"
226
227 #ifndef MAXPATHLEN
228 #define MAXPATHLEN _MAX_PATH
229 #endif
230
231 #define HAVE_SOUND 1
232 #define LISP_FLOAT_TYPE 1
233
234 #undef HAVE_SYS_SELECT_H
235 #define HAVE_SYS_TIMEB_H 1
236 #define HAVE_SYS_TIME_H 1
237 #define HAVE_UNISTD_H 1
238 #undef HAVE_UTIME_H
239 #undef HAVE_LINUX_VERSION_H
240 #undef HAVE_SYS_SYSTEMINFO_H
241 #undef HAVE_TERMIOS_H
242 #define HAVE_LIMITS_H 1
243 #define HAVE_STRING_H 1
244 #define HAVE_PWD_H 1
245 #define STDC_HEADERS 1
246 #define TIME_WITH_SYS_TIME 1
247
248 #define HAVE_GETTIMEOFDAY 1
249 #define HAVE_GETHOSTNAME 1
250 #undef HAVE_GETDOMAINNAME
251 #define HAVE_DUP2 1
252 #define HAVE_RENAME 1
253 #define HAVE_CLOSEDIR 1
254 #define HAVE_FSYNC 1 /* fsync is called _commit in MSVC. */
255
256 #undef TM_IN_SYS_TIME
257 #undef HAVE_TM_ZONE
258
259 #define HAVE_LONG_FILE_NAMES 1
260
261 #define HAVE_MKDIR 1
262 #define HAVE_RMDIR 1
263 #define HAVE_RANDOM 1
264 #undef HAVE_SYSINFO
265 #undef HAVE_LRAND48
266 #define HAVE_BCOPY 1
267 #define HAVE_BCMP 1
268 #define HAVE_LOGB 1
269 #define HAVE_FREXP 1
270 #define HAVE_FMOD 1
271 #undef HAVE_RINT
272 #undef HAVE_CBRT
273 #define HAVE_FTIME 1
274 #undef HAVE_RES_INIT /* For -lresolv on Suns. */
275 #undef HAVE_SETSID
276 #undef HAVE_FPATHCONF
277 #define HAVE_SELECT 1
278 #define HAVE_MKTIME 1
279 #undef HAVE_EUIDACCESS
280 #define HAVE_GETPAGESIZE 1
281 #define HAVE_TZSET 1
282 #define HAVE_SETLOCALE 1
283 #undef HAVE_UTIMES
284 #undef HAVE_SETRLIMIT
285 #undef HAVE_SETPGID
286 #undef HAVE_GETCWD
287 #define HAVE_SHUTDOWN 1
288 #define HAVE_STRFTIME 1
289
290 #define LOCALTIME_CACHE
291 #define HAVE_INET_SOCKETS 1
292
293 #undef HAVE_AIX_SMT_EXP
294
295 /* Define if you have the ANSI `strerror' function.
296 Otherwise you must have the variable `char *sys_errlist[]'. */
297 #define HAVE_STRERROR 1
298
299 /* Define if `struct utimbuf' is declared by <utime.h>. */
300 #undef HAVE_STRUCT_UTIMBUF
301
302 #define HAVE_MOUSE 1
303 #define HAVE_H_ERRNO 1
304
305 #define MULTI_KBOARD 1
306
307 #ifdef HAVE_NTGUI
308 #define HAVE_WINDOW_SYSTEM 1
309 #define HAVE_FACES 1
310 #define HAVE_MENUS 1
311 #endif
312
313 #define MODE_LINE_BINARY_TEXT(_b_) (NILP ((_b_)->buffer_file_type) ? "T" : "B")
314
315 /* get some redefinitions in place */
316
317 #ifdef emacs
318
319 /* calls that are emulated or shadowed */
320 #undef access
321 #define access sys_access
322 #undef chdir
323 #define chdir sys_chdir
324 #undef chmod
325 #define chmod sys_chmod
326 #define chown sys_chown
327 #undef close
328 #define close sys_close
329 #undef creat
330 #define creat sys_creat
331 #define ctime sys_ctime
332 #undef dup
333 #define dup sys_dup
334 #undef dup2
335 #define dup2 sys_dup2
336 #define fopen sys_fopen
337 #define link sys_link
338 #define mkdir sys_mkdir
339 #undef mktemp
340 #define mktemp sys_mktemp
341 #undef open
342 #define open sys_open
343 #define pipe sys_pipe
344 #undef read
345 #define read sys_read
346 #define rename sys_rename
347 #define rmdir sys_rmdir
348 #define select sys_select
349 #define sleep sys_sleep
350 #define strerror sys_strerror
351 #undef unlink
352 #define unlink sys_unlink
353 #undef write
354 #define write sys_write
355
356 /* subprocess calls that are emulated */
357 #define spawnve sys_spawnve
358 #define wait sys_wait
359 #define kill sys_kill
360 #define signal sys_signal
361
362 #endif /* emacs */
363
364 /* map to MSVC names */
365 #define execlp _execlp
366 #define execvp _execvp
367 #define fcloseall _fcloseall
368 #define fdopen _fdopen
369 #define fgetchar _fgetchar
370 #ifndef fileno
371 #define fileno _fileno
372 #endif
373 #define flushall _flushall
374 #define fputchar _fputchar
375 #define fsync _commit
376 #define ftruncate _chsize
377 #define getw _getw
378 #define getpid _getpid
379 #ifdef _MSC_VER
380 typedef int pid_t;
381 #endif
382 #define isatty _isatty
383 #define logb _logb
384 #define _longjmp longjmp
385 #define lseek _lseek
386 #define popen _popen
387 #define pclose _pclose
388 #define putw _putw
389 #define umask _umask
390 #define utimbuf _utimbuf
391 #define index strchr
392 #define rindex strrchr
393 #define strdup _strdup
394 #define strupr _strupr
395 #define strnicmp _strnicmp
396 #define stricmp _stricmp
397 #define tzset _tzset
398
399 #if !defined (_MSC_VER) || (_MSC_VER < 1400)
400 #define tzname _tzname
401 #define utime _utime
402 #endif
403
404 #ifdef HAVE_NTGUI
405 #define abort w32_abort
406 #endif
407
408 /* this is hacky, but is necessary to avoid warnings about macro
409 redefinitions using the SDK compilers */
410 #ifndef __STDC__
411 #define __STDC__ 1
412 #define MUST_UNDEF__STDC__
413 #endif
414 #include <direct.h>
415 #include <io.h>
416 #include <stdio.h>
417 #ifdef MUST_UNDEF__STDC__
418 #undef __STDC__
419 #undef MUST_UNDEF__STDC__
420 #endif
421
422 /* Defines that we need that aren't in the standard signal.h */
423 #define SIGHUP 1 /* Hang up */
424 #define SIGQUIT 3 /* Quit process */
425 #define SIGTRAP 5 /* Trace trap */
426 #define SIGKILL 9 /* Die, die die */
427 #define SIGPIPE 13 /* Write on pipe with no readers */
428 #define SIGALRM 14 /* Alarm */
429 #define SIGCHLD 18 /* Death of child */
430
431 #ifndef NSIG
432 #define NSIG 23
433 #endif
434
435 /* For integration with MSDOS support. */
436 #define getdisk() (_getdrive () - 1)
437 #ifdef emacs
438 #define getdefdir(_drv, _buf) ((_buf[0] = (_drv + 'A' - 1), _buf[1] = ':', _buf[2] = '/', _buf[3] = 0), 1)
439 #else
440 #define getdefdir(_drv, _buf) _getdcwd (_drv, _buf, MAXPATHLEN)
441 #endif
442
443 extern char *get_emacs_configuration (void);
444 extern char *get_emacs_configuration_options (void);
445 #define EMACS_CONFIGURATION get_emacs_configuration ()
446 #define EMACS_CONFIG_OPTIONS get_emacs_configuration_options ()
447
448 /* Define this so that winsock.h definitions don't get included with
449 windows.h. For this to have proper effect, config.h must always be
450 included before windows.h. */
451 #define _WINSOCKAPI_ 1
452 #define _WINSOCK_H
453
454 /* Defines size_t and alloca (). */
455 #ifdef USE_CRT_DLL
456 #define malloc e_malloc
457 #define free e_free
458 #define realloc e_realloc
459 #define calloc e_calloc
460 #endif
461 #include <malloc.h>
462
463 #include <sys/stat.h>
464
465 /* Define for those source files that do not include enough NT
466 system files. */
467 #ifndef NULL
468 #ifdef __cplusplus
469 #define NULL 0
470 #else
471 #define NULL ((void *)0)
472 #endif
473 #endif
474
475 /* For proper declaration of environ. */
476 #include <stdlib.h>
477 #ifndef sys_nerr
478 #define sys_nerr _sys_nerr
479 #endif
480 #include <string.h>
481
482 /* We need a little extra space, see ../../lisp/loadup.el.
483 The number below comes from 23923 bytes worth (as of 2006-04)
484 of w32-specific files loaded by loadup.el, plus 1K spare. */
485 #define SYSTEM_PURESIZE_EXTRA 50000
486
487 /* For unexec to work on Alpha systems, we need to put Emacs'
488 initialized data into a separate section from the CRT initialized
489 data (because the Alpha linker freely reorders data variables, even
490 across libraries, so our data and the CRT data get intermingled).
491
492 Starting with MSVC 5.0, we must also place the uninitialized data
493 into its own section. VC5 intermingles uninitialized data from the CRT
494 between Emacs' static uninitialized data and its public uninitialized
495 data. A separate .bss section for Emacs groups both static and
496 public uninitalized together.
497
498 Note that unexnt.c relies on this fact, and must be modified
499 accordingly if this section name is changed, or if this pragma is
500 removed. Also, obviously, all files that define initialized data
501 must include config.h to pick up this pragma. */
502
503 /* Names must be < 8 bytes */
504 #ifdef _MSC_VER
505 #pragma data_seg("EMDATA")
506 #pragma bss_seg("EMBSS")
507 #endif
508
509 /* #define FULL_DEBUG */
510 /* #define EMACSDEBUG */
511
512 #ifdef EMACSDEBUG
513 extern void _DebPrint (const char *fmt, ...);
514 #define DebPrint(stuff) _DebPrint stuff
515 #else
516 #define DebPrint(stuff)
517 #endif
518
519
520 /* ============================================================ */
521
522 /* arch-tag: 5d4a3a1c-40dc-4dea-9c7c-38fed9ae0eae
523 (do not change this comment) */