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