fix return type for "map_event" and "unmap_event" handlers

[wxWidgets.git] / BuildCVS.txt

diff --git a/BuildCVS.txt b/BuildCVS.txt
index 20fd09d6bfccf0fb9543fe830fac9987929ab13b..1e85521ae495a8bbc6dd5905c80b4286600595d2 100644 (file)
--- a/BuildCVS.txt
+++ b/BuildCVS.txt
@@ -2,49 +2,82 @@
                 How to build the sources from CVS
 ------------------------------------------------------------------------
 
                 How to build the sources from CVS
 ------------------------------------------------------------------------
 

+Please use the install.txt files in docs/gtk, docs/msw, docs/motif, docs/mac
+etc. alongside these instructions.
+

 I) Windows using plain makefiles
 ----------------------------------------
 
 I) Windows using plain makefiles
 ----------------------------------------
 

-a) Using the GNU MinGW32 or GNU CygWin32 compilers
+a) If using Microsoft Visual C++ 5.0 or 6.0
+
+Ensure that the command-line compiler and tools (including
+nmake) are installed and ready to run.  Depending on your
+installation there may be a batch file (commonly named VCVARS32.BAT)
+that needs to be run to set correct environment variables and PATH entries.
+
+Continue with item c) below.

 
 

-You'll need the compiler itself which is available from

 
 

-  http://www.cygwin.com
+b) If using the MinGW or Cygwin compilers

 
 

-When using MingW32 you'll need GNU make which is part of
-part of the CygWin32 toolchain and is also available as
-a stand alone port without the infamous Cygwin.dll from
+You can get MinGW from  http://www.mingw.org/

 
 

-  http://agnes.dida.physik.uni-essen.de/~janjaap/mingw32
+Cygwin is available at  http://www.cygwin.com/

 
 

-The makefile has small problems with Cygwin´s tools
-so it is recommended not to use these (but MingGW32
-and its make.exe).
+If you are using Cygwin or MinGW together with the MSYS environment, you
+can build the library using configure (see "Unix ports" and
+"Windows using configure" below). You can also
+build wxWidgets without configure using native makefile, but only with
+MinGW. Using Cygwin together with Windows makefile is no longer supported.
+
+If building with MinGW without configure:

 
 -> Set your path so that it includes the directory
    where your compiler and tools reside
 
 -> Set your path so that it includes the directory
    where your compiler and tools reside

--> Assume that you installed the wxWindows sources
-   into c:\wxWin
--> Copy c:\wxWin\include\wx\msw\setup0.h 
-   to   c:\wxWin\include\wx\msw\setup.h
--> Edit c:\wxWin\include\wx\msw\setup.h so that
-   most features are enabled (i.e. defined to 1) with
-   #define wxUSE_ODBC          0
-   #define wxUSE_SOCKETS       0
-   #define wxUSE_HTML          1
-   #define wxUSE_THREADS       1
-   #define wxUSE_FS_INET       0
-   #define wxUSE_FS_ZIP        1
-   #define wxUSE_BUSYINFO      1
-   #define wxUSE_DYNLIB_CLASS  1
-   #define wxUSE_ZIPSTREAM     1
-   #define wxUSE_LIBJPEG       1
-   #define wxUSE_LIBPNG        1
-
-   and iostreams ares disabled with
+
+-> Make sure you have GNU Make installed. It must be Windows native version.
+   Download it from http://www.mingw.org, the executable will be called
+   mingw32-make.exe.
+
+-> Modern version of MinGW is required; preferably MinGW 2.0 (with gcc3),
+   but MinGW with gcc-2.95.3 will suffice. If you are using 2.95, you will
+   have to change variable GCC_VERSION in config.gcc (see msw/install.txt
+   for details).
+
+If using configure, Unix instructions apply.
+
+
+c) Build instructions
+
+Assumming that you installed the wxWidgets sources
+into c:\wxWidgets:
+
+-> Copy c:\wxWidgets\include\wx\msw\setup0.h
+   to   c:\wxWidgets\include\wx\msw\setup.h
+-> Edit c:\wxWidgets\include\wx\msw\setup.h to choose
+   the features you would like to compile wxWidgets with[out].
+
+   and std iostreams are disabled with

    #define wxUSE_STD_IOSTREAM   0
    #define wxUSE_STD_IOSTREAM   0

