Applied new master define for CommandBar vs. PocketPC mixed bar.

[wxWidgets.git] / wxPython / docs / BUILD.html

diff --git a/wxPython/docs/BUILD.html b/wxPython/docs/BUILD.html
index 277c698c517adac46013002193890a5b5bbce568..7158c4ebe87300b9379b14e17483d39398abaaaf 100644 (file)
--- a/wxPython/docs/BUILD.html
+++ b/wxPython/docs/BUILD.html
@@ -20,11 +20,11 @@ importantly, that you know what you are doing!  ;-)</p>
 <p>If you want to also install the version of wxPython you build to be in
 your site-packages dir and be your default version of wxPython, then a
 few additional steps are needed, and you may want to use slightly
 <p>If you want to also install the version of wxPython you build to be in
 your site-packages dir and be your default version of wxPython, then a
 few additional steps are needed, and you may want to use slightly

-different options.  See INSTALL.txt for more details.  If you only use
-the instructions in this BUILD.txt file then you will end up with a
-separate installation of wxPython and you can switch back and forth
-between this and the release version that you may already have
-installed.</p>
+different options.  See the <a class="reference" href="INSTALL.html">INSTALL</a> document for more details.  If
+you only use the instructions in this <a class="reference" href="BUILD.html">BUILD</a> document file then you
+will end up with a separate installation of wxPython and you can
+switch back and forth between this and the release version that you
+may already have installed.</p>

 <p>If you want to make changes to any of the <tt class="literal"><span class="pre">*.i</span></tt> files, (SWIG interface
 definition files,) or to regenerate the extension sources or renamer
 modules, then you will need an up to date version of SWIG.  Either get
 <p>If you want to make changes to any of the <tt class="literal"><span class="pre">*.i</span></tt> files, (SWIG interface
 definition files,) or to regenerate the extension sources or renamer
 modules, then you will need an up to date version of SWIG.  Either get


@@ -37,6 +37,22 @@ with an existing SWIG install for example) then you can set a setup.py
 command-line variable named SWIG to be the full path name of the
 executable and the wxPython build will use it.  See below for an
 example.</p>
 command-line variable named SWIG to be the full path name of the
 executable and the wxPython build will use it.  See below for an
 example.</p>

+<p>In the text below I'll use WXDIR with environment variable syntax
+(either $WXDIR or %WXDIR%) to refer to the top level directory were
+your wxWidgerts and wxPython sources are located.  It will equate to
+whereever you checked out the wxWidgets module from CVS, or untarred
+the wxPythonSrc tarball to.  You can either substitute the $WXDIR text
+below with your actual dir, or set the value in the environment and
+use it just like you see it below.</p>
+<p>If you run into what appears to be compatibility issues between
+wxWidgets and wxPython while building wxPython, be sure you are using
+the wxWidgets sources included with the wxPythonSrc tarball or the CVS
+snapshot, and not a previously installed version or a version
+installed from one of the standard wxWidgets installers.  With the
+&quot;unstable&quot; releases (have a odd-numbered minor release value, where
+the APIs are allowed to change) there are often significant
+differences between the W.X.Y release of wxWidgets and the W.X.Y.Z
+release of wxPython.</p>

 <div class="section" id="building-on-unix-like-systems-e-g-linux-and-os-x">
 <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>
 <p>These platforms are built almost the same way while in development
 <div class="section" id="building-on-unix-like-systems-e-g-linux-and-os-x">
 <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>
 <p>These platforms are built almost the same way while in development


@@ -52,6 +68,7 @@ build dir so I can easily blow away everything in the build dir and
 rerun the script without having to remember the options I used
 before:</p>
 <pre class="literal-block">
 rerun the script without having to remember the options I used
 before:</p>
 <pre class="literal-block">

+cd $WXDIR

 mkdir bld
 cd bld
 ../configure --prefix=/opt/wx/2.5 \
 mkdir bld
 cd bld
 ../configure --prefix=/opt/wx/2.5 \


@@ -114,25 +131,26 @@ wxWidgets you just need to add /opt/wx/2.5/bin to the PATH and set
 LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on OS X) to /opt/wx/2.5/lib.</p>
 </li>
 <li><p class="first">I also have a script to help me build wxPython and it is checked in
 LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on OS X) to /opt/wx/2.5/lib.</p>
 </li>
 <li><p class="first">I also have a script to help me build wxPython and it is checked in

