git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	<?xml version="1.0" encoding="iso-8859-1" ?>
	2	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	4	<head>
	5	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
	6	<meta name="generator" content="Docutils 0.4.1: http://docutils.sourceforge.net/" />
	7	<title>Building wxPython 2.8 for Development and Testing</title>
	8	<link rel="stylesheet" href="default.css" type="text/css" />
	9	</head>
	10	<body>
	11	<div class="document" id="building-wxpython-2-8-for-development-and-testing">
	12	<h1 class="title">Building wxPython 2.8 for Development and Testing</h1>
	13	<p>This file describes how I build wxWidgets and wxPython while doing
	14	development and testing, and is meant to help other people that want
	15	to do the same thing. I'll assume that you are using either a CVS
	16	snapshot from <a class="reference" href="http://wxWidgets.org/snapshots/">http://wxWidgets.org/snapshots/</a>, a checkout from CVS, or
	17	one of the released wxPython-src-2.8.* tarballs. I'll also assume that
	18	you know your way around your system, the compiler, etc. and most
	19	importantly, that you know what you are doing! ;-)</p>
	20	<p>If you want to also install the version of wxPython you build to be in
	21	your site-packages dir and be your default version of wxPython, then a
	22	few additional steps are needed, and you may want to use slightly
	23	different options. See the <a class="reference" href="INSTALL.html">INSTALL</a> document for more details. If
	24	you only use the instructions in this <a class="reference" href="BUILD.html">BUILD</a> document file then you
	25	will end up with a separate installation of wxPython and you can
	26	switch back and forth between this and the release version that you
	27	may already have installed.</p>
	28	<p>If you want to make changes to any of the <tt class="docutils literal"><span class="pre">*.i</span></tt> files, (SWIG
	29	interface definition files,) or to regenerate the extension sources or
	30	renamer modules, then you will need an up to date version of SWIG,
	31	plus some patches. Get the sources for version 1.3.29, and then apply
	32	the patches in wxPython/SWIG and then build SWIG like normal. See the
	33	README.txt in the wxPython/SWIG dir for details about each patch and
	34	also info about those that may already have been applied to the SWIG
	35	sources. If you install this build of SWIG to a location that is not
	36	on the PATH (so it doesn't interfere with an existing SWIG install for
	37	example) then you can use a setup.py command-line option named SWIG
	38	set to the full path name of the executable and the wxPython build will
	39	use it. See below for an example.</p>
	40	<p>In the text below I'll use WXDIR with environment variable syntax
	41	(either $WXDIR or %WXDIR%) to refer to the top level directory where
	42	your wxWidgets and wxPython sources are located. It will equate to
	43	whereever you checked out the wxWidgets module from CVS, or untarred
	44	the wxPython-src tarball to. You can either substitute the $WXDIR text
	45	below with your actual dir, or set the value in the environment and
	46	use it just like you see it below.</p>
	47	<p>If you run into what appears to be compatibility issues between
	48	wxWidgets and wxPython while building wxPython, be sure you are using
	49	the wxWidgets sources included with the wxPython-src tarball or the
	50	CVS snapshot, and not a previously installed version or a version
	51	installed from one of the standard wxWidgets installers. With the
	52	"unstable" releases (have a odd-numbered minor release value, where
	53	the APIs are allowed to change) there are often significant
	54	differences between the W.X.Y release of wxWidgets and the W.X.Y.Z
	55	release of wxPython.</p>
	56	<div class="section">
	57	<h1><a id="building-on-unix-like-systems-e-g-linux-and-os-x" name="building-on-unix-like-systems-e-g-linux-and-os-x">Building on Unix-like Systems (e.g. Linux and OS X)</a></h1>
	58	<p>These platforms are built almost the same way while in development
	59	so I'll combine the descriptions about their build process here.
	60	First we will build wxWidgets and install it to an out of the way
	61	place, then do the same for wxPython.</p>
	62	<ol class="arabic">
	63	<li><p class="first">Create a build directory in the main wxWidgets dir, and configure
	64	wxWidgets. If you want to have multiple builds with different
	65	configure options, just use different subdirectories. I normally
	66	put the configure command in a script named ".configure" in each
	67	build dir so I can easily blow away everything in the build dir and
	68	rerun the script without having to remember the options I used
	69	before:</p>
	70	<pre class="literal-block">
	71	cd $WXDIR
	72	mkdir bld
	73	cd bld
	74	../configure --prefix=/opt/wx/2.8 \
	75	--with-gtk \
	76	--with-gnomeprint \
	77	--with-opengl \
	78	--enable-debug \
	79	--enable-geometry \
	80	--enable-graphics_ctx \
	81	--enable-sound --with-sdl \
	82	--enable-mediactrl \
	83	--enable-display \
	84	--disable-debugreport \
	85	</pre>
	86	<p>On OS X of course you'll want to use --with-mac instead of
	87	--with-gtk and --with-gnomeprint.</p>
	88	<p>Notice that above I used a prefix option of "/opt/wx/2.8". You can
	89	use whatever path you want, such as a path in your HOME dir or even
	90	one of the standard prefix paths such as /usr or /usr/local if you
	91	like, but using /opt this way lets me easily have multiple versions
	92	and ports of wxWidgets "installed" and makes it easy to switch
	93	between them, without impacting any versions of wxWidgets that may
	94	have been installed via an RPM or whatever. For the rest of the
	95	steps below be sure to also substitute "/opt/wx/2.8" with whatever
	96	prefix you choose for your build.</p>
	97	<p><strong>NOTE</strong>: Due to a recent change there is currently a dependency
	98	problem in the multilib builds of wxWidgets on OSX, so I have
	99	switched to using a monolithic build. That means that all of the
	100	core wxWidgets code is placed in in one shared library instead of
	101	several. wxPython can be used with either mode, so use whatever
	102	suits you on Linux and etc. but use monolithic on OSX. To switch
	103	to the monolithic build of wxWidgets just add this configure flag:</p>
	104	<pre class="literal-block">
	105	--enable-monolithic \
	106	</pre>
	107	<p>By default GTK 2.x will be used for the build. If you would rather
	108	use GTK 1.2.x for some reason then you can force configure to use
	109	it by changing the --with-gtk flag to specify it like this:</p>
	110	<pre class="literal-block">
	111	--with-gtk=1 \
	112	</pre>
	113	<p>To make the wxWidgets build be unicode enabled (strongly
	114	recommended unless you are building with GTK1) then add the
	115	following flag. When wxPython is unicode enabled then all strings
	116	that are passed to wx functions and methods will first be converted
	117	to unicode objects, and any 'strings' returned from wx functions
	118	and methods will actually be unicode objects.:</p>
	119	<pre class="literal-block">
	120	--enable-unicode \
	121	</pre>
	122	<p>If you want to use the image and zlib libraries included with
	123	wxWidgets instead of those already installed on your system, (for
	124	example, to reduce dependencies on 3rd party libraries) then you
	125	can add these flags to the configure command:</p>
	126	<pre class="literal-block">
	127	--with-libjpeg=builtin \
	128	--with-libpng=builtin \
	129	--with-libtiff=builtin \
	130	--with-zlib=builtin \
	131	</pre>
	132	</li>
	133	<li><p class="first">To build and install wxWidgets you could just use the "make"
	134	command but there are a couple other libraries besides the main
	135	wxWidgets libs that also need to be built so again I make a script
	136	to do it all for me so I don't forget anything. This time it is
	137	called ".make" (I use the leading "." so when I do <tt class="docutils literal"><span class="pre">rm</span> <span class="pre">-r</span> <span class="pre">*</span></tt> in
	138	my build dir I don't lose my scripts too.) This is what it looks
	139	like:</p>
	140	<pre class="literal-block">
	141	make $* \
	142	&& make -C contrib/src/gizmos $* \
	143	&& make -C contrib/src/stc $*
	144	</pre>
	145	<p>So you just use .make as if it where make, but don't forget to set
	146	the execute bit on .make first!:</p>
	147	<pre class="literal-block">
	148	.make
	149	.make install
	150	</pre>
	151	<p>When it's done you should have an installed set of files under
	152	/opt/wx/2.8 containing just wxWidgets. Now to use this version of
	153	wxWidgets you just need to add /opt/wx/2.8/bin to the PATH and set
	154	LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on OS X) to /opt/wx/2.8/lib.</p>
	155	</li>
	156	<li><p class="first">I also have a script to help me build wxPython and it is checked in
	157	to the CVS as wxWidgets/wxPython/b, but you probably don't want to
	158	use it as it's very cryptic and expects that you want to run SWIG,
	159	so if you don't have the latest patched up version of SWIG then
	160	you'll probably get stuck. So in this document I'll just give the
	161	raw commands instead.</p>
	162	<p>We're not going to install the development version of wxPython with
	163	these commands, so it won't impact your already installed version
	164	of the latest release. You'll be able test with this version when
	165	you want to, and use the installed release version the rest of the
	166	time. If you want to install the development version please read
	167	INSTALL.txt.</p>
	168	<p>If you have more than one version of Python on your system then be
	169	sure to use the version of Python that you want to use when running
	170	wxPython programs to run the setup.py commands below. I'll be
	171	using python2.5.</p>
	172	<p>Make sure that the first wx-config found on the PATH is the one
	173	belonging to the wxWidgets that you installed above, and then
	174	change to the $WXDIR/wxPython dir and run the this command:</p>
	175	<pre class="literal-block">
	176	cd $WXDIR/wxPython
	177	python2.5 setup.py build_ext --inplace --debug
	178	</pre>
	179	<p>If your new wx-config script is not on the PATH, or there is some
	180	other version of it found first, then you can add this to the
	181	command line to ensure your new one is used instead:</p>
	182	<pre class="literal-block">
	183	WX_CONFIG=/opt/wx/2.8/bin/wx-config
	184	</pre>
	185	<p>By default setup.py will assume that you built wxWidgets to use
	186	GTK2. If you built wxWidgets to use GTK 1.2.x then you should add
	187	this flag to the command-line:</p>
	188	<pre class="literal-block">
	189	WXPORT=gtk
	190	</pre>
	191	<p>Setup.py will assume by default that you are using a unicode build
	192	of wxWidgets. If not then you can use this flag:</p>
	193	<pre class="literal-block">
	194	UNICODE=0
	195	</pre>
	196	<p>If you are wanting to have the source files regenerated with swig,
	197	(only neccessary if you make modifications to the <tt class="docutils literal"><span class="pre">*.i</span></tt> files,)
	198	then you need to turn on the USE_SWIG flag and optionally tell it
	199	where to find the new swig executable, so add these flags:</p>
	200	<pre class="literal-block">
	201	USE_SWIG=1 SWIG=/opt/swig/bin/swig
	202	</pre>
	203	<p>If you get errors about being unable to find libGLU, wxGLCanvas
	204	being undeclared, or something similar then you can add
	205	BUILD_GLCANVAS=0 to the setup.py command line to disable the
	206	building of the glcanvas module.</p>
	207	<p>When the setup.py command is done you should have a fully populated
	208	(but uninstalled) wx package located in your $WXDIR/wxPython/wx
	209	directory.</p>
	210	</li>
	211	<li><p class="first">To run code with the development version of wxPython, just set the
	212	PYTHONPATH to the wxPython dir located in the source tree. For
	213	example:</p>
	214	<pre class="literal-block">
	215	export LD_LIBRARY_PATH=/opt/wx/2.8/lib
	216	export PYTHONPATH=$WXDIR/wxPython
	217	cd $WXDIR/wxPython/demo
	218	python2.5 demo.py
	219	</pre>
	220	<p>OS X NOTE: Depending on your version of OS X and Python you may
	221	need to use "pythonw" on the command line to run wxPython
	222	applications. This version of the Python executable is part of the
	223	Python Framework and is allowed to interact with the display. You
	224	can also double click on a .py or a .pyw file from the finder
	225	(assuming that the PythonLauncher app is associated with these file
	226	extensions) and it will launch the Framework version of Python for
	227	you. For information about creating Applicaiton Bundles of your
	228	wxPython apps please see the wiki and the mail lists.</p>
	229	<p>SOLARIS NOTE: If you get unresolved symbol errors when importing
	230	wxPython and you are running on Solaris and building with gcc, then
	231	you may be able to work around the problem by uncommenting a bit of
	232	code in config.py and building again. Look for 'SunOS' in config.py
	233	and uncomment the block containing it. The problem is that Sun's ld
	234	does not automatically add libgcc to the link step.</p>
	235	</li>
	236	</ol>
	237	</div>
	238	<div class="section">
	239	<h1><a id="building-on-windows" name="building-on-windows">Building on Windows</a></h1>
	240	<p>The Windows builds currently require the use of Microsoft Visual C++.
	241	Theoretically, other compilers (such as mingw32 or the Borland
	242	compilers) can also be used but I've never done the work to make that
	243	happen. If you want to try that then first you'll want to find out if
	244	there are any tricks that have to be done to make Python extension
	245	modules using that compiler, and then make a few changes to setup.py
	246	to accommodate that. (And send the patches to me.)</p>
	247	<p>The standard Python 2.3 and earlier are built with MS Visual C 6.0 and
	248	so you must also build with MSVC 6 in order to be used with the stock
	249	python.exe. If you woudl rather use a different version of
	250	VisualStudio keep in mind that you'll also have to build Python and
	251	any other extension modules that you use with that compiler because a
	252	different version of the C runtime library is used. The stock Python
	253	2.4 and 2.5 executables are built with MSVC 7.1, and the same rules
	254	apply to it.</p>
	255	<p>If you want to build a debuggable version of wxWidgets and wxPython you
	256	will need to have also built a debug version of Python and any other
	257	extension modules you need to use. You can tell if you have them
	258	already if there is a _d in the file names, for example python_d.exe
	259	or python25_d.dll. If you don't need to trace through the C/C++ parts
	260	of the code with the debugger then building the normal (or hybrid)
	261	version is fine, and you can use the regular python executables with
	262	it.</p>
	263	<p>Starting with 2.5.3.0 wxPython can be built for either the monlithic
	264	or the multi-lib wxWidgets builds. (Monolithic means that all the
	265	core wxWidgets code is in one DLL, and multi-lib means that the core
	266	code is divided into multiple DLLs.) To select which one to use
	267	specify the MONOLITHIC flag for both the wxWidgets build and the
	268	wxPython build as shown below, setting it to either 0 or 1.</p>
	269	<p>Just like the unix versions I also use some scripts to help me build
	270	wxWidgets, but I use some non-standard stuff to do it. So if you have
	271	bash (cygwin or probably MSYS too) or 4NT plus unix-like cat and sed
	272	programs then there is a copy of my wxWidgets build scripts in
	273	%WXDIR%\wxPython\distrib\msw. Just copy them to
	274	%WXDIR%\build\msw and you can use them to do your build, otherwise
	275	you can do everything by hand as described below. But if you do work
	276	by hand and something doesn't seem to be working correctly please
	277	refer to the build scripts to see what may need to be done
	278	differently.</p>
	279	<p>The *.btm files are for 4NT and the others are for bash. They are:</p>
	280	<pre class="literal-block">
	281	.make/.make.btm Builds the main lib and the needed contribs
	282	.mymake/.mymake.btm Builds just one lib, used by .make
	283	.makesetup.mk A makefile that will copy and edit setup.h
	284	as needed for the different types of builds
	285	</pre>
	286	<p>Okay. Here's what you've been waiting for, the instructions! Adapt
	287	accordingly if you are using the bash shell.</p>
	288	<ol class="arabic">
	289	<li><p class="first">Set an environment variable to the root of the wxWidgets source
	290	tree. This is used by the makefiles:</p>
	291	<pre class="literal-block">
	292	set WXWIN=%WXDIR%
	293	</pre>
	294	</li>
	295	<li><p class="first">Copy setup0.h to setup.h:</p>
	296	<pre class="literal-block">
	297	cd %WXDIR%\include\wx\msw
	298	copy setup0.h setup.h
	299	</pre>
	300	</li>
	301	<li><p class="first">Edit %WXDIR%\include\wx\msw\setup.h and change a few settings:</p>
	302	<pre class="literal-block">
	303	wxUSE_DEBUGREPORT 0
	304	wxUSE_EXCEPTIONS 0
	305	wxUSE_DIALUP_MANAGER 0
	306	wxUSE_GRAPHICS_CONTEXT 1
	307	wxUSE_GLCANVAS 1
	308	wxUSE_POSTSCRIPT 1
	309	</pre>
	310	<p>If you are using my build scripts then a few more settings will be
	311	changed automatically and then a copy of setup.h is placed in a
	312	subdir of %WXWIN%\libvc_dll. If you are doing it by hand and
	313	making a UNICODE build, then also change these:</p>
	314	<pre class="literal-block">
	315	wxUSE_UNICODE 1
	316	wxUSE_UNICODE_MSLU 1
	317	</pre>
	318	<p>If you are doing a "hybrid" build (which is the same as the
	319	binaries that I release) then also change these:</p>
	320	<pre class="literal-block">
	321	wxUSE_MEMORY_TRACING 0
	322	wxUSE_DEBUG_CONTEXT 0
	323	</pre>
	324	</li>
	325	<li><p class="first">Make sure that %WXDIR%\lib\vc_dll directory is on the PATH. The
	326	wxWidgets DLLs will end up there as part of the build and so you'll
	327	need it on the PATH for them to be found at runtime.</p>
	328	</li>
	329	<li><p class="first">Change to the %WXDIR%\build\msw directory</p>
	330	<blockquote>
	331	<p>cd %WXDIR%\build\msw</p>
	332	</blockquote>
	333	</li>
	334	<li><p class="first">If using my scripts then use the .make.btm command to build
	335	wxWidgets. It needs one command-line parameter which controls what
	336	kind of build(s) to do. Use one of the following:</p>
	337	<pre class="literal-block">
	338	debug Build debug version
	339	hybrid Build hybrid version
	340	both Both debug and hybrid
	341	debug-uni Build a debug unicode library
	342	hybrid-uni Hybrid unicode (see the pattern yet? ;-)
	343	both-uni and finally both unicode libraries
	344	</pre>
	345	<p>For example:</p>
	346	<pre class="literal-block">
	347	.make hybrid
	348	</pre>
	349	<p>You can also pass additional command line parameters as needed and
	350	they will all be passed on to the nmake commands, for example to
	351	clean up the build:</p>
	352	<pre class="literal-block">
	353	.make hybrid clean
	354	</pre>
	355	<p>If <em>not</em> using my scripts then you can do it by hand by directly
	356	executing nmake with a bunch of extra command line parameters.
	357	The base set are:</p>
	358	<pre class="literal-block">
	359	nmake -f makefile.vc OFFICIAL_BUILD=1 SHARED=1 MONOLITHIC=0 USE_OPENGL=1 USE_GDIPLUS=1
	360	</pre>
	361	<p>If doing a debug build then add:</p>
	362	<pre class="literal-block">
	363	BUILD=debug
	364	</pre>
	365	<p>otherwise add these:</p>
	366	<pre class="literal-block">
	367	DEBUG_FLAG=1 CXXFLAGS=/D__NO_VC_CRTDBG__ WXDEBUGFLAG=h BUILD=release
	368	</pre>
	369	<p>If doing a Unicode build then add these flags:</p>
	370	<pre class="literal-block">
	371	UNICODE=1 MSLU=1
	372	</pre>
	373	<p>Now, from the %WXDIR%\build\msw directory run nmake with your
	374	selection of command-line flags as described above.</p>
	375	</li>
	376	<li><p class="first">When that is all done it will have built the main wxWidgets DLLs
	377	and also some of the contribs DLLs. There should be a ton of DLLs
	378	and lots of lib files and other stuff in %WXDIR%\lib\vc_dll.</p>
	379	</li>
	380	<li><p class="first">Building wxPython on Windows is very similar to doing it for the
	381	unix systems. We're not going to install the development version
	382	of wxPython with these commands, so it won't impact your already
	383	installed version of the latest release. You'll be able to test
	384	with this version when you want to, and use the installed release
	385	version the rest of the time. If you ever do want to install the
	386	development version please refer to INSTALL.txt.</p>
	387	<p>Change to the %WXDIR%\wxPython dir and run the this command,
	388	making sure that you use the version of python that you want to
	389	build for (if you have more than one on your system) and to match
	390	the MONOLITHIC flag with how you built wxWidgets:</p>
	391	<pre class="literal-block">
	392	cd %WXDIR%\wxPython
	393	python setup.py build_ext --inplace MONOLITHIC=0
	394	</pre>
	395	<p>If you are wanting to have the source files regenerated with swig,
	396	(only neccessary if you make modifications to the <tt class="docutils literal"><span class="pre">*.i</span></tt> files,)
	397	then you need to turn on the USE_SWIG flag and optionally tell it
	398	where to find the new swig executable, so add these flags:</p>
	399	<pre class="literal-block">
	400	USE_SWIG=1 SWIG=e:\\projects\\SWIG-1.2.29\\swig.exe
	401	</pre>
	402	<p>If you built a Unicode version of wxWidgets and want to also build
	403	the Unicode version of wxPython then add this flag:</p>
	404	<pre class="literal-block">
	405	UNICODE=1
	406	</pre>
	407	<p>If you have a debug version of Python and wxWidgets and want to
	408	build a debug version of wxPython too, add the --debug flag to the
	409	command line. You should then end up with a set of <tt class="docutils literal"><span class="pre">*_d.pyd</span></tt>
	410	files in the wx package and you'll have to run <tt class="docutils literal"><span class="pre">python_d.exe</span></tt> to
	411	use them. The debug and hybrid(release) versions can coexist.</p>
	412	<p>When the setup.py command is done you should have fully populated
	413	wxPython and wx packages locally in %WXDIR%/wxPython/wxPython and
	414	%WXDIR%/wxPython/wx, with all the extension modules (<tt class="docutils literal"><span class="pre">*.pyd</span></tt>
	415	files) located in the wx package.</p>
	416	</li>
	417	<li><p class="first">To run code with the development version of wxPython, just set the
	418	PYTHONPATH to the wxPython dir in the CVS tree. For example:</p>
	419	<pre class="literal-block">
	420	set PYTHONPATH=%WXDIR%\wxPython
	421	cd %WXDIR\wxPython\demo
	422	python demo.py
	423	</pre>
	424	</li>
	425	</ol>
	426	</div>
	427	</div>
	428	</body>
	429	</html>