-Installing wxWindows 2.5.1
---------------------------
+Installing wxWidgets 2.6.2
+-----------------------------------------------------------
-This is wxWindows 2.5.1 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 lifetime.
+This is wxWidgets 2.6.2 for Microsoft Windows 9x/ME, Windows NT,
+Windows 2000, Windows XP and Windows CE.
+
+These installation notes can be found in docs/msw/install.txt
+in your wxWidgets distribution.
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
-===========
+============================================================
A setup program is provided (setup.exe) to automatically copy
files to a directory on your hard disk. Do not install into a
The setup program contains the following:
-- All common, generic and MSW-specific wxWindows source;
+- All common, generic and MSW-specific wxWidgets source;
- samples and demos;
- documentation in MS HTML Help format;
- makefiles for most Windows compilers, plus CodeWarrior,
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].
+the features you would like to compile wxWidgets with[out].
Compilation
===========
-The following sections explain how to compile wxWindows with each supported
+The following sections explain how to compile wxWidgets with each supported
compiler. Search for one of Microsoft/Borland/Watcom/Symantec/Metrowerks/
Cygwin/Mingw32 to quickly locate the instructions for your compiler.
Where compiled files are stored
-------------------------------
-After succesful compilation you'll find the libraries in a subdirectory
+After successful compilation you'll find the libraries in a subdirectory
of lib directory named after the compiler and DLL/static settings.
A couple of examples:
lib\bcc_lib Static libraries for Borland C++
lib\wat_dll Watcom C++ DLLs
-Names of compiled wxWindows libraries follow this scheme: libraries that don't
+Names of compiled wxWidgets 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
+build ('d'). Last component of them name is name of wxWidgets 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):
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).
+VC++ 5.0 can also be used, providing Service Pack 3 is applied. Without it
+you will have trouble with internal compiler errors. It is available for
+download at: ftp://ftp.microsoft.com/developr/visualstudio/sp3/full.
Using project files (VC++ 6 and later):
-1. Unarchive wxWindows-x.y.z-vc.zip, the VC++ 6 project
+1. Unarchive wxWidgets-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
'nmake -f makefile.vc'
- to make the wxWindows core library as release DLL.
+ to make the wxWidgets core library as release DLL.
See "Configuring the build" for instruction how to build debug or static
libraries.
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.
+within wxWidgets.
Note (2): libraries and applications generated with makefiles and
project files are now (hopefully) compatible where static libraries
the project. After this, delete everything (including PCH) and recompile.
Note (4): to create your own IDE files, copy .dsp and .dsw
-files from an existing wxWindows sample and adapt them, or
+files from an existing wxWidgets sample and adapt them, or
visit http://wiki.wxwindows.org/wiki.pl?MSVC.
-Borland C++ 5.0/5.5 compilation
--------------------------------
+Microsoft Visual C++ compilation for 64-bit Windows
+----------------------------------------------------------------
+
+Visual Studio 2005 includes 64-bit compilers, though they are not installed by
+default; you need to select them during the installation. Both native 64-bit
+compilers and 32-bit hosted cross compilers are included, so you do not need a
+64-bit machine to use them (though you do to run the created executables).
+Visual C++ Express Edition does not include 64-bit compilers.
+
+64-bit compilers are also available in various SDKs, for example
+the .NET Framework SDK:
+ http://msdn.microsoft.com/netframework/programming/64bit/devtools/
+
+Using project files:
+
+1. Open the VC++ 6 workspace file: build\msw\wx.dsw. Visual Studio will then
+ convert the projects to the current Visual C++ project format.
+
+2. To add 64-bit targets, go to the 'Build' menu and choose 'Configuration
+ Manager...'. In the 'Active solution platform' drop down choose '<new>',
+ then you can choose either 'Itanium' or 'x64'.
+
+ For more detailed instructions see:
+ http://msdn2.microsoft.com/en-us/library/9yb4317s(en-us,vs.80).aspx
+
+ Note: 64-bit targets created this way will use the build directory of the
+ corresponding 32-bit target for some files. Therefore after building
+ for one CPU it is necessary to clean the build before building the
+ equivalent target for another CPU. We've reported the problem to MS
+ but they say it is not possible to fix it.
+
+3. To build, go to the 'Build' menu and choose 'Batch Build...'. Tick all the
+ all the 'x64|Debug' or all the 'Itanium|Debug' projects, and click 'Build'.
+
+ This will build a debug version of the static libs. The section above on
+ Visual C++ in general has more information about adjusting the settings to
+ build other configurations.
+
+4. To compile one of the samples open one of the sample projects, such as
+ samples\minimal\minimal.dsw. Visual Studio will convert the project as in
+ step 1, then add a 64-bit target as in step 2, and build.
+
+Using makefiles:
+
+1. Open a 64-bit build command prompt, for either x64 or Itanium. Change
+ directory to build\msw. Then for x64 type:
+
+ nmake -f makefile.vc TARGET_CPU=AMD64
+
+ or for Itanium:
-Compiling using the makefiles (updated 24 Sept 02):
+ nmake -f makefile.vc TARGET_CPU=IA64
+
+ This will build a debug version of wxWidgets DLLs. See "Configuring the
+ build" for instruction how to build other configurations such as a release
+ build or static libraries.
+
+2. Change to the directory of one of the samples such as samples\minimal. Type
+ the same command used to build the main library, for example for x64:
+
+ nmake -f makefile.vc TARGET_CPU=AMD64
+
+Notes:
+
+The versions of the VC++ 8 compiler included with some SDKs requires an
+additional library to be linked or the following error is received.
+
+ LNK2001 unresolved external symbol __security_check_cookie
+
+If you receive this error add bufferoverflowu.lib to link, e.g.:
+
+ nmake -f makefile.vc TARGET_CPU=AMD64 LDFLAGS=bufferoverflowu.lib
+
+See http://support.microsoft.com/?id=894573 for more information.
+
+Borland C++ compilation
+----------------------------------------------------------------
+
+The minimum version required is 5.5, which can be downloaded for free from:
+http://www.borland.com/products/downloads/download_cbuilder.html#
+
+Compiling using the makefiles:
1. Change directory to build\msw. Type 'make -f makefile.bcc' to
- make the wxWindows core library. Ignore the compiler warnings.
+ make the wxWidgets core library. Ignore the compiler warnings.
This produces a couple of libraries in the lib\bcc_lib 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_mswd subdirectory.
-Note (1): the wxWindows makefiles assume dword structure alignment. Please
+Note (1): the wxWidgets 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.
+recompile wxWidgets. 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 for Borland C++ 5.0: not supported - please
-use version 2.4.1 (using the make utility in commandline mode works fine_
+Cmpilation succeeds with CBuilderX personal edition and CBuilder6, but
+you may have to copy make.exe from the 5.5 download to the new bin directory.
+Compiling using the IDE files for Borland C++ 5.0 and using CBuilder IDE
+(v1-v6): not supported
-Compiling using CBuilder (v1-v6): not supported - please
-use version 2.4.1 (using the make utility in commandline mode works fine_
** REMEMBER **
-In all of your wxWindows applications, your source code should include
+In all of your wxWidgets applications, your source code should include
the following preprocessor directive:
#ifdef __BORLANDC__
more details)
Borland 16 Bit compilation for Windows 3.1
-------------------------------------------
+----------------------------------------------------------------
-The last version of wxWindows to support 16-bit compilation with Borland was
+The last version of wxWidgets 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.
+ make the wxWidgets core library.
2. Change directory to samples\minimal and type 'wmake -f makefile.wat'
to make this sample. Repeat for other samples of interest.
the sample again.
Metrowerks CodeWarrior compilation
-----------------------------------
+----------------------------------------------------------------
-1. CodeWarrior Pro7 project files in XML format are already
- included in wxMSW-2.5.1.zip and the setup version.
+1. CodeWarrior Pro 7 project files in XML format are already
+ included in wxMSW-2.6.2.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
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
+3. The project file to build the Win32 wxWidgets 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
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.
+5. Import src\wxWidgetsW7.xml to create the project file wxWidgetsW7.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.
Cygwin/MinGW compilation
-------------------------
+----------------------------------------------------------------
-wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
+wxWidgets supports Cygwin (formerly GnuWin32) betas and
releases, and MinGW. Cygwin can be downloaded from:
http://sources.redhat.com/cygwin/
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.
+than 2.95.3 don't work; you can use wxWidgets 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
+There are two methods of compiling wxWidgets, 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.
+provide Unix-like tools that you'll need to build wxWidgets 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)
+NOTE: The makefile.gcc makefiles are for compilation under MinGW using
+ native make and Windows command interpreter (command.com/cmd.exe), they
+ won't work in other environments (such as UNIX or Unix-like, e.g. MSYS;
+ you have to use configure instead)
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:
+- Use the makefile.gcc files for compiling wxWidgets and samples,
+ e.g. to compile a debugging version of wxWidgets:
> cd c:\wx\build\msw
> make -f makefile.gcc BUILD=debug
> cd c:\wx\samples\minimal
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,
+Change directory to the root of the wxWidgets distribution,
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.
+ make install % This step is optional, see note (6) 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.
+ further information about using wxWidgets 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).
as follows:
/usr/local/lib - wxmswXYZd.dll.a and wxmswXYZd.dll
- /usr/local/include/wx - wxWindows header files
+ /usr/local/include/wx - wxWidgets header files
/usr/local/bin - wx-config
You may need to do this if using wx-config with the
flagged when the program quits. You can use Cygwin gdb
to debug MinGW executables.
+8. Note that gcc's precompiled headers do not work on current versions of
+ Cygwin. If your version of Cygwin is affected you will need to use the
+ --disable-precomp-headers configure option.
+
OLD VERSIONS:
- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
- 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
+ bison for ordinary wxWidgets compilation: a pre-generated .c file is
supplied).
- If using GnuWin32 b18, you will need to copy windres.exe
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.38 or later
+ Digital Mars C/C++ Compiler Version 8.40 or later
Basic utilities
from http://www.digitalmars.com/download/freecompiler.html
2. Change directory to build\msw and type 'make -f makefile.dmc' to
- make the wxWindows core library.
+ make the wxWidgets core library.
3. Change directory to samples\minimal and type 'make -f makefile.dmc'
to make this sample. Most of the other samples also work.
16-bit compilation is no longer supported.
Configuring the build
-=====================
+================================================================
-So far the instructions only explained how to build release DLLs of wxWindows
+So far the instructions only explained how to build release DLLs of wxWidgets
and did not cover any configuration. It is possible to change many aspects of
the build, including debug/release and ANSI/Unicode settings. All makefiles in
build\msw directory use same options (with a few exceptions documented below)
names and in make invocation command.
Changing the settings
----------------------
+----------------------------------------------------------------
There are two ways to modify the settings: either by passing the values as
arguments when invoking make or by editing build\msw\config.$(compiler) file
where $(compiler) is same extension as the makefile you use has (see below).
The latter is good for setting options that never change in your development
process (e.g. GCC_VERSION or VENDOR). If you want to build several versions of
-wxWindows and use them side by side, the former method is better. Settings in
+wxWidgets and use them side by side, the former method is better. Settings in
config.* files are shared by all makefiles (samples, contrib, main library),
but if you pass the options as arguments, you must use same arguments you used
for the library when building samples or contrib libraries!
MinGW using native makefiles:
> mingw32-make -f makefile.gcc BUILD=debug UNICODE=1
-MinGW using configure or Cygwin:
+MinGW using configure:
> ./configure --enable-debug --enable-unicode
(see ./configure --help on details; configure is not covered in this
section)
+Cygwin using configure:
+ > ./configure --disable-precomp-headers --enable-debug --enable-unicode
+ (use --disable-precomp-headers if Cygwin doesn't support precompiled
+ headers)
+
Brief explanation of options and possible values is in every
build\msw\config.* file; more detailed description follows.
Basic options
--------------
+----------------------------------------------------------------
-BUILD=debug
- Builds debug version of the library (default is 'release'). This affects
- name of the library ('d' is appended), __WXDEBUG__ is defined and debug
- information compiled into object files and the executable.
+BUILD=release
+ Builds release version of the library. It differs from default 'debug'
+ in lack of appended 'd' in name of library, does not define __WXDEBUG__
+ and not include debug information compiled into object files and the
+ executable.
-SHARED=0
- Build static libraries instead of DLLs. By default, DLLs are build
- (SHARED=1).
+SHARED=1
+ Build shared libraries (DLLs). By default, DLLs are not built
+ (SHARED=0).
UNICODE=1
To build Unicode versions of the libraries, add UNICODE=1 to make invocation
WXUNIV=1
Build wxUniversal instead of native wxMSW (see
- http://www.wxwindows.org/wxuniv.htm for more information).
+ http://www.wxwidgets.org/wxuniv.htm for more information).
Advanced options
-----------------
+----------------------------------------------------------------
MONOLITHIC=1
- Starting with version 2.5.1, wxWindows has the ability to be built as
+ Starting with version 2.5.1, wxWidgets has the ability to be built as
several smaller libraries instead of single big one as used to be the case
in 2.4 and older versions. This is called "multilib build" and is the
default behaviour of makefiles. You can still build single library
Do not build wxHTML library. If MONOLITHIC=1, then you must also
#define wxUSE_HTML 1 in setup.h.
+USE_XRC=0
+ Do not build XRC resources library. If MONOLITHIC=1, then you must also
+ #define wxUSE_HTML 1 in setup.h.
+
RUNTIME_LIBS=static
Links static version of C and C++ runtime libraries into the executable, so
that the program does not depend on DLLs provided with the compiler (e.g.
VENDOR=<your company name>
Set this to a short string identifying your company if you are planning to
- distribute wxWindows DLLs with your application. Default value is 'custom'.
- This string is included as part of DLL name. wxWindows DLLs contain compiler
+ distribute wxWidgets DLLs with your application. Default value is 'custom'.
+ This string is included as part of DLL name. wxWidgets DLLs contain compiler
name, version information and vendor name in them. For example
wxmsw250_core_bcc_custom.dll is one of DLLs build using Borland C++ with
default settings. If you set VENDOR=mycorp, the name will change to
wxmsw250_core_bcc_mycorp.dll.
CFG=<configuration name>
- Sets configuration name so that you can have multiple wxWindows build with
+ Sets configuration name so that you can have multiple wxWidgets builds with
different setup.h settings coexisting in same tree. See "Object and library
directories" below for more information.
Compiler specific options
--------------------------
+----------------------------------------------------------------
* MinGW
setting makes it possible.
Fine-tuning the compiler
-------------------------
+----------------------------------------------------------------
All makefiles have variables that you can use to specify additional options
passed to the compiler or linker. You won't need this in most cases, but if you
compiler), CPPFLAGS (for both C and C++ compiler) and LDFLAGS (the linker).
Object and library directories
-------------------------------
+----------------------------------------------------------------
All object files produced during library build are stored in a directory under
build\msw. It's name is derived from build settings and CFG variable and from
lib\bcc_dllMyBuild
etc.
-By now it is clear for CFG is for: builds with different CFG settings don't
+By now it is clear what CFG is for: builds with different CFG settings don't
share any files and they use different setup.h files. This allows you to e.g.
have two static debug builds, one with wxUSE_SOCKETS=0 and one with sockets
enabled (without CFG, both of them would be put into same directory and there
-would be conflict between the files).
+would be conflicts between the files).
General Notes
-=============
+=================================================================
- Debugging: under Windows 95, debugging output isn't output in
the same way that it is under NT or Windows 3.1.
projects / wxWidgets.git / blobdiff