Blame - Mac/Demo/building.html - platform/external/python/cpython3

blob: 48bb135f4d489831b2597c021182325a86da9fd9 [file] [log] [blame]

Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	1	<HTML>
				2	<HEAD>
				3	<TITLE>Building Mac Python from source</TITLE>
				4	</HEAD>
				5	<BODY>
				6	<H1>Building Mac Python from source</H1>
				7	<HR>
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	8
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	9	This document explains how to build MacPython from source. This is
				10	necessary if you want to write extension modules for 68K Python, and
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	11	is also necessary if you want to make modifications to the Python core.
				12	Building Python is not something to be undertaken lightly,
				13	you need a reasonable working
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	14	knowledge of the CodeWarrior development environment, a good net
				15	connection and probably quite some time too. <p>
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	16
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	17	The information density in this file is high, so you should probably
				18	print it and read it at your leasure. Most things are explained only
				19	once (and probably in the wrong place:-). <p>
				20
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	21	I am very interested in feedback on this document, send your
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	22	comments to the <A
				23	HREF="http://www.python.org/sigs/pythonmac-sig/">Mac Python Special
				24	Interest Group</A>.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	25
				26	<H2>What you need.</H2>
				27
				28	The following things you definitely need:
				29
				30	<UL>
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	31
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	32	<LI> You need a MacPython source distribution, of course. You can
Jack Jansen	9537586	1999-03-10 15:51:56 +0000	[diff] [blame^]	33	obtain one from <A HREF="ftp://ftp.cwi.nl/pub/jack/python/mac">
				34	ftp://ftp.cwi.nl/pub/jack/python/mac</A> or from the companion webpage
				35	at <A HREF="http://www.cwi.nl/~jack/macpython.html">
				36	http://www.cwi.nl/~jack/macpython.html</A> (which has up-to-date links
				37	to the other packages needed too) and possibly also from the standard
				38	<A HREF="ftp://ftp.python.org/pub/python/mac">python.org ftp
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	39	site</A>. Everything you need is also included in the standard Python
				40	source distribution, but the organization is different. Look in
				41	directory <code>Mac/mwerks/projects</code> for the project files and
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	42	related stuff. <BR>
				43
Jack Jansen	9537586	1999-03-10 15:51:56 +0000	[diff] [blame^]	44	If you are a <a href="http://www.python.org/psa">PSA</a> member, an
				45	alternative is to check the sources straight out of the CVS
				46	repository, see below. Most of the packages mentioned here are also
				47	available through CVS. Check the section on <a href="#cvs">CVS
				48	repository use</a> below.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	49
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	50	<LI> You need MetroWerks CodeWarrior. The current distribution has
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	51	been built with CodeWarrior Pro 4. Ordering information is
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	52	available on the <A HREF="http://www.metrowerks.com/">MetroWerks
Jack Jansen	a2139fe	1998-02-25 15:40:35 +0000	[diff] [blame]	53	homepage</A>. Building Python with MPW or Think/Symantec C is
				54	probably impossible without major surgery.
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	55
				56	<LI> You need GUSI, the Grand Unified Socket Interface, by Matthias
Jack Jansen	1473af7	1997-05-07 15:43:38 +0000	[diff] [blame]	57	Neeracher. The original CWGUSI is
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	58	obtainable from <A
Jack Jansen	f3dd5aa	1996-12-23 17:29:51 +0000	[diff] [blame]	59	HREF="ftp://sunsite.cnlab-switch.ch/software/platform/macos/src">
Jack Jansen	e66b8c8	1997-05-29 14:57:07 +0000	[diff] [blame]	60	ftp://sunsite.cnlab-switch.ch/software/platform/macos/src</A>.
Jack Jansen	3412c5d	1997-08-27 14:08:22 +0000	[diff] [blame]	61	At the moment Python is built with a slightly modified version of GUSI,
Jack Jansen	a598bc4	1999-02-10 23:08:24 +0000	[diff] [blame]	62	these modifications are available in folder <code>Python:Mac:GUSI-mods</code>. <br>
				63
				64	The modified GUSI is also in the MacPython cvs source repository, in the
				65	directory <code>lib-src/CWGUSI</code>. However, some files contain slashes in
				66	their names, something CVS seriously frowns upon, and each slash has been
				67	replaced by <code>"_s_"</code>. There is a script
				68	<code>Mac:scripts:fixgusidir.py</code> which you should run after checking CWGUSI
				69	out
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	70
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	71	</UL>
				72
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	73	<A NAME="optional">The MacPython project files are configured to
				74	include a plethora of optional modules</A>, and these modules need a