-to the CVS as wxWidgets/wxPython/b, but probably don't want to use
-it as it's very cryptic and expects that you want to run SWIG, so
-if you don't have the latest patched up version of SWIG then you'll
-probably get stuck.  So I'll just give the raw commands instead.</p>
+to the CVS as wxWidgets/wxPython/b, but you probably don't want to
+use it as it's very cryptic and expects that you want to run SWIG,
+so if you don't have the latest patched up version of SWIG then
+you'll probably get stuck.  So I'll just give the raw commands
+instead.</p>

 <p>We're not going to install the development version of wxPython with
 these commands, so it won't impact your already installed version
 of the latest release.  You'll be able test with this version when
 you want to, and use the installed release version the rest of the
 <p>We're not going to install the development version of wxPython with
 these commands, so it won't impact your already installed version
 of the latest release.  You'll be able test with this version when
 you want to, and use the installed release version the rest of the

-time.  If do want to install the development verison please read
+time.  If you want to install the development version please read

 INSTALL.txt.</p>
 <p>If you have more than one version of Python on your system then be
 sure to use the version of Python that you want to use when running
 wxPython programs to run the setup.py commands below.  I'll be
 using python2.3.</p>
 <p>Make sure that the first wx-config found on the PATH is the one you
 INSTALL.txt.</p>
 <p>If you have more than one version of Python on your system then be
 sure to use the version of Python that you want to use when running
 wxPython programs to run the setup.py commands below.  I'll be
 using python2.3.</p>
 <p>Make sure that the first wx-config found on the PATH is the one you

-installed above, and then change to the wxWidgets/wxPython dir and
+installed above, and then change to the $WXDIR/wxPython dir and

 run the this command:</p>
 <pre class="literal-block">
 run the this command:</p>
 <pre class="literal-block">

-cd wxPython
+cd $WXDIR/wxPython

 python2.3 setup.py build_ext --inplace --debug
 </pre>
 <p>If your new wx-config script is not on the PATH, or there is some
 python2.3 setup.py build_ext --inplace --debug
 </pre>
 <p>If your new wx-config script is not on the PATH, or there is some


@@ -152,28 +170,29 @@ where to find the new swig executable, so add these flags:</p>
 <pre class="literal-block">
 USE_SWIG=1 SWIG=/opt/swig/bin/swig
 </pre>
 <pre class="literal-block">
 USE_SWIG=1 SWIG=/opt/swig/bin/swig
 </pre>

-<p>If you get errors about wxGLCanvas or being unable to find libGLU
-or something like that then you can add BUILD_GLCANVAS=0 to the
-setup.py command line to disable the building of the glcanvas
-module.</p>
+<p>If you get errors about being unable to find libGLU, wxGLCanvas
+being undeclared, or something similar then you can add
+BUILD_GLCANVAS=0 to the setup.py command line to disable the
+building of the glcanvas module.</p>

 <p>When the setup.py command is done you should have fully populated
 <p>When the setup.py command is done you should have fully populated

-wxPython and wx packages locally in wxWidgets/wxPython/wxPython and
-.../wx, with all the extension modules (<tt class="literal"><span class="pre">*.so</span></tt> files) located in the
-wx package.</p>
+wxPython and wx packages locally in $WXDIR/wxPython/wxPython and
+$WXDIR/wxPython/wx, with all the extension modules (<tt class="literal"><span class="pre">*.so</span></tt> files)
+located in the wx package.</p>

 </li>
 </li>

-<li><p class="first">To run code with the development verison of wxPython, just set the
-PYTHONPATH to the wxPython dir in the CVS tree.  For example:</p>
+<li><p class="first">To run code with the development version of wxPython, just set the
+PYTHONPATH to the wxPython dir located in the source tree.  For
+example:</p>

 <pre class="literal-block">
 <pre class="literal-block">

-export LD_LIBRARY=/opt/wx/2.5/lib
-export PYTHONPATH=/myprojects/wxWidgets/wxPython
-cd /myprojects/wxWidgets/wxPython/demo
+export LD_LIBRARY_PATH=/opt/wx/2.5/lib
+export PYTHONPATH=$WXDIR/wxPython
+cd $WXDIR/wxPython/demo

 python2.3 demo.py
 </pre>
 <p>OS X NOTE: You need to use &quot;pythonw&quot; on the command line to run
 wxPython applications.  This version of the Python executable is
 part of the Python Framework and is allowed to interact with the
 display.  You can also double click on a .py or a .pyw file from
 python2.3 demo.py
 </pre>
 <p>OS X NOTE: You need to use &quot;pythonw&quot; on the command line to run
 wxPython applications.  This version of the Python executable is
 part of the Python Framework and is allowed to interact with the
 display.  You can also double click on a .py or a .pyw file from

