src/s/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 #ifndef DOS_NT
  27 #define DOS_NT  /* MSDOS or WINDOWSNT */
  28 #endif
  29
  30 /* #undef const */
  31
  32 /* If you are compiling with a non-C calling convention but need to
  33    declare vararg routines differently, put it here.  */
  34 #define _VARARGS_ __cdecl
  35
  36 /* If you are providing a function to something that will call the
  37    function back (like a signal handler and signal, or main) its calling
  38    convention must be whatever standard the libraries expect.  */
  39 #define _CALLBACK_ __cdecl
  40
  41 /* Letter to use in finding device name of first pty,
  42    if system supports pty's.  'a' means it is /dev/ptya0  */
  43 #define FIRST_PTY_LETTER 'a'
  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 /* NT supports Winsock which is close enough (with some hacks).  */
  50 #define HAVE_SOCKETS 1
  51
  52 /* But our select implementation doesn't allow us to make non-blocking
  53    connects.  So until that is fixed, this is necessary:  */
  54 #define BROKEN_NON_BLOCKING_CONNECT 1
  55
  56 /* And the select implementation does 1-byte read-ahead waiting
  57    for received packets, so datagrams are broken too.  */
  58 #define BROKEN_DATAGRAM_SOCKETS 1
  59
  60 /* MSVC ignores the "register" keyword, so test fails even though
  61    setjmp does work.  */
  62 #define GC_SETJMP_WORKS 1
  63
  64 /* Enable conservative stack marking for GC.  */
  65 #define GC_MARK_STACK 1
  66
  67 #define MAIL_USE_SYSTEM_LOCK 1
  68
  69 /* If the character used to separate elements of the executable path
  70    is not ':', #define this to be the appropriate character constant.  */
  71 #define SEPCHAR ';'
  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 /* Define this to be the separator between devices and paths.  */
  82 #define DEVICE_SEP ':'
  83
  84 /* We'll support either convention on NT.  */
  85 #define IS_DIRECTORY_SEP(_c_) ((_c_) == '/' || (_c_) == '\\')
  86 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_) || IS_DEVICE_SEP (_c_))
  87
  88 #ifdef __GNUC__
  89 #ifndef __cplusplus
  90 #undef inline
  91 #endif
  92 #else  /* MSVC */
  93 #define inline __inline
  94 #endif
  95
  96 #ifdef __GNUC__
  97 # define restrict __restrict__
  98 #else
  99 # define restrict
 100 #endif
 101
 102 /* `mode_t' is not defined for MSVC. Define. */
 103 #ifdef _MSC_VER
 104 typedef unsigned short mode_t;
 105 #endif
 106
 107 /* A va_copy replacement for MSVC.  */
 108 #ifdef _MSC_VER
 109 # ifdef _WIN64
 110 #  ifndef va_copy               /* Need to be checked (?) */
 111 #   define va_copy(d,s) ((d) = (s))
 112 #  endif
 113 # else  /* not _WIN64 */
 114 #  define va_copy(d,s) ((d) = (s))
 115 # endif  /* not _WIN64 */
 116 #endif   /* _MSC_VER */
 117
 118 #ifndef WINDOWSNT
 119 /* Some of the files of Emacs which are intended for use with other
 120    programs assume that if you have a config.h file, you must declare
 121    the type of getenv.  */
 122 extern char *getenv ();
 123 #endif
 124
 125 #ifdef HAVE_STRINGS_H
 126 #include "strings.h"
 127 #endif
 128 #include <sys/types.h>
 129
 130 #ifdef _MSC_VER
 131 typedef unsigned long sigset_t;
 132 typedef int ssize_t;
 133 #endif
 134
 135 struct sigaction {
 136   int sa_flags;
 137   void (*sa_handler)(int);
 138   sigset_t sa_mask;
 139 };
 140 #define SIG_BLOCK       1
 141 #define SIG_SETMASK     2
 142 #define SIG_UNBLOCK     3
 143
 144 /* The null device on Windows NT.  */
 145 #define NULL_DEVICE     "NUL:"
 146
 147 #ifndef MAXPATHLEN
 148 #define MAXPATHLEN      _MAX_PATH
 149 #endif
 150
 151 /* MinGW has these in its library; MSVC doesn't.  */
 152 #ifdef _MSC_VER
 153 #define strcasecmp(s1,s2)  _stricmp(s1,s2)
 154 #define strncasecmp(s1,s2) _strnicmp(s1,s2)
 155 #endif
 156
 157 #ifdef HAVE_NTGUI
 158 #define HAVE_WINDOW_SYSTEM 1
 159 #define HAVE_MENUS 1
 160 #endif
 161
 162 /* Get some redefinitions in place.  */
 163
 164 #ifdef emacs
 165
 166 #ifdef _MSC_VER
 167 #include <sys/timeb.h>
 168 #include <sys/stat.h>
 169 #include <signal.h>
 170
 171 /* MSVC gets link-time errors without these redirections.  */
 172 #define fstat(a, b) sys_fstat(a, b)
 173 #define stat(a, b)  sys_stat(a, b)
 174 #define utime       sys_utime
 175 #endif
 176
 177 /* Calls that are emulated or shadowed.  */
 178 #undef access
 179 #define access  sys_access
 180 #undef chdir
 181 #define chdir   sys_chdir
 182 #undef chmod
 183 #define chmod   sys_chmod
 184 #define chown   sys_chown
 185 #undef close
 186 #define close   sys_close
 187 #undef creat
 188 #define creat   sys_creat
 189 #define ctime   sys_ctime
 190 #undef dup
 191 #define dup     sys_dup
 192 #undef dup2
 193 #define dup2    sys_dup2
 194 #define fopen   sys_fopen
 195 #define link    sys_link
 196 #define localtime sys_localtime
 197 #define mkdir   sys_mkdir
 198 #undef mktemp
 199 #define mktemp  sys_mktemp
 200 #undef open
 201 #define open    sys_open
 202 #define pipe    sys_pipe
 203 #undef read
 204 #define read    sys_read
 205 #define rename  sys_rename
 206 #define rmdir   sys_rmdir
 207 #define select  sys_select
 208 #define pselect sys_select
 209 #define sleep   sys_sleep
 210 #define strerror sys_strerror
 211 #undef unlink
 212 #define unlink  sys_unlink
 213 #undef write
 214 #define write   sys_write
 215
 216 /* Subprocess calls that are emulated.  */
 217 #define spawnve sys_spawnve
 218 #define wait    sys_wait
 219 #define kill    sys_kill
 220 #define signal  sys_signal
 221
 222 /* termcap.c calls that are emulated.  */
 223 #define tputs   sys_tputs
 224 #define tgetstr sys_tgetstr
 225
 226 /* cm.c calls that are emulated.  */
 227 #define chcheckmagic sys_chcheckmagic
 228 #define cmcostinit   sys_cmcostinit
 229 #define cmgoto       sys_cmgoto
 230 #define cmputc       sys_cmputc
 231 #define Wcm_clear    sys_Wcm_clear
 232
 233 #endif /* emacs */
 234
 235 /* Map to MSVC names.  */
 236 #define execlp    _execlp
 237 #define execvp    _execvp
 238 #define fdopen    _fdopen
 239 #ifndef fileno
 240 #define fileno    _fileno
 241 #endif
 242 #define fsync     _commit
 243 #define ftruncate _chsize
 244 #define getpid    _getpid
 245 #ifdef _MSC_VER
 246 typedef int pid_t;
 247 #define snprintf  _snprintf
 248 #define strtoll   _strtoi64
 249 #endif
 250 #define isatty    _isatty
 251 #define logb      _logb
 252 #define _longjmp  longjmp
 253 #define lseek     _lseek
 254 #define popen     _popen
 255 #define pclose    _pclose
 256 #define umask     _umask
 257 #ifndef _MSC_VER
 258 #define utimbuf   _utimbuf
 259 #endif
 260 #define strdup    _strdup
 261 #define strupr    _strupr
 262 #define strnicmp  _strnicmp
 263 #define stricmp   _stricmp
 264 #define tzset     _tzset
 265
 266 /* Include time.h before redirecting tzname, since MSVC's time.h
 267    defines _tzname to call a function, but also declares tzname a
 268    2-element array.  Having the redirection before including the
 269    header thus has the effect of declaring a function that returns an
 270    array, and triggers an error message.  */
 271 #include <time.h>
 272 #define tzname    _tzname
 273 #if !defined (_MSC_VER) || (_MSC_VER < 1400)
 274 #undef  utime
 275 #define utime     _utime
 276 #endif
 277
 278 /* 'struct timespec' is used by time-related functions in lib/ and
 279    elsewhere, but we don't use lib/time.h where the structure is
 280    defined.  */
 281 struct timespec
 282 {
 283   time_t        tv_sec;         /* seconds */
 284   long int      tv_nsec;        /* nanoseconds */
 285 };
 286
 287 /* This is hacky, but is necessary to avoid warnings about macro
 288    redefinitions using the SDK compilers.  */
 289 #ifndef __STDC__
 290 #define __STDC__ 1
 291 #define MUST_UNDEF__STDC__
 292 #endif
 293 #include <direct.h>
 294 #include <io.h>
 295 #include <stdio.h>
 296 #ifdef MUST_UNDEF__STDC__
 297 #undef __STDC__
 298 #undef MUST_UNDEF__STDC__
 299 #endif
 300
 301 /* Defines that we need that aren't in the standard signal.h.  */
 302 #define SIGHUP  1               /* Hang up */
 303 #define SIGQUIT 3               /* Quit process */
 304 #define SIGTRAP 5               /* Trace trap */
 305 #define SIGKILL 9               /* Die, die die */
 306 #define SIGPIPE 13              /* Write on pipe with no readers */
 307 #define SIGALRM 14              /* Alarm */
 308 #define SIGCHLD 18              /* Death of child */
 309
 310 #ifndef NSIG
 311 #define NSIG 23
 312 #endif
 313
 314 /* For integration with MSDOS support.  */
 315 #define getdisk()               (_getdrive () - 1)
 316 #ifdef emacs
 317 #define getdefdir(_drv, _buf)   ((_buf[0] = (_drv + 'A' - 1), _buf[1] = ':', _buf[2] = '/', _buf[3] = 0), 1)
 318 #else
 319 #define getdefdir(_drv, _buf)   _getdcwd (_drv, _buf, MAXPATHLEN)
 320 #endif
 321
 322 extern char *get_emacs_configuration (void);
 323 extern char *get_emacs_configuration_options (void);
 324 #define EMACS_CONFIGURATION     get_emacs_configuration ()
 325 #define EMACS_CONFIG_OPTIONS    get_emacs_configuration_options ()
 326
 327 /* Define this so that winsock.h definitions don't get included with
 328    windows.h.  For this to have proper effect, config.h must always be
 329    included before windows.h.  */
 330 #define _WINSOCKAPI_    1
 331 #define _WINSOCK_H
 332
 333 /* Prevent accidental use of features unavailable in
 334    older Windows versions we still support.  */
 335 #define _WIN32_WINNT 0x0400
 336
 337 /* Make a leaner executable.  */
 338 #define WIN32_LEAN_AND_MEAN 1
 339
 340 /* Defines size_t and alloca ().  */
 341 #ifdef emacs
 342 #define malloc e_malloc
 343 #define free   e_free
 344 #define realloc e_realloc
 345 #define calloc e_calloc
 346 #endif
 347 #ifdef _MSC_VER
 348 #define alloca _alloca
 349 #else
 350 #include <malloc.h>
 351 #endif
 352
 353 /* stdlib.h must be included after redefining malloc & friends, but
 354    before redefining abort.  Isn't library redefinition funny?  */
 355 #include <stdlib.h>
 356
 357 /* Redefine abort.  */
 358 #ifdef HAVE_NTGUI
 359 #define abort   w32_abort
 360 extern _Noreturn void w32_abort (void);
 361 #endif
 362
 363 #include <sys/stat.h>
 364
 365 /* Define for those source files that do not include enough NT system files.  */
 366 #ifndef NULL
 367 #ifdef __cplusplus
 368 #define NULL    0
 369 #else
 370 #define NULL    ((void *)0)
 371 #endif
 372 #endif
 373
 374 /* For proper declaration of environ.  */
 375 #ifndef sys_nerr
 376 #define sys_nerr _sys_nerr
 377 #endif
 378
 379 extern int getloadavg (double *, int);
 380
 381 #if defined (__MINGW32__) || _MSC_VER >= 1400
 382
 383 /* Define to 1 if the system has the type `long long int'. */
 384 # define HAVE_LONG_LONG_INT 1
 385
 386 /* Define to 1 if the system has the type `unsigned long long int'. */
 387 # define HAVE_UNSIGNED_LONG_LONG_INT 1
 388
 389 #elif _MSC_VER >= 1200
 390
 391 /* Temporarily disable wider-than-pointer integers until they're tested more.
 392    Build with CFLAGS='-DWIDE_EMACS_INT' to try them out.  */
 393
 394 # ifdef WIDE_EMACS_INT
 395
 396 /* Use pre-C99-style 64-bit integers.  */
 397 # define EMACS_INT __int64
 398 # define EMACS_INT_MAX _I64_MAX
 399 # define pI "I64"
 400
 401 # endif
 402
 403 #endif
 404
 405 /* We need a little extra space, see ../../lisp/loadup.el.  */
 406 #define SYSTEM_PURESIZE_EXTRA 50000
 407
 408 #define DATA_START      get_data_start ()
 409
 410 /* For unexec to work on Alpha systems, we need to put Emacs'
 411    initialized data into a separate section from the CRT initialized
 412    data (because the Alpha linker freely reorders data variables, even
 413    across libraries, so our data and the CRT data get intermingled).
 414
 415    Starting with MSVC 5.0, we must also place the uninitialized data
 416    into its own section.  VC5 intermingles uninitialized data from the CRT
 417    between Emacs' static uninitialized data and its public uninitialized
 418    data.  A separate .bss section for Emacs groups both static and
 419    public uninitialized together.
 420
 421    Note that unexw32.c relies on this fact, and must be modified
 422    accordingly if this section name is changed, or if this pragma is
 423    removed.  Also, obviously, all files that define initialized data
 424    must include config.h to pick up this pragma.  */
 425
 426 /* Names must be < 8 bytes.  */
 427 #ifdef _MSC_VER
 428 #pragma data_seg("EMDATA")
 429 #pragma bss_seg("EMBSS")
 430 #endif
 431
 432 /* #define FULL_DEBUG */
 433 /* #define EMACSDEBUG */
 434
 435 #ifdef EMACSDEBUG
 436 extern void _DebPrint (const char *fmt, ...);
 437 #define DebPrint(stuff) _DebPrint stuff
 438 #else
 439 #define DebPrint(stuff)
 440 #endif
 441
 442 /* ============================================================ */