]> git.saurik.com Git - wxWidgets.git/blame - docs/msw/install.txt
wxExecute may only be called from the main thread
[wxWidgets.git] / docs / msw / install.txt
CommitLineData
42280e48 1Installing wxWindows 2.5.0
4e4dc03d 2--------------------------
0544bc0a 3
545d1e60
VZ
4This is wxWindows 2.5.0 for Microsoft Windows 9x/ME, Windows NT, Windows 2000
5and Windows XP. This is an unstable development release. Note that unstable in
6this context doesn't mean that it crashes a lot, just that the library API may
7change in backwards incompatible way during the 2.5 branch life time.
a40a9c81 8
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
545d1e60 22
2bda0e17
KB
23Unarchiving
24-----------
25
2b5f62a0
VZ
26A setup program is provided (setup.exe) to automatically copy
27files to a directory on your hard disk. Do not install into a
28path that contains spaces. To avoid confusion with other
29wxWindows installations that might be on your machine, the
30installation program does not se the WXWIN environment variable;
31please set this by hand via the System applet if you wish to
32make it permanent.
33
34The setup program contains the following:
01dba85a
JS
35
36- All common, generic and MSW-specific wxWindows source;
37- samples;
38- documentation in Windows Help format;
b9f933ab
JS
39- makefiles for most Windows compilers, plus CodeWarrior,
40 BC++ and VC++ IDE files;
01dba85a 41- JPEG library source;
669f7a11 42- TIFF library source;
01dba85a 43- Object Graphics Library;
01dba85a
JS
44- Tex2RTF source;
45- Dialog Editor binary.
46
f6bcfd97
BP
47Alternatively, you may unarchive the .zip form by hand:
48wxMSW-x.y.z.zip where x.y.z is the version number.
2bda0e17
KB
49
50Unarchive the required files plus any optional documentation
dbda9e86 51files into a suitable directory such as c:\wx.
2bda0e17 52
8870c26e
JS
53Other add-on packages are available from the wxWindows Web site, such as:
54
5d525ad9 55- mmedia.zip. Audio, CD, video access for Windows and Linux.
8870c26e
JS
56- ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
57- tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
58 the same document source.
59
545d1e60 60
dbda9e86
JS
61General installation notes
62--------------------------
63
2b5f62a0 64Alter your WXWIN environment variable to point to the root directory of the
9a718b86 65wxWindows installation. For Cygwin or MinGW compilation, make sure WXWIN
2b5f62a0 66contains only forward slashes.
dbda9e86
JS
67
68If installing from the CVS server, copy include/wx/msw/setup0.h to
a40a9c81
JS
69include/wx/msw/setup.h and edit the resulting file to choose
70the features you would like to compile wxWindows with[out].
dbda9e86 71
545d1e60 72
2bda0e17 73Compilation
545d1e60 74===========
2bda0e17 75
dbda9e86 76The following sections explain how to compile wxWindows with each supported
545d1e60
VZ
77compiler. Search for one of Microsoft/Borland/Watcom/Symantec/Metrowerks/
78Cygwin/Mingw32 to quickly locate the instructions for your compiler.
79
2bda0e17 80
545d1e60
VZ
81Microsoft Visual C++ compilation
82--------------------------------
2bda0e17 83
38c1f6f7
VZ
84Please note that the VC++ 6.0 project files will work for VC++ .NET also, but
85you must open the .dsp files and not the .dsw files and in this case you will
916095ba 86need to manually build the other .dsp on which wxWindows.dsp depends: jpeg,
38c1f6f7 87png, regex, tiff and zlib.
1257f684 88
916095ba
JS
89Also note that you can make the project files work with VC++ 5.0 but you'll
90need to edit .dsp file by hand before this is possible (change the version in
91the .dsp file header from 6.0 to 5.0).
38c1f6f7
VZ
92
93Using project files (VC++ 6 and later):
a367b9b3 94
a40a9c81 951. Unarchive wxWindows-x.y.z-vc.zip, the VC++ 6 project
f6bcfd97 96 makefiles (already included in wxMSW-x.y.z.zip and the setup version).
38c1f6f7 972. Open src/wxWindows.dsw, which has configurations for static
a40a9c81
JS
98 compilation or DLL compilation, and each of these available in
99 Unicode/ANSI and Debug/Release variations. Normally you'll use
100 a static linking ANSI configuration. Choose the Win32 Debug or
101 Win32 Release configuration for the wxWindows project, and compile.
102 Alternatively, use Batch Build to build more than one
103 configuration.
104 The following libraries will be produced depending on chosen
105 configuration:
106
107 wxmsw.lib wxmswd.lib ; ANSI Release/Debug
108 wxmswu.lib wxmswud.lib ; UNICODE Release/Debug
109 wxmsw23x.lib wxmsw23xd.lib ; ANSI DLL Release/Debug
110 wxmsw23xu.lib wxmsw23xud.lib ; UNICODE DLL Release/Debug
111
112 It will also produce similar variations on jpeg.lib, png.lib,
113 tiff.lib, zlib.lib, and regex.lib.
5fa399c9 1143. Open a sample project file, choose a configuration such as
a40a9c81 115 Win32 Debug using Build | Set Active Configuration..., and compile.
5fa399c9 116 The project files don't use precompiled headers, to save disk
16553659 117 space, but you can switch PCH compiling on for greater speed.
a40a9c81 118 NOTE: you may also use samples/samples.dsw to access all
669f7a11
JS
119 sample projects without opening each workspace individually.
120 You can use the Batch Build facility to make several samples
121 at a time.
a367b9b3
JS
122
123Using makefiles:
124
62448488 1251. Make sure your WXWIN variable is set.
d1e418ea
JS
1262. If you do NOT have the TIFF or JPEG source code, please remove
127 the tiff and jpeg targets from the 'all' target in
128 src\msw\makefile.vc. Also ensure the settings in
129 include\wx\msw\setup.h specify not to use JPEG or TIFF.
1303. Change directory to wx\src\msw. Type:
ca5c8b2d
JS
131
132 'nmake -f makefile.vc'
133
134 to make the wxWindows core library with debug information
7fee680b 135 (wx\lib\wxd.lib), then
ca5c8b2d 136
7fee680b 137 'nmake -f makefile.vc cleanall FINAL=1'
ca5c8b2d
JS
138 'nmake -f makefile.vc FINAL=1'
139
a40a9c81 140 to make the wxWindows core library without debug information.
85f3749f 1414. Change directory to wx\samples and type 'nmake -f makefile.vc'
2bda0e17
KB
142 to make all the samples. You can also make them individually.
143
5fa399c9 144Makefile notes:
e2a6f233 145
7fee680b 146 Use the 'cleanall' target to clean all objects, libraries and
ca5c8b2d
JS
147 executables.
148
149 To build the release version using makefiles, add FINAL=1 to your
150 nmake invocation, both when building the library and for samples.
7fee680b
JS
151 You MUST use the 'cleanall' target (with FINAL=1 or FINAL=0)
152 before making a different configuration, because otherwise
153 object files used to build the previous configuration may be
2edb0bde 154 used accidentally for the current configuration. You might see
7fee680b
JS
155 this manifested in unexpected link errors or warnings. This problem
156 doesn't occur when using project files to build wxWindows.
ca5c8b2d 157
4dcd292c 158 To build Unicode versions of the libraries, add UNICODE=1
9a718b86 159 to the nmake invocation (default is UNICODE=0). If you want to
545d1e60 160 be able to use Unicode version on Windows9x, you will need
26a00631
VS
161 MSLU (Microsoft Layer for Unicode) runtime DLL and import lib.
162 The former can be downloaded from Microsoft, the latter is part
545d1e60 163 of the latest Platform SDK from Microsoft (see msdn.microsoft.com
26a00631
VS
164 for details). An alternative implementation of import library can
165 be downloaded from http://libunicows.sourceforge.net - unlike the
166 official one, this one works with other compilers and does not
167 require 300+ MB Platform SDK update. Add MSLU=1 to the nmake
168 invocation to enable MSLU.
4dcd292c 169
ca5c8b2d
JS
170 Note that the wxWindows core library allows you to have debug
171 and release libraries available simultaneously, by compiling the
172 objects in different subdirectories, whereas samples must be
7fee680b 173 cleaned and re-made to build a different configuration.
e2a6f233
JS
174
175To build the DLL version using makefiles:
176
9a718b86 1771. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll'
e2a6f233
JS
178 to make both a suitable DLL and import library, and to build a
179 suitable precompiled header file for compiling applications.
a40a9c81 180 See the previous section for library names.
ca5c8b2d
JS
1812. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
182 (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
183 applications).
e2a6f233 184
3f1af920 185Note (1): if you wish to use templates, please edit
025e88c5
JS
186include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
187Without this, the redefinition of 'new' will cause problems in
188the headers. Alternatively, #undef new before including template headers.
dbda9e86
JS
189You will also need to set wxUSE_IOSTREAMH to 0 if you will be
190using templates, to avoid the non-template stream files being included
191within wxWindows.
025e88c5 192
3f1af920 193Note (2): libraries and applications generated with makefiles and
5fa399c9
JS
194project files are now (hopefully) compatible where static libraries
195are concerned, but please exercise caution nevertheless and if
196possible, use one method or the other.
3f1af920 197
750b78ba 198Note (3): VC++ 5's optimization code seems to be broken and can
ad556aa9
JS
199cause both compile and run-time problems: this can be seen when
200deleting an object Dialog Editor, in Release mode with optimizations
201on. If in doubt, switch off optimisations, although this will result in much
750b78ba
JS
202larger executables. It seems possible that the library can be created with
203strong optimization, so long as the application is not strongly
204optimized. For example, in wxWindows project, set to 'Minimum
205Size'. In Dialog Editor project, set to 'Customize: Favor Small
206Code' (and no others). This will then work.
207
ad813b00
JS
208Note (4): some crash problems can be due to inconsistent compiler
209options. If strange/weird/impossible things start to happen please
210check (dumping IDE project file as makefile and doing text comparison
211if necessary) that the project settings, especially the list of defined
212symbols, struct packing, etc. are exactly the same for all items in
213the project. After this, delete everything (including PCH) and recompile.
214
a40a9c81 215Note (5): to create your own IDE files, see the technical note on the
9c6751aa 216wxWindows web site or CD-ROM, entitled "Compiling wxWindows
f6bcfd97
BP
217applications in the VC++ IDE" (technical note docs/tech/tn0010.htm in the
218wxWindows distribution). You can also copy .dsp and .dsw
9c6751aa
JS
219files from an existing wxWindows sample and adapt them.
220
545d1e60 221
8fb3a512
JS
222Visual C++ 1.5 compilation (16-bit)
223-----------------------------------
2bda0e17 224
9d1461a4 225No longer supported
a40a9c81 226
e2a6f233 227
9d1461a4 228Borland C++ 5.0/5.5 compilation
2bda0e17
KB
229-------------------------------
230
2b5f62a0 231Compiling using the makefiles (updated 24 Sept 02):
ca5c8b2d 232
9fce8d2e
JS
2331. Make sure your WXWIN variable is set [e.g add
234 set WXWIN=c:\wxwindows
2b5f62a0 235 to your autoexec.bat file], The WXWIN variable should contain neither spaces nor -
545d1e60 236 You may like to use the short form as shown by a dos directory listing ;
42280e48 237 eg instead of c:\wxwindows-2.5.0 use c:\wxwind~1.4
545d1e60 238 Reboot if needed for the changes to autoexec.bat to take effect.
19e9b919 2392. Change directory to src\msw. Type 'make -f makefile.b32' to
b7b45f6f
CE
240 make the wxWindows core library. Ignore the compiler warnings.
241 This produces a library in the wxwindows\lib directory called
242 wx32ds.lib
c0bcc480 2433. Change directory to a sample or demo such as samples\minimal, and type
b7b45f6f 244 'make -f makefile.b32'. This produces a windows exe file
4bf78aae
JS
2454. For release versions, recompile wxWindows and samples using
246 'make -f makefile.b32 clean'
247 'make -f makefile.b32 FINAL=1'
b7b45f6f
CE
248 for the library and samples. This produces a library wx32s.lib eliminating
249 all debugging information - if you wish to retain reduced debugging information
250 'make -f makefile.b32 clean'
251 'make -f makefile.b32 FINAL=hybrid'
252
f6bcfd97
BP
2535. To make and use wxWindows as a DLL, type
254 'make -f makefile.b32 clean'
255 'make -f makefile.b32 DLL=1'
545d1e60 256 which generates a DLL (wx32d.dll) and import library (wx32d.lib),
f6bcfd97
BP
257 and then for each sample,
258 'make -f makefile.b32 WXUSINGDLL=1'
259 Please note that the samples have not been exhaustively tested
b7b45f6f
CE
260 with this configuration. You may also generate a sepratae library
261 and second DLL using the commands
262 'make -f makefile.b32 clean'
263 'make -f makefile.b32 DLL=1 FINAL=1'
545d1e60 264 which generates a DLL (wx32.dll) and import library (wx32.lib),
b7b45f6f
CE
265 and then for each sample,
266 'make -f makefile.b32 WXUSINGDLL=1 FINAL=1'
267
2b5f62a0
VZ
2686. You can use the WXUNIVERSAL widgets instead of the native MSW
269 ones (eg if you want to build an application with the same
270 look and feel on all platforms)
271 Use the command
272 'make -f makefile.b32 WXUSINGUNIV=1'
273 Then run
274 'make -f makefile.b32 WXUSINGUNIV=1' in the sample directory which you wish
275 to build using the wxUniversal widgets. Use 'SET WXTHEME=GTK' [or WIN32 or METAL]
276 to test the existing themes
277 The makefile is written with the intention that you can build DLLs
278 and do final releases by combinations of commandline parameters.
279 At the time of writing, (Oct 02) not all the wxDialogs are working
280
2817. To make console mode applications with wxWindows functions go
b7b45f6f
CE
282 to the src\msw directory
283 'make -f makebase.b32 clean'
284 'make -f makebase.b32'
285 There is a sample\console directory and in this type
286 'make -f makefile.b32 wxUSE_GUI=0'
287
288Note (0): This provides the ability to produce separate wxwindows libraries
289 for different purposes, and only have to rebuild the applications
290
62448488 291
9d1461a4 292Note (1): the wxWindows makefiles assume byte structure alignment. Please
1a7f3062
JS
293make sure that your own project or makefile settings use the
294same alignment, or you could experience mysterious crashes. To
295change the alignment, add a suitable option to the $(CFG) target code
296in src/msw/makefile.b32.
297
9d1461a4 298Note (2): if you get undefined _SQL... symbols at link time,
154f22b3
JS
299either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
300directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
301recompile wxWindows. The same applies if compiling using the IDE.
302
790ad94f 303
9d1461a4 304Note (3): If you wish debug messages to be sent to the console in
7fee680b
JS
305debug mode, edit src\makeb32.env and change /aa to /Tpe in
306LINK_FLAGS.
307
9fce8d2e 308Compiling using the IDE files: [Borland C++ 5.0, not Cbuilder]
ca5c8b2d 309
9d1461a4
CE
3101. Load src\bc32.ide from the file bc32.zip at
311 http://biolpc22.york.ac.uk/pub/ports/bcc32/wxwin21/ and select Release settings
ca5c8b2d
JS
3122. Go to Options|Project... and specify the correct BC++ include and lib path for
313 your file structure.
3143. Press F9 to compile the wxWindows library.
33b64e6f 3154. Load samples\bc32.ide.
ca5c8b2d
JS
3165. Go to Options|Project... and specify the correct BC++ include and lib path for
317 your file structure.
01dba85a
JS
3186. Press F9 to compile the samples (build each node separately if
319 you prefer, by right clicking and choose Build Node).
3207. Run each sample: you may need to run from each sample's directory
321 since some (notably the wxHTML samples) look for files
322 relative to the working directory.
ca5c8b2d 323
c0bcc480
JS
324Note (1): the samples project file contains a selection of
325samples, and not all samples. The remaining samples can be made
326with the makefiles. See also the demos hierarchy which doesn't
327have any BC++ project files yet.
328
fb1bd1bd 329Note (2): to make the png, zlib, jpeg and tiff libraries (needed for
01dba85a 330some samples) you need to compile them with bc32.ide.
33b64e6f 331
c0bcc480
JS
332Note (3): the debug version of the wxWindows library is about 40 MB, and the
333release version is around 5 MB.
33b64e6f 334
f6bcfd97 335See also the file docs/tech/tn0007.txt for further instructions and details
ca5c8b2d
JS
336of how to create your own project files.
337
f6bcfd97
BP
338** REMEMBER **
339
545d1e60 340In all of your wxWindows applications, your source code should include
f6bcfd97
BP
341the following preprocessor directive:
342
343#ifdef __BORLANDC__
344#pragma hdrstop
345#endif
346
545d1e60
VZ
347(check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for
348more details)
349
f6bcfd97 350
9fce8d2e 351Borland C++Builder IDE compilation
545d1e60 352----------------------------------
4bf78aae 353
f6bcfd97 3541. Build the wxWindows libraries using the Borland make utility as
9d1461a4 355 specified in the section called "Borland C++ 5.0 compilation"
f6bcfd97
BP
356 above. (C++ Builder includes a stand-alone C++ compiler. For example,
357 C++ Builder 4.0 comes with C++ 5.4.)
3f1af920 358
9d1461a4 3592. You can use the process_sample_bcb.bat command which is in
9fce8d2e
JS
360 wxwindows\distrib\msw to generate a .mak or .bpr file for most of the
361 samples [mak for Cbuilder 1-3; bpr for v4]. Execute this in the sample
9d1461a4
CE
362 directory, passing the name of the cpp files on the command line. For more
363 details, see the instructions in docs/tech/tn0004.htm or
364 http://biolpc22.york.ac.uk/wx/bc/ide.html.
365
366Borland 16 Bit compilation for Windows 3.1
367------------------------------------------
4bf78aae 368
9d1461a4
CE
369The last version of wxWindows to support 16-bit compilation with Borland was
3702.2.7 - Please download and read the instructions in that release
545d1e60
VZ
371
372Watcom C++ 10.6/11 and OpenWatcom compilation
373---------------------------------------------
7be1f0d9 374
cba2db0c
JS
3751. Make sure your WXWIN variable is set, and uses the DOS short
376 name form.
545d1e60 3772. Change directory to wx\src\msw. Type 'wmake -f makefile.wat' to
7be1f0d9 378 make the wxWindows core library.
545d1e60 3793. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
ace03f87
JS
380 to make this sample. Repeat for other samples of interest.
381
545d1e60
VZ
382
383There are several makefile variables which may be modified:
384
385- FINAL may be set to 1 (e.g. 'wmake -f makefile.wat FINAL=1') to build
386 the release version of the library, i.e. without debug info and with
387 optimizations enabled
388
389- WATCOM_SUFFIX is appended to the names of all libraries produced by the
390 makefile -- this allows to use several compilers in the same wxWindows
391 source tree. If you only use Watcom compiler, set WATCOM_SUFFIX to nothing.
392
393- OUTPUTDIR may be set to the name of the directory where you want all the
394 object files to be generated (the library files are always created in
395 %WXWIN\lib). You may set it to nothing to create them in the same directory
396 as the sourcse, however using a separate directory is preferable if you use
397 several different compilers. If you change OUTPUTDIR, make sure that it is
398 either empty or has a trailing backslash!
399
400
401Note (1): if your installation of Watcom doesn't have odbc32.lib file and
402 you need it (i.e. you have wxUSE_ODBC=1), you can use the file
403 from lib\watcom directory. See the notes in that directory.
404
405Note (2): if variant.cpp is compiled with date/time class options, the linker
406 gives up. So the date/time option is switched off for Watcom C++.
407 Also, wxAutomationObject is not compiled with Watcom C++ 10.
408
409Note (3): if Watcom can't read the precompiled header when building a sample,
410 try deleting src\msw\watcom.pch and compiling the sample again.
411
7be1f0d9 412
62448488
JS
413Metrowerks CodeWarrior compilation
414----------------------------------
415
545d1e60 4161. CodeWarrior Pro7 project files in XML format are already
42280e48 417 included in wxMSW-2.5.0.zip and the setup version.
545d1e60
VZ
4182. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if
419 you are working from the CVS version) to make sure the settings reflect
420 what you want. If you aren't sure, leave it alone and go with the
ba14d986
VZ
421 default settings. A few notes:
422 - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL
545d1e60 423 - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports
ba14d986
VZ
424 will be rather confusing due to interactions with the MSL ANSI
425 and runtime libs.
545d1e60
VZ
4263. The project file to build the Win32 wxWindows libraries relies on the
427 Batch File Runner plug-in. This plug-in is not installed as part of
428 a normal CW7 installation. However, you can find this plug-in on the
429 CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the
430 "Batch File Post Linker".
4314. If you choose not to install the Batch File Runner plug-in, then you
ba14d986 432 need to do the following by hand:
545d1e60
VZ
433 (1) Create the directories lib\cw7msw\include\wx and copy the file
434 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
ba14d986 435 working from the CVS version) to lib\cw7msw\include\wx\setup.h
545d1e60
VZ
436 (2) Create the directories lib\cw7mswd\include\wx and copy the file
437 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
ba14d986 438 working from the CVS version) to lib\cw7mswd\include\wx\setup.h
73c3b37b 4395. Import src\wxWindowsW7.xml to create the project file wxWindowsW7.mcp.
545d1e60
VZ
440 Store this project file in directory src. You may get warnings about
441 not being able to find certain project paths; ignore these warnings, the
ba14d986 442 appropriate paths will be created during the build by the Batch File Runner.
545d1e60
VZ
4436. Choose the wxlib Win32 debug or wxlib Win32 Release target and build. You
444 will get some warnings about hidden virtual functions, illegal conversions
ba14d986 445 from const pointers to pointers, etc., all of which you can safely ignore.
545d1e60
VZ
446 ***Note: if you get errors that the compiler can't find "wx/setup.h", just
447 stop the build and build again. These errors occur because sometimes the
ba14d986
VZ
448 compiler starts doing its thing before the copying of setup.h has completed.
4497. The following libraries will be produced depending on chosen
450 target:
451 - wx_x86.lib ANSI Release (static)
452 - wx_x86_d.lib ANSI Debug (static)
4538. Sorry, I haven't had time yet to create and test unicode or DLL versions.
545d1e60 454 Volunteers for this are welcome (as neither DLLs nor unicode builds are
ba14d986 455 big priorities for me ;).
545d1e60
VZ
4569. CodeWarrior Pro7 project files (in XML format) are also provided for some
457 of the samples. In particular, there are project files for the minimal,
458 controls, dialogs, dnd, nd docview samples. You can use these project
459 files as templates for the other samples and for your own projects.
460 - For example, to make a project file for the "newgrid" sample,
461 just copy the project file for the "minimal" sample, minimalW7.mcp
462 (made by importing minimalW7.xml into CodeWarrior), into the
463 sample/newgrid directory, calling it newgridW7.mcp. Open
464 newgridW7.mcp and revise the project by deleting the files
465 minimal.rc and minimal.cpp and adding the files griddemo.rc and
73c3b37b 466 griddemo.cpp. Build and run....
62448488 467
545d1e60 468
9a718b86 469Cygwin/MinGW compilation
545d1e60 470------------------------
2bda0e17 471
74afbadc 472wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
9a718b86 473releases, and MinGW. Cygwin can be downloaded from:
6500c0b1 474
9a718b86 475 http://sources.redhat.com/cygwin/
2bda0e17 476
9a718b86 477and MinGW from:
6500c0b1 478
9a718b86 479 http://www.mingw.org/
2bda0e17 480
9a718b86 481Both Cygwin and MinGW can be used with the same makefiles, and both can be
545d1e60
VZ
482used with configure. However the (strongly) preferred way to build wxWindows
483is using configure with Cygwin and using the makefiles with MinGW as these
484configurations are test much more often than the remaining two and so are much
485more likely to work out of the box.
486
4dcd292c 487
9a718b86
MB
488NOTE: some notes specific to old Cygwin (< 1.1.x)
489 and MinGW (< 1.0) are at the end of this section
490 (see OLD VERSIONS)
2bda0e17 491
7666ad49
JS
492There are two methods of compiling wxWindows, by using the
493makefiles provided or by using 'configure'.
2bda0e17 494
9a718b86 495Retrieve and install the latest version of Cygwin, or MinGW, as per
6500c0b1
JS
496the instructions with either of these packages.
497
9a718b86 498If using MinGW, you can download the add-on MSYS package to
6500c0b1 499provide Unix-like tools that you'll need to build wxWindows.
9a718b86 500If you do not want to use MSYS, then you need to download extra utilities from
6500c0b1 501ports/mingw32 on the wxWindows ftp site or CD-ROM:
7666ad49 502
2b5f62a0 503 ftp://biolpc22.york.ac.uk/pub/ports/mingw32/extra.zip
545d1e60
VZ
504
505These should be extracted to a directory in your path. If you have
6500c0b1
JS
506already downloaded rm, cp, mv from elsewhere, or are using
507MSYS, you won't need all of these files. However if using MSYS
508and configure to build wxWindows, you will need to unzip the
509following files from extra.zip and place them in e.g. an
510extrabin directory which you then add to your path:
7666ad49 511
6500c0b1
JS
512 bison.exe bison.hairy bison.simple flex.exe
513
514You will also need to set these variables:
515
516 set BISON_SIMPLE=c:\apps\mingw2.0.0-3\extrabin\bison.simple
517 set BISON_HAIRY=c:\apps\mingw2.0.0-3\extrabin\bison.hairy
518
519Here we're setting them in DOS before invoking 'sh', but you
520could set them within the shell instead.
521
522The 'configure' method uses flex and bison, whereas the
523direct makefile method uses pregenerated C files.
524
525Using makefiles directly
526========================
7666ad49 527
02fd5400
MB
528NOTE: The makefile are for compilation under Cygwin, MSYS, or
529 command.com/cmd.exe, they won't work in other environments
530 (such as UNIX)
531
7666ad49 532Here are the steps required using the provided makefiles:
8870c26e 533
dbda9e86 534- Set your WXWIN variable to where wxWindows is installed.
9a718b86 535 *** IMPORTANT: For Cygwin/MinGW, use forward slashes in the path, not
25889d3c 536 backslashes.
dbda9e86 537
6500c0b1 538- Edit src/makeg95.env and set the MINGW32 variable at the top of
9a718b86
MB
539 the file to either 1 (you have MinGW) or 0 (if you have
540 Cygwin); also set the MINGW32VERSION variable appropriately for your
541 GCC version.
6500c0b1 542
2bda0e17 543- Use the makefile.g95 files for compiling wxWindows and samples,
4dcd292c 544 e.g. to compile a debugging version of wxWindows:
2bda0e17 545 > cd c:\wx\src\msw
02fd5400 546 > make -f makefile.g95 clean
2bda0e17
KB
547 > make -f makefile.g95
548 > cd c:\wx\samples\minimal
02fd5400 549 > make -f makefile.g95 cleanall
2bda0e17
KB
550 > make -f makefile.g95
551
4dcd292c
MB
552 to compile with optimizations:
553 > cd c:\wx\src\msw
02fd5400 554 > make -f makefile.g95 clean
4dcd292c
MB
555 > make -f makefile.g95 FINAL=1
556 > cd c:\wx\samples\minimal
02fd5400 557 > make -f makefile.g95 cleanall
4dcd292c
MB
558 > make -f makefile.g95 FINAL=1
559
560 to compile a DLL:
561 > cd c:\wx\src\msw
02fd5400 562 > make -f makefile.g95 clean
4dcd292c
MB
563 > make -f makefile.g95 WXMAKINGDLL=1
564 > cd c:\wx\samples\minimal
02fd5400 565 > make -f makefile.g95 cleanall
4dcd292c
MB
566 > make -f makefile.g95 WXUSINGDLL=1
567
568 to compile the Unicode version:
569 > cd c:\wx\src\msw
02fd5400 570 > make -f makefile.g95 clean
4dcd292c
MB
571 > make -f makefile.g95 UNICODE=1
572 > cd c:\wx\samples\minimal
02fd5400 573 > make -f makefile.g95 cleanall
4dcd292c
MB
574 > make -f makefile.g95 UNICODE=1
575
9a718b86 576 Options can be combined (e.g.: UNICODE=1 FINAL=1)
4dcd292c 577
cba2db0c
JS
578 Ignore the warning about the default entry point.
579
9a718b86
MB
580- Use the 'strip' command to reduce executable/dll size (note that
581 stripping an executable/dll will remove debug information!).
2bda0e17 582
74afbadc 583- With Cygwin, you can invoke gdb --nw myfile.exe to
4fabb575 584 debug an executable. If there are memory leaks, they will be
4dcd292c
MB
585 flagged when the program quits. You can use Cygwin gdb
586 to debug MinGW executables.
2bda0e17
KB
587
588All targets have 'clean' targets to allow removal of object files
4dcd292c
MB
589and other intermediate compiler files and 'cleanall' targets to
590allow removal of all object files and library files.
2bda0e17 591
7666ad49
JS
592Using configure
593===============
594
595Instead of using the makefiles, you can use the configure
596system to generate appropriate makefiles, as used on Unix
597and Mac OS X systems.
598
599Change directory to the root of the wxWindows distribution,
9a718b86 600make a build directory, and run configure and make in this directory.
7666ad49
JS
601
602For example:
603
604 cd $WXWIN
605 mkdir build-debug
606 cd build-debug
607 ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared
608 make
c5f53eb8 609 make install % This step is optional, see note (8) below.
7666ad49
JS
610 cd samples/minimal
611 make
612 ./minimal.exe
613
7c5dc04f 614Notes:
2bda0e17 615
9a718b86 6161. See also the Cygwin/MinGW on the web site or CD-ROM for
bf4d9b2b 617 further information about using wxWindows with these compilers.
7c5dc04f 618
6b978929 6192. libwx.a is 100 MB or more - but much less if compiled with no
bf4d9b2b 620 debug info (-g0) and level 4 optimization (-O4).
7c5dc04f 621
9a718b86 6223. If you get a link error under MinGW 2.95.2 referring to:
6b978929
JS
623
624 EnumDAdvise__11IDataObjectPP13IEnumSTATDATA@8
625
626 then you need to edit the file objidl.h at line 663 and add
627 a missing PURE keyword:
628
629 STDMETHOD(EnumDAdvise)(THIS_ IEnumSTATDATA**) PURE;
630
9a718b86 6314. There's a bug in MinGW headers for some early distributions.
7c5dc04f 632
bf4d9b2b 633 in include/windows32/defines.h, where it says:
7c5dc04f 634
bf4d9b2b 635 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
7c5dc04f 636
bf4d9b2b 637 it should say:
7c5dc04f 638
bf4d9b2b 639 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
7c5dc04f 640
bf4d9b2b 641 (a missing bracket).
7c5dc04f 642
6b978929 6435. If there's a problem with the copy or remove commands in
bf4d9b2b 644 src/msw/makefile.g95, you may need to change the COPY and
f6bcfd97 645 RM variables in makeg95.env.
51babd09 646
6b978929 6476. If there's a problem executing the windres program, try
bf4d9b2b 648 commenting out RCPREPROCESSOR in makeg95.env.
51babd09 649
9a718b86 6507. OpenGL support should work with MinGW as-is. However,
fac26663
JS
651 if you wish to generate import libraries appropriate either for
652 the MS OpenGL libraries or the SGI OpenGL libraries, go to
653 include/wx/msw/gl and use:
654
655 dlltool -k -d opengl.def -llibopengl.a
656
657 for the SGI DLLs, or
658
659 dlltool -k -d opengl32.def -llibopengl32.a
660
661 and similarly for glu[32].def.
662
c5f53eb8
JS
6638. The 'make install' step is optional, and copies files
664 as follows:
665
666 /usr/local/lib - wxmswXYZd.dll.a and wxmswXYZd.dll
667 /usr/local/include/wx - wxWindows header files
668 /usr/local/bin - wx-config
669
670 You may need to do this if using wx-config with the
671 default root path.
672
4dcd292c
MB
673OLD VERSIONS:
674
9a718b86 675- If using MinGW 2.95 and below with wxWindows 2.1 or above, you
4dcd292c 676 must hand-patch with Mingw32-gcc295.patches (located in the
9a718b86 677 top-level of the wxWindows 2 installation). MinGW 2.95.2
4dcd292c
MB
678 and above contain the fixes already.
679
680- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
681 to set up appropriate variables, if necessary mounting drives.
682 Run it before compiling.
683
684- For Cygwin, make sure there's a \tmp directory on your
685 Windows drive or bison will crash (actually you don't need
686 bison for ordinary wxWindows compilation: a pre-generated .c file is
687 supplied).
688
4dcd292c 689- If using GnuWin32 b18, you will need to copy windres.exe
9a718b86 690 from e.g. the MinGW distribution, to a directory in your path.
4dcd292c 691
545d1e60 692
6500c0b1
JS
693Symantec C++ compilation
694------------------------
695
6961. Make sure your WXWIN variable is set, and uses the FAT (short
697 name) form.
6982. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
6993. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
700 make the wxWindows core library.
7014. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
702 to make this sample.
2bda0e17 703
6500c0b1
JS
704Note: the minimal sample doesn't link properly ('Error: no
705start address').
70632-bit compilation only (partially) supported at present, using SC++ 6.1.
707Some functionality is missing using this compiler (see makefile).
708Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
709Step (2). 16-bit compilation is left as an exercise for the user!
710
545d1e60 711
6500c0b1
JS
712Salford C++ compilation
713-----------------------
714
7151. Make sure your WXWIN variable is set, and uses the FAT (short
716 name) form.
7172. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
718 notes.
7193. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
720 make the wxWindows core library.
7214. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
722 to make this sample.
723
724Unfortunately, Salford C++ seems to have problems with its code generation for
725operations on objects, as seen in wxFrame::OnMenuHighlight
726(minimal sample) or wxWindow::SetValidator (mdi sample). Also the
727the debugging version of the library is 90MB, with samples coming in
728at 40MB :-) However, wxWindows at least makes a good test suite for
729improving the compiler.
2bda0e17 730
545d1e60 731
57c208c5
JS
732TWIN32 and gcc on Linux
733-----------------------
734
735The wxWindows 2 for Windows port may be compiled using
736the TWIN32 emulator package from www.willows.com. However,
737TWIN32 is by no means finished so this should be taken as
738something to think about for the future, rather than
739a tool for writing products with.
740
741Use makefile.twn in much the same way as makefile.g95, as
742described above. Not all sample makefiles are supplied yet.
743
8870c26e
JS
744For some reason, I found I had to copy TWIN32's Windows resource
745compiler (rc) to the current working directory for it to be found.
746
545d1e60 747
8870c26e
JS
748General Notes
749-------------
a0a302dc
JS
750
751- Debugging: under Windows 95, debugging output isn't output in
9c6751aa
JS
752 the same way that it is under NT or Windows 3.1.
753 Please see DebugView (bin/dbgview.exe in the distribution), also
754 available from http://www.sysinternals.com and on the wxWindows CD-ROM
755 under Packages.
62448488 756
e3065973
JS
757- If you are installing wxWindows 2 from CVS, you may find that
758 include/wx/msw/setup.h is missing. This is deliberate, to avoid
759 developers' different setup.h configurations getting confused.
f6bcfd97
BP
760 Please copy setup0.h to setup.h before compiling. Also, read
761 the BuildCVS.txt for other hints.
bf4d9b2b 762