-the finder (assuming that PythonLauncher is still associated with
+the finder (assuming that the PythonLauncher app is associated with

 these file extensions) and it will launch the Framework version of
 Python for you.  For information about creating Applicaiton Bundles
 of your wxPython apps please see the wiki and the mail lists.</p>
 these file extensions) and it will launch the Framework version of
 Python for you.  For information about creating Applicaiton Bundles
 of your wxPython apps please see the wiki and the mail lists.</p>


@@ -197,11 +216,12 @@ modules using that compiler, and then make a few changes to setup.py
 to accomodate that.  (And send the patches to me.)  If you plan on
 using VisualStudio.Net (a.k.a. MSVC 7.1) keep in mind that you'll also
 have to build Python and any other extension modules that you use with
 to accomodate that.  (And send the patches to me.)  If you plan on
 using VisualStudio.Net (a.k.a. MSVC 7.1) keep in mind that you'll also
 have to build Python and any other extension modules that you use with

-that compiler because a different version of the C runtime likbrary is
+that compiler because a different version of the C runtime library is

 used.  The Python executable that comes from PythonLabs and the
 wxPython extensions that I distribute are built with MSVC 6 with all
 used.  The Python executable that comes from PythonLabs and the
 wxPython extensions that I distribute are built with MSVC 6 with all

-the Service Packs applied.</p>
-<p>If you want to build a debugable version of wxWidgets and wxPython you
+the Service Packs applied.  This policy will change with Python 2.4
+and MSVC 7.1 will be used starting with that version.</p>
+<p>If you want to build a debuggable version of wxWidgets and wxPython you

 will need to have also built a debug version of Python and any other
 extension modules you need to use.  You can tell if you have them
 already if there is a _d in the file names, for example python_d.exe
 will need to have also built a debug version of Python and any other
 extension modules you need to use.  You can tell if you have them
 already if there is a _d in the file names, for example python_d.exe


@@ -210,29 +230,38 @@ of the code with the debugger then building the normal (or hybrid)
 version is fine, and you can use the regular python executables with
 it.</p>
 <p>Just like the unix versions I also use some scripts to help me build
 version is fine, and you can use the regular python executables with
 it.</p>
 <p>Just like the unix versions I also use some scripts to help me build

-wxWidgets, but I use some non-standard stuff to do it.  So if you want
-to use them too you'll need to get a copy or 4DOS or 4NT from
-<a class="reference" href="http://www.jpsoft.com/">http://www.jpsoft.com/</a> and also a copy of unix-like cat and sed
-programs.  You can also do by hand what my scripts are doing, but
-there are a lof steps involved and I won't be going into details
-here.  There is a copy of my build scripts in wxWidgetswxPythondistribmsw</p>
+wxWidgets, but I use some non-standard stuff to do it.  So if you have
+bash (cygwin or probably MSYS too) or 4NT plus unix-like cat and sed
+programs then there is a copy of my wxWidgets build scripts in
+%WXDIR%\wxPython\distrib\msw.  Just copy them to
+%WXDIR%\build\msw and you can use them to do your build, otherwise
+you can do everything by hand as described below.  But if you do work
+by hand and something doesn't seem to be working correctly please
+refer to the build scripts to see what may need to be done
+differently.</p>
+<p>The *.btm files are for 4NT and the others are for bash.  They are:</p>
+<pre class="literal-block">
+.make/.make.btm        Builds the main lib and the needed contribs
+.mymake/.mymake.btm    Builds just one lib, use by .make
+.makesetup.mk          A makefile that will copy and edit setup.h
+                       as needed for the different types of builds
+</pre>
+<p>Okay.  Here's what you've been waiting for, the instructions!  Adapt
+accordingly if you are using the bash shell.</p>

 <ol class="arabic">
 <li><p class="first">Set an environment variable to the root of the wxWidgets source
 <ol class="arabic">
 <li><p class="first">Set an environment variable to the root of the wxWidgets source

-tree:</p>
+tree.  This is used by the makefiles:</p>

 <pre class="literal-block">
 <pre class="literal-block">

-set WXWIN=e:\projects\wxWidgets
+set WXWIN=%WXDIR%

 </pre>
 </li>
 </pre>
 </li>

