]> git.saurik.com Git - wxWidgets.git/blame - docs/msw/install.txt
accessor functions for wxAuiMDIParentFrame
[wxWidgets.git] / docs / msw / install.txt
CommitLineData
751f9954 1Installing wxWidgets 2.7.2
5147354c 2-----------------------------------------------------------
0544bc0a 3
751f9954 4This is wxWidgets 2.7.2 for Microsoft Windows 9x/ME, Windows NT,
5147354c
JS
5Windows 2000, Windows XP and Windows CE.
6
7These installation notes can be found in docs/msw/install.txt
8in your wxWidgets distribution.
0544bc0a 9
dbda9e86 10IMPORTANT NOTE: If you experience problems installing, please
9c6751aa 11re-read this instructions and other related files (changes.txt,
7666ad49
JS
12readme.txt, FAQ) carefully before mailing wx-users. Preferably,
13try to fix the problem first and then upload a patch to
14SourceForge:
15
16 http://sourceforge.net/patch/?group_id=9863
17
18Please report bugs using the SourceForge bug tracker:
19
20 http://sourceforge.net/bugs/?group_id=9863
dbda9e86 21
2bda0e17 22Unarchiving
5147354c 23============================================================
2bda0e17 24
2b5f62a0
VZ
25A setup program is provided (setup.exe) to automatically copy
26files to a directory on your hard disk. Do not install into a
3d82ef9b 27path that contains spaces.
2b5f62a0
VZ
28
29The setup program contains the following:
01dba85a 30
fc2171bd 31- All common, generic and MSW-specific wxWidgets source;
3d82ef9b
JS
32- samples and demos;
33- documentation in MS HTML Help format;
b9f933ab
JS
34- makefiles for most Windows compilers, plus CodeWarrior,
35 BC++ and VC++ IDE files;
01dba85a 36- JPEG library source;
669f7a11 37- TIFF library source;
3d82ef9b 38- Object Graphics Library, Tex2RTF, wxSTC, etc.
01dba85a 39
f6bcfd97
BP
40Alternatively, you may unarchive the .zip form by hand:
41wxMSW-x.y.z.zip where x.y.z is the version number.
2bda0e17
KB
42
43Unarchive the required files plus any optional documentation
dbda9e86 44files into a suitable directory such as c:\wx.
2bda0e17 45
dbda9e86 46General installation notes
03265572 47==========================
dbda9e86 48
dbda9e86 49If installing from the CVS server, copy include/wx/msw/setup0.h to
a40a9c81 50include/wx/msw/setup.h and edit the resulting file to choose
fc2171bd 51the features you would like to compile wxWidgets with[out].
dbda9e86 52
2bda0e17 53Compilation
545d1e60 54===========
2bda0e17 55
fc2171bd 56The following sections explain how to compile wxWidgets with each supported
545d1e60
VZ
57compiler. Search for one of Microsoft/Borland/Watcom/Symantec/Metrowerks/
58Cygwin/Mingw32 to quickly locate the instructions for your compiler.
59
fd9f42b6
VS
60All makefiles and project are located in build\msw directory.
61
62Where compiled files are stored
63-------------------------------
64
3980000c 65After successful compilation you'll find the libraries in a subdirectory
0a7cad3a 66of lib directory named after the compiler and DLL/static settings.
6acf2ef6 67A couple of examples:
fd9f42b6 68
6acf2ef6
VS
69 lib\vc_lib VC++ compiled static libraries
70 lib\vc_dll VC++ DLLs
71 lib\bcc_lib Static libraries for Borland C++
72 lib\wat_dll Watcom C++ DLLs
fd9f42b6 73
fc2171bd 74Names of compiled wxWidgets libraries follow this scheme: libraries that don't
fd9f42b6
VS
75depend on GUI components begin with "wxbase" followed by version number and
76letters indicating if the library is compiled as Unicode ('u') and/or debug
fc2171bd 77build ('d'). Last component of them name is name of wxWidgets component
fd9f42b6
VS
78(unless you built the library as single monolithic library; look for
79"Configuring the build" below). This is a typical set of release ANSI build
80libraries (release versions on left, debug on right side):
81
82 wxbase25.lib wxbase25d.lib
83 wxbase25_net.lib wxbase25d_net.lib
84 wxbase25_xml.lib wxbase25d_xml.lib
85 wxmsw25_core.lib wxmsw25d_core.lib
86 wxmsw25_html.lib wxmsw25d_html.lib
87 wxmsw25_adv.lib wxmsw25d_adv.lib
88
6acf2ef6
VS
89Their Unicode debug counterparts in wxUniversal build would be
90
91 wxbase25ud.lib
92 wxbase25ud_net.lib
93 wxbase25ud_xml.lib (notice these libs are same for wxUniv and wxMSW)
94 wxmswuniv25ud_core.lib
95 wxmswuniv25ud_html.lib
96 wxmswuniv25ud_adv.lib
97
98These directories also contain subdirectory with wx/setup.h header. This
99subdirectory is named after port, Unicode, wxUniv and debug settings and
100you must add it to include paths when compiling your application. Some
101examples:
102
103 lib\vc_lib\msw\wx\setup.h VC++ static, wxMSW
104 lib\vc_lib\mswud\wx\setup.h VC++ static, wxMSW, Unicode, debug
105 lib\vc_lib\mswunivd\wx\setup.h VC++ static, wxUniversal, debug
fd9f42b6
VS
106
107Below are compiler specific notes followed by customizing instructions that
108apply to all compilers (search for "Configuring the build").
109
545d1e60 110Microsoft Visual C++ compilation
5147354c 111----------------------------------------------------------------
2bda0e17 112
90985bde
VZ
113You may wish to visit http://wiki.wxwindows.org/wiki.pl?MSVC for a more
114informal and more detailed description of the process summarized below.
115
b2575739 116Please note that the VC++ 6.0 project files will work for VC++ .NET also.
1257f684 117
aee06d92
MW
118VC++ 5.0 can also be used, providing Service Pack 3 is applied. Without it
119you will have trouble with internal compiler errors. It is available for
120download at: ftp://ftp.microsoft.com/developr/visualstudio/sp3/full.
38c1f6f7
VZ
121
122Using project files (VC++ 6 and later):
a367b9b3 123
fc2171bd 1241. Unarchive wxWidgets-x.y.z-vc.zip, the VC++ 6 project
f6bcfd97 125 makefiles (already included in wxMSW-x.y.z.zip and the setup version).
fd9f42b6 1262. Open build\msw\wx.dsw, which has configurations for static
a40a9c81 127 compilation or DLL compilation, and each of these available in
fd9f42b6
VS
128 Unicode/ANSI, Debug/Release and wxUniversal or native variations.
129 Normally you'll use a static linking ANSI configuration.
efefa4f8
VS
130 Choose the Win32 Debug or Win32 Release configuration (or any other that
131 suits your needs) and use Batch Build to compile _all_ projects. If you
21de777f 132 know you won't need some of the libraries (i.e. html part), you don't have
efefa4f8 133 to compile it. It will also produce similar variations on jpeg.lib,
fd9f42b6 134 png.lib, tiff.lib, zlib.lib, and regex.lib.
3f04a3c0 135
3e09f6f1
VZ
136 If you want to build DLL configurations in wx.dsw project you unfortunately
137 need to build them in the proper order (jpeg, png, tiff, zlib, regex, expat,
138 base, net, odbc, core, gl, html, media, qa, adv, dbgrid, xrc, aui, richtext)
139 manually because VC6 doesn't always respect the correct build order.
140
141 Alternatively, use the special wx_dll.dsw project which adds the
142 dependencies to force the correct order (but, because of this, doesn't work
143 for the static libraries) or simply redo the build several times until all
144 DLLs are linked correctly. Pleae notice that it's normal that dbgrid project
145 doesn't build if wxUSE_ODBC is set to 0 (default).
5fa399c9 1463. Open a sample project file, choose a configuration such as
a40a9c81 147 Win32 Debug using Build | Set Active Configuration..., and compile.
5fa399c9 148 The project files don't use precompiled headers, to save disk
16553659 149 space, but you can switch PCH compiling on for greater speed.
a40a9c81 150 NOTE: you may also use samples/samples.dsw to access all
669f7a11
JS
151 sample projects without opening each workspace individually.
152 You can use the Batch Build facility to make several samples
153 at a time.
a367b9b3
JS
154
155Using makefiles:
156
03265572 1571. Change directory to build\msw. Type:
ca5c8b2d
JS
158
159 'nmake -f makefile.vc'
160
fc2171bd 161 to make the wxWidgets core library as release DLL.
fd9f42b6
VS
162 See "Configuring the build" for instruction how to build debug or static
163 libraries.
3d82ef9b 164
03265572 1652. Change directory to samples and type 'nmake -f makefile.vc'
2bda0e17
KB
166 to make all the samples. You can also make them individually.
167
5fa399c9 168Makefile notes:
e2a6f233 169
fd9f42b6 170 Use the 'clean' target to clean all objects, libraries and
ca5c8b2d
JS
171 executables.
172
3f1af920 173Note (1): if you wish to use templates, please edit
025e88c5
JS
174include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
175Without this, the redefinition of 'new' will cause problems in
176the headers. Alternatively, #undef new before including template headers.
dbda9e86
JS
177You will also need to set wxUSE_IOSTREAMH to 0 if you will be
178using templates, to avoid the non-template stream files being included
fc2171bd 179within wxWidgets.
025e88c5 180
3f1af920 181Note (2): libraries and applications generated with makefiles and
5fa399c9
JS
182project files are now (hopefully) compatible where static libraries
183are concerned, but please exercise caution nevertheless and if
184possible, use one method or the other.
3f1af920 185
3d82ef9b 186Note (3): some crash problems can be due to inconsistent compiler
ad813b00
JS
187options. If strange/weird/impossible things start to happen please
188check (dumping IDE project file as makefile and doing text comparison
189if necessary) that the project settings, especially the list of defined
190symbols, struct packing, etc. are exactly the same for all items in
191the project. After this, delete everything (including PCH) and recompile.
192
3d82ef9b 193Note (4): to create your own IDE files, copy .dsp and .dsw
fc2171bd 194files from an existing wxWidgets sample and adapt them, or
3d82ef9b 195visit http://wiki.wxwindows.org/wiki.pl?MSVC.
e2a6f233 196
391e89ae
MW
197Microsoft Visual C++ compilation for 64-bit Windows
198----------------------------------------------------------------
199
200Visual Studio 2005 includes 64-bit compilers, though they are not installed by
b46d37d7
MW
201default; you need to select them during the installation. Both native 64-bit
202compilers and 32-bit hosted cross compilers are included, so you do not need a
20364-bit machine to use them (though you do to run the created executables).
204Visual C++ Express Edition does not include 64-bit compilers.
391e89ae 205
b46d37d7
MW
20664-bit compilers are also available in various SDKs, for example
207the .NET Framework SDK:
391e89ae
MW
208 http://msdn.microsoft.com/netframework/programming/64bit/devtools/
209
210Using project files:
211
391e89ae
MW
2121. Open the VC++ 6 workspace file: build\msw\wx.dsw. Visual Studio will then
213 convert the projects to the current Visual C++ project format.
214
2152. To add 64-bit targets, go to the 'Build' menu and choose 'Configuration
216 Manager...'. In the 'Active solution platform' drop down choose '<new>',
217 then you can choose either 'Itanium' or 'x64'.
218
219 For more detailed instructions see:
220 http://msdn2.microsoft.com/en-us/library/9yb4317s(en-us,vs.80).aspx
221
b46d37d7
MW
222 Note: 64-bit targets created this way will use the build directory of the
223 corresponding 32-bit target for some files. Therefore after building
224 for one CPU it is necessary to clean the build before building the
225 equivalent target for another CPU. We've reported the problem to MS
b974b0da 226 but they say it is not possible to fix it.
b46d37d7 227
391e89ae
MW
2283. To build, go to the 'Build' menu and choose 'Batch Build...'. Tick all the
229 all the 'x64|Debug' or all the 'Itanium|Debug' projects, and click 'Build'.
230
231 This will build a debug version of the static libs. The section above on
232 Visual C++ in general has more information about adjusting the settings to
233 build other configurations.
234
2354. To compile one of the samples open one of the sample projects, such as
236 samples\minimal\minimal.dsw. Visual Studio will convert the project as in
237 step 1, then add a 64-bit target as in step 2, and build.
238
239Using makefiles:
240
2411. Open a 64-bit build command prompt, for either x64 or Itanium. Change
b974b0da 242 directory to build\msw. Then for x64 type:
391e89ae
MW
243
244 nmake -f makefile.vc TARGET_CPU=AMD64
245
246 or for Itanium:
247
248 nmake -f makefile.vc TARGET_CPU=IA64
249
250 This will build a debug version of wxWidgets DLLs. See "Configuring the
251 build" for instruction how to build other configurations such as a release
252 build or static libraries.
253
2542. Change to the directory of one of the samples such as samples\minimal. Type
255 the same command used to build the main library, for example for x64:
256
257 nmake -f makefile.vc TARGET_CPU=AMD64
258
259Notes:
260
261The versions of the VC++ 8 compiler included with some SDKs requires an
262additional library to be linked or the following error is received.
263
264 LNK2001 unresolved external symbol __security_check_cookie
265
266If you receive this error add bufferoverflowu.lib to link, e.g.:
267
268 nmake -f makefile.vc TARGET_CPU=AMD64 LDFLAGS=bufferoverflowu.lib
269
270See http://support.microsoft.com/?id=894573 for more information.
271
71521e37 272Borland C++ compilation
5147354c 273----------------------------------------------------------------
2bda0e17 274
9afe7433
VZ
275The minimum version required is 5.5 (last version supported by BC++ 5.0 was
2762.4.2), which can be downloaded for free from:
71521e37
CE
277http://www.borland.com/products/downloads/download_cbuilder.html#
278
279Compiling using the makefiles:
ca5c8b2d 280
fd9f42b6 2811. Change directory to build\msw. Type 'make -f makefile.bcc' to
fc2171bd 282 make the wxWidgets core library. Ignore the compiler warnings.
6bddef36 283 This produces a couple of libraries in the lib\bcc_lib directory.
fd9f42b6
VS
284
2852. Change directory to a sample or demo such as samples\minimal, and type
286 'make -f makefile.bcc'. This produces a windows exe file - by default
6bddef36 287 in the bcc_mswd subdirectory.
fd9f42b6 288
fc2171bd 289Note (1): the wxWidgets makefiles assume dword structure alignment. Please
1a7f3062
JS
290make sure that your own project or makefile settings use the
291same alignment, or you could experience mysterious crashes. To
fd9f42b6 292change the alignment, change CPPFLAGS in build\msw\config.bcc.
1a7f3062 293
9d1461a4 294Note (2): if you get undefined _SQL... symbols at link time,
154f22b3
JS
295either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
296directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
fc2171bd 297recompile wxWidgets. The same applies if compiling using the IDE.
154f22b3 298
9d1461a4 299Note (3): If you wish debug messages to be sent to the console in
fd9f42b6 300debug mode, edit makefile.bcc and change /aa to /Tpe in link commands.
7fee680b 301
71521e37
CE
302Cmpilation succeeds with CBuilderX personal edition and CBuilder6, but
303you may have to copy make.exe from the 5.5 download to the new bin directory.
304Compiling using the IDE files for Borland C++ 5.0 and using CBuilder IDE
305(v1-v6): not supported
ca5c8b2d 306
ca5c8b2d 307
f6bcfd97
BP
308** REMEMBER **
309
fc2171bd 310In all of your wxWidgets applications, your source code should include
f6bcfd97
BP
311the following preprocessor directive:
312
313#ifdef __BORLANDC__
314#pragma hdrstop
315#endif
316
545d1e60
VZ
317(check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for
318more details)
319
9d1461a4 320Borland 16 Bit compilation for Windows 3.1
5147354c 321----------------------------------------------------------------
4bf78aae 322
fc2171bd 323The last version of wxWidgets to support 16-bit compilation with Borland was
9d1461a4 3242.2.7 - Please download and read the instructions in that release
545d1e60
VZ
325
326Watcom C++ 10.6/11 and OpenWatcom compilation
5147354c 327----------------------------------------------------------------
7be1f0d9 328
fd9f42b6 3291. Change directory to build\msw. Type 'wmake -f makefile.wat' to
fc2171bd 330 make the wxWidgets core library.
3d82ef9b 331
e8400940 3322. Change directory to samples\minimal and type 'wmake -f makefile.wat'
ace03f87
JS
333 to make this sample. Repeat for other samples of interest.
334
545d1e60
VZ
335Note (1): if your installation of Watcom doesn't have odbc32.lib file and
336 you need it (i.e. you have wxUSE_ODBC=1), you can use the file
337 from lib\watcom directory. See the notes in that directory.
338
339Note (2): if variant.cpp is compiled with date/time class options, the linker
340 gives up. So the date/time option is switched off for Watcom C++.
341 Also, wxAutomationObject is not compiled with Watcom C++ 10.
342
025bbf5b
CE
343Note (3): RawBitmaps won't work at present because they use unsupported template
344 classes
345
346Note (4): if Watcom can't read the precompiled header when building a sample,
fd9f42b6
VS
347 try deleting .pch files in build\msw\wat_* and compiling
348 the sample again.
545d1e60 349
0797d647
VZ
350Note (5): wxUSE_STD_STRING is disabled in wx/string.h for Watcom as this
351 compiler doesn't come with standard C++ library headers by default.
352 If you install STLPort or another STL implementation, you'll need to
353 edit wx/string.h and remove the check for Digital Mars in it (search
354 for __WATCOM__).
355
356
62448488 357Metrowerks CodeWarrior compilation
5147354c 358----------------------------------------------------------------
62448488 359
9afe7433
VZ
360** NOTE: We don't use Metrowerks compiler any more and so depend on
361** your contributions to keep it up to date. It is possible that
362** the project files mentioned below are out of date due to recently
363** added files, please add them manually if you get linking errors.
364** The authoritative list of files is in build/bakefiles/files.bkl
365
5147354c 3661. CodeWarrior Pro 7 project files in XML format are already
751f9954 367 included in wxMSW-2.7.2.zip and the setup version.
3d82ef9b 368
545d1e60
VZ
3692. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if
370 you are working from the CVS version) to make sure the settings reflect
371 what you want. If you aren't sure, leave it alone and go with the
ba14d986
VZ
372 default settings. A few notes:
373 - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL
545d1e60 374 - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports
ba14d986
VZ
375 will be rather confusing due to interactions with the MSL ANSI
376 and runtime libs.
3d82ef9b 377
fc2171bd 3783. The project file to build the Win32 wxWidgets libraries relies on the
545d1e60
VZ
379 Batch File Runner plug-in. This plug-in is not installed as part of
380 a normal CW7 installation. However, you can find this plug-in on the
381 CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the
382 "Batch File Post Linker".
3d82ef9b 383
545d1e60 3844. If you choose not to install the Batch File Runner plug-in, then you
ba14d986 385 need to do the following by hand:
545d1e60
VZ
386 (1) Create the directories lib\cw7msw\include\wx and copy the file
387 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
ba14d986 388 working from the CVS version) to lib\cw7msw\include\wx\setup.h
545d1e60
VZ
389 (2) Create the directories lib\cw7mswd\include\wx and copy the file
390 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
ba14d986 391 working from the CVS version) to lib\cw7mswd\include\wx\setup.h
3d82ef9b 392
fc2171bd 3935. Import src\wxWidgetsW7.xml to create the project file wxWidgetsW7.mcp.
545d1e60
VZ
394 Store this project file in directory src. You may get warnings about
395 not being able to find certain project paths; ignore these warnings, the
ba14d986 396 appropriate paths will be created during the build by the Batch File Runner.
3d82ef9b 397
545d1e60
VZ
3986. Choose the wxlib Win32 debug or wxlib Win32 Release target and build. You
399 will get some warnings about hidden virtual functions, illegal conversions
ba14d986 400 from const pointers to pointers, etc., all of which you can safely ignore.
545d1e60
VZ
401 ***Note: if you get errors that the compiler can't find "wx/setup.h", just
402 stop the build and build again. These errors occur because sometimes the
ba14d986 403 compiler starts doing its thing before the copying of setup.h has completed.
3d82ef9b 404
ba14d986
VZ
4057. The following libraries will be produced depending on chosen
406 target:
407 - wx_x86.lib ANSI Release (static)
408 - wx_x86_d.lib ANSI Debug (static)
3d82ef9b 409
ba14d986 4108. Sorry, I haven't had time yet to create and test unicode or DLL versions.
545d1e60 411 Volunteers for this are welcome (as neither DLLs nor unicode builds are
ba14d986 412 big priorities for me ;).
3d82ef9b 413
545d1e60
VZ
4149. CodeWarrior Pro7 project files (in XML format) are also provided for some
415 of the samples. In particular, there are project files for the minimal,
416 controls, dialogs, dnd, nd docview samples. You can use these project
417 files as templates for the other samples and for your own projects.
3d82ef9b 418 - For example, to make a project file for the "grid" sample,
545d1e60
VZ
419 just copy the project file for the "minimal" sample, minimalW7.mcp
420 (made by importing minimalW7.xml into CodeWarrior), into the
3d82ef9b 421 sample/grid directory, calling it gridW7.mcp. Open
545d1e60
VZ
422 newgridW7.mcp and revise the project by deleting the files
423 minimal.rc and minimal.cpp and adding the files griddemo.rc and
377c68c5
CE
424 griddemo.cpp. Build and run....
425
545d1e60 426
9a718b86 427Cygwin/MinGW compilation
5147354c 428----------------------------------------------------------------
2bda0e17 429
7acf6a92 430wxWidgets supports Cygwin (formerly GnuWin32) betas and
9a718b86 431releases, and MinGW. Cygwin can be downloaded from:
6500c0b1 432
9a718b86 433 http://sources.redhat.com/cygwin/
2bda0e17 434
9a718b86 435and MinGW from:
6500c0b1 436
9a718b86 437 http://www.mingw.org/
2bda0e17 438
fd9f42b6
VS
439Both Cygwin and MinGW can be used with configure (assuming you have MSYS
440installed in case of MinGW). You will need new enough MinGW version, preferably
441MinGW 2.0 (ships with gcc3) or at least 1.0 (gcc-2.95.3). GCC versions older
fc2171bd 442than 2.95.3 don't work; you can use wxWidgets 2.4 with them.
545d1e60 443
fd9f42b6
VS
444NOTE: some notes specific to old Cygwin (< 1.1.x) are at the end of this
445 section (see OLD VERSIONS)
2bda0e17 446
fc2171bd 447There are two methods of compiling wxWidgets, by using the
7666ad49 448makefiles provided or by using 'configure'.
2bda0e17 449
9a718b86 450Retrieve and install the latest version of Cygwin, or MinGW, as per
6500c0b1
JS
451the instructions with either of these packages.
452
9a718b86 453If using MinGW, you can download the add-on MSYS package to
fc2171bd 454provide Unix-like tools that you'll need to build wxWidgets using configure.
6500c0b1
JS
455
456Using makefiles directly
5147354c 457----------------------------------------------------------------
7666ad49 458
d01bf7ae 459NOTE: The makefile.gcc makefiles are for compilation under MinGW using
59f846df
VZ
460 Windows command interpreter (command.com/cmd.exe), they won't work in
461 other environments (such as UNIX or Unix-like, e.g. MSYS where you have
462 to use configure instead, see the section below)
02fd5400 463
7666ad49 464Here are the steps required using the provided makefiles:
8870c26e 465
fd9f42b6
VS
466- If you are using gcc-2.95, edit build\msw\config.gcc and set the GCC_VERSION
467 variable to "2.95".
6500c0b1 468
fc2171bd
JS
469- Use the makefile.gcc files for compiling wxWidgets and samples,
470 e.g. to compile a debugging version of wxWidgets:
fd9f42b6
VS
471 > cd c:\wx\build\msw
472 > make -f makefile.gcc BUILD=debug
4dcd292c 473 > cd c:\wx\samples\minimal
fd9f42b6
VS
474 > make -f makefile.gcc BUILD=debug
475 (See below for more options.)
4dcd292c 476
cba2db0c
JS
477 Ignore the warning about the default entry point.
478
9a718b86
MB
479- Use the 'strip' command to reduce executable/dll size (note that
480 stripping an executable/dll will remove debug information!).
2bda0e17 481
2bda0e17 482All targets have 'clean' targets to allow removal of object files
fd9f42b6 483and other intermediate compiler files.
2bda0e17 484
7666ad49 485Using configure
5147354c 486----------------------------------------------------------------
7666ad49
JS
487
488Instead of using the makefiles, you can use the configure
489system to generate appropriate makefiles, as used on Unix
490and Mac OS X systems.
491
fc2171bd 492Change directory to the root of the wxWidgets distribution,
9a718b86 493make a build directory, and run configure and make in this directory.
7666ad49
JS
494
495For example:
496
497 cd $WXWIN
498 mkdir build-debug
499 cd build-debug
500 ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared
501 make
be27bc46 502 make install % This step is optional, see note (6) below.
7666ad49
JS
503 cd samples/minimal
504 make
505 ./minimal.exe
506
7c5dc04f 507Notes:
2bda0e17 508
9a718b86 5091. See also the Cygwin/MinGW on the web site or CD-ROM for
fc2171bd 510 further information about using wxWidgets with these compilers.
7c5dc04f 511
6b978929 5122. libwx.a is 100 MB or more - but much less if compiled with no
bf4d9b2b 513 debug info (-g0) and level 4 optimization (-O4).
7c5dc04f 514
9a718b86 5153. If you get a link error under MinGW 2.95.2 referring to:
6b978929
JS
516
517 EnumDAdvise__11IDataObjectPP13IEnumSTATDATA@8
518
519 then you need to edit the file objidl.h at line 663 and add
520 a missing PURE keyword:
521
522 STDMETHOD(EnumDAdvise)(THIS_ IEnumSTATDATA**) PURE;
523
9a718b86 5244. There's a bug in MinGW headers for some early distributions.
7c5dc04f 525
bf4d9b2b 526 in include/windows32/defines.h, where it says:
7c5dc04f 527
bf4d9b2b 528 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
7c5dc04f 529
bf4d9b2b 530 it should say:
7c5dc04f 531
bf4d9b2b 532 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
7c5dc04f 533
bf4d9b2b 534 (a missing bracket).
7c5dc04f 535
fd9f42b6 5365. OpenGL support should work with MinGW as-is. However,
fac26663
JS
537 if you wish to generate import libraries appropriate either for
538 the MS OpenGL libraries or the SGI OpenGL libraries, go to
539 include/wx/msw/gl and use:
540
541 dlltool -k -d opengl.def -llibopengl.a
542
543 for the SGI DLLs, or
544
545 dlltool -k -d opengl32.def -llibopengl32.a
546
547 and similarly for glu[32].def.
548
fd9f42b6 5496. The 'make install' step is optional, and copies files
c5f53eb8
JS
550 as follows:
551
552 /usr/local/lib - wxmswXYZd.dll.a and wxmswXYZd.dll
fc2171bd 553 /usr/local/include/wx - wxWidgets header files
c5f53eb8
JS
554 /usr/local/bin - wx-config
555
556 You may need to do this if using wx-config with the
557 default root path.
558
fd9f42b6
VS
5597. With Cygwin, you can invoke gdb --nw myfile.exe to
560 debug an executable. If there are memory leaks, they will be
561 flagged when the program quits. You can use Cygwin gdb
562 to debug MinGW executables.
4dcd292c 563
14ff1954
MW
5648. Note that gcc's precompiled headers do not work on current versions of
565 Cygwin. If your version of Cygwin is affected you will need to use the
566 --disable-precomp-headers configure option.
567
fd9f42b6 568OLD VERSIONS:
4dcd292c
MB
569
570- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
571 to set up appropriate variables, if necessary mounting drives.
572 Run it before compiling.
573
574- For Cygwin, make sure there's a \tmp directory on your
575 Windows drive or bison will crash (actually you don't need
fc2171bd 576 bison for ordinary wxWidgets compilation: a pre-generated .c file is
4dcd292c
MB
577 supplied).
578
4dcd292c 579- If using GnuWin32 b18, you will need to copy windres.exe
9a718b86 580 from e.g. the MinGW distribution, to a directory in your path.
4dcd292c 581
df945db9 582
ce8897bb 583Symantec & DigitalMars C++ compilation
5147354c
JS
584----------------------------------------------------------------
585
ce8897bb
CE
586The DigitalMars compiler is a free succssor to the Symantec compiler
587and can be downloaded from http://www.digitalmars.com/
025bbf5b 588
fd9f42b6
VS
5891. You need to download and unzip in turn (later packages will overwrite
590 older files)
9c266fa0 591 Digital Mars C/C++ Compiler Version 8.40 or later
1a81e3db 592 Basic utilities
df945db9 593 from http://www.digitalmars.com/download/freecompiler.html
025bbf5b 594
df945db9 5952. Change directory to build\msw and type 'make -f makefile.dmc' to
fc2171bd 596 make the wxWidgets core library.
df945db9
VZ
597
5983. Change directory to samples\minimal and type 'make -f makefile.dmc'
1a81e3db 599 to make this sample. Most of the other samples also work.
377c68c5 600
2bda0e17 601
df945db9
VZ
602Note that if you don't have the files makefile.dmc you may create them yourself
603using bakefile tool according to the instructions in build\bakefiles\README:
604
605 cd build\bakefiles
606 bakefile_gen -f dmars -b wx.bkl
607 bakefile_gen -f dmars -b ../../samples/minimal/minimal.bkl
608
609
0797d647
VZ
610Note that wxUSE_STD_STRING is disabled in wx/string.h for Digital Mars as this
611compiler doesn't come with standard C++ library headers by default. If you
612install STLPort or another STL implementation, you'll need to edit wx/string.h
613and remove the check for Digital Mars in it (search for __DMC__).
614
615
ce8897bb 61616-bit compilation is no longer supported.
6500c0b1 617
fd9f42b6 618Configuring the build
5147354c 619================================================================
57c208c5 620
fc2171bd 621So far the instructions only explained how to build release DLLs of wxWidgets
03265572
VS
622and did not cover any configuration. It is possible to change many aspects of
623the build, including debug/release and ANSI/Unicode settings. All makefiles in
624build\msw directory use same options (with a few exceptions documented below)
625and the only difference between them is in object files and library directory
626names and in make invocation command.
57c208c5 627
03265572 628Changing the settings
5147354c 629----------------------------------------------------------------
57c208c5 630
03265572
VS
631There are two ways to modify the settings: either by passing the values as
632arguments when invoking make or by editing build\msw\config.$(compiler) file
633where $(compiler) is same extension as the makefile you use has (see below).
634The latter is good for setting options that never change in your development
635process (e.g. GCC_VERSION or VENDOR). If you want to build several versions of
fc2171bd 636wxWidgets and use them side by side, the former method is better. Settings in
03265572
VS
637config.* files are shared by all makefiles (samples, contrib, main library),
638but if you pass the options as arguments, you must use same arguments you used
639for the library when building samples or contrib libraries!
8870c26e 640
03265572
VS
641Examples of invoking make in Unicode debug build (other options described
642below are set analogically):
545d1e60 643
03265572
VS
644Visual C++:
645 > nmake -f makefile.vc BUILD=debug UNICODE=1
646
647Borland C++:
19fea858 648 > make -f makefile.bcc -DBUILD=debug -DUNICODE=1
03265572
VS
649 (Note that you have to use -D to set the variable, unlike in other make
650 tools!)
651
652Watcom C/C++:
653 > wmake -f makefile.wat BUILD=debug UNICODE=1
654
655MinGW using native makefiles:
656 > mingw32-make -f makefile.gcc BUILD=debug UNICODE=1
657
14ff1954 658MinGW using configure:
03265572
VS
659 > ./configure --enable-debug --enable-unicode
660 (see ./configure --help on details; configure is not covered in this
661 section)
662
14ff1954
MW
663Cygwin using configure:
664 > ./configure --disable-precomp-headers --enable-debug --enable-unicode
665 (use --disable-precomp-headers if Cygwin doesn't support precompiled
666 headers)
667
03265572
VS
668Brief explanation of options and possible values is in every
669build\msw\config.* file; more detailed description follows.
670
671Basic options
5147354c 672----------------------------------------------------------------
a0a302dc 673
458d26a0
WS
674BUILD=release
675 Builds release version of the library. It differs from default 'debug'
676 in lack of appended 'd' in name of library, does not define __WXDEBUG__
677 and not include debug information compiled into object files and the
678 executable.
679
680SHARED=1
681 Build shared libraries (DLLs). By default, DLLs are not built
682 (SHARED=0).
03265572
VS
683
684UNICODE=1
685 To build Unicode versions of the libraries, add UNICODE=1 to make invocation
686 (default is UNICODE=0). If you want to be able to use Unicode version on
687 Windows9x, you will need to set MSLU=1 as well.
688
689 This option affect name of the library ('u' is appended) and the directory
690 where the library and setup.h are store (ditto).
691
692WXUNIV=1
693 Build wxUniversal instead of native wxMSW (see
fc2171bd 694 http://www.wxwidgets.org/wxuniv.htm for more information).
03265572
VS
695
696Advanced options
5147354c 697----------------------------------------------------------------
03265572
VS
698
699MONOLITHIC=1
fc2171bd 700 Starting with version 2.5.1, wxWidgets has the ability to be built as
03265572
VS
701 several smaller libraries instead of single big one as used to be the case
702 in 2.4 and older versions. This is called "multilib build" and is the
703 default behaviour of makefiles. You can still build single library
704 ("monolithic build") by setting MONOLITHIC variable to 1.
705
706USE_GUI=0
707 Disable building GUI parts of the library, build only wxBase components used
708 by console applications. Note that if you leave USE_GUI=1 then both wxBase
709 and GUI libraries are built. If you are building monolithic library, then
710 you should set wxUSE_GUI to 1 in setup.h.
711
712USE_OPENGL=1
713 Build wxmsw25_gl.lib library with OpenGL integration class wxGLCanvas.
714 You must also modify your setup.h to #define wxUSE_GLCANVAS 1. Note that
715 OpenGL library is always built as additional library, even in monolithic
716 build!
717
718USE_ODBC=1
719 Build two additional libraries in multilib mode, one with database
720 classes and one with wxGrid database support. You must
721 #define wxUSE_ODBC 1 in setup.h
722
723USE_HTML=0
724 Do not build wxHTML library. If MONOLITHIC=1, then you must also
725 #define wxUSE_HTML 1 in setup.h.
726
9a8f0513
VS
727USE_XRC=0
728 Do not build XRC resources library. If MONOLITHIC=1, then you must also
729 #define wxUSE_HTML 1 in setup.h.
730
03265572
VS
731RUNTIME_LIBS=static
732 Links static version of C and C++ runtime libraries into the executable, so
733 that the program does not depend on DLLs provided with the compiler (e.g.
734 Visual C++'s msvcrt.dll or Borland's cc3250mt.dll).
735 Caution: Do not use static runtime libraries when building DLL (SHARED=1)!
736
737MSLU=1
738 Enables MSLU (Microsoft Layer for Unicode). This setting makes sense only if
739 used together with UNICODE=1. If you want to be able to use Unicode version
740 on Windows9x, you will need MSLU (Microsoft Layer for Unicode) runtime DLL
741 and import lib. The former can be downloaded from Microsoft, the latter is
742 part of the latest Platform SDK from Microsoft (see msdn.microsoft.com for
743 details). An alternative implementation of import library can be downloaded
744 from http://libunicows.sourceforge.net - unlike the official one, this one
745 works with other compilers and does not require 300+ MB Platform SDK update.
746
747DEBUG_FLAG=0
748DEBUG_FLAG=1
749 If set to 1, define __WXDEBUG__ symbol, append 'd' to library name and do
750 sanity checks at runtime. If set to 0, don't do it. By default, this is
751 governed by BUILD option (if 'debug', DEBUG_FLAG=1, if 'release' it is 0),
752 but it is sometimes desirable to modify default behaviour and e.g. define
753 __WXDEBUG__ even in release builds.
754
755DEBUG_INFO=0
756DEBUG_INFO=1
757 Same as DEBUG_FLAG in behaviour, this option affects whether debugging
758 information is included in the executable or not.
759
760VENDOR=<your company name>
761 Set this to a short string identifying your company if you are planning to
fc2171bd
JS
762 distribute wxWidgets DLLs with your application. Default value is 'custom'.
763 This string is included as part of DLL name. wxWidgets DLLs contain compiler
03265572
VS
764 name, version information and vendor name in them. For example
765 wxmsw250_core_bcc_custom.dll is one of DLLs build using Borland C++ with
766 default settings. If you set VENDOR=mycorp, the name will change to
767 wxmsw250_core_bcc_mycorp.dll.
768
769CFG=<configuration name>
fc2171bd 770 Sets configuration name so that you can have multiple wxWidgets builds with
03265572
VS
771 different setup.h settings coexisting in same tree. See "Object and library
772 directories" below for more information.
773
774Compiler specific options
5147354c 775----------------------------------------------------------------
03265572
VS
776
777* MinGW
778
779If you are using gcc-2.95 instead of gcc3, you must set GCC_VERSION to
7802.95. In build\msw\config.gcc, change
781> GCC_VERSION = 3
782to
783> GCC_VERSION = 2.95
784
785* Visual C++
786
787DEBUG_RUNTIME_LIBS=0
788DEBUG_RUNTIME_LIBS=1
789 If set to 1, msvcrtd.dll is used, if to 0, msvcrt.dll is used. By default
790 msvcrtd.dll is used only if the executable contains debug info and
791 msvcrt.dll if it doesn't. It is sometimes desirable to build with debug info
792 and still link against msvcrt.dll (e.g. when you want to ship the app to
793 customers and still have usable .pdb files with debug information) and this
794 setting makes it possible.
795
796Fine-tuning the compiler
5147354c 797----------------------------------------------------------------
03265572
VS
798
799All makefiles have variables that you can use to specify additional options
800passed to the compiler or linker. You won't need this in most cases, but if you
801do, simply add desired flags to CFLAGS (for C compiler), CXXFLAGS (for C++
802compiler), CPPFLAGS (for both C and C++ compiler) and LDFLAGS (the linker).
803
804Object and library directories
5147354c 805----------------------------------------------------------------
03265572
VS
806
807All object files produced during library build are stored in a directory under
808build\msw. It's name is derived from build settings and CFG variable and from
809compiler name. Examples of directory names:
810
811 build\msw\bcc_msw SHARED=0
812 build\msw\bcc_mswdll SHARED=1
813 build\msw\bcc_mswunivd SHARED=0, WXUNIV=1, BUILD=debug
814 build\msw\vc_mswunivd ditto, with Visual C++
815
6acf2ef6
VS
816Libraries and DLLs are copied into subdirectory of lib directory with
817name derived from compiler and static/DLL setting and setup.h into directory
818with name that contains other settings:
03265572
VS
819
820 lib\bcc_msw
6acf2ef6
VS
821 lib\bcc_lib\msw\wx\setup.h
822 lib\bcc_dll
823 lib\bcc_dll\msw\wx\setup.h
824 lib\bcc_lib
825 lib\bcc_lib\mswunivd\wx\setup.h
826 lib\vc_lib
827 lib\vc_lib\mswunivd\wx\setup.h
828
829Each lib\ subdirectory has wx subdirectory with setup.h as seen above.
830This file is copied there from include\wx\msw\setup.h (and if it doesn't exist,
831from include\wx\msw\setup0.h) and this is the copy of setup.h that is used by
832all samples and should be used by your apps as well. If you are doing changes
833to setup.h, you should do them in this file, _not_ in include\wx\msw\setup.h.
03265572
VS
834
835If you set CFG to something, the value is appended to directory names. E.g.
836for CFG=MyBuild, you'll have object files in
837
838 build\msw\bcc_mswMyBuild
839 build\msw\bcc_mswdllMyBuild
840 etc.
841
842and libraries in
843
6acf2ef6
VS
844 lib\bcc_libMyBuild
845 lib\bcc_dllMyBuild
03265572
VS
846 etc.
847
fd04b3cb 848By now it is clear what CFG is for: builds with different CFG settings don't
03265572
VS
849share any files and they use different setup.h files. This allows you to e.g.
850have two static debug builds, one with wxUSE_SOCKETS=0 and one with sockets
851enabled (without CFG, both of them would be put into same directory and there
fd04b3cb 852would be conflicts between the files).
03265572 853
03265572 854General Notes
5147354c 855=================================================================
03265572 856
a0a302dc 857- Debugging: under Windows 95, debugging output isn't output in
9c6751aa 858 the same way that it is under NT or Windows 3.1.
3d82ef9b
JS
859 Please see DebugView available from http://www.sysinternals.com.
860