Move directory-abbrev-alist doc from Lispref to Emacs manual.
[emacs.git] / src / s / darwin.h
blob2b0addbef0859e56d094bc988d36575bae9701b1
1 /* System description header file for Darwin (Mac OS X).
2 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007,
3 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 * Define symbols to identify the version of Unix this is.
23 * Define all the symbols that apply correctly.
26 #define BSD4_2
27 /* BSD4_3 and BSD4_4 are already defined in sys/param.h */
28 #define BSD_SYSTEM
30 /* More specific than the above two. We cannot use __APPLE__ as this
31 may not be defined on non-OSX Darwin, and we cannot define DARWIN
32 here because Panther and lower CoreFoundation.h uses DARWIN to
33 distinguish OS X from pure Darwin. */
35 #define DARWIN_OS
38 /* SYSTEM_TYPE should indicate the kind of system you are using.
39 It sets the Lisp variable system-type. */
41 #define SYSTEM_TYPE "darwin"
43 /* Emacs can read input using SIGIO and buffering characters itself,
44 or using CBREAK mode and making C-g cause SIGINT.
45 The choice is controlled by the variable interrupt_input.
47 Define INTERRUPT_INPUT to make interrupt_input = 1 the default (use SIGIO)
49 Emacs uses the presence or absence of the SIGIO and BROKEN_SIGIO macros
50 to indicate whether or not signal-driven I/O is possible. It uses
51 INTERRUPT_INPUT to decide whether to use it by default.
53 SIGIO can be used only on systems that implement it (4.2 and 4.3).
54 CBREAK mode has two disadvantages
55 1) At least in 4.2, it is impossible to handle the Meta key properly.
56 I hear that in system V this problem does not exist.
57 2) Control-G causes output to be discarded.
58 I do not know whether this can be fixed in system V.
60 Another method of doing input is planned but not implemented.
61 It would have Emacs fork off a separate process
62 to read the input and send it to the true Emacs process
63 through a pipe. */
65 #define INTERRUPT_INPUT
67 /* Letter to use in finding device name of first pty,
68 if system supports pty's. 'a' means it is /dev/ptya0 */
70 #define FIRST_PTY_LETTER 'p'
73 * Define HAVE_TERMIOS if the system provides POSIX-style
74 * functions and macros for terminal control.
76 * Define HAVE_TERMIO if the system provides sysV-style ioctls
77 * for terminal control.
79 * Do not define both. HAVE_TERMIOS is preferred, if it is
80 * supported on your system.
83 #define HAVE_TERMIOS
85 #define NO_TERMIO
88 * Define HAVE_PTYS if the system supports pty devices.
89 * Note: PTYs are broken on darwin <6. Use at your own risk.
92 #define HAVE_PTYS
93 /* Run only once. We need a `for'-loop because the code uses
94 `continue'. */
95 #define PTY_ITERATION for (i = 0; i < 1; i++)
96 #define PTY_NAME_SPRINTF /* none */
97 #define PTY_TTY_NAME_SPRINTF /* none */
98 /* Note that openpty may fork via grantpt on Mac OS X 10.4/Darwin 8.
99 But we don't have to block SIGCHLD because it is blocked in the
100 implementation of grantpt. */
101 #define PTY_OPEN \
102 do \
104 int slave; \
105 if (openpty (&fd, &slave, pty_name, NULL, NULL) == -1) \
106 fd = -1; \
107 else \
108 emacs_close (slave); \
110 while (0)
113 * PTYs only work correctly on Darwin 7 or higher. So make the
114 * default for process-connection-type dependent on the kernel
115 * version.
117 #define MIN_PTY_KERNEL_VERSION '7'
119 /* Define this symbol if your system has the functions bcopy, etc. */
121 #define BSTRING
123 /* define MAIL_USE_FLOCK if the mailer uses flock
124 to interlock access to /usr/spool/mail/$USER.
125 The alternative is that a lock file named
126 /usr/spool/mail/$USER.lock. */
128 #define MAIL_USE_FLOCK
130 /* Define CLASH_DETECTION if you want lock files to be written
131 so that Emacs can tell instantly when you try to modify
132 a file that someone else has modified in his Emacs. */
134 #define CLASH_DETECTION
136 /* Avoid the use of the name init_process (process.c) because it is
137 also the name of a Mach system call. */
138 #define init_process emacs_init_process
140 /* Used in dispnew.c. Copied from freebsd.h. */
141 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_p - (FILE)->_bf._base)
143 /* System uses OXTABS instead of the expected TAB3. (Copied from
144 bsd386.h.) */
145 #define TAB3 OXTABS
147 /* Darwin ld insists on the use of malloc routines in the System
148 framework. */
149 #define SYSTEM_MALLOC
151 /* Define HAVE_SOCKETS if system supports 4.2-compatible sockets. */
152 #define HAVE_SOCKETS
154 /* Definitions for how to dump. Copied from nextstep.h. */
156 #define UNEXEC unexmacosx.o
158 #define START_FILES pre-crt0.o
160 /* start_of_text isn't actually used, so make it compile without error. */
161 #define TEXT_START (0)
163 /* Definitions for how to compile & link. */
165 #ifdef HAVE_NS
166 #define LIBS_NSGUI -framework AppKit
167 #define SYSTEM_PURESIZE_EXTRA 200000
168 #define HEADERPAD_EXTRA 6C8
169 #else /* !HAVE_NS */
170 #define LIBS_NSGUI
171 #define HEADERPAD_EXTRA 690
172 #endif /* !HAVE_NS */
174 /* On Darwin, res_init appears not to be useful: see bug#562 and
175 http://lists.gnu.org/archive/html/emacs-devel/2007-11/msg01467.html */
177 #undef HAVE_RES_INIT
178 #undef HAVE_LIBRESOLV
180 /* The -headerpad option tells ld (see man page) to leave room at the
181 end of the header for adding load commands. Needed for dumping.
182 0x690 is the total size of 30 segment load commands (at 56
183 each); under Cocoa 31 commands are required. */
184 #define LD_SWITCH_SYSTEM_TEMACS -prebind LIBS_NSGUI -Xlinker -headerpad -Xlinker HEADERPAD_EXTRA
186 #define C_SWITCH_SYSTEM_TEMACS -Dtemacs
188 #ifdef temacs
189 #define malloc unexec_malloc
190 #define realloc unexec_realloc
191 #define free unexec_free
192 /* Don't use posix_memalign because it is not compatible with
193 unexmacosx.c. */
194 #undef HAVE_POSIX_MEMALIGN
195 #endif
197 /* The ncurses library has been moved out of the System framework in
198 Mac OS X 10.2. So if ./configure detects it, set the command-line
199 option to use it. */
200 #ifdef HAVE_LIBNCURSES
201 #define LIBS_TERMCAP -lncurses
202 /* This prevents crashes when running Emacs in Terminal.app under
203 10.2. */
204 #define TERMINFO
205 #endif
207 /* Link this program just by running cc. */
208 #define ORDINARY_LINK
210 /* We don't have a g library, so override the -lg LIBS_DEBUG switch. */
211 #define LIBS_DEBUG
213 /* Adding -lm confuses the dynamic linker, so omit it. */
214 #define LIB_MATH
216 /* Define the following so emacs symbols will not conflict with those
217 in the System framework. Otherwise -prebind will not work. */
219 /* Do not define abort in emacs.c. */
220 #define NO_ABORT
222 /* Do not define matherr in floatfns.c. */
223 #define NO_MATHERR
225 /* The following solves the problem that Emacs hangs when evaluating
226 (make-comint "test0" "/nodir/nofile" nil "") when /nodir/nofile
227 does not exist. Also, setsid is not allowed in the vfork child's
228 context as of Darwin 9/Mac OS X 10.5. */
229 #undef HAVE_WORKING_VFORK
230 #define vfork fork
232 /* Don't close pty in process.c to make it as controlling terminal.
233 It is already a controlling terminal of subprocess, because we did
234 ioctl TIOCSCTTY. */
235 #define DONT_REOPEN_PTY
237 /* This makes create_process in process.c save and restore signal
238 handlers correctly. Suggested by Nozomu Ando.*/
239 #define POSIX_SIGNALS
241 /* Use the GC_MAKE_GCPROS_NOOPS (see lisp.h) method for marking the
242 stack. */
243 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
245 /* arch-tag: 481d443d-4f89-43ea-b5fb-49706d95fa41
246 (do not change this comment) */