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

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