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.4: http://docutils.sourceforge.net/" />
   7 <title>Building wxPython 2.7 for Development and Testing</title>
   8 <style type="text/css">
   9
  10 /*
  11 :Author: David Goodger
  12 :Contact: goodger@users.sourceforge.net
  13 :Date: $Date$
  14 :Revision: $Revision$
  15 :Copyright: This stylesheet has been placed in the public domain.
  16
  17 Default cascading style sheet for the HTML output of Docutils.
  18
  19 See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
  20 customize this style sheet.
  21 */
  22
  23 /* used to remove borders from tables and images */
  24 .borderless, table.borderless td, table.borderless th {
  25   border: 0 }
  26
  27 table.borderless td, table.borderless th {
  28   /* Override padding for "table.docutils td" with "! important".
  29      The right padding separates the table cells. */
  30   padding: 0 0.5em 0 0 ! important }
  31
  32 .first {
  33   /* Override more specific margin styles with "! important". */
  34   margin-top: 0 ! important }
  35
  36 .last, .with-subtitle {
  37   margin-bottom: 0 ! important }
  38
  39 .hidden {
  40   display: none }
  41
  42 a.toc-backref {
  43   text-decoration: none ;
  44   color: black }
  45
  46 blockquote.epigraph {
  47   margin: 2em 5em ; }
  48
  49 dl.docutils dd {
  50   margin-bottom: 0.5em }
  51
  52 /* Uncomment (and remove this text!) to get bold-faced definition list terms
  53 dl.docutils dt {
  54   font-weight: bold }
  55 */
  56
  57 div.abstract {
  58   margin: 2em 5em }
  59
  60 div.abstract p.topic-title {
  61   font-weight: bold ;
  62   text-align: center }
  63
  64 div.admonition, div.attention, div.caution, div.danger, div.error,
  65 div.hint, div.important, div.note, div.tip, div.warning {
  66   margin: 2em ;
  67   border: medium outset ;
  68   padding: 1em }
  69
  70 div.admonition p.admonition-title, div.hint p.admonition-title,
  71 div.important p.admonition-title, div.note p.admonition-title,
  72 div.tip p.admonition-title {
  73   font-weight: bold ;
  74   font-family: sans-serif }
  75
  76 div.attention p.admonition-title, div.caution p.admonition-title,
  77 div.danger p.admonition-title, div.error p.admonition-title,
  78 div.warning p.admonition-title {
  79   color: red ;
  80   font-weight: bold ;
  81   font-family: sans-serif }
  82
  83 /* Uncomment (and remove this text!) to get reduced vertical space in
  84    compound paragraphs.
  85 div.compound .compound-first, div.compound .compound-middle {
  86   margin-bottom: 0.5em }
  87
  88 div.compound .compound-last, div.compound .compound-middle {
  89   margin-top: 0.5em }
  90 */
  91
  92 div.dedication {
  93   margin: 2em 5em ;
  94   text-align: center ;
  95   font-style: italic }
  96
  97 div.dedication p.topic-title {
  98   font-weight: bold ;
  99   font-style: normal }
 100
 101 div.figure {
 102   margin-left: 2em ;
 103   margin-right: 2em }
 104
 105 div.footer, div.header {
 106   clear: both;
 107   font-size: smaller }
 108
 109 div.line-block {
 110   display: block ;
 111   margin-top: 1em ;
 112   margin-bottom: 1em }
 113
 114 div.line-block div.line-block {
 115   margin-top: 0 ;
 116   margin-bottom: 0 ;
 117   margin-left: 1.5em }
 118
 119 div.sidebar {
 120   margin-left: 1em ;
 121   border: medium outset ;
 122   padding: 1em ;
 123   background-color: #ffffee ;
 124   width: 40% ;
 125   float: right ;
 126   clear: right }
 127
 128 div.sidebar p.rubric {
 129   font-family: sans-serif ;
 130   font-size: medium }
 131
 132 div.system-messages {
 133   margin: 5em }
 134
 135 div.system-messages h1 {
 136   color: red }
 137
 138 div.system-message {
 139   border: medium outset ;
 140   padding: 1em }
 141
 142 div.system-message p.system-message-title {
 143   color: red ;
 144   font-weight: bold }
 145
 146 div.topic {
 147   margin: 2em }
 148
 149 h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
 150 h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
 151   margin-top: 0.4em }
 152
 153 h1.title {
 154   text-align: center }
 155
 156 h2.subtitle {
 157   text-align: center }
 158
 159 hr.docutils {
 160   width: 75% }
 161
 162 img.align-left {
 163   clear: left }
 164
 165 img.align-right {
 166   clear: right }
 167
 168 ol.simple, ul.simple {
 169   margin-bottom: 1em }
 170
 171 ol.arabic {
 172   list-style: decimal }
 173
 174 ol.loweralpha {
 175   list-style: lower-alpha }
 176
 177 ol.upperalpha {
 178   list-style: upper-alpha }
 179
 180 ol.lowerroman {
 181   list-style: lower-roman }
 182
 183 ol.upperroman {
 184   list-style: upper-roman }
 185
 186 p.attribution {
 187   text-align: right ;
 188   margin-left: 50% }
 189
 190 p.caption {
 191   font-style: italic }
 192
 193 p.credits {
 194   font-style: italic ;
 195   font-size: smaller }
 196
 197 p.label {
 198   white-space: nowrap }
 199
 200 p.rubric {
 201   font-weight: bold ;
 202   font-size: larger ;
 203   color: maroon ;
 204   text-align: center }
 205
 206 p.sidebar-title {
 207   font-family: sans-serif ;
 208   font-weight: bold ;
 209   font-size: larger }
 210
 211 p.sidebar-subtitle {
 212   font-family: sans-serif ;
 213   font-weight: bold }
 214
 215 p.topic-title {
 216   font-weight: bold }
 217
 218 pre.address {
 219   margin-bottom: 0 ;
 220   margin-top: 0 ;
 221   font-family: serif ;
 222   font-size: 100% }
 223
 224 pre.literal-block, pre.doctest-block {
 225   margin-left: 2em ;
 226   margin-right: 2em ;
 227   background-color: #eeeeee }
 228
 229 span.classifier {
 230   font-family: sans-serif ;
 231   font-style: oblique }
 232
 233 span.classifier-delimiter {
 234   font-family: sans-serif ;
 235   font-weight: bold }
 236
 237 span.interpreted {
 238   font-family: sans-serif }
 239
 240 span.option {
 241   white-space: nowrap }
 242
 243 span.pre {
 244   white-space: pre }
 245
 246 span.problematic {
 247   color: red }
 248
 249 span.section-subtitle {
 250   /* font-size relative to parent (h1..h6 element) */
 251   font-size: 80% }
 252
 253 table.citation {
 254   border-left: solid 1px gray;
 255   margin-left: 1px }
 256
 257 table.docinfo {
 258   margin: 2em 4em }
 259
 260 table.docutils {
 261   margin-top: 0.5em ;
 262   margin-bottom: 0.5em }
 263
 264 table.footnote {
 265   border-left: solid 1px black;
 266   margin-left: 1px }
 267
 268 table.docutils td, table.docutils th,
 269 table.docinfo td, table.docinfo th {
 270   padding-left: 0.5em ;
 271   padding-right: 0.5em ;
 272   vertical-align: top }
 273
 274 table.docutils th.field-name, table.docinfo th.docinfo-name {
 275   font-weight: bold ;
 276   text-align: left ;
 277   white-space: nowrap ;
 278   padding-left: 0 }
 279
 280 h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
 281 h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
 282   font-size: 100% }
 283
 284 tt.docutils {
 285   background-color: #eeeeee }
 286
 287 ul.auto-toc {
 288   list-style-type: none }
 289
 290 </style>
 291 </head>
 292 <body>
 293 <div class="document" id="building-wxpython-2-7-for-development-and-testing">
 294 <h1 class="title">Building wxPython 2.7 for Development and Testing</h1>
 295 <p>This file describes how I build wxWidgets and wxPython while doing
 296 development and testing, and is meant to help other people that want
 297 to do the same thing.  I'll assume that you are using either a CVS
 298 snapshot from <a class="reference" href="http://wxWidgets.org/snapshots/">http://wxWidgets.org/snapshots/</a>, a checkout from CVS, or
 299 one of the released wxPython-src-2.7.* tarballs.  I'll also assume that
 300 you know your way around your system, the compiler, etc. and most
 301 importantly, that you know what you are doing!  ;-)</p>
 302 <p>If you want to also install the version of wxPython you build to be in
 303 your site-packages dir and be your default version of wxPython, then a
 304 few additional steps are needed, and you may want to use slightly
 305 different options.  See the <a class="reference" href="INSTALL.html">INSTALL</a> document for more details.  If
 306 you only use the instructions in this <a class="reference" href="BUILD.html">BUILD</a> document file then you
 307 will end up with a separate installation of wxPython and you can
 308 switch back and forth between this and the release version that you
 309 may already have installed.</p>
 310 <p>If you want to make changes to any of the <tt class="docutils literal"><span class="pre">*.i</span></tt> files, (SWIG
 311 interface definition files,) or to regenerate the extension sources or
 312 renamer modules, then you will need an up to date version of SWIG,
 313 plus some patches.  Get the sources for version 1.3.29, and then apply
 314 the patches in wxPython/SWIG and then build SWIG like normal.  See the
 315 README.txt in the wxPython/SWIG dir for details about each patch and
 316 also info about those that may already have been applied to the SWIG
 317 sources.  If you install this build of SWIG to a location that is not
 318 on the PATH (so it doesn't interfere with an existing SWIG install for
 319 example) then you can use a setup.py command-line option named SWIG
 320 set to the full path name of the executable and the wxPython build will
 321 use it.  See below for an example.</p>
 322 <p>In the text below I'll use WXDIR with environment variable syntax
 323 (either $WXDIR or %WXDIR%) to refer to the top level directory where
 324 your wxWidgets and wxPython sources are located.  It will equate to
 325 whereever you checked out the wxWidgets module from CVS, or untarred
 326 the wxPython-src tarball to.  You can either substitute the $WXDIR text
 327 below with your actual dir, or set the value in the environment and
 328 use it just like you see it below.</p>
 329 <p>If you run into what appears to be compatibility issues between
 330 wxWidgets and wxPython while building wxPython, be sure you are using
 331 the wxWidgets sources included with the wxPython-src tarball or the
 332 CVS snapshot, and not a previously installed version or a version
 333 installed from one of the standard wxWidgets installers.  With the
 334 &quot;unstable&quot; releases (have a odd-numbered minor release value, where
 335 the APIs are allowed to change) there are often significant
 336 differences between the W.X.Y release of wxWidgets and the W.X.Y.Z
 337 release of wxPython.</p>
 338 <div class="section">
 339 <h1><a id="building-on-unix-like-systems-e-g-linux-and-os-x" 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>
 340 <p>These platforms are built almost the same way while in development
 341 so I'll combine the descriptions about their build process here.
 342 First we will build wxWidgets and install it to an out of the way
 343 place, then do the same for wxPython.</p>
 344 <ol class="arabic">
 345 <li><p class="first">Create a build directory in the main wxWidgets dir, and configure
 346 wxWidgets.  If you want to have multiple builds with different
 347 configure options, just use different subdirectories.  I normally
 348 put the configure command in a script named &quot;.configure&quot; in each
 349 build dir so I can easily blow away everything in the build dir and
 350 rerun the script without having to remember the options I used
 351 before:</p>
 352 <pre class="literal-block">
 353 cd $WXDIR
 354 mkdir bld
 355 cd bld
 356 ../configure --prefix=/opt/wx/2.7 \
 357              --with-gtk \
 358              --with-gnomeprint \
 359              --with-opengl \
 360              --enable-debug \
 361              --enable-geometry \
 362              --enable-graphics_ctx \
 363              --enable-sound --with-sdl \
 364              --enable-mediactrl \
 365              --enable-display \
 366              --disable-debugreport \
 367 </pre>
 368 <p>On OS X of course you'll want to use --with-mac instead of
 369 --with-gtk and --with-gnomeprint.</p>
 370 <p>Notice that above I used a prefix option of &quot;/opt/wx/2.7&quot;.  You can
 371 use whatever path you want, such as a path in your HOME dir or even
 372 one of the standard prefix paths such as /usr or /usr/local if you
 373 like, but using /opt this way lets me easily have multiple versions
 374 and ports of wxWidgets &quot;installed&quot; and makes it easy to switch
 375 between them, without impacting any versions of wxWidgets that may
 376 have been installed via an RPM or whatever.  For the rest of the
 377 steps below be sure to also substitute &quot;/opt/wx/2.7&quot; with whatever
 378 prefix you choose for your build.</p>
 379 <p><strong>NOTE</strong>: Due to a recent change there is currently a dependency
 380 problem in the multilib builds of wxWidgets on OSX, so I have
 381 switched to using a monolithic build.  That means that all of the
 382 core wxWidgets code is placed in in one shared library instead of
 383 several.  wxPython can be used with either mode, so use whatever
 384 suits you on Linux and etc. but use monolithic on OSX.  To switch
 385 to the monolithic build of wxWidgets just add this configure flag:</p>
 386 <pre class="literal-block">
 387 --enable-monolithic \
 388 </pre>
 389 <p>By default GTK 2.x will be used for the build.  If you would rather
 390 use GTK 1.2.x for some reason then you can force configure to use
 391 it by changing the --with-gtk flag to specify it like this:</p>
 392 <pre class="literal-block">
 393 --with-gtk=1 \
 394 </pre>
 395 <p>To make the wxWidgets build be unicode enabled (strongly
 396 recommended unless you are building with GTK1) then add the
 397 following flag.  When wxPython is unicode enabled then all strings
 398 that are passed to wx functions and methods will first be converted
 399 to unicode objects, and any 'strings' returned from wx functions
 400 and methods will actually be unicode objects.:</p>
 401 <pre class="literal-block">
 402 --enable-unicode \
 403 </pre>
 404 <p>If you want to use the image and zlib libraries included with
 405 wxWidgets instead of those already installed on your system, (for
 406 example, to reduce dependencies on 3rd party libraries) then you
 407 can add these flags to the configure command:</p>
 408 <pre class="literal-block">
 409 --with-libjpeg=builtin \
 410 --with-libpng=builtin \
 411 --with-libtiff=builtin \
 412 --with-zlib=builtin \
 413 </pre>
 414 </li>
 415 <li><p class="first">To build and install wxWidgets you could just use the &quot;make&quot;
 416 command but there are a couple other libraries besides the main
 417 wxWidgets libs that also need to be built so again I make a script
 418 to do it all for me so I don't forget anything.  This time it is
 419 called &quot;.make&quot; (I use the leading &quot;.&quot;  so when I do <tt class="docutils literal"><span class="pre">rm</span> <span class="pre">-r</span> <span class="pre">*</span></tt> in
 420 my build dir I don't lose my scripts too.)  This is what it looks
 421 like:</p>
 422 <pre class="literal-block">
 423 make $* \
 424     &amp;&amp; make -C contrib/src/gizmos $* \
 425     &amp;&amp; make -C contrib/src/stc $*
 426 </pre>
 427 <p>So you just use .make as if it where make, but don't forget to set
 428 the execute bit on .make first!:</p>
 429 <pre class="literal-block">
 430 .make
 431 .make install
 432 </pre>
 433 <p>When it's done you should have an installed set of files under
 434 /opt/wx/2.7 containing just wxWidgets.  Now to use this version of
 435 wxWidgets you just need to add /opt/wx/2.7/bin to the PATH and set
 436 LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on OS X) to /opt/wx/2.7/lib.</p>
 437 </li>
 438 <li><p class="first">I also have a script to help me build wxPython and it is checked in
 439 to the CVS as wxWidgets/wxPython/b, but you probably don't want to
 440 use it as it's very cryptic and expects that you want to run SWIG,
 441 so if you don't have the latest patched up version of SWIG then
 442 you'll probably get stuck.  So in this document I'll just give the
 443 raw commands instead.</p>
 444 <p>We're not going to install the development version of wxPython with
 445 these commands, so it won't impact your already installed version
 446 of the latest release.  You'll be able test with this version when
 447 you want to, and use the installed release version the rest of the
 448 time.  If you want to install the development version please read
 449 INSTALL.txt.</p>
 450 <p>If you have more than one version of Python on your system then be
 451 sure to use the version of Python that you want to use when running
 452 wxPython programs to run the setup.py commands below.  I'll be
 453 using python2.5.</p>
 454 <p>Make sure that the first wx-config found on the PATH is the one
 455 belonging to the wxWidgets that you installed above, and then
 456 change to the $WXDIR/wxPython dir and run the this command:</p>
 457 <pre class="literal-block">
 458 cd $WXDIR/wxPython
 459 python2.5 setup.py build_ext --inplace --debug
 460 </pre>
 461 <p>If your new wx-config script is not on the PATH, or there is some
 462 other version of it found first, then you can add this to the
 463 command line to ensure your new one is used instead:</p>
 464 <pre class="literal-block">
 465 WX_CONFIG=/opt/wx/2.7/bin/wx-config
 466 </pre>
 467 <p>By default setup.py will assume that you built wxWidgets to use
 468 GTK2.  If you built wxWidgets to use GTK 1.2.x then you should add
 469 this flag to the command-line:</p>
 470 <pre class="literal-block">
 471 WXPORT=gtk
 472 </pre>
 473 <p>Setup.py will assume by default that you are using a unicode build
 474 of wxWidgets.  If not then you can use this flag:</p>
 475 <pre class="literal-block">
 476 UNICODE=0
 477 </pre>
 478 <p>If you are wanting to have the source files regenerated with swig,
 479 (only neccessary if you make modifications to the <tt class="docutils literal"><span class="pre">*.i</span></tt> files,)
 480 then you need to turn on the USE_SWIG flag and optionally tell it
 481 where to find the new swig executable, so add these flags:</p>
 482 <pre class="literal-block">
 483 USE_SWIG=1 SWIG=/opt/swig/bin/swig
 484 </pre>
 485 <p>If you get errors about being unable to find libGLU, wxGLCanvas
 486 being undeclared, or something similar then you can add
 487 BUILD_GLCANVAS=0 to the setup.py command line to disable the
 488 building of the glcanvas module.</p>
 489 <p>When the setup.py command is done you should have a fully populated
 490 (but uninstalled) wx package located in your $WXDIR/wxPython/wx
 491 directory.</p>
 492 </li>
 493 <li><p class="first">To run code with the development version of wxPython, just set the
 494 PYTHONPATH to the wxPython dir located in the source tree.  For
 495 example:</p>
 496 <pre class="literal-block">
 497 export LD_LIBRARY_PATH=/opt/wx/2.7/lib
 498 export PYTHONPATH=$WXDIR/wxPython
 499 cd $WXDIR/wxPython/demo
 500 python2.5 demo.py
 501 </pre>
 502 <p>OS X NOTE: Depending on your version of OS X and Python you may
 503 need to use &quot;pythonw&quot; on the command line to run wxPython
 504 applications.  This version of the Python executable is part of the
 505 Python Framework and is allowed to interact with the display.  You
 506 can also double click on a .py or a .pyw file from the finder
 507 (assuming that the PythonLauncher app is associated with these file
 508 extensions) and it will launch the Framework version of Python for
 509 you.  For information about creating Applicaiton Bundles of your
 510 wxPython apps please see the wiki and the mail lists.</p>
 511 <p>SOLARIS NOTE: If you get unresolved symbol errors when importing
 512 wxPython and you are running on Solaris and building with gcc, then
 513 you may be able to work around the problem by uncommenting a bit of
 514 code in config.py and building again.  Look for 'SunOS' in config.py
 515 and uncomment the block containing it.  The problem is that Sun's ld
 516 does not automatically add libgcc to the link step.</p>
 517 </li>
 518 </ol>
 519 </div>
 520 <div class="section">
 521 <h1><a id="building-on-windows" name="building-on-windows">Building on Windows</a></h1>
 522 <p>The Windows builds currently require the use of Microsoft Visual C++.
 523 Theoretically, other compilers (such as mingw32 or the Borland
 524 compilers) can also be used but I've never done the work to make that
 525 happen.  If you want to try that then first you'll want to find out if
 526 there are any tricks that have to be done to make Python extension
 527 modules using that compiler, and then make a few changes to setup.py
 528 to accommodate that.  (And send the patches to me.)</p>
 529 <p>The standard Python 2.3 and earlier are built with MS Visual C 6.0 and
 530 so you must also build with MSVC 6 in order to be used with the stock
 531 python.exe.  If you woudl rather use a different version of
 532 VisualStudio keep in mind that you'll also have to build Python and
 533 any other extension modules that you use with that compiler because a
 534 different version of the C runtime library is used.  The stock Python
 535 2.4 and 2.5 executables are built with MSVC 7.1, and the same rules
 536 apply to it.</p>
 537 <p>If you want to build a debuggable version of wxWidgets and wxPython you
 538 will need to have also built a debug version of Python and any other
 539 extension modules you need to use.  You can tell if you have them
 540 already if there is a _d in the file names, for example python_d.exe
 541 or python25_d.dll.  If you don't need to trace through the C/C++ parts
 542 of the code with the debugger then building the normal (or hybrid)
 543 version is fine, and you can use the regular python executables with
 544 it.</p>
 545 <p>Starting with 2.5.3.0 wxPython can be built for either the monlithic
 546 or the multi-lib wxWidgets builds.  (Monolithic means that all the
 547 core wxWidgets code is in one DLL, and multi-lib means that the core
 548 code is divided into multiple DLLs.)  To select which one to use
 549 specify the MONOLITHIC flag for both the wxWidgets build and the
 550 wxPython build as shown below, setting it to either 0 or 1.</p>
 551 <p>Just like the unix versions I also use some scripts to help me build
 552 wxWidgets, but I use some non-standard stuff to do it.  So if you have
 553 bash (cygwin or probably MSYS too) or 4NT plus unix-like cat and sed
 554 programs then there is a copy of my wxWidgets build scripts in
 555 %WXDIR%\wxPython\distrib\msw.  Just copy them to
 556 %WXDIR%\build\msw and you can use them to do your build, otherwise
 557 you can do everything by hand as described below.  But if you do work
 558 by hand and something doesn't seem to be working correctly please
 559 refer to the build scripts to see what may need to be done
 560 differently.</p>
 561 <p>The *.btm files are for 4NT and the others are for bash.  They are:</p>
 562 <pre class="literal-block">
 563 .make/.make.btm        Builds the main lib and the needed contribs
 564 .mymake/.mymake.btm    Builds just one lib, used by .make
 565 .makesetup.mk          A makefile that will copy and edit setup.h
 566                        as needed for the different types of builds
 567 </pre>
 568 <p>Okay.  Here's what you've been waiting for, the instructions!  Adapt
 569 accordingly if you are using the bash shell.</p>
 570 <ol class="arabic">
 571 <li><p class="first">Set an environment variable to the root of the wxWidgets source
 572 tree.  This is used by the makefiles:</p>
 573 <pre class="literal-block">
 574 set WXWIN=%WXDIR%
 575 </pre>
 576 </li>
 577 <li><p class="first">Copy setup0.h to setup.h:</p>
 578 <pre class="literal-block">
 579 cd %WXDIR%\include\wx\msw
 580 copy setup0.h setup.h
 581 </pre>
 582 </li>
 583 <li><p class="first">Edit %WXDIR%\include\wx\msw\setup.h and change a few settings:</p>
 584 <pre class="literal-block">
 585 wxUSE_DEBUGREPORT              0
 586 wxUSE_EXCEPTIONS               0
 587 wxUSE_DIALUP_MANAGER           0
 588 wxUSE_GRAPHICS_CONTEXT         1
 589 wxUSE_GLCANVAS                 1
 590 wxUSE_POSTSCRIPT               1
 591 wxUSE_DIB_FOR_BITMAP           1
 592 </pre>
 593 <p>If you are using my build scripts then a few more settings will be
 594 changed automatically and then a copy of setup.h is placed in a
 595 subdir of %WXWIN%\libvc_dll.  If you are doing it by hand and
 596 making a UNICODE build, then also change these:</p>
 597 <pre class="literal-block">
 598 wxUSE_UNICODE                  1
 599 wxUSE_UNICODE_MSLU             1
 600 </pre>
 601 <p>If you are doing a &quot;hybrid&quot; build (which is the same as the
 602 binaries that I release) then also change these:</p>
 603 <pre class="literal-block">
 604 wxUSE_MEMORY_TRACING           0
 605 wxUSE_DEBUG_CONTEXT            0
 606 </pre>
 607 </li>
 608 <li><p class="first">Make sure that %WXDIR%\lib\vc_dll directory is on the PATH.  The
 609 wxWidgets DLLs will end up there as part of the build and so you'll
 610 need it on the PATH for them to be found at runtime.</p>
 611 </li>
 612 <li><p class="first">Change to the %WXDIR%\build\msw directory</p>
 613 <blockquote>
 614 <p>cd %WXDIR%\build\msw</p>
 615 </blockquote>
 616 </li>
 617 <li><p class="first">If using my scripts then use the .make.btm command to build
 618 wxWidgets.  It needs one command-line parameter which controls what
 619 kind of build(s) to do.  Use one of the following:</p>
 620 <pre class="literal-block">
 621 debug          Build debug version
 622 hybrid         Build hybrid version
 623 both           Both debug and hybrid
 624 debug-uni      Build a debug unicode library
 625 hybrid-uni     Hybrid unicode (see the pattern yet? ;-)
 626 both-uni       and finally both unicode libraries
 627 </pre>
 628 <p>For example:</p>
 629 <pre class="literal-block">
 630 .make hybrid
 631 </pre>
 632 <p>You can also pass additional command line parameters as needed and
 633 they will all be passed on to the nmake commands, for example to
 634 clean up the build:</p>
 635 <pre class="literal-block">
 636 .make hybrid clean
 637 </pre>
 638 <p>If <em>not</em> using my scripts then you can do it by hand by directly
 639 executing nmake with a bunch of extra command line parameters.
 640 The base set are:</p>
 641 <pre class="literal-block">
 642 nmake -f makefile.vc OFFICIAL_BUILD=1 SHARED=1 MONOLITHIC=0 USE_OPENGL=1 USE_GDIPLUS=1
 643 </pre>
 644 <p>If doing a debug build then add:</p>
 645 <pre class="literal-block">
 646 BUILD=debug
 647 </pre>
 648 <p>otherwise add these:</p>
 649 <pre class="literal-block">
 650 DEBUG_FLAG=1 CXXFLAGS=/D__NO_VC_CRTDBG__ WXDEBUGFLAG=h BUILD=release
 651 </pre>
 652 <p>If doing a Unicode build then add these flags:</p>
 653 <pre class="literal-block">
 654 UNICODE=1 MSLU=1
 655 </pre>
 656 <p>Now, from the %WXDIR%\build\msw directory run nmake with your
 657 selection of command-line flags as described above.</p>
 658 </li>
 659 <li><p class="first">When that is all done it will have built the main wxWidgets DLLs
 660 and also some of the contribs DLLs.  There should be a ton of DLLs
 661 and lots of lib files and other stuff in %WXDIR%\lib\vc_dll.</p>
 662 </li>
 663 <li><p class="first">Building wxPython on Windows is very similar to doing it for the
 664 unix systems.  We're not going to install the development version
 665 of wxPython with these commands, so it won't impact your already
 666 installed version of the latest release.  You'll be able to test
 667 with this version when you want to, and use the installed release
 668 version the rest of the time.  If you ever do want to install the
 669 development version please refer to INSTALL.txt.</p>
 670 <p>Change to the %WXDIR%\wxPython dir and run the this command,
 671 making sure that you use the version of python that you want to
 672 build for (if you have more than one on your system) and to match
 673 the MONOLITHIC flag with how you built wxWidgets:</p>
 674 <pre class="literal-block">
 675 cd %WXDIR%\wxPython
 676 python setup.py build_ext --inplace MONOLITHIC=0
 677 </pre>
 678 <p>If you are wanting to have the source files regenerated with swig,
 679 (only neccessary if you make modifications to the <tt class="docutils literal"><span class="pre">*.i</span></tt> files,)
 680 then you need to turn on the USE_SWIG flag and optionally tell it
 681 where to find the new swig executable, so add these flags:</p>
 682 <pre class="literal-block">
 683 USE_SWIG=1 SWIG=e:\\projects\\SWIG-1.2.29\\swig.exe
 684 </pre>
 685 <p>If you built a Unicode version of wxWidgets and want to also build
 686 the Unicode version of wxPython then add this flag:</p>
 687 <pre class="literal-block">
 688 UNICODE=1
 689 </pre>
 690 <p>If you have a debug version of Python and wxWidgets and want to
 691 build a debug version of wxPython too, add the --debug flag to the
 692 command line.  You should then end up with a set of <tt class="docutils literal"><span class="pre">*_d.pyd</span></tt>
 693 files in the wx package and you'll have to run <tt class="docutils literal"><span class="pre">python_d.exe</span></tt> to
 694 use them.  The debug and hybrid(release) versions can coexist.</p>
 695 <p>When the setup.py command is done you should have fully populated
 696 wxPython and wx packages locally in %WXDIR%/wxPython/wxPython and
 697 %WXDIR%/wxPython/wx, with all the extension modules (<tt class="docutils literal"><span class="pre">*.pyd</span></tt>
 698 files) located in the wx package.</p>
 699 </li>
 700 <li><p class="first">To run code with the development version of wxPython, just set the
 701 PYTHONPATH to the wxPython dir in the CVS tree.  For example:</p>
 702 <pre class="literal-block">
 703 set PYTHONPATH=%WXDIR%\wxPython
 704 cd %WXDIR\wxPython\demo
 705 python demo.py
 706 </pre>
 707 </li>
 708 </ol>
 709 </div>
 710 </div>
 711 </body>
 712 </html>