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