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