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