]> git.saurik.com Git - wxWidgets.git/blame - wxPython/docs/BUILD.html
Fixes so bg colors in a notebook on XP are visible again
[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>
8eda5e35
RD
47<div class="section" id="building-on-unix-like-systems-e-g-linux-and-os-x">
48<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>
49<p>These platforms are built almost the same way while in development
50so I'll combine the descriptions about their build process here.
fc33e5e1 51First we will build wxWidgets and install it to an out of the way
8eda5e35
RD
52place, then do the same for wxPython.</p>
53<ol class="arabic">
fc33e5e1
RD
54<li><p class="first">Create a build directory in the main wxWidgets dir, and configure
55wxWidgets. If you want to have multiple builds with different
8eda5e35
RD
56configure options, just use different subdirectories. I normally
57put the configure command in a script named &quot;.configure&quot; in each
58build dir so I can easily blow away everything in the build dir and
59rerun the script without having to remember the options I used
60before:</p>
61<pre class="literal-block">
2e957aae 62cd $WXDIR
8eda5e35
RD
63mkdir bld
64cd bld
65../configure --prefix=/opt/wx/2.5 \
66 --with-gtk \
67 --with-opengl \
68 --disable-monolithic \
69 --enable-debug \
70 --enable-geometry \
fc33e5e1
RD
71 --enable-sound --with-sdl \
72 --enable-display \
8eda5e35
RD
73</pre>
74<p>On OS X of course you'll want to use --with-mac instead of
75--with-gtk. For GTK2 and unicode add:</p>
fc33e5e1
RD
76<pre class="literal-block">
77--enable-gtk2 \
78--enable-unicode \
79</pre>
8eda5e35
RD
80<p>Notice that I used a prefix of /opt/wx/2.5. You can use whatever
81path you want, such as a path in your HOME dir or even one of the
82standard prefix paths such as /usr or /usr/local if you like, but
83using /opt this way lets me easily have multiple versions and ports
fc33e5e1
RD
84of wxWidgets &quot;installed&quot; and makes it easy to switch between them,
85without impacting any versions of wxWidgets that may have been
8eda5e35
RD
86installed via an RPM or whatever. For the rest of the steps below
87be sure to also substitute &quot;/opt/wx/2.5&quot; with whatever prefix you
88choose for your build.</p>
89<p>If you want to use the image and zlib libraries included with
fc33e5e1 90wxWidgets instead of those already installed on your system, (for
8eda5e35
RD
91example, to reduce dependencies on 3rd party libraries) then you
92can add these flags to the configure command:</p>
93<pre class="literal-block">
94--with-libjpeg=builtin \
95--with-libpng=builtin \
96--with-libtiff=builtin \
97--with-zlib=builtin \
98</pre>
99</li>
fc33e5e1
RD
100<li><p class="first">To build and install wxWidgets you could just use the &quot;make&quot;
101command but there are other libraries besides the main wxWidgets
8eda5e35
RD
102libs that also need to be built so again I make a script to do it
103all for me so I don't forget anything. This time it is called
104&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
105dir I don't lose my scripts too.) This is what it looks like:</p>
106<pre class="literal-block">
107make $* \
108 &amp;&amp; make -C contrib/src/gizmos $* \
109 &amp;&amp; make -C contrib/src/ogl CXXFLAGS=&quot;-DwxUSE_DEPRECATED=0&quot; $* \
110 &amp;&amp; make -C contrib/src/stc $* \
111 &amp;&amp; make -C contrib/src/xrc $*
112</pre>
113<p>So you just use .make as if it where make, but don't forget to set
114the execute bit on .make first!:</p>
115<pre class="literal-block">
116.make
117.make install
118</pre>
119<p>When it's done you should have an installed set of files under
fc33e5e1
RD
120/opt/wx/2.5 containing just wxWidgets. Now to use this version of
121wxWidgets you just need to add /opt/wx/2.5/bin to the PATH and set
8eda5e35
RD
122LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on OS X) to /opt/wx/2.5/lib.</p>
123</li>
124<li><p class="first">I also have a script to help me build wxPython and it is checked in
2e957aae
RD
125to the CVS as wxWidgets/wxPython/b, but you probably don't want to
126use it as it's very cryptic and expects that you want to run SWIG,
127so if you don't have the latest patched up version of SWIG then
128you'll probably get stuck. So I'll just give the raw commands
129instead.</p>
8eda5e35
RD
130<p>We're not going to install the development version of wxPython with
131these commands, so it won't impact your already installed version
132of the latest release. You'll be able test with this version when
133you want to, and use the installed release version the rest of the
134time. If do want to install the development verison please read
135INSTALL.txt.</p>
136<p>If you have more than one version of Python on your system then be
137sure to use the version of Python that you want to use when running
138wxPython programs to run the setup.py commands below. I'll be
139using python2.3.</p>
140<p>Make sure that the first wx-config found on the PATH is the one you
2e957aae 141installed above, and then change to the $WXDIR/wxPython dir and
8eda5e35
RD
142run the this command:</p>
143<pre class="literal-block">
2e957aae 144cd $WXDIR/wxPython
8eda5e35
RD
145python2.3 setup.py build_ext --inplace --debug
146</pre>
147<p>If your new wx-config script is not on the PATH, or there is some
148other version of it found first, then you can add this to the
149command line to ensure your new one is used instead:</p>
150<pre class="literal-block">
151WX_CONFIG=/opt/wx/2.5/bin/wx-config
152</pre>
153<p>If you are building with GTK2 then add the following flags to the
154command line:</p>
155<pre class="literal-block">
156WXPORT=gtk2 UNICODE=1
157</pre>
158<p>If you are wanting to have the source files regenerated with swig,
159then you need to turn on the USE_SWIG flag and optionally tell it
160where to find the new swig executable, so add these flags:</p>
161<pre class="literal-block">
162USE_SWIG=1 SWIG=/opt/swig/bin/swig
163</pre>
164<p>If you get errors about wxGLCanvas or being unable to find libGLU
165or something like that then you can add BUILD_GLCANVAS=0 to the
166setup.py command line to disable the building of the glcanvas
167module.</p>
168<p>When the setup.py command is done you should have fully populated
2e957aae
RD
169wxPython and wx packages locally in $WXDIR/wxPython/wxPython and
170$WXDIR/wxPython/wx, with all the extension modules (<tt class="literal"><span class="pre">*.so</span></tt> files)
171located in the wx package.</p>
8eda5e35
RD
172</li>
173<li><p class="first">To run code with the development verison of wxPython, just set the
2e957aae
RD
174PYTHONPATH to the wxPython dir located in the source tree. For
175example:</p>
8eda5e35 176<pre class="literal-block">
2e957aae
RD
177export LD_LIBRARY_PATH=/opt/wx/2.5/lib
178export PYTHONPATH=$WXDIR/wxPython
179cd $WXDIR/wxPython/demo
8eda5e35
RD
180python2.3 demo.py
181</pre>
182<p>OS X NOTE: You need to use &quot;pythonw&quot; on the command line to run
183wxPython applications. This version of the Python executable is
184part of the Python Framework and is allowed to interact with the
9c329f86 185display. You can also double click on a .py or a .pyw file from
2e957aae 186the finder (assuming that the PythonLauncher app is associated with
8eda5e35
RD
187these file extensions) and it will launch the Framework version of
188Python for you. For information about creating Applicaiton Bundles
189of your wxPython apps please see the wiki and the mail lists.</p>
190<p>SOLARIS NOTE: If you get unresolved symbol errors when importing
191wxPython and you are running on Solaris and building with gcc, then
192you may be able to work around the problem by uncommenting a bit of
193code in setup.py and building again. Look for 'SunOS' in setup.py
194and uncomment the block containing it. The problem is that Sun's ld
195does not automatically add libgcc to the link step.</p>
196</li>
197</ol>
198</div>
199<div class="section" id="building-on-windows">
200<h1><a name="building-on-windows">Building on Windows</a></h1>
201<p>The Windows builds currently require the use of Microsoft Visual C++.
202Theoretically, other compilers (such as mingw32 or the Borland
203compilers) can also be used but I've never done the work to make that
204happen. If you want to try that then first you'll want to find out if
205there are any tricks that have to be done to make Python extension
206modules using that compiler, and then make a few changes to setup.py
207to accomodate that. (And send the patches to me.) If you plan on
208using VisualStudio.Net (a.k.a. MSVC 7.1) keep in mind that you'll also
209have to build Python and any other extension modules that you use with
2e957aae 210that compiler because a different version of the C runtime library is
8eda5e35
RD
211used. The Python executable that comes from PythonLabs and the
212wxPython extensions that I distribute are built with MSVC 6 with all
2e957aae
RD
213the Service Packs applied. This policy will change with Python 2.4
214and MSVC 7.1 will be used starting with that version.</p>
fc33e5e1 215<p>If you want to build a debugable version of wxWidgets and wxPython you
8eda5e35
RD
216will need to have also built a debug version of Python and any other
217extension modules you need to use. You can tell if you have them
218already if there is a _d in the file names, for example python_d.exe
219or python23_d.dll. If you don't need to trace through the C/C++ parts
220of the code with the debugger then building the normal (or hybrid)
221version is fine, and you can use the regular python executables with
222it.</p>
223<p>Just like the unix versions I also use some scripts to help me build
fc33e5e1 224wxWidgets, but I use some non-standard stuff to do it. So if you want
2e957aae 225to use my scripts you'll need to get a copy or 4DOS or 4NT from
8eda5e35
RD
226<a class="reference" href="http://www.jpsoft.com/">http://www.jpsoft.com/</a> and also a copy of unix-like cat and sed
227programs. You can also do by hand what my scripts are doing, but
2e957aae
RD
228there are alot of steps involved and I won't be going into details
229here. There is a copy of my build scripts in %WXDIR%wxPythondistribmsw
230that you can use for reference (if you don't use them directly) for
231adapting these instructions to your specific needs. The directions
232below assume that you are using my scripts.</p>
8eda5e35 233<ol class="arabic">
fc33e5e1 234<li><p class="first">Set an environment variable to the root of the wxWidgets source
2e957aae 235tree. This is used by the makefiles:</p>
8eda5e35 236<pre class="literal-block">
2e957aae 237set WXWIN=%WXDIR%
8eda5e35
RD
238</pre>
239</li>
240<li><p class="first">Copy setup0.h to setup.h</p>
241<blockquote>
2e957aae 242<p>cd %WXDIR%includewxmsw
8eda5e35
RD
243copy setup0.h setup.h</p>
244</blockquote>
245</li>
2e957aae 246<li><p class="first">Edit %WXDIR%includewxmswsetup.h and change a few settings.
8eda5e35
RD
247Some of them are changed by my build scripts depending on the type
248of build (debug/hybrid, unicode/ansi). I change a few of the other
249defaults to have these values:</p>
250<pre class="literal-block">
251wxDIALOG_UNIT_COMPATIBILITY 0
252wxUSE_DEBUG_CONTEXT 1
253wxUSE_MEMORY_TRACING 1
254wxUSE_DIALUP_MANAGER 0
255wxUSE_GLCANVAS 1
256wxUSE_POSTSCRIPT 1
257wxUSE_AFM_FOR_POSTSCRIPT 0
fc33e5e1 258wxUSE_DISPLAY 1
8eda5e35
RD
259</pre>
260</li>
2e957aae 261<li><p class="first">Make sure that %WXDIR%libvc_dll directory is on the PATH. The
90805926
RD
262wxWidgets DLLs will end up there as part of the build and so you'll
263need it on the PATH for them to be found at runtime.</p>
8eda5e35 264</li>
2e957aae
RD
265<li><p class="first">Change to the %WXDIR%buildmsw directory and copy my build scripts
266there from their default location in %WXDIR%wxPythondistribmsw
267if they are not present already.</p>
8eda5e35 268</li>
fc33e5e1 269<li><p class="first">Use the .make.btm command to build wxWidgets. It needs one
8eda5e35
RD
270command-line parameter which controls what kind of build(s) to do.
271Use one of the following:</p>
272<pre class="literal-block">
273debug Build debug version
274hybrid Build hybrid version
275both Both debug and hybrid
276debug-uni Build a debug unicode library
277hybrid-uni Hybrid unicode (see the pattern yet? ;-)
278both-uni and finally both unicode libraries
279</pre>
280<p>For example:</p>
281<pre class="literal-block">
282 .make hybrid
283
284You can also pass additional command line parameters as needed and
285they will all be passed on to the nmake commands, for example to
286clean up the build::
287
288 .make hybrid clean
289</pre>
290</li>
fc33e5e1 291<li><p class="first">When that is done it will have built the main wxWidgets DLLs and
8eda5e35
RD
292also some of the contribs DLLs. There should be a ton of DLLs in
293%WXDIR%bin and lots of lib files and other stuff in
294%WXDIR%libvc_dll.</p>
295</li>
296<li><p class="first">Building wxPython on Windows is very similar to doing it for the
297unix systems. We're not going to install the development version
298of wxPython with these commands, so it won't impact your already
299installed version of the latest release. You'll be able to test
300with this version when you want to, and use the installed release
301version the rest of the time. If you ever do want to install the
302development verison please refer to INSTALL.txt.</p>
2e957aae 303<p>Change to the %WXDIR%wxPython dir and run the this command,
8eda5e35
RD
304makeing sure that you use the version of python that you want to
305build for (if you have more than one on your system):</p>
306<pre class="literal-block">
2e957aae 307cd %WXDIR%\wxPython
8eda5e35
RD
308python setup.py build_ext --inplace
309</pre>
310<p>If you are wanting to have the source files regenerated with swig,
311then you need to turn on the USE_SWIG flag and optionally tell it
312where to find the new swig executable, so add these flags:</p>
313<pre class="literal-block">
314USE_SWIG=1 SWIG=e:\projects\SWIG-cvs\swig.exe
315</pre>
fc33e5e1 316<p>If you built a Unicode version of wxWidgets and want to also build
8eda5e35
RD
317the Unicode version of wxPython then add this flag:</p>
318<pre class="literal-block">
319UNICODE=1
320</pre>
fc33e5e1 321<p>If you have a debug version of Python and wxWidgets and want to
8eda5e35
RD
322build a debug version of wxPython too, add the --debug flag to the
323command line. You should then end up with a set of <tt class="literal"><span class="pre">*_d.pyd</span></tt>
324files in the wx package and you'll have to run <tt class="literal"><span class="pre">python_d.exe</span></tt> to
325use them. The debug and hybrid(release) versions can coexist.</p>
326<p>When the setup.py command is done you should have fully populated
2e957aae
RD
327wxPython and wx packages locally in %WXDIR%/wxPython/wxPython and
328%WXDIR%/wxPython/wx, with all the extension modules (<tt class="literal"><span class="pre">*.pyd</span></tt>
8eda5e35
RD
329files) located in the wx package.</p>
330</li>
331<li><p class="first">To run code with the development verison of wxPython, just set the
332PYTHONPATH to the wxPython dir in the CVS tree. For example:</p>
333<pre class="literal-block">
2e957aae
RD
334set PYTHONPATH=%WXDIR%\wxPython
335cd %WXDIR\wxPython\demo
8eda5e35
RD
336python demo.py
337</pre>
338</li>
339</ol>
340</div>
341</div>
8eda5e35
RD
342</body>
343</html>