[bpt/emacs.git] / src / s / darwin.h

/* System description header file for Darwin (Mac OS X).
   Copyright (C) 2001, 2002 Free Software Foundation, Inc.

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */


/*
 *	Define symbols to identify the version of Unix this is.
 *	Define all the symbols that apply correctly.
 */

/* #define UNIPLUS */
/* #define USG5 */
/* #define USG */
/* #define HPUX */
/* #define UMAX */
/* #define BSD4_1 */
#define BSD4_2
/* BSD4_3 and BSD4_4 are already defined in sys/param.h */
/* #define BSD4_3 */
/* #define BSD4_4 */
#define BSD_SYSTEM
/* #define VMS */

/* MAC_OS is used to conditionally compile code common to both MAC_OS8
   and MAC_OSX.  */
#ifdef MAC_OSX
#ifdef HAVE_CARBON
#define MAC_OS
#endif
#endif

/* SYSTEM_TYPE should indicate the kind of system you are using.
 It sets the Lisp variable system-type.  */

#define SYSTEM_TYPE "darwin"

/* NOMULTIPLEJOBS should be defined if your system's shell
 does not have "job control" (the ability to stop a program,
 run some other program, then continue the first one).  */

/* #define NOMULTIPLEJOBS */

/* Emacs can read input using SIGIO and buffering characters itself,
   or using CBREAK mode and making C-g cause SIGINT.
   The choice is controlled by the variable interrupt_input.

   Define INTERRUPT_INPUT to make interrupt_input = 1 the default (use SIGIO)

   Emacs uses the presence or absence of the SIGIO and BROKEN_SIGIO macros
   to indicate whether or not signal-driven I/O is possible.  It uses
   INTERRUPT_INPUT to decide whether to use it by default.

   SIGIO can be used only on systems that implement it (4.2 and 4.3).
   CBREAK mode has two disadvantages
     1) At least in 4.2, it is impossible to handle the Meta key properly.
        I hear that in system V this problem does not exist.
     2) Control-G causes output to be discarded.
        I do not know whether this can be fixed in system V.

   Another method of doing input is planned but not implemented.
   It would have Emacs fork off a separate process
   to read the input and send it to the true Emacs process
   through a pipe. */

#define INTERRUPT_INPUT

/* Letter to use in finding device name of first pty,
  if system supports pty's.  'a' means it is /dev/ptya0  */

#define FIRST_PTY_LETTER 'p'

/*
 *	Define HAVE_TERMIOS if the system provides POSIX-style
 *	functions and macros for terminal control.
 *
 *	Define HAVE_TERMIO if the system provides sysV-style ioctls
 *	for terminal control.
 *
 *	Do not define both.  HAVE_TERMIOS is preferred, if it is
 *	supported on your system.
 */

#define HAVE_TERMIOS
/* #define HAVE_TERMIO */

#define NO_TERMIO

/*
 *	Define HAVE_PTYS if the system supports pty devices.
 */

#define HAVE_PTYS

/*
 *	Define NONSYSTEM_DIR_LIBRARY to make Emacs emulate
 *      The 4.2 opendir, etc., library functions.
 */

/* #define NONSYSTEM_DIR_LIBRARY */

/* Define this symbol if your system has the functions bcopy, etc. */

#define BSTRING

/* subprocesses should be defined if you want to
   have code for asynchronous subprocesses
   (as used in M-x compile and M-x shell).
   This is generally OS dependent, and not supported
   under most USG systems. */

#define subprocesses

/* If your system uses COFF (Common Object File Format) then define the
   preprocessor symbol "COFF". */

/* #define COFF */

/* define MAIL_USE_FLOCK if the mailer uses flock
   to interlock access to /usr/spool/mail/$USER.
   The alternative is that a lock file named
   /usr/spool/mail/$USER.lock.  */

#define MAIL_USE_FLOCK

/* Define CLASH_DETECTION if you want lock files to be written
   so that Emacs can tell instantly when you try to modify
   a file that someone else has modified in his Emacs.  */

#define CLASH_DETECTION

/* Define this if your operating system declares signal handlers to
   have a type other than the usual.  `The usual' is `void' for ANSI C
   systems (i.e. when the __STDC__ macro is defined), and `int' for
   pre-ANSI systems.  If you're using GCC on an older system, __STDC__
   will be defined, but the system's include files will still say that
   signal returns int or whatever; in situations like that, define
   this to be what the system's include files want.  */
/* #define SIGTYPE int */

/* If the character used to separate elements of the executable path
   is not ':', #define this to be the appropriate character constant.  */
/* #define SEPCHAR ':' */

/* Define this if the system can use mmap for buffer text allocation.  */
/* #define USE_MMAP_FOR_BUFFERS 1 */

/* ============================================================ */

