fixed HasButtons()

[wxWidgets.git] / docs / msw / install.txt

Installing wxWindows 2.5.0
--------------------------

This is wxWindows 2.5.0 for Microsoft Windows 9x/ME, Windows NT, Windows 2000
and Windows XP. This is an unstable development release. Note that unstable in
this context doesn't mean that it crashes a lot, just that the library API may
change in backwards incompatible way during the 2.5 branch life time.


IMPORTANT NOTE: If you experience problems installing, please
re-read this instructions and other related files (changes.txt,
readme.txt, FAQ) carefully before mailing wx-users. Preferably,
try to fix the problem first and then upload a patch to
SourceForge:

  http://sourceforge.net/patch/?group_id=9863

Please report bugs using the SourceForge bug tracker:

  http://sourceforge.net/bugs/?group_id=9863


Unarchiving
-----------

A setup program is provided (setup.exe) to automatically copy
files to a directory on your hard disk. Do not install into a
path that contains spaces. To avoid confusion with other
wxWindows installations that might be on your machine, the
installation program does not se the WXWIN environment variable;
please set this by hand via the System applet if you wish to
make it permanent.

The setup program contains the following:

- All common, generic and MSW-specific wxWindows source;
- samples;
- documentation in Windows Help format;
- makefiles for most Windows compilers, plus CodeWarrior,
  BC++ and VC++ IDE files;
- JPEG library source;
- TIFF library source;
- Object Graphics Library;
- Tex2RTF source;
- Dialog Editor binary.

Alternatively, you may unarchive the .zip form by hand:
wxMSW-x.y.z.zip where x.y.z is the version number.

Unarchive the required files plus any optional documentation
files into a suitable directory such as c:\wx.

Other add-on packages are available from the wxWindows Web site, such as:

- mmedia.zip. Audio, CD, video access for Windows and Linux.
- ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
- tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
  the same document source.


General installation notes
--------------------------

If installing from the CVS server, copy include/wx/msw/setup0.h to
include/wx/msw/setup.h and edit the resulting file to choose
the features you would like to compile wxWindows with[out].


Compilation
===========

The following sections explain how to compile wxWindows with each supported
compiler. Search for one of Microsoft/Borland/Watcom/Symantec/Metrowerks/
Cygwin/Mingw32 to quickly locate the instructions for your compiler.

All makefiles and project are located in build\msw directory.

Where compiled files are stored
-------------------------------

After succesful compilation you'll find the libraries in a subdirectory
of lib directory named after the compiler, toolkit name and DLL and Unicode
settings. A couple of examples:

  lib\vc_msw                    VC++ compiled static libraries
  lib\vc_mswdll                 VC++ DLLs
  lib\bcc_mswud                 Static libraries for Borland C++,
                                Unicode debug build
  lib\wat_mswunivdll            Watcom C++ DLLs of wxUniversal port

Names of compiled wxWindows libraries follow this scheme: libraries that don't
depend on GUI components begin with "wxbase" followed by version number and
letters indicating if the library is compiled as Unicode ('u') and/or debug
build ('d'). Last component of them name is name of wxWindows component
(unless you built the library as single monolithic library; look for
"Configuring the build" below). This is a typical set of release ANSI build
libraries (release versions on left, debug on right side):

  wxbase25.lib              wxbase25d.lib
  wxbase25_net.lib          wxbase25d_net.lib
  wxbase25_xml.lib          wxbase25d_xml.lib
  wxmsw25_core.lib          wxmsw25d_core.lib
  wxmsw25_html.lib          wxmsw25d_html.lib
  wxmsw25_adv.lib           wxmsw25d_adv.lib

These directories also contain wx/setup.h header.

Below are compiler specific notes followed by customizing instructions that
apply to all compilers (search for "Configuring the build").


Microsoft Visual C++ compilation
--------------------------------

You may wish to visit http://wiki.wxwindows.org/wiki.pl?MSVC for a more
informal and more detailed description of the process summarized below.

Please note that the VC++ 6.0 project files will work for VC++ .NET also.

Also note that you can make the project files work with VC++ 5.0 but you'll
need to edit .dsp file by hand before this is possible (change the version in
the .dsp file header from 6.0 to 5.0).

