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