]> git.saurik.com Git - wxWidgets.git/blame - docs/msw/install.txt
Fixes tex2rtf to search for files on current folder too. This is basically to test...
[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
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.
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
391e89ae
MW
189Microsoft Visual C++ compilation for 64-bit Windows
190----------------------------------------------------------------
191
192Visual Studio 2005 includes 64-bit compilers, though they are not installed by
b46d37d7
MW
193default; you need to select them during the installation. Both native 64-bit
194compilers and 32-bit hosted cross compilers are included, so you do not need a
19564-bit machine to use them (though you do to run the created executables).
196Visual C++ Express Edition does not include 64-bit compilers.
391e89ae 197
b46d37d7
MW
19864-bit compilers are also available in various SDKs, for example
199the .NET Framework SDK:
391e89ae
MW
200 http://msdn.microsoft.com/netframework/programming/64bit/devtools/
201
202Using project files:
203
391e89ae
MW
2041. Open the VC++ 6 workspace file: build\msw\wx.dsw. Visual Studio will then
205 convert the projects to the current Visual C++ project format.
206
2072. To add 64-bit targets, go to the 'Build' menu and choose 'Configuration
208 Manager...'. In the 'Active solution platform' drop down choose '<new>',
209 then you can choose either 'Itanium' or 'x64'.
210
211 For more detailed instructions see:
212 http://msdn2.microsoft.com/en-us/library/9yb4317s(en-us,vs.80).aspx
213
b46d37d7
MW
214 Note: 64-bit targets created this way will use the build directory of the
215 corresponding 32-bit target for some files. Therefore after building
216 for one CPU it is necessary to clean the build before building the
217 equivalent target for another CPU. We've reported the problem to MS
b974b0da 218 but they say it is not possible to fix it.
b46d37d7 219
391e89ae
MW
2203. To build, go to the 'Build' menu and choose 'Batch Build...'. Tick all the
221 all the 'x64|Debug' or all the 'Itanium|Debug' projects, and click 'Build'.
222
223 This will build a debug version of the static libs. The section above on
224 Visual C++ in general has more information about adjusting the settings to
225 build other configurations.
226
2274. To compile one of the samples open one of the sample projects, such as
228 samples\minimal\minimal.dsw. Visual Studio will convert the project as in
229 step 1, then add a 64-bit target as in step 2, and build.
230
231Using makefiles:
232
2331. Open a 64-bit build command prompt, for either x64 or Itanium. Change
b974b0da 234 directory to build\msw. Then for x64 type:
391e89ae
MW
235
236 nmake -f makefile.vc TARGET_CPU=AMD64
237
238 or for Itanium:
239
240 nmake -f makefile.vc TARGET_CPU=IA64
241
242 This will build a debug version of wxWidgets DLLs. See "Configuring the
243 build" for instruction how to build other configurations such as a release
244 build or static libraries.
245
2462. Change to the directory of one of the samples such as samples\minimal. Type
247 the same command used to build the main library, for example for x64:
248
249 nmake -f makefile.vc TARGET_CPU=AMD64
250
251Notes:
252
253The versions of the VC++ 8 compiler included with some SDKs requires an
254additional library to be linked or the following error is received.
255
256 LNK2001 unresolved external symbol __security_check_cookie
257
258If you receive this error add bufferoverflowu.lib to link, e.g.:
259
260 nmake -f makefile.vc TARGET_CPU=AMD64 LDFLAGS=bufferoverflowu.lib
261
262See http://support.microsoft.com/?id=894573 for more information.
263
71521e37 264Borland C++ compilation
5147354c 265----------------------------------------------------------------
2bda0e17 266
71521e37
CE
267The minimum version required is 5.5, which can be downloaded for free from:
268http://www.borland.com/products/downloads/download_cbuilder.html#
269
270Compiling using the makefiles:
ca5c8b2d 271
fd9f42b6 2721. Change directory to build\msw. Type 'make -f makefile.bcc' to
fc2171bd 273 make the wxWidgets core library. Ignore the compiler warnings.
6bddef36 274 This produces a couple of libraries in the lib\bcc_lib directory.
fd9f42b6
VS
275
2762. Change directory to a sample or demo such as samples\minimal, and type
277 'make -f makefile.bcc'. This produces a windows exe file - by default
6bddef36 278 in the bcc_mswd subdirectory.
fd9f42b6 279
fc2171bd 280Note (1): the wxWidgets makefiles assume dword structure alignment. Please
1a7f3062
JS
281make sure that your own project or makefile settings use the
282same alignment, or you could experience mysterious crashes. To
fd9f42b6 283change the alignment, change CPPFLAGS in build\msw\config.bcc.
1a7f3062 284
9d1461a4 285Note (2): if you get undefined _SQL... symbols at link time,
154f22b3
JS
286either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
287directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
fc2171bd 288recompile wxWidgets. The same applies if compiling using the IDE.
154f22b3 289
9d1461a4 290Note (3): If you wish debug messages to be sent to the console in
fd9f42b6 291debug mode, edit makefile.bcc and change /aa to /Tpe in link commands.
7fee680b 292
71521e37
CE
293Cmpilation succeeds with CBuilderX personal edition and CBuilder6, but
294you may have to copy make.exe from the 5.5 download to the new bin directory.
295Compiling using the IDE files for Borland C++ 5.0 and using CBuilder IDE
296(v1-v6): not supported
ca5c8b2d 297
ca5c8b2d 298
f6bcfd97
BP
299** REMEMBER **
300
fc2171bd 301In all of your wxWidgets applications, your source code should include
f6bcfd97
BP
302the following preprocessor directive:
303
304#ifdef __BORLANDC__
305#pragma hdrstop
306#endif
307
545d1e60
VZ
308(check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for
309more details)
310
9d1461a4 311Borland 16 Bit compilation for Windows 3.1
5147354c 312----------------------------------------------------------------
4bf78aae 313
fc2171bd 314The last version of wxWidgets to support 16-bit compilation with Borland was
9d1461a4 3152.2.7 - Please download and read the instructions in that release
545d1e60
VZ
316
317Watcom C++ 10.6/11 and OpenWatcom compilation
5147354c 318----------------------------------------------------------------
7be1f0d9 319
fd9f42b6 3201. Change directory to build\msw. Type 'wmake -f makefile.wat' to
fc2171bd 321 make the wxWidgets core library.
3d82ef9b 322
e8400940 3232. Change directory to samples\minimal and type 'wmake -f makefile.wat'
ace03f87
JS
324 to make this sample. Repeat for other samples of interest.
325
545d1e60
VZ
326Note (1): if your installation of Watcom doesn't have odbc32.lib file and
327 you need it (i.e. you have wxUSE_ODBC=1), you can use the file
328 from lib\watcom directory. See the notes in that directory.
329
330Note (2): if variant.cpp is compiled with date/time class options, the linker
331 gives up. So the date/time option is switched off for Watcom C++.
332 Also, wxAutomationObject is not compiled with Watcom C++ 10.
333
025bbf5b
CE
334Note (3): RawBitmaps won't work at present because they use unsupported template
335 classes
336
337Note (4): if Watcom can't read the precompiled header when building a sample,
fd9f42b6
VS
338 try deleting .pch files in build\msw\wat_* and compiling
339 the sample again.
545d1e60 340
62448488 341Metrowerks CodeWarrior compilation
5147354c 342----------------------------------------------------------------
62448488 343
5147354c 3441. CodeWarrior Pro 7 project files in XML format are already
f02fe2ef 345 included in wxMSW-2.6.2.zip and the setup version.
3d82ef9b 346
545d1e60
VZ
3472. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if
348 you are working from the CVS version) to make sure the settings reflect
349 what you want. If you aren't sure, leave it alone and go with the
ba14d986
VZ
350 default settings. A few notes:
351 - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL
545d1e60 352 - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports
ba14d986
VZ
353 will be rather confusing due to interactions with the MSL ANSI
354 and runtime libs.
3d82ef9b 355
fc2171bd 3563. The project file to build the Win32 wxWidgets libraries relies on the
545d1e60
VZ
357 Batch File Runner plug-in. This plug-in is not installed as part of
358 a normal CW7 installation. However, you can find this plug-in on the
359 CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the
360 "Batch File Post Linker".
3d82ef9b 361
545d1e60 3624. If you choose not to install the Batch File Runner plug-in, then you
ba14d986 363 need to do the following by hand:
545d1e60
VZ
364 (1) Create the directories lib\cw7msw\include\wx and copy the file
365 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
ba14d986 366 working from the CVS version) to lib\cw7msw\include\wx\setup.h
545d1e60
VZ
367 (2) Create the directories lib\cw7mswd\include\wx and copy the file
368 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
ba14d986 369 working from the CVS version) to lib\cw7mswd\include\wx\setup.h
3d82ef9b 370
fc2171bd 3715. Import src\wxWidgetsW7.xml to create the project file wxWidgetsW7.mcp.
545d1e60
VZ
372 Store this project file in directory src. You may get warnings about
373 not being able to find certain project paths; ignore these warnings, the
ba14d986 374 appropriate paths will be created during the build by the Batch File Runner.
3d82ef9b 375
545d1e60
VZ
3766. Choose the wxlib Win32 debug or wxlib Win32 Release target and build. You
377 will get some warnings about hidden virtual functions, illegal conversions
ba14d986 378 from const pointers to pointers, etc., all of which you can safely ignore.
545d1e60
VZ
379 ***Note: if you get errors that the compiler can't find "wx/setup.h", just
380 stop the build and build again. These errors occur because sometimes the
ba14d986 381 compiler starts doing its thing before the copying of setup.h has completed.
3d82ef9b 382
ba14d986
VZ
3837. The following libraries will be produced depending on chosen
384 target:
385 - wx_x86.lib ANSI Release (static)
386 - wx_x86_d.lib ANSI Debug (static)
3d82ef9b 387
ba14d986 3888. Sorry, I haven't had time yet to create and test unicode or DLL versions.
545d1e60 389 Volunteers for this are welcome (as neither DLLs nor unicode builds are
ba14d986 390 big priorities for me ;).
3d82ef9b 391
545d1e60
VZ
3929. CodeWarrior Pro7 project files (in XML format) are also provided for some
393 of the samples. In particular, there are project files for the minimal,
394 controls, dialogs, dnd, nd docview samples. You can use these project
395 files as templates for the other samples and for your own projects.
3d82ef9b 396 - For example, to make a project file for the "grid" sample,
545d1e60
VZ
397 just copy the project file for the "minimal" sample, minimalW7.mcp
398 (made by importing minimalW7.xml into CodeWarrior), into the
3d82ef9b 399 sample/grid directory, calling it gridW7.mcp. Open
545d1e60
VZ
400 newgridW7.mcp and revise the project by deleting the files
401 minimal.rc and minimal.cpp and adding the files griddemo.rc and
377c68c5
CE
402 griddemo.cpp. Build and run....
403
545d1e60 404
9a718b86 405Cygwin/MinGW compilation
5147354c 406----------------------------------------------------------------
2bda0e17 407
7acf6a92 408wxWidgets supports Cygwin (formerly GnuWin32) betas and
9a718b86 409releases, and MinGW. Cygwin can be downloaded from:
6500c0b1 410
9a718b86 411 http://sources.redhat.com/cygwin/
2bda0e17 412
9a718b86 413and MinGW from:
6500c0b1 414
9a718b86 415 http://www.mingw.org/
2bda0e17 416
fd9f42b6
VS
417Both Cygwin and MinGW can be used with configure (assuming you have MSYS
418installed in case of MinGW). You will need new enough MinGW version, preferably
419MinGW 2.0 (ships with gcc3) or at least 1.0 (gcc-2.95.3). GCC versions older
fc2171bd 420than 2.95.3 don't work; you can use wxWidgets 2.4 with them.
545d1e60 421
fd9f42b6
VS
422NOTE: some notes specific to old Cygwin (< 1.1.x) are at the end of this
423 section (see OLD VERSIONS)
2bda0e17 424
fc2171bd 425There are two methods of compiling wxWidgets, by using the
7666ad49 426makefiles provided or by using 'configure'.
2bda0e17 427
9a718b86 428Retrieve and install the latest version of Cygwin, or MinGW, as per
6500c0b1
JS
429the instructions with either of these packages.
430
9a718b86 431If using MinGW, you can download the add-on MSYS package to
fc2171bd 432provide Unix-like tools that you'll need to build wxWidgets using configure.
6500c0b1
JS
433
434Using makefiles directly
5147354c 435----------------------------------------------------------------
7666ad49 436
d01bf7ae
VS
437NOTE: The makefile.gcc makefiles are for compilation under MinGW using
438 native make and Windows command interpreter (command.com/cmd.exe), they
439 won't work in other environments (such as UNIX or Unix-like, e.g. MSYS;
440 you have to use configure instead)
02fd5400 441
7666ad49 442Here are the steps required using the provided makefiles:
8870c26e 443
fd9f42b6
VS
444- If you are using gcc-2.95, edit build\msw\config.gcc and set the GCC_VERSION
445 variable to "2.95".
6500c0b1 446
fc2171bd
JS
447- Use the makefile.gcc files for compiling wxWidgets and samples,
448 e.g. to compile a debugging version of wxWidgets:
fd9f42b6
VS
449 > cd c:\wx\build\msw
450 > make -f makefile.gcc BUILD=debug
4dcd292c 451 > cd c:\wx\samples\minimal
fd9f42b6
VS
452 > make -f makefile.gcc BUILD=debug
453 (See below for more options.)
4dcd292c 454
cba2db0c
JS
455 Ignore the warning about the default entry point.
456
9a718b86
MB
457- Use the 'strip' command to reduce executable/dll size (note that
458 stripping an executable/dll will remove debug information!).
2bda0e17 459
2bda0e17 460All targets have 'clean' targets to allow removal of object files
fd9f42b6 461and other intermediate compiler files.
2bda0e17 462
7666ad49 463Using configure
5147354c 464----------------------------------------------------------------
7666ad49
JS
465
466Instead of using the makefiles, you can use the configure
467system to generate appropriate makefiles, as used on Unix
468and Mac OS X systems.
469
fc2171bd 470Change directory to the root of the wxWidgets distribution,
9a718b86 471make a build directory, and run configure and make in this directory.
7666ad49
JS
472
473For example:
474
475 cd $WXWIN
476 mkdir build-debug
477 cd build-debug
478 ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared
479 make
be27bc46 480 make install % This step is optional, see note (6) below.
7666ad49
JS
481 cd samples/minimal
482 make
483 ./minimal.exe
484
7c5dc04f 485Notes:
2bda0e17 486
9a718b86 4871. See also the Cygwin/MinGW on the web site or CD-ROM for
fc2171bd 488 further information about using wxWidgets with these compilers.
7c5dc04f 489
6b978929 4902. libwx.a is 100 MB or more - but much less if compiled with no
bf4d9b2b 491 debug info (-g0) and level 4 optimization (-O4).
7c5dc04f 492
9a718b86 4933. If you get a link error under MinGW 2.95.2 referring to:
6b978929
JS
494
495 EnumDAdvise__11IDataObjectPP13IEnumSTATDATA@8
496
497 then you need to edit the file objidl.h at line 663 and add
498 a missing PURE keyword:
499
500 STDMETHOD(EnumDAdvise)(THIS_ IEnumSTATDATA**) PURE;
501
9a718b86 5024. There's a bug in MinGW headers for some early distributions.
7c5dc04f 503
bf4d9b2b 504 in include/windows32/defines.h, where it says:
7c5dc04f 505
bf4d9b2b 506 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
7c5dc04f 507
bf4d9b2b 508 it should say:
7c5dc04f 509
bf4d9b2b 510 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
7c5dc04f 511
bf4d9b2b 512 (a missing bracket).
7c5dc04f 513
fd9f42b6 5145. OpenGL support should work with MinGW as-is. However,
fac26663
JS
515 if you wish to generate import libraries appropriate either for
516 the MS OpenGL libraries or the SGI OpenGL libraries, go to
517 include/wx/msw/gl and use:
518
519 dlltool -k -d opengl.def -llibopengl.a
520
521 for the SGI DLLs, or
522
523 dlltool -k -d opengl32.def -llibopengl32.a
524
525 and similarly for glu[32].def.
526
fd9f42b6 5276. The 'make install' step is optional, and copies files
c5f53eb8
JS
528 as follows:
529
530 /usr/local/lib - wxmswXYZd.dll.a and wxmswXYZd.dll
fc2171bd 531 /usr/local/include/wx - wxWidgets header files
c5f53eb8
JS
532 /usr/local/bin - wx-config
533
534 You may need to do this if using wx-config with the
535 default root path.
536
fd9f42b6
VS
5377. With Cygwin, you can invoke gdb --nw myfile.exe to
538 debug an executable. If there are memory leaks, they will be
539 flagged when the program quits. You can use Cygwin gdb
540 to debug MinGW executables.
4dcd292c 541
14ff1954
MW
5428. Note that gcc's precompiled headers do not work on current versions of
543 Cygwin. If your version of Cygwin is affected you will need to use the
544 --disable-precomp-headers configure option.
545
fd9f42b6 546OLD VERSIONS:
4dcd292c
MB
547
548- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
549 to set up appropriate variables, if necessary mounting drives.
550 Run it before compiling.
551
552- For Cygwin, make sure there's a \tmp directory on your
553 Windows drive or bison will crash (actually you don't need
fc2171bd 554 bison for ordinary wxWidgets compilation: a pre-generated .c file is
4dcd292c
MB
555 supplied).
556
4dcd292c 557- If using GnuWin32 b18, you will need to copy windres.exe
9a718b86 558 from e.g. the MinGW distribution, to a directory in your path.
4dcd292c 559
df945db9 560
ce8897bb 561Symantec & DigitalMars C++ compilation
5147354c
JS
562----------------------------------------------------------------
563
ce8897bb
CE
564The DigitalMars compiler is a free succssor to the Symantec compiler
565and can be downloaded from http://www.digitalmars.com/
025bbf5b 566
fd9f42b6
VS
5671. You need to download and unzip in turn (later packages will overwrite
568 older files)
9c266fa0 569 Digital Mars C/C++ Compiler Version 8.40 or later
1a81e3db 570 Basic utilities
df945db9 571 from http://www.digitalmars.com/download/freecompiler.html
025bbf5b 572
df945db9 5732. Change directory to build\msw and type 'make -f makefile.dmc' to
fc2171bd 574 make the wxWidgets core library.
df945db9
VZ
575
5763. Change directory to samples\minimal and type 'make -f makefile.dmc'
1a81e3db 577 to make this sample. Most of the other samples also work.
377c68c5 578
2bda0e17 579
df945db9
VZ
580Note that if you don't have the files makefile.dmc you may create them yourself
581using bakefile tool according to the instructions in build\bakefiles\README:
582
583 cd build\bakefiles
584 bakefile_gen -f dmars -b wx.bkl
585 bakefile_gen -f dmars -b ../../samples/minimal/minimal.bkl
586
587
ce8897bb 58816-bit compilation is no longer supported.
6500c0b1 589
fd9f42b6 590Configuring the build
5147354c 591================================================================
57c208c5 592
fc2171bd 593So far the instructions only explained how to build release DLLs of wxWidgets
03265572
VS
594and did not cover any configuration. It is possible to change many aspects of
595the build, including debug/release and ANSI/Unicode settings. All makefiles in
596build\msw directory use same options (with a few exceptions documented below)
597and the only difference between them is in object files and library directory
598names and in make invocation command.
57c208c5 599
03265572 600Changing the settings
5147354c 601----------------------------------------------------------------
57c208c5 602
03265572
VS
603There are two ways to modify the settings: either by passing the values as
604arguments when invoking make or by editing build\msw\config.$(compiler) file
605where $(compiler) is same extension as the makefile you use has (see below).
606The latter is good for setting options that never change in your development
607process (e.g. GCC_VERSION or VENDOR). If you want to build several versions of
fc2171bd 608wxWidgets and use them side by side, the former method is better. Settings in
03265572
VS
609config.* files are shared by all makefiles (samples, contrib, main library),
610but if you pass the options as arguments, you must use same arguments you used
611for the library when building samples or contrib libraries!
8870c26e 612
03265572
VS
613Examples of invoking make in Unicode debug build (other options described
614below are set analogically):
545d1e60 615
03265572
VS
616Visual C++:
617 > nmake -f makefile.vc BUILD=debug UNICODE=1
618
619Borland C++:
19fea858 620 > make -f makefile.bcc -DBUILD=debug -DUNICODE=1
03265572
VS
621 (Note that you have to use -D to set the variable, unlike in other make
622 tools!)
623
624Watcom C/C++:
625 > wmake -f makefile.wat BUILD=debug UNICODE=1
626
627MinGW using native makefiles:
628 > mingw32-make -f makefile.gcc BUILD=debug UNICODE=1
629
14ff1954 630MinGW using configure:
03265572
VS
631 > ./configure --enable-debug --enable-unicode
632 (see ./configure --help on details; configure is not covered in this
633 section)
634
14ff1954
MW
635Cygwin using configure:
636 > ./configure --disable-precomp-headers --enable-debug --enable-unicode
637 (use --disable-precomp-headers if Cygwin doesn't support precompiled
638 headers)
639
03265572
VS
640Brief explanation of options and possible values is in every
641build\msw\config.* file; more detailed description follows.
642
643Basic options
5147354c 644----------------------------------------------------------------
a0a302dc 645
458d26a0
WS
646BUILD=release
647 Builds release version of the library. It differs from default 'debug'
648 in lack of appended 'd' in name of library, does not define __WXDEBUG__
649 and not include debug information compiled into object files and the
650 executable.
651
652SHARED=1
653 Build shared libraries (DLLs). By default, DLLs are not built
654 (SHARED=0).
03265572
VS
655
656UNICODE=1
657 To build Unicode versions of the libraries, add UNICODE=1 to make invocation
658 (default is UNICODE=0). If you want to be able to use Unicode version on
659 Windows9x, you will need to set MSLU=1 as well.
660
661 This option affect name of the library ('u' is appended) and the directory
662 where the library and setup.h are store (ditto).
663
664WXUNIV=1
665 Build wxUniversal instead of native wxMSW (see
fc2171bd 666 http://www.wxwidgets.org/wxuniv.htm for more information).
03265572
VS
667
668Advanced options
5147354c 669----------------------------------------------------------------
03265572
VS
670
671MONOLITHIC=1
fc2171bd 672 Starting with version 2.5.1, wxWidgets has the ability to be built as
03265572
VS
673 several smaller libraries instead of single big one as used to be the case
674 in 2.4 and older versions. This is called "multilib build" and is the
675 default behaviour of makefiles. You can still build single library
676 ("monolithic build") by setting MONOLITHIC variable to 1.
677
678USE_GUI=0
679 Disable building GUI parts of the library, build only wxBase components used
680 by console applications. Note that if you leave USE_GUI=1 then both wxBase
681 and GUI libraries are built. If you are building monolithic library, then
682 you should set wxUSE_GUI to 1 in setup.h.
683
684USE_OPENGL=1
685 Build wxmsw25_gl.lib library with OpenGL integration class wxGLCanvas.
686 You must also modify your setup.h to #define wxUSE_GLCANVAS 1. Note that
687 OpenGL library is always built as additional library, even in monolithic
688 build!
689
690USE_ODBC=1
691 Build two additional libraries in multilib mode, one with database
692 classes and one with wxGrid database support. You must
693 #define wxUSE_ODBC 1 in setup.h
694
695USE_HTML=0
696 Do not build wxHTML library. If MONOLITHIC=1, then you must also
697 #define wxUSE_HTML 1 in setup.h.
698
9a8f0513
VS
699USE_XRC=0
700 Do not build XRC resources library. If MONOLITHIC=1, then you must also
701 #define wxUSE_HTML 1 in setup.h.
702
03265572
VS
703RUNTIME_LIBS=static
704 Links static version of C and C++ runtime libraries into the executable, so
705 that the program does not depend on DLLs provided with the compiler (e.g.
706 Visual C++'s msvcrt.dll or Borland's cc3250mt.dll).
707 Caution: Do not use static runtime libraries when building DLL (SHARED=1)!
708
709MSLU=1
710 Enables MSLU (Microsoft Layer for Unicode). This setting makes sense only if
711 used together with UNICODE=1. If you want to be able to use Unicode version
712 on Windows9x, you will need MSLU (Microsoft Layer for Unicode) runtime DLL
713 and import lib. The former can be downloaded from Microsoft, the latter is
714 part of the latest Platform SDK from Microsoft (see msdn.microsoft.com for
715 details). An alternative implementation of import library can be downloaded
716 from http://libunicows.sourceforge.net - unlike the official one, this one
717 works with other compilers and does not require 300+ MB Platform SDK update.
718
719DEBUG_FLAG=0
720DEBUG_FLAG=1
721 If set to 1, define __WXDEBUG__ symbol, append 'd' to library name and do
722 sanity checks at runtime. If set to 0, don't do it. By default, this is
723 governed by BUILD option (if 'debug', DEBUG_FLAG=1, if 'release' it is 0),
724 but it is sometimes desirable to modify default behaviour and e.g. define
725 __WXDEBUG__ even in release builds.
726
727DEBUG_INFO=0
728DEBUG_INFO=1
729 Same as DEBUG_FLAG in behaviour, this option affects whether debugging
730 information is included in the executable or not.
731
732VENDOR=<your company name>
733 Set this to a short string identifying your company if you are planning to
fc2171bd
JS
734 distribute wxWidgets DLLs with your application. Default value is 'custom'.
735 This string is included as part of DLL name. wxWidgets DLLs contain compiler
03265572
VS
736 name, version information and vendor name in them. For example
737 wxmsw250_core_bcc_custom.dll is one of DLLs build using Borland C++ with
738 default settings. If you set VENDOR=mycorp, the name will change to
739 wxmsw250_core_bcc_mycorp.dll.
740
741CFG=<configuration name>
fc2171bd 742 Sets configuration name so that you can have multiple wxWidgets builds with
03265572
VS
743 different setup.h settings coexisting in same tree. See "Object and library
744 directories" below for more information.
745
746Compiler specific options
5147354c 747----------------------------------------------------------------
03265572
VS
748
749* MinGW
750
751If you are using gcc-2.95 instead of gcc3, you must set GCC_VERSION to
7522.95. In build\msw\config.gcc, change
753> GCC_VERSION = 3
754to
755> GCC_VERSION = 2.95
756
757* Visual C++
758
759DEBUG_RUNTIME_LIBS=0
760DEBUG_RUNTIME_LIBS=1
761 If set to 1, msvcrtd.dll is used, if to 0, msvcrt.dll is used. By default
762 msvcrtd.dll is used only if the executable contains debug info and
763 msvcrt.dll if it doesn't. It is sometimes desirable to build with debug info
764 and still link against msvcrt.dll (e.g. when you want to ship the app to
765 customers and still have usable .pdb files with debug information) and this
766 setting makes it possible.
767
768Fine-tuning the compiler
5147354c 769----------------------------------------------------------------
03265572
VS
770
771All makefiles have variables that you can use to specify additional options
772passed to the compiler or linker. You won't need this in most cases, but if you
773do, simply add desired flags to CFLAGS (for C compiler), CXXFLAGS (for C++
774compiler), CPPFLAGS (for both C and C++ compiler) and LDFLAGS (the linker).
775
776Object and library directories
5147354c 777----------------------------------------------------------------
03265572
VS
778
779All object files produced during library build are stored in a directory under
780build\msw. It's name is derived from build settings and CFG variable and from
781compiler name. Examples of directory names:
782
783 build\msw\bcc_msw SHARED=0
784 build\msw\bcc_mswdll SHARED=1
785 build\msw\bcc_mswunivd SHARED=0, WXUNIV=1, BUILD=debug
786 build\msw\vc_mswunivd ditto, with Visual C++
787
6acf2ef6
VS
788Libraries and DLLs are copied into subdirectory of lib directory with
789name derived from compiler and static/DLL setting and setup.h into directory
790with name that contains other settings:
03265572
VS
791
792 lib\bcc_msw
6acf2ef6
VS
793 lib\bcc_lib\msw\wx\setup.h
794 lib\bcc_dll
795 lib\bcc_dll\msw\wx\setup.h
796 lib\bcc_lib
797 lib\bcc_lib\mswunivd\wx\setup.h
798 lib\vc_lib
799 lib\vc_lib\mswunivd\wx\setup.h
800
801Each lib\ subdirectory has wx subdirectory with setup.h as seen above.
802This file is copied there from include\wx\msw\setup.h (and if it doesn't exist,
803from include\wx\msw\setup0.h) and this is the copy of setup.h that is used by
804all samples and should be used by your apps as well. If you are doing changes
805to setup.h, you should do them in this file, _not_ in include\wx\msw\setup.h.
03265572
VS
806
807If you set CFG to something, the value is appended to directory names. E.g.
808for CFG=MyBuild, you'll have object files in
809
810 build\msw\bcc_mswMyBuild
811 build\msw\bcc_mswdllMyBuild
812 etc.
813
814and libraries in
815
6acf2ef6
VS
816 lib\bcc_libMyBuild
817 lib\bcc_dllMyBuild
03265572
VS
818 etc.
819
fd04b3cb 820By now it is clear what CFG is for: builds with different CFG settings don't
03265572
VS
821share any files and they use different setup.h files. This allows you to e.g.
822have two static debug builds, one with wxUSE_SOCKETS=0 and one with sockets
823enabled (without CFG, both of them would be put into same directory and there
fd04b3cb 824would be conflicts between the files).
03265572 825
03265572 826General Notes
5147354c 827=================================================================
03265572 828
a0a302dc 829- Debugging: under Windows 95, debugging output isn't output in
9c6751aa 830 the same way that it is under NT or Windows 3.1.
3d82ef9b
JS
831 Please see DebugView available from http://www.sysinternals.com.
832