]> git.saurik.com Git - wxWidgets.git/blame - docs/msw/install.txt
Rebake after adding libs html and xml to samples using lib adv
[wxWidgets.git] / docs / msw / install.txt
CommitLineData
f02fe2ef 1Installing wxWidgets 2.6.2
5147354c 2-----------------------------------------------------------
0544bc0a 3
f02fe2ef 4This is wxWidgets 2.6.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
916095ba
JS
118Also note that you can make the project files work with VC++ 5.0 but you'll
119need to edit .dsp file by hand before this is possible (change the version in
120the .dsp file header from 6.0 to 5.0).
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.
f2e61abe
VS
135 If you want to build DLLs, you have to either build them one by one in
136 proper order (jpeg, png, tiff, zlib, regex, expat, base, core, the rest
137 in any order) or to use wx_dll.dsw workspace which has correct dependencies.
5fa399c9 1383. Open a sample project file, choose a configuration such as
a40a9c81 139 Win32 Debug using Build | Set Active Configuration..., and compile.
5fa399c9 140 The project files don't use precompiled headers, to save disk
16553659 141 space, but you can switch PCH compiling on for greater speed.
a40a9c81 142 NOTE: you may also use samples/samples.dsw to access all
669f7a11
JS
143 sample projects without opening each workspace individually.
144 You can use the Batch Build facility to make several samples
145 at a time.
a367b9b3
JS
146
147Using makefiles:
148
03265572 1491. Change directory to build\msw. Type:
ca5c8b2d
JS
150
151 'nmake -f makefile.vc'
152
fc2171bd 153 to make the wxWidgets core library as release DLL.
fd9f42b6
VS
154 See "Configuring the build" for instruction how to build debug or static
155 libraries.
3d82ef9b 156
03265572 1572. Change directory to samples and type 'nmake -f makefile.vc'
2bda0e17
KB
158 to make all the samples. You can also make them individually.
159
5fa399c9 160Makefile notes:
e2a6f233 161
fd9f42b6 162 Use the 'clean' target to clean all objects, libraries and
ca5c8b2d
JS
163 executables.
164
3f1af920 165Note (1): if you wish to use templates, please edit
025e88c5
JS
166include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
167Without this, the redefinition of 'new' will cause problems in
168the headers. Alternatively, #undef new before including template headers.
dbda9e86
JS
169You will also need to set wxUSE_IOSTREAMH to 0 if you will be
170using templates, to avoid the non-template stream files being included
fc2171bd 171within wxWidgets.
025e88c5 172
3f1af920 173Note (2): libraries and applications generated with makefiles and
5fa399c9
JS
174project files are now (hopefully) compatible where static libraries
175are concerned, but please exercise caution nevertheless and if
176possible, use one method or the other.
3f1af920 177
3d82ef9b 178Note (3): some crash problems can be due to inconsistent compiler
ad813b00
JS
179options. If strange/weird/impossible things start to happen please
180check (dumping IDE project file as makefile and doing text comparison
181if necessary) that the project settings, especially the list of defined
182symbols, struct packing, etc. are exactly the same for all items in
183the project. After this, delete everything (including PCH) and recompile.
184
3d82ef9b 185Note (4): to create your own IDE files, copy .dsp and .dsw
fc2171bd 186files from an existing wxWidgets sample and adapt them, or
3d82ef9b 187visit http://wiki.wxwindows.org/wiki.pl?MSVC.
e2a6f233 188
9d1461a4 189Borland C++ 5.0/5.5 compilation
5147354c 190----------------------------------------------------------------
2bda0e17 191
2b5f62a0 192Compiling using the makefiles (updated 24 Sept 02):
ca5c8b2d 193
fd9f42b6 1941. Change directory to build\msw. Type 'make -f makefile.bcc' to
fc2171bd 195 make the wxWidgets core library. Ignore the compiler warnings.
6bddef36 196 This produces a couple of libraries in the lib\bcc_lib directory.
fd9f42b6
VS
197
1982. Change directory to a sample or demo such as samples\minimal, and type
199 'make -f makefile.bcc'. This produces a windows exe file - by default
6bddef36 200 in the bcc_mswd subdirectory.
fd9f42b6 201
fc2171bd 202Note (1): the wxWidgets makefiles assume dword structure alignment. Please
1a7f3062
JS
203make sure that your own project or makefile settings use the
204same alignment, or you could experience mysterious crashes. To
fd9f42b6 205change the alignment, change CPPFLAGS in build\msw\config.bcc.
1a7f3062 206
9d1461a4 207Note (2): if you get undefined _SQL... symbols at link time,
154f22b3
JS
208either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
209directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
fc2171bd 210recompile wxWidgets. The same applies if compiling using the IDE.
154f22b3 211
9d1461a4 212Note (3): If you wish debug messages to be sent to the console in
fd9f42b6 213debug mode, edit makefile.bcc and change /aa to /Tpe in link commands.
7fee680b 214
7945bfb4
CE
215Compiling using the IDE files for Borland C++ 5.0: not supported - please
216use version 2.4.1 (using the make utility in commandline mode works fine_
ca5c8b2d 217
7945bfb4
CE
218Compiling using CBuilder (v1-v6): not supported - please
219use version 2.4.1 (using the make utility in commandline mode works fine_
ca5c8b2d 220
f6bcfd97
BP
221** REMEMBER **
222
fc2171bd 223In all of your wxWidgets applications, your source code should include
f6bcfd97
BP
224the following preprocessor directive:
225
226#ifdef __BORLANDC__
227#pragma hdrstop
228#endif
229
545d1e60
VZ
230(check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for
231more details)
232
9d1461a4 233Borland 16 Bit compilation for Windows 3.1
5147354c 234----------------------------------------------------------------
4bf78aae 235
fc2171bd 236The last version of wxWidgets to support 16-bit compilation with Borland was
9d1461a4 2372.2.7 - Please download and read the instructions in that release
545d1e60
VZ
238
239Watcom C++ 10.6/11 and OpenWatcom compilation
5147354c 240----------------------------------------------------------------
7be1f0d9 241
fd9f42b6 2421. Change directory to build\msw. Type 'wmake -f makefile.wat' to
fc2171bd 243 make the wxWidgets core library.
3d82ef9b 244
e8400940 2452. Change directory to samples\minimal and type 'wmake -f makefile.wat'
ace03f87
JS
246 to make this sample. Repeat for other samples of interest.
247
545d1e60
VZ
248Note (1): if your installation of Watcom doesn't have odbc32.lib file and
249 you need it (i.e. you have wxUSE_ODBC=1), you can use the file
250 from lib\watcom directory. See the notes in that directory.
251
252Note (2): if variant.cpp is compiled with date/time class options, the linker
253 gives up. So the date/time option is switched off for Watcom C++.
254 Also, wxAutomationObject is not compiled with Watcom C++ 10.
255
025bbf5b
CE
256Note (3): RawBitmaps won't work at present because they use unsupported template
257 classes
258
259Note (4): if Watcom can't read the precompiled header when building a sample,
fd9f42b6
VS
260 try deleting .pch files in build\msw\wat_* and compiling
261 the sample again.
545d1e60 262
62448488 263Metrowerks CodeWarrior compilation
5147354c 264----------------------------------------------------------------
62448488 265
5147354c 2661. CodeWarrior Pro 7 project files in XML format are already
f02fe2ef 267 included in wxMSW-2.6.2.zip and the setup version.
3d82ef9b 268
545d1e60
VZ
2692. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if
270 you are working from the CVS version) to make sure the settings reflect
271 what you want. If you aren't sure, leave it alone and go with the
ba14d986
VZ
272 default settings. A few notes:
273 - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL
545d1e60 274 - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports
ba14d986
VZ
275 will be rather confusing due to interactions with the MSL ANSI
276 and runtime libs.
3d82ef9b 277
fc2171bd 2783. The project file to build the Win32 wxWidgets libraries relies on the
545d1e60
VZ
279 Batch File Runner plug-in. This plug-in is not installed as part of
280 a normal CW7 installation. However, you can find this plug-in on the
281 CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the
282 "Batch File Post Linker".
3d82ef9b 283
545d1e60 2844. If you choose not to install the Batch File Runner plug-in, then you
ba14d986 285 need to do the following by hand:
545d1e60
VZ
286 (1) Create the directories lib\cw7msw\include\wx and copy the file
287 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
ba14d986 288 working from the CVS version) to lib\cw7msw\include\wx\setup.h
545d1e60
VZ
289 (2) Create the directories lib\cw7mswd\include\wx and copy the file
290 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
ba14d986 291 working from the CVS version) to lib\cw7mswd\include\wx\setup.h
3d82ef9b 292
fc2171bd 2935. Import src\wxWidgetsW7.xml to create the project file wxWidgetsW7.mcp.
545d1e60
VZ
294 Store this project file in directory src. You may get warnings about
295 not being able to find certain project paths; ignore these warnings, the
ba14d986 296 appropriate paths will be created during the build by the Batch File Runner.
3d82ef9b 297
545d1e60
VZ
2986. Choose the wxlib Win32 debug or wxlib Win32 Release target and build. You
299 will get some warnings about hidden virtual functions, illegal conversions
ba14d986 300 from const pointers to pointers, etc., all of which you can safely ignore.
545d1e60
VZ
301 ***Note: if you get errors that the compiler can't find "wx/setup.h", just
302 stop the build and build again. These errors occur because sometimes the
ba14d986 303 compiler starts doing its thing before the copying of setup.h has completed.
3d82ef9b 304
ba14d986
VZ
3057. The following libraries will be produced depending on chosen
306 target:
307 - wx_x86.lib ANSI Release (static)
308 - wx_x86_d.lib ANSI Debug (static)
3d82ef9b 309
ba14d986 3108. Sorry, I haven't had time yet to create and test unicode or DLL versions.
545d1e60 311 Volunteers for this are welcome (as neither DLLs nor unicode builds are
ba14d986 312 big priorities for me ;).
3d82ef9b 313
545d1e60
VZ
3149. CodeWarrior Pro7 project files (in XML format) are also provided for some
315 of the samples. In particular, there are project files for the minimal,
316 controls, dialogs, dnd, nd docview samples. You can use these project
317 files as templates for the other samples and for your own projects.
3d82ef9b 318 - For example, to make a project file for the "grid" sample,
545d1e60
VZ
319 just copy the project file for the "minimal" sample, minimalW7.mcp
320 (made by importing minimalW7.xml into CodeWarrior), into the
3d82ef9b 321 sample/grid directory, calling it gridW7.mcp. Open
545d1e60
VZ
322 newgridW7.mcp and revise the project by deleting the files
323 minimal.rc and minimal.cpp and adding the files griddemo.rc and
377c68c5
CE
324 griddemo.cpp. Build and run....
325
545d1e60 326
9a718b86 327Cygwin/MinGW compilation
5147354c 328----------------------------------------------------------------
2bda0e17 329
7acf6a92 330wxWidgets supports Cygwin (formerly GnuWin32) betas and
9a718b86 331releases, and MinGW. Cygwin can be downloaded from:
6500c0b1 332
9a718b86 333 http://sources.redhat.com/cygwin/
2bda0e17 334
9a718b86 335and MinGW from:
6500c0b1 336
9a718b86 337 http://www.mingw.org/
2bda0e17 338
fd9f42b6
VS
339Both Cygwin and MinGW can be used with configure (assuming you have MSYS
340installed in case of MinGW). You will need new enough MinGW version, preferably
341MinGW 2.0 (ships with gcc3) or at least 1.0 (gcc-2.95.3). GCC versions older
fc2171bd 342than 2.95.3 don't work; you can use wxWidgets 2.4 with them.
545d1e60 343
fd9f42b6
VS
344NOTE: some notes specific to old Cygwin (< 1.1.x) are at the end of this
345 section (see OLD VERSIONS)
2bda0e17 346
fc2171bd 347There are two methods of compiling wxWidgets, by using the
7666ad49 348makefiles provided or by using 'configure'.
2bda0e17 349
9a718b86 350Retrieve and install the latest version of Cygwin, or MinGW, as per
6500c0b1
JS
351the instructions with either of these packages.
352
9a718b86 353If using MinGW, you can download the add-on MSYS package to
fc2171bd 354provide Unix-like tools that you'll need to build wxWidgets using configure.
6500c0b1
JS
355
356Using makefiles directly
5147354c 357----------------------------------------------------------------
7666ad49 358
d01bf7ae
VS
359NOTE: The makefile.gcc makefiles are for compilation under MinGW using
360 native make and Windows command interpreter (command.com/cmd.exe), they
361 won't work in other environments (such as UNIX or Unix-like, e.g. MSYS;
362 you have to use configure instead)
02fd5400 363
7666ad49 364Here are the steps required using the provided makefiles:
8870c26e 365
fd9f42b6
VS
366- If you are using gcc-2.95, edit build\msw\config.gcc and set the GCC_VERSION
367 variable to "2.95".
6500c0b1 368
fc2171bd
JS
369- Use the makefile.gcc files for compiling wxWidgets and samples,
370 e.g. to compile a debugging version of wxWidgets:
fd9f42b6
VS
371 > cd c:\wx\build\msw
372 > make -f makefile.gcc BUILD=debug
4dcd292c 373 > cd c:\wx\samples\minimal
fd9f42b6
VS
374 > make -f makefile.gcc BUILD=debug
375 (See below for more options.)
4dcd292c 376
cba2db0c
JS
377 Ignore the warning about the default entry point.
378
9a718b86
MB
379- Use the 'strip' command to reduce executable/dll size (note that
380 stripping an executable/dll will remove debug information!).
2bda0e17 381
2bda0e17 382All targets have 'clean' targets to allow removal of object files
fd9f42b6 383and other intermediate compiler files.
2bda0e17 384
7666ad49 385Using configure
5147354c 386----------------------------------------------------------------
7666ad49
JS
387
388Instead of using the makefiles, you can use the configure
389system to generate appropriate makefiles, as used on Unix
390and Mac OS X systems.
391
fc2171bd 392Change directory to the root of the wxWidgets distribution,
9a718b86 393make a build directory, and run configure and make in this directory.
7666ad49
JS
394
395For example:
396
397 cd $WXWIN
398 mkdir build-debug
399 cd build-debug
400 ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared
401 make
c5f53eb8 402 make install % This step is optional, see note (8) below.
7666ad49
JS
403 cd samples/minimal
404 make
405 ./minimal.exe
406
7c5dc04f 407Notes:
2bda0e17 408
9a718b86 4091. See also the Cygwin/MinGW on the web site or CD-ROM for
fc2171bd 410 further information about using wxWidgets with these compilers.
7c5dc04f 411
6b978929 4122. libwx.a is 100 MB or more - but much less if compiled with no
bf4d9b2b 413 debug info (-g0) and level 4 optimization (-O4).
7c5dc04f 414
9a718b86 4153. If you get a link error under MinGW 2.95.2 referring to:
6b978929
JS
416
417 EnumDAdvise__11IDataObjectPP13IEnumSTATDATA@8
418
419 then you need to edit the file objidl.h at line 663 and add
420 a missing PURE keyword:
421
422 STDMETHOD(EnumDAdvise)(THIS_ IEnumSTATDATA**) PURE;
423
9a718b86 4244. There's a bug in MinGW headers for some early distributions.
7c5dc04f 425
bf4d9b2b 426 in include/windows32/defines.h, where it says:
7c5dc04f 427
bf4d9b2b 428 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
7c5dc04f 429
bf4d9b2b 430 it should say:
7c5dc04f 431
bf4d9b2b 432 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
7c5dc04f 433
bf4d9b2b 434 (a missing bracket).
7c5dc04f 435
fd9f42b6 4365. OpenGL support should work with MinGW as-is. However,
fac26663
JS
437 if you wish to generate import libraries appropriate either for
438 the MS OpenGL libraries or the SGI OpenGL libraries, go to
439 include/wx/msw/gl and use:
440
441 dlltool -k -d opengl.def -llibopengl.a
442
443 for the SGI DLLs, or
444
445 dlltool -k -d opengl32.def -llibopengl32.a
446
447 and similarly for glu[32].def.
448
fd9f42b6 4496. The 'make install' step is optional, and copies files
c5f53eb8
JS
450 as follows:
451
452 /usr/local/lib - wxmswXYZd.dll.a and wxmswXYZd.dll
fc2171bd 453 /usr/local/include/wx - wxWidgets header files
c5f53eb8
JS
454 /usr/local/bin - wx-config
455
456 You may need to do this if using wx-config with the
457 default root path.
458
fd9f42b6
VS
4597. With Cygwin, you can invoke gdb --nw myfile.exe to
460 debug an executable. If there are memory leaks, they will be
461 flagged when the program quits. You can use Cygwin gdb
462 to debug MinGW executables.
4dcd292c 463
14ff1954
MW
4648. Note that gcc's precompiled headers do not work on current versions of
465 Cygwin. If your version of Cygwin is affected you will need to use the
466 --disable-precomp-headers configure option.
467
fd9f42b6 468OLD VERSIONS:
4dcd292c
MB
469
470- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
471 to set up appropriate variables, if necessary mounting drives.
472 Run it before compiling.
473
474- For Cygwin, make sure there's a \tmp directory on your
475 Windows drive or bison will crash (actually you don't need
fc2171bd 476 bison for ordinary wxWidgets compilation: a pre-generated .c file is
4dcd292c
MB
477 supplied).
478
4dcd292c 479- If using GnuWin32 b18, you will need to copy windres.exe
9a718b86 480 from e.g. the MinGW distribution, to a directory in your path.
4dcd292c 481
df945db9 482
ce8897bb 483Symantec & DigitalMars C++ compilation
5147354c
JS
484----------------------------------------------------------------
485
ce8897bb
CE
486The DigitalMars compiler is a free succssor to the Symantec compiler
487and can be downloaded from http://www.digitalmars.com/
025bbf5b 488
fd9f42b6
VS
4891. You need to download and unzip in turn (later packages will overwrite
490 older files)
9c266fa0 491 Digital Mars C/C++ Compiler Version 8.40 or later
1a81e3db 492 Basic utilities
df945db9 493 from http://www.digitalmars.com/download/freecompiler.html
025bbf5b 494
df945db9 4952. Change directory to build\msw and type 'make -f makefile.dmc' to
fc2171bd 496 make the wxWidgets core library.
df945db9
VZ
497
4983. Change directory to samples\minimal and type 'make -f makefile.dmc'
1a81e3db 499 to make this sample. Most of the other samples also work.
377c68c5 500
2bda0e17 501
df945db9
VZ
502Note that if you don't have the files makefile.dmc you may create them yourself
503using bakefile tool according to the instructions in build\bakefiles\README:
504
505 cd build\bakefiles
506 bakefile_gen -f dmars -b wx.bkl
507 bakefile_gen -f dmars -b ../../samples/minimal/minimal.bkl
508
509
ce8897bb 51016-bit compilation is no longer supported.
6500c0b1 511
fd9f42b6 512Configuring the build
5147354c 513================================================================
57c208c5 514
fc2171bd 515So far the instructions only explained how to build release DLLs of wxWidgets
03265572
VS
516and did not cover any configuration. It is possible to change many aspects of
517the build, including debug/release and ANSI/Unicode settings. All makefiles in
518build\msw directory use same options (with a few exceptions documented below)
519and the only difference between them is in object files and library directory
520names and in make invocation command.
57c208c5 521
03265572 522Changing the settings
5147354c 523----------------------------------------------------------------
57c208c5 524
03265572
VS
525There are two ways to modify the settings: either by passing the values as
526arguments when invoking make or by editing build\msw\config.$(compiler) file
527where $(compiler) is same extension as the makefile you use has (see below).
528The latter is good for setting options that never change in your development
529process (e.g. GCC_VERSION or VENDOR). If you want to build several versions of
fc2171bd 530wxWidgets and use them side by side, the former method is better. Settings in
03265572
VS
531config.* files are shared by all makefiles (samples, contrib, main library),
532but if you pass the options as arguments, you must use same arguments you used
533for the library when building samples or contrib libraries!
8870c26e 534
03265572
VS
535Examples of invoking make in Unicode debug build (other options described
536below are set analogically):
545d1e60 537
03265572
VS
538Visual C++:
539 > nmake -f makefile.vc BUILD=debug UNICODE=1
540
541Borland C++:
19fea858 542 > make -f makefile.bcc -DBUILD=debug -DUNICODE=1
03265572
VS
543 (Note that you have to use -D to set the variable, unlike in other make
544 tools!)
545
546Watcom C/C++:
547 > wmake -f makefile.wat BUILD=debug UNICODE=1
548
549MinGW using native makefiles:
550 > mingw32-make -f makefile.gcc BUILD=debug UNICODE=1
551
14ff1954 552MinGW using configure:
03265572
VS
553 > ./configure --enable-debug --enable-unicode
554 (see ./configure --help on details; configure is not covered in this
555 section)
556
14ff1954
MW
557Cygwin using configure:
558 > ./configure --disable-precomp-headers --enable-debug --enable-unicode
559 (use --disable-precomp-headers if Cygwin doesn't support precompiled
560 headers)
561
03265572
VS
562Brief explanation of options and possible values is in every
563build\msw\config.* file; more detailed description follows.
564
565Basic options
5147354c 566----------------------------------------------------------------
a0a302dc 567
458d26a0
WS
568BUILD=release
569 Builds release version of the library. It differs from default 'debug'
570 in lack of appended 'd' in name of library, does not define __WXDEBUG__
571 and not include debug information compiled into object files and the
572 executable.
573
574SHARED=1
575 Build shared libraries (DLLs). By default, DLLs are not built
576 (SHARED=0).
03265572
VS
577
578UNICODE=1
579 To build Unicode versions of the libraries, add UNICODE=1 to make invocation
580 (default is UNICODE=0). If you want to be able to use Unicode version on
581 Windows9x, you will need to set MSLU=1 as well.
582
583 This option affect name of the library ('u' is appended) and the directory
584 where the library and setup.h are store (ditto).
585
586WXUNIV=1
587 Build wxUniversal instead of native wxMSW (see
fc2171bd 588 http://www.wxwidgets.org/wxuniv.htm for more information).
03265572
VS
589
590Advanced options
5147354c 591----------------------------------------------------------------
03265572
VS
592
593MONOLITHIC=1
fc2171bd 594 Starting with version 2.5.1, wxWidgets has the ability to be built as
03265572
VS
595 several smaller libraries instead of single big one as used to be the case
596 in 2.4 and older versions. This is called "multilib build" and is the
597 default behaviour of makefiles. You can still build single library
598 ("monolithic build") by setting MONOLITHIC variable to 1.
599
600USE_GUI=0
601 Disable building GUI parts of the library, build only wxBase components used
602 by console applications. Note that if you leave USE_GUI=1 then both wxBase
603 and GUI libraries are built. If you are building monolithic library, then
604 you should set wxUSE_GUI to 1 in setup.h.
605
606USE_OPENGL=1
607 Build wxmsw25_gl.lib library with OpenGL integration class wxGLCanvas.
608 You must also modify your setup.h to #define wxUSE_GLCANVAS 1. Note that
609 OpenGL library is always built as additional library, even in monolithic
610 build!
611
612USE_ODBC=1
613 Build two additional libraries in multilib mode, one with database
614 classes and one with wxGrid database support. You must
615 #define wxUSE_ODBC 1 in setup.h
616
617USE_HTML=0
618 Do not build wxHTML library. If MONOLITHIC=1, then you must also
619 #define wxUSE_HTML 1 in setup.h.
620
9a8f0513
VS
621USE_XRC=0
622 Do not build XRC resources library. If MONOLITHIC=1, then you must also
623 #define wxUSE_HTML 1 in setup.h.
624
03265572
VS
625RUNTIME_LIBS=static
626 Links static version of C and C++ runtime libraries into the executable, so
627 that the program does not depend on DLLs provided with the compiler (e.g.
628 Visual C++'s msvcrt.dll or Borland's cc3250mt.dll).
629 Caution: Do not use static runtime libraries when building DLL (SHARED=1)!
630
631MSLU=1
632 Enables MSLU (Microsoft Layer for Unicode). This setting makes sense only if
633 used together with UNICODE=1. If you want to be able to use Unicode version
634 on Windows9x, you will need MSLU (Microsoft Layer for Unicode) runtime DLL
635 and import lib. The former can be downloaded from Microsoft, the latter is
636 part of the latest Platform SDK from Microsoft (see msdn.microsoft.com for
637 details). An alternative implementation of import library can be downloaded
638 from http://libunicows.sourceforge.net - unlike the official one, this one
639 works with other compilers and does not require 300+ MB Platform SDK update.
640
641DEBUG_FLAG=0
642DEBUG_FLAG=1
643 If set to 1, define __WXDEBUG__ symbol, append 'd' to library name and do
644 sanity checks at runtime. If set to 0, don't do it. By default, this is
645 governed by BUILD option (if 'debug', DEBUG_FLAG=1, if 'release' it is 0),
646 but it is sometimes desirable to modify default behaviour and e.g. define
647 __WXDEBUG__ even in release builds.
648
649DEBUG_INFO=0
650DEBUG_INFO=1
651 Same as DEBUG_FLAG in behaviour, this option affects whether debugging
652 information is included in the executable or not.
653
654VENDOR=<your company name>
655 Set this to a short string identifying your company if you are planning to
fc2171bd
JS
656 distribute wxWidgets DLLs with your application. Default value is 'custom'.
657 This string is included as part of DLL name. wxWidgets DLLs contain compiler
03265572
VS
658 name, version information and vendor name in them. For example
659 wxmsw250_core_bcc_custom.dll is one of DLLs build using Borland C++ with
660 default settings. If you set VENDOR=mycorp, the name will change to
661 wxmsw250_core_bcc_mycorp.dll.
662
663CFG=<configuration name>
fc2171bd 664 Sets configuration name so that you can have multiple wxWidgets builds with
03265572
VS
665 different setup.h settings coexisting in same tree. See "Object and library
666 directories" below for more information.
667
668Compiler specific options
5147354c 669----------------------------------------------------------------
03265572
VS
670
671* MinGW
672
673If you are using gcc-2.95 instead of gcc3, you must set GCC_VERSION to
6742.95. In build\msw\config.gcc, change
675> GCC_VERSION = 3
676to
677> GCC_VERSION = 2.95
678
679* Visual C++
680
681DEBUG_RUNTIME_LIBS=0
682DEBUG_RUNTIME_LIBS=1
683 If set to 1, msvcrtd.dll is used, if to 0, msvcrt.dll is used. By default
684 msvcrtd.dll is used only if the executable contains debug info and
685 msvcrt.dll if it doesn't. It is sometimes desirable to build with debug info
686 and still link against msvcrt.dll (e.g. when you want to ship the app to
687 customers and still have usable .pdb files with debug information) and this
688 setting makes it possible.
689
690Fine-tuning the compiler
5147354c 691----------------------------------------------------------------
03265572
VS
692
693All makefiles have variables that you can use to specify additional options
694passed to the compiler or linker. You won't need this in most cases, but if you
695do, simply add desired flags to CFLAGS (for C compiler), CXXFLAGS (for C++
696compiler), CPPFLAGS (for both C and C++ compiler) and LDFLAGS (the linker).
697
698Object and library directories
5147354c 699----------------------------------------------------------------
03265572
VS
700
701All object files produced during library build are stored in a directory under
702build\msw. It's name is derived from build settings and CFG variable and from
703compiler name. Examples of directory names:
704
705 build\msw\bcc_msw SHARED=0
706 build\msw\bcc_mswdll SHARED=1
707 build\msw\bcc_mswunivd SHARED=0, WXUNIV=1, BUILD=debug
708 build\msw\vc_mswunivd ditto, with Visual C++
709
6acf2ef6
VS
710Libraries and DLLs are copied into subdirectory of lib directory with
711name derived from compiler and static/DLL setting and setup.h into directory
712with name that contains other settings:
03265572
VS
713
714 lib\bcc_msw
6acf2ef6
VS
715 lib\bcc_lib\msw\wx\setup.h
716 lib\bcc_dll
717 lib\bcc_dll\msw\wx\setup.h
718 lib\bcc_lib
719 lib\bcc_lib\mswunivd\wx\setup.h
720 lib\vc_lib
721 lib\vc_lib\mswunivd\wx\setup.h
722
723Each lib\ subdirectory has wx subdirectory with setup.h as seen above.
724This file is copied there from include\wx\msw\setup.h (and if it doesn't exist,
725from include\wx\msw\setup0.h) and this is the copy of setup.h that is used by
726all samples and should be used by your apps as well. If you are doing changes
727to setup.h, you should do them in this file, _not_ in include\wx\msw\setup.h.
03265572
VS
728
729If you set CFG to something, the value is appended to directory names. E.g.
730for CFG=MyBuild, you'll have object files in
731
732 build\msw\bcc_mswMyBuild
733 build\msw\bcc_mswdllMyBuild
734 etc.
735
736and libraries in
737
6acf2ef6
VS
738 lib\bcc_libMyBuild
739 lib\bcc_dllMyBuild
03265572
VS
740 etc.
741
fd04b3cb 742By now it is clear what CFG is for: builds with different CFG settings don't
03265572
VS
743share any files and they use different setup.h files. This allows you to e.g.
744have two static debug builds, one with wxUSE_SOCKETS=0 and one with sockets
745enabled (without CFG, both of them would be put into same directory and there
fd04b3cb 746would be conflicts between the files).
03265572 747
03265572 748General Notes
5147354c 749=================================================================
03265572 750
a0a302dc 751- Debugging: under Windows 95, debugging output isn't output in
9c6751aa 752 the same way that it is under NT or Windows 3.1.
3d82ef9b
JS
753 Please see DebugView available from http://www.sysinternals.com.
754