Using project files (VC++ 6 and later):

1. Unarchive wxWindows-x.y.z-vc.zip, the VC++ 6 project
   makefiles (already included in wxMSW-x.y.z.zip and the setup version).
2. Open build\msw\wx.dsw, which has configurations for static
   compilation or DLL compilation, and each of these available in
   Unicode/ANSI, Debug/Release and wxUniversal or native variations.
   Normally you'll use a static linking ANSI configuration.
   Choose the Win32 Debug or Win32 Release configuration for the wxWindows
   project, and compile. Alternatively, use Batch Build to build more than
   one configuration. It will also produce similar variations on jpeg.lib,
   png.lib, tiff.lib, zlib.lib, and regex.lib.
3. Open a sample project file, choose a configuration such as
   Win32 Debug using Build | Set Active Configuration..., and compile.
   The project files don't use precompiled headers, to save disk
   space, but you can switch PCH compiling on for greater speed.
   NOTE: you may also use samples/samples.dsw to access all
   sample projects without opening each workspace individually.
   You can use the Batch Build facility to make several samples
   at a time.

Using makefiles:

1. If you do NOT have the TIFF or JPEG source code, please remove
   the tiff and jpeg targets from the 'all' target in
   src\msw\makefile.vc. Also ensure the settings in
   include\wx\msw\setup.h specify not to use JPEG or TIFF.
2. Change directory to build\msw. Type:

  'nmake -f makefile.vc'

   to make the wxWindows core library as release DLL.
   See "Configuring the build" for instruction how to build debug or static
   libraries.
3. Change directory to samples and type 'nmake -f makefile.vc'
   to make all the samples. You can also make them individually.

Makefile notes:

  Use the 'clean' target to clean all objects, libraries and
  executables.

Note (1): if you wish to use templates, please edit
include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
Without this, the redefinition of 'new' will cause problems in
the headers. Alternatively, #undef new before including template headers.
You will also need to set wxUSE_IOSTREAMH to 0 if you will be
using templates, to avoid the non-template stream files being included
within wxWindows.

Note (2): libraries and applications generated with makefiles and
project files are now (hopefully) compatible where static libraries
are concerned, but please exercise caution nevertheless and if
possible, use one method or the other.

Note (3): VC++ 5's optimization code seems to be broken and can
cause both compile and run-time problems: this can be seen when
deleting an object Dialog Editor, in Release mode with optimizations
on. If in doubt, switch off optimisations, although this will result in much
larger executables. It seems possible that the library can be created with
strong optimization, so long as the application is not strongly
optimized. For example, in wxWindows project, set to 'Minimum
Size'. In Dialog Editor project, set to 'Customize: Favor Small
Code' (and no others). This will then work.

Note (4): some crash problems can be due to inconsistent compiler
options. If strange/weird/impossible things start to happen please
check (dumping IDE project file as makefile and doing text comparison
if necessary) that the project settings, especially the list of defined
symbols, struct packing, etc. are exactly the same for all items in
the project. After this, delete everything (including PCH) and recompile.

Note (5): to create your own IDE files, see the technical note on the
wxWindows web site or CD-ROM, entitled "Compiling wxWindows
applications in the VC++ IDE" (technical note docs/tech/tn0010.htm in the
wxWindows distribution). You can also copy .dsp and .dsw
files from an existing wxWindows sample and adapt them.


Visual C++ 1.5 compilation (16-bit)
-----------------------------------

No longer supported


Borland C++ 5.0/5.5 compilation
-------------------------------

Compiling using the makefiles (updated 24 Sept 02):

1. Change directory to build\msw. Type 'make -f makefile.bcc' to
   make the wxWindows core library. Ignore the compiler warnings.
   This produces a couple of librarie in the lib\bcc_mswdll directory.

2. Change directory to a sample or demo such as samples\minimal, and type
  'make -f makefile.bcc'. This produces a windows exe file - by default 
   in the bcc_mswdll subdirectory.

Note (1): the wxWindows makefiles assume dword structure alignment. Please
make sure that your own project or makefile settings use the
same alignment, or you could experience mysterious crashes. To
change the alignment, change CPPFLAGS in build\msw\config.bcc.