Jack Jansen	a2139fe	1998-02-25 15:40:35 +0000	[diff] [blame]	75	number of extra packages. To use the project files as-is you have to
Jack Jansen	27b10ec	1996-08-23 15:44:18 +0000	[diff] [blame]	76	download these packages too. PPC and CFM68K Python have all such modules as
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	77	dynamically loaded modules, so if you don't need a certain package it
Jack Jansen	27b10ec	1996-08-23 15:44:18 +0000	[diff] [blame]	78	suffices to just refrain from builing the extension module. For static 68K
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	79	Python things are a bit more complicated: you have to edit the
				80	interpreter project file to remove the reference to the module (and
Jack Jansen	27b10ec	1996-08-23 15:44:18 +0000	[diff] [blame]	81	the libraries it uses), and edit the <code>Mac:mwerks:mwerks_nonshared_config.h</code>
				82	file to remove the <code>USE_...</code> line. Here are the locations for the various things
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	83	you need:
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	84
				85	<UL>
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	86
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	87	<LI> Tcl and Tk can be obtained from <A
				88	HREF="ftp://ftp.smli.com/pub/tcl/mac/">ftp://ftp.smli.com/pub/tcl/mac/</A>.
Jack Jansen	44a8931	1997-12-23 22:56:25 +0000	[diff] [blame]	89	The current distributions, Tcl 8.0p2 and Tk 8.0p2 need a bit of work,
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	90	see the section on <A HREF="#tcltk">building Tcl/Tk Python</A>
				91	below. Get the "full source" distribution, which includes MoreFiles.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	92
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	93	<LI> Waste, a TextEdit replacement written by Marco Piovanelli, <A
				94	HREF="mailto:piovanel@kagi.com"><piovanel@kagi.com></A>. Python
Jack Jansen	a2139fe	1998-02-25 15:40:35 +0000	[diff] [blame]	95	was built using version 1.3, which you can obtain from <A
				96	HREF="http://www.boingo.com/waste"><http://www.boingo.com/waste></A>
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	97	and various other places.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	98
Jack Jansen	1473af7	1997-05-07 15:43:38 +0000	[diff] [blame]	99	<LI> Gdbm library for the Mac. Available from Jack's Mac software page at
				100	<A HREF="http://www.cwi.nl/~jack/macsoftware.html">
				101	http://www.cwi.nl/~jack/macsoftware.html</A> and <A HREF="ftp://ftp.cwi.nl/pub/jack/mac">
Jack Jansen	a598bc4	1999-02-10 23:08:24 +0000	[diff] [blame]	102	ftp://ftp.cwi.nl/pub/jack/mac</A>. Also in the MacPython cvs repository at
				103	<code>lib-src/gdbm</code>.
Jack Jansen	1473af7	1997-05-07 15:43:38 +0000	[diff] [blame]	104
				105	<LI> JPEG library by the Independent JPEG Group. A version including
				106	Mac projects can be found at Jack's page mentioned above.
				107	The most recent JPEG library can always be obtained from <A
Jack Jansen	a598bc4	1999-02-10 23:08:24 +0000	[diff] [blame]	108	HREF="ftp://ftp.uu.net/graphics/jpeg/">ftp://ftp.uu.net/graphics/jpeg/</A>. Again,
				109	also in the MacPython cvs repository at <code>lib-src/jpeg</code>.
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	110
Jack Jansen	1473af7	1997-05-07 15:43:38 +0000	[diff] [blame]	111	<LI> The netpbm/pbmplus, libtiff, zlib and png libraries. The netpbm distribution
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	112	(which includes libtiff) is generally available on Internet ftp
				113	servers. For Python pbmplus, an older incarnation of netpbm, is
				114	functionally identical to netpbm, since Python only uses the library
				115	and not the complete applications. A distribution with correct
