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