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