-
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.
+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.
-Please note that the library naming conventions for VC++
-compilation have changed after 2.3.1. This means that
-you will need to change your application project files. See the
-relevant section below for details.
IMPORTANT NOTE: If you experience problems installing, please
re-read this instructions and other related files (changes.txt,
http://sourceforge.net/bugs/?group_id=9863
+
Unarchiving
-----------
- tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
the same document source.
+
General installation notes
--------------------------
Alter your WXWIN environment variable to point to the root directory of the
-wxWindows installation. For Cygwin or Mingw32 compilation, make sure WXWIN
+wxWindows installation. For Cygwin or MinGW compilation, make sure WXWIN
contains only forward slashes.
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.
+compiler. Search for one of Microsoft/Borland/Watcom/Symantec/Metrowerks/
+Cygwin/Mingw32 to quickly locate the instructions for your compiler.
-Visual C++ 6.0 compilation
----------------------------
-Please note that the VC++ 6.0 project files will work for
-VC++ .NET also, but you must open the .dsp files and not the .dsw
-files.
+Microsoft Visual C++ compilation
+--------------------------------
-Using project files (VC++ 6 only):
+Please note that the VC++ 6.0 project files will work for VC++ .NET also, but
+you must open the .dsp files and not the .dsw files and in this case you will
+need to manually build the other .dsp on which wxWindows.dsp depends: jpeg,
+png, regex, tiff and zlib.
+
+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 src/wxWindows.dsp, which has configurations for static
+2. Open src/wxWindows.dsw, which has configurations for static
compilation or DLL compilation, and each of these available in
Unicode/ANSI and Debug/Release variations. Normally you'll use
a static linking ANSI configuration. Choose the Win32 Debug or
doesn't occur when using project files to build wxWindows.
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
+ 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
+ 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
To build the DLL version using makefiles:
-1. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll pch'
+1. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll'
to make both a suitable DLL and import library, and to build a
suitable precompiled header file for compiling applications.
See the previous section for library names.
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)
-----------------------------------
Use the 'clean' target to clean all objects, libraries and
executables.
+
Borland C++ 4.5/5.0/5.5 compilation
-------------------------------
1. Make sure your WXWIN variable is set [e.g add
set WXWIN=c:\wxwindows
to your autoexec.bat file], The WXWIN variable should contain neither spaces nor -
- You may like to use the short form as shown by a dos directory listing ;
+ You may like to use the short form as shown by a dos directory listing ;
eg instead of c:\wxwindows-2.5.0 use c:\wxwind~1.4
- Reboot if needed for the changes to autoexec.bat to take effect.
+ Reboot if needed for the changes to autoexec.bat to take effect.
2. Change directory to src\msw. Type 'make -f makefile.b32' to
make the wxWindows core library. Ignore the compiler warnings.
This produces a library in the wxwindows\lib directory called
5. To make and use wxWindows as a DLL, type
'make -f makefile.b32 clean'
'make -f makefile.b32 DLL=1'
- which generates a DLL (wx32d.dll) and import library (wx32d.lib),
+ which generates a DLL (wx32d.dll) and import library (wx32d.lib),
and then for each sample,
'make -f makefile.b32 WXUSINGDLL=1'
Please note that the samples have not been exhaustively tested
and second DLL using the commands
'make -f makefile.b32 clean'
'make -f makefile.b32 DLL=1 FINAL=1'
- which generates a DLL (wx32.dll) and import library (wx32.lib),
+ which generates a DLL (wx32.dll) and import library (wx32.lib),
and then for each sample,
'make -f makefile.b32 WXUSINGDLL=1 FINAL=1'
Note (1): In Borland 4.5 and earleir, using bcc.exe you also need to define BCCDIR
in the autoexec.bat file; like this:
set BCCDIR=c:\progra~1\borland\bcc
- so that it points to the root directory of
+ so that it points to the root directory of
your Borland C++ installation, and it uses the FAT (short
name) form with no spaces.
** REMEMBER **
-In all of your wxWindows applications, your source code should include
+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)
+(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++ 4.5/5.0 compilation"
samples [mak for Cbuilder 1-3; bpr for v4]. Execute this in the sample
directory, passing the name of the cpp files on the command line.
-Watcom C++ 10.6/11 compilation
----------------------------
+
+Watcom C++ 10.6/11 and OpenWatcom compilation
+---------------------------------------------
1. Make sure your WXWIN variable is set, and uses the DOS short
name form.
-2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat all' to
+2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat' to
make the wxWindows core library.
-3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat all'
+3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
to make this sample. Repeat for other samples of interest.
-Note (1): makewat.env uses the odbc32.lib supplied in wxWindows' 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++.
-Note (3): if Watcom can't read the precompiled header when
-building a sample, try deleting src\msw\watcom.pch and
-compiling the sample again.
+
+There are several makefile variables which may be modified:
+
+- FINAL may be set to 1 (e.g. 'wmake -f makefile.wat FINAL=1') to build
+ the release version of the library, i.e. without debug info and with
+ optimizations enabled
+
+- WATCOM_SUFFIX is appended to the names of all libraries produced by the
+ makefile -- this allows to use several compilers in the same wxWindows
+ source tree. If you only use Watcom compiler, set WATCOM_SUFFIX to nothing.
+
+- OUTPUTDIR may be set to the name of the directory where you want all the
+ object files to be generated (the library files are always created in
+ %WXWIN\lib). You may set it to nothing to create them in the same directory
+ as the sourcse, however using a separate directory is preferable if you use
+ several different compilers. If you change OUTPUTDIR, make sure that it is
+ either empty or has a trailing backslash!
+
+
+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): if Watcom can't read the precompiled header when building a sample,
+ try deleting src\msw\watcom.pch and compiling the sample again.
+
Metrowerks CodeWarrior compilation
----------------------------------
-1. CodeWarrior Pro7 project files in XML format are already
+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
+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
+ - 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
+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
+ (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
+ (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
+ 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
+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
+ ***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
+ 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
+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/Mingw32 compilation
-----------------------------------
+
+Cygwin/MinGW compilation
+------------------------
wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
-releases, and Mingw32. Cygwin can be downloaded from:
+releases, and MinGW. Cygwin can be downloaded from:
- http://sources.redhat.com/cygwin
+ http://sources.redhat.com/cygwin/
-and Mingw32 from:
+and MinGW from:
- http://www.mingw.org
+ http://www.mingw.org/
-Both Cygwin and MinGW can be used with the same makefiles.
+Both Cygwin and MinGW can be used with the same makefiles, and both can be
+used with configure. However the (strongly) preferred way to build wxWindows
+is using configure with Cygwin and using the makefiles with MinGW as these
+configurations are test much more often than the remaining two and so are much
+more likely to work out of the box.
-NOTE: some notes specific to old Cygwin ( < 1.1.x )
- and MinGW ( < 1.0 ) are at the end of this section
- ( see OLD VERSIONS )
+
+NOTE: some notes specific to old Cygwin (< 1.1.x)
+ and MinGW (< 1.0) 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 Mingw32, as per
+Retrieve and install the latest version of Cygwin, or MinGW, as per
the instructions with either of these packages.
-If using Mingw32, you can download the add-on MSYS package to
+If using MinGW, you can download the add-on MSYS package to
provide Unix-like tools that you'll need to build wxWindows.
-
-The solution prior to MSYS was to download extra utilities from
+If you do not want to use MSYS, then you need to download extra utilities from
ports/mingw32 on the wxWindows ftp site or CD-ROM:
ftp://biolpc22.york.ac.uk/pub/ports/mingw32/extra.zip
-
-These should be extracted to a directory in your path. If you have
+
+These should be extracted to a directory in your path. If you have
already downloaded rm, cp, mv from elsewhere, or are using
MSYS, you won't need all of these files. However if using MSYS
and configure to build wxWindows, you will need to unzip the
Here are the steps required using the provided makefiles:
- Set your WXWIN variable to where wxWindows is installed.
- *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
+ *** IMPORTANT: For Cygwin/MinGW, use forward slashes in the path, not
backslashes.
- Edit src/makeg95.env and set the MINGW32 variable at the top of
- the file to either 1 (you have Mingw32) or 0 (if you have
- Cygwin). If using Mingw32, also set the MINGW32VERSION variable
- appropriately.
+ the file to either 1 (you have MinGW) or 0 (if you have
+ Cygwin); also set the MINGW32VERSION variable appropriately for your
+ GCC version.
- Use the makefile.g95 files for compiling wxWindows and samples,
e.g. to compile a debugging version of wxWindows:
> make -f makefile.g95 cleanall
> make -f makefile.g95 UNICODE=1
- Options can be combined ( e.g.: UNICODE=1 FINAL=1 )
+ Options can be combined (e.g.: UNICODE=1 FINAL=1)
Ignore the warning about the default entry point.
-- Use the 'strip' command to reduce executable size.
+- Use the 'strip' command to reduce executable/dll size (note that
+ stripping an executable/dll will remove debug information!).
- With Cygwin, you can invoke gdb --nw myfile.exe to
debug an executable. If there are memory leaks, they will be
and Mac OS X systems.
Change directory to the root of the wxWindows distribution,
-make a build directory, run 'sh', and then from this shell
-run configure and make.
+make a build directory, and run configure and make in this directory.
For example:
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/Mingw32 on the web site or CD-ROM for
+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 Mingw32 2.95.2 referring to:
+3. If you get a link error under MinGW 2.95.2 referring to:
EnumDAdvise__11IDataObjectPP13IEnumSTATDATA@8
STDMETHOD(EnumDAdvise)(THIS_ IEnumSTATDATA**) PURE;
-4. There's a bug in Mingw32 headers for some early distributions.
+4. There's a bug in MinGW headers for some early distributions.
in include/windows32/defines.h, where it says:
6. If there's a problem executing the windres program, try
commenting out RCPREPROCESSOR in makeg95.env.
-7. OpenGL support should work with Mingw32 as-is. However,
+7. 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:
and similarly for glu[32].def.
+8. 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.
+
OLD VERSIONS:
-- If using Mingw32 2.95 and below with wxWindows 2.1 or above, you
+- If using MinGW 2.95 and below with wxWindows 2.1 or above, you
must hand-patch with Mingw32-gcc295.patches (located in the
- top-level of the wxWindows 2 installation). Mingw32 2.95.2
+ top-level of the wxWindows 2 installation). MinGW 2.95.2
and above contain the fixes already.
- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
supplied).
- If using GnuWin32 b18, you will need to copy windres.exe
- from e.g. the Mingw32 distribution, to a directory in your path.
+ from e.g. the MinGW distribution, to a directory in your path.
+
Symantec C++ compilation
------------------------
Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
Step (2). 16-bit compilation is left as an exercise for the user!
+
Salford C++ compilation
-----------------------
at 40MB :-) However, wxWindows at least makes a good test suite for
improving the compiler.
+
TWIN32 and gcc on Linux
-----------------------
For some reason, I found I had to copy TWIN32's Windows resource
compiler (rc) to the current working directory for it to be found.
+
General Notes
-------------