admin/CPP-DEFINES

   1 Here are some of the cpp macros used, together with some short explanation
   2 of their use.  Feel free to add more macros and more categories.
   3 Most of these are from config.in, so it's probably better to put the
   4 explanations in that file.  Ideally, everything would be defined and
   5 documented in config.in, and this file would not be necessary.
   6
   7
   8 ** Distinguishing OSes **
   9
  10 AIX
  11 _AIX
  12 CYGWIN          Compiling the Cygwin port.
  13 __CYGWIN__      Ditto
  14 GNU_LINUX
  15 HPUX
  16 IRIX6_5
  17 MSDOS           Compiling the MS-DOS port.
  18 __MSDOS__       Ditto.
  19 __DJGPP_MINOR__ Minor version number of the DJGPP library; used only in msdos.c and dosfns.c.
  20 DOS_NT          Compiling for either the MS-DOS or native MS-Windows port.
  21 WINDOWSNT       Compiling the native MS-Windows (W32) port.
  22 __MINGW32__     Compiling the W32 port with the MinGW port of GCC.
  23 _MSC_VER        Compiling the W32 port with the Microsoft C compiler.
  24 DARWIN_OS       Compiling on Mac OS X or pure Darwin (and using s/darwin.h).
  25 SOLARIS2
  26 USG
  27 USG5_4
  28
  29 ** Distinguishing GUIs **
  30
  31 HAVE_NTGUI      Use the native W32 GUI for windows, frames, menus&scrollbars.
  32 HAVE_NS         Use the NeXT/OpenStep/Cocoa UI under Mac OS X or GNUstep.
  33 NS_IMPL_GNUSTEP Compile support for GNUstep implementation of NS GUI API.
  34 NS_IMPL_COCOA   Compile support for Cocoa (Apple) implementation of NS GUI API.
  35 HAVE_X11        Compile support for the X11 GUI.
  36 HAVE_X_WINDOWS  Compile support for X Window system
  37   (It looks like, nowadays, if HAVE_X11 is set, HAVE_X_WINDOWS must
  38    be, and vice versa.  At least, this is true for configure, and
  39    msdos; not sure about nt.)
  40 HAVE_X11R6
  41 HAVE_X11R6_XIM
  42 HAVE_X11XTR6
  43 USE_LUCID       Use the Lucid toolkit for menus&scrollbars.  Requires HAVE_X11.
  44 USE_MOTIF       Use the Motif toolkit for menus&scrollbars.  Requires HAVE_X11.
  45 USE_GTK         Use the Gtk   toolkit for menus&scrollbars.  Requires HAVE_X11.
  46
  47 ** Frame types **
  48
  49 FRAME_TERMCAP_P A tty (character terminal) frame.
  50 FRAME_X_P       A frame on X Window system.
  51 FRAME_MSDOS_P   An MS-DOS frame (used only by the DOS port).
  52 FRAME_W32_P     A frame using native MS-Windows GUI.
  53 FRAME_WINDOW_P  A GUI frame (like X, w32, etc.)
  54
  55 ** Support for accessing other processes on the system **
  56
  57 HAVE_PROCFS     The /proc filesystem is supported.
  58
  59 ** Compile-time options **
  60
  61 REL_ALLOC       Compile in the relocatable memory allocator ralloc.c.
  62 SYSTEM_MALLOC   Use the system library's malloc.
  63 subprocesses    System can use subprocesses (for M-x shell for example).
  64                 Defined by default, only MSDOS undefines it.
  65 DEBUG_LISP_OBJECT_TYPE Define it in lisp.h enable compile time checks
  66                        on Lisp_Object use.
  67
  68 ** System specific macros
  69 FIRST_PTY_LETTER
  70 HAVE_PTYS
  71 INTERRUPT_INPUT
  72 NARROWPROTO
  73 SEPCHAR
  74 SYSTEM_TYPE
  75
  76 ** Misc macros
  77 USER_FULL_NAME   If defined, overrides the default pw->pw_gecos for
  78 getting at the full user name.  Only MSDOS overrides the default.
  79
  80 ** Miscellaneous defines.  Some of these might not be used in the code
  81 anymore, so they can be removed.
  82
  83 AMPERSAND_FULL_NAME
  84 BROKEN_DATAGRAM_SOCKETS
  85 BROKEN_FIONREAD
  86 BROKEN_GET_CURRENT_DIR_NAME
  87 BROKEN_NON_BLOCKING_CONNECT
  88 BROKEN_PTY_READ_AFTER_EAGAIN
  89 DEFAULT_SOUND_DEVICE
  90 DEVICE_SEP
  91 DIRECTORY_SEP
  92 DONT_REOPEN_PTY
  93 DOUG_LEA_MALLOC
  94 EMACS_CONFIGURATION
  95 EMACS_CONFIG_OPTIONS
  96 EMACS_INT
  97 EMACS_UINT
  98 GC_MARK_SECONDARY_STACK
  99 GC_MARK_STACK
 100 GC_SETJMP_WORKS
 101 GNU_MALLOC
 102 HAVE_AIX_SMT_EXP
 103 HAVE_ALARM
 104 HAVE_ALLOCA
 105 HAVE_ALLOCA_H
 106 HAVE_ALSA
 107 HAVE_ATTRIBUTE_ALIGNED
 108 HAVE_BDFFONT
 109 HAVE_BOXES
 110 HAVE_C99_STRTOLD
 111 HAVE_CFMAKERAW
 112 HAVE_CFSETSPEED
 113 HAVE_CLOCK_GETTIME
 114 HAVE_CLOCK_SETTIME
 115 HAVE_COFF_H
 116 HAVE_COM_ERR_H
 117 HAVE_COPYSIGN
 118 HAVE_DBUS
 119 HAVE_DBUS_TYPE_IS_VALID
 120 HAVE_DBUS_VALIDATE_BUS_NAME
 121 HAVE_DBUS_VALIDATE_INTERFACE
 122 HAVE_DBUS_VALIDATE_MEMBER
 123 HAVE_DBUS_VALIDATE_PATH
 124 HAVE_DBUS_WATCH_GET_UNIX_FD
 125 HAVE_DECL_GETENV
 126 HAVE_DECL_LOCALTIME_R
 127 HAVE_DECL_STRMODE
 128 HAVE_DECL_STRTOIMAX
 129 HAVE_DECL_STRTOLL
 130 HAVE_DECL_STRTOULL
 131 HAVE_DECL_STRTOUMAX
 132 HAVE_DECL_SYS_SIGLIST
 133 HAVE_DECL_TZNAME
 134 HAVE_DECL___SYS_SIGLIST
 135 HAVE_DIALOGS
 136 HAVE_DIFFTIME
 137 HAVE_DUP2
 138 HAVE_ENDGRENT
 139 HAVE_ENDPWENT
 140 HAVE_ENVIRON_DECL
 141 HAVE_EUIDACCESS
 142 HAVE_FORK
 143 HAVE_FREEIFADDRS
 144 HAVE_FREETYPE
 145 HAVE_FSEEKO
 146 HAVE_FUTIMENS
 147 HAVE_FUTIMES
 148 HAVE_FUTIMESAT
 149 HAVE_GAI_STRERROR
 150 HAVE_GCONF
 151 HAVE_GETADDRINFO
 152 HAVE_GETDELIM
 153 HAVE_GETGRENT
 154 HAVE_GETHOSTNAME
 155 HAVE_GETIFADDRS
 156 HAVE_GETLINE
 157 HAVE_GETLOADAVG
 158 HAVE_GETOPT_H
 159 HAVE_GETOPT_LONG_ONLY
 160 HAVE_GETPAGESIZE
 161 HAVE_GETPEERNAME
 162 HAVE_GETPT
 163 HAVE_GETPWENT
 164 HAVE_GETRLIMIT
 165 HAVE_GETRUSAGE
 166 HAVE_GETSOCKNAME
 167 HAVE_GETTIMEOFDAY
 168 HAVE_GET_CURRENT_DIR_NAME
 169 HAVE_GHOSTSCRIPT
 170 HAVE_GIF
 171 HAVE_GNUTLS
 172 HAVE_GPM
 173 HAVE_GRANTPT
 174 HAVE_GSETTINGS
 175 HAVE_GTK3
 176 HAVE_GTK_ADJUSTMENT_GET_PAGE_SIZE
 177 HAVE_GTK_DIALOG_GET_ACTION_AREA
 178 HAVE_GTK_FILE_SELECTION_NEW
 179 HAVE_GTK_MAIN
 180 HAVE_GTK_MULTIDISPLAY
 181 HAVE_GTK_ORIENTABLE_SET_ORIENTATION
 182 HAVE_GTK_WIDGET_GET_MAPPED
 183 HAVE_GTK_WIDGET_GET_SENSITIVE
 184 HAVE_GTK_WIDGET_GET_WINDOW
 185 HAVE_GTK_WIDGET_SET_HAS_WINDOW
 186 HAVE_GTK_WINDOW_SET_HAS_RESIZE_GRIP
 187 HAVE_G_TYPE_INIT
 188 HAVE_H_ERRNO
 189 HAVE_IFADDRS_H
 190 HAVE_IMAGEMAGICK
 191 HAVE_INET_SOCKETS
 192 HAVE_INTTYPES_H
 193 HAVE_JPEG
 194 HAVE_KERBEROSIV_KRB_H
 195 HAVE_KERBEROS_KRB_H
 196 HAVE_KRB5_ERROR_E_TEXT
 197 HAVE_KRB5_ERROR_TEXT
 198 HAVE_KRB5_H
 199 HAVE_KRB_H
 200 HAVE_LANGINFO_CODESET
 201 HAVE_LIBDGC
 202 HAVE_LIBKSTAT
 203 HAVE_LIBLOCKFILE
 204 HAVE_LIBMAIL
 205 HAVE_LIBOTF
 206 HAVE_LIBPERFSTAT
 207 HAVE_LIBPNG_PNG_H
 208 HAVE_LIBSELINUX
 209 HAVE_LIBXML2
 210 HAVE_LIBXMU
 211 HAVE_LOCALTIME_R
 212 HAVE_LOCAL_SOCKETS
 213 HAVE_LONG_FILE_NAMES
 214 HAVE_LONG_LONG_INT
 215 HAVE_LRAND48
 216 HAVE_LSTAT
 217 HAVE_LUTIMES
 218 HAVE_M17N_FLT
 219 HAVE_MACHINE_SOUNDCARD_H
 220 HAVE_MACH_MACH_H
 221 HAVE_MAGICKEXPORTIMAGEPIXELS
 222 HAVE_MAGICKMERGEIMAGELAYERS
 223 HAVE_MAILLOCK_H
 224 HAVE_MALLOC_MALLOC_H
 225 HAVE_MATHERR
 226 HAVE_MBSTATE_T
 227 HAVE_MEMCMP
 228 HAVE_MEMMOVE
 229 HAVE_MEMORY_H
 230 HAVE_MEMSET
 231 HAVE_MENUS
 232 HAVE_MKSTEMP
 233 HAVE_MMAP
 234 HAVE_MULTILINGUAL_MENU
 235 HAVE_NANOTIME
 236 HAVE_NET_IF_DL_H
 237 HAVE_NET_IF_H
 238 HAVE_NLIST_H
 239 HAVE_OTF_GET_VARIATION_GLYPHS
 240 HAVE_PERSONALITY_LINUX32
 241 HAVE_PNG
 242 HAVE_PNG_H
 243 HAVE_POSIX_MEMALIGN
 244 HAVE_PROCFS
 245 HAVE_PSELECT
 246 HAVE_PSTAT_GETDYNAMIC
 247 HAVE_PTHREAD
 248 HAVE_PTHREAD_H
 249 HAVE_PTHREAD_SIGMASK
 250 HAVE_PTYS
 251 HAVE_PTY_H
 252 HAVE_PWD_H
 253 HAVE_RANDOM
 254 HAVE_READLINK
 255 HAVE_READLINKAT
 256 HAVE_RECVFROM
 257 HAVE_RES_INIT
 258 HAVE_RINT
 259 HAVE_RSVG
 260 HAVE_SELECT
 261 HAVE_SENDTO
 262 HAVE_SEQPACKET
 263 HAVE_SETITIMER
 264 HAVE_SETLOCALE
 265 HAVE_SETRLIMIT
 266 HAVE_SHARED_GAME_DIR
 267 HAVE_SHUTDOWN
 268 HAVE_SIGNED_${GLTYPE}
 269 HAVE_SIGNED_SIG_ATOMIC_T
 270 HAVE_SIGNED_WCHAR_T
 271 HAVE_SIGNED_WINT_T
 272 HAVE_SIGSET_T
 273 HAVE_SNPRINTF
 274 HAVE_SOCKETS
 275 HAVE_SOUND
 276 HAVE_SOUNDCARD_H
 277 HAVE_STDINT_H
 278 HAVE_STDIO_EXT_H
 279 HAVE_STDLIB_H
 280 HAVE_STLIB_H_1
 281 HAVE_STRINGS_H
 282 HAVE_STRING_H
 283 HAVE_STRNCASECMP
 284 HAVE_STRSIGNAL
 285 HAVE_STRTOIMAX
 286 HAVE_STRTOLL
 287 HAVE_STRTOULL
 288 HAVE_STRTOUMAX
 289 HAVE_STRUCT_ERA_ENTRY
 290 HAVE_STRUCT_IFREQ_IFR_ADDR
 291 HAVE_STRUCT_IFREQ_IFR_ADDR_SA_LEN
 292 HAVE_STRUCT_IFREQ_IFR_BROADADDR
 293 HAVE_STRUCT_IFREQ_IFR_FLAGS
 294 HAVE_STRUCT_IFREQ_IFR_HWADDR
 295 HAVE_STRUCT_IFREQ_IFR_NETMASK
 296 HAVE_STRUCT_NLIST_N_UN_N_NAME
 297 HAVE_STRUCT_STAT_ST_ATIMENSEC
 298 HAVE_STRUCT_STAT_ST_ATIMESPEC_TV_NSEC
 299 HAVE_STRUCT_STAT_ST_ATIM_ST__TIM_TV_NSEC
 300 HAVE_STRUCT_STAT_ST_ATIM_TV_NSEC
 301 HAVE_STRUCT_STAT_ST_BIRTHTIMENSEC
 302 HAVE_STRUCT_STAT_ST_BIRTHTIMESPEC_TV_NSEC
 303 HAVE_STRUCT_STAT_ST_BIRTHTIM_TV_NSEC
 304 HAVE_STRUCT_TIMEZONE
 305 HAVE_STRUCT_TM_TM_ZONE
 306 HAVE_STRUCT_UTIMBUF
 307 HAVE_ST_DM_MODE
 308 HAVE_SYMLINK
 309 HAVE_SYNC
 310 HAVE_SYS_BITYPES_H
 311 HAVE_SYS_INTTYPES_H
 312 HAVE_SYS_LOADAVG_H
 313 HAVE_SYS_PARAM_H
 314 HAVE_SYS_RESOURCE_H
 315 HAVE_SYS_SELECT_H
 316 HAVE_SYS_SOCKET_H
 317 HAVE_SYS_SOUNDCARD_H
 318 HAVE_SYS_STAT_H
 319 HAVE_SYS_SYSTEMINFO_H
 320 HAVE_SYS_TIMEB_H
 321 HAVE_SYS_TIME_H
 322 HAVE_SYS_TYPES_H
 323 HAVE_SYS_UN_H
 324 HAVE_SYS_UTSNAME_H
 325 HAVE_SYS_VLIMIT_H
 326 HAVE_SYS_WAIT_H
 327 HAVE_TCATTR
 328 HAVE_TERM_H
 329 HAVE_TIFF
 330 HAVE_TIMEVAL
 331 HAVE_TM_GMTOFF
 332 HAVE_TM_ZONE
 333 HAVE_TOUCHLOCK
 334 HAVE_TZNAME
 335 HAVE_TZSET
 336 HAVE_UNSIGNED_LONG_LONG_INT
 337 HAVE_UTIL_H
 338 HAVE_UTIMENSAT
 339 HAVE_UTIMES
 340 HAVE_UTIME_H
 341 HAVE_UTMP_H
 342 HAVE_VFORK
 343 HAVE_VFORK_H
 344 HAVE_WCHAR_H
 345 HAVE_WCHAR_T
 346 HAVE_WINDOW_SYSTEM
 347 HAVE_WINSOCK2_H
 348 HAVE_WORKING_FORK
 349 HAVE_WORKING_UTIMES
 350 HAVE_WORKING_VFORK
 351 HAVE_WS2TCPIP_H
 352 HAVE_XAW3D
 353 HAVE_XFT
 354 HAVE_XIM
 355 HAVE_XPM
 356 HAVE_XRMSETDATABASE
 357 HAVE_XSCREENNUMBEROFSCREEN
 358 HAVE_XSCREENRESOURCESTRING
 359 HAVE_X_I18N
 360 HAVE_X_MENU
 361 HAVE_X_SM
 362 HAVE_X_WINDOWS
 363 HAVE__BOOL
 364 HAVE__FTIME
 365 HAVE___BUILTIN_UNWIND_INIT
 366 HAVE___EXECUTABLE_START
 367 HAVE___FPENDING
 368 INTERNAL_TERMINAL
 369 IS_ANY_SEP
 370 IS_DIRECTORY_SEP
 371 MAIL_USE_FLOCK
 372 MAIL_USE_LOCKF
 373 MAIL_USE_POP
 374 MAIL_USE_SYSTEM_LOCK
 375 MAXPATHLEN
 376 NLIST_STRUCT
 377 NO_EDITRES
 378 NSIG
 379 NSIG_MINIMUM
 380 NULL_DEVICE
 381 PAGESIZE
 382 PREFER_VSUSP
 383 PTY_ITERATION
 384 PTY_NAME_SPRINTF
 385 PTY_OPEN
 386 PTY_TTY_NAME_SPRINTF
 387 PURESIZE
 388 RUN_TIME_REMAP
 389 SETUP_SLAVE_PTY
 390 SIGNALS_VIA_CHARACTERS
 391 STDC_HEADERS
 392 SYSTEM_PURESIZE_EXTRA
 393 SYSTEM_MALLOC
 394 TAB3
 395 TABDLY
 396 TERM
 397 TIME_WITH_SYS_TIME
 398 TIOCSIGSEND
 399 TM_IN_SYS_TIME
 400 UNIX98_PTYS
 401 USE_TOOLKIT_SCROLL_BARS
 402 USG_SUBTTY_WORKS
 403 VALBITS
 404 XOS_NEEDS_TIME_H
 405 _FILE_OFFSET_BITS
 406 _LP64
 407 _longjmp
 408 _setjmp
 409 abort
 410 alloca
 411 close
 412 emacs
 413 free
 414 gmtime
 415 localtime
 416 malloc
 417 random
 418 read
 419 realloc
 420 select
 421 umask
 422 vfork
 423
 424
 425 src/sysdep.c:
 426 write
 427
 428 src/syssignal.h:
 429 signal
 430 sigmask
 431 sigsetmask
 432
 433
 434 lib/dup2.c:
 435 dup2
 436
 437 lib/signal.h:
 438 signal
 439
 440 lib/stdio.h:
 441 fdopen
 442 fopen
 443 fwrite
 444 popen
 445 rename
 446
 447 lib/stdlib.h:
 448 calloc
 449 srandom     (conf_post.h may undo)
 450
 451 lib/strftime.c:
 452 tzname
 453 tzset
 454
 455 lib/sys/stat.h:
 456 mkdir
 457
 458 lib/unistd.h:
 459 chown
 460 dup
 461 dup2
 462 ftruncate
 463 isatty
 464 link
 465 lseek
 466 pipe
 467 rmdir
 468 sleep
 469 unlink
 470
 471
 472 MS DOS stuff:
 473
 474 _NAIVE_DOS_REGS
 475
 476
 477 MS stuff:
 478
 479 USE_CRT_DLL
 480
 481 ms-w32.h:
 482 DebPrint
 483 EMACSDEBUG
 484 MUST_UNDEF__STDC__
 485
 486 _VARARGS_
 487 _WINSOCKAPI_
 488 _WINSOCK_H
 489
 490 access
 491 calloc
 492 chdir
 493 chmod
 494 chown
 495 creat
 496 ctime
 497 dup
 498 dup2
 499 execlp
 500 execvp  (also emacsclient.c [WINDOWSNT])
 501 fdopen
 502 fileno
 503 fopen
 504 fsync
 505 ftruncate
 506 getdefdir
 507 getdisk
 508 getpid
 509 isatty
 510 kill
 511 link
 512 lseek
 513 mkdir
 514 mktemp
 515 open
 516 pclose
 517 pipe
 518 popen
 519 rename
 520 rmdir
 521 signal
 522 sleep
 523 spawnve
 524 strdup
 525 stricmp
 526 strnicmp
 527 strupr
 528 sys_nerr
 529 tzname
 530 tzset
 531 umask
 532 unlink
 533 utimbuf
 534 utime
 535 wait  (also movemail.c [WINDOWSNT])
 536 write
 537
 538 lib-src/ntlib:
 539 access
 540 chdir
 541 chmod
 542 creat
 543 dup
 544 dup2
 545 execlp
 546 execvp
 547 fdopen
 548 fileno
 549 fopen
 550 getpid
 551 index
 552 isatty
 553 lseek
 554 mkdir
 555 mktemp
 556 open
 557 pclose
 558 pipe
 559 popen
 560 rmdir
 561 rindex
 562 sleep
 563 umask
 564 unlink
 565 utime