2 Installing wxWindows 2.1
3 ------------------------
5 This is a beta release of wxWindows 2.1 for Microsoft
6 Windows 95, 98 and NT. This is not a production release,
7 although a huge number of bugs found in wxWindows 2.0 have been
10 IMPORTANT NOTE: If you experience problems installing, please
11 re-read this instructions and other related files (release.txt,
12 todo.txt, bugs.txt etc.) carefully before mailing wxwin-users or
13 the author. Preferably, try to fix the problem first and
14 then send a patch to the author. Please report bugs using the
15 bug report form on the wxWindows web site.
20 A setup program is provided (setup.exe) to automatically copy files to a
21 directory on your hard disk. Do not install into a path that contains spaces.
22 The installation program should set the WXWIN environment variable, which
23 will be activated when your machine is rebooted. The setup
24 program contains the following:
26 - All common, generic and MSW-specific wxWindows source;
28 - documentation in Windows Help format;
29 - makefiles for most Windows compilers, plus BC++ and
31 - JPEG library source;
32 - Object Graphics Library;
34 - wxTreeLayout library;
36 - Dialog Editor binary.
38 Alternatively, you may unarchive the set of .zip files by hand,
39 where x is the minor version number and y is the release number:
41 wx2_x_y_gen.zip Generic source code and samples (required)
42 wx2_x_y_msw.zip Windows-specific source code and samples (required)
43 wx2_x_y_doc.zip Documentation source code (not required)
44 wx2_x_y_hlp.zip WinHelp documentation
45 wx2_x_y_pdf.zip Acrobat PDF documentation
46 wx2_x_y_htm.zip HTML documentation
47 wx2_x_y_vc.zip MS VC++ 5.0 project files
48 wx2_x_y_cw.zip Metrowerks CodeWarrior project files
49 wx2_x_y_bc.zip BC++ 5 project files
50 jpeg.zip Use this to allow wxImage to read and write JPEG files
51 tiff.zip Use this to allow wxImage to read and write TIFF files
53 Unarchive the required files plus any optional documentation
54 files into a suitable directory such as c:\wx.
56 Other add-on packages are available from the wxWindows Web site, such as:
58 - glcanvas.zip. Use OpenGL in a wxWindows window.
59 - ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
60 - tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
61 the same document source.
63 General installation notes
64 --------------------------
66 Alter your WXWIN environment variable to point to this directory.
67 For Cygwin or Mingw32 compilation, make sure WXWIN contains only
70 If installing from the CVS server, copy include/wx/msw/setup0.h to
71 include/wx/msw/setup.h and edit the resulting file to choose the featrues you
72 would like to compile wxWindows with[out].
77 The following sections explain how to compile wxWindows with each supported
80 Visual C++ 4.0/5.0/6.0 compilation
81 ----------------------------------
85 1. Unarchive wx2_x_y_vc.zip, the VC++ 5/6 project makefiles.
86 2. Open src/wxvc.dsp, set Debug or Release configuration, and
87 compile. This will produce src/Debug/wxvc.lib or
88 src/Release/wxvc.lib. The project file src/wxvc_dll.dsp
89 will make a DLL version of wxWindow, which will go in
90 src/DebugDLL/wxvc.[lib,dll] and src/ReleaseDLL/wxvc.[lib,dll].
91 3. If you want to use JPEG in your application (such as the image
92 sample), open src/jpeg/jpeg.dsp (VC++ 5/6 only) and compile in
93 Debug and Release configurations. If you have VC++ 4,
94 use makefile.vc, but you may only have one set of object
95 files at a time in use (debug or release versions).
96 4. Open a sample project file, choose a configuration using
97 Build | Set Active Configuration..., and compile.
98 The project files don't use precompiled headers, to save
99 space, but you can switch PCH compiling on for greater speed.
103 1. Make sure your WXWIN variable is set.
104 2. If you do NOT have the TIFF or JPEG source code, please remove
105 the tiff and jpeg targets from the 'all' target in
106 src\msw\makefile.vc. Also ensure the settings in
107 include\wx\msw\setup.h specify not to use JPEG or TIFF.
108 3. Change directory to wx\src\msw. Type:
110 'nmake -f makefile.vc'
112 to make the wxWindows core library with debug information
113 (wx\lib\wx_d.lib), or
115 'nmake -f makefile.vc FINAL=1'
117 to make the wxWindows core library without debug information
119 4. Change directory to wx\samples and type 'nmake -f makefile.vc'
120 to make all the samples. You can also make them individually.
124 Use the 'clean' target to clean all objects, libraries and
127 To build the release version using makefiles, add FINAL=1 to your
128 nmake invocation, both when building the library and for samples.
130 Note that the wxWindows core library allows you to have debug
131 and release libraries available simultaneously, by compiling the
132 objects in different subdirectories, whereas samples must be
133 cleaned and re-made to build a different configuration. This
134 may be changed in later versions of wxWindows.
136 To build the DLL version using makefiles:
138 1. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll pch'
139 to make both a suitable DLL and import library, and to build a
140 suitable precompiled header file for compiling applications.
141 The resulting libraries are called:
143 wx\lib\wx200.lib(dll) (debug version)
144 wx\lib\wx200.lib(dll) (release version, using FINAL=1)
146 2. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
147 (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
150 Note (1): if you wish to use templates, please edit
151 include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
152 Without this, the redefinition of 'new' will cause problems in
153 the headers. Alternatively, #undef new before including template headers.
154 You will also need to set wxUSE_IOSTREAMH to 0 if you will be
155 using templates, to avoid the non-template stream files being included
158 Note (2): libraries and applications generated with makefiles and
159 project files are unlikely to be compatible, so use one method or
162 Note (3): VC++ 5's optimization code seems to be broken and can
163 cause both compile and run-time problems: this can be seen when
164 deleting an object Dialog Editor, in Release mode with optimizations
165 on. If in doubt, switch off optimisations, although this will result in much
166 larger executables. It seems possible that the library can be created with
167 strong optimization, so long as the application is not strongly
168 optimized. For example, in wxWindows project, set to 'Minimum
169 Size'. In Dialog Editor project, set to 'Customize: Favor Small
170 Code' (and no others). This will then work.
172 Similarly, in VC++ 4, optimization can cause internal compiler
173 errors, so edit src\makevc.env and change /O1 to /Od before
174 trying build a release version of the library.
176 Note (4): some crash problems can be due to inconsistent compiler
177 options. If strange/weird/impossible things start to happen please
178 check (dumping IDE project file as makefile and doing text comparison
179 if necessary) that the project settings, especially the list of defined
180 symbols, struct packing, etc. are exactly the same for all items in
181 the project. After this, delete everything (including PCH) and recompile.
183 Visual C++ 1.5 compilation (16-bit)
184 -----------------------------------
186 1. Make sure your WXWIN variable is set, and uses the FAT (short
188 2. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to
189 make the wxWindows core library.
190 3. Change directory to a sample, such as wx\samples\minimal, and
191 type 'nmake -f makefile.dos'.
193 Add FINAL=1 to your makefile invocation to build the release
194 versions of the library and samples.
196 Use the 'clean' target to clean all objects, libraries and
199 Borland C++ 4.5/5.0 compilation
200 -------------------------------
202 Compiling using the makefiles:
204 1. Make sure your WXWIN variable is set, and uses the FAT (short
205 name) form if doing a 16-bit compile.
206 2. Change directory to wx\src\msw. Type 'make -f makefile.b32' to
207 make the wxWindows core library. Ignore the warnings about
208 'XXX' not found in library.
209 3. Change directory to a sample such as minimal, and type
210 'make -f makefile.b32'.
211 4. For release versions, recompile wxWindows and samples using
212 'make -f makefile.b32 clean'
213 'make -f makefile.b32 FINAL=1'
214 for the library and samples.
216 Note (1): the wxWindows library and (some) samples compile in 16-bit mode
217 using makefile.bcc, but at present the wxWindows resource system is switched
218 off in this mode. See issues.txt for details.
220 Note (2): unfortunately most samples won't link in 16-bit mode,
221 because the automatic data segment exceeds 64K. The minimal
222 sample links and runs, however.
224 Note (3): the wxWindows makefiles assume byte structure alignment. Please
225 make sure that your own project or makefile settings use the
226 same alignment, or you could experience mysterious crashes. To
227 change the alignment, add a suitable option to the $(CFG) target code
228 in src/msw/makefile.b32.
230 Note (4): if you get undefined _SQL... symbols at link time,
231 either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
232 directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
233 recompile wxWindows. The same applies if compiling using the IDE.
235 Note (5): BC++ 4.5 (not 5.0) trips up over jdmerge.c in the JPEG folder;
236 you will therefore need to set wxUSE_LIBJPEG to 0 in setup.h and remove
237 the jpeg target from src\msw\makefile.b32.
239 Compiling using the IDE files:
241 1. Load src\bc32.ide (Release settings)
242 2. Go to Options|Project... and specify the correct BC++ include and lib path for
244 3. Press F9 to compile the wxWindows library.
245 4. Load samples\bc32.ide.
246 5. Go to Options|Project... and specify the correct BC++ include and lib path for
248 6. Press F9 to compile the samples (build each node separately if
249 you prefer, by right clicking and choose Build Node).
250 7. Run each sample: you may need to run from each sample's directory
251 since some (notably the wxHTML samples) look for files
252 relative to the working directory.
254 Note that to make the png, xpm, zlib and jpeg libraries (needed for
255 some samples) you need to compile them with bc32.ide.
257 The debug version of the wxWindows library is about 37 MB, and the
258 release version is around 3 MB.
260 See also the file bc_ide.txt for further instructions and details
261 of how to create your own project files.
263 Borland C++Builder compilation
264 ------------------------------
266 C++Builder compilation is the same as for Borland C++ above.
268 Tested with C++Builder 1.0 and 3.0. Only makefiles are currently
271 Watcom C++ 10.6/11 compilation
272 ---------------------------
274 1. Make sure your WXWIN variable is set, and uses the DOS short
276 2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat' to
277 make the wxWindows core library.
278 3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
279 to make this sample. Repeat for other samples of interest.
281 Note (1): setup.h overrides wxUSE_LIBJPEG and sets it to 0, since
282 imagjpeg.cpp doesn't compile.
283 Note (2): makewat.env uses the odbc32.lib supplied in wxWindows' lib\watcom
284 directory. See the notes in that directory.
285 Note (3): if variant.cpp is compiled with date/time class
286 options, the linker gives up. So the date/time option is switched
287 off for Watcom C++. Also, wxAutomationObject is not compiled with
289 Note (4): if Watcom can't read the precompiled header when
290 building a sample, try deleting src\msw\watcom.pch and
291 compiling the sample again.
292 Note (5): if you get _popen_ and _pclose_ link errors, try
293 recompiling wxWindows with XPM support disabled in setup.h.
294 Alternatively, make sure these lines exist at the top of
297 // Added by JACS for Watcom C++/wxWindows compilation (no popen/pclose functions)
302 Metrowerks CodeWarrior compilation
303 ----------------------------------
305 1. Downloaded and unzip wx2_x_y_cw.zip.
306 2. Load the make_cw.mcp project in wx\src, and compile.
307 3. Load the make_cw.mcp project in wx\samples\minimal, and compile.
308 Further project files for samples will be available in due
311 Note (1): you need CodeWarrior Pro 4 plus the patches to 4.1 from the
314 Note (2): unfortunately these files are not yet up-to-date for the
317 Symantec C++ compilation
318 ------------------------
320 1. Make sure your WXWIN variable is set, and uses the FAT (short
322 2. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
323 3. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
324 make the wxWindows core library.
325 4. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
328 Note: the minimal sample doesn't link properly ('Error: no
330 32-bit compilation only (partially) supported at present, using SC++ 6.1.
331 Some functionality is missing using this compiler (see makefile).
332 Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
333 Step (2). 16-bit compilation is left as an excercise for the user!
335 Salford C++ compilation
336 -----------------------
338 1. Make sure your WXWIN variable is set, and uses the FAT (short
340 2. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
342 3. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
343 make the wxWindows core library.
344 4. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
347 Unfortunately, Salford C++ seems to have problems with its code generation for
348 operations on objects, as seen in wxFrame::OnMenuHighlight
349 (minimal sample) or wxWindow::SetValidator (mdi sample). Also the
350 the debugging version of the library is 90MB, with samples coming in
351 at 40MB :-) However, wxWindows at least makes a good test suite for
352 improving the compiler.
354 Cygwin b19/b20/Mingw32 compilation
355 ----------------------------------
357 wxWindows 2 supports Cygwin (formerly GnuWin32) b19, b20, Mingw32, and Mingw32/EGCS.
359 Thanks are due to Keith Garry Boyce (garp@opustel.com) and Cygnus for making
362 From wxWindows 2.0 beta 9, both Cygwin and Mingw32 (the minimal
363 distribution of Cygwin) can be used with the same makefiles.
365 Here are the steps required:
367 - Retrieve and install the latest beta of Cygwin, or Mingw32, as per the
368 instructions with either of these packages.
370 - If using Mingw32 (including the EGCS variant), you need some
371 extra files to use the wxWindows makefiles. You can find these
372 files in ports/mingw32 on the ftp site or CD-ROM, as extra.zip.
373 These should be extracted to the Mingw32 directory.
374 If you have already have downloaded bison, flex, make, rm, mv
375 from elsewhere, you won't need this.
377 If using Mingw32 2.8.1, see also see mingw32.txt in this directory
378 (docs/msw) about a fix that has to be applied to a Mingw32 header file.
380 If using Mingw32 2.95 with wxWindows 2.1 or above, and wish to use OLE, you
381 should hand-patch in Mingw32-gcc295.patches (located in the top-level of the
382 wxWindows 2 installation).
384 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
385 to set up appropriate variables, if necessary mounting drives.
386 Run it before compiling.
388 - For Cygwin, make sure there's a \tmp directory on your
389 Windows drive or bison will crash.
391 - Edit wx/src/makeg95.env and set the MINGW32 variable at the top of
392 the file to either 1 (you have Mingw32) or 0 (you have Cygwin32).
393 If using MINGW32, also set the MINGW32VERSION variable
396 - Mingw32 may not support winsock.h, so if you have a problem
397 here, comment out socket-related files in src/msw/makefile.g95.
399 - Set your WXWIN variable to where wxWindows is installed.
400 *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
403 - Use the makefile.g95 files for compiling wxWindows and samples,
406 > make -f makefile.g95
407 > cd c:\wx\samples\minimal
408 > make -f makefile.g95
410 Ignore the warning about the default entry point.
412 - Use the 'strip' command to reduce executable size.
414 - With Cygnus Cygwin, you can invoke gdb --nw myfile.exe to
415 debug an executable. If there are memory leaks, they will be
416 flagged when the program quits.
418 - If using GnuWin32 b18, you will need to copy windres.exe
419 from e.g. the Mingw32 distribution, to a directory in your path.
421 All targets have 'clean' targets to allow removal of object files
422 and other intermediate compiler files.
426 - See also the Cygwin/Mingw32 on the web site or CD-ROM for
427 further information about using wxWindows with these compilers.
429 - libwx.a is 48 MB or more - but much less if compiled with no
430 debug info (-g0) and level 4 optimization (-O4).
432 - install.exe doesn't have built-in decompression because lzexpand.lib
433 isn't available with Cygwin. However, you can use it with external
434 decompression utilities.
436 - There's a bug in Mingw32 headers for some early distributions.
438 in include/windows32/defines.h, where it says:
440 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
444 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
448 - If there's a problem with the copy command in
449 src/msw/makefile.g95, you may need to change the relevant
450 section to the following:
452 COPY = command /c copy
453 $(COMMDIR)/y_tab.c: $(COMMDIR)/dosyacc.c
454 $(COPY) ..\\common\\dosyacc.c ..\\common\\y_tab.c
456 $(COMMDIR)/lex_yy.c: $(COMMDIR)/doslex.c
457 $(COPY) ..\\common\\doslex.c ..\\common\\lex_yy.c
461 - The GNU-WIN32 site is at
462 http://www.cygnus.com/gnu-win32/
463 - Mingw32 is available at:
464 ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/mingw32/gcc-2.95/
465 - See also http://web.ukonline.co.uk/julian.smart/wxwin/gnuwin32.htm
467 TWIN32 and gcc on Linux
468 -----------------------
470 The wxWindows 2 for Windows port may be compiled using
471 the TWIN32 emulator package from www.willows.com. However,
472 TWIN32 is by no means finished so this should be taken as
473 something to think about for the future, rather than
474 a tool for writing products with.
476 Use makefile.twn in much the same way as makefile.g95, as
477 described above. Not all sample makefiles are supplied yet.
479 For some reason, I found I had to copy TWIN32's Windows resource
480 compiler (rc) to the current working directory for it to be found.
485 - Debugging: under Windows 95, debugging output isn't output in
486 the same way that it is under NT or Windows 3.1. Set
487 wxUSE_DBWIN32 to 1 if you wish to enable code to output debugging
488 info to an external debug monitor, such as Andrew Tucker's DBWIN32.
489 You can download DBWIN32 from:
491 http://ftp.digital.com/pub/micro/NT/WinSite/programr/dbwin32.zip
493 and it's also on the wxWindows CD-ROM under Packages.
495 - If you are installing wxWindows 2 from CVS, you may find that
496 include/wx/msw/setup.h is missing. This is deliberate, to avoid
497 developers' different setup.h configurations getting confused.
498 Please copy setup0.h to setup.h before compiling.