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