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