src/s/darwin.h

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