Jack Jansen	1473af7	1997-05-07 15:43:38 +0000	[diff] [blame]	116	projects and library source only is available from, you guessed it, Jack's Mac software
Jack Jansen	a598bc4	1999-02-10 23:08:24 +0000	[diff] [blame]	117	page mentioned above. And, guessed it again, in the MacPython cvs repository
				118	at <code>lib-src/netpbm</code>, etc. The only gotcha is that libtiff lives in
				119	<code>lib-src/netpbm/libtiff</code>, for historical reasons.
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	120
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	121	</UL>
				122
				123	<H2>Setting Up</H2>
				124
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	125	Now that you have collected everything you should start with building
Jack Jansen	1473af7	1997-05-07 15:43:38 +0000	[diff] [blame]	126	the various parts. If you don't want to fix
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	127	access paths try to set things up as follows:
				128
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	129	<PRE>
				130	Top-level-folder:
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	131	CWGUSI
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	132	imglibs
Jack Jansen	de57030	1998-08-27 13:39:01 +0000	[diff] [blame]	133	jpeg
				134	netpbm
				135	libtiff
Jack Jansen	1473af7	1997-05-07 15:43:38 +0000	[diff] [blame]	136	zlib
Jack Jansen	de57030	1998-08-27 13:39:01 +0000	[diff] [blame]	137	png
Jack Jansen	1473af7	1997-05-07 15:43:38 +0000	[diff] [blame]	138	gdbm
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	139	Python
Jack Jansen	3261719	1997-08-19 14:01:16 +0000	[diff] [blame]	140	Tcl/Tk Folder
				141	tcl8.0
				142	tk8.0
Jack Jansen	a2139fe	1998-02-25 15:40:35 +0000	[diff] [blame]	143	MoreFiles 1.4.3
				144	Waste 1.3 distribution (if you want waste)
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	145	</PRE>
				146
Jack Jansen	de57030	1998-08-27 13:39:01 +0000	[diff] [blame]	147	If your setup of the libraries is exactly the same as mine (which is
				148	not very likely, unless you happen to work from the same CVS
				149	repository) you can use the project <code>buildlibs.prj</code> in the
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	150	<code>:Mac:build.mac</code> folder to build all needed libraries in one
Jack Jansen	de57030	1998-08-27 13:39:01 +0000	[diff] [blame]	151	fell swoop, otherwise you will have to build the libraries one by
				152	one. <p>
				153
Jack Jansen	1473af7	1997-05-07 15:43:38 +0000	[diff] [blame]	154	First build GUSI. If you didn't get the python-specific GUSI you have to
				155	move the files from the "CWGUSI-mods" to the right
Jack Jansen	3412c5d	1997-08-27 14:08:22 +0000	[diff] [blame]	156	place in the CWGUSI distribution folder. Build the MSL version for your
				157	platform (ppc, 68k, cfm68k). <p>
Jack Jansen	16e99c0	1996-09-07 17:11:26 +0000	[diff] [blame]	158
Jack Jansen	9537586	1999-03-10 15:51:56 +0000	[diff] [blame^]	159	<em>Note:</em> always rebuild the CWGUSI libraries, even if you have
				160	checked them out from the CVS repository. <P>
				161
Jack Jansen	16e99c0	1996-09-07 17:11:26 +0000	[diff] [blame]	162	Next, in
Jack Jansen	1473af7	1997-05-07 15:43:38 +0000	[diff] [blame]	163	<code>MoreFiles</code>, <code>libjpeg</code>, <code>pbmplus</code>,
				164	<code>zlib</code>, <code>libpng</code>, <code>gdbm</code>,
