nt/inc/ms-w32.h

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