Note (2): if you get undefined _SQL... symbols at link time,
either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
recompile wxWindows. The same applies if compiling using the IDE.


Note (3): If you wish debug messages to be sent to the console in
debug mode, edit makefile.bcc and change /aa to /Tpe in link commands.

Compiling using the IDE files: [Borland C++ 5.0, not Cbuilder]

1. Load src\bc32.ide from the file bc32.zip at 
   http://biolpc22.york.ac.uk/pub/ports/bcc32/wxwin21/ and select Release settings
2. Go to Options|Project... and specify the correct BC++ include and lib path for
   your file structure.
3. Press F9 to compile the wxWindows library.
4. Load samples\bc32.ide.
5. Go to Options|Project... and specify the correct BC++ include and lib path for
   your file structure.
6. Press F9 to compile the samples (build each node separately if
   you prefer, by right clicking and choose Build Node).
7. Run each sample: you may need to run from each sample's directory
   since some (notably the wxHTML samples) look for files
   relative to the working directory.

Note (1): the samples project file contains a selection of
samples, and not all samples. The remaining samples can be made
with the makefiles. See also the demos hierarchy which doesn't
have any BC++ project files yet.

Note (2): to make the png, zlib, jpeg and tiff libraries (needed for
some samples) you need to compile them with bc32.ide.

Note (3): the debug version of the wxWindows library is about 40 MB, and the
release version is around 5 MB.

See also the file docs/tech/tn0007.txt for further instructions and details
of how to create your own project files.

** REMEMBER **

In all of your wxWindows applications, your source code should include
the following preprocessor directive:

#ifdef __BORLANDC__
#pragma hdrstop
#endif

(check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for
more details)


Borland C++Builder IDE compilation
----------------------------------

1. Build the wxWindows libraries using the Borland make utility as
   specified in the section called "Borland C++ 5.0 compilation"
   above. (C++ Builder includes a stand-alone C++ compiler.  For example,
   C++ Builder 4.0 comes with C++ 5.4.)

2. You can use the process_sample_bcb.bat command which is in
   wxwindows\distrib\msw to generate a .mak or .bpr file for most of the
   samples [mak for Cbuilder 1-6; v4 and after will convert this to bpr]. 
   Execute this in the sampledirectory, passing the name of the cpp files 
   on the command line. For more details, see the instructions in 
   docs/tech/tn0004.htm or http://biolpc22.york.ac.uk/wx/bc/ide.html.

Borland 16 Bit compilation for Windows 3.1
------------------------------------------

The last version of wxWindows to support 16-bit compilation with Borland was
2.2.7 - Please download and read the instructions in that release

Watcom C++ 10.6/11 and OpenWatcom compilation
---------------------------------------------

1. Change directory to build\msw. Type 'wmake -f makefile.wat' to
   make the wxWindows core library.
2. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
   to make this sample. Repeat for other samples of interest.


Note (1): if your installation of Watcom doesn't have odbc32.lib file and
          you need it (i.e. you have wxUSE_ODBC=1), you can use the file
          from lib\watcom directory. See the notes in that directory.

Note (2): if variant.cpp is compiled with date/time class options, the linker
          gives up. So the date/time option is switched off for Watcom C++.
          Also, wxAutomationObject is not compiled with Watcom C++ 10.

Note (3): RawBitmaps won't work at present because they use unsupported template
          classes

Note (4): if Watcom can't read the precompiled header when building a sample,
          try deleting .pch files in build\msw\wat_* and compiling
          the sample again.


Metrowerks CodeWarrior compilation
----------------------------------

1. CodeWarrior Pro7 project files in XML format are already
   included in wxMSW-2.5.0.zip and the setup version.
2. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if
   you are working from the CVS version) to make sure the settings reflect
   what you want.  If you aren't sure, leave it alone and go with the
   default settings.  A few notes:
       - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL
       - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports
         will be rather confusing due to interactions with the MSL ANSI
         and runtime libs.
3. The project file to build the Win32 wxWindows libraries relies on the
   Batch File Runner plug-in.  This plug-in is not installed as part of
   a normal CW7 installation.  However, you can find this plug-in on the
   CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the
   "Batch File Post Linker".