Jack Jansen	a2139fe	1998-02-25 15:40:35 +0000	[diff] [blame]	165	and<code>libtiff</code> you build all projects. Usually the projects are in "mac"
Jack Jansen	1473af7	1997-05-07 15:43:38 +0000	[diff] [blame]	166	subfolders, sometimes they are in the main folder. Tcl/tk is a special
Jack Jansen	27b10ec	1996-08-23 15:44:18 +0000	[diff] [blame]	167	case, see below. Of course, if you are only interested in one of
				168	static 68K, CFM68K or PPC you can skip building the other libraries.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	169
				170	<H2><A NAME="tcltk">Building Tcl/Tk</H2>
				171
Jack Jansen	3412c5d	1997-08-27 14:08:22 +0000	[diff] [blame]	172	You need to make some minor changes to the Tcl/Tk 8.0
				173	distribution. You should make the CW Pro projects (in the mac subfolders).
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	174	<UL>
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	175
Jack Jansen	3261719	1997-08-19 14:01:16 +0000	[diff] [blame]	176	<LI> There are no cfm68k targets. You make these by copying the 68k targets,
				177	setting the "68k target" to "cfm68k library" and changing the output filename,
				178	and changing the prefix
				179	header filename in the C/C++ settings panel to "MW_???HeaderCFM68K".
Jack Jansen	e66b8c8	1997-05-29 14:57:07 +0000	[diff] [blame]	180
Jack Jansen	3261719	1997-08-19 14:01:16 +0000	[diff] [blame]	181	<LI> I had to add Search.c (from MoreFiles) to the tcl library projects. I don't
				182	understand why this is, but it seemed to cure the problems I had.
Jack Jansen	f3dd5aa	1996-12-23 17:29:51 +0000	[diff] [blame]	183
				184	<LI> Note that if you use a different release of Tcl and Tk than the ones
				185	I have used you may have to adapt the Python <code>tkresources.rsrc</code> file.
				186	This is easiest done by building <code>SimpleTk</code> and copying the TEXT, ICON
				187	and CRSR resources from it to <code>tkresources.rsrc</code>. This allows
				188	the <code>_tkinter</code> module to work without an installed Tk/Tcl on your
				189	machine.
Jack Jansen	27b10ec	1996-08-23 15:44:18 +0000	[diff] [blame]	190
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	191	</UL>
				192
Jack Jansen	f3dd5aa	1996-12-23 17:29:51 +0000	[diff] [blame]	193	Build first the Tcl library, then
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	194	SimpleTcl (test it by typing <code>ls -l</code> in the window you get)
				195	then the Tk library, then SimpleTk (which can again be tested with
				196	<code>ls -l</code>). If this all worked you are all set to try
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	197	building Python.
				198
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	199	<H2>Building Waste</H2>
				200
				201	You do not need to build the Waste libraries, as Python includes the
Jack Jansen	a2139fe	1998-02-25 15:40:35 +0000	[diff] [blame]	202	source modules themselves.
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	203
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	204	<H2>The organization of the Python source tree</H2>
				205
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	206	Time for a short break, while we have a look at the organization of
				207	the Python source tree. At the top level, we find the following
				208	folders:
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	209
				210	<DL>
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	211	<DT> Demo
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	212	<DD> Demo programs that are not Mac-specific. Some of these may not
				213	work, the file <code>README-Mac</code> has some details.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	214
				215	<DT> Extensions
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	216	<DD> Extensions to the interpreter that are not Mac-specific. Contains
Jack Jansen	a598bc4	1999-02-10 23:08:24 +0000	[diff] [blame]	217	the <code>img</code>, <code>Imaging</code> and <code>Numeric</code> extensions
				218	in this distribution. Nowadays, the extensions are all built in their own
				219	folders (unlike in older distributions, where img was incorporated in the main
				220	build procedure).
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	221
				222	<DT> Grammar
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	223	<DD> The Python grammar. Included for reference only, you cannot build
				224	the parser on a Mac.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	225
				226	<DT> Include
				227	<DD> Machine-independent header files.
				228
				229	<DT> Modules
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	230	<DD> Machine-independent optional modules. Not all of these will work
				231	on the Mac.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	232
				233	<DT> Objects
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	234	<DD> Machine-independent code for various objects. Most of these are
				235	not really optional: the interpreter will not function without them.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	236
				237	<DT> Parser
				238	<DD> The Python parser (machine-independent).
				239
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	240	<DT> Python
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	241	<DD> The core interpreter. Most files are machine-independent, some
				242	are unix-specific and not used on the Mac.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	243
				244	<DT> Tools
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	245	<DD> Tools for python developers. Contains <code>modulator</code>
				246	which builds skeleton C extension modules and <code>bgen</code> which
				247	generates complete interface modules from information in C header
				248	files. There are some readme files, but more documentation is sorely
				249	needed.
				250
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	251	</DL>
				252
				253	All the mac-specific stuff lives in the <code>Mac</code> folder:
				254	<DL>
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	255	<DT> Build
				256	<DD> This is where the project files live and where you build the
				257	libraries, shared libraries, executables and plugin modules. All the
				258	resulting binaries, except for intermedeate results, are deposited in