--> type: cd c:\wxWin\src\msw
--> type: make -f makefile.g95
+ 
+-> type: cd c:\wxWidgets\build\msw
+-> type: make -f makefile.gcc  (if using GNU tools)
+or type: nmake -f makefile.vc   (if using MS VC++)
+etc.
+
+   See also docs/msw/install.txt for additional compilation options.
+
+d) Borland (including free command line tools)
+   Download tools from http://www.borland.com/downloads/
+   
+   See docs/msw/install.txt for details; in brief:
+
+-> type cd c:\wxWidgets\build\msw
+-> type make -f makefile.bcc
+
+You can customize many things in the build process, detailed description is
+in docs/msw/install.txt.
+

 
 II) Unix ports
 --------------
 
 II) Unix ports
 --------------


@@ -52,12 +85,19 @@ II) Unix ports
 Building wxGTK or wxMotif completely without configure
 won't ever work, but there is now a new makefile system
 that works without libtool and automake, using only
 Building wxGTK or wxMotif completely without configure
 won't ever work, but there is now a new makefile system
 that works without libtool and automake, using only

-configure to create what is needed. 
+configure to create what is needed.
+
+In order to create configure, you need to have the
+GNU autoconf package (version > 2.54) installed
+on your system and type run "autoconf" in the base
+directory (or run the autogen.sh script in the same
+directory, which just calls autoconf). Note that you usually don't
+need to do this because configure is included in CVS.

 
 Set WXWIN environment variable to the base directory such
 
 Set WXWIN environment variable to the base directory such

-as ~/wxWindows (this is actually not really needed).
+as ~/wxWidgets (this is actually not really needed).

 
 

--> type: export WXWIN=~/wxWindows
+-> type: export WXWIN=~/wxWidgets

 -> type: md mybuild
 -> type: cd mybuild
 -> type: ../configure --with-motif
 -> type: md mybuild
 -> type: cd mybuild
 -> type: ../configure --with-motif


@@ -76,94 +116,147 @@ yet complete).
 III) Windows using configure
 ----------------------------------------
 
 III) Windows using configure
 ----------------------------------------
 

-Take a look at Unix->Windows cross compiling. With minor
-modifications, this should work in Windows if you've got the cygnus
-utilities (bash, GNU make, etc) and either mingw32 or cygwin32 installed. 
-See http://www.cygnus.com for these programs, or go straight to their
-ftp server at ftp://sourceware.cygnus.com/pub/cygwin/. 
+wxWidgets can be built on Windows using MSYS (see
+http://www.mingw.org/), which is a POSIX build environment
+for Windows. With MSYS you can just ./configure && make (see also VII,
+Unix->Windows cross-compiling using configure).

 
 

-Of course, you can also build the library using plain makefiles (see 
+Of course, you can also build the library using plain makefiles (see

 section I).
 
 section I).
 

-V) MacOS
+IV) Classic MacOS using CodeWarrior (eg MacOS 8.x/9.x)

 ----------------------------------------
 
 ----------------------------------------
 

+Refer to the readme.txt and install.txt files in docs/mac to build
+wxWidgets under Classic Mac OS using CodeWarrior.
+
+If you are checking out the CVS sources using cvs under Mac OS X and
+compiling under Classic Mac OS:
+
+- make sure that all text files have a Mac OS type of 'TEXT' otherwise
+  CodeWarrior may ignore them. Checking out the CVS sources using cvs
+  under Mac OS X creates untyped files which can lead to compilation
+  errors under CodeWarrior which are hard to track down.
+
+- convert the xml files to CodeWarrior binary projects using the supplied
+  AppleScript in docs/mac (M5xml2mcp.applescript for CodeWarrior 5.3)
+
+V) MacOS X using configure and the Developer Tools
+----------------------------------------
+
+You need to have the Developer Tools installed. If this is not the case,
+you will need to register at the Apple Developer web site (this is a free
+registration) in order to download the Developer Tools installer.
+
+In order to create configure, you need to have the
+GNU autoconf package (version >= 2.54) installed
+on your system and type run "autoconf" in the base
+directory (or run the autogen.sh script in the same
+directory, which just calls autoconf).
+
+-> type: mkdir macbuild
+-> type: cd macbuild
+-> type: ../configure --with-mac
+or type: ../configure
+-> type: make
+

 VI) OS/2
 ----------------------------------------
 VI) OS/2
 ----------------------------------------

