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