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