+No notes.

 
 VII) Unix->Windows cross-compiling using configure
 --------------------------------------------------
 
 
 VII) Unix->Windows cross-compiling using configure
 --------------------------------------------------
 

-First you'll need a cross-compiler; linux glibc binaries of mingw32 and
-cygwin32 (both based on egcs) can be found at
-ftp://ftp.objsw.com/pub/crossgcc/linux-x-win32. Otherwise you can 
-compile one yourself. Check the relevant FAQs.
+First you'll need a cross-compiler; linux glibc binaries of MinGW and
+Cygwin (both based on egcs) can be found at
+ftp://ftp.objsw.com/pub/crossgcc/linux-x-win32. Alternative binaries,
+based on the latest MinGW release can be found at
+http://members.telering.at/jessich/mingw/mingwcross/mingw_cross.html
+Otherwise you can compile one yourself.

 
 

-[ A Note about cygwin32 and mingw32: the main difference is that cygwin32
+[ A Note about Cygwin and MinGW: the main difference is that Cygwin

 binaries are always linked against cygwin.dll. This dll encapsulates most
 standard Unix C extensions, which is very handy if you're porting unix
 binaries are always linked against cygwin.dll. This dll encapsulates most
 standard Unix C extensions, which is very handy if you're porting unix

-software to windows. However, wxMSW doesn't need this, so mingw32 is
+software to windows. However, wxMSW doesn't need this, so MinGW is

 preferable if you write portable C(++). ]
 
 You might want to build both Unix and Windows binaries in the same source
 tree; to do this make subdirs for each e.g. unix and win32. If you've
 preferable if you write portable C(++). ]
 
 You might want to build both Unix and Windows binaries in the same source
 tree; to do this make subdirs for each e.g. unix and win32. If you've

-already build wxWindows in the main dir, do a 'make distclean' there,
+already build wxWidgets in the main dir, do a 'make distclean' there,

 otherwise configure will get confused. (In any case, read the section 'Unix
 otherwise configure will get confused. (In any case, read the section 'Unix

-using configure' and make sure you're able to build a native wxWindows
+using configure' and make sure you're able to build a native wxWidgets

 library; cross-compiling errors can be pretty obscure and you'll want to be
 sure that your configure setup is basically sound.)
 
 To cross compile the windows library, do
 library; cross-compiling errors can be pretty obscure and you'll want to be
 sure that your configure setup is basically sound.)
 
 To cross compile the windows library, do

--> cd win32 
+-> cd win32

 (or whatever you called it)
 Now run configure. There are two ways to do this
 (or whatever you called it)
 Now run configure. There are two ways to do this

--> ../configure --host=i586-mingw32 --build=i586-linux --with-mingw \
-   --enable-dnd=no
+-> ../configure --host=i586-mingw32 --build=i586-linux --with-mingw

 where --build= should read whatever platform you're building on. Configure
 will notice that build and host platforms differ, and automatically prepend
 where --build= should read whatever platform you're building on. Configure
 will notice that build and host platforms differ, and automatically prepend

