code.delx.au - gnu-emacs/blob - 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 #undef opendir
 228 #define opendir sys_opendir
 229 #undef closedir
 230 #define closedir sys_closedir
 231 #undef readdir
 232 #define readdir sys_readdir
 233 #undef seekdir
 234 #define seekdir sys_seekdir
 235 /* This prototype is needed because some files include config.h
 236    _after_ the standard headers, so sys_unlink gets no prototype from
 237    stdio.h or io.h.  */
 238 extern int sys_unlink (const char *);
 239 #undef write
 240 #define write   sys_write
 241
 242 /* Subprocess calls that are emulated.  */
 243 #define spawnve sys_spawnve
 244 #define kill    sys_kill
 245 #define signal  sys_signal
 246
 247 /* Internal signals.  */
 248 #define emacs_raise(sig) emacs_abort()
 249
 250 /* termcap.c calls that are emulated.  */
 251 #define tputs   sys_tputs
 252 #define tgetstr sys_tgetstr
 253
 254 /* cm.c calls that are emulated.  */
 255 #define chcheckmagic sys_chcheckmagic
 256 #define cmcostinit   sys_cmcostinit
 257 #define cmgoto       sys_cmgoto
 258 #define cmputc       sys_cmputc
 259 #define Wcm_clear    sys_Wcm_clear
 260
 261 #endif /* emacs */
 262
 263 /* Map to MSVC names.  */
 264 #define execlp    _execlp
 265 #define execvp    _execvp
 266 #define fdatasync _commit
 267 #define fdopen    _fdopen
 268 #define fsync     _commit
 269 #define ftruncate _chsize
 270 #define getpid    _getpid
 271 #ifdef _MSC_VER
 272 typedef int pid_t;
 273 #define snprintf  _snprintf
 274 #define strtoll   _strtoi64
 275 #define copysign  _copysign
 276 #endif
 277 #define isatty    _isatty
 278 #define _longjmp  longjmp
 279 #define lseek     _lseek
 280 #define popen     _popen
 281 #define pclose    _pclose
 282 #define umask     _umask
 283 #define strdup    _strdup
 284 #define strupr    _strupr
 285 #define strnicmp  _strnicmp
 286 #define stricmp   _stricmp
 287 #define tzset     _tzset
 288
 289 /* We cannot include system header process.h, since there's src/process.h.  */
 290 int _getpid (void);
 291
 292 /* Include time.h before redirecting tzname, since MSVC's time.h
 293    defines _tzname to call a function, but also declares tzname a
 294    2-element array.  Having the redirection before including the
 295    header thus has the effect of declaring a function that returns an
 296    array, and triggers an error message.  */
 297 #include <time.h>
 298 #define tzname    _tzname
 299
 300 /* 'struct timespec' is used by time-related functions in lib/ and
 301    elsewhere, but we don't use lib/time.h where the structure is
 302    defined.  */
 303 /* MinGW64 defines 'struct timespec' and _TIMESPEC_DEFINED in sys/types.h.  */
 304 #ifndef _TIMESPEC_DEFINED
 305 struct timespec
 306 {
 307   time_t        tv_sec;         /* seconds */
 308   long int      tv_nsec;        /* nanoseconds */
 309 };
 310 #endif
 311
 312 /* Required for functions in lib/time_r.c, since we don't use lib/time.h.  */
 313 extern struct tm *gmtime_r (time_t const * restrict, struct tm * restrict);
 314 extern struct tm *localtime_r (time_t const * restrict, struct tm * restrict);
 315
 316 #ifdef _MSC_VER
 317 /* This is hacky, but is necessary to avoid warnings about macro
 318    redefinitions using the MSVC compilers, since, when __STDC__ is
 319    undefined or zero, those compilers declare functions like fileno,
 320    lseek, and chdir, for which we defined macros above.  */
 321 #ifndef __STDC__
 322 #define __STDC__ 1
 323 #define MUST_UNDEF__STDC__
 324 #endif
 325 #include <direct.h>
 326 #include <io.h>
 327 #include <stdio.h>
 328 #ifdef MUST_UNDEF__STDC__
 329 #undef __STDC__
 330 #undef MUST_UNDEF__STDC__
 331 #endif
 332 #else  /* !_MSC_VER */
 333 #include <direct.h>
 334 #include <io.h>
 335 #include <stdio.h>
 336 #endif  /* !_MSC_VER */
 337 #ifndef fileno
 338 #define fileno    _fileno
 339 #endif
 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 /* In case lib/errno.h is not used.  */
 360 #ifndef EOPNOTSUPP
 361 #define EOPNOTSUPP 130
 362 #endif
 363
 364 #ifdef _MSC_VER
 365 typedef int sigset_t;
 366 typedef int ssize_t;
 367 #endif
 368
 369 #ifdef _W64     /* MinGW64 */
 370 #ifndef _POSIX
 371 typedef _sigset_t sigset_t;
 372 #endif
 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 extern int mkostemp (char *, int);
 465
 466
 467 #if defined (__MINGW32__)
 468
 469 /* Define to 1 if the system has the type `long long int'. */
 470 # ifndef HAVE_LONG_LONG_INT
 471 #  define HAVE_LONG_LONG_INT 1
 472 # endif
 473
 474 /* Define to 1 if the system has the type `unsigned long long int'. */
 475 # ifndef HAVE_UNSIGNED_LONG_LONG_INT
 476 #  define HAVE_UNSIGNED_LONG_LONG_INT 1
 477 # endif
 478
 479 #endif
 480
 481 #ifdef _MSC_VER
 482 # if defined(_WIN64)
 483 typedef __int64 EMACS_INT;
 484 typedef unsigned __int64 EMACS_UINT;
 485 #  define EMACS_INT_MAX           LLONG_MAX
 486 #  define PRIuMAX                 "llu"
 487 #  define pI                      "ll"
 488 /* Fix a bug in MSVC headers : stdint.h */
 489 #  define _INTPTR 2
 490 # elif defined(_WIN32)
 491 /* Temporarily disable wider-than-pointer integers until they're tested more.
 492    Build with CFLAGS='-DWIDE_EMACS_INT' to try them out.  */
 493
 494 #  ifdef WIDE_EMACS_INT
 495
 496 /* Use pre-C99-style 64-bit integers.  */
 497 typedef __int64 EMACS_INT;
 498 typedef unsigned __int64 EMACS_UINT;
 499 #   define EMACS_INT_MAX           LLONG_MAX
 500 #   define PRIuMAX                 "llu"
 501 #   define pI                     "I64"
 502 #  else
 503 typedef int EMACS_INT;
 504 typedef unsigned int EMACS_UINT;
 505 #   define EMACS_INT_MAX           LONG_MAX
 506 #   define PRIuMAX                 "lu"
 507 #   define pI                     "l"
 508 #  endif
 509 # endif
 510 #endif
 511
 512 /* We need a little extra space, see ../../lisp/loadup.el.  */
 513 #define SYSTEM_PURESIZE_EXTRA 50000
 514
 515 #define DATA_START      get_data_start ()
 516
 517 /* For unexec to work on Alpha systems, we need to put Emacs'
 518    initialized data into a separate section from the CRT initialized
 519    data (because the Alpha linker freely reorders data variables, even
 520    across libraries, so our data and the CRT data get intermingled).
 521
 522    Starting with MSVC 5.0, we must also place the uninitialized data
 523    into its own section.  VC5 intermingles uninitialized data from the CRT
 524    between Emacs' static uninitialized data and its public uninitialized
 525    data.  A separate .bss section for Emacs groups both static and
 526    public uninitialized together.
 527
 528    Note that unexw32.c relies on this fact, and must be modified
 529    accordingly if this section name is changed, or if this pragma is
 530    removed.  Also, obviously, all files that define initialized data
 531    must include config.h to pick up this pragma.  */
 532
 533 /* Names must be < 8 bytes.  */
 534 #ifdef _MSC_VER
 535 #pragma data_seg("EMDATA")
 536 #pragma bss_seg("EMBSS")
 537 #endif
 538
 539 /* #define FULL_DEBUG */
 540 /* #define EMACSDEBUG */
 541
 542 #ifdef EMACSDEBUG
 543 extern void _DebPrint (const char *fmt, ...);
 544 #define DebPrint(stuff) _DebPrint stuff
 545 #else
 546 #define DebPrint(stuff)
 547 #endif
 548
 549 #ifdef _MSC_VER
 550 #if _MSC_VER >= 800 && !defined(__cplusplus)
 551 /* Unnamed type definition in parentheses.
 552    A structure, union, or enumerated type with no name is defined in a
 553    parenthetical expression.  The type definition is meaningless.  */
 554 #pragma warning(disable:4116)
 555 /* 'argument' : conversion from 'type1' to 'type2', possible loss of
 556    data A floating point type was converted to an integer type.  A
 557    possible loss of data may have occurred.  */
 558 #pragma warning(disable:4244)
 559 /* Negative integral constant converted to unsigned type.
 560    An expression converts a negative integer constant to an unsigned type.
 561    The result of the expression is probably meaningless.  */
 562 #pragma warning(disable:4308)
 563 #endif
 564 #endif
 565
 566
 567 /* ============================================================ */