/* Here, add any special hacks needed
   to make Emacs work on this system.  For example,
   you might define certain system call names that don't
   exist on your system, or that do different things on
   your system and must be used only through an encapsulation
   (Which you should place, by convention, in sysdep.c).  */

/* Some compilers tend to put everything declared static
   into the initialized data area, which becomes pure after dumping Emacs.
   On these systems, you must #define static as nothing to foil this.
   Note that emacs carefully avoids static vars inside functions.  */

/* #define static */

/* If the system's imake configuration file defines `NeedWidePrototypes'
   as `NO', we must define NARROWPROTO manually.  Such a define is
   generated in the Makefile generated by `xmkmf'.  If we don't
   define NARROWPROTO, we will see the wrong function prototypes
   for X functions taking float or double parameters.  */

/*  #define NARROWPROTO 1 */

/* ============================================================ */

/* After adding support for a new system, modify the large case
   statement in the `configure' script to recognize reasonable
   configuration names, and add a description of the system to
   `etc/MACHINES'.

   If you've just fixed a problem in an existing configuration file,
   you should also check `etc/MACHINES' to make sure its descriptions
   of known problems in that configuration should be updated.  */


/* Avoid the use of the name init_process (process.c) because it is
   also the name of a Mach system call.  */
#define init_process emacs_init_process

/* Fix compilation problem for regex.c.  */
#define __restrict

/* Fix compilation problem for md5.c.  */
#define __attribute__(x)

/* Used in dispnew.c.  Copied from freebsd.h. */
#define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_p - (FILE)->_bf._base)

/* System uses OXTABS instead of the expected TAB3.  (Copied from
   bsd386.h.)  */
#define TAB3 OXTABS

/* Darwin ld insists on the use of malloc routines in the System
   framework.  */
#define SYSTEM_MALLOC

/* Define HAVE_SOCKETS if system supports 4.2-compatible sockets.  */
#define HAVE_SOCKETS

/* Extra initialization calls in main for Mac OS X system type.  */
#ifdef HAVE_CARBON
#define SYMS_SYSTEM syms_of_mac()
#endif

/* Definitions for how to dump.  Copied from nextstep.h.  */

#define UNEXEC unexmacosx.o

#define START_FILES pre-crt0.o

/* start_of_text isn't actually used, so make it compile without error.  */
#define TEXT_START (0)

/* This seems to be right for end_of_text, but it may not be used anyway.  */
#define TEXT_END get_etext()

/* This seems to be right for end_of_data, but it may not be used anyway.  */
#define DATA_END get_edata()

/* Definitions for how to compile & link.  */

/* Indicate that we are compiling for Mac OS X and where to find Mac
   specific headers.  */
#define C_SWITCH_SYSTEM -fpascal-strings -fno-common -DMAC_OSX -I../mac/src

/* Link in the Carbon lib.  The -headerpad option tells ld (see man
   page) to leave room at the end of the header for adding load
   commands.  Needed for dumping.  0x690 is the total size of 30
   segment load commands (at 56 each).  */
#define LD_SWITCH_SYSTEM_TEMACS -prebind -framework Carbon -lstdc++ -Xlinker -headerpad -Xlinker 690

#define C_SWITCH_SYSTEM_TEMACS -Dtemacs

/* The ncurses library has been moved out of the System framework in
   Mac OS X 10.2.  So if ./configure detects it, set the command-line
   option to use it.  */
#ifdef HAVE_LIBNCURSES
#define LIBS_TERMCAP -lncurses
/* This prevents crashes when running Emacs in Terminal.app under
   10.2.  */
#define TERMINFO
#endif

/* Link this program just by running cc.  */
#define ORDINARY_LINK

/* We don't have a g library, so override the -lg LIBS_DEBUG switch.  */
#define LIBS_DEBUG

/* Adding -lm confuses the dynamic linker, so omit it.  */
#define LIB_MATH

/* Tell src/Makefile.in to create files in the Mac OS X application
   bundle mac/Emacs.app.  */
#ifdef HAVE_CARBON
#define OTHER_FILES macosx-app
#endif


/* Define the following so emacs symbols will not conflict with those
   in the System framework.  Otherwise -prebind will not work.  */

/* Do not define abort in emacs.c.  */
#define NO_ABORT

/* Do not define matherr in floatfns.c.  */
#define NO_MATHERR


/* This prevents a compilation error in xfaces.c: struct kboard * is
   used in a function protocol the first time this type appears in the
   file, since MULTI_KBOARD is undefined for the Mac OS X build.  */
#ifndef NOT_C_CODE
struct kboard;
#endif

/* The following solves the problem that Emacs hangs when evaluating
   (make-comint "test0" "/nodir/nofile" nil "") when /nodir/nofile
   does not exist.  */
#undef HAVE_WORKING_VFORK
#define vfork fork
#define DONT_REOPEN_PTY

#ifdef temacs
#define malloc unexec_malloc
#define realloc unexec_realloc
#define free unexec_free
#endif

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