Reapplied patch to change the two scrolled window implementations

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

diff --git a/wxPython/docs/BUILD.txt b/wxPython/docs/BUILD.txt
index d1408a17de3fa4a947f491b911095f1e206eadfb..85d25f0dda8c5efd9a6cdbaf5036828320034d20 100644 (file)
--- a/wxPython/docs/BUILD.txt
+++ b/wxPython/docs/BUILD.txt
@@ -5,7 +5,7 @@ This file describes how I build wxWidgets and wxPython while doing
 development and testing, and is meant to help other people that want
 to do the same thing.  I'll assume that you are using either a CVS
 snapshot from http://wxWidgets.org/snapshots/, a checkout from CVS, or
 development and testing, and is meant to help other people that want
 to do the same thing.  I'll assume that you are using either a CVS
 snapshot from http://wxWidgets.org/snapshots/, a checkout from CVS, or

-one of the released wxPythonSrc-2.5.* tarballs.  I'll also assume that
+one of the released wxPython-src-2.5.* tarballs.  I'll also assume that

 you know your way around your system, the compiler, etc. and most
 importantly, that you know what you are doing!  ;-)
 
 you know your way around your system, the compiler, etc. and most
 importantly, that you know what you are doing!  ;-)
 


@@ -21,31 +21,31 @@ may already have installed.
 .. _INSTALL: INSTALL.html
 .. _BUILD: BUILD.html
 
 .. _INSTALL: INSTALL.html
 .. _BUILD: BUILD.html
 

