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. | |
8922df07 GM |
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 | ||
aa5fea59 SM |
7 | |
8 | ** Distinguishing OSes ** | |
9 | ||
8922df07 GM |
10 | AIX |
11 | _AIX | |
12 | BSD4_2 | |
13 | BSD_SYSTEM | |
aa5fea59 | 14 | CYGWIN Compiling the Cygwin port. |
077e3aa8 | 15 | __CYGWIN__ Ditto |
8922df07 GM |
16 | GNU_LINUX |
17 | HPUX | |
18 | IRIX6_5 | |
077e3aa8 EZ |
19 | MSDOS 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 |
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. | |
14145fa3 | 26 | DARWIN_OS Compiling on Mac OS X or pure Darwin (and using s/darwin.h). |
8922df07 GM |
27 | SOLARIS2 |
28 | USG | |
29 | USG5 | |
30 | USG5_4 | |
aa5fea59 SM |
31 | |
32 | ** Distinguishing GUIs ** | |
33 | ||
077e3aa8 | 34 | HAVE_NTGUI Use the native W32 GUI for windows, frames, menus&scrollbars. |
14145fa3 | 35 | HAVE_NS Use the NeXT/OpenStep/Cocoa UI under Mac OS X or GNUstep. |
d1a5744d | 36 | NS_IMPL_GNUSTEP Compile support for GNUstep implementation of NS GUI API. |
edfda783 | 37 | NS_IMPL_COCOA Compile support for Cocoa (Apple) implementation of NS GUI API. |
aa5fea59 | 38 | HAVE_X11 Compile support for the X11 GUI. |
077e3aa8 | 39 | HAVE_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.) | |
aa5fea59 SM |
43 | USE_LUCID Use the Lucid toolkit for menus&scrollbars. Requires HAVE_X11. |
44 | USE_MOTIF Use the Motif toolkit for menus&scrollbars. Requires HAVE_X11. | |
45 | USE_GTK Use the Gtk toolkit for menus&scrollbars. Requires HAVE_X11. | |
46 | ||
077e3aa8 EZ |
47 | ** Frame types ** |
48 | ||
49 | FRAME_TERMCAP_P A tty (character terminal) frame. | |
50 | FRAME_X_P A frame on X Window system. | |
51 | FRAME_MSDOS_P An MS-DOS frame (used only by the DOS port). | |
077e3aa8 EZ |
52 | FRAME_W32_P A frame using native MS-Windows GUI. |
53 | FRAME_WINDOW_P A GUI frame (like X, w32, etc.) | |
54 | ||
c3179b06 EZ |
55 | ** Support for accessing other processes on the system ** |
56 | ||
57 | HAVE_PROCFS The /proc filesystem is supported. | |
c3179b06 | 58 | |
077e3aa8 | 59 | ** Compile-time options ** |
c3179b06 | 60 | |
077e3aa8 EZ |
61 | REL_ALLOC Compile in the relocatable memory allocator ralloc.c. |
62 | SYSTEM_MALLOC Use the system library's malloc. | |
8922df07 GM |
63 | subprocesses System can use subprocesses (for M-x shell for example). |
64 | Defined by default, only MSDOS undefines it. | |
65 | DEBUG_LISP_OBJECT_TYPE Define it in lisp.h enable compile time checks | |
66 | on Lisp_Object use. | |
077e3aa8 | 67 | |
8922df07 | 68 | ** System specific macros |
0f21c005 DN |
69 | FIRST_PTY_LETTER |
70 | HAVE_PTYS | |
0f21c005 | 71 | INTERRUPT_INPUT |
0f21c005 | 72 | NARROWPROTO |
0f21c005 | 73 | SEPCHAR |
0f21c005 | 74 | SYSTEM_TYPE |
0f21c005 | 75 | |
2b5b9582 | 76 | ** Misc macros |
8922df07 GM |
77 | USER_FULL_NAME If defined, overrides the default pw->pw_gecos for |
78 | getting at the full user name. Only MSDOS overrides the default. | |
2b5b9582 | 79 | |
8922df07 GM |
80 | ** Miscellaneous defines. Some of these might not be used in the code |
81 | anymore, so they can be removed. | |
a0ce9ab7 | 82 | |
a0ce9ab7 | 83 | AMPERSAND_FULL_NAME |
a0ce9ab7 | 84 | BROKEN_DATAGRAM_SOCKETS |
f3041af1 | 85 | BROKEN_FIONREAD |
a0ce9ab7 DN |
86 | BROKEN_GET_CURRENT_DIR_NAME |
87 | BROKEN_NON_BLOCKING_CONNECT | |
88 | BROKEN_PTY_READ_AFTER_EAGAIN | |
89 | BROKEN_SA_RESTART | |
90 | BROKEN_SIGAIO | |
f3041af1 | 91 | BROKEN_SIGIO |
a0ce9ab7 DN |
92 | BROKEN_SIGPOLL |
93 | BROKEN_SIGPTY | |
d35e1cd7 | 94 | CLASH_DETECTION |
f3041af1 DN |
95 | DATA_SEG_BITS |
96 | DATA_START | |
a0ce9ab7 DN |
97 | DEFAULT_SOUND_DEVICE |
98 | DEVICE_SEP | |
99 | DIRECTORY_SEP | |
100 | DONT_REOPEN_PTY | |
a0ce9ab7 DN |
101 | DOUG_LEA_MALLOC |
102 | DebPrint | |
103 | EMACSDEBUG | |
104 | EMACS_CONFIGURATION | |
105 | EMACS_CONFIG_OPTIONS | |
106 | EMACS_INT | |
107 | EMACS_UINT | |
a0ce9ab7 | 108 | FLOAT_CHECK_DOMAIN |
a0ce9ab7 | 109 | GC_MARK_SECONDARY_STACK |
f3041af1 DN |
110 | GC_MARK_STACK |
111 | GC_SETJMP_WORKS | |
f3041af1 | 112 | GNU_MALLOC |
a0ce9ab7 | 113 | HAVE_AIX_SMT_EXP |
a0ce9ab7 | 114 | HAVE_CBRT |
f3041af1 | 115 | HAVE_CLOSEDIR |
a0ce9ab7 DN |
116 | HAVE_DUP2 |
117 | HAVE_EUIDACCESS | |
a0ce9ab7 DN |
118 | HAVE_FMOD |
119 | HAVE_FPATHCONF | |
120 | HAVE_FREXP | |
121 | HAVE_FSYNC | |
a0ce9ab7 | 122 | HAVE_GETCWD |
a0ce9ab7 DN |
123 | HAVE_GETHOSTNAME |
124 | HAVE_GETLOADAVG | |
125 | HAVE_GETPAGESIZE | |
126 | HAVE_GETPT | |
f3041af1 | 127 | HAVE_GETTIMEOFDAY |
a0ce9ab7 DN |
128 | HAVE_GETWD |
129 | HAVE_H_ERRNO | |
f3041af1 | 130 | HAVE_INET_SOCKETS |
a0ce9ab7 | 131 | HAVE_INVERSE_HYPERBOLIC |
a0ce9ab7 | 132 | HAVE_LIBKSTAT |
a0ce9ab7 DN |
133 | HAVE_LINUX_VERSION_H |
134 | HAVE_LOGB | |
135 | HAVE_LONG_FILE_NAMES | |
136 | HAVE_LRAND48 | |
137 | HAVE_MENUS | |
a0ce9ab7 | 138 | HAVE_MOUSE |
a0ce9ab7 | 139 | HAVE_PSTAT_GETDYNAMIC |
a0ce9ab7 DN |
140 | HAVE_PWD_H |
141 | HAVE_RANDOM | |
a0ce9ab7 | 142 | HAVE_RES_INIT |
a0ce9ab7 | 143 | HAVE_RINT |
f3041af1 | 144 | HAVE_SELECT |
a0ce9ab7 DN |
145 | HAVE_SETLOCALE |
146 | HAVE_SETPGID | |
147 | HAVE_SETRLIMIT | |
148 | HAVE_SETSID | |
149 | HAVE_SHUTDOWN | |
d35e1cd7 | 150 | HAVE_SOCKETS |
a0ce9ab7 DN |
151 | HAVE_SOUND |
152 | HAVE_STDLIB_H | |
f2a77c3a | 153 | HAVE_STRING_H |
a0ce9ab7 | 154 | HAVE_STRUCT_UTIMBUF |
a0ce9ab7 DN |
155 | HAVE_SYS_SELECT_H |
156 | HAVE_SYS_SYSTEMINFO_H | |
157 | HAVE_SYS_TIMEB_H | |
158 | HAVE_SYS_TIME_H | |
f3041af1 | 159 | HAVE_TCATTR |
a0ce9ab7 DN |
160 | HAVE_TM_ZONE |
161 | HAVE_TZSET | |
f3041af1 | 162 | HAVE_UNISTD_H |
a0ce9ab7 | 163 | HAVE_UTIME_H |
a0ce9ab7 DN |
164 | HAVE_WINDOW_SYSTEM |
165 | HAVE_WORKING_VFORK | |
166 | HAVE_XRMSETDATABASE | |
a0ce9ab7 | 167 | INTERNAL_TERMINAL |
a0ce9ab7 DN |
168 | IS_ANY_SEP |
169 | IS_DIRECTORY_SEP | |
a0ce9ab7 | 170 | LOCALTIME_CACHE |
1495e2fc | 171 | MAIL_USE_FLOCK |
a0ce9ab7 DN |
172 | MAIL_USE_LOCKF |
173 | MAIL_USE_POP | |
174 | MAIL_USE_SYSTEM_LOCK | |
175 | MAXPATHLEN | |
a0ce9ab7 | 176 | MUST_UNDEF__STDC__ |
f3041af1 | 177 | NLIST_STRUCT |
f2a77c3a | 178 | NO_ABORT |
a0ce9ab7 | 179 | NO_EDITRES |
a0ce9ab7 | 180 | NO_MATHERR |
f3041af1 | 181 | NO_TERMIO |
f3041af1 DN |
182 | NSIG |
183 | NSIG_MINIMUM | |
a0ce9ab7 | 184 | NULL_DEVICE |
f3041af1 | 185 | ORDINARY_LINK |
a0ce9ab7 DN |
186 | O_RDONLY |
187 | O_RDWR | |
a0ce9ab7 | 188 | PAGESIZE |
f3041af1 | 189 | PENDING_OUTPUT_COUNT |
f3041af1 DN |
190 | PREFER_VSUSP |
191 | PTY_ITERATION | |
d35e1cd7 | 192 | PTY_NAME_SPRINTF |
f3041af1 | 193 | PTY_OPEN |
d35e1cd7 | 194 | PTY_TTY_NAME_SPRINTF |
f3041af1 | 195 | PURESIZE |
f3041af1 | 196 | RUN_TIME_REMAP |
a0ce9ab7 | 197 | SA_RESTART |
a0ce9ab7 | 198 | SETPGRP_RELEASES_CTTY |
f3041af1 | 199 | SETUP_SLAVE_PTY |
a0ce9ab7 DN |
200 | SIGALRM |
201 | SIGCHLD | |
202 | SIGHUP | |
203 | SIGKILL | |
f3041af1 | 204 | SIGNALS_VIA_CHARACTERS |
a0ce9ab7 DN |
205 | SIGPIPE |
206 | SIGQUIT | |
207 | SIGTRAP | |
a0ce9ab7 | 208 | STDC_HEADERS |
a0ce9ab7 | 209 | SYSTEM_PURESIZE_EXTRA |
bbbac910 | 210 | SYSTEM_MALLOC |
f2a77c3a DN |
211 | TAB3 |
212 | TABDLY | |
a0ce9ab7 | 213 | TERM |
a0ce9ab7 DN |
214 | TIME_WITH_SYS_TIME |
215 | TIOCSIGSEND | |
216 | TM_IN_SYS_TIME | |
f3041af1 | 217 | ULIMIT_BREAK_VALUE |
a0ce9ab7 DN |
218 | UNIX98_PTYS |
219 | USE_CRT_DLL | |
a0ce9ab7 | 220 | USE_TOOLKIT_SCROLL_BARS |
a0ce9ab7 DN |
221 | USG_SUBTTY_WORKS |
222 | VALBITS | |
f2a77c3a | 223 | XOS_NEEDS_TIME_H |
a0ce9ab7 | 224 | _FILE_OFFSET_BITS |
a0ce9ab7 | 225 | _LP64 |
a0ce9ab7 DN |
226 | _NAIVE_DOS_REGS |
227 | _VARARGS_ | |
228 | _WINSOCKAPI_ | |
229 | _WINSOCK_H | |
f3041af1 DN |
230 | _longjmp |
231 | _setjmp | |
a0ce9ab7 DN |
232 | _start |
233 | abort | |
234 | access | |
f3041af1 | 235 | alloca |
a0ce9ab7 | 236 | brk |
a0ce9ab7 DN |
237 | calloc |
238 | chdir | |
239 | chmod | |
240 | chown | |
241 | close | |
a0ce9ab7 DN |
242 | creat |
243 | ctime | |
a0ce9ab7 DN |
244 | dup |
245 | dup2 | |
246 | edata | |
f3041af1 | 247 | emacs |
f3041af1 | 248 | etext |
a0ce9ab7 DN |
249 | execlp |
250 | execvp | |
a0ce9ab7 | 251 | fdopen |
a0ce9ab7 | 252 | fileno |
a0ce9ab7 | 253 | fopen |
a0ce9ab7 DN |
254 | free |
255 | fsync | |
256 | ftruncate | |
257 | fwrite | |
258 | getdefdir | |
259 | getdisk | |
260 | getenv | |
261 | getpid | |
262 | getuid | |
a0ce9ab7 | 263 | gmtime |
f3041af1 | 264 | index |
a0ce9ab7 DN |
265 | isatty |
266 | kill | |
267 | link | |
268 | linux | |
269 | localtime | |
270 | logb | |
271 | lseek | |
a0ce9ab7 | 272 | malloc |
a0ce9ab7 DN |
273 | mkdir |
274 | mktemp | |
275 | open | |
276 | pclose | |
277 | pipe | |
278 | popen | |
a0ce9ab7 DN |
279 | random |
280 | read | |
281 | realloc | |
282 | rename | |
283 | rindex | |
284 | rmdir | |
285 | sbrk | |
286 | select | |
287 | sigmask | |
288 | signal | |
289 | sigsetmask | |
290 | sleep | |
291 | spawnve | |
292 | srandom | |
a0ce9ab7 | 293 | strdup |
a0ce9ab7 DN |
294 | stricmp |
295 | strnicmp | |
296 | strupr | |
a0ce9ab7 DN |
297 | sys_nerr |
298 | system | |
299 | temacs | |
300 | tzname | |
301 | tzset | |
302 | umask | |
303 | unix | |
304 | unlink | |
305 | utimbuf | |
306 | utime | |
307 | vfork | |
308 | wait | |
309 | write | |
310 | xfree |