Jack Jansen	a598bc4	1999-02-10 23:08:24 +0000	[diff] [blame]	259	the toplevel folder or the Mac:PlugIns folder (for plugin modules).
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	260
				261	<DT> Compat
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	262	<DD> Unix-compatability routines. Some of these are not used anymore,
				263	since CWGUSI provides a rather complete emulation, but you may need
				264	these if you are trying to build a non-GUSI python.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	265
				266	<DT> Demo
				267	<DD> Mac-specific demo programs, some of them annotated.
				268
				269	<DT> Include
				270	<DD> Mac-specific but compiler-independent include files.
				271
				272	<DT> Lib
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	273	<DD> Mac-specific standard modules. The <code>toolbox</code> folder
				274	contains modules specifically needed with various MacOS toolbox
				275	interface modules.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	276
				277	<DT> Modules
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	278	<DD> Mac-specific builtin modules. Theoretically these are all
				279	optional, but some are rather essential (like
				280	<code>macmodule</code>). A lot of these modules are generated with
				281	<code>bgen</code>, in which case the bgen input files are included so
				282	you can attempt to regenerate them or extend them.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	283
				284	<DT> MPW
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	285	<DD> MPW-specific files. These have not been used or kept up-to-date
				286	for a long time, so use at your own risk.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	287
				288	<DT> mwerks
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	289	<DD> Mwerks-specific sources and headers. Contains glue code for
				290	Pythons shared-library architecture, a replacement for
				291	<code>malloc</code> and a directory with various projects for building
				292	variations on the Python interpreter. The <code>mwerks_*.h</code>
				293	files here are the option-setting files for the various interpreters
				294	and such, comparable to the unix command-line <code>-D</code> options
				295	to the compiler. Each project uses the correct option file as its
				296	"prefix file" in the "C/C++ language" settings. Disabling optional
				297	modules (for the 68K interpreter), building non-GUSI interpreters and
				298	various other things are accomplished by modifying these files (and
				299	possibly changing the list of files included in the project window, of
				300	course).
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	301
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	302	<DT> PlugIns
				303	<DD> This is where the PPC and CFM68K dynamically-loaded plugin modules live.
				304
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	305	<DT> Python
				306	<DD> Mac-specific parts of the core interpreter.
				307
				308	<DT> Resources
				309	<DD> Resource files needed to build the interpreter.
				310
				311	<DT> Scripts
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	312	<DD> A collection of various mac-specific Python scripts. Some are
				313	essential, some are useful but few are documented, so you will have to
				314	use your imagination to work them out.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	315
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	316	<DT> Tools
				317	<DD> A collection of tools, usually bigger than those in the scripts
				318	folder. The important ones here are the IDE and macfreeze. The IDE is built
				319	with the buildIDE.py script, which puts the resulting applet in the toplevel
				320	folder. Macfreeze is usually invoked through the BuildApplication script,
				321	but for more control over the freezing process you can run the main script here.
				322
				323
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	324	<DT> Unsupported
				325	<DD> Modules that are not supported any longer but may still work with a little effort.
				326	</DL>
				327
				328	<H2>Building the 68K interpreter</H2>
				329
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	330	If you have all the optional libraries mentioned <A
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	331	HREF="#optional">above</A> loaded building Python for 68K macs is a
				332	breeze: in the Mac:Build folder you build the libraries with buildlibs.prj
				333	and then the interpreter with PythonStandalone.prj. <p>
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	334
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	335	If you were previously running another copy of this Python release,
				336	from a binary installer for instance, you should
				337	first remove the <code>Python XXX preferences</code> file from your
				338	preference folder. Next, run the interpreter, in the toplevel folder. This will
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	339	create a correct initial preferences file. You are now all set, and
				340	your tree should be completely compatible with a binary-only
				341	distribution. Read the release notes
				342	(<code>Relnotes-somethingorother</code>) and
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	343	<code>ReadMe</code> in the <code>Mac</code> folder. <p>
				344
				345	If something goes wrong you may end up with a garbled preferences file. Removing
				346	it from the system folder and running Python once again will re-create it.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	347
