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