4. If you choose not to install the Batch File Runner plug-in, then you
   need to do the following by hand:
      (1) Create the directories lib\cw7msw\include\wx and copy the file
          include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
          working from the CVS version) to lib\cw7msw\include\wx\setup.h
      (2) Create the directories lib\cw7mswd\include\wx and copy the file
          include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
          working from the CVS version) to lib\cw7mswd\include\wx\setup.h
5. Import src\wxWindowsW7.xml to create the project file wxWindowsW7.mcp.
   Store this project file in directory src.  You may get warnings about
   not being able to find certain project paths; ignore these warnings, the
   appropriate paths will be created during the build by the Batch File Runner.
6. Choose the wxlib Win32 debug or wxlib Win32 Release target and build.  You
   will get some warnings about hidden virtual functions, illegal conversions
   from const pointers to pointers, etc., all of which you can safely ignore.
   ***Note:  if you get errors that the compiler can't find "wx/setup.h", just
   stop the build and build again.  These errors occur because sometimes the
   compiler starts doing its thing before the copying of setup.h has completed.
7. The following libraries will be produced depending on chosen
   target:
       - wx_x86.lib             ANSI Release (static)
       - wx_x86_d.lib           ANSI Debug (static)
8. Sorry, I haven't had time yet to create and test unicode or DLL versions.
   Volunteers for this are welcome (as neither DLLs nor unicode builds are
   big priorities for me ;).
9. CodeWarrior Pro7 project files (in XML format) are also provided for some
   of the samples.  In particular, there are project files for the minimal,
   controls, dialogs, dnd, nd docview samples.  You can use these project
   files as templates for the other samples and for your own projects.
       - For example, to make a project file for the "newgrid" sample,
         just copy the project file for the "minimal" sample, minimalW7.mcp
         (made by importing minimalW7.xml into CodeWarrior), into the
         sample/newgrid directory, calling it newgridW7.mcp.  Open
         newgridW7.mcp and revise the project by deleting the files
         minimal.rc and minimal.cpp and adding the files griddemo.rc and
         griddemo.cpp.  Build and run....


Cygwin/MinGW compilation
------------------------

wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
releases, and MinGW. Cygwin can be downloaded from:

    http://sources.redhat.com/cygwin/

and MinGW from:

    http://www.mingw.org/

Both Cygwin and MinGW can be used with configure (assuming you have MSYS
installed in case of MinGW). You will need new enough MinGW version, preferably
MinGW 2.0 (ships with gcc3) or at least 1.0 (gcc-2.95.3). GCC versions older
than 2.95.3 don't work; you can use wxWindows 2.4 with them.

NOTE: some notes specific to old Cygwin (< 1.1.x) are at the end of this
      section (see OLD VERSIONS)

There are two methods of compiling wxWindows, by using the
makefiles provided or by using 'configure'.

Retrieve and install the latest version of Cygwin, or MinGW, as per
the instructions with either of these packages.

If using MinGW, you can download the add-on MSYS package to
provide Unix-like tools that you'll need to build wxWindows using configure.

Using makefiles directly
------------------------

NOTE: The makefile are for compilation under Cygwin, MSYS, or
      command.com/cmd.exe, they won't work in other environments
      (such as UNIX)

Here are the steps required using the provided makefiles:

- If you are using gcc-2.95, edit build\msw\config.gcc and set the GCC_VERSION
  variable to "2.95".

- Use the makefile.gcc files for compiling wxWindows and samples,
  e.g. to compile a debugging version of wxWindows:
  > cd c:\wx\build\msw
  > make -f makefile.gcc BUILD=debug
  > cd c:\wx\samples\minimal
  > make -f makefile.gcc BUILD=debug
  (See below for more options.)

  Ignore the warning about the default entry point.

- Use the 'strip' command to reduce executable/dll size (note that
  stripping an executable/dll will remove debug information!).

All targets have 'clean' targets to allow removal of object files
and other intermediate compiler files.

Using configure
===============

Instead of using the makefiles, you can use the configure
system to generate appropriate makefiles, as used on Unix
and Mac OS X systems.

Change directory to the root of the wxWindows distribution,
make a build directory, and run configure and make in this directory.

For example:

  cd $WXWIN
  mkdir build-debug
  cd build-debug
  ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared
  make
  make install % This step is optional, see note (8) below.
  cd samples/minimal
  make
  ./minimal.exe