-If you want to make changes to any of the ``*.i`` 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
-and build the current CVS version, or version 1.3.20, and then apply
-the patches in wxPython/SWIG.  See the README.txt in that dir for
-details about each patch and also info about those that may already
-have been applied to the SWIG sources.  If you install this build of
-SWIG to a location that is not on the PATH (so it doesn't interfere
-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.
+If you want to make changes to any of the ``*.i`` 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,
+plus some patches.  Get the sources for version 1.3.22, and then apply
+the patches in wxPython/SWIG and then build SWIG like normal.  See the
+README.txt in the wxPython/SWIG dir for details about each patch and
+also info about those that may already have been applied to the SWIG
+sources.  If you install this build of SWIG to a location that is not
+on the PATH (so it doesn't interfere 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.

 
 In the text below I'll use WXDIR with environment variable syntax
 
 In the text below I'll use WXDIR with environment variable syntax

-(either $WXDIR or %WXDIR%) to refer to the top level directory were
+(either $WXDIR or %WXDIR%) to refer to the top level directory where

 your wxWidgerts and wxPython sources are located.  It will equate to
 whereever you checked out the wxWidgets module from CVS, or untarred
 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
+the wxPython-src 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.
 
 If you run into what appears to be compatibility issues between
 wxWidgets and wxPython while building wxPython, be sure you are using
 below with your actual dir, or set the value in the environment and
 use it just like you see it below.
 
 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
+the wxWidgets sources included with the wxPython-src tarball or the
+CVS snapshot, and not a previously installed version or a version

 installed from one of the standard wxWidgets installers.  With the
 "unstable" releases (have a odd-numbered minor release value, where
 the APIs are allowed to change) there are often significant
 installed from one of the standard wxWidgets installers.  With the
 "unstable" releases (have a odd-numbered minor release value, where
 the APIs are allowed to change) there are often significant


@@ -77,7 +77,6 @@ place, then do the same for wxPython.
          ../configure --prefix=/opt/wx/2.5 \
                       --with-gtk \
                       --with-opengl \
          ../configure --prefix=/opt/wx/2.5 \
                       --with-gtk \
                       --with-opengl \

-                      --disable-monolithic \

                       --enable-debug \
                       --enable-geometry \
                       --enable-sound --with-sdl \
                       --enable-debug \
                       --enable-geometry \
                       --enable-sound --with-sdl \


@@ -85,9 +84,31 @@ place, then do the same for wxPython.
                       
 
    On OS X of course you'll want to use --with-mac instead of
                       
 
    On OS X of course you'll want to use --with-mac instead of

-   --with-gtk.  For GTK2 and unicode add::
+   --with-gtk.  
+
+   **NOTE**: Due to a recent change there is currently a dependency
+   problem in the multilib builds of wxWidgets on OSX, so I have
+   switched to using a monolithic build.  That means that all of the
+   core wxWidgets code is placed in in one shared library instead of
+   several.  wxPython can be used with either mode, so use whatever
+   suits you on Linux and etc. but use monolithic on OSX.  To switch
+   to the monolithic build of wxWidgets just add this configure flag::
+
+                    --enable-monolithic \
+
+   By default GTK2 will be selected if its development pacakge is
+   installed on your build system.  To force the use of GTK 1.2.x
+   instead add this flag::
+
+                     --disable-gtk2 \
+
+   To make the wxWidgets build be unicode enabled (strongly
+   recommended if you are building with GTK2) then add the following.
+   When wxPython is unicode enabled then all strings that are passed
+   to wx functions and methods will first be converted to unicode
+   objects, and any 'strings' returned from wx functions and methods
+   will actually be unicode objects.::

                          
                          

-                      --enable-gtk2 \

                       --enable-unicode \
 
    Notice that I used a prefix of /opt/wx/2.5.  You can use whatever
                       --enable-unicode \
 
    Notice that I used a prefix of /opt/wx/2.5.  You can use whatever


@@ -115,14 +136,13 @@ place, then do the same for wxPython.
    command but there are other libraries besides the main wxWidgets
    libs that also need to be built so again I make a script to do it
    all for me so I don't forget anything.  This time it is called
    command but there are other libraries besides the main wxWidgets
    libs that also need to be built so again I make a script to do it
    all for me so I don't forget anything.  This time it is called

-   ".make" (I use the leading ".  so when I do ``rm -r *`` in my build
+   ".make" (I use the leading "."  so when I do ``rm -r *`` in my build

    dir I don't lose my scripts too.)  This is what it looks like::
 
         make $* \
             && make -C contrib/src/gizmos $* \
             && make -C contrib/src/ogl CXXFLAGS="-DwxUSE_DEPRECATED=0" $* \
    dir I don't lose my scripts too.)  This is what it looks like::
 
         make $* \
             && make -C contrib/src/gizmos $* \
             && make -C contrib/src/ogl CXXFLAGS="-DwxUSE_DEPRECATED=0" $* \

-            && make -C contrib/src/stc $* \
-            && make -C contrib/src/xrc $* 
+            && make -C contrib/src/stc $* 

    
    So you just use .make as if it where make, but don't forget to set
    the execute bit on .make first!::
    
    So you just use .make as if it where make, but don't forget to set
    the execute bit on .make first!::


@@ -147,7 +167,7 @@ place, then do the same for wxPython.
    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
    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.
 
    If you have more than one version of Python on your system then be
    INSTALL.txt.
 
    If you have more than one version of Python on your system then be


@@ -168,10 +188,17 @@ place, then do the same for wxPython.
 
          WX_CONFIG=/opt/wx/2.5/bin/wx-config
 
 
          WX_CONFIG=/opt/wx/2.5/bin/wx-config
 

-   If you are building with GTK2 then add the following flags to the
-   command line::
+   By default setup.py will assume that you built wxWidgets to use
+   GTK2.  If you built wxWidgets to use GTK 1.2.x then you should add
+   this flag to the command-line::

 
 

-         WXPORT=gtk2 UNICODE=1
+        WXPORT=gtk 
+
+   If you would like to do a Unicode enabled build (all strings sent
+   to or retruned from wx functions are Unicode objects) and your
+   wxWidgets was built with unicode enabled then add this flag::
+
+         UNICODE=1

 
    If you are wanting to have the source files regenerated with swig,
    then you need to turn on the USE_SWIG flag and optionally tell it
 
    If you are wanting to have the source files regenerated with swig,
    then you need to turn on the USE_SWIG flag and optionally tell it


@@ -179,10 +206,10 @@ place, then do the same for wxPython.
 
          USE_SWIG=1 SWIG=/opt/swig/bin/swig
 
 
          USE_SWIG=1 SWIG=/opt/swig/bin/swig
 

-   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.
+   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.

 
    When the setup.py command is done you should have fully populated
    wxPython and wx packages locally in $WXDIR/wxPython/wxPython and
 
    When the setup.py command is done you should have fully populated
    wxPython and wx packages locally in $WXDIR/wxPython/wxPython and


@@ -190,7 +217,7 @@ place, then do the same for wxPython.
    located in the wx package.
 
 
    located in the wx package.
 
 

-4. To run code with the development verison of wxPython, just set the
+4. To run code with the development version of wxPython, just set the

    PYTHONPATH to the wxPython dir located in the source tree.  For
    example::
 
    PYTHONPATH to the wxPython dir located in the source tree.  For
    example::
 


@@ -227,7 +254,7 @@ compilers) can also be used but I've never done the work to make that
 happen.  If you want to try that then first you'll want to find out if
 there are any tricks that have to be done to make Python extension
 modules using that compiler, and then make a few changes to setup.py
 happen.  If you want to try that then first you'll want to find out if
 there are any tricks that have to be done to make Python extension
 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
+to accommodate 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 library is
 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 library is


@@ -236,7 +263,7 @@ wxPython extensions that I distribute are built with MSVC 6 with all
 the Service Packs applied.  This policy will change with Python 2.4
 and MSVC 7.1 will be used starting with that version.
 
 the Service Packs applied.  This policy will change with Python 2.4
 and MSVC 7.1 will be used starting with that version.
 

-If you want to build a debugable version of wxWidgets and wxPython you
+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


@@ -245,17 +272,33 @@ 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.
 
 version is fine, and you can use the regular python executables with
 it.
 

-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 my scripts you'll need to get a copy or 4DOS or 4NT from
-http://www.jpsoft.com/ 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 alot of steps involved and I won't be going into details
-here.  There is a copy of my build scripts in %WXDIR%\\wxPython\\distrib\\msw
-that you can use for reference (if you don't use them directly) for
-adapting these instructions to your specific needs.  The directions
-below assume that you are using my scripts.
+Starting with 2.5.3.0 wxPython can be built for either the monlithic
+or the multi-lib wxWidgets builds.  (Monolithic means that all the
+core wxWidgets code is in one DLL, and multi-lib means that the core
+code is divided into multiple DLLs.)  To select which one to use
+specify the MONOLITHIC flag for both the wxWidgets build and the
+wxPython build as shown below, setting it to either 0 or 1.

 
 

+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 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.
+
+The \*.btm files are for 4NT and the others are for bash.  They are::
+
+   .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
+
+Okay.  Here's what you've been waiting for, the instructions!  Adapt
+accordingly if you are using the bash shell.

 
 1. Set an environment variable to the root of the wxWidgets source
    tree.  This is used by the makefiles::
 
 1. Set an environment variable to the root of the wxWidgets source
    tree.  This is used by the makefiles::


@@ -268,10 +311,7 @@ below assume that you are using my scripts.
          copy setup0.h setup.h
 
 
          copy setup0.h setup.h
 
 

-3. Edit %WXDIR%\\include\\wx\\msw\\setup.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::
+3. Edit %WXDIR%\\include\\wx\\msw\\setup.h and change a few settings::

 
          wxDIALOG_UNIT_COMPATIBILITY    0
          wxUSE_DEBUG_CONTEXT            1
 
          wxDIALOG_UNIT_COMPATIBILITY    0
          wxUSE_DEBUG_CONTEXT            1


@@ -281,21 +321,35 @@ below assume that you are using my scripts.
          wxUSE_POSTSCRIPT               1
          wxUSE_AFM_FOR_POSTSCRIPT       0
          wxUSE_DISPLAY                  1
          wxUSE_POSTSCRIPT               1
          wxUSE_AFM_FOR_POSTSCRIPT       0
          wxUSE_DISPLAY                  1

-         
+
+   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%\\lib\vc_dll.  If you are doing it by hand and making a
+   UNICODE build, then also change these::
+
+         wxUSE_UNICODE                  1
+        wxUSE_UNICODE_MSLU             1
+
+   If you are doing a "hybrid" build (which is the same as the
+   binaries that I release) then also change these::
+
+         wxUSE_MEMORY_TRACING           0
+         wxUSE_DEBUG_CONTEXT            0
+

 
 4. 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.
 
 
 
 4. 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.
 
 

-5. Change to the %WXDIR%\\build\\msw directory and copy my build scripts
-   there from their default location in %WXDIR%\\wxPython\\distrib\\msw
-   if they are not present already.
+5. Change to the %WXDIR%\\build\\msw directory 
+
+        cd %WXDIR%\\build\\msw

 
 
 
 

-6. 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::
+6. 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::

 
          debug          Build debug version
          hybrid         Build hybrid version
 
          debug          Build debug version
          hybrid         Build hybrid version


@@ -308,16 +362,46 @@ below assume that you are using my scripts.
 
          .make hybrid
 
 
          .make hybrid
 

-    You can also pass additional command line parameters as needed and
-    they will all be passed on to the nmake commands, for example to
-    clean up the build::
+   You can also pass additional command line parameters as needed and
+   they will all be passed on to the nmake commands, for example to
+   clean up the build::

 
          .make hybrid clean
 
 
          .make hybrid clean
 

+   If *not* 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::
+
+       -f makefile.vc OFFICIAL_BUILD=1 SHARED=1 MONOLITHIC=1 USE_OPENGL=1
+
+   If doing a debug build then add::
+
+       BUILD=debug 
+
+   otherwise add these::
+
+       DEBUG_FLAG=1 CXXFLAGS=/D__NO_VC_CRTDBG__ WXDEBUGFLAG=h BUILD=release
+
+   If doing a Unicode build then add these flags::
+
+       UNICODE=1 MSLU=1
+
+   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::
+
+       %WXDIR%\contrib\build\gizmos
+       %WXDIR%\contrib\build\stc
+       %WXDIR%\contrib\build\ogl
+
+    Note, that the ogl lib build will need an additional flag::
+
+       CPPFLAGS="-DwxUSE_DEPRECATED=0"

 
 

-7.  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 and
-    lots of lib files and other stuff in %WXDIR%\\lib\\vc_dll.
+7.  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.

 
 
 8. Building wxPython on Windows is very similar to doing it for the
 
 
 8. Building wxPython on Windows is very similar to doing it for the


@@ -326,14 +410,15 @@ below assume that you are using my scripts.
    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.
+   development version please refer to INSTALL.txt.

 
    Change to the %WXDIR%\\wxPython dir and run the this command,
 
    Change to the %WXDIR%\\wxPython dir and run the this command,

-   makeing sure that you use the version of python that you want to
-   build for (if you have more than one on your system)::
+   making sure that you use the version of python that you want to
+   build for (if you have more than one on your system) and to match
+   the MONOLITHIC flag with how you built wxWidgets::

 
          cd %WXDIR%\wxPython
 
          cd %WXDIR%\wxPython

-         python setup.py build_ext --inplace 
+         python setup.py build_ext --inplace MONOLITHIC=1

 
    If you are wanting to have the source files regenerated with swig,
    then you need to turn on the USE_SWIG flag and optionally tell it
 
    If you are wanting to have the source files regenerated with swig,
    then you need to turn on the USE_SWIG flag and optionally tell it


@@ -358,7 +443,7 @@ below assume that you are using my scripts.
    files) located in the wx package.
 
 
    files) located in the wx package.
 
 

-9. To run code with the development verison of wxPython, just set the
+9. To run code with the development version of wxPython, just set the

    PYTHONPATH to the wxPython dir in the CVS tree.  For example::
 
         set PYTHONPATH=%WXDIR%\wxPython
    PYTHONPATH to the wxPython dir in the CVS tree.  For example::
 
         set PYTHONPATH=%WXDIR%\wxPython