nt/inc/ms-w32.h

   1 /* System description file for Windows NT.
   2
   3 Copyright (C) 1993-1995, 2001-2013 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
  27 /* #undef const */
  28
  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
  35
  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
  39
  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
  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 /* 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
  52
  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
  56
  57 #define MAIL_USE_SYSTEM_LOCK 1
  58
  59 /* Define to 1 if GCC-style __attribute__ ((__aligned__ (expr))) works. */
  60 #ifdef __GNUC__
  61 #define HAVE_ATTRIBUTE_ALIGNED 1
  62 #endif
  63
  64 /* Define to 1 if strtold conforms to C99. */
  65 #ifdef __GNUC__
  66 #define HAVE_C99_STRTOLD 1
  67 #endif
  68
  69 #if (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8))
  70 #define HAVE___BUILTIN_UNWIND_INIT 1
  71 #endif
  72
  73 /* This isn't perfect, as some systems might have the page file in
  74    another place.  Also, I suspect that the time stamp of that file
  75    might also change when Windows enlarges the file due to
  76    insufficient VM.  Still, this seems to be the most reliable way;
  77    the alternative (of using GetSystemTimes) won't work on laptops
  78    that hibernate, because the system clock is stopped then.  Other
  79    possibility would be to run "net statistics workstation" and parse
  80    the output, but that's gross.  So this should do; if the file is
  81    not there, the boot time will be returned as zero, and filelock.c
  82    already handles that.  */
  83 #define BOOT_TIME_FILE "C:/pagefile.sys"
  84
  85 /* ============================================================ */
  86
  87 /* Here, add any special hacks needed to make Emacs work on this
  88    system.  For example, you might define certain system call names
  89    that don't exist on your system, or that do different things on
  90    your system and must be used only through an encapsulation (which
  91    you should place, by convention, in sysdep.c).  */
  92
  93 #ifdef __GNUC__
  94 #ifndef __cplusplus
  95 #undef inline
  96 #endif
  97 #else  /* MSVC */
  98 #define inline __inline
  99 #endif
 100
 101 #ifdef __GNUC__
 102 # define restrict __restrict__
 103 #else
 104 # define restrict
 105 #endif
 106
 107 /* `mode_t' is not defined for MSVC. Define. */
 108 #ifdef _MSC_VER
 109 typedef unsigned short mode_t;
 110 #endif
 111
 112 /* A va_copy replacement for MSVC.  */
 113 #ifdef _MSC_VER
 114 # ifdef _WIN64
 115 #  ifndef va_copy               /* Need to be checked (?) */
 116 #   define va_copy(d,s) ((d) = (s))
 117 #  endif
 118 # else  /* not _WIN64 */
 119 #  define va_copy(d,s) ((d) = (s))
 120 # endif  /* not _WIN64 */
 121 #endif   /* _MSC_VER */
 122
 123 #ifndef WINDOWSNT
 124 /* Some of the files of Emacs which are intended for use with other
 125    programs assume that if you have a config.h file, you must declare
 126    the type of getenv.  */
 127 extern char *getenv ();
 128 #endif
 129
 130 /* Prevent accidental use of features unavailable in older Windows
 131    versions we still support.  MinGW64 defines this to a higher value
 132    in its system headers, and is not really compatible with values
 133    lower than 0x0500, so leave it alone.  */
 134 #ifndef _W64
 135 # define _WIN32_WINNT 0x0400
 136 #endif
 137
 138 /* Make a leaner executable.  */
 139 #define WIN32_LEAN_AND_MEAN 1
 140
 141 #ifdef HAVE_STRINGS_H
 142 #include "strings.h"
 143 #endif
 144 #include <sys/types.h>
 145
 146 #ifndef MAXPATHLEN
 147 #define MAXPATHLEN      _MAX_PATH
 148 #endif
 149
 150 #ifdef HAVE_NTGUI
 151 #define HAVE_WINDOW_SYSTEM 1
 152 #define HAVE_MENUS 1
 153 #endif
 154
 155 /* Get some redefinitions in place.  */
 156
 157 #ifdef emacs
 158
 159 #ifdef _W64
 160 /* MinGW64 specific stuff.  */
 161 /* Make sure 'struct timespec' and 'struct timezone' are defined.  */
 162 #include <sys/types.h>
 163 #include <time.h>
 164 #endif
 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 chdir
 179 #define chdir   sys_chdir
 180 #undef chmod
 181 #define chmod   sys_chmod
 182 #undef close
 183 #define close   sys_close
 184 #undef creat
 185 #define creat   sys_creat
 186 #define ctime   sys_ctime
 187 #undef dup
 188 #define dup     sys_dup
 189 #undef dup2
 190 #define dup2    sys_dup2
 191 #define fopen   sys_fopen
 192 #define link    sys_link
 193 #define localtime sys_localtime
 194 #define mkdir   sys_mkdir
 195 #undef mktemp
 196 #define mktemp  sys_mktemp
 197 #undef open
 198 #define open    sys_open
 199 #define pipe    sys_pipe
 200 #undef read
 201 #define read    sys_read
 202 #define rename  sys_rename
 203 #define rmdir   sys_rmdir
 204 #define select  sys_select
 205 #define pselect sys_select
 206 #define sleep   sys_sleep
 207 #define strerror sys_strerror
 208 #undef unlink
 209 #define unlink  sys_unlink
 210 /* This prototype is needed because some files include config.h
 211    _after_ the standard headers, so sys_unlink gets no prototype from
 212    stdio.h or io.h.  */
 213 extern int sys_unlink (const char *);
 214 #undef write
 215 #define write   sys_write
 216
 217 /* Subprocess calls that are emulated.  */
 218 #define spawnve sys_spawnve
 219 #define kill    sys_kill
 220 #define signal  sys_signal
 221
 222 /* Internal signals.  */
 223 #define emacs_raise(sig) emacs_abort()
 224
 225 /* termcap.c calls that are emulated.  */
 226 #define tputs   sys_tputs
 227 #define tgetstr sys_tgetstr
 228
 229 /* cm.c calls that are emulated.  */
 230 #define chcheckmagic sys_chcheckmagic
 231 #define cmcostinit   sys_cmcostinit
 232 #define cmgoto       sys_cmgoto
 233 #define cmputc       sys_cmputc
 234 #define Wcm_clear    sys_Wcm_clear
 235
 236 #endif /* emacs */
 237
 238 /* Map to MSVC names.  */
 239 #define execlp    _execlp
 240 #define execvp    _execvp
 241 #define fdatasync _commit
 242 #define fdopen    _fdopen
 243 #ifndef fileno
 244 #define fileno    _fileno
 245 #endif
 246 #define fsync     _commit
 247 #define ftruncate _chsize
 248 #define getpid    _getpid
 249 #ifdef _MSC_VER
 250 typedef int pid_t;
 251 #define snprintf  _snprintf
 252 #define strtoll   _strtoi64
 253 #endif
 254 #define isatty    _isatty
 255 #define _longjmp  longjmp
 256 #define lseek     _lseek
 257 #define popen     _popen
 258 #define pclose    _pclose
 259 #define umask     _umask
 260 #ifndef _MSC_VER
 261 #define utimbuf   _utimbuf
 262 #endif
 263 #define strdup    _strdup
 264 #define strupr    _strupr
 265 #define strnicmp  _strnicmp
 266 #define stricmp   _stricmp
 267 #define tzset     _tzset
 268
 269 /* We cannot include system header process.h, since there's src/process.h.  */
 270 int _getpid (void);
 271
 272 /* Include time.h before redirecting tzname, since MSVC's time.h
 273    defines _tzname to call a function, but also declares tzname a
 274    2-element array.  Having the redirection before including the
 275    header thus has the effect of declaring a function that returns an
 276    array, and triggers an error message.  */
 277 #include <time.h>
 278 #define tzname    _tzname
 279 #if !defined (_MSC_VER) || (_MSC_VER < 1400)
 280 #undef  utime
 281 #define utime     _utime
 282 #endif
 283
 284 /* 'struct timespec' is used by time-related functions in lib/ and
 285    elsewhere, but we don't use lib/time.h where the structure is
 286    defined.  */
 287 /* MinGW64 defines 'struct timespec' and _TIMESPEC_DEFINED in sys/types.h.  */
 288 #ifndef _TIMESPEC_DEFINED
 289 struct timespec
 290 {
 291   time_t        tv_sec;         /* seconds */
 292   long int      tv_nsec;        /* nanoseconds */
 293 };
 294 #endif
 295
 296 /* Required for functions in lib/time_r.c, since we don't use lib/time.h.  */
 297 extern struct tm *gmtime_r (time_t const * restrict, struct tm * restrict);
 298 extern struct tm *localtime_r (time_t const * restrict, struct tm * restrict);
 299
 300 #ifdef _MSC_VER
 301 /* This is hacky, but is necessary to avoid warnings about macro
 302    redefinitions using the MSVC compilers, since, when __STDC__ is
 303    undefined or zero, those compilers declare functions like fileno,
 304    lseek, and chdir, for which we defined macros above.  */
 305 #ifndef __STDC__
 306 #define __STDC__ 1
 307 #define MUST_UNDEF__STDC__
 308 #endif
 309 #include <direct.h>
 310 #include <io.h>
 311 #include <stdio.h>
 312 #ifdef MUST_UNDEF__STDC__
 313 #undef __STDC__
 314 #undef MUST_UNDEF__STDC__
 315 #endif
 316 #else  /* !_MSC_VER */
 317 #include <direct.h>
 318 #include <io.h>
 319 #include <stdio.h>
 320 #endif  /* !_MSC_VER */
 321
 322 /* Defines that we need that aren't in the standard signal.h.  */
 323 #define SIGHUP  1               /* Hang up */
 324 #define SIGQUIT 3               /* Quit process */
 325 #define SIGTRAP 5               /* Trace trap */
 326 #define SIGKILL 9               /* Die, die die */
 327 #define SIGPIPE 13              /* Write on pipe with no readers */
 328 #define SIGALRM 14              /* Alarm */
 329 #define SIGCHLD 18              /* Death of child */
 330 #define SIGPROF 19              /* Profiling */
 331
 332 #ifndef NSIG
 333 #define NSIG 23
 334 #endif
 335
 336 #ifndef ENOTSUP
 337 #define ENOTSUP ENOSYS
 338 #endif
 339
 340 #ifdef _MSC_VER
 341 typedef int sigset_t;
 342 typedef int ssize_t;
 343 #endif
 344
 345 #ifndef _POSIX  /* MinGW64 */
 346 typedef _sigset_t sigset_t;
 347 #endif
 348
 349 typedef void (_CALLBACK_ *signal_handler) (int);
 350 extern signal_handler sys_signal (int, signal_handler);
 351
 352 struct sigaction {
 353   int sa_flags;
 354   void (_CALLBACK_ *sa_handler)(int);
 355   sigset_t sa_mask;
 356 };
 357 #define SA_RESTART      0
 358 #define SIG_BLOCK       1
 359 #define SIG_SETMASK     2
 360 #define SIG_UNBLOCK     3
 361
 362 extern int sigemptyset (sigset_t *);
 363 extern int sigaddset (sigset_t *, int);
 364 extern int sigfillset (sigset_t *);
 365 extern int sigprocmask (int, const sigset_t *, sigset_t *);
 366 extern int pthread_sigmask (int, const sigset_t *, sigset_t *);
 367 extern int sigismember (const sigset_t *, int);
 368 extern int setpgrp (int, int);
 369 extern int sigaction (int, const struct sigaction *, struct sigaction *);
 370 extern int alarm (int);
 371
 372 extern int sys_kill (int, int);
 373
 374
 375 /* For integration with MSDOS support.  */
 376 #define getdisk()               (_getdrive () - 1)
 377 #ifdef emacs
 378 #define getdefdir(_drv, _buf)   ((_buf[0] = (_drv + 'A' - 1), _buf[1] = ':', _buf[2] = '/', _buf[3] = 0), 1)
 379 #else
 380 #define getdefdir(_drv, _buf)   _getdcwd (_drv, _buf, MAXPATHLEN)
 381 #endif
 382
 383 extern char *get_emacs_configuration (void);
 384 extern char *get_emacs_configuration_options (void);
 385 #define EMACS_CONFIGURATION     get_emacs_configuration ()
 386 #define EMACS_CONFIG_OPTIONS    get_emacs_configuration_options ()
 387
 388 /* Define this so that winsock.h definitions don't get included with
 389    windows.h.  For this to have proper effect, config.h must always be
 390    included before windows.h.  */
 391 #define _WINSOCKAPI_    1
 392 #define _WINSOCK_H
 393
 394 /* Defines size_t and alloca ().  */
 395 #ifdef emacs
 396 #define malloc e_malloc
 397 #define free   e_free
 398 #define realloc e_realloc
 399 #define calloc e_calloc
 400 #endif
 401 #ifdef _MSC_VER
 402 #define alloca _alloca
 403 #else
 404 #include <malloc.h>
 405 #endif
 406
 407 #include <stdlib.h>
 408 #include <sys/stat.h>
 409
 410 /* Define for those source files that do not include enough NT system files.  */
 411 #ifndef NULL
 412 #ifdef __cplusplus
 413 #define NULL    0
 414 #else
 415 #define NULL    ((void *)0)
 416 #endif
 417 #endif
 418
 419 /* For proper declaration of environ.  */
 420 #ifndef sys_nerr
 421 #define sys_nerr _sys_nerr
 422 #endif
 423
 424 /* This must be after including stdlib.h, which defines putenv on MinGW.  */
 425 #ifdef putenv
 426 # undef putenv
 427 #endif
 428 #define putenv    sys_putenv
 429 extern int sys_putenv (char *);
 430
 431 extern int getloadavg (double *, int);
 432 extern int getpagesize (void);
 433
 434 extern void * memrchr (void const *, int, size_t);
 435
 436
 437 #if defined (__MINGW32__)
 438
 439 /* Define to 1 if the system has the type `long long int'. */
 440 # define HAVE_LONG_LONG_INT 1
 441
 442 /* Define to 1 if the system has the type `unsigned long long int'. */
 443 # define HAVE_UNSIGNED_LONG_LONG_INT 1
 444
 445 #endif
 446
 447 #ifdef _MSC_VER
 448 # if defined(_WIN64)
 449 typedef __int64 EMACS_INT;
 450 typedef unsigned __int64 EMACS_UINT;
 451 #  define EMACS_INT_MAX           LLONG_MAX
 452 #  define PRIuMAX                 "llu"
 453 #  define pI                      "ll"
 454 /* Fix a bug in MSVC headers : stdint.h */
 455 #  define _INTPTR 2
 456 # elif defined(_WIN32)
 457 /* Temporarily disable wider-than-pointer integers until they're tested more.
 458    Build with CFLAGS='-DWIDE_EMACS_INT' to try them out.  */
 459
 460 #  ifdef WIDE_EMACS_INT
 461
 462 /* Use pre-C99-style 64-bit integers.  */
 463 typedef __int64 EMACS_INT;
 464 typedef unsigned __int64 EMACS_UINT;
 465 #   define EMACS_INT_MAX           LLONG_MAX
 466 #   define PRIuMAX                 "llu"
 467 #   define pI                     "I64"
 468 #  else
 469 typedef int EMACS_INT;
 470 typedef unsigned int EMACS_UINT;
 471 #   define EMACS_INT_MAX           LONG_MAX
 472 #   define PRIuMAX                 "lu"
 473 #   define pI                     "l"
 474 #  endif
 475 # endif
 476 #endif
 477
 478 /* We need a little extra space, see ../../lisp/loadup.el.  */
 479 #define SYSTEM_PURESIZE_EXTRA 50000
 480
 481 #define DATA_START      get_data_start ()
 482
 483 /* For unexec to work on Alpha systems, we need to put Emacs'
 484    initialized data into a separate section from the CRT initialized
 485    data (because the Alpha linker freely reorders data variables, even
 486    across libraries, so our data and the CRT data get intermingled).
 487
 488    Starting with MSVC 5.0, we must also place the uninitialized data
 489    into its own section.  VC5 intermingles uninitialized data from the CRT
 490    between Emacs' static uninitialized data and its public uninitialized
 491    data.  A separate .bss section for Emacs groups both static and
 492    public uninitialized together.
 493
 494    Note that unexw32.c relies on this fact, and must be modified
 495    accordingly if this section name is changed, or if this pragma is
 496    removed.  Also, obviously, all files that define initialized data
 497    must include config.h to pick up this pragma.  */
 498
 499 /* Names must be < 8 bytes.  */
 500 #ifdef _MSC_VER
 501 #pragma data_seg("EMDATA")
 502 #pragma bss_seg("EMBSS")
 503 #endif
 504
 505 /* #define FULL_DEBUG */
 506 /* #define EMACSDEBUG */
 507
 508 #ifdef EMACSDEBUG
 509 extern void _DebPrint (const char *fmt, ...);
 510 #define DebPrint(stuff) _DebPrint stuff
 511 #else
 512 #define DebPrint(stuff)
 513 #endif
 514
 515 #ifdef _MSC_VER
 516 #if _MSC_VER >= 800 && !defined(__cplusplus)
 517 /* Unnamed type definition in parentheses.
 518    A structure, union, or enumerated type with no name is defined in a
 519    parenthetical expression.  The type definition is meaningless.  */
 520 #pragma warning(disable:4116)
 521 /* 'argument' : conversion from 'type1' to 'type2', possible loss of
 522    data A floating point type was converted to an integer type.  A
 523    possible loss of data may have occurred.  */
 524 #pragma warning(disable:4244)
 525 /* Negative integral constant converted to unsigned type.
 526    An expression converts a negative integer constant to an unsigned type.
 527    The result of the expression is probably meaningless.  */
 528 #pragma warning(disable:4308)
 529 #endif
 530 #endif
 531 #define TERM_HEADER "w32term.h"
 532
 533
 534 /* ============================================================ */