src/s/ms-w32.h

   1 /* System description file for Windows NT.
   2
   3 Copyright (C) 1993-1995, 2001-2012  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 #ifndef DOS_NT
  27 #define DOS_NT  /* MSDOS or WINDOWSNT */
  28 #endif
  29
  30 /* #undef const */
  31
  32 /* If you are compiling with a non-C calling convention but need to
  33    declare vararg routines differently, put it here.  */
  34 #define _VARARGS_ __cdecl
  35
  36 /* If you are providing a function to something that will call the
  37    function back (like a signal handler and signal, or main) its calling
  38    convention must be whatever standard the libraries expect.  */
  39 #define _CALLBACK_ __cdecl
  40
  41 /* Letter to use in finding device name of first pty,
  42    if system supports pty's.  'a' means it is /dev/ptya0  */
  43 #define FIRST_PTY_LETTER 'a'
  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 /* NT supports Winsock which is close enough (with some hacks).  */
  50 #define HAVE_SOCKETS 1
  51
  52 /* But our select implementation doesn't allow us to make non-blocking
  53    connects.  So until that is fixed, this is necessary:  */
  54 #define BROKEN_NON_BLOCKING_CONNECT 1
  55
  56 /* And the select implementation does 1-byte read-ahead waiting
  57    for received packets, so datagrams are broken too.  */
  58 #define BROKEN_DATAGRAM_SOCKETS 1
  59
  60 /* MSVC ignores the "register" keyword, so test fails even though
  61    setjmp does work.  */
  62 #define GC_SETJMP_WORKS 1
  63
  64 /* Enable conservative stack marking for GC.  */
  65 #define GC_MARK_STACK 1
  66
  67 #define MAIL_USE_SYSTEM_LOCK 1
  68
  69 /* If the character used to separate elements of the executable path
  70    is not ':', #define this to be the appropriate character constant.  */
  71 #define SEPCHAR ';'
  72
  73 /* ============================================================ */
  74
  75 /* Here, add any special hacks needed to make Emacs work on this
  76    system.  For example, you might define certain system call names
  77    that don't exist on your system, or that do different things on
  78    your system and must be used only through an encapsulation (which
  79    you should place, by convention, in sysdep.c).  */
  80
  81 /* Define this to be the separator between devices and paths.  */
  82 #define DEVICE_SEP ':'
  83
  84 /* We'll support either convention on NT.  */
  85 #define IS_DIRECTORY_SEP(_c_) ((_c_) == '/' || (_c_) == '\\')
  86 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_) || IS_DEVICE_SEP (_c_))
  87
  88 #ifdef __GNUC__
  89 #ifndef __cplusplus
  90 #undef inline
  91 #endif
  92 #else  /* MSVC */
  93 #define inline __inline
  94 #endif
  95
  96 #ifdef __GNUC__
  97 # define restrict __restrict__
  98 #else
  99 # define restrict
 100 #endif
 101
 102 /* `mode_t' is not defined for MSVC. Define. */
 103 #ifdef _MSC_VER
 104 typedef unsigned short mode_t;
 105 #endif
 106
 107 /* A va_copy replacement for MSVC.  */
 108 #ifdef _MSC_VER
 109 # ifdef _WIN64
 110 #  ifndef va_copy               /* Need to be checked (?) */
 111 #   define va_copy(d,s) ((d) = (s))
 112 #  endif
 113 # else  /* not _WIN64 */
 114 #  define va_copy(d,s) ((d) = (s))
 115 # endif  /* not _WIN64 */
 116 #endif   /* _MSC_VER */
 117
 118 #ifndef WINDOWSNT
 119 /* Some of the files of Emacs which are intended for use with other
 120    programs assume that if you have a config.h file, you must declare
 121    the type of getenv.  */
 122 extern char *getenv ();
 123 #endif
 124
 125 #ifdef HAVE_STRINGS_H
 126 #include "strings.h"
 127 #endif
 128 #include <sys/types.h>
 129
 130 #ifdef _MSC_VER
 131 typedef unsigned long sigset_t;
 132 typedef int ssize_t;
 133 #endif
 134
 135 struct sigaction {
 136   int sa_flags;
 137   void (*sa_handler)(int);
 138   sigset_t sa_mask;
 139 };
 140 #define SIG_BLOCK       1
 141 #define SIG_SETMASK     2
 142 #define SIG_UNBLOCK     3
 143
 144 /* The null device on Windows NT.  */
 145 #define NULL_DEVICE     "NUL:"
 146
 147 #ifndef MAXPATHLEN
 148 #define MAXPATHLEN      _MAX_PATH
 149 #endif
 150
 151 #ifdef HAVE_NTGUI
 152 #define HAVE_WINDOW_SYSTEM 1
 153 #define HAVE_MENUS 1
 154 #endif
 155
 156 /* Get some redefinitions in place.  */
 157
 158 #ifdef emacs
 159
 160 #ifdef _MSC_VER
 161 #include <sys/timeb.h>
 162 #include <sys/stat.h>
 163 #include <signal.h>
 164
 165 /* MSVC gets link-time errors without these redirections.  */
 166 #define fstat(a, b) sys_fstat(a, b)
 167 #define stat(a, b)  sys_stat(a, b)
 168 #define utime       sys_utime
 169 #endif
 170
 171 /* Calls that are emulated or shadowed.  */
 172 #undef access
 173 #define access  sys_access
 174 #undef chdir
 175 #define chdir   sys_chdir
 176 #undef chmod
 177 #define chmod   sys_chmod
 178 #define chown   sys_chown
 179 #undef close
 180 #define close   sys_close
 181 #undef creat
 182 #define creat   sys_creat
 183 #define ctime   sys_ctime
 184 #undef dup
 185 #define dup     sys_dup
 186 #undef dup2
 187 #define dup2    sys_dup2
 188 #define fopen   sys_fopen
 189 #define link    sys_link
 190 #define localtime sys_localtime
 191 #define mkdir   sys_mkdir
 192 #undef mktemp
 193 #define mktemp  sys_mktemp
 194 #undef open
 195 #define open    sys_open
 196 #define pipe    sys_pipe
 197 #undef read
 198 #define read    sys_read
 199 #define rename  sys_rename
 200 #define rmdir   sys_rmdir
 201 #define select  sys_select
 202 #define pselect sys_select
 203 #define sleep   sys_sleep
 204 #define strerror sys_strerror
 205 #undef unlink
 206 #define unlink  sys_unlink
 207 #undef write
 208 #define write   sys_write
 209
 210 /* Subprocess calls that are emulated.  */
 211 #define spawnve sys_spawnve
 212 #define wait    sys_wait
 213 #define kill    sys_kill
 214 #define signal  sys_signal
 215
 216 /* termcap.c calls that are emulated.  */
 217 #define tputs   sys_tputs
 218 #define tgetstr sys_tgetstr
 219
 220 /* cm.c calls that are emulated.  */
 221 #define chcheckmagic sys_chcheckmagic
 222 #define cmcostinit   sys_cmcostinit
 223 #define cmgoto       sys_cmgoto
 224 #define cmputc       sys_cmputc
 225 #define Wcm_clear    sys_Wcm_clear
 226
 227 #endif /* emacs */
 228
 229 /* Map to MSVC names.  */
 230 #define execlp    _execlp
 231 #define execvp    _execvp
 232 #define fdopen    _fdopen
 233 #ifndef fileno
 234 #define fileno    _fileno
 235 #endif
 236 #define fsync     _commit
 237 #define ftruncate _chsize
 238 #define getpid    _getpid
 239 #ifdef _MSC_VER
 240 typedef int pid_t;
 241 #define snprintf  _snprintf
 242 #define strtoll   _strtoi64
 243 #endif
 244 #define isatty    _isatty
 245 #define logb      _logb
 246 #define _longjmp  longjmp
 247 #define lseek     _lseek
 248 #define popen     _popen
 249 #define pclose    _pclose
 250 #define umask     _umask
 251 #ifndef _MSC_VER
 252 #define utimbuf   _utimbuf
 253 #endif
 254 #define strdup    _strdup
 255 #define strupr    _strupr
 256 #define strnicmp  _strnicmp
 257 #define stricmp   _stricmp
 258 #define tzset     _tzset
 259
 260 /* Include time.h before redirecting tzname, since MSVC's time.h
 261    defines _tzname to call a function, but also declares tzname a
 262    2-element array.  Having the redirection before including the
 263    header thus has the effect of declaring a function that returns an
 264    array, and triggers an error message.  */
 265 #include <time.h>
 266 #define tzname    _tzname
 267 #if !defined (_MSC_VER) || (_MSC_VER < 1400)
 268 #undef  utime
 269 #define utime     _utime
 270 #endif
 271
 272 /* 'struct timespec' is used by time-related functions in lib/ and
 273    elsewhere, but we don't use lib/time.h where the structure is
 274    defined.  */
 275 struct timespec
 276 {
 277   time_t        tv_sec;         /* seconds */
 278   long int      tv_nsec;        /* nanoseconds */
 279 };
 280
 281 /* This is hacky, but is necessary to avoid warnings about macro
 282    redefinitions using the SDK compilers.  */
 283 #ifndef __STDC__
 284 #define __STDC__ 1
 285 #define MUST_UNDEF__STDC__
 286 #endif
 287 #include <direct.h>
 288 #include <io.h>
 289 #include <stdio.h>
 290 #ifdef MUST_UNDEF__STDC__
 291 #undef __STDC__
 292 #undef MUST_UNDEF__STDC__
 293 #endif
 294
 295 /* Defines that we need that aren't in the standard signal.h.  */
 296 #define SIGHUP  1               /* Hang up */
 297 #define SIGQUIT 3               /* Quit process */
 298 #define SIGTRAP 5               /* Trace trap */
 299 #define SIGKILL 9               /* Die, die die */
 300 #define SIGPIPE 13              /* Write on pipe with no readers */
 301 #define SIGALRM 14              /* Alarm */
 302 #define SIGCHLD 18              /* Death of child */
 303
 304 #ifndef NSIG
 305 #define NSIG 23
 306 #endif
 307
 308 /* For integration with MSDOS support.  */
 309 #define getdisk()               (_getdrive () - 1)
 310 #ifdef emacs
 311 #define getdefdir(_drv, _buf)   ((_buf[0] = (_drv + 'A' - 1), _buf[1] = ':', _buf[2] = '/', _buf[3] = 0), 1)
 312 #else
 313 #define getdefdir(_drv, _buf)   _getdcwd (_drv, _buf, MAXPATHLEN)
 314 #endif
 315
 316 extern char *get_emacs_configuration (void);
 317 extern char *get_emacs_configuration_options (void);
 318 #define EMACS_CONFIGURATION     get_emacs_configuration ()
 319 #define EMACS_CONFIG_OPTIONS    get_emacs_configuration_options ()
 320
 321 /* Define this so that winsock.h definitions don't get included with
 322    windows.h.  For this to have proper effect, config.h must always be
 323    included before windows.h.  */
 324 #define _WINSOCKAPI_    1
 325 #define _WINSOCK_H
 326
 327 /* Prevent accidental use of features unavailable in
 328    older Windows versions we still support.  */
 329 #define _WIN32_WINNT 0x0400
 330
 331 /* Make a leaner executable.  */
 332 #define WIN32_LEAN_AND_MEAN 1
 333
 334 /* Defines size_t and alloca ().  */
 335 #ifdef emacs
 336 #define malloc e_malloc
 337 #define free   e_free
 338 #define realloc e_realloc
 339 #define calloc e_calloc
 340 #endif
 341 #ifdef _MSC_VER
 342 #define alloca _alloca
 343 #else
 344 #include <malloc.h>
 345 #endif
 346
 347 /* stdlib.h must be included after redefining malloc & friends, but
 348    before redefining abort.  Isn't library redefinition funny?  */
 349 #include <stdlib.h>
 350
 351 /* Redefine abort.  */
 352 #ifdef HAVE_NTGUI
 353 #define abort   w32_abort
 354 extern _Noreturn void w32_abort (void);
 355 #endif
 356
 357 #include <sys/stat.h>
 358
 359 /* Define for those source files that do not include enough NT system files.  */
 360 #ifndef NULL
 361 #ifdef __cplusplus
 362 #define NULL    0
 363 #else
 364 #define NULL    ((void *)0)
 365 #endif
 366 #endif
 367
 368 /* For proper declaration of environ.  */
 369 #ifndef sys_nerr
 370 #define sys_nerr _sys_nerr
 371 #endif
 372
 373 extern int getloadavg (double *, int);
 374
 375 #if defined (__MINGW32__) || _MSC_VER >= 1400
 376
 377 /* Define to 1 if the system has the type `long long int'. */
 378 # define HAVE_LONG_LONG_INT 1
 379
 380 /* Define to 1 if the system has the type `unsigned long long int'. */
 381 # define HAVE_UNSIGNED_LONG_LONG_INT 1
 382
 383 #elif _MSC_VER >= 1200
 384
 385 /* Temporarily disable wider-than-pointer integers until they're tested more.
 386    Build with CFLAGS='-DWIDE_EMACS_INT' to try them out.  */
 387
 388 # ifdef WIDE_EMACS_INT
 389
 390 /* Use pre-C99-style 64-bit integers.  */
 391 # define EMACS_INT __int64
 392 # define EMACS_INT_MAX _I64_MAX
 393 # define pI "I64"
 394
 395 # endif
 396
 397 #endif
 398
 399 /* We need a little extra space, see ../../lisp/loadup.el.  */
 400 #define SYSTEM_PURESIZE_EXTRA 50000
 401
 402 #define DATA_START      get_data_start ()
 403
 404 /* For unexec to work on Alpha systems, we need to put Emacs'
 405    initialized data into a separate section from the CRT initialized
 406    data (because the Alpha linker freely reorders data variables, even
 407    across libraries, so our data and the CRT data get intermingled).
 408
 409    Starting with MSVC 5.0, we must also place the uninitialized data
 410    into its own section.  VC5 intermingles uninitialized data from the CRT
 411    between Emacs' static uninitialized data and its public uninitialized
 412    data.  A separate .bss section for Emacs groups both static and
 413    public uninitialized together.
 414
 415    Note that unexw32.c relies on this fact, and must be modified
 416    accordingly if this section name is changed, or if this pragma is
 417    removed.  Also, obviously, all files that define initialized data
 418    must include config.h to pick up this pragma.  */
 419
 420 /* Names must be < 8 bytes.  */
 421 #ifdef _MSC_VER
 422 #pragma data_seg("EMDATA")
 423 #pragma bss_seg("EMBSS")
 424 #endif
 425
 426 /* #define FULL_DEBUG */
 427 /* #define EMACSDEBUG */
 428
 429 #ifdef EMACSDEBUG
 430 extern void _DebPrint (const char *fmt, ...);
 431 #define DebPrint(stuff) _DebPrint stuff
 432 #else
 433 #define DebPrint(stuff)
 434 #endif
 435
 436 /* ============================================================ */