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. | |
10 | __DJGPP__ Major version number of the DJGPP library for the DOS port. | |
11 | __DJGPP_MINOR__ Minor version number of the DJGPP library. | |
12 | __GO32__ Compiling the DOS port with DJGPP v1.x (obsolete). | |
13 | DOS_NT Compiling for either the MS-DOS or native MS-Windows port. | |
14 | WINDOWSNT Compiling the native MS-Windows (W32) port. | |
15 | __MINGW32__ Compiling the W32 port with the MinGW port of GCC. | |
16 | _MSC_VER Compiling the W32 port with the Microsoft C compiler. | |
14145fa3 | 17 | DARWIN_OS Compiling on Mac OS X or pure Darwin (and using s/darwin.h). |
aa5fea59 SM |
18 | |
19 | ** Distinguishing GUIs ** | |
20 | ||
077e3aa8 | 21 | HAVE_NTGUI Use the native W32 GUI for windows, frames, menus&scrollbars. |
14145fa3 | 22 | HAVE_NS Use the NeXT/OpenStep/Cocoa UI under Mac OS X or GNUstep. |
d1a5744d | 23 | NS_IMPL_GNUSTEP Compile support for GNUstep implementation of NS GUI API. |
edfda783 | 24 | NS_IMPL_COCOA Compile support for Cocoa (Apple) implementation of NS GUI API. |
aa5fea59 | 25 | HAVE_X11 Compile support for the X11 GUI. |
077e3aa8 | 26 | HAVE_X_WINDOWS Compile support for X Window system |
aa5fea59 SM |
27 | X11 ?? Makefile.in suggests it's equivalent to HAVE_X11 |
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. | |
43 | LISTPROC A function that returns a list of PIDs of system processes. | |
44 | PROCATTR A function that returns attributes of a process. | |
45 | ||
077e3aa8 | 46 | ** Compile-time options ** |
c3179b06 | 47 | |
077e3aa8 EZ |
48 | REL_ALLOC Compile in the relocatable memory allocator ralloc.c. |
49 | SYSTEM_MALLOC Use the system library's malloc. | |
bbbac910 | 50 | subprocesses System can use subprocesses (for M-x shell for example). Defined by default, only MSDOS undefines it. |
14145fa3 | 51 | USE_LISP_UNION_TYPE Define it in lisp.h to make Lisp_Object be a union type instead of the default int. |
077e3aa8 | 52 | |
0f21c005 DN |
53 | ** System specific macros, decribed in detail in src/s/template.h |
54 | BSTRING | |
55 | CLASH_DETECTION | |
56 | COFF | |
57 | FIRST_PTY_LETTER | |
58 | HAVE_PTYS | |
59 | HAVE_TERMIO | |
60 | HAVE_TERMIOS | |
61 | INTERRUPT_INPUT | |
62 | MAIL_USE_FLOCK | |
63 | NARROWPROTO | |
64 | NOMULTIPLEJOBS | |
65 | SEPCHAR | |
66 | SIGTYPE | |
67 | SYSTEM_TYPE | |
68 | USE_MMAP_FOR_BUFFERS | |
69 | ||
70 | ** Machine specific macros, decribed in detail in src/m/template.h | |
71 | CANNOT_DUMP | |
72 | EXPLICIT_SIGN_EXTEND | |
73 | LOAD_AVE_CVT | |
74 | LOAD_AVE_TYPE | |
75 | NO_ARG_ARRAY | |
76 | NO_REMAP | |
77 | NO_SOCK_SIGIO | |
78 | VIRT_ADDR_VARIES | |
79 | WORDS_BIG_ENDIAN | |
80 | ||
2b5b9582 EZ |
81 | ** Misc macros |
82 | USER_FULL_NAME If defined, overrides the default pw->pw_gecos for getting at the full user name. Only MSDOS overrides the default. | |
83 | ||
4624371d | 84 | ** Replace, the definition is trivial: SWITCH_ENUM_CAST |
d35e1cd7 | 85 | |
a0ce9ab7 DN |
86 | ** 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. |
87 | ||
d35e1cd7 | 88 | |
a0ce9ab7 DN |
89 | AIX |
90 | AMPERSAND_FULL_NAME | |
a0ce9ab7 DN |
91 | BCOPY_DOWNWARD_SAFE |
92 | BCOPY_UPWARD_SAFE | |
93 | BITS_PER_EMACS_INT | |
94 | BITS_PER_LONG | |
95 | BROKEN_DATAGRAM_SOCKETS | |
f3041af1 | 96 | BROKEN_FIONREAD |
a0ce9ab7 DN |
97 | BROKEN_GET_CURRENT_DIR_NAME |
98 | BROKEN_NON_BLOCKING_CONNECT | |
99 | BROKEN_PTY_READ_AFTER_EAGAIN | |
100 | BROKEN_SA_RESTART | |
101 | BROKEN_SIGAIO | |
f3041af1 | 102 | BROKEN_SIGIO |
a0ce9ab7 DN |
103 | BROKEN_SIGPOLL |
104 | BROKEN_SIGPTY | |
a0ce9ab7 | 105 | BSD4_2 |
f3041af1 | 106 | BSD4_3 |
d35e1cd7 DN |
107 | BSD_PGRPS |
108 | BSD_SYSTEM | |
d35e1cd7 | 109 | CLASH_DETECTION |
f3041af1 | 110 | COFF_BSD_SYMBOLS |
d35e1cd7 | 111 | CRT0_DUMMIES |
f3041af1 | 112 | C_DEBUG_SWITCH |
f3041af1 DN |
113 | C_SWITCH_MACHINE |
114 | C_SWITCH_SYSTEM | |
a0ce9ab7 DN |
115 | C_SWITCH_SYSTEM_TEMACS |
116 | C_SWITCH_X_SYSTEM | |
f3041af1 DN |
117 | DATA_SEG_BITS |
118 | DATA_START | |
a0ce9ab7 | 119 | DBL_MIN_REPLACEMENT |
f3041af1 | 120 | DECLARE_GETPWUID_WITH_UID_T |
a0ce9ab7 DN |
121 | DEFAULT_SOUND_DEVICE |
122 | DEVICE_SEP | |
123 | DIRECTORY_SEP | |
124 | DONT_REOPEN_PTY | |
a0ce9ab7 DN |
125 | DOUG_LEA_MALLOC |
126 | DebPrint | |
127 | EMACSDEBUG | |
128 | EMACS_CONFIGURATION | |
129 | EMACS_CONFIG_OPTIONS | |
130 | EMACS_INT | |
131 | EMACS_UINT | |
132 | END_FILES_1 | |
a0ce9ab7 | 133 | FILE_SYSTEM_CASE |
a0ce9ab7 | 134 | FLOAT_CHECK_DOMAIN |
f3041af1 | 135 | FSCALE |
a0ce9ab7 DN |
136 | GAP_USE_BCOPY |
137 | GC_LISP_OBJECT_ALIGNMENT | |
138 | GC_MARK_SECONDARY_STACK | |
f3041af1 DN |
139 | GC_MARK_STACK |
140 | GC_SETJMP_WORKS | |
a0ce9ab7 DN |
141 | GMALLOC_INHIBIT_VALLOC |
142 | GNU_LIBRARY_PENDING_OUTPUT_COUNT | |
143 | GNU_LINUX | |
f3041af1 | 144 | GNU_MALLOC |
a0ce9ab7 | 145 | HAVE_AIX_SMT_EXP |
f3041af1 | 146 | HAVE_ALLOCA |
a0ce9ab7 DN |
147 | HAVE_BCMP |
148 | HAVE_BCOPY | |
149 | HAVE_CBRT | |
f3041af1 | 150 | HAVE_CLOSEDIR |
a0ce9ab7 | 151 | HAVE_CRTIN |
a0ce9ab7 DN |
152 | HAVE_DUP2 |
153 | HAVE_EUIDACCESS | |
a0ce9ab7 DN |
154 | HAVE_FMOD |
155 | HAVE_FPATHCONF | |
156 | HAVE_FREXP | |
157 | HAVE_FSYNC | |
158 | HAVE_FTIME | |
159 | HAVE_GETCWD | |
160 | HAVE_GETDOMAINNAME | |
161 | HAVE_GETHOSTNAME | |
162 | HAVE_GETLOADAVG | |
163 | HAVE_GETPAGESIZE | |
164 | HAVE_GETPT | |
f3041af1 | 165 | HAVE_GETTIMEOFDAY |
a0ce9ab7 DN |
166 | HAVE_GETWD |
167 | HAVE_H_ERRNO | |
168 | HAVE_INDEX | |
f3041af1 | 169 | HAVE_INET_SOCKETS |
a0ce9ab7 DN |
170 | HAVE_INVERSE_HYPERBOLIC |
171 | HAVE_LIB64_DIR | |
172 | HAVE_LIBKSTAT | |
173 | HAVE_LIBNCURSES | |
174 | HAVE_LIBPTHREADS | |
175 | HAVE_LIBXMU | |
176 | HAVE_LIMITS_H | |
177 | HAVE_LINUX_VERSION_H | |
178 | HAVE_LOGB | |
179 | HAVE_LONG_FILE_NAMES | |
180 | HAVE_LRAND48 | |
181 | HAVE_MENUS | |
182 | HAVE_MKDIR | |
183 | HAVE_MKTIME | |
184 | HAVE_MOUSE | |
185 | HAVE_PERROR | |
186 | HAVE_PSTAT_GETDYNAMIC | |
a0ce9ab7 DN |
187 | HAVE_PWD_H |
188 | HAVE_RANDOM | |
189 | HAVE_RENAME | |
190 | HAVE_RES_INIT | |
191 | HAVE_RINDEX | |
192 | HAVE_RINT | |
193 | HAVE_RMDIR | |
f3041af1 | 194 | HAVE_SELECT |
a0ce9ab7 DN |
195 | HAVE_SETLOCALE |
196 | HAVE_SETPGID | |
197 | HAVE_SETRLIMIT | |
198 | HAVE_SETSID | |
199 | HAVE_SHUTDOWN | |
d35e1cd7 | 200 | HAVE_SOCKETS |
a0ce9ab7 DN |
201 | HAVE_SOUND |
202 | HAVE_STDLIB_H | |
203 | HAVE_STRERROR | |
204 | HAVE_STRFTIME | |
f2a77c3a | 205 | HAVE_STRING_H |
a0ce9ab7 DN |
206 | HAVE_STRUCT_UTIMBUF |
207 | HAVE_SYSINFO | |
f3041af1 | 208 | HAVE_SYSV_SIGPAUSE |
a0ce9ab7 DN |
209 | HAVE_SYS_SELECT_H |
210 | HAVE_SYS_SYSTEMINFO_H | |
211 | HAVE_SYS_TIMEB_H | |
212 | HAVE_SYS_TIME_H | |
f3041af1 | 213 | HAVE_TCATTR |
a0ce9ab7 | 214 | HAVE_TERMIOS_H |
f3041af1 | 215 | HAVE_TEXT_START |
a0ce9ab7 DN |
216 | HAVE_TIMEVAL |
217 | HAVE_TM_ZONE | |
218 | HAVE_TZSET | |
f3041af1 | 219 | HAVE_UNISTD_H |
f3041af1 | 220 | HAVE_UTIMES |
a0ce9ab7 DN |
221 | HAVE_UTIME_H |
222 | HAVE_VOLATILE | |
a0ce9ab7 DN |
223 | HAVE_WINDOW_SYSTEM |
224 | HAVE_WORKING_VFORK | |
225 | HAVE_XRMSETDATABASE | |
226 | HPUX | |
a0ce9ab7 | 227 | IBMR2AIX |
f3041af1 | 228 | INHIBIT_X11R6_XIM |
a0ce9ab7 | 229 | INTERNAL_TERMINAL |
a0ce9ab7 DN |
230 | IS_ANY_SEP |
231 | IS_DIRECTORY_SEP | |
d35e1cd7 DN |
232 | KERNEL_FILE |
233 | LDAV_SYMBOL | |
f3041af1 | 234 | LD_SWITCH_MACHINE |
a0ce9ab7 | 235 | LD_SWITCH_MACHINE_TEMACS |
f3041af1 DN |
236 | LD_SWITCH_SYSTEM |
237 | LD_SWITCH_SYSTEM_TEMACS | |
a0ce9ab7 DN |
238 | LD_SWITCH_SYSTEM_tmp |
239 | LD_SWITCH_X_DEFAULT | |
d35e1cd7 | 240 | LIBS_DEBUG |
f3041af1 DN |
241 | LIBS_MACHINE |
242 | LIBS_SYSTEM | |
243 | LIBS_TERMCAP | |
f3041af1 DN |
244 | LIBX11_SYSTEM |
245 | LIBXMU | |
246 | LIB_GCC | |
a0ce9ab7 | 247 | LIB_MATH |
f3041af1 DN |
248 | LIB_MOTIF |
249 | LIB_STANDARD | |
f3041af1 | 250 | LINKER |
0176a259 | 251 | LINUX_VERSION_CODE |
a0ce9ab7 DN |
252 | LISP_FLOAT_TYPE |
253 | LNOFLSH | |
a0ce9ab7 | 254 | LOCALTIME_CACHE |
a0ce9ab7 DN |
255 | MAIL_USE_LOCKF |
256 | MAIL_USE_POP | |
257 | MAIL_USE_SYSTEM_LOCK | |
258 | MAXPATHLEN | |
c5e7567d | 259 | MIN_PTY_KERNEL_VERSION -- only used on Mac |
a0ce9ab7 | 260 | MODE_LINE_BINARY_TEXT |
a0ce9ab7 | 261 | MUST_UNDEF__STDC__ |
f2a77c3a | 262 | NEED_BSDTTY |
f3041af1 | 263 | NEED_ERRNO |
a0ce9ab7 | 264 | NEED_LIBW |
f2a77c3a | 265 | NEED_UNISTD_H |
f3041af1 | 266 | NLIST_STRUCT |
f3041af1 | 267 | NOT_C_CODE |
a0ce9ab7 | 268 | NOT_USING_MOTIF |
f2a77c3a | 269 | NO_ABORT |
0e4cd8de | 270 | NO_DIR_LIBRARY |
a0ce9ab7 | 271 | NO_EDITRES |
a0ce9ab7 | 272 | NO_MATHERR |
a0ce9ab7 | 273 | NO_SHARED_LIBS |
f3041af1 | 274 | NO_TERMIO |
f3041af1 DN |
275 | NSIG |
276 | NSIG_MINIMUM | |
a0ce9ab7 DN |
277 | NULL |
278 | NULL_DEVICE | |
f3041af1 | 279 | ORDINARY_LINK |
a0ce9ab7 DN |
280 | OTHER_FILES |
281 | O_APPEND | |
282 | O_BINARY | |
283 | O_CREAT | |
284 | O_EXCL | |
285 | O_RDONLY | |
286 | O_RDWR | |
287 | O_TEXT | |
288 | O_TRUNC | |
289 | O_WRONLY | |
290 | PAGESIZE | |
f3041af1 | 291 | PENDING_OUTPUT_COUNT |
a0ce9ab7 | 292 | POSIX |
f3041af1 DN |
293 | POSIX_SIGNALS |
294 | PREFER_VSUSP | |
295 | PTY_ITERATION | |
d35e1cd7 | 296 | PTY_NAME_SPRINTF |
f3041af1 | 297 | PTY_OPEN |
d35e1cd7 | 298 | PTY_TTY_NAME_SPRINTF |
f3041af1 | 299 | PURESIZE |
f3041af1 | 300 | RUN_TIME_REMAP |
a0ce9ab7 | 301 | SA_RESTART |
f3041af1 | 302 | SECTION_ALIGNMENT |
f3041af1 | 303 | SEGMENT_MASK |
a0ce9ab7 | 304 | SETPGRP_RELEASES_CTTY |
f3041af1 | 305 | SETUP_SLAVE_PTY |
a0ce9ab7 DN |
306 | SIGALRM |
307 | SIGCHLD | |
308 | SIGHUP | |
309 | SIGKILL | |
f3041af1 | 310 | SIGNALS_VIA_CHARACTERS |
a0ce9ab7 DN |
311 | SIGPIPE |
312 | SIGQUIT | |
313 | SIGTRAP | |
f3041af1 | 314 | SIGTYPE |
a0ce9ab7 | 315 | SOLARIS2 |
f3041af1 | 316 | START_FILES |
a0ce9ab7 DN |
317 | START_FILES_1 |
318 | STDC_HEADERS | |
319 | SYMS_SYSTEM | |
320 | SYSTEM_PURESIZE_EXTRA | |
bbbac910 | 321 | SYSTEM_MALLOC |
f3041af1 | 322 | SYSV_SYSTEM_DIR |
a0ce9ab7 | 323 | Srandom |
f2a77c3a DN |
324 | TAB3 |
325 | TABDLY | |
a0ce9ab7 | 326 | TERM |
f3041af1 | 327 | TERMINFO |
f3041af1 | 328 | TEXT_START |
a0ce9ab7 | 329 | THIS_IS_CONFIGURE |
f3041af1 | 330 | THIS_IS_MAKEFILE |
a0ce9ab7 DN |
331 | TIME_WITH_SYS_TIME |
332 | TIOCSIGSEND | |
333 | TM_IN_SYS_TIME | |
f3041af1 | 334 | ULIMIT_BREAK_VALUE |
f3041af1 | 335 | UNEXEC |
a0ce9ab7 DN |
336 | UNIX98_PTYS |
337 | USE_CRT_DLL | |
338 | USE_MAC_IMAGE_IO | |
a0ce9ab7 | 339 | USE_TOOLKIT_SCROLL_BARS |
f3041af1 DN |
340 | USG |
341 | USG5 | |
f3041af1 | 342 | USG5_4 |
a0ce9ab7 DN |
343 | USG_SUBTTY_WORKS |
344 | VALBITS | |
d35e1cd7 | 345 | WORDS_BIG_ENDIAN |
a0ce9ab7 | 346 | WRETCODE |
a0ce9ab7 | 347 | XINT |
f2a77c3a | 348 | XOS_NEEDS_TIME_H |
a0ce9ab7 DN |
349 | XPNTR |
350 | XSET | |
351 | XUINT | |
a0ce9ab7 DN |
352 | _AIX |
353 | _ARCH_PPC64 | |
354 | _CALLBACK_ | |
355 | _FILE_OFFSET_BITS | |
a0ce9ab7 DN |
356 | _LP64 |
357 | _MALLOC_INTERNAL | |
358 | _NAIVE_DOS_REGS | |
359 | _VARARGS_ | |
360 | _WINSOCKAPI_ | |
361 | _WINSOCK_H | |
362 | __ELF__ | |
363 | __FreeBSD__ | |
364 | __FreeBSD_version | |
365 | __GNUC__ | |
bbbac910 | 366 | __GNU_LIBRARY__ |
0176a259 | 367 | __GNUC_MINOR__ |
a0ce9ab7 DN |
368 | __NetBSD__ |
369 | __OpenBSD__ | |
370 | __STDC__ | |
371 | __arch64__ | |
372 | __cplusplus | |
373 | __hpux | |
374 | __ia64__ | |
375 | __linux__ | |
376 | __mc68000__ | |
377 | __mips__ | |
f3041af1 DN |
378 | _longjmp |
379 | _setjmp | |
a0ce9ab7 DN |
380 | _start |
381 | abort | |
382 | access | |
f3041af1 | 383 | alloca |
a0ce9ab7 DN |
384 | bcmp |
385 | bcopy | |
386 | brk | |
387 | bzero | |
388 | calloc | |
389 | chdir | |
390 | chmod | |
391 | chown | |
392 | close | |
393 | const | |
394 | creat | |
395 | ctime | |
a0ce9ab7 DN |
396 | dup |
397 | dup2 | |
398 | edata | |
f3041af1 | 399 | emacs |
f3041af1 | 400 | etext |
a0ce9ab7 DN |
401 | execlp |
402 | execvp | |
a0ce9ab7 | 403 | fdopen |
a0ce9ab7 | 404 | fileno |
a0ce9ab7 | 405 | fopen |
a0ce9ab7 DN |
406 | free |
407 | fsync | |
408 | ftruncate | |
409 | fwrite | |
410 | getdefdir | |
411 | getdisk | |
412 | getenv | |
413 | getpid | |
414 | getuid | |
a0ce9ab7 DN |
415 | gmtime |
416 | i386 | |
f3041af1 | 417 | index |
a0ce9ab7 DN |
418 | init_process |
419 | isatty | |
420 | kill | |
421 | link | |
422 | linux | |
423 | localtime | |
424 | logb | |
425 | lseek | |
f3041af1 | 426 | m68k |
a0ce9ab7 | 427 | malloc |
a0ce9ab7 DN |
428 | mkdir |
429 | mktemp | |
430 | open | |
431 | pclose | |
432 | pipe | |
433 | popen | |
a0ce9ab7 DN |
434 | random |
435 | read | |
436 | realloc | |
437 | rename | |
438 | rindex | |
439 | rmdir | |
440 | sbrk | |
441 | select | |
442 | sigmask | |
443 | signal | |
444 | sigsetmask | |
445 | sleep | |
446 | spawnve | |
447 | srandom | |
a0ce9ab7 DN |
448 | strdup |
449 | strerror | |
450 | stricmp | |
451 | strnicmp | |
452 | strupr | |
a0ce9ab7 DN |
453 | sys_nerr |
454 | system | |
455 | temacs | |
456 | tzname | |
457 | tzset | |
458 | umask | |
459 | unix | |
460 | unlink | |
461 | utimbuf | |
462 | utime | |
463 | vfork | |
464 | wait | |
465 | write | |
466 | xfree | |
d35e1cd7 | 467 | |
aa5fea59 | 468 | # arch-tag: bc80061a-1168-4911-9766-46aaf2640250 |