Notes:

1. See also the Cygwin/MinGW on the web site or CD-ROM for
   further information about using wxWindows with these compilers.

2. libwx.a is 100 MB or more - but much less if compiled with no
   debug info (-g0) and level 4 optimization (-O4).

3. If you get a link error under MinGW 2.95.2 referring to:

   EnumDAdvise__11IDataObjectPP13IEnumSTATDATA@8

   then you need to edit the file objidl.h at line 663 and add
   a missing PURE keyword:

   STDMETHOD(EnumDAdvise)(THIS_ IEnumSTATDATA**) PURE;

4. There's a bug in MinGW headers for some early distributions.

   in include/windows32/defines.h, where it says:

   #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)

   it should say:

   #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)

   (a missing bracket).

5. OpenGL support should work with MinGW as-is. However,
   if you wish to generate import libraries appropriate either for
   the MS OpenGL libraries or the SGI OpenGL libraries, go to
   include/wx/msw/gl and use:

     dlltool -k -d opengl.def -llibopengl.a

   for the SGI DLLs, or

     dlltool -k -d opengl32.def -llibopengl32.a

   and similarly for glu[32].def.

6. The 'make install' step is optional, and copies files
   as follows:

   /usr/local/lib - wxmswXYZd.dll.a and wxmswXYZd.dll
   /usr/local/include/wx - wxWindows header files
   /usr/local/bin - wx-config

   You may need to do this if using wx-config with the
   default root path.

7. With Cygwin, you can invoke gdb --nw myfile.exe to
   debug an executable. If there are memory leaks, they will be
   flagged when the program quits. You can use Cygwin gdb
   to debug MinGW executables.


OLD VERSIONS:

- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
  to set up appropriate variables, if necessary mounting drives.
  Run it before compiling.

- For Cygwin, make sure there's a \tmp directory on your
  Windows drive or bison will crash (actually you don't need
  bison for ordinary wxWindows compilation: a pre-generated .c file is
  supplied).

- If using GnuWin32 b18, you will need to copy windres.exe
  from e.g. the MinGW distribution, to a directory in your path.


Symantec & DigitalMars C++ compilation
------------------------
The DigitalMars compiler is a free succssor to the Symantec compiler
and can be downloaded from http://www.digitalmars.com/
   
1. You need to download and unzip in turn (later packages will overwrite
   older files)
    Digital Mars C/C++ Compiler Version 8.33 
    Basic utilities
    beta test C++ Compiler Version 8.34
   from http://www.digitalmars.com/download/freecompiler.html [02 may 03, CE]

2. Change directory to build\msw. Type 'make -f makefile.dm' to
   make the wxWindows core library.
3. Change directory to wx\samples\minimal and type 'make -f makefile.dm'
   to make this sample. The mdi and image sample also work; others may give
   linker erros due to missing libraries

16-bit compilation is no longer supported.


Configuring the build
=====================

                   CONFIGURING THE BUILD


  To build Unicode versions of the libraries, add UNICODE=1
  to the nmake invocation (default is UNICODE=0). If you want to
  be able to use Unicode version on Windows9x, you will need
  MSLU (Microsoft Layer for Unicode) runtime DLL and import lib.
  The former can be downloaded from Microsoft, the latter is part
  of the latest Platform SDK from Microsoft (see msdn.microsoft.com
  for details). An alternative implementation of import library can
  be downloaded from http://libunicows.sourceforge.net - unlike the
  official one, this one works with other compilers and does not
  require 300+ MB Platform SDK update. Add MSLU=1 to the nmake
  invocation to enable MSLU.


General Notes
-------------

- Debugging: under Windows 95, debugging output isn't output in
  the same way that it is under NT or Windows 3.1.
  Please see DebugView (bin/dbgview.exe in the distribution), also
  available from http://www.sysinternals.com and on the wxWindows CD-ROM
  under Packages.

- If you are installing wxWindows 2 from CVS, you may find that
  include/wx/msw/setup.h is missing. This is deliberate, to avoid
  developers' different setup.h configurations getting confused.
  Please copy setup0.h to setup.h before compiling. Also, read
  the BuildCVS.txt for other hints.