-i586-mingw32- to gcc, ar, ld, etc (make sure they're in the PATH!). 
-The other way to run configure is by specifying the names of the binaries 
+i586-mingw32- to gcc, ar, ld, etc (make sure they're in the PATH!).
+The other way to run configure is by specifying the names of the binaries

 yourself:
 -> CC=i586-mingw32-gcc CXX=i586-mingw32-g++ RANLIB=i586-mingw32-ranlib \
    DLLTOOL=i586-mingw32-dlltool LD=i586-mingw32-ld NM=i586-mingw32-nm \
 yourself:
 -> CC=i586-mingw32-gcc CXX=i586-mingw32-g++ RANLIB=i586-mingw32-ranlib \
    DLLTOOL=i586-mingw32-dlltool LD=i586-mingw32-ld NM=i586-mingw32-nm \

-   ../configure --host=i586-mingw32 --with-mingw --enable-dnd=no
-
-(all assuming you're using mingw32)
-Drag'n'drop is disabled because mingw32 lacks (AFAIK) OLE headers.
-
-[ Update: some new mingw32 versions now have a new set of windows header 
-files, which apparently can handle ole. Untested at the moment ]
+   ../configure --host=i586-mingw32 --with-mingw

 
 

-Configure will conclude that shared libraries are out of the question and
-opt for a static one. I haven't looked into DLL creation yet.
+(all assuming you're using MinGW)
+By default this will compile a DLL, if you want a static library,
+specify --disable-shared.

 
 

-Type 
+Type

 -> make
 and wait, wait, wait. Don't leave the room, because the minute you do there
 will be a compile error :-)
 
 -> make
 and wait, wait, wait. Don't leave the room, because the minute you do there
 will be a compile error :-)
 

-If this is successful, you end up with a libwx_msw.a in win32/lib.  Now try 
-building the minimal sample:
+NB: if you are using a very old compiler you risk to get quite a few warnings
+    about "ANSI C++ forbids implicit conversion from 'void *'" in all places
+    where va_arg macro is used. This is due to a bug in (some versions of)
+    MinGW headers which may be corrected by upgrading your compier,
+    otherwise you might edit the file
+
+    ${install_prefix}/lib/gcc-lib/i586-mingw32/egcs-2.91.57/include/stdarg.h
+
+    (instead of egcs-2.91.57 you may have something different), searching for
+    the lines
+
+/* Define __gnuc_va_list.  */
+
+#ifndef __GNUC_VA_LIST
+#define __GNUC_VA_LIST
+#if defined(__svr4__) || defined(_AIX) || defined(_M_UNIX) || defined(__NetBSD__)
+typedef char *__gnuc_va_list;
+#else
+typedef void *__gnuc_va_list;
+#endif
+#endif
+
+    and adding "|| defined(_WIN32)" to the list of platforms on which
+    __gnuc_va_list is char *.
+
+If this is successful, you end up with a wx23_2.dll/libwx23_2.a in win32/lib
+(or just libwx_msw.a if you opted for a static build).
+Now try building the minimal sample:

 
 -> cd samples/minimal
 -> make
 
 -> cd samples/minimal
 -> make

--> mv minimal minimal.exe

 
 

-and run it with wine, for example
+and run it with wine, for example (or copy to a Windows box)

 -> wine minimal.exe
 
 If all is well, do an install; from win32
 -> make install
 
 -> wine minimal.exe
 
 If all is well, do an install; from win32
 -> make install
 

-Native and cross-compiled installations can co-exist peacefully 
-(as long as their widget sets differ), except for wx-config. You might 
+Native and cross-compiled installations can co-exist peacefully
+(as long as their widget sets differ), except for wx-config. You might

 want to rename the cross-compiled one to i586-mingw32-wx-config, or something.
 
 Cross-compiling TODO:
 ---------------------
 want to rename the cross-compiled one to i586-mingw32-wx-config, or something.
 
 Cross-compiling TODO:
 ---------------------

-- resource compiling must be done manually for now (should/can we link the 
+- resource compiling must be done manually for now (should/can we link the

 default wx resources into libwx_msw.a?) [ No we can't; the linker won't
 link it in... you have to supply an object file ]
 default wx resources into libwx_msw.a?) [ No we can't; the linker won't
 link it in... you have to supply an object file ]

-- dynamic libraries

 - static executables are HUGE -- there must be room for improvement.
 
 - static executables are HUGE -- there must be room for improvement.