-Installing wxWindows 2.5.0
+Installing wxWindows 2.5.1
--------------------------
-This is wxWindows 2.5.0 for Microsoft Windows 9x/ME, Windows NT, Windows 2000
+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 life time.
-
+change in backwards incompatible way during the 2.5 branch lifetime.
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
-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.
+path that contains spaces.
The setup program contains the following:
- All common, generic and MSW-specific wxWindows source;
-- samples;
-- documentation in Windows Help format;
+- samples and demos;
+- documentation in MS HTML 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.
+- Object Graphics Library, Tex2RTF, wxSTC, etc.
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
---------------------------
-
-Alter your WXWIN environment variable to point to the root directory of the
-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
===========
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 and DLL/staitc settings.
+A couple of examples:
+
+ lib\vc_lib VC++ compiled static libraries
+ lib\vc_dll VC++ DLLs
+ 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
+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
+
+Their Unicode debug counterparts in wxUniversal build would be
+
+ wxbase25ud.lib
+ wxbase25ud_net.lib
+ wxbase25ud_xml.lib (notice these libs are same for wxUniv and wxMSW)
+ wxmswuniv25ud_core.lib
+ wxmswuniv25ud_html.lib
+ wxmswuniv25ud_adv.lib
+
+These directories also contain subdirectory with wx/setup.h header. This
+subdirectory is named after port, Unicode, wxUniv and debug settings and
+you must add it to include paths when compiling your application. Some
+examples:
+
+ lib\vc_lib\msw\wx\setup.h VC++ static, wxMSW
+ lib\vc_lib\mswud\wx\setup.h VC++ static, wxMSW, Unicode, debug
+ lib\vc_lib\mswunivd\wx\setup.h VC++ static, wxUniversal, debug
+
+Below are compiler specific notes followed by customizing instructions that
+apply to all compilers (search for "Configuring the build").
Microsoft Visual C++ 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 and in this case you will
-need to manually build the other .dsp on which wxWindows.dsp depends: jpeg,
-png, regex, tiff and zlib.
+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
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.dsw, which has configurations for static
+2. Open build\msw\wx.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
- Win32 Release configuration for the wxWindows project, and compile.
- Alternatively, use Batch Build to build more than one
- configuration.
- The following libraries will be produced depending on chosen
- configuration:
-
- wxmsw.lib wxmswd.lib ; ANSI Release/Debug
- wxmswu.lib wxmswud.lib ; UNICODE Release/Debug
- wxmsw23x.lib wxmsw23xd.lib ; ANSI DLL Release/Debug
- wxmsw23xu.lib wxmsw23xud.lib ; UNICODE DLL Release/Debug
-
- It will also produce similar variations on jpeg.lib, png.lib,
- tiff.lib, zlib.lib, and regex.lib.
+ 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 (or any other that
+ suits your needs) and use Batch Build to compile _all_ projects. If you
+ know you won't need some of the libraries (i.e. html part), you don't have
+ to compile it. It will also produce similar variations on jpeg.lib,
+ png.lib, tiff.lib, zlib.lib, and regex.lib.
+ If you want to build DLLs, you have to either build them one by one in
+ proper order (jpeg, png, tiff, zlib, regex, expat, base, core, the rest
+ in any order) or to use wx_dll.dsw workspace which has correct dependencies.
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
Using makefiles:
-1. Make sure your WXWIN variable is set.
-2. 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.
-3. Change directory to wx\src\msw. Type:
+1. Change directory to build\msw. Type:
'nmake -f makefile.vc'
- to make the wxWindows core library with debug information
- (wx\lib\wxd.lib), then
+ to make the wxWindows core library as release DLL.
+ See "Configuring the build" for instruction how to build debug or static
+ libraries.
- 'nmake -f makefile.vc cleanall FINAL=1'
- 'nmake -f makefile.vc FINAL=1'
-
- to make the wxWindows core library without debug information.
-4. Change directory to wx\samples and type 'nmake -f makefile.vc'
+2. 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 'cleanall' target to clean all objects, libraries and
+ Use the 'clean' target to clean all objects, libraries and
executables.
- To build the release version using makefiles, add FINAL=1 to your
- nmake invocation, both when building the library and for samples.
- You MUST use the 'cleanall' target (with FINAL=1 or FINAL=0)
- before making a different configuration, because otherwise
- object files used to build the previous configuration may be
- used accidentally for the current configuration. You might see
- this manifested in unexpected link errors or warnings. This problem
- 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
- 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.
-
- Note that the wxWindows core library allows you to have debug
- and release libraries available simultaneously, by compiling the
- objects in different subdirectories, whereas samples must be
- cleaned and re-made to build a different configuration.
-
-To build the DLL version using makefiles:
-
-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.
-2. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
- (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
- applications).
-
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
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
+Note (3): 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
-
+Note (4): to create your own IDE files, copy .dsp and .dsw
+files from an existing wxWindows sample and adapt them, or
+visit http://wiki.wxwindows.org/wiki.pl?MSVC.
Borland C++ 5.0/5.5 compilation
-------------------------------
Compiling using the makefiles (updated 24 Sept 02):
-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 ;
- 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.
-2. Change directory to src\msw. Type 'make -f makefile.b32' to
+1. Change directory to build\msw. Type 'make -f makefile.bcc' to
make the wxWindows core library. Ignore the compiler warnings.
- This produces a library in the wxwindows\lib directory called
- wx32ds.lib
-3. Change directory to a sample or demo such as samples\minimal, and type
- 'make -f makefile.b32'. This produces a windows exe file
-4. For release versions, recompile wxWindows and samples using
- 'make -f makefile.b32 clean'
- 'make -f makefile.b32 FINAL=1'
- for the library and samples. This produces a library wx32s.lib eliminating
- all debugging information - if you wish to retain reduced debugging information
- 'make -f makefile.b32 clean'
- 'make -f makefile.b32 FINAL=hybrid'
-
-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),
- and then for each sample,
- 'make -f makefile.b32 WXUSINGDLL=1'
- Please note that the samples have not been exhaustively tested
- with this configuration. You may also generate a sepratae library
- 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),
- and then for each sample,
- 'make -f makefile.b32 WXUSINGDLL=1 FINAL=1'
-
-6. You can use the WXUNIVERSAL widgets instead of the native MSW
- ones (eg if you want to build an application with the same
- look and feel on all platforms)
- Use the command
- 'make -f makefile.b32 WXUSINGUNIV=1'
- Then run
- 'make -f makefile.b32 WXUSINGUNIV=1' in the sample directory which you wish
- to build using the wxUniversal widgets. Use 'SET WXTHEME=GTK' [or WIN32 or METAL]
- to test the existing themes
- The makefile is written with the intention that you can build DLLs
- and do final releases by combinations of commandline parameters.
- At the time of writing, (Oct 02) not all the wxDialogs are working
-
-7. To make console mode applications with wxWindows functions go
- to the src\msw directory
- 'make -f makebase.b32 clean'
- 'make -f makebase.b32'
- There is a sample\console directory and in this type
- 'make -f makefile.b32 wxUSE_GUI=0'
-
-Note (0): This provides the ability to produce separate wxwindows libraries
- for different purposes, and only have to rebuild the applications
-
-
-Note (1): the wxWindows makefiles assume byte structure alignment. Please
+ 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
make sure that your own project or makefile settings use the
same alignment, or you could experience mysterious crashes. To
-change the alignment, add a suitable option to the $(CFG) target code
-in src/msw/makefile.b32.
+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 src\makeb32.env and change /aa to /Tpe in
-LINK_FLAGS.
-
-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.
+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_
+
+Compiling using CBuilder (v1-v6): not supported - please
+use version 2.4.1 (using the make utility in commandline mode works fine_
** REMEMBER **
(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-3; bpr for v4]. Execute this in the sample
- directory, 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
------------------------------------------
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' to
+1. Change directory to build\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'
- to make this sample. Repeat for other samples of interest.
-
-
-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). Compilation will fail if you set it to an empty string
- to create them in the same directory as the source. If you change OUTPUTDIR,
- make sure that it does not have a trailing backslash!
-
-- In the samples, you may use EXEDIR=adir to build the samples in adir. Setting
- EXEDIR=. will build in the current directory,
+2. Change directory to 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
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.
+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.
+ included in wxMSW-2.5.1.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
- 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
(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,
+ - For example, to make a project file for the "grid" 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
+ sample/grid directory, calling it gridW7.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....
http://www.mingw.org/
-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.
-
+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)
- and MinGW (< 1.0) are at the end of this section
- (see OLD VERSIONS)
+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'.
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.
-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
-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
-following files from extra.zip and place them in e.g. an
-extrabin directory which you then add to your path:
-
- bison.exe bison.hairy bison.simple flex.exe
-
-You will also need to set these variables:
-
- set BISON_SIMPLE=c:\apps\mingw2.0.0-3\extrabin\bison.simple
- set BISON_HAIRY=c:\apps\mingw2.0.0-3\extrabin\bison.hairy
-
-Here we're setting them in DOS before invoking 'sh', but you
-could set them within the shell instead.
-
-The 'configure' method uses flex and bison, whereas the
-direct makefile method uses pregenerated C files.
+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
Here are the steps required using the provided makefiles:
-- Set your WXWIN variable to where wxWindows is installed.
- *** IMPORTANT: For Cygwin/MinGW, use forward slashes in the path, not
- backslashes.
+- If you are using gcc-2.95, edit build\msw\config.gcc and set the GCC_VERSION
+ variable to "2.95".
-- Edit src/makeg95.env and set the MINGW32 variable at the top of
- 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,
+- Use the makefile.gcc files for compiling wxWindows and samples,
e.g. to compile a debugging version of wxWindows:
- > cd c:\wx\src\msw
- > make -f makefile.g95 clean
- > make -f makefile.g95
- > cd c:\wx\samples\minimal
- > make -f makefile.g95 cleanall
- > make -f makefile.g95
-
- to compile with optimizations:
- > cd c:\wx\src\msw
- > make -f makefile.g95 clean
- > make -f makefile.g95 FINAL=1
- > cd c:\wx\samples\minimal
- > make -f makefile.g95 cleanall
- > make -f makefile.g95 FINAL=1
-
- to compile a DLL:
- > cd c:\wx\src\msw
- > make -f makefile.g95 clean
- > make -f makefile.g95 WXMAKINGDLL=1
- > cd c:\wx\samples\minimal
- > make -f makefile.g95 cleanall
- > make -f makefile.g95 WXUSINGDLL=1
-
- to compile the Unicode version:
- > cd c:\wx\src\msw
- > make -f makefile.g95 clean
- > make -f makefile.g95 UNICODE=1
+ > cd c:\wx\build\msw
+ > make -f makefile.gcc BUILD=debug
> cd c:\wx\samples\minimal
- > make -f makefile.g95 cleanall
- > make -f makefile.g95 UNICODE=1
-
- Options can be combined (e.g.: UNICODE=1 FINAL=1)
+ > 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!).
-- 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.
-
All targets have 'clean' targets to allow removal of object files
-and other intermediate compiler files and 'cleanall' targets to
-allow removal of all object files and library 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
(a missing bracket).
-5. If there's a problem with the copy or remove commands in
- src/msw/makefile.g95, you may need to change the COPY and
- RM variables in makeg95.env.
-
-6. If there's a problem executing the windres program, try
- commenting out RCPREPROCESSOR in makeg95.env.
-
-7. OpenGL support should work with MinGW as-is. However,
+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:
and similarly for glu[32].def.
-8. The 'make install' step is optional, and copies files
+6. The 'make install' step is optional, and copies files
as follows:
/usr/local/lib - wxmswXYZd.dll.a and wxmswXYZd.dll
You may need to do this if using wx-config with the
default root path.
-OLD VERSIONS:
+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.
-- 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). MinGW 2.95.2
- and above contain the fixes already.
+OLD VERSIONS:
- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
to set up appropriate variables, if necessary mounting drives.
- 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.34 or 8.35
+ Basic utilities
+ from http://www.digitalmars.com/download/freecompiler.html [26 Aug 03, CE]
+
+2. Change directory to src\msw. Type 'make -f makefile.sc' to
+ make the wxWindows core library.
+3. Change directory to samples\minimal and type 'make -f makefile.sc'
+ to make this sample. Most of the other samples also work.
-Symantec C++ compilation
-------------------------
-1. Make sure your WXWIN variable is set, and uses the FAT (short
- name) form.
-2. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
-3. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
- make the wxWindows core library.
-4. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
- to make this sample.
+16-bit compilation is no longer supported.
-Note: the minimal sample doesn't link properly ('Error: no
-start address').
-32-bit compilation only (partially) supported at present, using SC++ 6.1.
-Some functionality is missing using this compiler (see makefile).
-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!
+Configuring the build
+=====================
+So far the instructions only explained how to build release DLLs of wxWindows
+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)
+and the only difference between them is in object files and library directory
+names and in make invocation command.
-Salford C++ compilation
------------------------
+Changing the settings
+---------------------
-1. Make sure your WXWIN variable is set, and uses the FAT (short
- name) form.
-2. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
- notes.
-3. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
- make the wxWindows core library.
-4. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
- to make this sample.
+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
+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!
-Unfortunately, Salford C++ seems to have problems with its code generation for
-operations on objects, as seen in wxFrame::OnMenuHighlight
-(minimal sample) or wxWindow::SetValidator (mdi sample). Also the
-the debugging version of the library is 90MB, with samples coming in
-at 40MB :-) However, wxWindows at least makes a good test suite for
-improving the compiler.
+Examples of invoking make in Unicode debug build (other options described
+below are set analogically):
+Visual C++:
+ > nmake -f makefile.vc BUILD=debug UNICODE=1
-TWIN32 and gcc on Linux
------------------------
+Borland C++:
+ > make -f makefile.bcc -DBUILD=debug -DUNICODE=1
+ (Note that you have to use -D to set the variable, unlike in other make
+ tools!)
-The wxWindows 2 for Windows port may be compiled using
-the TWIN32 emulator package from www.willows.com. However,
-TWIN32 is by no means finished so this should be taken as
-something to think about for the future, rather than
-a tool for writing products with.
+Watcom C/C++:
+ > wmake -f makefile.wat BUILD=debug UNICODE=1
-Use makefile.twn in much the same way as makefile.g95, as
-described above. Not all sample makefiles are supplied yet.
+MinGW using native makefiles:
+ > mingw32-make -f makefile.gcc BUILD=debug UNICODE=1
-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.
+MinGW using configure or Cygwin:
+ > ./configure --enable-debug --enable-unicode
+ (see ./configure --help on details; configure is not covered in this
+ section)
+Brief explanation of options and possible values is in every
+build\msw\config.* file; more detailed description follows.
-General Notes
+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.
+
+SHARED=0
+ Build static libraries instead of DLLs. By default, DLLs are build
+ (SHARED=1).
+
+UNICODE=1
+ To build Unicode versions of the libraries, add UNICODE=1 to make invocation
+ (default is UNICODE=0). If you want to be able to use Unicode version on
+ Windows9x, you will need to set MSLU=1 as well.
+
+ This option affect name of the library ('u' is appended) and the directory
+ where the library and setup.h are store (ditto).
+
+WXUNIV=1
+ Build wxUniversal instead of native wxMSW (see
+ http://www.wxwindows.org/wxuniv.htm for more information).
+
+Advanced options
+----------------
+
+MONOLITHIC=1
+ Starting with version 2.5.1, wxWindows 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
+ ("monolithic build") by setting MONOLITHIC variable to 1.
+
+USE_GUI=0
+ Disable building GUI parts of the library, build only wxBase components used
+ by console applications. Note that if you leave USE_GUI=1 then both wxBase
+ and GUI libraries are built. If you are building monolithic library, then
+ you should set wxUSE_GUI to 1 in setup.h.
+
+USE_OPENGL=1
+ Build wxmsw25_gl.lib library with OpenGL integration class wxGLCanvas.
+ You must also modify your setup.h to #define wxUSE_GLCANVAS 1. Note that
+ OpenGL library is always built as additional library, even in monolithic
+ build!
+
+USE_ODBC=1
+ Build two additional libraries in multilib mode, one with database
+ classes and one with wxGrid database support. You must
+ #define wxUSE_ODBC 1 in setup.h
+
+USE_HTML=0
+ Do not build wxHTML 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.
+ Visual C++'s msvcrt.dll or Borland's cc3250mt.dll).
+ Caution: Do not use static runtime libraries when building DLL (SHARED=1)!
+
+MSLU=1
+ Enables MSLU (Microsoft Layer for Unicode). This setting makes sense only if
+ used together with UNICODE=1. 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.
+
+DEBUG_FLAG=0
+DEBUG_FLAG=1
+ If set to 1, define __WXDEBUG__ symbol, append 'd' to library name and do
+ sanity checks at runtime. If set to 0, don't do it. By default, this is
+ governed by BUILD option (if 'debug', DEBUG_FLAG=1, if 'release' it is 0),
+ but it is sometimes desirable to modify default behaviour and e.g. define
+ __WXDEBUG__ even in release builds.
+
+DEBUG_INFO=0
+DEBUG_INFO=1
+ Same as DEBUG_FLAG in behaviour, this option affects whether debugging
+ information is included in the executable or not.
+
+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
+ 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
+ different setup.h settings coexisting in same tree. See "Object and library
+ directories" below for more information.
+
+Compiler specific options
+-------------------------
+
+* MinGW
+
+If you are using gcc-2.95 instead of gcc3, you must set GCC_VERSION to
+2.95. In build\msw\config.gcc, change
+> GCC_VERSION = 3
+to
+> GCC_VERSION = 2.95
+
+* Visual C++
+
+DEBUG_RUNTIME_LIBS=0
+DEBUG_RUNTIME_LIBS=1
+ If set to 1, msvcrtd.dll is used, if to 0, msvcrt.dll is used. By default
+ msvcrtd.dll is used only if the executable contains debug info and
+ msvcrt.dll if it doesn't. It is sometimes desirable to build with debug info
+ and still link against msvcrt.dll (e.g. when you want to ship the app to
+ customers and still have usable .pdb files with debug information) and this
+ 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
+do, simply add desired flags to CFLAGS (for C compiler), CXXFLAGS (for C++
+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
+compiler name. Examples of directory names:
+
+ build\msw\bcc_msw SHARED=0
+ build\msw\bcc_mswdll SHARED=1
+ build\msw\bcc_mswunivd SHARED=0, WXUNIV=1, BUILD=debug
+ build\msw\vc_mswunivd ditto, with Visual C++
+
+Libraries and DLLs are copied into subdirectory of lib directory with
+name derived from compiler and static/DLL setting and setup.h into directory
+with name that contains other settings:
+
+ lib\bcc_msw
+ lib\bcc_lib\msw\wx\setup.h
+ lib\bcc_dll
+ lib\bcc_dll\msw\wx\setup.h
+ lib\bcc_lib
+ lib\bcc_lib\mswunivd\wx\setup.h
+ lib\vc_lib
+ lib\vc_lib\mswunivd\wx\setup.h
+
+Each lib\ subdirectory has wx subdirectory with setup.h as seen above.
+This file is copied there from include\wx\msw\setup.h (and if it doesn't exist,
+from include\wx\msw\setup0.h) and this is the copy of setup.h that is used by
+all samples and should be used by your apps as well. If you are doing changes
+to setup.h, you should do them in this file, _not_ in include\wx\msw\setup.h.
+
+If you set CFG to something, the value is appended to directory names. E.g.
+for CFG=MyBuild, you'll have object files in
+
+ build\msw\bcc_mswMyBuild
+ build\msw\bcc_mswdllMyBuild
+ etc.
+
+and libraries in
+
+ lib\bcc_libMyBuild
+ lib\bcc_dllMyBuild
+ etc.
+
+By now it is clear for 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).
+
+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.
+ Please see DebugView available from http://www.sysinternals.com.
projects / wxWidgets.git / blobdiff