-<li><p class="first">Copy setup0.h to setup.h</p>
-<blockquote>
-<p>cd %WXWIN%includewxmsw
-copy setup0.h setup.h</p>
-</blockquote>
+<li><p class="first">Copy setup0.h to setup.h:</p>
+<pre class="literal-block">
+cd %WXDIR%\include\wx\msw
+copy setup0.h setup.h
+</pre>

 </li>
 </li>

-<li><p class="first">Edit %WXWIN%includewxmswsetup.h and change a few settings.
-Some of them are changed by my build scripts depending on the type
-of build (debug/hybrid, unicode/ansi). I change a few of the other
-defaults to have these values:</p>
+<li><p class="first">Edit %WXDIR%\include\wx\msw\setup.h and change a few settings:</p>

 <pre class="literal-block">
 wxDIALOG_UNIT_COMPATIBILITY    0
 wxUSE_DEBUG_CONTEXT            1
 <pre class="literal-block">
 wxDIALOG_UNIT_COMPATIBILITY    0
 wxUSE_DEBUG_CONTEXT            1


@@ -243,16 +272,33 @@ wxUSE_POSTSCRIPT               1
 wxUSE_AFM_FOR_POSTSCRIPT       0
 wxUSE_DISPLAY                  1
 </pre>
 wxUSE_AFM_FOR_POSTSCRIPT       0
 wxUSE_DISPLAY                  1
 </pre>

+<p>If you are using my build scripts then a few more settings will be
+changed and then a copy of setup.h is placed in a subdir of
+%WXWIN%\libvc_dll.  If you are doing it by hand and making a
+UNICODE build, then also change these:</p>
+<pre class="literal-block">
+wxUSE_UNICODE                  1
+wxUSE_UNICODE_MSLU             1
+</pre>
+<p>If you are doing a &quot;hybrid&quot; build (which is the same as the
+binaries that I release) then also change these:</p>
+<pre class="literal-block">
+wxUSE_MEMORY_TRACING           0
+wxUSE_DEBUG_CONTEXT            0
+</pre>

 </li>
 </li>

-<li><p class="first">Make a %WXWIN%BIN directory and add it to the PATH.  My build
-scripts will copy the wxWidgets DLLs there.</p>
+<li><p class="first">Make sure that %WXDIR%\lib\vc_dll directory is on the PATH.  The
+wxWidgets DLLs will end up there as part of the build and so you'll
+need it on the PATH for them to be found at runtime.</p>

 </li>
 </li>

-<li><p class="first">Change to the %WXWIN%buildmsw directory and copy my build scripts
-there.</p>
+<li><p class="first">Change to the %WXDIR%\build\msw directory</p>
+<blockquote>
+<p>cd %WXDIR%\build\msw</p>
+</blockquote>

 </li>
 </li>

-<li><p class="first">Use the .make.btm command to build wxWidgets.  It needs one
-command-line parameter which controls what kind of build(s) to do.
-Use one of the following:</p>
+<li><p class="first">If using my scripts then use the .make.btm command to build
+wxWidgets.  It needs one command-line parameter which controls what
+kind of build(s) to do.  Use one of the following:</p>

 <pre class="literal-block">
 debug          Build debug version
 hybrid         Build hybrid version
 <pre class="literal-block">
 debug          Build debug version
 hybrid         Build hybrid version


@@ -263,19 +309,46 @@ both-uni       and finally both unicode libraries
 </pre>
 <p>For example:</p>
 <pre class="literal-block">
 </pre>
 <p>For example:</p>
 <pre class="literal-block">

-     .make hybrid
-
-You can also pass additional command line parameters as needed and
+.make hybrid
+</pre>
+<p>You can also pass additional command line parameters as needed and

 they will all be passed on to the nmake commands, for example to
 they will all be passed on to the nmake commands, for example to

-clean up the build::
-
-     .make hybrid clean
+clean up the build:</p>
+<pre class="literal-block">
+.make hybrid clean
+</pre>
+<p>If <em>not</em> using my scripts then you can do it by hand by directly
+executing nmake with a bunch of extra command line parameters.
+The base set are:</p>
+<pre class="literal-block">
+-f makefile.vc OFFICIAL_BUILD=1 SHARED=1 MONOLITHIC=0 USE_OPENGL=1
+</pre>
+<p>If doing a debug build then add:</p>
+<pre class="literal-block">
+BUILD=debug 
+</pre>
+<p>otherwise add these:</p>
+<pre class="literal-block">
+DEBUG_FLAG=1 CXXFLAGS=/D__NO_VC_CRTDBG__ WXDEBUGFLAG=h BUILD=release
+</pre>
+<p>If doing a Unicode build then add these flags:</p>
+<pre class="literal-block">
+UNICODE=1 MSLU=1
+</pre>
+<p>Now, from the %WXDIR%\build\msw directory run nmake with your
+selection of command-line flags as described above.  Repeat this
+same command from the following directories in order to build the
+contrib libraries:</p>
+<pre class="literal-block">
+%WXDIR%\contrib\build\gizmos
+%WXDIR%\contrib\build\xrc
+%WXDIR%\contrib\build\stc
+%WXDIR%\contrib\build\ogl

 </pre>
 </li>
 </pre>
 </li>

