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
4 ** Distinguishing OSes **
5
6 CYGWIN Compiling the Cygwin port.
7 __CYGWIN__ Ditto
8 MSDOS Compiling the MS-DOS port.
9 __MSDOS__ Ditto.
10 __DJGPP_MINOR__ Minor version number of the DJGPP library; used only in msdos.c and dosfns.c.
11 DOS_NT Compiling for either the MS-DOS or native MS-Windows port.
12 WINDOWSNT Compiling the native MS-Windows (W32) port.
13 __MINGW32__ Compiling the W32 port with the MinGW port of GCC.
14 _MSC_VER Compiling the W32 port with the Microsoft C compiler.
15 DARWIN_OS Compiling on Mac OS X or pure Darwin (and using s/darwin.h).
16
17 ** Distinguishing GUIs **
18
19 HAVE_NTGUI Use the native W32 GUI for windows, frames, menus&scrollbars.
20 HAVE_NS Use the NeXT/OpenStep/Cocoa UI under Mac OS X or GNUstep.
21 NS_IMPL_GNUSTEP Compile support for GNUstep implementation of NS GUI API.
22 NS_IMPL_COCOA Compile support for Cocoa (Apple) implementation of NS GUI API.
23 HAVE_X11 Compile support for the X11 GUI.
24 HAVE_X_WINDOWS Compile support for X Window system
25 USE_LUCID Use the Lucid toolkit for menus&scrollbars. Requires HAVE_X11.
26 USE_MOTIF Use the Motif toolkit for menus&scrollbars. Requires HAVE_X11.
27 USE_GTK Use the Gtk toolkit for menus&scrollbars. Requires HAVE_X11.
28
29 ** Frame types **
30
31 FRAME_TERMCAP_P A tty (character terminal) frame.
32 FRAME_X_P A frame on X Window system.
33 FRAME_MSDOS_P An MS-DOS frame (used only by the DOS port).
34 FRAME_W32_P A frame using native MS-Windows GUI.
35 FRAME_WINDOW_P A GUI frame (like X, w32, etc.)
36
37 ** Support for accessing other processes on the system **
38
39 HAVE_PROCFS The /proc filesystem is supported.
40
41 ** Compile-time options **
42
43 REL_ALLOC Compile in the relocatable memory allocator ralloc.c.
44 SYSTEM_MALLOC Use the system library's malloc.
45 subprocesses System can use subprocesses (for M-x shell for example). Defined by default, only MSDOS undefines it.
46 USE_LISP_UNION_TYPE Define it in lisp.h to make Lisp_Object be a union type instead of the default int.
47
48 ** System specific macros, decribed in detail in src/s/template.h
49 BSTRING
50 CLASH_DETECTION
51 COFF
52 FIRST_PTY_LETTER
53 HAVE_PTYS
54 HAVE_TERMIO
55 HAVE_TERMIOS
56 INTERRUPT_INPUT
57 NARROWPROTO
58 SEPCHAR
59 SIGTYPE
60 SYSTEM_TYPE
61 USE_MMAP_FOR_BUFFERS
62
63 ** Machine specific macros, decribed in detail in src/m/template.h
64 CANNOT_DUMP
65 EXPLICIT_SIGN_EXTEND
66 LOAD_AVE_CVT
67 LOAD_AVE_TYPE
68 NO_REMAP
69 VIRT_ADDR_VARIES
70 WORDS_BIG_ENDIAN
71
72 ** Misc macros
73 USER_FULL_NAME If defined, overrides the default pw->pw_gecos for getting at the full user name. Only MSDOS overrides the default.
74
75 ** Replace, the definition is trivial: SWITCH_ENUM_CAST
76
77 ** Defines from src/m/*.h and src/s/*.h. Some of these might not be used in the code anymore, so they can be removed. The HAVE_* definitions are probably handled by autoconf, so it might be possible to just remove them from src/[sm]/*.h.
78
79
80 AIX
81 AMPERSAND_FULL_NAME
82 BCOPY_DOWNWARD_SAFE
83 BCOPY_UPWARD_SAFE
84 BITS_PER_EMACS_INT
85 BITS_PER_LONG
86 BITS_PER_CHAR
87 BITS_PER_SHORT
88 BITS_PER_INT
89 BROKEN_DATAGRAM_SOCKETS
90 BROKEN_FIONREAD
91 BROKEN_GET_CURRENT_DIR_NAME
92 BROKEN_NON_BLOCKING_CONNECT
93 BROKEN_PTY_READ_AFTER_EAGAIN
94 BROKEN_SA_RESTART
95 BROKEN_SIGAIO
96 BROKEN_SIGIO
97 BROKEN_SIGPOLL
98 BROKEN_SIGPTY
99 BSD4_2
100 BSD4_3
101 BSD_SYSTEM
102 CLASH_DETECTION
103 DATA_SEG_BITS
104 DATA_START
105 DBL_MIN_REPLACEMENT
106 DECLARE_GETPWUID_WITH_UID_T
107 DEFAULT_SOUND_DEVICE
108 DEVICE_SEP
109 DIRECTORY_SEP
110 DONT_REOPEN_PTY
111 DOUG_LEA_MALLOC
112 DebPrint
113 EMACSDEBUG
114 EMACS_CONFIGURATION
115 EMACS_CONFIG_OPTIONS
116 EMACS_INT
117 EMACS_UINT
118 FILE_SYSTEM_CASE
119 FLOAT_CHECK_DOMAIN
120 FSCALE
121 GAP_USE_BCOPY
122 GC_LISP_OBJECT_ALIGNMENT
123 GC_MARK_SECONDARY_STACK
124 GC_MARK_STACK
125 GC_SETJMP_WORKS
126 GMALLOC_INHIBIT_VALLOC
127 GNU_LIBRARY_PENDING_OUTPUT_COUNT
128 GNU_LINUX
129 GNU_MALLOC
130 HAVE_AIX_SMT_EXP
131 HAVE_ALLOCA
132 HAVE_BCMP
133 HAVE_BCOPY
134 HAVE_CBRT
135 HAVE_CLOSEDIR
136 HAVE_DUP2
137 HAVE_EUIDACCESS
138 HAVE_FMOD
139 HAVE_FPATHCONF
140 HAVE_FREXP
141 HAVE_FSYNC
142 HAVE_FTIME
143 HAVE_GETCWD
144 HAVE_GETDOMAINNAME
145 HAVE_GETHOSTNAME
146 HAVE_GETLOADAVG
147 HAVE_GETPAGESIZE
148 HAVE_GETPT
149 HAVE_GETTIMEOFDAY
150 HAVE_GETWD
151 HAVE_H_ERRNO
152 HAVE_INDEX
153 HAVE_INET_SOCKETS
154 HAVE_INVERSE_HYPERBOLIC
155 HAVE_LIBKSTAT
156 HAVE_LIMITS_H
157 HAVE_LINUX_VERSION_H
158 HAVE_LOGB
159 HAVE_LONG_FILE_NAMES
160 HAVE_LRAND48
161 HAVE_MENUS
162 HAVE_MKDIR
163 HAVE_MKTIME
164 HAVE_MOUSE
165 HAVE_PERROR
166 HAVE_PSTAT_GETDYNAMIC
167 HAVE_PWD_H
168 HAVE_RANDOM
169 HAVE_RENAME
170 HAVE_RES_INIT
171 HAVE_RINDEX
172 HAVE_RINT
173 HAVE_RMDIR
174 HAVE_SELECT
175 HAVE_SETLOCALE
176 HAVE_SETPGID
177 HAVE_SETRLIMIT
178 HAVE_SETSID
179 HAVE_SHUTDOWN
180 HAVE_SOCKETS
181 HAVE_SOUND
182 HAVE_STDLIB_H
183 HAVE_STRERROR
184 HAVE_STRFTIME
185 HAVE_STRING_H
186 HAVE_STRUCT_UTIMBUF
187 HAVE_SYSINFO
188 HAVE_SYSV_SIGPAUSE
189 HAVE_SYS_SELECT_H
190 HAVE_SYS_SYSTEMINFO_H
191 HAVE_SYS_TIMEB_H
192 HAVE_SYS_TIME_H
193 HAVE_TCATTR
194 HAVE_TERMIOS_H
195 HAVE_TEXT_START
196 HAVE_TIMEVAL
197 HAVE_TM_ZONE
198 HAVE_TZSET
199 HAVE_UNISTD_H
200 HAVE_UTIMES
201 HAVE_UTIME_H
202 HAVE_VOLATILE
203 HAVE_WINDOW_SYSTEM
204 HAVE_WORKING_VFORK
205 HAVE_XRMSETDATABASE
206 HPUX
207 INHIBIT_X11R6_XIM
208 INTERNAL_TERMINAL
209 IS_ANY_SEP
210 IS_DIRECTORY_SEP
211 KERNEL_FILE
212 LDAV_SYMBOL
213 LINKER
214 LINUX_VERSION_CODE
215 LISP_FLOAT_TYPE
216 LNOFLSH
217 LOCALTIME_CACHE
218 MAIL_USE_FLOCK
219 MAIL_USE_LOCKF
220 MAIL_USE_POP
221 MAIL_USE_SYSTEM_LOCK
222 MAXPATHLEN
223 MIN_PTY_KERNEL_VERSION -- only used on Mac
224 MODE_LINE_BINARY_TEXT
225 MUST_UNDEF__STDC__
226 NLIST_STRUCT
227 NOT_C_CODE
228 NO_ABORT
229 NO_EDITRES
230 NO_MATHERR
231 NO_TERMIO
232 NSIG
233 NSIG_MINIMUM
234 NULL
235 NULL_DEVICE
236 ORDINARY_LINK
237 O_APPEND
238 O_RDONLY
239 O_RDWR
240 PAGESIZE
241 PENDING_OUTPUT_COUNT
242 POSIX
243 PREFER_VSUSP
244 PTY_ITERATION
245 PTY_NAME_SPRINTF
246 PTY_OPEN
247 PTY_TTY_NAME_SPRINTF
248 PURESIZE
249 RUN_TIME_REMAP
250 SA_RESTART
251 SECTION_ALIGNMENT -- was only used by s/lynxos.h, maybe all code depending on it can be removed.
252 SEGMENT_MASK
253 SETPGRP_RELEASES_CTTY
254 SETUP_SLAVE_PTY
255 SIGALRM
256 SIGCHLD
257 SIGHUP
258 SIGKILL
259 SIGNALS_VIA_CHARACTERS
260 SIGPIPE
261 SIGQUIT
262 SIGTRAP
263 SIGTYPE
264 SOLARIS2
265 STDC_HEADERS
266 SYMS_SYSTEM
267 SYSTEM_PURESIZE_EXTRA
268 SYSTEM_MALLOC
269 SYSV_SYSTEM_DIR
270 TAB3
271 TABDLY
272 TERM
273 TEXT_START
274 THIS_IS_CONFIGURE
275 TIME_WITH_SYS_TIME
276 TIOCSIGSEND
277 TM_IN_SYS_TIME
278 ULIMIT_BREAK_VALUE
279 UNEXEC
280 UNIX98_PTYS
281 USE_CRT_DLL
282 USE_TOOLKIT_SCROLL_BARS
283 USG
284 USG5
285 USG5_4
286 USG_SUBTTY_WORKS
287 VALBITS
288 WORDS_BIG_ENDIAN
289 WRETCODE
290 XINT
291 XOS_NEEDS_TIME_H
292 XPNTR
293 XSET
294 XUINT
295 _AIX
296 _ARCH_PPC64
297 _CALLBACK_
298 _FILE_OFFSET_BITS
299 _LP64
300 _MALLOC_INTERNAL
301 _NAIVE_DOS_REGS
302 _VARARGS_
303 _WINSOCKAPI_
304 _WINSOCK_H
305 __ELF__
306 __FreeBSD__
307 __GNUC__
308 __GNU_LIBRARY__
309 __GNUC_MINOR__
310 __NetBSD__
311 __OpenBSD__
312 __STDC__
313 __arch64__
314 __cplusplus
315 __hpux
316 __ia64__
317 __linux__
318 __mc68000__
319 __mips__
320 _longjmp
321 _setjmp
322 _start
323 abort
324 access
325 alloca
326 bcmp
327 bcopy
328 brk
329 bzero
330 calloc
331 chdir
332 chmod
333 chown
334 close
335 const
336 creat
337 ctime
338 dup
339 dup2
340 edata
341 emacs
342 etext
343 execlp
344 execvp
345 fdopen
346 fileno
347 fopen
348 free
349 fsync
350 ftruncate
351 fwrite
352 getdefdir
353 getdisk
354 getenv
355 getpid
356 getuid
357 gmtime
358 i386
359 index
360 init_process
361 isatty
362 kill
363 link
364 linux
365 localtime
366 logb
367 lseek
368 m68k
369 malloc
370 mkdir
371 mktemp
372 open
373 pclose
374 pipe
375 popen
376 random
377 read
378 realloc
379 rename
380 rindex
381 rmdir
382 sbrk
383 select
384 sigmask
385 signal
386 sigsetmask
387 sleep
388 spawnve
389 srandom
390 strdup
391 strerror
392 stricmp
393 strnicmp
394 strupr
395 sys_nerr
396 system
397 temacs
398 tzname
399 tzset
400 umask
401 unix
402 unlink
403 utimbuf
404 utime
405 vfork
406 wait
407 write
408 xfree
409
410 # arch-tag: bc80061a-1168-4911-9766-46aaf2640250