src/s/darwin.h

   1 /* System description header file for Darwin (Mac OS X).
   2    Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007,
   3                  2008 Free Software Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   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.
  11
  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.
  16
  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/>.  */
  19
  20
  21 /*
  22  *      Define symbols to identify the version of Unix this is.
  23  *      Define all the symbols that apply correctly.
  24  */
  25
  26 #define BSD4_2
  27 /* BSD4_3 and BSD4_4 are already defined in sys/param.h */
  28 /* #define BSD4_3 */
  29 /* #define BSD4_4 */
  30 #define BSD_SYSTEM
  31 /* #define VMS */
  32
  33 /* MAC_OS is used to conditionally compile code common to both MAC_OS8
  34    and MAC_OSX.  */
  35 #ifdef MAC_OSX
  36 #ifdef HAVE_CARBON
  37 #define MAC_OS
  38 /* We need a little extra space, see ../../lisp/loadup.el. */
  39 #define SYSTEM_PURESIZE_EXTRA 30000
  40
  41 #endif
  42 #endif
  43
  44 /* SYSTEM_TYPE should indicate the kind of system you are using.
  45  It sets the Lisp variable system-type.  */
  46
  47 #define SYSTEM_TYPE "darwin"
  48
  49 /* NOMULTIPLEJOBS should be defined if your system's shell
  50  does not have "job control" (the ability to stop a program,
  51  run some other program, then continue the first one).  */
  52
  53 /* #define NOMULTIPLEJOBS */
  54
  55 /* Emacs can read input using SIGIO and buffering characters itself,
  56    or using CBREAK mode and making C-g cause SIGINT.
  57    The choice is controlled by the variable interrupt_input.
  58
  59    Define INTERRUPT_INPUT to make interrupt_input = 1 the default (use SIGIO)
  60
  61    Emacs uses the presence or absence of the SIGIO and BROKEN_SIGIO macros
  62    to indicate whether or not signal-driven I/O is possible.  It uses
  63    INTERRUPT_INPUT to decide whether to use it by default.
  64
  65    SIGIO can be used only on systems that implement it (4.2 and 4.3).
  66    CBREAK mode has two disadvantages
  67      1) At least in 4.2, it is impossible to handle the Meta key properly.
  68         I hear that in system V this problem does not exist.
  69      2) Control-G causes output to be discarded.
  70         I do not know whether this can be fixed in system V.
  71
  72    Another method of doing input is planned but not implemented.
  73    It would have Emacs fork off a separate process
  74    to read the input and send it to the true Emacs process
  75    through a pipe. */
  76
  77 #define INTERRUPT_INPUT
  78
  79 /* Letter to use in finding device name of first pty,
  80   if system supports pty's.  'a' means it is /dev/ptya0  */
  81
  82 #define FIRST_PTY_LETTER 'p'
  83
  84 /*
  85  *      Define HAVE_TERMIOS if the system provides POSIX-style
  86  *      functions and macros for terminal control.
  87  *
  88  *      Define HAVE_TERMIO if the system provides sysV-style ioctls
  89  *      for terminal control.
  90  *
  91  *      Do not define both.  HAVE_TERMIOS is preferred, if it is
  92  *      supported on your system.
  93  */
  94
  95 #define HAVE_TERMIOS
  96 /* #define HAVE_TERMIO */
  97
  98 #define NO_TERMIO
  99
 100 /*
 101  *      Define HAVE_PTYS if the system supports pty devices.
 102  *      Note: PTYs are broken on darwin <6.  Use at your own risk.
 103  */
 104
 105 #define HAVE_PTYS
 106
 107 /**
 108  * PTYs only work correctly on Darwin 7 or higher.  So make the
 109  * default for process-connection-type dependent on the kernel
 110  * version.
 111  */
 112 #define MIN_PTY_KERNEL_VERSION '7'
 113
 114 /*
 115  *      Define NONSYSTEM_DIR_LIBRARY to make Emacs emulate
 116  *      The 4.2 opendir, etc., library functions.
 117  */
 118
 119 /* #define NONSYSTEM_DIR_LIBRARY */
 120
 121 /* Define this symbol if your system has the functions bcopy, etc. */
 122
 123 #define BSTRING
 124
 125 /* subprocesses should be defined if you want to
 126    have code for asynchronous subprocesses
 127    (as used in M-x compile and M-x shell).
 128    This is generally OS dependent, and not supported
 129    under most USG systems. */
 130
 131 #define subprocesses
 132
 133 /* If your system uses COFF (Common Object File Format) then define the
 134    preprocessor symbol "COFF". */
 135
 136 /* #define COFF */
 137
 138 /* define MAIL_USE_FLOCK if the mailer uses flock
 139    to interlock access to /usr/spool/mail/$USER.
 140    The alternative is that a lock file named
 141    /usr/spool/mail/$USER.lock.  */
 142
 143 #define MAIL_USE_FLOCK
 144
 145 /* Define CLASH_DETECTION if you want lock files to be written
 146    so that Emacs can tell instantly when you try to modify
 147    a file that someone else has modified in his Emacs.  */
 148
 149 #define CLASH_DETECTION
 150
 151 /* Define this if your operating system declares signal handlers to
 152    have a type other than the usual.  `The usual' is `void' for ANSI C
 153    systems (i.e. when the __STDC__ macro is defined), and `int' for
 154    pre-ANSI systems.  If you're using GCC on an older system, __STDC__
 155    will be defined, but the system's include files will still say that
 156    signal returns int or whatever; in situations like that, define
 157    this to be what the system's include files want.  */
 158 /* #define SIGTYPE int */
 159
 160 /* If the character used to separate elements of the executable path
 161    is not ':', #define this to be the appropriate character constant.  */
 162 /* #define SEPCHAR ':' */
 163
 164 /* Define this if the system can use mmap for buffer text allocation.  */
 165 /* #define USE_MMAP_FOR_BUFFERS 1 */
 166
 167 /* ============================================================ */
 168
 169 /* Here, add any special hacks needed
 170    to make Emacs work on this system.  For example,
 171    you might define certain system call names that don't
 172    exist on your system, or that do different things on
 173    your system and must be used only through an encapsulation
 174    (Which you should place, by convention, in sysdep.c).  */
 175
 176 /* Some compilers tend to put everything declared static
 177    into the initialized data area, which becomes pure after dumping Emacs.
 178    On these systems, you must #define static as nothing to foil this.
 179    Note that emacs carefully avoids static vars inside functions.  */
 180
 181 /* #define static */
 182
 183 /* If the system's imake configuration file defines `NeedWidePrototypes'
 184    as `NO', we must define NARROWPROTO manually.  Such a define is
 185    generated in the Makefile generated by `xmkmf'.  If we don't
 186    define NARROWPROTO, we will see the wrong function prototypes
 187    for X functions taking float or double parameters.  */
 188
 189 /*  #define NARROWPROTO 1 */
 190
 191 /* ============================================================ */
 192
 193 /* After adding support for a new system, modify the large case
 194    statement in the `configure' script to recognize reasonable
 195    configuration names, and add a description of the system to
 196    `etc/MACHINES'.
 197
 198    If you've just fixed a problem in an existing configuration file,
 199    you should also check `etc/MACHINES' to make sure its descriptions
 200    of known problems in that configuration should be updated.  */
 201
 202
 203 /* Avoid the use of the name init_process (process.c) because it is
 204    also the name of a Mach system call.  */
 205 #define init_process emacs_init_process
 206
 207 /* Used in dispnew.c.  Copied from freebsd.h. */
 208 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_p - (FILE)->_bf._base)
 209
 210 /* System uses OXTABS instead of the expected TAB3.  (Copied from
 211    bsd386.h.)  */
 212 #define TAB3 OXTABS
 213
 214 /* Darwin ld insists on the use of malloc routines in the System
 215    framework.  */
 216 #define SYSTEM_MALLOC
 217
 218 /* Define HAVE_SOCKETS if system supports 4.2-compatible sockets.  */
 219 #define HAVE_SOCKETS
 220
 221 /* In Carbon, asynchronous I/O (using SIGIO) can't be used for window
 222    events because they don't come from sockets, even though it works
 223    fine on tty's.  */
 224 /* This seems to help in Ctrl-G detection under Cocoa, however at the cost
 225    of some quirks that may or may not bother a given user. */
 226 #if defined (HAVE_CARBON) || defined (COCOA_EXPERIMENTAL_CTRL_G)
 227 #define NO_SOCK_SIGIO
 228 #endif
 229
 230 /* Extra initialization calls in main for Mac OS X system type.  */
 231 #ifdef HAVE_CARBON
 232 #define SYMS_SYSTEM syms_of_mac()
 233 #endif
 234
 235 /* Definitions for how to dump.  Copied from nextstep.h.  */
 236
 237 #define UNEXEC unexmacosx.o
 238
 239 #define START_FILES pre-crt0.o
 240
 241 /* start_of_text isn't actually used, so make it compile without error.  */
 242 #define TEXT_START (0)
 243
 244 /* This seems to be right for end_of_text, but it may not be used anyway.  */
 245 #define TEXT_END get_etext()
 246
 247 /* This seems to be right for end_of_data, but it may not be used anyway.  */
 248 #define DATA_END get_edata()
 249
 250 /* Definitions for how to compile & link.  */
 251
 252 /* This is for the Carbon port.  Under the NeXTstep port, this is still picked
 253    up during preprocessing, but is undone in config.in. */
 254 #ifndef HAVE_NS
 255 #define C_SWITCH_SYSTEM -fpascal-strings -DMAC_OSX
 256 #endif
 257
 258 /* Link in the Carbon or AppKit lib. */
 259 #ifdef HAVE_NS
 260 /* PENDING: lresolv is here because configure when testing #undefs res_init,
 261             a macro in /usr/include/resolv.h for res_9_init, not in stdc lib. */
 262 #define LIBS_MACGUI -framework AppKit -lresolv
 263 #define SYSTEM_PURESIZE_EXTRA 200000
 264 #define HEADERPAD_EXTRA 6C8
 265 #else
 266 #define HEADERPAD_EXTRA 690
 267
 268 #ifdef HAVE_CARBON
 269
 270 #ifdef HAVE_AVAILABILITYMACROS_H
 271 #include <AvailabilityMacros.h>
 272 #endif
 273
 274 /* Whether to use the Image I/O framework for reading images.  */
 275 #ifndef USE_MAC_IMAGE_IO
 276 #if MAC_OS_X_VERSION_MAX_ALLOWED >= 1040 && (MAC_OS_X_VERSION_MIN_REQUIRED >= 1040 || MAC_OS_X_VERSION_MIN_REQUIRED < 1020)
 277 #define USE_MAC_IMAGE_IO 1
 278 #endif
 279 #endif
 280
 281 /* If the Image I/O framework is not used, fall back on QuickTime.  */
 282 #if USE_MAC_IMAGE_IO
 283 #define LIBS_IMAGE
 284 #else
 285 #define LIBS_IMAGE -framework QuickTime
 286 #endif
 287
 288 #endif  /* HAVE_CARBON */
 289
 290 /* Link in the Carbon lib. */
 291 #ifdef HAVE_CARBON
 292 #define LIBS_MACGUI -framework Carbon LIBS_IMAGE
 293 #else
 294 #define LIBS_MACGUI
 295 #endif /* !HAVE_CARBON */
 296 #endif /* !HAVE_NS */
 297
 298 /* The -headerpad option tells ld (see man page) to leave room at the
 299    end of the header for adding load commands.  Needed for dumping.
 300    0x690 is the total size of 30 segment load commands (at 56
 301    each); under Cocoa 31 commands are required.  */
 302 #define LD_SWITCH_SYSTEM_TEMACS -prebind LIBS_MACGUI -Xlinker -headerpad -Xlinker HEADERPAD_EXTRA
 303
 304 #define C_SWITCH_SYSTEM_TEMACS -Dtemacs
 305
 306 /* The ncurses library has been moved out of the System framework in
 307    Mac OS X 10.2.  So if ./configure detects it, set the command-line
 308    option to use it.  */
 309 #ifdef HAVE_LIBNCURSES
 310 #define LIBS_TERMCAP -lncurses
 311 /* This prevents crashes when running Emacs in Terminal.app under
 312    10.2.  */
 313 #define TERMINFO
 314 #endif
 315
 316 /* Link this program just by running cc.  */
 317 #define ORDINARY_LINK
 318
 319 /* We don't have a g library, so override the -lg LIBS_DEBUG switch.  */
 320 #define LIBS_DEBUG
 321
 322 /* Adding -lm confuses the dynamic linker, so omit it.  */
 323 #define LIB_MATH
 324
 325 /* Tell src/Makefile.in to create files in the Mac OS X application
 326    bundle mac/Emacs.app.  */
 327 #ifdef HAVE_CARBON
 328 #define OTHER_FILES macosx-app
 329 #endif
 330
 331 /* PENDING: can this target be specified in a clearer way? */
 332 #ifdef HAVE_NS
 333 #define OTHER_FILES ns-app
 334 #endif
 335
 336
 337 /* Define the following so emacs symbols will not conflict with those
 338    in the System framework.  Otherwise -prebind will not work.  */
 339
 340 /* Do not define abort in emacs.c.  */
 341 #define NO_ABORT
 342
 343 /* Do not define matherr in floatfns.c.  */
 344 #define NO_MATHERR
 345
 346
 347 /* The following solves the problem that Emacs hangs when evaluating
 348    (make-comint "test0" "/nodir/nofile" nil "") when /nodir/nofile
 349    does not exist.  */
 350 #undef HAVE_WORKING_VFORK
 351 #define vfork fork
 352
 353 /* Don't close pty in process.c to make it as controlling terminal.
 354    It is already a controlling terminal of subprocess, because we did
 355    ioctl TIOCSCTTY.  */
 356 #define DONT_REOPEN_PTY
 357
 358 #ifdef temacs
 359 #define malloc unexec_malloc
 360 #define realloc unexec_realloc
 361 #define free unexec_free
 362 #endif
 363
 364 /* This makes create_process in process.c save and restore signal
 365    handlers correctly.  Suggested by Nozomu Ando.*/
 366 #define POSIX_SIGNALS
 367
 368 /* Reroute calls to SELECT to the version defined in mac.c to fix the
 369    problem of Emacs requiring an extra return to be typed to start
 370    working when started from the command line.  */
 371 #if defined (HAVE_CARBON) && (defined (emacs) || defined (temacs))
 372 #define select sys_select
 373 #endif
 374
 375 /* Use the GC_MAKE_GCPROS_NOOPS (see lisp.h) method for marking the
 376    stack.  */
 377 #define GC_MARK_STACK   GC_MAKE_GCPROS_NOOPS
 378
 379 /* arch-tag: 481d443d-4f89-43ea-b5fb-49706d95fa41
 380    (do not change this comment) */