Jack Jansen	3412c5d	1997-08-27 14:08:22 +0000	[diff] [blame]	348	<H2>Building the PPC and CFM68K interpreter</H2>
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	349
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	350	First you optionally build the external libraries with buildlibs.prj. Next,
				351	the projects for
				352	interpreter, core library and applet skeleton are all linked together, so
Jack Jansen	3b80526	1999-02-14 23:12:06 +0000	[diff] [blame]	353	building the fat target in <code>PythonEngine.prj</code>
				354	will result in everything being built. The
Jack Jansen	3412c5d	1997-08-27 14:08:22 +0000	[diff] [blame]	355	resulting applications and fat shared library are deposited in the main
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	356	Python folder. Finally, you build all the plugins with the plugins.prj project.
				357
				358	For completeness sake here is a breakdown of the projects:
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	359
				360	<DL>
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	361
Jack Jansen	3412c5d	1997-08-27 14:08:22 +0000	[diff] [blame]	362	<DT> PythonCore (with subprojects PythonCorePPC and PythonCoreCFM68K)
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	363	<DD> The shared library that contains the bulk of the interpreter and
				364	its resources. It is a good idea to immedeately put an alias to this
				365	shared library in the <code>Extensions</code> folder of your system
				366	folder. Do exactly that: put an <em>alias</em> there, copying or
Jack Jansen	3412c5d	1997-08-27 14:08:22 +0000	[diff] [blame]	367	moving the file will cause you grief later if you rebuild the library and
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	368	forget to copy it to the extensions folder again. The InstallPython applet
				369	will also do this, along with creating the plugin aliases.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	370
Jack Jansen	3b80526	1999-02-14 23:12:06 +0000	[diff] [blame]	371	<DT> PythonInterpeter
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	372	<DD> The interpreter. This is basically a routine to call out to the
Jack Jansen	3b80526	1999-02-14 23:12:06 +0000	[diff] [blame]	373	shared library. Unlike in previous releases the same program is used for
				374	creating applets (for which formerly PythonApplet was used). <p>
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	375
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	376	<DT> Plugin projects
Jack Jansen	a598bc4	1999-02-10 23:08:24 +0000	[diff] [blame]	377	<DD> Each plugin module has a separate project. The <code>Plugins.prj</code>
				378	project tries to build them all, but is known to be flakey under CW Pro 4.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	379	</DL>
				380
Jack Jansen	3412c5d	1997-08-27 14:08:22 +0000	[diff] [blame]	381	After creating the alias to <code>PythonCore</code> you remove any old
Jack Jansen	061ac50	1996-10-22 15:27:56 +0000	[diff] [blame]	382	<code>Python XXX Preferences</code> file from the <code>Preferences</code> folder
				383	(if you had python installed on your system before) and run the interpreter once
Jack Jansen	3412c5d	1997-08-27 14:08:22 +0000	[diff] [blame]	384	to create the correct preferences file. <p>
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	385
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	386	Next, you have to build the extension modules.
				387	The <code>PlugIns.ppc</code> project has all the
