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