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 #ifdef __MINGW32__
 137 /* A kludge to avoid including header files in lib/.  They cannot be
 138    configured-out, and their stuff interferes with what we have
 139    defined in this header and in other headers in nt/inc.  Yuck!  */
 140 #define __need_system_fcntl_h
 141 #define _GL_FCNTL_H
 142 #define _GL_JUST_INCLUDE_SYSTEM_INTTYPES_H
 143 #define _GL_ALREADY_INCLUDING_SIGNAL_H
 144 #define _GL_ALREADY_INCLUDING_STDIO_H
 145 #define __need_system_stdlib_h
 146 #define _GL_TIME_H
 147 #define __need_system_sys_stat_h
 148 #endif
 149
 150 /* Prevent accidental use of features unavailable in older Windows
 151    versions we still support.  MinGW64 defines this to a higher value
 152    in its system headers, and is not really compatible with values
 153    lower than 0x0500, so leave it alone.  */
 154 #ifndef _W64
 155 # define _WIN32_WINNT 0x0400
 156 #endif
 157
 158 /* Make a leaner executable.  */
 159 #define WIN32_LEAN_AND_MEAN 1
 160
 161 #ifdef HAVE_STRINGS_H
 162 #include "strings.h"
 163 #endif
 164 #include <sys/types.h>
 165
 166 #ifndef MAXPATHLEN
 167 #define MAXPATHLEN      _MAX_PATH
 168 #endif
 169
 170 #ifdef HAVE_NTGUI
 171 # ifndef HAVE_WINDOW_SYSTEM
 172 #  define HAVE_WINDOW_SYSTEM 1
 173 # endif
 174 # ifndef HAVE_MENUS
 175 #  define HAVE_MENUS 1
 176 # endif
 177 #endif
 178
 179 /* Get some redefinitions in place.  */
 180
 181 #ifdef emacs
 182
 183 #ifdef _W64
 184 /* MinGW64 specific stuff.  */
 185 /* Make sure 'struct timespec' and 'struct timezone' are defined.  */
 186 #include <sys/types.h>
 187 #include <time.h>
 188 /* This prototype avoids MinGW64 compiler warnings due to the fact
 189    that time.h is included before localtime is redirected to
 190    sys_localtime below.  */
 191 extern struct tm * sys_localtime (const time_t *);
 192 /* MinGW64 uses a 2-argument _setjmp, and setjmp is a macro defined to
 193    supply the 2nd arg correctly, so don't use _setjmp directly in that
 194    case. */
 195 #undef HAVE__SETJMP
 196 #endif
 197
 198 #ifdef _MSC_VER
 199 #include <sys/timeb.h>
 200 #include <sys/stat.h>
 201 #include <signal.h>
 202
 203 /* MSVC gets link-time errors without these redirections.  */
 204 #define fstat(a, b) sys_fstat(a, b)
 205 #define stat(a, b)  sys_stat(a, b)
 206 #define utime       sys_utime
 207 #endif
 208
 209 /* Calls that are emulated or shadowed.  */
 210 #undef chdir
 211 #define chdir   sys_chdir
 212 #undef chmod
 213 #define chmod   sys_chmod
 214 #undef close
 215 #define close   sys_close
 216 #undef creat
 217 #define creat   sys_creat
 218 #define ctime   sys_ctime
 219 #undef dup
 220 #define dup     sys_dup
 221 #undef dup2
 222 #define dup2    sys_dup2
 223 #define fopen   sys_fopen
 224 #define link    sys_link
 225 #define localtime sys_localtime
 226 #define mkdir   sys_mkdir
 227 #undef mktemp
 228 #define mktemp  sys_mktemp
 229 #undef open
 230 #define open    sys_open
 231 #define pipe    sys_pipe
 232 #undef read
 233 #define read    sys_read
 234 #define rename  sys_rename
 235 #define rmdir   sys_rmdir
 236 #define select  sys_select
 237 #define pselect sys_select
 238 #define sleep   sys_sleep
 239 #define strerror sys_strerror
 240 #undef unlink
 241 #define unlink  sys_unlink
 242 /* This prototype is needed because some files include config.h
 243    _after_ the standard headers, so sys_unlink gets no prototype from
 244    stdio.h or io.h.  */
 245 extern int sys_unlink (const char *);
 246 #undef write
 247 #define write   sys_write
 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 #ifndef fileno
 276 #define fileno    _fileno
 277 #endif
 278 #define fsync     _commit
 279 #define ftruncate _chsize
 280 #define getpid    _getpid
 281 #ifdef _MSC_VER
 282 typedef int pid_t;
 283 #define snprintf  _snprintf
 284 #define strtoll   _strtoi64
 285 #define copysign  _copysign
 286 #endif
 287 #define isatty    _isatty
 288 #define _longjmp  longjmp
 289 #define lseek     _lseek
 290 #define popen     _popen
 291 #define pclose    _pclose
 292 #define umask     _umask
 293 #define strdup    _strdup
 294 #define strupr    _strupr
 295 #define strnicmp  _strnicmp
 296 #define stricmp   _stricmp
 297 #define tzset     _tzset
 298
 299 /* We cannot include system header process.h, since there's src/process.h.  */
 300 int _getpid (void);
 301
 302 /* Include time.h before redirecting tzname, since MSVC's time.h
 303    defines _tzname to call a function, but also declares tzname a
 304    2-element array.  Having the redirection before including the
 305    header thus has the effect of declaring a function that returns an
 306    array, and triggers an error message.  */
 307 #include <time.h>
 308 #define tzname    _tzname
 309
 310 /* 'struct timespec' is used by time-related functions in lib/ and
 311    elsewhere, but we don't use lib/time.h where the structure is
 312    defined.  */
 313 /* MinGW64 defines 'struct timespec' and _TIMESPEC_DEFINED in sys/types.h.  */
 314 #ifndef _TIMESPEC_DEFINED
 315 struct timespec
 316 {
 317   time_t        tv_sec;         /* seconds */
 318   long int      tv_nsec;        /* nanoseconds */
 319 };
 320 #endif
 321
 322 /* Required for functions in lib/time_r.c, since we don't use lib/time.h.  */
 323 extern struct tm *gmtime_r (time_t const * restrict, struct tm * restrict);
 324 extern struct tm *localtime_r (time_t const * restrict, struct tm * restrict);
 325
 326 #ifdef _MSC_VER
 327 /* This is hacky, but is necessary to avoid warnings about macro
 328    redefinitions using the MSVC compilers, since, when __STDC__ is
 329    undefined or zero, those compilers declare functions like fileno,
 330    lseek, and chdir, for which we defined macros above.  */
 331 #ifndef __STDC__
 332 #define __STDC__ 1
 333 #define MUST_UNDEF__STDC__
 334 #endif
 335 #include <direct.h>
 336 #include <io.h>
 337 #include <stdio.h>
 338 #ifdef MUST_UNDEF__STDC__
 339 #undef __STDC__
 340 #undef MUST_UNDEF__STDC__
 341 #endif
 342 #else  /* !_MSC_VER */
 343 #include <direct.h>
 344 #include <io.h>
 345 #include <stdio.h>
 346 #endif  /* !_MSC_VER */
 347
 348 /* Defines that we need that aren't in the standard signal.h.  */
 349 #define SIGHUP  1               /* Hang up */
 350 #define SIGQUIT 3               /* Quit process */
 351 #define SIGTRAP 5               /* Trace trap */
 352 #define SIGKILL 9               /* Die, die die */
 353 #define SIGPIPE 13              /* Write on pipe with no readers */
 354 #define SIGALRM 14              /* Alarm */
 355 #define SIGCHLD 18              /* Death of child */
 356 #define SIGPROF 19              /* Profiling */
 357
 358 #ifndef NSIG
 359 #define NSIG 23
 360 #endif
 361
 362 #ifndef ENOTSUP
 363 #define ENOTSUP ENOSYS
 364 #endif
 365
 366 #ifdef _MSC_VER
 367 typedef int sigset_t;
 368 typedef int ssize_t;
 369 #endif
 370
 371 #ifndef _POSIX  /* MinGW64 */
 372 typedef _sigset_t sigset_t;
 373 #endif
 374
 375 typedef void (_CALLBACK_ *signal_handler) (int);
 376 extern signal_handler sys_signal (int, signal_handler);
 377
 378 struct sigaction {
 379   int sa_flags;
 380   void (_CALLBACK_ *sa_handler)(int);
 381   sigset_t sa_mask;
 382 };
 383 #define SA_RESTART      0
 384 #define SIG_BLOCK       1
 385 #define SIG_SETMASK     2
 386 #define SIG_UNBLOCK     3
 387
 388 extern int sigemptyset (sigset_t *);
 389 extern int sigaddset (sigset_t *, int);
 390 extern int sigfillset (sigset_t *);
 391 extern int sigprocmask (int, const sigset_t *, sigset_t *);
 392 extern int pthread_sigmask (int, const sigset_t *, sigset_t *);
 393 extern int sigismember (const sigset_t *, int);
 394 extern int setpgrp (int, int);
 395 extern int sigaction (int, const struct sigaction *, struct sigaction *);
 396 extern int alarm (int);
 397
 398 extern int sys_kill (int, int);
 399
 400
 401 /* For integration with MSDOS support.  */
 402 #define getdisk()               (_getdrive () - 1)
 403 #ifdef emacs
 404 #define getdefdir(_drv, _buf)   ((_buf[0] = (_drv + 'A' - 1), _buf[1] = ':', _buf[2] = '/', _buf[3] = 0), 1)
 405 #else
 406 #define getdefdir(_drv, _buf)   _getdcwd (_drv, _buf, MAXPATHLEN)
 407 #endif
 408
 409 #ifndef EMACS_CONFIGURATION
 410 extern char *get_emacs_configuration (void);
 411 extern char *get_emacs_configuration_options (void);
 412 #define EMACS_CONFIGURATION     get_emacs_configuration ()
 413 #define EMACS_CONFIG_OPTIONS    get_emacs_configuration_options ()
 414 #endif
 415
 416 /* Define this so that winsock.h definitions don't get included with
 417    windows.h.  For this to have proper effect, config.h must always be
 418    included before windows.h.  */
 419 #define _WINSOCKAPI_    1
 420 #define _WINSOCK_H
 421
 422 /* Defines size_t and alloca ().  */
 423 #ifdef emacs
 424 #define malloc e_malloc
 425 #define free   e_free
 426 #define realloc e_realloc
 427 #define calloc e_calloc
 428 #endif
 429 #ifdef _MSC_VER
 430 #define alloca _alloca
 431 #else
 432 #include <malloc.h>
 433 #endif
 434
 435 #include <stdlib.h>
 436 #include <sys/stat.h>
 437
 438 /* Define for those source files that do not include enough NT system files.  */
 439 #ifndef NULL
 440 #ifdef __cplusplus
 441 #define NULL    0
 442 #else
 443 #define NULL    ((void *)0)
 444 #endif
 445 #endif
 446
 447 /* For proper declaration of environ.  */
 448 #ifndef sys_nerr
 449 #define sys_nerr _sys_nerr
 450 #endif
 451
 452 /* This must be after including stdlib.h, which defines putenv on MinGW.  */
 453 #ifdef putenv
 454 # undef putenv
 455 #endif
 456 #define putenv    sys_putenv
 457 extern int sys_putenv (char *);
 458
 459 extern int getloadavg (double *, int);
 460 extern int getpagesize (void);
 461
 462 extern void * memrchr (void const *, int, size_t);
 463
 464
 465 #if defined (__MINGW32__)
 466
 467 /* Define to 1 if the system has the type `long long int'. */
 468 # ifndef HAVE_LONG_LONG_INT
 469 #  define HAVE_LONG_LONG_INT 1
 470 # endif
 471
 472 /* Define to 1 if the system has the type `unsigned long long int'. */
 473 # ifndef HAVE_UNSIGNED_LONG_LONG_INT
 474 #  define HAVE_UNSIGNED_LONG_LONG_INT 1
 475 # endif
 476
 477 #endif
 478
 479 #ifdef _MSC_VER
 480 # if defined(_WIN64)
 481 typedef __int64 EMACS_INT;
 482 typedef unsigned __int64 EMACS_UINT;
 483 #  define EMACS_INT_MAX           LLONG_MAX
 484 #  define PRIuMAX                 "llu"
 485 #  define pI                      "ll"
 486 /* Fix a bug in MSVC headers : stdint.h */
 487 #  define _INTPTR 2
 488 # elif defined(_WIN32)
 489 /* Temporarily disable wider-than-pointer integers until they're tested more.
 490    Build with CFLAGS='-DWIDE_EMACS_INT' to try them out.  */
 491
 492 #  ifdef WIDE_EMACS_INT
 493
 494 /* Use pre-C99-style 64-bit integers.  */
 495 typedef __int64 EMACS_INT;
 496 typedef unsigned __int64 EMACS_UINT;
 497 #   define EMACS_INT_MAX           LLONG_MAX
 498 #   define PRIuMAX                 "llu"
 499 #   define pI                     "I64"
 500 #  else
 501 typedef int EMACS_INT;
 502 typedef unsigned int EMACS_UINT;
 503 #   define EMACS_INT_MAX           LONG_MAX
 504 #   define PRIuMAX                 "lu"
 505 #   define pI                     "l"
 506 #  endif
 507 # endif
 508 #endif
 509
 510 /* We need a little extra space, see ../../lisp/loadup.el.  */
 511 #define SYSTEM_PURESIZE_EXTRA 50000
 512
 513 #define DATA_START      get_data_start ()
 514
 515 /* For unexec to work on Alpha systems, we need to put Emacs'
 516    initialized data into a separate section from the CRT initialized
 517    data (because the Alpha linker freely reorders data variables, even
 518    across libraries, so our data and the CRT data get intermingled).
 519
 520    Starting with MSVC 5.0, we must also place the uninitialized data
 521    into its own section.  VC5 intermingles uninitialized data from the CRT
 522    between Emacs' static uninitialized data and its public uninitialized
 523    data.  A separate .bss section for Emacs groups both static and
 524    public uninitialized together.
 525
 526    Note that unexw32.c relies on this fact, and must be modified
 527    accordingly if this section name is changed, or if this pragma is
 528    removed.  Also, obviously, all files that define initialized data
 529    must include config.h to pick up this pragma.  */
 530
 531 /* Names must be < 8 bytes.  */
 532 #ifdef _MSC_VER
 533 #pragma data_seg("EMDATA")
 534 #pragma bss_seg("EMBSS")
 535 #endif
 536
 537 /* #define FULL_DEBUG */
 538 /* #define EMACSDEBUG */
 539
 540 #ifdef EMACSDEBUG
 541 extern void _DebPrint (const char *fmt, ...);
 542 #define DebPrint(stuff) _DebPrint stuff
 543 #else
 544 #define DebPrint(stuff)
 545 #endif
 546
 547 #ifdef _MSC_VER
 548 #if _MSC_VER >= 800 && !defined(__cplusplus)
 549 /* Unnamed type definition in parentheses.
 550    A structure, union, or enumerated type with no name is defined in a
 551    parenthetical expression.  The type definition is meaningless.  */
 552 #pragma warning(disable:4116)
 553 /* 'argument' : conversion from 'type1' to 'type2', possible loss of
 554    data A floating point type was converted to an integer type.  A
 555    possible loss of data may have occurred.  */
 556 #pragma warning(disable:4244)
 557 /* Negative integral constant converted to unsigned type.
 558    An expression converts a negative integer constant to an unsigned type.
 559    The result of the expression is probably meaningless.  */
 560 #pragma warning(disable:4308)
 561 #endif
 562 #endif
 563
 564
 565 /* ============================================================ */