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