]> git.saurik.com Git - wxWidgets.git/blame - docs/msw/install.txt
More OS/2 update to fix some owner drawn things
[wxWidgets.git] / docs / msw / install.txt
CommitLineData
2bda0e17 1
4e4dc03d
JS
2Installing wxWindows 2.3.3
3--------------------------
0544bc0a 4
4e4dc03d 5This is wxWindows 2.3.3 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
154f22b3 28A setup program is provided (setup.exe) to automatically copy files to a
01dba85a
JS
29directory on your hard disk. Do not install into a path that contains spaces.
30The installation program should set the WXWIN environment variable, which
31will be activated when your machine is rebooted. The setup
32program contains the following:
33
34- All common, generic and MSW-specific wxWindows source;
35- samples;
36- documentation in Windows Help format;
b9f933ab
JS
37- makefiles for most Windows compilers, plus CodeWarrior,
38 BC++ and VC++ IDE files;
01dba85a 39- JPEG library source;
669f7a11 40- TIFF library source;
01dba85a 41- Object Graphics Library;
01dba85a
JS
42- Tex2RTF source;
43- Dialog Editor binary.
44
f6bcfd97
BP
45Alternatively, you may unarchive the .zip form by hand:
46wxMSW-x.y.z.zip where x.y.z is the version number.
2bda0e17
KB
47
48Unarchive the required files plus any optional documentation
dbda9e86 49files into a suitable directory such as c:\wx.
2bda0e17 50
8870c26e
JS
51Other add-on packages are available from the wxWindows Web site, such as:
52
5d525ad9 53- mmedia.zip. Audio, CD, video access for Windows and Linux.
8870c26e
JS
54- ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
55- tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
56 the same document source.
57
dbda9e86
JS
58General installation notes
59--------------------------
60
61Alter your WXWIN environment variable to point to this directory.
62For Cygwin or Mingw32 compilation, make sure WXWIN contains only
63forward slashes.
64
65If installing from the CVS server, copy include/wx/msw/setup0.h to
a40a9c81
JS
66include/wx/msw/setup.h and edit the resulting file to choose
67the features you would like to compile wxWindows with[out].
dbda9e86 68
2bda0e17
KB
69Compilation
70-----------
71
dbda9e86
JS
72The following sections explain how to compile wxWindows with each supported
73compiler.
2bda0e17 74
a40a9c81
JS
75Visual C++ 6.0 compilation
76---------------------------
2bda0e17 77
a40a9c81 78Using project files (VC++ 6 only):
a367b9b3 79
a40a9c81 801. Unarchive wxWindows-x.y.z-vc.zip, the VC++ 6 project
f6bcfd97 81 makefiles (already included in wxMSW-x.y.z.zip and the setup version).
a40a9c81
JS
822. Open src/wxWindows.dsp, which has configurations for static
83 compilation or DLL compilation, and each of these available in
84 Unicode/ANSI and Debug/Release variations. Normally you'll use
85 a static linking ANSI configuration. Choose the Win32 Debug or
86 Win32 Release configuration for the wxWindows project, and compile.
87 Alternatively, use Batch Build to build more than one
88 configuration.
89 The following libraries will be produced depending on chosen
90 configuration:
91
92 wxmsw.lib wxmswd.lib ; ANSI Release/Debug
93 wxmswu.lib wxmswud.lib ; UNICODE Release/Debug
94 wxmsw23x.lib wxmsw23xd.lib ; ANSI DLL Release/Debug
95 wxmsw23xu.lib wxmsw23xud.lib ; UNICODE DLL Release/Debug
96
97 It will also produce similar variations on jpeg.lib, png.lib,
98 tiff.lib, zlib.lib, and regex.lib.
5fa399c9 993. Open a sample project file, choose a configuration such as
a40a9c81 100 Win32 Debug using Build | Set Active Configuration..., and compile.
5fa399c9 101 The project files don't use precompiled headers, to save disk
16553659 102 space, but you can switch PCH compiling on for greater speed.
a40a9c81 103 NOTE: you may also use samples/samples.dsw to access all
669f7a11
JS
104 sample projects without opening each workspace individually.
105 You can use the Batch Build facility to make several samples
106 at a time.
a367b9b3
JS
107
108Using makefiles:
109
62448488 1101. Make sure your WXWIN variable is set.
d1e418ea
JS
1112. If you do NOT have the TIFF or JPEG source code, please remove
112 the tiff and jpeg targets from the 'all' target in
113 src\msw\makefile.vc. Also ensure the settings in
114 include\wx\msw\setup.h specify not to use JPEG or TIFF.
1153. Change directory to wx\src\msw. Type:
ca5c8b2d
JS
116
117 'nmake -f makefile.vc'
118
119 to make the wxWindows core library with debug information
7fee680b 120 (wx\lib\wxd.lib), then
ca5c8b2d 121
7fee680b 122 'nmake -f makefile.vc cleanall FINAL=1'
ca5c8b2d
JS
123 'nmake -f makefile.vc FINAL=1'
124
a40a9c81 125 to make the wxWindows core library without debug information.
85f3749f 1264. Change directory to wx\samples and type 'nmake -f makefile.vc'
2bda0e17
KB
127 to make all the samples. You can also make them individually.
128
5fa399c9 129Makefile notes:
e2a6f233 130
7fee680b 131 Use the 'cleanall' target to clean all objects, libraries and
ca5c8b2d
JS
132 executables.
133
134 To build the release version using makefiles, add FINAL=1 to your
135 nmake invocation, both when building the library and for samples.
7fee680b
JS
136 You MUST use the 'cleanall' target (with FINAL=1 or FINAL=0)
137 before making a different configuration, because otherwise
138 object files used to build the previous configuration may be
2edb0bde 139 used accidentally for the current configuration. You might see
7fee680b
JS
140 this manifested in unexpected link errors or warnings. This problem
141 doesn't occur when using project files to build wxWindows.
ca5c8b2d 142
4dcd292c 143 To build Unicode versions of the libraries, add UNICODE=1
26a00631
VS
144 to the nmake invocation ( default is UNICODE=0 ). If you want to
145 be able to use Unicode version on Windows9x, you will need
146 MSLU (Microsoft Layer for Unicode) runtime DLL and import lib.
147 The former can be downloaded from Microsoft, the latter is part
148 of the latest Platform SDK from Microsoft (see msdn.microsoft.com
149 for details). An alternative implementation of import library can
150 be downloaded from http://libunicows.sourceforge.net - unlike the
151 official one, this one works with other compilers and does not
152 require 300+ MB Platform SDK update. Add MSLU=1 to the nmake
153 invocation to enable MSLU.
4dcd292c 154
ca5c8b2d
JS
155 Note that the wxWindows core library allows you to have debug
156 and release libraries available simultaneously, by compiling the
157 objects in different subdirectories, whereas samples must be
7fee680b 158 cleaned and re-made to build a different configuration.
e2a6f233
JS
159
160To build the DLL version using makefiles:
161
1621. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll pch'
163 to make both a suitable DLL and import library, and to build a
164 suitable precompiled header file for compiling applications.
a40a9c81 165 See the previous section for library names.
ca5c8b2d
JS
1662. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
167 (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
168 applications).
e2a6f233 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
176within wxWindows.
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
750b78ba 183Note (3): VC++ 5's optimization code seems to be broken and can
ad556aa9
JS
184cause both compile and run-time problems: this can be seen when
185deleting an object Dialog Editor, in Release mode with optimizations
186on. If in doubt, switch off optimisations, although this will result in much
750b78ba
JS
187larger executables. It seems possible that the library can be created with
188strong optimization, so long as the application is not strongly
189optimized. For example, in wxWindows project, set to 'Minimum
190Size'. In Dialog Editor project, set to 'Customize: Favor Small
191Code' (and no others). This will then work.
192
ad813b00
JS
193Note (4): some crash problems can be due to inconsistent compiler
194options. If strange/weird/impossible things start to happen please
195check (dumping IDE project file as makefile and doing text comparison
196if necessary) that the project settings, especially the list of defined
197symbols, struct packing, etc. are exactly the same for all items in
198the project. After this, delete everything (including PCH) and recompile.
199
a40a9c81 200Note (5): to create your own IDE files, see the technical note on the
9c6751aa 201wxWindows web site or CD-ROM, entitled "Compiling wxWindows
f6bcfd97
BP
202applications in the VC++ IDE" (technical note docs/tech/tn0010.htm in the
203wxWindows distribution). You can also copy .dsp and .dsw
9c6751aa
JS
204files from an existing wxWindows sample and adapt them.
205
8fb3a512
JS
206Visual C++ 1.5 compilation (16-bit)
207-----------------------------------
2bda0e17 208
a40a9c81
JS
209NOTE: this has not been tested recently and probably doesn't
210work.
211
62448488
JS
2121. Make sure your WXWIN variable is set, and uses the FAT (short
213 name) form.
2142. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to
2bda0e17 215 make the wxWindows core library.
62448488 2163. Change directory to a sample, such as wx\samples\minimal, and
f60d0f94 217 type 'nmake -f makefile.dos'.
2bda0e17 218
e2a6f233
JS
219Add FINAL=1 to your makefile invocation to build the release
220versions of the library and samples.
221
222Use the 'clean' target to clean all objects, libraries and
223executables.
224
9fce8d2e 225Borland C++ 4.5/5.0/5.5 compilation
2bda0e17
KB
226-------------------------------
227
ca5c8b2d
JS
228Compiling using the makefiles:
229
a40a9c81
JS
2300. If downloading from CVS, copy include\wx\msw\setup0.h to
231 include\wx\setup.h.
9fce8d2e
JS
2321. Make sure your WXWIN variable is set [e.g add
233 set WXWIN=c:\wxwindows
234 to your autoexec.bat file], and that it uses the FAT (short
235 name) form with no spaces.
9fce8d2e 236 Reboot if needed for the changes to autoexec.bat to take effect.
19e9b919 2372. Change directory to src\msw. Type 'make -f makefile.b32' to
62448488
JS
238 make the wxWindows core library. Ignore the warnings about
239 'XXX' not found in library.
c0bcc480 2403. Change directory to a sample or demo such as samples\minimal, and type
62448488 241 'make -f makefile.b32'.
4bf78aae
JS
2424. For release versions, recompile wxWindows and samples using
243 'make -f makefile.b32 clean'
244 'make -f makefile.b32 FINAL=1'
245 for the library and samples.
f6bcfd97
BP
2465. To make and use wxWindows as a DLL, type
247 'make -f makefile.b32 clean'
248 'make -f makefile.b32 DLL=1'
249 and then for each sample,
250 'make -f makefile.b32 WXUSINGDLL=1'
251 Please note that the samples have not been exhaustively tested
252 with this configuration.
62448488 253
6b6fc9b0
VZ
254Note (1): In Borland 4.5 and earleir, using bcc.exe you also need to define BCCDIR
255in the autoexec.bat file; like this:
256 set BCCDIR=c:\progra~1\borland\bcc
257 so that it points to the root directory of
258 your Borland C++ installation, and it uses the FAT (short
259 name) form with no spaces.
260
261
262Note (2): the wxWindows library and (some) samples compile in 16-bit mode
3b1de9c2
JS
263using makefile.bcc, but at present the wxWindows resource system is switched
264off in this mode. See issues.txt for details.
2bda0e17 265
6b6fc9b0 266Note (3): unfortunately most samples won't link in 16-bit mode,
8fb3a512
JS
267because the automatic data segment exceeds 64K. The minimal
268sample links and runs, however.
269
6b6fc9b0 270Note (4): the wxWindows makefiles assume byte structure alignment. Please
1a7f3062
JS
271make sure that your own project or makefile settings use the
272same alignment, or you could experience mysterious crashes. To
273change the alignment, add a suitable option to the $(CFG) target code
274in src/msw/makefile.b32.
275
6b6fc9b0 276Note (5): if you get undefined _SQL... symbols at link time,
154f22b3
JS
277either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
278directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
279recompile wxWindows. The same applies if compiling using the IDE.
280
6b6fc9b0 281Note (6): BC++ 4.5 (not 5.0) trips up over jdmerge.c in the JPEG folder;
790ad94f 282you will therefore need to set wxUSE_LIBJPEG to 0 in setup.h and remove
b2cf617c
JS
283the jpeg target from src\msw\makefile.b32, and remove jpeg from
284src\makeprog.b32.
790ad94f 285
c3b177ae 286
7fee680b
JS
287Note (7): If you wish debug messages to be sent to the console in
288debug mode, edit src\makeb32.env and change /aa to /Tpe in
289LINK_FLAGS.
290
9fce8d2e 291Compiling using the IDE files: [Borland C++ 5.0, not Cbuilder]
ca5c8b2d 292
01dba85a 2931. Load src\bc32.ide (Release settings)
ca5c8b2d
JS
2942. Go to Options|Project... and specify the correct BC++ include and lib path for
295 your file structure.
2963. Press F9 to compile the wxWindows library.
33b64e6f 2974. Load samples\bc32.ide.
ca5c8b2d
JS
2985. Go to Options|Project... and specify the correct BC++ include and lib path for
299 your file structure.
01dba85a
JS
3006. Press F9 to compile the samples (build each node separately if
301 you prefer, by right clicking and choose Build Node).
3027. Run each sample: you may need to run from each sample's directory
303 since some (notably the wxHTML samples) look for files
304 relative to the working directory.
ca5c8b2d 305
c0bcc480
JS
306Note (1): the samples project file contains a selection of
307samples, and not all samples. The remaining samples can be made
308with the makefiles. See also the demos hierarchy which doesn't
309have any BC++ project files yet.
310
fb1bd1bd 311Note (2): to make the png, zlib, jpeg and tiff libraries (needed for
01dba85a 312some samples) you need to compile them with bc32.ide.
33b64e6f 313
c0bcc480
JS
314Note (3): the debug version of the wxWindows library is about 40 MB, and the
315release version is around 5 MB.
33b64e6f 316
f6bcfd97 317See also the file docs/tech/tn0007.txt for further instructions and details
ca5c8b2d
JS
318of how to create your own project files.
319
f6bcfd97
BP
320** REMEMBER **
321
322In all of your wxWindows applications, your source code should include
323the following preprocessor directive:
324
325#ifdef __BORLANDC__
326#pragma hdrstop
327#endif
328
329(check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for
330more details)
331
9fce8d2e 332Borland C++Builder IDE compilation
4bf78aae
JS
333------------------------------
334
f6bcfd97
BP
3351. Build the wxWindows libraries using the Borland make utility as
336 specified in the section called "Borland C++ 4.5/5.0 compilation"
337 above. (C++ Builder includes a stand-alone C++ compiler. For example,
338 C++ Builder 4.0 comes with C++ 5.4.)
3f1af920 339
f6bcfd97
BP
3402. You can build samples using the makefiles as per the
341 instructions for BC++ above, or you can follow the instructions
342 in docs/tech/tn0004.htm or http://biolpc22.york.ac.uk/wx/bc/ide.html.
9fce8d2e
JS
343 You can use the process_sample_bcb.bat command which is in
344 wxwindows\distrib\msw to generate a .mak or .bpr file for most of the
345 samples [mak for Cbuilder 1-3; bpr for v4]. Execute this in the sample
346 directory, passing the name of the cpp files on the command line.
4bf78aae 347
ace03f87 348Watcom C++ 10.6/11 compilation
7be1f0d9
JS
349---------------------------
350
cba2db0c
JS
3511. Make sure your WXWIN variable is set, and uses the DOS short
352 name form.
3602a62e 3532. Change directory to wx\src\msw. Type 'wmake -f makefile.wat all' to
7be1f0d9 354 make the wxWindows core library.
3602a62e 3553. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat all'
ace03f87
JS
356 to make this sample. Repeat for other samples of interest.
357
f6bcfd97 358Note (1): makewat.env uses the odbc32.lib supplied in wxWindows' lib\watcom
ace03f87 359directory. See the notes in that directory.
f6bcfd97 360Note (2): if variant.cpp is compiled with date/time class
457e6c54
JS
361options, the linker gives up. So the date/time option is switched
362off for Watcom C++. Also, wxAutomationObject is not compiled with
363Watcom C++.
f6bcfd97 364Note (3): if Watcom can't read the precompiled header when
457e6c54
JS
365building a sample, try deleting src\msw\watcom.pch and
366compiling the sample again.
7be1f0d9 367
62448488
JS
368Metrowerks CodeWarrior compilation
369----------------------------------
370
ba14d986 3711. CodeWarrior Pro7 project files in XML format are already
73c3b37b 372 included in wxMSW-2.3.3.zip and the setup version.
ba14d986
VZ
3732. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if
374 you are working from the CVS version) to make sure the settings reflect
375 what you want. If you aren't sure, leave it alone and go with the
376 default settings. A few notes:
377 - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL
378 - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports
379 will be rather confusing due to interactions with the MSL ANSI
380 and runtime libs.
3813. The project file to build the Win32 wxWindows libraries relies on the
382 Batch File Runner plug-in. This plug-in is not installed as part of
383 a normal CW7 installation. However, you can find this plug-in on the
384 CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the
385 "Batch File Post Linker".
3864. If you choose not to install the Batch File Runner plug-in, then you
387 need to do the following by hand:
388 (1) Create the directories lib\cw7msw\include\wx and copy the file
389 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
390 working from the CVS version) to lib\cw7msw\include\wx\setup.h
391 (2) Create the directories lib\cw7mswd\include\wx and copy the file
392 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
393 working from the CVS version) to lib\cw7mswd\include\wx\setup.h
73c3b37b 3945. Import src\wxWindowsW7.xml to create the project file wxWindowsW7.mcp.
ba14d986
VZ
395 Store this project file in directory src. You may get warnings about
396 not being able to find certain project paths; ignore these warnings, the
397 appropriate paths will be created during the build by the Batch File Runner.
3986. Choose the wxlib Win32 debug or wxlib Win32 Release target and build. You
399 will get some warnings about hidden virtual functions, illegal conversions
400 from const pointers to pointers, etc., all of which you can safely ignore.
401 ***Note: if you get errors that the compiler can't find "wx/setup.h", just
402 stop the build and build again. These errors occur because sometimes the
403 compiler starts doing its thing before the copying of setup.h has completed.
4047. The following libraries will be produced depending on chosen
405 target:
406 - wx_x86.lib ANSI Release (static)
407 - wx_x86_d.lib ANSI Debug (static)
4088. Sorry, I haven't had time yet to create and test unicode or DLL versions.
409 Volunteers for this are welcome (as neither DLLs nor unicode builds are
410 big priorities for me ;).
4119. CodeWarrior Pro7 project files (in XML format) are also provided for some
73c3b37b
JS
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.
415 - For example, to make a project file for the "newgrid" sample,
416 just copy the project file for the "minimal" sample, minimalW7.mcp
417 (made by importing minimalW7.xml into CodeWarrior), into the
418 sample/newgrid directory, calling it newgridW7.mcp. Open
419 newgridW7.mcp and revise the project by deleting the files
420 minimal.rc and minimal.cpp and adding the files griddemo.rc and
421 griddemo.cpp. Build and run....
62448488 422
8fb3a512 423
3f1af920
JS
424Symantec C++ compilation
425------------------------
426
4271. Make sure your WXWIN variable is set, and uses the FAT (short
428 name) form.
4292. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
4303. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
431 make the wxWindows core library.
4324. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
433 to make this sample.
434
435Note: the minimal sample doesn't link properly ('Error: no
436start address').
43732-bit compilation only (partially) supported at present, using SC++ 6.1.
438Some functionality is missing using this compiler (see makefile).
439Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
2edb0bde 440Step (2). 16-bit compilation is left as an exercise for the user!
3f1af920 441
ce3ed50d
JS
442Salford C++ compilation
443-----------------------
444
4451. Make sure your WXWIN variable is set, and uses the FAT (short
446 name) form.
4472. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
448 notes.
4493. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
450 make the wxWindows core library.
4514. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
452 to make this sample.
453
454Unfortunately, Salford C++ seems to have problems with its code generation for
455operations on objects, as seen in wxFrame::OnMenuHighlight
456(minimal sample) or wxWindow::SetValidator (mdi sample). Also the
457the debugging version of the library is 90MB, with samples coming in
458at 40MB :-) However, wxWindows at least makes a good test suite for
459improving the compiler.
460
74afbadc 461Cygwin/Mingw32 compilation
8870c26e 462----------------------------------
2bda0e17 463
74afbadc
JS
464wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
465releases, and Mingw32.
2bda0e17 466
74afbadc
JS
467Thanks are due to Keith Garry Boyce (garp@opustel.com), Cygnus
468and others for making it all possible.
2bda0e17 469
4dcd292c
MB
470Both Cygwin and MinGW can be used with the same makefiles.
471
472NOTE: some notes specific to old Cygwin ( < 1.1.x )
473 and MinGW ( < 1.0 ) are at the end of this section
474 ( see OLD VERSIONS )
2bda0e17 475
2bda0e17 476
7666ad49
JS
477There are two methods of compiling wxWindows, by using the
478makefiles provided or by using 'configure'.
2bda0e17 479
7666ad49
JS
480Retrieve and install the latest version of Cygwin, or Mingw32, as per the
481instructions with either of these packages.
eb165274 482
7666ad49
JS
483If using Mingw32, you need some extra files to use the wxWindows
484makefiles. You can find these files in ports/mingw32 on the
485wxWindows ftp site or CD-ROM, as extra.zip.
486
487 ftp://biolp22.york.ac.uk/pub/ports/mingw32/extra.zip
eb165274 488
7666ad49
JS
489These should be extracted to the Mingw32 directory. If you have
490already downloaded rm, cp, mv from elsewhere, you won't need this.
491
492Using makefiles
493===============
494
02fd5400
MB
495NOTE: The makefile are for compilation under Cygwin, MSYS, or
496 command.com/cmd.exe, they won't work in other environments
497 (such as UNIX)
498
7666ad49 499Here are the steps required using the provided makefiles:
8870c26e 500
dbda9e86 501- Set your WXWIN variable to where wxWindows is installed.
25889d3c
JS
502 *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
503 backslashes.
dbda9e86 504
ac240778
JS
505- Check src/makeg95.env to see that MINGW32VERSION is set to correctly
506 reflect the version of gcc that you have. Edit it as needed.
507
2bda0e17 508- Use the makefile.g95 files for compiling wxWindows and samples,
4dcd292c 509 e.g. to compile a debugging version of wxWindows:
2bda0e17 510 > cd c:\wx\src\msw
02fd5400 511 > make -f makefile.g95 clean
2bda0e17
KB
512 > make -f makefile.g95
513 > cd c:\wx\samples\minimal
02fd5400 514 > make -f makefile.g95 cleanall
2bda0e17
KB
515 > make -f makefile.g95
516
4dcd292c
MB
517 to compile with optimizations:
518 > cd c:\wx\src\msw
02fd5400 519 > make -f makefile.g95 clean
4dcd292c
MB
520 > make -f makefile.g95 FINAL=1
521 > cd c:\wx\samples\minimal
02fd5400 522 > make -f makefile.g95 cleanall
4dcd292c
MB
523 > make -f makefile.g95 FINAL=1
524
525 to compile a DLL:
526 > cd c:\wx\src\msw
02fd5400 527 > make -f makefile.g95 clean
4dcd292c
MB
528 > make -f makefile.g95 WXMAKINGDLL=1
529 > cd c:\wx\samples\minimal
02fd5400 530 > make -f makefile.g95 cleanall
4dcd292c
MB
531 > make -f makefile.g95 WXUSINGDLL=1
532
533 to compile the Unicode version:
534 > cd c:\wx\src\msw
02fd5400 535 > make -f makefile.g95 clean
4dcd292c
MB
536 > make -f makefile.g95 UNICODE=1
537 > cd c:\wx\samples\minimal
02fd5400 538 > make -f makefile.g95 cleanall
4dcd292c
MB
539 > make -f makefile.g95 UNICODE=1
540
541 Options can be combined ( e.g.: UNICODE=1 FINAL=1 )
542
cba2db0c
JS
543 Ignore the warning about the default entry point.
544
2bda0e17
KB
545- Use the 'strip' command to reduce executable size.
546
74afbadc 547- With Cygwin, you can invoke gdb --nw myfile.exe to
4fabb575 548 debug an executable. If there are memory leaks, they will be
4dcd292c
MB
549 flagged when the program quits. You can use Cygwin gdb
550 to debug MinGW executables.
2bda0e17
KB
551
552All targets have 'clean' targets to allow removal of object files
4dcd292c
MB
553and other intermediate compiler files and 'cleanall' targets to
554allow removal of all object files and library files.
2bda0e17 555
7666ad49
JS
556Using configure
557===============
558
559Instead of using the makefiles, you can use the configure
560system to generate appropriate makefiles, as used on Unix
561and Mac OS X systems.
562
563Change directory to the root of the wxWindows distribution,
564make a build directory, and then run configure and make.
565
566For example:
567
568 cd $WXWIN
569 mkdir build-debug
570 cd build-debug
571 ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared
572 make
573 cd samples/minimal
574 make
575 ./minimal.exe
576
577
7c5dc04f 578Notes:
2bda0e17 579
bf4d9b2b
JS
5801. See also the Cygwin/Mingw32 on the web site or CD-ROM for
581 further information about using wxWindows with these compilers.
7c5dc04f 582
bf4d9b2b
JS
5832. libwx.a is 48 MB or more - but much less if compiled with no
584 debug info (-g0) and level 4 optimization (-O4).
7c5dc04f 585
bf4d9b2b 5863. There's a bug in Mingw32 headers for some early distributions.
7c5dc04f 587
bf4d9b2b 588 in include/windows32/defines.h, where it says:
7c5dc04f 589
bf4d9b2b 590 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
7c5dc04f 591
bf4d9b2b 592 it should say:
7c5dc04f 593
bf4d9b2b 594 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
7c5dc04f 595
bf4d9b2b 596 (a missing bracket).
7c5dc04f 597
f6bcfd97 5984. If there's a problem with the copy or remove commands in
bf4d9b2b 599 src/msw/makefile.g95, you may need to change the COPY and
f6bcfd97 600 RM variables in makeg95.env.
51babd09 601
bf4d9b2b
JS
6025. If there's a problem executing the windres program, try
603 commenting out RCPREPROCESSOR in makeg95.env.
51babd09 604
fac26663
JS
6056. OpenGL support should work with Mingw32 as-is. However,
606 if you wish to generate import libraries appropriate either for
607 the MS OpenGL libraries or the SGI OpenGL libraries, go to
608 include/wx/msw/gl and use:
609
610 dlltool -k -d opengl.def -llibopengl.a
611
612 for the SGI DLLs, or
613
614 dlltool -k -d opengl32.def -llibopengl32.a
615
616 and similarly for glu[32].def.
617
4dcd292c
MB
618OLD VERSIONS:
619
620- If using Mingw32 2.95 and below with wxWindows 2.1 or above, you
621 must hand-patch with Mingw32-gcc295.patches (located in the
622 top-level of the wxWindows 2 installation). Mingw32 2.95.2
623 and above contain the fixes already.
624
625- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
626 to set up appropriate variables, if necessary mounting drives.
627 Run it before compiling.
628
629- For Cygwin, make sure there's a \tmp directory on your
630 Windows drive or bison will crash (actually you don't need
631 bison for ordinary wxWindows compilation: a pre-generated .c file is
632 supplied).
633
634- Edit wx/src/makeg95.env and set the MINGW32 variable at the top of
635 the file to either 1 (you have Mingw32 or Cygwin 1.x releases) or 0
636 (if you have Cygwin betas). If using Mingw32, also set the
637 MINGW32VERSION variable appropriately.
638
639- If using GnuWin32 b18, you will need to copy windres.exe
640 from e.g. the Mingw32 distribution, to a directory in your path.
641
2bda0e17
KB
642References:
643
74afbadc 644 - The Cygwin site is at
4dcd292c 645 http://sources.redhat.com/cygwin
2bda0e17 646 - Mingw32 is available at:
74afbadc 647 ftp://www.mingw.org
2bda0e17 648
57c208c5
JS
649TWIN32 and gcc on Linux
650-----------------------
651
652The wxWindows 2 for Windows port may be compiled using
653the TWIN32 emulator package from www.willows.com. However,
654TWIN32 is by no means finished so this should be taken as
655something to think about for the future, rather than
656a tool for writing products with.
657
658Use makefile.twn in much the same way as makefile.g95, as
659described above. Not all sample makefiles are supplied yet.
660
8870c26e
JS
661For some reason, I found I had to copy TWIN32's Windows resource
662compiler (rc) to the current working directory for it to be found.
663
664General Notes
665-------------
a0a302dc
JS
666
667- Debugging: under Windows 95, debugging output isn't output in
9c6751aa
JS
668 the same way that it is under NT or Windows 3.1.
669 Please see DebugView (bin/dbgview.exe in the distribution), also
670 available from http://www.sysinternals.com and on the wxWindows CD-ROM
671 under Packages.
62448488 672
e3065973
JS
673- If you are installing wxWindows 2 from CVS, you may find that
674 include/wx/msw/setup.h is missing. This is deliberate, to avoid
675 developers' different setup.h configurations getting confused.
f6bcfd97
BP
676 Please copy setup0.h to setup.h before compiling. Also, read
677 the BuildCVS.txt for other hints.
bf4d9b2b 678