Merge from trunk + rename the event. Not tested yet.
[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_GET_CURRENT_DIR_NAME
90 BROKEN_NON_BLOCKING_CONNECT
91 BROKEN_PTY_READ_AFTER_EAGAIN
92 CLASH_DETECTION
93 DATA_SEG_BITS
94 DATA_START
95 DEFAULT_SOUND_DEVICE
96 DEVICE_SEP
97 DIRECTORY_SEP
98 DONT_REOPEN_PTY
99 DOUG_LEA_MALLOC
100 EMACS_CONFIGURATION
101 EMACS_CONFIG_OPTIONS
102 EMACS_INT
103 EMACS_UINT
104 GC_MARK_SECONDARY_STACK
105 GC_MARK_STACK
106 GC_SETJMP_WORKS
107 GNU_MALLOC
108 HAVE_AIX_SMT_EXP
109 HAVE_ALARM
110 HAVE_ALLOCA
111 HAVE_ALLOCA_H
112 HAVE_ALSA
113 HAVE_ATTRIBUTE_ALIGNED
114 HAVE_BDFFONT
115 HAVE_BOXES
116 HAVE_C99_STRTOLD
117 HAVE_CFMAKERAW
118 HAVE_CFSETSPEED
119 HAVE_CLOCK_GETTIME
120 HAVE_CLOCK_SETTIME
121 HAVE_COFF_H
122 HAVE_COM_ERR_H
123 HAVE_COPYSIGN
124 HAVE_DBUS
125 HAVE_DBUS_TYPE_IS_VALID
126 HAVE_DBUS_VALIDATE_BUS_NAME
127 HAVE_DBUS_VALIDATE_INTERFACE
128 HAVE_DBUS_VALIDATE_MEMBER
129 HAVE_DBUS_VALIDATE_PATH
130 HAVE_DBUS_WATCH_GET_UNIX_FD
131 HAVE_DECL_GETENV
132 HAVE_DECL_LOCALTIME_R
133 HAVE_DECL_STRMODE
134 HAVE_DECL_STRTOIMAX
135 HAVE_DECL_STRTOLL
136 HAVE_DECL_STRTOULL
137 HAVE_DECL_STRTOUMAX
138 HAVE_DECL_SYS_SIGLIST
139 HAVE_DECL_TZNAME
140 HAVE_DECL___SYS_SIGLIST
141 HAVE_DES_H
142 HAVE_DEV_PTMX
143 HAVE_DIALOGS
144 HAVE_DIFFTIME
145 HAVE_DUP2
146 HAVE_ENDGRENT
147 HAVE_ENDPWENT
148 HAVE_ENVIRON_DECL
149 HAVE_EUIDACCESS
150 HAVE_FORK
151 HAVE_FREEIFADDRS
152 HAVE_FREETYPE
153 HAVE_FSEEKO
154 HAVE_FSYNC
155 HAVE_FUTIMENS
156 HAVE_FUTIMES
157 HAVE_FUTIMESAT
158 HAVE_GAI_STRERROR
159 HAVE_GCONF
160 HAVE_GETADDRINFO
161 HAVE_GETDELIM
162 HAVE_GETGRENT
163 HAVE_GETHOSTNAME
164 HAVE_GETIFADDRS
165 HAVE_GETLINE
166 HAVE_GETLOADAVG
167 HAVE_GETOPT_H
168 HAVE_GETOPT_LONG_ONLY
169 HAVE_GETPAGESIZE
170 HAVE_GETPEERNAME
171 HAVE_GETPT
172 HAVE_GETPWENT
173 HAVE_GETRLIMIT
174 HAVE_GETRUSAGE
175 HAVE_GETSOCKNAME
176 HAVE_GETTIMEOFDAY
177 HAVE_GET_CURRENT_DIR_NAME
178 HAVE_GHOSTSCRIPT
179 HAVE_GIF
180 HAVE_GNUTLS
181 HAVE_GNUTLS_CALLBACK_CERTIFICATE_VERIFY
182 HAVE_GNUTLS_CERTIFICATE_SET_VERIFY_FUNCTION
183 HAVE_GPM
184 HAVE_GRANTPT
185 HAVE_GSETTINGS
186 HAVE_GTK3
187 HAVE_GTK_ADJUSTMENT_GET_PAGE_SIZE
188 HAVE_GTK_DIALOG_GET_ACTION_AREA
189 HAVE_GTK_FILE_SELECTION_NEW
190 HAVE_GTK_MAIN
191 HAVE_GTK_MULTIDISPLAY
192 HAVE_GTK_ORIENTABLE_SET_ORIENTATION
193 HAVE_GTK_WIDGET_GET_MAPPED
194 HAVE_GTK_WIDGET_GET_SENSITIVE
195 HAVE_GTK_WIDGET_GET_WINDOW
196 HAVE_GTK_WIDGET_SET_HAS_WINDOW
197 HAVE_GTK_WINDOW_SET_HAS_RESIZE_GRIP
198 HAVE_G_TYPE_INIT
199 HAVE_H_ERRNO
200 HAVE_IFADDRS_H
201 HAVE_IMAGEMAGICK
202 HAVE_INET_SOCKETS
203 HAVE_INTTYPES_H
204 HAVE_JPEG
205 HAVE_KERBEROSIV_DES_H
206 HAVE_KERBEROSIV_KRB_H
207 HAVE_KERBEROS_DES_H
208 HAVE_KERBEROS_KRB_H
209 HAVE_KRB5_ERROR_E_TEXT
210 HAVE_KRB5_ERROR_TEXT
211 HAVE_KRB5_H
212 HAVE_KRB_H
213 HAVE_LANGINFO_CODESET
214 HAVE_LIBCOM_ERR
215 HAVE_LIBCRYPTO
216 HAVE_LIBDES
217 HAVE_LIBDES425
218 HAVE_LIBDGC
219 HAVE_LIBDNET
220 HAVE_LIBHESIOD
221 HAVE_LIBK5CRYPTO
222 HAVE_LIBKRB
223 HAVE_LIBKRB4
224 HAVE_LIBKRB5
225 HAVE_LIBKSTAT
226 HAVE_LIBLOCKFILE
227 HAVE_LIBM
228 HAVE_LIBMAIL
229 HAVE_LIBOTF
230 HAVE_LIBPERFSTAT
231 HAVE_LIBPNG_PNG_H
232 HAVE_LIBPTHREADS
233 HAVE_LIBRESOLV
234 HAVE_LIBSELINUX
235 HAVE_LIBXEXT
236 HAVE_LIBXML2
237 HAVE_LIBXMU
238 HAVE_LINUX_VERSION_H
239 HAVE_LOCALTIME_R
240 HAVE_LOCAL_SOCKETS
241 HAVE_LONG_FILE_NAMES
242 HAVE_LONG_LONG_INT
243 HAVE_LRAND48
244 HAVE_LSTAT
245 HAVE_LUTIMES
246 HAVE_M17N_FLT
247 HAVE_MACHINE_SOUNDCARD_H
248 HAVE_MACH_MACH_H
249 HAVE_MAGICKEXPORTIMAGEPIXELS
250 HAVE_MAGICKMERGEIMAGELAYERS
251 HAVE_MAILLOCK_H
252 HAVE_MALLOC_MALLOC_H
253 HAVE_MATHERR
254 HAVE_MBSTATE_T
255 HAVE_MEMCMP
256 HAVE_MEMMOVE
257 HAVE_MEMORY_H
258 HAVE_MEMSET
259 HAVE_MENUS
260 HAVE_MKSTEMP
261 HAVE_MMAP
262 HAVE_MULTILINGUAL_MENU
263 HAVE_NANOTIME
264 HAVE_NET_IF_DL_H
265 HAVE_NET_IF_H
266 HAVE_NLIST_H
267 HAVE_OTF_GET_VARIATION_GLYPHS
268 HAVE_PERSONALITY_LINUX32
269 HAVE_PNG
270 HAVE_PNG_H
271 HAVE_POSIX_MEMALIGN
272 HAVE_PROCFS
273 HAVE_PSELECT
274 HAVE_PSTAT_GETDYNAMIC
275 HAVE_PTHREAD
276 HAVE_PTHREAD_H
277 HAVE_PTHREAD_SIGMASK
278 HAVE_PTYS
279 HAVE_PTY_H
280 HAVE_PWD_H
281 HAVE_RANDOM
282 HAVE_READLINK
283 HAVE_READLINKAT
284 HAVE_RECVFROM
285 HAVE_RES_INIT
286 HAVE_RINT
287 HAVE_RSVG
288 HAVE_SELECT
289 HAVE_SENDTO
290 HAVE_SEQPACKET
291 HAVE_SETITIMER
292 HAVE_SETLOCALE
293 HAVE_SETRLIMIT
294 HAVE_SHARED_GAME_DIR
295 HAVE_SHUTDOWN
296 HAVE_SIGNED_${GLTYPE}
297 HAVE_SIGNED_SIG_ATOMIC_T
298 HAVE_SIGNED_WCHAR_T
299 HAVE_SIGNED_WINT_T
300 HAVE_SIGSET_T
301 HAVE_SNPRINTF
302 HAVE_SOCKETS
303 HAVE_SOUND
304 HAVE_SOUNDCARD_H
305 HAVE_SPEED_T
306 HAVE_STDINT_H
307 HAVE_STDIO_EXT_H
308 HAVE_STDLIB_H
309 HAVE_STLIB_H_1
310 HAVE_STRINGS_H
311 HAVE_STRING_H
312 HAVE_STRNCASECMP
313 HAVE_STRSIGNAL
314 HAVE_STRTOIMAX
315 HAVE_STRTOLL
316 HAVE_STRTOULL
317 HAVE_STRTOUMAX
318 HAVE_STRUCT_ERA_ENTRY
319 HAVE_STRUCT_IFREQ_IFR_ADDR
320 HAVE_STRUCT_IFREQ_IFR_ADDR_SA_LEN
321 HAVE_STRUCT_IFREQ_IFR_BROADADDR
322 HAVE_STRUCT_IFREQ_IFR_FLAGS
323 HAVE_STRUCT_IFREQ_IFR_HWADDR
324 HAVE_STRUCT_IFREQ_IFR_NETMASK
325 HAVE_STRUCT_NLIST_N_UN_N_NAME
326 HAVE_STRUCT_STAT_ST_ATIMENSEC
327 HAVE_STRUCT_STAT_ST_ATIMESPEC_TV_NSEC
328 HAVE_STRUCT_STAT_ST_ATIM_ST__TIM_TV_NSEC
329 HAVE_STRUCT_STAT_ST_ATIM_TV_NSEC
330 HAVE_STRUCT_STAT_ST_BIRTHTIMENSEC
331 HAVE_STRUCT_STAT_ST_BIRTHTIMESPEC_TV_NSEC
332 HAVE_STRUCT_STAT_ST_BIRTHTIM_TV_NSEC
333 HAVE_STRUCT_TIMEZONE
334 HAVE_STRUCT_TM_TM_ZONE
335 HAVE_STRUCT_UTIMBUF
336 HAVE_ST_DM_MODE
337 HAVE_SYMLINK
338 HAVE_SYNC
339 HAVE_SYS_BITYPES_H
340 HAVE_SYS_INTTYPES_H
341 HAVE_SYS_LOADAVG_H
342 HAVE_SYS_PARAM_H
343 HAVE_SYS_RESOURCE_H
344 HAVE_SYS_SELECT_H
345 HAVE_SYS_SOCKET_H
346 HAVE_SYS_SOUNDCARD_H
347 HAVE_SYS_STAT_H
348 HAVE_SYS_SYSTEMINFO_H
349 HAVE_SYS_TIMEB_H
350 HAVE_SYS_TIME_H
351 HAVE_SYS_TYPES_H
352 HAVE_SYS_UN_H
353 HAVE_SYS_UTSNAME_H
354 HAVE_SYS_VLIMIT_H
355 HAVE_SYS_WAIT_H
356 HAVE_TCATTR
357 HAVE_TERM_H
358 HAVE_TIFF
359 HAVE_TIMEVAL
360 HAVE_TM_GMTOFF
361 HAVE_TM_ZONE
362 HAVE_TOUCHLOCK
363 HAVE_TZNAME
364 HAVE_TZSET
365 HAVE_UNSIGNED_LONG_LONG_INT
366 HAVE_UTIL_H
367 HAVE_UTIMENSAT
368 HAVE_UTIMES
369 HAVE_UTIME_H
370 HAVE_UTMP_H
371 HAVE_VFORK
372 HAVE_VFORK_H
373 HAVE_WCHAR_H
374 HAVE_WCHAR_T
375 HAVE_WINDOW_SYSTEM
376 HAVE_WINSOCK2_H
377 HAVE_WORKING_FORK
378 HAVE_WORKING_UTIMES
379 HAVE_WORKING_VFORK
380 HAVE_WS2TCPIP_H
381 HAVE_XAW3D
382 HAVE_XFT
383 HAVE_XIM
384 HAVE_XKBGETKEYBOARD
385 HAVE_XPM
386 HAVE_XRMSETDATABASE
387 HAVE_XSCREENNUMBEROFSCREEN
388 HAVE_XSCREENRESOURCESTRING
389 HAVE_X_I18N
390 HAVE_X_MENU
391 HAVE_X_SM
392 HAVE_X_WINDOWS
393 HAVE__BOOL
394 HAVE__FTIME
395 HAVE___BUILTIN_UNWIND_INIT
396 HAVE___EXECUTABLE_START
397 HAVE___FPENDING
398 INTERNAL_TERMINAL
399 IS_ANY_SEP
400 IS_DIRECTORY_SEP
401 LOCALTIME_CACHE
402 MAIL_USE_FLOCK
403 MAIL_USE_LOCKF
404 MAIL_USE_POP
405 MAIL_USE_SYSTEM_LOCK
406 MAXPATHLEN
407 NLIST_STRUCT
408 NO_EDITRES
409 NSIG
410 NSIG_MINIMUM
411 NULL_DEVICE
412 ORDINARY_LINK
413 PAGESIZE
414 PREFER_VSUSP
415 PTY_ITERATION
416 PTY_NAME_SPRINTF
417 PTY_OPEN
418 PTY_TTY_NAME_SPRINTF
419 PURESIZE
420 RUN_TIME_REMAP
421 SETUP_SLAVE_PTY
422 SIGNALS_VIA_CHARACTERS
423 STDC_HEADERS
424 SYSTEM_PURESIZE_EXTRA
425 SYSTEM_MALLOC
426 TAB3
427 TABDLY
428 TERM
429 TIME_WITH_SYS_TIME
430 TIOCSIGSEND
431 TM_IN_SYS_TIME
432 UNIX98_PTYS
433 USE_TOOLKIT_SCROLL_BARS
434 USG_SUBTTY_WORKS
435 VALBITS
436 XOS_NEEDS_TIME_H
437 _FILE_OFFSET_BITS
438 _LP64
439 _longjmp
440 _setjmp
441 abort
442 alloca
443 close
444 emacs
445 free
446 gmtime
447 localtime
448 malloc
449 random
450 read
451 realloc
452 select
453 umask
454 vfork
455
456
457 src/sysdep.c:
458 write
459
460 src/syssignal.h:
461 signal
462 sigmask
463 sigsetmask
464
465
466 lib/dup2.c:
467 dup2
468
469 lib/signal.h:
470 signal
471
472 lib/stdio.h:
473 fdopen
474 fopen
475 fwrite
476 popen
477 rename
478
479 lib/stdlib.h:
480 calloc
481 srandom (conf_post.h may undo)
482
483 lib/strftime.c:
484 tzname
485 tzset
486
487 lib/sys/stat.h:
488 mkdir
489
490 lib/unistd.h:
491 chown
492 dup
493 dup2
494 ftruncate
495 isatty
496 link
497 lseek
498 pipe
499 rmdir
500 sleep
501 unlink
502
503
504 MS DOS stuff:
505
506 _NAIVE_DOS_REGS
507
508
509 MS stuff:
510
511 USE_CRT_DLL
512
513 ms-w32.h:
514 DebPrint
515 EMACSDEBUG
516 MUST_UNDEF__STDC__
517
518 _VARARGS_
519 _WINSOCKAPI_
520 _WINSOCK_H
521
522 access
523 calloc
524 chdir
525 chmod
526 chown
527 creat
528 ctime
529 dup
530 dup2
531 execlp
532 execvp (also emacsclient.c [WINDOWSNT])
533 fdopen
534 fileno
535 fopen
536 fsync
537 ftruncate
538 getdefdir
539 getdisk
540 getpid
541 isatty
542 kill
543 link
544 lseek
545 mkdir
546 mktemp
547 open
548 pclose
549 pipe
550 popen
551 rename
552 rmdir
553 signal
554 sleep
555 spawnve
556 strdup
557 stricmp
558 strnicmp
559 strupr
560 sys_nerr
561 tzname
562 tzset
563 umask
564 unlink
565 utimbuf
566 utime
567 wait (also movemail.c [WINDOWSNT])
568 write
569
570 lib-src/ntlib:
571 access
572 chdir
573 chmod
574 creat
575 dup
576 dup2
577 execlp
578 execvp
579 fdopen
580 fileno
581 fopen
582 getpid
583 index
584 isatty
585 lseek
586 mkdir
587 mktemp
588 open
589 pclose
590 pipe
591 popen
592 rmdir
593 rindex
594 sleep
595 umask
596 unlink
597 utime