Jack Jansen	a598bc4	1999-02-10 23:08:24 +0000	[diff] [blame]	388	other projects as subprojects and builds everything (but see the gotcha above).
				389	<p>
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	390
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	391	Finally, you must build the standard applets:
Jack Jansen	3412c5d	1997-08-27 14:08:22 +0000	[diff] [blame]	392	<code>EditPythonPrefs</code>, <code>BuildApplet</code>, etc. This is
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	393	easiest done with the <code>fullbuild</code> script from
Jack Jansen	3412c5d	1997-08-27 14:08:22 +0000	[diff] [blame]	394	<code>Mac:scripts</code>. <p>
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	395
				396	<BLOCKQUOTE>
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	397	Actually, the <code>fullbuild</code> script can be used to build
				398	everything, but you need a fully-functional interpreter before you can
				399	use it (and one that isn't rebuilt in the process: you cannot rebuild
				400	a running program). You could copy the 68K interpreter to a different
				401	place and use that to run fullbuild, or use the standalone PPC python
				402	for this. I tend to keep a standalone interpreter in a safe place for
Jack Jansen	e66b8c8	1997-05-29 14:57:07 +0000	[diff] [blame]	403	this use only. <p>
				404
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	405	</BLOCKQUOTE>
				406
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	407	You are all set now, and should read the release notes and
Jack Jansen	3412c5d	1997-08-27 14:08:22 +0000	[diff] [blame]	408	<code>ReadMe</code> file from the <code>Mac</code> folder.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	409
Jack Jansen	27b10ec	1996-08-23 15:44:18 +0000	[diff] [blame]	410	<H2>Rebuilding <code>.exp</code> files for PPC and CFM68K</H2>
				411
				412	Occasionally it may be necessary to rebuild your PythonCore <code>.exp</code>
				413	file, a file that controls which symbols are exported by your PythonCore
				414	shared library. Rebuild it if you get unexpected undefined symbols when you
				415	are building a plugin module. <p>
				416
				417	Rebuilding the .exp file is done by first removing the file and removing the
				418	reference to it in the project (in the "config" section). Next, build PythonCore.
				419	This will create a new .exp file. Edit this file to remove the references to
				420	the symbols <code>__initialize</code>, <code>__terminate</code>, <code>setjmp</code>,
Jack Jansen	1473af7	1997-05-07 15:43:38 +0000	[diff] [blame]	421	<code>longjmp</code>, <code>main</code> and (for PPC) <code>__ptmf_null</code> or (for
				422	CFM68K) <code>__start</code> and <code>dummy_init_routine</code>.
				423	Next, add the .exp file to the project
Jack Jansen	27b10ec	1996-08-23 15:44:18 +0000	[diff] [blame]	424	again and rebuild PythonCore. <p>
				425
				426	This rather convoluted procedure is needed to ensure that plugin modules don't
				427	accidentally link with those entrypoints from PythonCore, which will not work because
				428	those routines have to be in the same code fragment as they are used from.
				429
Jack Jansen	9537586	1999-03-10 15:51:56 +0000	[diff] [blame^]	430	<H2><a name="cvs">Using the CVS source archive</a></H2>
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	431
				432	It is possible to access the Python sources through remote CVS if you are
				433	a PSA member. The advantage of this is that you get the very latest sources,
				434	so any bug fixed or new features will be immedeately available. This is also
				435	the disadvantage, of course: as this is the same tree as is used for development it
				436	may sometimes be a little less stable. <p>
				437
				438	The CVS client of choice is Alexandre Parenteau's MacCVS. It can be
				439	obtained through the <a href="http://www.cyclic.com">Cyclic CVS homepage</a>. MacCVS
				440	uses Internet Config to set file types correctly based on the filename extension. In
				441	the maccvs preferences you should also set (in the "binary files" section)
				442	"use mac encoding: applesingle" and (in the "text files" section) "use ISO latin 1
				443	conversion". <p>
				444
