2 Installing wxWindows 2.3.3
3 --------------------------
5 This is wxWindows 2.3.3 for Microsoft Windows 9x/ME, Windows NT,
6 Windows 2000 and Windows XP. This is an unstable development release.
8 Please note that the library naming conventions for VC++
9 compilation have changed after 2.3.1. This means that
10 you will need to change your application project files. See the
11 relevant section below for details.
13 IMPORTANT NOTE: If you experience problems installing, please
14 re-read this instructions and other related files (changes.txt,
15 readme.txt, notes on the Web site) carefully before mailing
16 wx-users or the author. Preferably, try to fix the problem first and
17 then send a patch to the author. Please report bugs using the
18 bug report form on the wxWindows web site.
23 A setup program is provided (setup.exe) to automatically copy files to a
24 directory on your hard disk. Do not install into a path that contains spaces.
25 The installation program should set the WXWIN environment variable, which
26 will be activated when your machine is rebooted. The setup
27 program contains the following:
29 - All common, generic and MSW-specific wxWindows source;
31 - documentation in Windows Help format;
32 - makefiles for most Windows compilers, plus BC++ and
34 - JPEG library source;
35 - TIFF library source;
36 - Object Graphics Library;
38 - Dialog Editor binary.
40 Alternatively, you may unarchive the .zip form by hand:
41 wxMSW-x.y.z.zip where x.y.z is the version number.
43 Unarchive the required files plus any optional documentation
44 files into a suitable directory such as c:\wx.
46 Other add-on packages are available from the wxWindows Web site, such as:
48 - mmedia.zip. Audio, CD, video access for Windows and Linux.
49 - ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
50 - tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
51 the same document source.
53 General installation notes
54 --------------------------
56 Alter your WXWIN environment variable to point to this directory.
57 For Cygwin or Mingw32 compilation, make sure WXWIN contains only
60 If installing from the CVS server, copy include/wx/msw/setup0.h to
61 include/wx/msw/setup.h and edit the resulting file to choose
62 the features you would like to compile wxWindows with[out].
67 The following sections explain how to compile wxWindows with each supported
70 Visual C++ 6.0 compilation
71 ---------------------------
73 Using project files (VC++ 6 only):
75 1. Unarchive wxWindows-x.y.z-vc.zip, the VC++ 6 project
76 makefiles (already included in wxMSW-x.y.z.zip and the setup version).
77 2. Open src/wxWindows.dsp, which has configurations for static
78 compilation or DLL compilation, and each of these available in
79 Unicode/ANSI and Debug/Release variations. Normally you'll use
80 a static linking ANSI configuration. Choose the Win32 Debug or
81 Win32 Release configuration for the wxWindows project, and compile.
82 Alternatively, use Batch Build to build more than one
84 The following libraries will be produced depending on chosen
87 wxmsw.lib wxmswd.lib ; ANSI Release/Debug
88 wxmswu.lib wxmswud.lib ; UNICODE Release/Debug
89 wxmsw23x.lib wxmsw23xd.lib ; ANSI DLL Release/Debug
90 wxmsw23xu.lib wxmsw23xud.lib ; UNICODE DLL Release/Debug
92 It will also produce similar variations on jpeg.lib, png.lib,
93 tiff.lib, zlib.lib, and regex.lib.
94 3. Open a sample project file, choose a configuration such as
95 Win32 Debug using Build | Set Active Configuration..., and compile.
96 The project files don't use precompiled headers, to save disk
97 space, but you can switch PCH compiling on for greater speed.
98 NOTE: you may also use samples/samples.dsw to access all
99 sample projects without opening each workspace individually.
100 You can use the Batch Build facility to make several samples
105 1. Make sure your WXWIN variable is set.
106 2. If you do NOT have the TIFF or JPEG source code, please remove
107 the tiff and jpeg targets from the 'all' target in
108 src\msw\makefile.vc. Also ensure the settings in
109 include\wx\msw\setup.h specify not to use JPEG or TIFF.
110 3. Change directory to wx\src\msw. Type:
112 'nmake -f makefile.vc'
114 to make the wxWindows core library with debug information
115 (wx\lib\wxd.lib), then
117 'nmake -f makefile.vc cleanall FINAL=1'
118 'nmake -f makefile.vc FINAL=1'
120 to make the wxWindows core library without debug information.
121 4. Change directory to wx\samples and type 'nmake -f makefile.vc'
122 to make all the samples. You can also make them individually.
126 Use the 'cleanall' target to clean all objects, libraries and
129 To build the release version using makefiles, add FINAL=1 to your
130 nmake invocation, both when building the library and for samples.
131 You MUST use the 'cleanall' target (with FINAL=1 or FINAL=0)
132 before making a different configuration, because otherwise
133 object files used to build the previous configuration may be
134 used accidentally for the current configuration. You might see
135 this manifested in unexpected link errors or warnings. This problem
136 doesn't occur when using project files to build wxWindows.
138 To build Unicode versions of the libraries, add UNICODE=1
139 to the nmake invocation ( default is UNICODE=0 ).
141 Note that the wxWindows core library allows you to have debug
142 and release libraries available simultaneously, by compiling the
143 objects in different subdirectories, whereas samples must be
144 cleaned and re-made to build a different configuration.
146 To build the DLL version using makefiles:
148 1. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll pch'
149 to make both a suitable DLL and import library, and to build a
150 suitable precompiled header file for compiling applications.
151 See the previous section for library names.
152 2. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
153 (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
156 Note (1): if you wish to use templates, please edit
157 include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
158 Without this, the redefinition of 'new' will cause problems in
159 the headers. Alternatively, #undef new before including template headers.
160 You will also need to set wxUSE_IOSTREAMH to 0 if you will be
161 using templates, to avoid the non-template stream files being included
164 Note (2): libraries and applications generated with makefiles and
165 project files are now (hopefully) compatible where static libraries
166 are concerned, but please exercise caution nevertheless and if
167 possible, use one method or the other.
169 Note (3): VC++ 5's optimization code seems to be broken and can
170 cause both compile and run-time problems: this can be seen when
171 deleting an object Dialog Editor, in Release mode with optimizations
172 on. If in doubt, switch off optimisations, although this will result in much
173 larger executables. It seems possible that the library can be created with
174 strong optimization, so long as the application is not strongly
175 optimized. For example, in wxWindows project, set to 'Minimum
176 Size'. In Dialog Editor project, set to 'Customize: Favor Small
177 Code' (and no others). This will then work.
179 Note (4): some crash problems can be due to inconsistent compiler
180 options. If strange/weird/impossible things start to happen please
181 check (dumping IDE project file as makefile and doing text comparison
182 if necessary) that the project settings, especially the list of defined
183 symbols, struct packing, etc. are exactly the same for all items in
184 the project. After this, delete everything (including PCH) and recompile.
186 Note (5): to create your own IDE files, see the technical note on the
187 wxWindows web site or CD-ROM, entitled "Compiling wxWindows
188 applications in the VC++ IDE" (technical note docs/tech/tn0010.htm in the
189 wxWindows distribution). You can also copy .dsp and .dsw
190 files from an existing wxWindows sample and adapt them.
192 Visual C++ 1.5 compilation (16-bit)
193 -----------------------------------
195 NOTE: this has not been tested recently and probably doesn't
198 1. Make sure your WXWIN variable is set, and uses the FAT (short
200 2. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to
201 make the wxWindows core library.
202 3. Change directory to a sample, such as wx\samples\minimal, and
203 type 'nmake -f makefile.dos'.
205 Add FINAL=1 to your makefile invocation to build the release
206 versions of the library and samples.
208 Use the 'clean' target to clean all objects, libraries and
211 Borland C++ 4.5/5.0/5.5 compilation
212 -------------------------------
214 Compiling using the makefiles:
216 0. If downloading from CVS, copy include\wx\msw\setup0.h to
218 1. Make sure your WXWIN variable is set [e.g add
219 set WXWIN=c:\wxwindows
220 to your autoexec.bat file], and that it uses the FAT (short
221 name) form with no spaces.
222 Reboot if needed for the changes to autoexec.bat to take effect.
223 2. Change directory to src\msw. Type 'make -f makefile.b32' to
224 make the wxWindows core library. Ignore the warnings about
225 'XXX' not found in library.
226 3. Change directory to a sample or demo such as samples\minimal, and type
227 'make -f makefile.b32'.
228 4. For release versions, recompile wxWindows and samples using
229 'make -f makefile.b32 clean'
230 'make -f makefile.b32 FINAL=1'
231 for the library and samples.
232 5. To make and use wxWindows as a DLL, type
233 'make -f makefile.b32 clean'
234 'make -f makefile.b32 DLL=1'
235 and then for each sample,
236 'make -f makefile.b32 WXUSINGDLL=1'
237 Please note that the samples have not been exhaustively tested
238 with this configuration.
240 Note (1): In Borland 4.5 and earleir, using bcc.exe you also need to define BCCDIR
241 in the autoexec.bat file; like this:
242 set BCCDIR=c:\progra~1\borland\bcc
243 so that it points to the root directory of
244 your Borland C++ installation, and it uses the FAT (short
245 name) form with no spaces.
248 Note (2): the wxWindows library and (some) samples compile in 16-bit mode
249 using makefile.bcc, but at present the wxWindows resource system is switched
250 off in this mode. See issues.txt for details.
252 Note (3): unfortunately most samples won't link in 16-bit mode,
253 because the automatic data segment exceeds 64K. The minimal
254 sample links and runs, however.
256 Note (4): the wxWindows makefiles assume byte structure alignment. Please
257 make sure that your own project or makefile settings use the
258 same alignment, or you could experience mysterious crashes. To
259 change the alignment, add a suitable option to the $(CFG) target code
260 in src/msw/makefile.b32.
262 Note (5): if you get undefined _SQL... symbols at link time,
263 either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
264 directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
265 recompile wxWindows. The same applies if compiling using the IDE.
267 Note (6): BC++ 4.5 (not 5.0) trips up over jdmerge.c in the JPEG folder;
268 you will therefore need to set wxUSE_LIBJPEG to 0 in setup.h and remove
269 the jpeg target from src\msw\makefile.b32, and remove jpeg from
273 Note (7): If you wish debug messages to be sent to the console in
274 debug mode, edit src\makeb32.env and change /aa to /Tpe in
277 Compiling using the IDE files: [Borland C++ 5.0, not Cbuilder]
279 1. Load src\bc32.ide (Release settings)
280 2. Go to Options|Project... and specify the correct BC++ include and lib path for
282 3. Press F9 to compile the wxWindows library.
283 4. Load samples\bc32.ide.
284 5. Go to Options|Project... and specify the correct BC++ include and lib path for
286 6. Press F9 to compile the samples (build each node separately if
287 you prefer, by right clicking and choose Build Node).
288 7. Run each sample: you may need to run from each sample's directory
289 since some (notably the wxHTML samples) look for files
290 relative to the working directory.
292 Note (1): the samples project file contains a selection of
293 samples, and not all samples. The remaining samples can be made
294 with the makefiles. See also the demos hierarchy which doesn't
295 have any BC++ project files yet.
297 Note (2): to make the png, zlib, jpeg and tiff libraries (needed for
298 some samples) you need to compile them with bc32.ide.
300 Note (3): the debug version of the wxWindows library is about 40 MB, and the
301 release version is around 5 MB.
303 See also the file docs/tech/tn0007.txt for further instructions and details
304 of how to create your own project files.
308 In all of your wxWindows applications, your source code should include
309 the following preprocessor directive:
315 (check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for
318 Borland C++Builder IDE compilation
319 ------------------------------
321 1. Build the wxWindows libraries using the Borland make utility as
322 specified in the section called "Borland C++ 4.5/5.0 compilation"
323 above. (C++ Builder includes a stand-alone C++ compiler. For example,
324 C++ Builder 4.0 comes with C++ 5.4.)
326 2. You can build samples using the makefiles as per the
327 instructions for BC++ above, or you can follow the instructions
328 in docs/tech/tn0004.htm or http://biolpc22.york.ac.uk/wx/bc/ide.html.
329 You can use the process_sample_bcb.bat command which is in
330 wxwindows\distrib\msw to generate a .mak or .bpr file for most of the
331 samples [mak for Cbuilder 1-3; bpr for v4]. Execute this in the sample
332 directory, passing the name of the cpp files on the command line.
334 Watcom C++ 10.6/11 compilation
335 ---------------------------
337 1. Make sure your WXWIN variable is set, and uses the DOS short
339 2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat all' to
340 make the wxWindows core library.
341 3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat all'
342 to make this sample. Repeat for other samples of interest.
344 Note (1): makewat.env uses the odbc32.lib supplied in wxWindows' lib\watcom
345 directory. See the notes in that directory.
346 Note (2): if variant.cpp is compiled with date/time class
347 options, the linker gives up. So the date/time option is switched
348 off for Watcom C++. Also, wxAutomationObject is not compiled with
350 Note (3): if Watcom can't read the precompiled header when
351 building a sample, try deleting src\msw\watcom.pch and
352 compiling the sample again.
354 Metrowerks CodeWarrior compilation
355 ----------------------------------
357 1. CodeWarrior Pro7 project files in XML format are already
358 included in wxMSW-x.y.z.zip and the setup version.
359 2. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if
360 you are working from the CVS version) to make sure the settings reflect
361 what you want. If you aren't sure, leave it alone and go with the
362 default settings. A few notes:
363 - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL
364 - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports
365 will be rather confusing due to interactions with the MSL ANSI
367 3. The project file to build the Win32 wxWindows libraries relies on the
368 Batch File Runner plug-in. This plug-in is not installed as part of
369 a normal CW7 installation. However, you can find this plug-in on the
370 CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the
371 "Batch File Post Linker".
372 4. If you choose not to install the Batch File Runner plug-in, then you
373 need to do the following by hand:
374 (1) Create the directories lib\cw7msw\include\wx and copy the file
375 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
376 working from the CVS version) to lib\cw7msw\include\wx\setup.h
377 (2) Create the directories lib\cw7mswd\include\wx and copy the file
378 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
379 working from the CVS version) to lib\cw7mswd\include\wx\setup.h
380 5. Import srcwxWindows.xml to create the project file wxWindows.mcp.
381 Store this project file in directory src. You may get warnings about
382 not being able to find certain project paths; ignore these warnings, the
383 appropriate paths will be created during the build by the Batch File Runner.
384 6. Choose the wxlib Win32 debug or wxlib Win32 Release target and build. You
385 will get some warnings about hidden virtual functions, illegal conversions
386 from const pointers to pointers, etc., all of which you can safely ignore.
387 ***Note: if you get errors that the compiler can't find "wx/setup.h", just
388 stop the build and build again. These errors occur because sometimes the
389 compiler starts doing its thing before the copying of setup.h has completed.
390 7. The following libraries will be produced depending on chosen
392 - wx_x86.lib ANSI Release (static)
393 - wx_x86_d.lib ANSI Debug (static)
394 8. Sorry, I haven't had time yet to create and test unicode or DLL versions.
395 Volunteers for this are welcome (as neither DLLs nor unicode builds are
396 big priorities for me ;).
397 9. CodeWarrior Pro7 project files (in XML format) are also provided for some
398 of the samples. In particular, for the minimal, controls, dialogs, dnd,
399 and docview samples. You can use these project files as templates for
400 the other samples and for your own projects.
403 Symantec C++ compilation
404 ------------------------
406 1. Make sure your WXWIN variable is set, and uses the FAT (short
408 2. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
409 3. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
410 make the wxWindows core library.
411 4. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
414 Note: the minimal sample doesn't link properly ('Error: no
416 32-bit compilation only (partially) supported at present, using SC++ 6.1.
417 Some functionality is missing using this compiler (see makefile).
418 Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
419 Step (2). 16-bit compilation is left as an exercise for the user!
421 Salford C++ compilation
422 -----------------------
424 1. Make sure your WXWIN variable is set, and uses the FAT (short
426 2. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
428 3. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
429 make the wxWindows core library.
430 4. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
433 Unfortunately, Salford C++ seems to have problems with its code generation for
434 operations on objects, as seen in wxFrame::OnMenuHighlight
435 (minimal sample) or wxWindow::SetValidator (mdi sample). Also the
436 the debugging version of the library is 90MB, with samples coming in
437 at 40MB :-) However, wxWindows at least makes a good test suite for
438 improving the compiler.
440 Cygwin/Mingw32 compilation
441 ----------------------------------
443 wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
444 releases, and Mingw32.
446 Thanks are due to Keith Garry Boyce (garp@opustel.com), Cygnus
447 and others for making it all possible.
449 Both Cygwin and MinGW can be used with the same makefiles.
451 NOTE: some notes specific to old Cygwin ( < 1.1.x )
452 and MinGW ( < 1.0 ) are at the end of this section
455 Here are the steps required:
457 - Retrieve and install the latest version of Cygwin, or Mingw32, as per the
458 instructions with either of these packages.
460 - If using Mingw32, you need some extra files to use the wxWindows
461 makefiles. You can find these files in ports/mingw32 on the
462 wxWindows ftp site or CD-ROM, as extra.zip.
464 ftp://ftp.remstar.com/pub/wxwin/ports/mingw32/extra.zip
466 These should be extracted to the Mingw32 directory. If you have
467 already downloaded rm, cp, mv from elsewhere, you won't need this.
469 - Set your WXWIN variable to where wxWindows is installed.
470 *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
473 - Use the makefile.g95 files for compiling wxWindows and samples,
474 e.g. to compile a debugging version of wxWindows:
476 > make -f makefile.g95
477 > cd c:\wx\samples\minimal
478 > make -f makefile.g95
480 to compile with optimizations:
482 > make -f makefile.g95 FINAL=1
483 > cd c:\wx\samples\minimal
484 > make -f makefile.g95 FINAL=1
488 > make -f makefile.g95 WXMAKINGDLL=1
489 > cd c:\wx\samples\minimal
490 > make -f makefile.g95 WXUSINGDLL=1
492 to compile the Unicode version:
494 > make -f makefile.g95 UNICODE=1
495 > cd c:\wx\samples\minimal
496 > make -f makefile.g95 UNICODE=1
498 Options can be combined ( e.g.: UNICODE=1 FINAL=1 )
500 Ignore the warning about the default entry point.
502 - Use the 'strip' command to reduce executable size.
504 - With Cygwin, you can invoke gdb --nw myfile.exe to
505 debug an executable. If there are memory leaks, they will be
506 flagged when the program quits. You can use Cygwin gdb
507 to debug MinGW executables.
509 All targets have 'clean' targets to allow removal of object files
510 and other intermediate compiler files and 'cleanall' targets to
511 allow removal of all object files and library files.
515 1. See also the Cygwin/Mingw32 on the web site or CD-ROM for
516 further information about using wxWindows with these compilers.
518 2. libwx.a is 48 MB or more - but much less if compiled with no
519 debug info (-g0) and level 4 optimization (-O4).
521 3. There's a bug in Mingw32 headers for some early distributions.
523 in include/windows32/defines.h, where it says:
525 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
529 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
533 4. If there's a problem with the copy or remove commands in
534 src/msw/makefile.g95, you may need to change the COPY and
535 RM variables in makeg95.env.
537 5. If there's a problem executing the windres program, try
538 commenting out RCPREPROCESSOR in makeg95.env.
540 6. OpenGL support should work with Mingw32 as-is. However,
541 if you wish to generate import libraries appropriate either for
542 the MS OpenGL libraries or the SGI OpenGL libraries, go to
543 include/wx/msw/gl and use:
545 dlltool -k -d opengl.def -llibopengl.a
549 dlltool -k -d opengl32.def -llibopengl32.a
551 and similarly for glu[32].def.
555 - If using Mingw32 2.95 and below with wxWindows 2.1 or above, you
556 must hand-patch with Mingw32-gcc295.patches (located in the
557 top-level of the wxWindows 2 installation). Mingw32 2.95.2
558 and above contain the fixes already.
560 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
561 to set up appropriate variables, if necessary mounting drives.
562 Run it before compiling.
564 - For Cygwin, make sure there's a \tmp directory on your
565 Windows drive or bison will crash (actually you don't need
566 bison for ordinary wxWindows compilation: a pre-generated .c file is
569 - Edit wx/src/makeg95.env and set the MINGW32 variable at the top of
570 the file to either 1 (you have Mingw32 or Cygwin 1.x releases) or 0
571 (if you have Cygwin betas). If using Mingw32, also set the
572 MINGW32VERSION variable appropriately.
574 - If using GnuWin32 b18, you will need to copy windres.exe
575 from e.g. the Mingw32 distribution, to a directory in your path.
579 - The Cygwin site is at
580 http://sources.redhat.com/cygwin
581 - Mingw32 is available at:
584 TWIN32 and gcc on Linux
585 -----------------------
587 The wxWindows 2 for Windows port may be compiled using
588 the TWIN32 emulator package from www.willows.com. However,
589 TWIN32 is by no means finished so this should be taken as
590 something to think about for the future, rather than
591 a tool for writing products with.
593 Use makefile.twn in much the same way as makefile.g95, as
594 described above. Not all sample makefiles are supplied yet.
596 For some reason, I found I had to copy TWIN32's Windows resource
597 compiler (rc) to the current working directory for it to be found.
602 - Debugging: under Windows 95, debugging output isn't output in
603 the same way that it is under NT or Windows 3.1.
604 Please see DebugView (bin/dbgview.exe in the distribution), also
605 available from http://www.sysinternals.com and on the wxWindows CD-ROM
608 - If you are installing wxWindows 2 from CVS, you may find that
609 include/wx/msw/setup.h is missing. This is deliberate, to avoid
610 developers' different setup.h configurations getting confused.
611 Please copy setup0.h to setup.h before compiling. Also, read
612 the BuildCVS.txt for other hints.