wxPython/docs/BUILD.html

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