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