2 Installing wxWindows 2.1
3 ------------------------
5 This is a snapshot release of wxWindows 2.1 for
6 Microsoft 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 (todo.txt,
12 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.
19 A setup program is provided to automatically copy files to a
20 directory on your hard disk. Do not install into a path that contains spaces.
21 The installation program should set the WXWIN environment variable, which
22 will be activated when your machine is rebooted. The setup
23 program contains the following:
25 - All common, generic and MSW-specific wxWindows source;
27 - documentation in Windows Help format;
28 - makefiles for most Windows compilers, plus BC++ and
30 - JPEG library source;
31 - Object Graphics Library;
33 - wxTreeLayout library;
35 - Dialog Editor binary.
37 Alternatively, you may unarchive the set of .zip files by hand,
38 where x is the minor version number and y is the release number:
40 wx2_x_y_gen.zip Generic source code and samples (required)
41 wx2_x_y_msw.zip Windows-specific source code and samples (required)
42 wx2_x_y_doc.zip Documentation source code (not required)
43 wx2_x_y_hlp.zip WinHelp documentation
44 wx2_x_y_pdf.zip Acrobat PDF documentation
45 wx2_x_y_htm.zip HTML documentation
46 wx2_x_y_vc.zip MS VC++ 5.0 project files
47 wx2_x_y_cw.zip Metrowerks CodeWarrior project files
48 wx2_x_y_bc.zip BC++ 5 project files
49 jpeg.zip Use this to allow wxImage to read and write JPEG files
51 Unarchive the required files plus any optional documentation
52 files into a suitable directory such as c:\wx.
54 Other add-on packages are available from the wxWindows Web site, such as:
56 - glcanvas.zip. Use OpenGL in a wxWindows window.
57 - ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
58 - tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
59 the same document source.
61 General installation notes
62 --------------------------
64 Alter your WXWIN environment variable to point to this directory.
65 For Cygwin or Mingw32 compilation, make sure WXWIN contains only
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 the featrues you
70 would like to compile wxWindows with[out].
75 The following sections explain how to compile wxWindows with each supported
78 Visual C++ 4.0/5.0/6.0 compilation
79 ----------------------------------
83 1. Unarchive wx2_x_y_vc.zip, the VC++ 5/6 project makefiles.
84 2. Open src/wxvc.dsp, set Debug or Release configuration, and
85 compile. This will produce src/Debug/wxvc.lib or
86 src/Release/wxvc.lib. The project file src/wxvc_dll.dsp
87 will make a DLL version of wxWindow, which will go in
88 src/DebugDLL/wxvc.[lib,dll] and src/ReleaseDLL/wxvc.[lib,dll].
89 3. If you want to use JPEG in your application (such as the image
90 sample), open src/jpeg/jpeg.dsp (VC++ 5/6 only) and compile in
91 Debug and Release configurations. If you have VC++ 4,
92 use makefile.vc, but you may only have one set of object
93 files at a time in use (debug or release versions).
94 4. Open a sample project file, choose a configuration, and compile.
95 The project files don't use precompiled headers, to save
96 space, but you can switch PCH compiling on for greater speed.
100 1. Make sure your WXWIN variable is set.
101 2. Change directory to wx\src\msw. Type:
103 'nmake -f makefile.vc'
105 to make the wxWindows core library with debug information
106 (wx\lib\wx_d.lib), or
108 'nmake -f makefile.vc FINAL=1'
110 to make the wxWindows core library without debug information
112 3. If you wish to use JPEG in your applications, do the same
113 procedure in src\jpeg but add the 'all' target to the
115 4. Change directory to wx\samples and type 'nmake -f makefile.vc'
116 to make all the samples. You can also make them individually.
120 Use the 'clean' target to clean all objects, libraries and
123 To build the release version using makefiles, add FINAL=1 to your
124 nmake invocation, both when building the library and for samples.
126 Note that the wxWindows core library allows you to have debug
127 and release libraries available simultaneously, by compiling the
128 objects in different subdirectories, whereas samples must be
129 cleaned and re-made to build a different configuration. This
130 may be changed in later versions of wxWindows.
132 To build the DLL version using makefiles:
134 1. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll pch'
135 to make both a suitable DLL and import library, and to build a
136 suitable precompiled header file for compiling applications.
137 The resulting libraries are called:
139 wx\lib\wx200.lib(dll) (debug version)
140 wx\lib\wx200.lib(dll) (release version, using FINAL=1)
142 2. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
143 (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
146 Note (1): if you wish to use templates, please edit
147 include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
148 Without this, the redefinition of 'new' will cause problems in
149 the headers. Alternatively, #undef new before including template headers.
150 You will also need to set wxUSE_IOSTREAMH to 0 if you will be
151 using templates, to avoid the non-template stream files being included
154 Note (2): libraries and applications generated with makefiles and
155 project files are unlikely to be compatible, so use one method or
158 Note (3): VC++ 5's optimization code seems to be broken and can
159 cause both compile and run-time problems: this can be seen when
160 deleting an object Dialog Editor, in Release mode with optimizations
161 on. If in doubt, switch off optimisations, although this will result in much
162 larger executables. It seems possible that the library can be created with
163 strong optimization, so long as the application is not strongly
164 optimized. For example, in wxWindows project, set to 'Minimum
165 Size'. In Dialog Editor project, set to 'Customize: Favor Small
166 Code' (and no others). This will then work.
168 Similarly, in VC++ 4, optimization can cause internal compiler
169 errors, so edit src\makevc.env and change /O1 to /Od before
170 trying build a release version of the library.
172 Note (4): some crash problems can be due to inconsistent compiler
173 options. If strange/weird/impossible things start to happen please
174 check (dumping IDE project file as makefile and doing text comparison
175 if necessary) that the project settings, especially the list of defined
176 symbols, struct packing, etc. are exactly the same for all items in
177 the project. After this, delete everything (including PCH) and recompile.
179 Visual C++ 1.5 compilation (16-bit)
180 -----------------------------------
182 1. Make sure your WXWIN variable is set, and uses the FAT (short
184 2. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to
185 make the wxWindows core library.
186 3. Change directory to a sample, such as wx\samples\minimal, and
187 type 'nmake -f makefile.dos'.
189 Add FINAL=1 to your makefile invocation to build the release
190 versions of the library and samples.
192 Use the 'clean' target to clean all objects, libraries and
195 Borland C++ 4.5/5.0 compilation
196 -------------------------------
198 Compiling using the makefiles:
200 1. Make sure your WXWIN variable is set, and uses the FAT (short
201 name) form if doing a 16-bit compile.
202 2. Change directory to wx\src\msw. Type 'make -f makefile.b32' to
203 make the wxWindows core library. Ignore the warnings about
204 'XXX' not found in library.
205 3. Change directory to a sample such as minimal, and type
206 'make -f makefile.b32'.
207 4. For release versions, recompile wxWindows and samples using
208 'make -f makefile.b32 clean'
209 'make -f makefile.b32 FINAL=1'
210 for the library and samples.
212 Note (1): the wxWindows library and (some) samples compile in 16-bit mode
213 using makefile.bcc, but at present the wxWindows resource system is switched
214 off in this mode. See issues.txt for details.
216 Note (2): unfortunately most samples won't link in 16-bit mode,
217 because the automatic data segment exceeds 64K. The minimal
218 sample links and runs, however.
220 Note (3): the wxWindows makefiles assume byte structure alignment. Please
221 make sure that your own project or makefile settings use the
222 same alignment, or you could experience mysterious crashes. To
223 change the alignment, add a suitable option to the $(CFG) target code
224 in src/msw/makefile.b32.
226 Compiling using the IDE files:
228 1. Load src\bc32.ide (Release settings)
229 2. Go to Options|Project... and specify the correct BC++ include and lib path for
231 3. Press F9 to compile the wxWindows library.
232 4. Load samples\bc32.ide.
233 5. Go to Options|Project... and specify the correct BC++ include and lib path for
235 6. Press F9 to compile the samples (build each node separately if
236 you prefer, by right clicking and choose Build Node).
237 7. Run each sample: you may need to run from each sample's directory
238 since some (notably the wxHTML samples) look for files
239 relative to the working directory.
241 Note that to make the png, xpm, zlib and jpeg libraries (needed for
242 some samples) you need to compile them with bc32.ide.
244 The debug version of the wxWindows library is about 37 MB, and the
245 release version is around 3 MB.
247 See also the file bc_ide.txt for further instructions and details
248 of how to create your own project files.
250 Borland C++Builder compilation
251 ------------------------------
253 C++Builder compilation is the same as for Borland C++ above.
255 Tested with C++Builder 1.0 and 3.0. Only makefiles are currently
258 Watcom C++ 10.6/11 compilation
259 ---------------------------
261 1. Make sure your WXWIN variable is set, and uses the DOS short
263 2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat' to
264 make the wxWindows core library.
265 3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
266 to make this sample. Repeat for other samples of interest.
268 Note (1): setup.h overrides wxUSE_LIBJPEG and sets it to 0, since
269 imagjpeg.cpp doesn't compile.
270 Note (2): makewat.env uses the odbc32.lib supplied in wxWindows' lib\watcom
271 directory. See the notes in that directory.
273 Metrowerks CodeWarrior compilation
274 ----------------------------------
276 1. Downloaded and unzip wx2_x_y_cw.zip.
277 2. Load the make_cw.mcp project in wx\src, and compile.
278 3. Load the make_cw.mcp project in wx\samples\minimal, and compile.
279 Further project files for samples will be available in due
282 Note (1): you need CodeWarrior Pro 4 plus the patches to 4.1 from the
285 Note (2): unfortunately these files are not yet up-to-date for the
288 Symantec C++ compilation
289 ------------------------
291 1. Make sure your WXWIN variable is set, and uses the FAT (short
293 2. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
294 3. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
295 make the wxWindows core library.
296 4. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
299 Note: the minimal sample doesn't link properly ('Error: no
301 32-bit compilation only (partially) supported at present, using SC++ 6.1.
302 Some functionality is missing using this compiler (see makefile).
303 Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
304 Step (2). 16-bit compilation is left as an excercise for the user!
306 Salford C++ compilation
307 -----------------------
309 1. Make sure your WXWIN variable is set, and uses the FAT (short
311 2. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
313 3. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
314 make the wxWindows core library.
315 4. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
318 Unfortunately, Salford C++ seems to have problems with its code generation for
319 operations on objects, as seen in wxFrame::OnMenuHighlight
320 (minimal sample) or wxWindow::SetValidator (mdi sample). Also the
321 the debugging version of the library is 90MB, with samples coming in
322 at 40MB :-) However, wxWindows at least makes a good test suite for
323 improving the compiler.
325 Cygwin b19/b20/Mingw32 compilation
326 ----------------------------------
328 wxWindows 2 supports Cygwin (formerly GnuWin32) b19, b20, Mingw32, and Mingw32/EGCS.
330 Thanks are due to Keith Garry Boyce (garp@opustel.com) and Cygnus for making
333 From wxWindows 2.0 beta 9, both Cygwin and Mingw32 (the minimal
334 distribution of Cygwin) can be used with the same makefiles.
336 Here are the steps required:
338 - Retrieve and install the latest beta of Cygwin, or Mingw32, as per the
339 instructions with either of these packages.
341 - If using Mingw32 (including the EGCS variant), you need some
342 extra files to use the wxWindows makefiles. You can find these
343 files in ports/mingw32 on the ftp site or CD-ROM, as extra.zip.
344 These should be extracted to the Mingw32 directory.
345 If you have already have downloaded bison, flex, make, rm, mv
346 from elsewhere, you won't need this.
348 If using Mingw32 2.8.1, see also see mingw32.txt in this directory
349 (docs/msw) about a fix that has to be applied to a Mingw32 header file.
351 If using Mingw32 2.95 with wxWindows 2.1 or above, and wish to use OLE, you
352 should hand-patch in Mingw32-gcc295.patches (located in the top-level of the
353 wxWindows 2 installation).
355 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
356 to set up appropriate variables, if necessary mounting drives.
357 Run it before compiling.
359 - For Cygwin, make sure there's a \tmp directory on your
360 Windows drive or bison will crash.
362 - Edit wx/src/makeg95.env and set the MINGW32 variable at the top of
363 the file to either 1 (you have Mingw32) or 0 (you have Cygwin32).
364 If using MINGW32, also set the MINGW32VERSION variable
367 - Mingw32 may not support winsock.h, so if you have a problem
368 here, comment out socket-related files in src/msw/makefile.g95.
370 - Set your WXWIN variable to where wxWindows is installed.
371 *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
374 - Use the makefile.g95 files for compiling wxWindows and samples,
377 > make -f makefile.g95
378 > cd c:\wx\samples\minimal
379 > make -f makefile.g95
381 Ignore the warning about the default entry point.
383 - Use the 'strip' command to reduce executable size.
385 - With Cygnus Cygwin, you can invoke gdb --nw myfile.exe to
386 debug an executable. If there are memory leaks, they will be
387 flagged when the program quits.
389 - If using GnuWin32 b18, you will need to copy windres.exe
390 from e.g. the Mingw32 distribution, to a directory in your path.
392 All targets have 'clean' targets to allow removal of object files
393 and other intermediate compiler files.
397 - libwx.a is 48 MB or more - but much less if compiled with no
398 debug info (-g0) and level 4 optimization (-O4).
400 - install.exe doesn't have built-in decompression because lzexpand.lib
401 isn't available with Cygwin. However, you can use it with external
402 decompression utilities.
404 - Doesn't compile src/msw/ole files, so no drag and drop.
406 - There's a bug in Mingw32 headers for some early distributions.
408 in include/windows32/defines.h, where it says:
410 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
414 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
418 - If there's a problem with the copy command in
419 src/msw/makefile.g95, you may need to change the relevant
420 section to the following:
422 COPY = command /c copy
423 $(COMMDIR)/y_tab.c: $(COMMDIR)/dosyacc.c
424 $(COPY) ..\\common\\dosyacc.c ..\\common\\y_tab.c
426 $(COMMDIR)/lex_yy.c: $(COMMDIR)/doslex.c
427 $(COPY) ..\\common\\doslex.c ..\\common\\lex_yy.c
431 - The GNU-WIN32 site is at
432 http://www.cygnus.com/gnu-win32/
433 - Mingw32 is available at:
434 ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/mingw32/gcc-2.95/
435 - See also http://web.ukonline.co.uk/julian.smart/wxwin/gnuwin32.htm
437 TWIN32 and gcc on Linux
438 -----------------------
440 The wxWindows 2 for Windows port may be compiled using
441 the TWIN32 emulator package from www.willows.com. However,
442 TWIN32 is by no means finished so this should be taken as
443 something to think about for the future, rather than
444 a tool for writing products with.
446 Use makefile.twn in much the same way as makefile.g95, as
447 described above. Not all sample makefiles are supplied yet.
449 For some reason, I found I had to copy TWIN32's Windows resource
450 compiler (rc) to the current working directory for it to be found.
455 - Debugging: under Windows 95, debugging output isn't output in
456 the same way that it is under NT or Windows 3.1. Set
457 wxUSE_DBWIN32 to 1 if you wish to enable code to output debugging
458 info to an external debug monitor, such as Andrew Tucker's DBWIN32.
459 You can download DBWIN32 from:
461 http://ftp.digital.com/pub/micro/NT/WinSite/programr/dbwin32.zip
463 and it's also on the wxWindows CD-ROM under Packages.
465 - If you are installing wxWindows 2 from CVS, you may find that
466 include/wx/msw/setup.h is missing. This is deliberate, to avoid
467 developers' different setup.h configurations getting confused.
468 Please copy setup0.h to setup.h before compiling.