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

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