]> git.saurik.com Git - wxWidgets.git/blame - docs/msw/install.txt
wxFileName::Normalize(wxPATH_NORM_ENV_VARS) now works
[wxWidgets.git] / docs / msw / install.txt
CommitLineData
93f467a3 1Installing wxWindows 2.5.1
4e4dc03d 2--------------------------
0544bc0a 3
93f467a3 4This is wxWindows 2.5.1 for Microsoft Windows 9x/ME, Windows NT, Windows 2000
545d1e60
VZ
5and Windows XP. This is an unstable development release. Note that unstable in
6this context doesn't mean that it crashes a lot, just that the library API may
3d82ef9b 7change in backwards incompatible way during the 2.5 branch lifetime.
0544bc0a 8
dbda9e86 9IMPORTANT NOTE: If you experience problems installing, please
9c6751aa 10re-read this instructions and other related files (changes.txt,
7666ad49
JS
11readme.txt, FAQ) carefully before mailing wx-users. Preferably,
12try to fix the problem first and then upload a patch to
13SourceForge:
14
15 http://sourceforge.net/patch/?group_id=9863
16
17Please report bugs using the SourceForge bug tracker:
18
19 http://sourceforge.net/bugs/?group_id=9863
dbda9e86 20
2bda0e17 21Unarchiving
03265572 22===========
2bda0e17 23
2b5f62a0
VZ
24A setup program is provided (setup.exe) to automatically copy
25files to a directory on your hard disk. Do not install into a
3d82ef9b 26path that contains spaces.
2b5f62a0
VZ
27
28The setup program contains the following:
01dba85a
JS
29
30- All common, generic and MSW-specific wxWindows source;
3d82ef9b
JS
31- samples and demos;
32- documentation in MS HTML Help format;
b9f933ab
JS
33- makefiles for most Windows compilers, plus CodeWarrior,
34 BC++ and VC++ IDE files;
01dba85a 35- JPEG library source;
669f7a11 36- TIFF library source;
3d82ef9b 37- Object Graphics Library, Tex2RTF, wxSTC, etc.
01dba85a 38
f6bcfd97
BP
39Alternatively, you may unarchive the .zip form by hand:
40wxMSW-x.y.z.zip where x.y.z is the version number.
2bda0e17
KB
41
42Unarchive the required files plus any optional documentation
dbda9e86 43files into a suitable directory such as c:\wx.
2bda0e17 44
dbda9e86 45General installation notes
03265572 46==========================
dbda9e86 47
dbda9e86 48If installing from the CVS server, copy include/wx/msw/setup0.h to
a40a9c81
JS
49include/wx/msw/setup.h and edit the resulting file to choose
50the features you would like to compile wxWindows with[out].
dbda9e86 51
2bda0e17 52Compilation
545d1e60 53===========
2bda0e17 54
dbda9e86 55The following sections explain how to compile wxWindows with each supported
545d1e60
VZ
56compiler. Search for one of Microsoft/Borland/Watcom/Symantec/Metrowerks/
57Cygwin/Mingw32 to quickly locate the instructions for your compiler.
58
fd9f42b6
VS
59All makefiles and project are located in build\msw directory.
60
61Where compiled files are stored
62-------------------------------
63
64After succesful compilation you'll find the libraries in a subdirectory
6acf2ef6
VS
65of lib directory named after the compiler and DLL/staitc settings.
66A couple of examples:
fd9f42b6 67
6acf2ef6
VS
68 lib\vc_lib VC++ compiled static libraries
69 lib\vc_dll VC++ DLLs
70 lib\bcc_lib Static libraries for Borland C++
71 lib\wat_dll Watcom C++ DLLs
fd9f42b6
VS
72
73Names of compiled wxWindows libraries follow this scheme: libraries that don't
74depend on GUI components begin with "wxbase" followed by version number and
75letters indicating if the library is compiled as Unicode ('u') and/or debug
76build ('d'). Last component of them name is name of wxWindows component
77(unless you built the library as single monolithic library; look for
78"Configuring the build" below). This is a typical set of release ANSI build
79libraries (release versions on left, debug on right side):
80
81 wxbase25.lib wxbase25d.lib
82 wxbase25_net.lib wxbase25d_net.lib
83 wxbase25_xml.lib wxbase25d_xml.lib
84 wxmsw25_core.lib wxmsw25d_core.lib
85 wxmsw25_html.lib wxmsw25d_html.lib
86 wxmsw25_adv.lib wxmsw25d_adv.lib
87
6acf2ef6
VS
88Their Unicode debug counterparts in wxUniversal build would be
89
90 wxbase25ud.lib
91 wxbase25ud_net.lib
92 wxbase25ud_xml.lib (notice these libs are same for wxUniv and wxMSW)
93 wxmswuniv25ud_core.lib
94 wxmswuniv25ud_html.lib
95 wxmswuniv25ud_adv.lib
96
97These directories also contain subdirectory with wx/setup.h header. This
98subdirectory is named after port, Unicode, wxUniv and debug settings and
99you must add it to include paths when compiling your application. Some
100examples:
101
102 lib\vc_lib\msw\wx\setup.h VC++ static, wxMSW
103 lib\vc_lib\mswud\wx\setup.h VC++ static, wxMSW, Unicode, debug
104 lib\vc_lib\mswunivd\wx\setup.h VC++ static, wxUniversal, debug
fd9f42b6
VS
105
106Below are compiler specific notes followed by customizing instructions that
107apply to all compilers (search for "Configuring the build").
108
545d1e60
VZ
109Microsoft Visual C++ compilation
110--------------------------------
2bda0e17 111
90985bde
VZ
112You may wish to visit http://wiki.wxwindows.org/wiki.pl?MSVC for a more
113informal and more detailed description of the process summarized below.
114
b2575739 115Please note that the VC++ 6.0 project files will work for VC++ .NET also.
1257f684 116
916095ba
JS
117Also note that you can make the project files work with VC++ 5.0 but you'll
118need to edit .dsp file by hand before this is possible (change the version in
119the .dsp file header from 6.0 to 5.0).
38c1f6f7
VZ
120
121Using project files (VC++ 6 and later):
a367b9b3 122
a40a9c81 1231. Unarchive wxWindows-x.y.z-vc.zip, the VC++ 6 project
f6bcfd97 124 makefiles (already included in wxMSW-x.y.z.zip and the setup version).
fd9f42b6 1252. Open build\msw\wx.dsw, which has configurations for static
a40a9c81 126 compilation or DLL compilation, and each of these available in
fd9f42b6
VS
127 Unicode/ANSI, Debug/Release and wxUniversal or native variations.
128 Normally you'll use a static linking ANSI configuration.
efefa4f8
VS
129 Choose the Win32 Debug or Win32 Release configuration (or any other that
130 suits your needs) and use Batch Build to compile _all_ projects. If you
21de777f 131 know you won't need some of the libraries (i.e. html part), you don't have
efefa4f8 132 to compile it. It will also produce similar variations on jpeg.lib,
fd9f42b6 133 png.lib, tiff.lib, zlib.lib, and regex.lib.
f2e61abe
VS
134 If you want to build DLLs, you have to either build them one by one in
135 proper order (jpeg, png, tiff, zlib, regex, expat, base, core, the rest
136 in any order) or to use wx_dll.dsw workspace which has correct dependencies.
5fa399c9 1373. Open a sample project file, choose a configuration such as
a40a9c81 138 Win32 Debug using Build | Set Active Configuration..., and compile.
5fa399c9 139 The project files don't use precompiled headers, to save disk
16553659 140 space, but you can switch PCH compiling on for greater speed.
a40a9c81 141 NOTE: you may also use samples/samples.dsw to access all
669f7a11
JS
142 sample projects without opening each workspace individually.
143 You can use the Batch Build facility to make several samples
144 at a time.
a367b9b3
JS
145
146Using makefiles:
147
03265572 1481. Change directory to build\msw. Type:
ca5c8b2d
JS
149
150 'nmake -f makefile.vc'
151
fd9f42b6
VS
152 to make the wxWindows core library as release DLL.
153 See "Configuring the build" for instruction how to build debug or static
154 libraries.
3d82ef9b 155
03265572 1562. Change directory to samples and type 'nmake -f makefile.vc'
2bda0e17
KB
157 to make all the samples. You can also make them individually.
158
5fa399c9 159Makefile notes:
e2a6f233 160
fd9f42b6 161 Use the 'clean' target to clean all objects, libraries and
ca5c8b2d
JS
162 executables.
163
3f1af920 164Note (1): if you wish to use templates, please edit
025e88c5
JS
165include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
166Without this, the redefinition of 'new' will cause problems in
167the headers. Alternatively, #undef new before including template headers.
dbda9e86
JS
168You will also need to set wxUSE_IOSTREAMH to 0 if you will be
169using templates, to avoid the non-template stream files being included
170within wxWindows.
025e88c5 171
3f1af920 172Note (2): libraries and applications generated with makefiles and
5fa399c9
JS
173project files are now (hopefully) compatible where static libraries
174are concerned, but please exercise caution nevertheless and if
175possible, use one method or the other.
3f1af920 176
3d82ef9b 177Note (3): some crash problems can be due to inconsistent compiler
ad813b00
JS
178options. If strange/weird/impossible things start to happen please
179check (dumping IDE project file as makefile and doing text comparison
180if necessary) that the project settings, especially the list of defined
181symbols, struct packing, etc. are exactly the same for all items in
182the project. After this, delete everything (including PCH) and recompile.
183
3d82ef9b
JS
184Note (4): to create your own IDE files, copy .dsp and .dsw
185files from an existing wxWindows sample and adapt them, or
186visit http://wiki.wxwindows.org/wiki.pl?MSVC.
e2a6f233 187
9d1461a4 188Borland C++ 5.0/5.5 compilation
2bda0e17
KB
189-------------------------------
190
2b5f62a0 191Compiling using the makefiles (updated 24 Sept 02):
ca5c8b2d 192
fd9f42b6 1931. Change directory to build\msw. Type 'make -f makefile.bcc' to
b7b45f6f 194 make the wxWindows core library. Ignore the compiler warnings.
6bddef36 195 This produces a couple of libraries in the lib\bcc_lib directory.
fd9f42b6
VS
196
1972. Change directory to a sample or demo such as samples\minimal, and type
198 'make -f makefile.bcc'. This produces a windows exe file - by default
6bddef36 199 in the bcc_mswd subdirectory.
fd9f42b6
VS
200
201Note (1): the wxWindows makefiles assume dword structure alignment. Please
1a7f3062
JS
202make sure that your own project or makefile settings use the
203same alignment, or you could experience mysterious crashes. To
fd9f42b6 204change the alignment, change CPPFLAGS in build\msw\config.bcc.
1a7f3062 205
9d1461a4 206Note (2): if you get undefined _SQL... symbols at link time,
154f22b3
JS
207either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
208directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
209recompile wxWindows. The same applies if compiling using the IDE.
210
9d1461a4 211Note (3): If you wish debug messages to be sent to the console in
fd9f42b6 212debug mode, edit makefile.bcc and change /aa to /Tpe in link commands.
7fee680b 213
7945bfb4
CE
214Compiling using the IDE files for Borland C++ 5.0: not supported - please
215use version 2.4.1 (using the make utility in commandline mode works fine_
ca5c8b2d 216
7945bfb4
CE
217Compiling using CBuilder (v1-v6): not supported - please
218use version 2.4.1 (using the make utility in commandline mode works fine_
ca5c8b2d 219
f6bcfd97
BP
220** REMEMBER **
221
545d1e60 222In all of your wxWindows applications, your source code should include
f6bcfd97
BP
223the following preprocessor directive:
224
225#ifdef __BORLANDC__
226#pragma hdrstop
227#endif
228
545d1e60
VZ
229(check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for
230more details)
231
9d1461a4
CE
232Borland 16 Bit compilation for Windows 3.1
233------------------------------------------
4bf78aae 234
9d1461a4
CE
235The last version of wxWindows to support 16-bit compilation with Borland was
2362.2.7 - Please download and read the instructions in that release
545d1e60
VZ
237
238Watcom C++ 10.6/11 and OpenWatcom compilation
239---------------------------------------------
7be1f0d9 240
fd9f42b6 2411. Change directory to build\msw. Type 'wmake -f makefile.wat' to
7be1f0d9 242 make the wxWindows core library.
3d82ef9b 243
e8400940 2442. Change directory to samples\minimal and type 'wmake -f makefile.wat'
ace03f87
JS
245 to make this sample. Repeat for other samples of interest.
246
545d1e60
VZ
247Note (1): if your installation of Watcom doesn't have odbc32.lib file and
248 you need it (i.e. you have wxUSE_ODBC=1), you can use the file
249 from lib\watcom directory. See the notes in that directory.
250
251Note (2): if variant.cpp is compiled with date/time class options, the linker
252 gives up. So the date/time option is switched off for Watcom C++.
253 Also, wxAutomationObject is not compiled with Watcom C++ 10.
254
025bbf5b
CE
255Note (3): RawBitmaps won't work at present because they use unsupported template
256 classes
257
258Note (4): if Watcom can't read the precompiled header when building a sample,
fd9f42b6
VS
259 try deleting .pch files in build\msw\wat_* and compiling
260 the sample again.
545d1e60 261
62448488
JS
262Metrowerks CodeWarrior compilation
263----------------------------------
264
545d1e60 2651. CodeWarrior Pro7 project files in XML format are already
93f467a3 266 included in wxMSW-2.5.1.zip and the setup version.
3d82ef9b 267
545d1e60
VZ
2682. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if
269 you are working from the CVS version) to make sure the settings reflect
270 what you want. If you aren't sure, leave it alone and go with the
ba14d986
VZ
271 default settings. A few notes:
272 - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL
545d1e60 273 - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports
ba14d986
VZ
274 will be rather confusing due to interactions with the MSL ANSI
275 and runtime libs.
3d82ef9b 276
545d1e60
VZ
2773. The project file to build the Win32 wxWindows libraries relies on the
278 Batch File Runner plug-in. This plug-in is not installed as part of
279 a normal CW7 installation. However, you can find this plug-in on the
280 CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the
281 "Batch File Post Linker".
3d82ef9b 282
545d1e60 2834. If you choose not to install the Batch File Runner plug-in, then you
ba14d986 284 need to do the following by hand:
545d1e60
VZ
285 (1) Create the directories lib\cw7msw\include\wx and copy the file
286 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
ba14d986 287 working from the CVS version) to lib\cw7msw\include\wx\setup.h
545d1e60
VZ
288 (2) Create the directories lib\cw7mswd\include\wx and copy the file
289 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
ba14d986 290 working from the CVS version) to lib\cw7mswd\include\wx\setup.h
3d82ef9b 291
73c3b37b 2925. Import src\wxWindowsW7.xml to create the project file wxWindowsW7.mcp.
545d1e60
VZ
293 Store this project file in directory src. You may get warnings about
294 not being able to find certain project paths; ignore these warnings, the
ba14d986 295 appropriate paths will be created during the build by the Batch File Runner.
3d82ef9b 296
545d1e60
VZ
2976. Choose the wxlib Win32 debug or wxlib Win32 Release target and build. You
298 will get some warnings about hidden virtual functions, illegal conversions
ba14d986 299 from const pointers to pointers, etc., all of which you can safely ignore.
545d1e60
VZ
300 ***Note: if you get errors that the compiler can't find "wx/setup.h", just
301 stop the build and build again. These errors occur because sometimes the
ba14d986 302 compiler starts doing its thing before the copying of setup.h has completed.
3d82ef9b 303
ba14d986
VZ
3047. The following libraries will be produced depending on chosen
305 target:
306 - wx_x86.lib ANSI Release (static)
307 - wx_x86_d.lib ANSI Debug (static)
3d82ef9b 308
ba14d986 3098. Sorry, I haven't had time yet to create and test unicode or DLL versions.
545d1e60 310 Volunteers for this are welcome (as neither DLLs nor unicode builds are
ba14d986 311 big priorities for me ;).
3d82ef9b 312
545d1e60
VZ
3139. CodeWarrior Pro7 project files (in XML format) are also provided for some
314 of the samples. In particular, there are project files for the minimal,
315 controls, dialogs, dnd, nd docview samples. You can use these project
316 files as templates for the other samples and for your own projects.
3d82ef9b 317 - For example, to make a project file for the "grid" sample,
545d1e60
VZ
318 just copy the project file for the "minimal" sample, minimalW7.mcp
319 (made by importing minimalW7.xml into CodeWarrior), into the
3d82ef9b 320 sample/grid directory, calling it gridW7.mcp. Open
545d1e60
VZ
321 newgridW7.mcp and revise the project by deleting the files
322 minimal.rc and minimal.cpp and adding the files griddemo.rc and
377c68c5
CE
323 griddemo.cpp. Build and run....
324
545d1e60 325
9a718b86 326Cygwin/MinGW compilation
545d1e60 327------------------------
2bda0e17 328
74afbadc 329wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
9a718b86 330releases, and MinGW. Cygwin can be downloaded from:
6500c0b1 331
9a718b86 332 http://sources.redhat.com/cygwin/
2bda0e17 333
9a718b86 334and MinGW from:
6500c0b1 335
9a718b86 336 http://www.mingw.org/
2bda0e17 337
fd9f42b6
VS
338Both Cygwin and MinGW can be used with configure (assuming you have MSYS
339installed in case of MinGW). You will need new enough MinGW version, preferably
340MinGW 2.0 (ships with gcc3) or at least 1.0 (gcc-2.95.3). GCC versions older
341than 2.95.3 don't work; you can use wxWindows 2.4 with them.
545d1e60 342
fd9f42b6
VS
343NOTE: some notes specific to old Cygwin (< 1.1.x) are at the end of this
344 section (see OLD VERSIONS)
2bda0e17 345
7666ad49
JS
346There are two methods of compiling wxWindows, by using the
347makefiles provided or by using 'configure'.
2bda0e17 348
9a718b86 349Retrieve and install the latest version of Cygwin, or MinGW, as per
6500c0b1
JS
350the instructions with either of these packages.
351
9a718b86 352If using MinGW, you can download the add-on MSYS package to
fd9f42b6 353provide Unix-like tools that you'll need to build wxWindows using configure.
6500c0b1
JS
354
355Using makefiles directly
fd9f42b6 356------------------------
7666ad49 357
02fd5400
MB
358NOTE: The makefile are for compilation under Cygwin, MSYS, or
359 command.com/cmd.exe, they won't work in other environments
360 (such as UNIX)
361
7666ad49 362Here are the steps required using the provided makefiles:
8870c26e 363
fd9f42b6
VS
364- If you are using gcc-2.95, edit build\msw\config.gcc and set the GCC_VERSION
365 variable to "2.95".
6500c0b1 366
fd9f42b6 367- Use the makefile.gcc files for compiling wxWindows and samples,
4dcd292c 368 e.g. to compile a debugging version of wxWindows:
fd9f42b6
VS
369 > cd c:\wx\build\msw
370 > make -f makefile.gcc BUILD=debug
4dcd292c 371 > cd c:\wx\samples\minimal
fd9f42b6
VS
372 > make -f makefile.gcc BUILD=debug
373 (See below for more options.)
4dcd292c 374
cba2db0c
JS
375 Ignore the warning about the default entry point.
376
9a718b86
MB
377- Use the 'strip' command to reduce executable/dll size (note that
378 stripping an executable/dll will remove debug information!).
2bda0e17 379
2bda0e17 380All targets have 'clean' targets to allow removal of object files
fd9f42b6 381and other intermediate compiler files.
2bda0e17 382
7666ad49 383Using configure
03265572 384---------------
7666ad49
JS
385
386Instead of using the makefiles, you can use the configure
387system to generate appropriate makefiles, as used on Unix
388and Mac OS X systems.
389
390Change directory to the root of the wxWindows distribution,
9a718b86 391make a build directory, and run configure and make in this directory.
7666ad49
JS
392
393For example:
394
395 cd $WXWIN
396 mkdir build-debug
397 cd build-debug
398 ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared
399 make
c5f53eb8 400 make install % This step is optional, see note (8) below.
7666ad49
JS
401 cd samples/minimal
402 make
403 ./minimal.exe
404
7c5dc04f 405Notes:
2bda0e17 406
9a718b86 4071. See also the Cygwin/MinGW on the web site or CD-ROM for
bf4d9b2b 408 further information about using wxWindows with these compilers.
7c5dc04f 409
6b978929 4102. libwx.a is 100 MB or more - but much less if compiled with no
bf4d9b2b 411 debug info (-g0) and level 4 optimization (-O4).
7c5dc04f 412
9a718b86 4133. If you get a link error under MinGW 2.95.2 referring to:
6b978929
JS
414
415 EnumDAdvise__11IDataObjectPP13IEnumSTATDATA@8
416
417 then you need to edit the file objidl.h at line 663 and add
418 a missing PURE keyword:
419
420 STDMETHOD(EnumDAdvise)(THIS_ IEnumSTATDATA**) PURE;
421
9a718b86 4224. There's a bug in MinGW headers for some early distributions.
7c5dc04f 423
bf4d9b2b 424 in include/windows32/defines.h, where it says:
7c5dc04f 425
bf4d9b2b 426 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
7c5dc04f 427
bf4d9b2b 428 it should say:
7c5dc04f 429
bf4d9b2b 430 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
7c5dc04f 431
bf4d9b2b 432 (a missing bracket).
7c5dc04f 433
fd9f42b6 4345. OpenGL support should work with MinGW as-is. However,
fac26663
JS
435 if you wish to generate import libraries appropriate either for
436 the MS OpenGL libraries or the SGI OpenGL libraries, go to
437 include/wx/msw/gl and use:
438
439 dlltool -k -d opengl.def -llibopengl.a
440
441 for the SGI DLLs, or
442
443 dlltool -k -d opengl32.def -llibopengl32.a
444
445 and similarly for glu[32].def.
446
fd9f42b6 4476. The 'make install' step is optional, and copies files
c5f53eb8
JS
448 as follows:
449
450 /usr/local/lib - wxmswXYZd.dll.a and wxmswXYZd.dll
451 /usr/local/include/wx - wxWindows header files
452 /usr/local/bin - wx-config
453
454 You may need to do this if using wx-config with the
455 default root path.
456
fd9f42b6
VS
4577. With Cygwin, you can invoke gdb --nw myfile.exe to
458 debug an executable. If there are memory leaks, they will be
459 flagged when the program quits. You can use Cygwin gdb
460 to debug MinGW executables.
4dcd292c 461
fd9f42b6 462OLD VERSIONS:
4dcd292c
MB
463
464- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
465 to set up appropriate variables, if necessary mounting drives.
466 Run it before compiling.
467
468- For Cygwin, make sure there's a \tmp directory on your
469 Windows drive or bison will crash (actually you don't need
470 bison for ordinary wxWindows compilation: a pre-generated .c file is
471 supplied).
472
4dcd292c 473- If using GnuWin32 b18, you will need to copy windres.exe
9a718b86 474 from e.g. the MinGW distribution, to a directory in your path.
4dcd292c 475
ce8897bb 476Symantec & DigitalMars C++ compilation
03265572 477--------------------------------------
ce8897bb
CE
478The DigitalMars compiler is a free succssor to the Symantec compiler
479and can be downloaded from http://www.digitalmars.com/
025bbf5b 480
fd9f42b6
VS
4811. You need to download and unzip in turn (later packages will overwrite
482 older files)
377c68c5 483 Digital Mars C/C++ Compiler Version 8.34 or 8.35
1a81e3db 484 Basic utilities
377c68c5 485 from http://www.digitalmars.com/download/freecompiler.html [26 Aug 03, CE]
025bbf5b 486
1a81e3db 4872. Change directory to src\msw. Type 'make -f makefile.sc' to
6500c0b1 488 make the wxWindows core library.
1a81e3db
CE
4893. Change directory to samples\minimal and type 'make -f makefile.sc'
490 to make this sample. Most of the other samples also work.
377c68c5 491
2bda0e17 492
ce8897bb 49316-bit compilation is no longer supported.
6500c0b1 494
fd9f42b6
VS
495Configuring the build
496=====================
57c208c5 497
03265572
VS
498So far the instructions only explained how to build release DLLs of wxWindows
499and did not cover any configuration. It is possible to change many aspects of
500the build, including debug/release and ANSI/Unicode settings. All makefiles in
501build\msw directory use same options (with a few exceptions documented below)
502and the only difference between them is in object files and library directory
503names and in make invocation command.
57c208c5 504
03265572
VS
505Changing the settings
506---------------------
57c208c5 507
03265572
VS
508There are two ways to modify the settings: either by passing the values as
509arguments when invoking make or by editing build\msw\config.$(compiler) file
510where $(compiler) is same extension as the makefile you use has (see below).
511The latter is good for setting options that never change in your development
512process (e.g. GCC_VERSION or VENDOR). If you want to build several versions of
513wxWindows and use them side by side, the former method is better. Settings in
514config.* files are shared by all makefiles (samples, contrib, main library),
515but if you pass the options as arguments, you must use same arguments you used
516for the library when building samples or contrib libraries!
8870c26e 517
03265572
VS
518Examples of invoking make in Unicode debug build (other options described
519below are set analogically):
545d1e60 520
03265572
VS
521Visual C++:
522 > nmake -f makefile.vc BUILD=debug UNICODE=1
523
524Borland C++:
19fea858 525 > make -f makefile.bcc -DBUILD=debug -DUNICODE=1
03265572
VS
526 (Note that you have to use -D to set the variable, unlike in other make
527 tools!)
528
529Watcom C/C++:
530 > wmake -f makefile.wat BUILD=debug UNICODE=1
531
532MinGW using native makefiles:
533 > mingw32-make -f makefile.gcc BUILD=debug UNICODE=1
534
535MinGW using configure or Cygwin:
536 > ./configure --enable-debug --enable-unicode
537 (see ./configure --help on details; configure is not covered in this
538 section)
539
540Brief explanation of options and possible values is in every
541build\msw\config.* file; more detailed description follows.
542
543Basic options
8870c26e 544-------------
a0a302dc 545
03265572
VS
546BUILD=debug
547 Builds debug version of the library (default is 'release'). This affects
548 name of the library ('d' is appended), __WXDEBUG__ is defined and debug
549 information compiled into object files and the executable.
550
551SHARED=0
552 Build static libraries instead of DLLs. By default, DLLs are build
553 (SHARED=1).
554
555UNICODE=1
556 To build Unicode versions of the libraries, add UNICODE=1 to make invocation
557 (default is UNICODE=0). If you want to be able to use Unicode version on
558 Windows9x, you will need to set MSLU=1 as well.
559
560 This option affect name of the library ('u' is appended) and the directory
561 where the library and setup.h are store (ditto).
562
563WXUNIV=1
564 Build wxUniversal instead of native wxMSW (see
565 http://www.wxwindows.org/wxuniv.htm for more information).
566
567Advanced options
568----------------
569
570MONOLITHIC=1
93f467a3 571 Starting with version 2.5.1, wxWindows has the ability to be built as
03265572
VS
572 several smaller libraries instead of single big one as used to be the case
573 in 2.4 and older versions. This is called "multilib build" and is the
574 default behaviour of makefiles. You can still build single library
575 ("monolithic build") by setting MONOLITHIC variable to 1.
576
577USE_GUI=0
578 Disable building GUI parts of the library, build only wxBase components used
579 by console applications. Note that if you leave USE_GUI=1 then both wxBase
580 and GUI libraries are built. If you are building monolithic library, then
581 you should set wxUSE_GUI to 1 in setup.h.
582
583USE_OPENGL=1
584 Build wxmsw25_gl.lib library with OpenGL integration class wxGLCanvas.
585 You must also modify your setup.h to #define wxUSE_GLCANVAS 1. Note that
586 OpenGL library is always built as additional library, even in monolithic
587 build!
588
589USE_ODBC=1
590 Build two additional libraries in multilib mode, one with database
591 classes and one with wxGrid database support. You must
592 #define wxUSE_ODBC 1 in setup.h
593
594USE_HTML=0
595 Do not build wxHTML library. If MONOLITHIC=1, then you must also
596 #define wxUSE_HTML 1 in setup.h.
597
598RUNTIME_LIBS=static
599 Links static version of C and C++ runtime libraries into the executable, so
600 that the program does not depend on DLLs provided with the compiler (e.g.
601 Visual C++'s msvcrt.dll or Borland's cc3250mt.dll).
602 Caution: Do not use static runtime libraries when building DLL (SHARED=1)!
603
604MSLU=1
605 Enables MSLU (Microsoft Layer for Unicode). This setting makes sense only if
606 used together with UNICODE=1. If you want to be able to use Unicode version
607 on Windows9x, you will need MSLU (Microsoft Layer for Unicode) runtime DLL
608 and import lib. The former can be downloaded from Microsoft, the latter is
609 part of the latest Platform SDK from Microsoft (see msdn.microsoft.com for
610 details). An alternative implementation of import library can be downloaded
611 from http://libunicows.sourceforge.net - unlike the official one, this one
612 works with other compilers and does not require 300+ MB Platform SDK update.
613
614DEBUG_FLAG=0
615DEBUG_FLAG=1
616 If set to 1, define __WXDEBUG__ symbol, append 'd' to library name and do
617 sanity checks at runtime. If set to 0, don't do it. By default, this is
618 governed by BUILD option (if 'debug', DEBUG_FLAG=1, if 'release' it is 0),
619 but it is sometimes desirable to modify default behaviour and e.g. define
620 __WXDEBUG__ even in release builds.
621
622DEBUG_INFO=0
623DEBUG_INFO=1
624 Same as DEBUG_FLAG in behaviour, this option affects whether debugging
625 information is included in the executable or not.
626
627VENDOR=<your company name>
628 Set this to a short string identifying your company if you are planning to
629 distribute wxWindows DLLs with your application. Default value is 'custom'.
630 This string is included as part of DLL name. wxWindows DLLs contain compiler
631 name, version information and vendor name in them. For example
632 wxmsw250_core_bcc_custom.dll is one of DLLs build using Borland C++ with
633 default settings. If you set VENDOR=mycorp, the name will change to
634 wxmsw250_core_bcc_mycorp.dll.
635
636CFG=<configuration name>
637 Sets configuration name so that you can have multiple wxWindows build with
638 different setup.h settings coexisting in same tree. See "Object and library
639 directories" below for more information.
640
641Compiler specific options
642-------------------------
643
644* MinGW
645
646If you are using gcc-2.95 instead of gcc3, you must set GCC_VERSION to
6472.95. In build\msw\config.gcc, change
648> GCC_VERSION = 3
649to
650> GCC_VERSION = 2.95
651
652* Visual C++
653
654DEBUG_RUNTIME_LIBS=0
655DEBUG_RUNTIME_LIBS=1
656 If set to 1, msvcrtd.dll is used, if to 0, msvcrt.dll is used. By default
657 msvcrtd.dll is used only if the executable contains debug info and
658 msvcrt.dll if it doesn't. It is sometimes desirable to build with debug info
659 and still link against msvcrt.dll (e.g. when you want to ship the app to
660 customers and still have usable .pdb files with debug information) and this
661 setting makes it possible.
662
663Fine-tuning the compiler
664------------------------
665
666All makefiles have variables that you can use to specify additional options
667passed to the compiler or linker. You won't need this in most cases, but if you
668do, simply add desired flags to CFLAGS (for C compiler), CXXFLAGS (for C++
669compiler), CPPFLAGS (for both C and C++ compiler) and LDFLAGS (the linker).
670
671Object and library directories
672------------------------------
673
674All object files produced during library build are stored in a directory under
675build\msw. It's name is derived from build settings and CFG variable and from
676compiler name. Examples of directory names:
677
678 build\msw\bcc_msw SHARED=0
679 build\msw\bcc_mswdll SHARED=1
680 build\msw\bcc_mswunivd SHARED=0, WXUNIV=1, BUILD=debug
681 build\msw\vc_mswunivd ditto, with Visual C++
682
6acf2ef6
VS
683Libraries and DLLs are copied into subdirectory of lib directory with
684name derived from compiler and static/DLL setting and setup.h into directory
685with name that contains other settings:
03265572
VS
686
687 lib\bcc_msw
6acf2ef6
VS
688 lib\bcc_lib\msw\wx\setup.h
689 lib\bcc_dll
690 lib\bcc_dll\msw\wx\setup.h
691 lib\bcc_lib
692 lib\bcc_lib\mswunivd\wx\setup.h
693 lib\vc_lib
694 lib\vc_lib\mswunivd\wx\setup.h
695
696Each lib\ subdirectory has wx subdirectory with setup.h as seen above.
697This file is copied there from include\wx\msw\setup.h (and if it doesn't exist,
698from include\wx\msw\setup0.h) and this is the copy of setup.h that is used by
699all samples and should be used by your apps as well. If you are doing changes
700to setup.h, you should do them in this file, _not_ in include\wx\msw\setup.h.
03265572
VS
701
702If you set CFG to something, the value is appended to directory names. E.g.
703for CFG=MyBuild, you'll have object files in
704
705 build\msw\bcc_mswMyBuild
706 build\msw\bcc_mswdllMyBuild
707 etc.
708
709and libraries in
710
6acf2ef6
VS
711 lib\bcc_libMyBuild
712 lib\bcc_dllMyBuild
03265572
VS
713 etc.
714
715By now it is clear for CFG is for: builds with different CFG settings don't
716share any files and they use different setup.h files. This allows you to e.g.
717have two static debug builds, one with wxUSE_SOCKETS=0 and one with sockets
718enabled (without CFG, both of them would be put into same directory and there
719would be conflict between the files).
720
03265572
VS
721General Notes
722=============
723
a0a302dc 724- Debugging: under Windows 95, debugging output isn't output in
9c6751aa 725 the same way that it is under NT or Windows 3.1.
3d82ef9b
JS
726 Please see DebugView available from http://www.sysinternals.com.
727