-<li><p class="first">When that is done it will have built the main wxWidgets DLLs and
-also some of the contribs DLLs.  There should be a ton of DLLs in
-%WXDIR%bin and lots of lib files and other stuff in
-%WXDIR%libvc_dll.</p>
+<li><p class="first">When that is all done it will have built the main wxWidgets DLLs
+and also some of the contribs DLLs.  There should be a ton of DLLs
+and lots of lib files and other stuff in %WXDIR%\lib\vc_dll.</p>

 </li>
 <li><p class="first">Building wxPython on Windows is very similar to doing it for the
 unix systems.  We're not going to install the development version
 </li>
 <li><p class="first">Building wxPython on Windows is very similar to doing it for the
 unix systems.  We're not going to install the development version


@@ -283,12 +356,12 @@ of wxPython with these commands, so it won't impact your already
 installed version of the latest release.  You'll be able to test
 with this version when you want to, and use the installed release
 version the rest of the time.  If you ever do want to install the
 installed version of the latest release.  You'll be able to test
 with this version when you want to, and use the installed release
 version the rest of the time.  If you ever do want to install the

-development verison please refer to INSTALL.txt.</p>
-<p>Change to the wxWidgetswxPython dir and run the this command,
-makeing sure that you use the version of python that you want to
+development version please refer to INSTALL.txt.</p>
+<p>Change to the %WXDIR%\wxPython dir and run the this command,
+making sure that you use the version of python that you want to

 build for (if you have more than one on your system):</p>
 <pre class="literal-block">
 build for (if you have more than one on your system):</p>
 <pre class="literal-block">

-cd %WXWIN%\wxPython
+cd %WXDIR%\wxPython

 python setup.py build_ext --inplace 
 </pre>
 <p>If you are wanting to have the source files regenerated with swig,
 python setup.py build_ext --inplace 
 </pre>
 <p>If you are wanting to have the source files regenerated with swig,


@@ -308,24 +381,20 @@ command line.  You should then end up with a set of <tt class="literal"><span cl
 files in the wx package and you'll have to run <tt class="literal"><span class="pre">python_d.exe</span></tt> to
 use them.  The debug and hybrid(release) versions can coexist.</p>
 <p>When the setup.py command is done you should have fully populated
 files in the wx package and you'll have to run <tt class="literal"><span class="pre">python_d.exe</span></tt> to
 use them.  The debug and hybrid(release) versions can coexist.</p>
 <p>When the setup.py command is done you should have fully populated

-wxPython and wx packages locally in wxWidgets/wxPython/wxPython and
-wxWidgets/wxPython/wx, with all the extension modules (<tt class="literal"><span class="pre">*.pyd</span></tt>
+wxPython and wx packages locally in %WXDIR%/wxPython/wxPython and
+%WXDIR%/wxPython/wx, with all the extension modules (<tt class="literal"><span class="pre">*.pyd</span></tt>

 files) located in the wx package.</p>
 </li>
 files) located in the wx package.</p>
 </li>

-<li><p class="first">To run code with the development verison of wxPython, just set the
+<li><p class="first">To run code with the development version of wxPython, just set the

 PYTHONPATH to the wxPython dir in the CVS tree.  For example:</p>
 <pre class="literal-block">
 PYTHONPATH to the wxPython dir in the CVS tree.  For example:</p>
 <pre class="literal-block">

-set PYTHONPATH=e:\projects\wxWidgets\wxPython
-cd e:\projects\wxWidgets\wxPython
+set PYTHONPATH=%WXDIR%\wxPython
+cd %WXDIR\wxPython\demo

 python demo.py
 </pre>
 </li>
 </ol>
 </div>
 </div>
 python demo.py
 </pre>
 </li>
 </ol>
 </div>
 </div>

-<hr class="footer" />
-<div class="footer">
-Generated on: 2004-03-12 19:55 UTC.
-</div>

 </body>
 </html>
 </body>
 </html>