nt/inc/ms-w32.h

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