Jack Jansen	9537586	1999-03-10 15:51:56 +0000	[diff] [blame^]	445	The machine-independent Python sources are checked out from the main
				446	Python CVS archive, see the <a href="http://www.python.org/psa">PSA
				447	homepage</a> for details. When you check the sources out you will get
				448	something like <code>Python:dist:src</code>, and under that the
				449	<code>Modules</code>, <code>Lib</code>, etc hierarchy. The
				450	<code>src</code> folder should be renamed to <code>Python</code>, and
				451	is what this document refers to as the "toplevel Python folder". <P>
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	452
Jack Jansen	9537586	1999-03-10 15:51:56 +0000	[diff] [blame^]	453	Next, within the toplevel Python folder, you check out the
				454	mac-specific sources in a Mac folder. The CVS path to use can be found
				455	at the <a href="http://www.cwi.nl/~jack/macpython.html">MacPython
				456	homepage</a>. Finally, you check out the external libraries needed in
				457	the parent of the Python folder. The CVS path for these libraries is
				458	also mentioned at the MacPython homepage. <p>
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	459
Jack Jansen	9537586	1999-03-10 15:51:56 +0000	[diff] [blame^]	460	Neither of the pages mentioned above contains the passwords for the
				461	CVS sites, for obvious reasons, but they do contain instructions on
				462	how to obtain the passwords. <p>
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	463
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	464	<H2>Odds and ends</H2>
				465
				466	Some remarks that I could not fit in elsewhere:
				467
				468	<UL>
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	469
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	470	<LI> It may be possible to use the <code>PythonCore</code> shared
				471	library to embed Python in another program, if your program can live
Jack Jansen	1473af7	1997-05-07 15:43:38 +0000	[diff] [blame]	472	with using GUSI for I/O. Use PythonCore in stead of your MSL C library
Jack Jansen	4c1e56c	1996-08-06 16:16:20 +0000	[diff] [blame]	473	(or, at the very least, link it before the normal C library). Let me
				474	know whether this works.
				475
				476	<LI> It is possible to build PPC extension modules without building a
Jack Jansen	c256ece	1999-02-03 13:09:27 +0000	[diff] [blame]	477	complete Python. The binary distribution installer can optionally install
				478	all the needed folders. A template for a dynamic module can be found in
Jack Jansen	3412c5d	1997-08-27 14:08:22 +0000	[diff] [blame]	479	<code>xx.prj</code>.
Jack Jansen	27b10ec	1996-08-23 15:44:18 +0000	[diff] [blame]	480
				481	<LI> The Python shared library architecture is a variant of the architecture
				482	described as "application with shared libraries and dropins" in the MetroWerks
				483	"Targeting MacOS" documentation. The Python Application and applet-template use
Jack Jansen	1473af7	1997-05-07 15:43:38 +0000	[diff] [blame]	484	the <code>MSL AppRuntime.Lib</code> runtime library (with properly set CFM
				485	initialization and termination routines). PythonCore uses <code>MSL Runtime.Lib</code>,
				486	which is really intended for standalone programs but which we fool into working by
				487	providing a dummy main program.
Jack Jansen	27b10ec	1996-08-23 15:44:18 +0000	[diff] [blame]	488	It is linked statically into PythonCore (and exported to the applications and plugins)
				489	so we do not have to distribute yet another shared library. Plugin modules use
Jack Jansen	1473af7	1997-05-07 15:43:38 +0000	[diff] [blame]	490	<code>MSL ShlibRuntime.Lib</code> (not the dropin runtime: modules are never unloaded)
				491	and obtain the rest from PythonCore. PythonCore uses a
Jack Jansen	27b10ec	1996-08-23 15:44:18 +0000	[diff] [blame]	492	non-standard initialization entry point, <code>__initialize_with_resources</code>, to
Jack Jansen	1473af7	1997-05-07 15:43:38 +0000	[diff] [blame]	493	be able to obtain resources from the library file later on. Plugins can do the same
				494	(_tkinter does) or use the standard <code>__initialize</code> entry point.
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	495
				496
Jack Jansen	6ad8d13	1997-01-15 16:53:37 +0000	[diff] [blame]	497	</UL>
Jack Jansen	8f2d802	1996-08-05 15:34:45 +0000	[diff] [blame]	498	</BODY>
				499	</HTML>