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 If there is a setup program, run the setup program that comes with the Windows version.
20 Do not install into a path that contains spaces. The installation program should set the
21 WXWIN environment variable, which will be activated when your machine is rebooted.
23 If there is no setup program, it will come as a series of .zip
26 wx200gen.zip Generic source code and samples (required)
27 wx200msw.zip Windows-specific source code and samples (required)
28 wx200doc.zip Documentation source code (not required)
29 wx200hlp.zip WinHelp documentation
30 wx200pdf.zip Acrobat PDF documentation
31 wx200htm.zip HTML documentation
32 wx200vc.zip MS VC++ 5.0 project files
33 wx200cw.zip Metrowerks CodeWarrior project files
34 wx200bc.zip BC++ 5 project files
36 Unarchive the required files plus any optional documentation
37 files into a suitable directory such as c:\wx.
39 Other add-on packages are available from the wxWindows Web site, such as:
41 - glcanvas.zip. Use OpenGL in a wxWindows window.
42 - ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
43 - tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
44 the same document source.
46 General installation notes
47 --------------------------
49 Alter your WXWIN environment variable to point to this directory.
50 For Cygwin or Mingw32 compilation, make sure WXWIN contains only
53 If installing from the CVS server, copy include/wx/msw/setup0.h to
54 include/wx/msw/setup.h and edit the resulting file to choose the featrues you
55 would like to compile wxWindows with[out].
60 The following sections explain how to compile wxWindows with each supported
63 Visual C++ 4.0/5.0/6.0 compilation
64 ----------------------------------
68 1. Unarchive wx200vc.zip, the VC++ 5/6 project makefiles.
69 2. Open src/wxvc.dsp, set Debug or Release configuration, and
70 compile. This will produce src/Debug/wxvc.lib or
71 src/Release/wxvc.lib. The project file src/wxvc_dll.dsp
72 will make a DLL version of wxWindow, which will go in
73 src/DebugDLL/wxvc.[lib,dll] and src/ReleaseDLL/wxvc.[lib,dll].
74 3. If you want to use JPEG in your application (such as the image
75 sample), open src/jpeg/jpeg.dsp (VC++ 6 only) and compile in
76 Debug and Release configurations. If you have VC++ 5 or
77 earlier, use makefile.vc, but you may only have one set of object
78 files at a time in use (debug or release).
79 4. Open a sample project file, choose a configuration, and compile.
80 The project files don't use precompiled headers, to save
81 space, but you can switch PCH compiling on for greater speed.
85 1. Make sure your WXWIN variable is set.
86 2. Change directory to wx\src\msw. Type:
88 'nmake -f makefile.vc'
90 to make the wxWindows core library with debug information
93 'nmake -f makefile.vc FINAL=1'
95 to make the wxWindows core library without debug information
97 3. If you wish to use JPEG in your applications, do the same
98 procedure in src\jpeg but add the 'all' target to the
100 4. Change directory to wx\samples and type 'nmake -f makefile.vc'
101 to make all the samples. You can also make them individually.
105 Use the 'clean' target to clean all objects, libraries and
108 To build the release version using makefiles, add FINAL=1 to your
109 nmake invocation, both when building the library and for samples.
111 Note that the wxWindows core library allows you to have debug
112 and release libraries available simultaneously, by compiling the
113 objects in different subdirectories, whereas samples must be
114 cleaned and re-made to build a different configuration. This
115 may be changed in later versions of wxWindows.
117 To build the DLL version using makefiles:
119 1. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll pch'
120 to make both a suitable DLL and import library, and to build a
121 suitable precompiled header file for compiling applications.
122 The resulting libraries are called:
124 wx\lib\wx200_d.lib(dll) (debug version)
125 wx\lib\wx200.lib(dll) (release version, using FINAL=1)
127 2. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
128 (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
131 Note (1): if you wish to use templates, please edit
132 include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
133 Without this, the redefinition of 'new' will cause problems in
134 the headers. Alternatively, #undef new before including template headers.
135 You will also need to set wxUSE_IOSTREAMH to 0 if you will be
136 using templates, to avoid the non-template stream files being included
139 Note (2): libraries and applications generated with makefiles and
140 project files are unlikely to be compatible, so use one method or
143 Note (3): VC++ 5's optimization code seems to be broken and can
144 cause problems: this can be seen when deleting an object Dialog
145 Editor, in Release mode with optimizations on. If in doubt,
146 switch off optimisations, although this will result in much
147 larger executables. It seems possible that the library can be created with
148 strong optimization, so long as the application is not strongly
149 optimized. For example, in wxWindows project, set to 'Minimum
150 Size'. In Dialog Editor project, set to 'Customize: Favor Small
151 Code' (and no others). This will then work.
153 Similarly, in VC++ 4, optimization can cause internal compiler
154 errors, so edit src\makevc.env and change /O1 to /Od before
155 trying build a release version of the library.
157 Note (4): some crash problems can be due to inconsistent compiler
158 options. If strange/weird/impossible things start to happen please
159 check (dumping IDE project file as makefile and doing text comparison
160 if necessary) that the project settings, especially the list of defined
161 symbols, struct packing, etc. are exactly the same for all items in
162 the project. After this, delete everything (including PCH) and recompile.
164 Visual C++ 1.5 compilation (16-bit)
165 -----------------------------------
167 1. Make sure your WXWIN variable is set, and uses the FAT (short
169 2. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to
170 make the wxWindows core library.
171 3. Change directory to a sample, such as wx\samples\minimal, and
172 type 'nmake -f makefile.dos'.
174 Add FINAL=1 to your makefile invocation to build the release
175 versions of the library and samples.
177 Use the 'clean' target to clean all objects, libraries and
180 Borland C++ 4.5/5.0 compilation
181 -------------------------------
183 Compiling using the makefiles:
185 1. Make sure your WXWIN variable is set, and uses the FAT (short
186 name) form if doing a 16-bit compile.
187 2. Change directory to wx\src\msw. Type 'make -f makefile.b32' to
188 make the wxWindows core library. Ignore the warnings about
189 'XXX' not found in library.
190 3. Change directory to a sample such as minimal, and type
191 'make -f makefile.b32'.
192 4. For release versions, recompile wxWindows and samples using
193 'make -f makefile.b32 clean'
194 'make -f makefile.b32 FINAL=1'
195 for the library and samples.
197 Note (1): the wxWindows library and (some) samples compile in 16-bit mode
198 using makefile.bcc, but at present the wxWindows resource system is switched
199 off in this mode. See issues.txt for details.
201 Note (2): unfortunately most samples won't link in 16-bit mode,
202 because the automatic data segment exceeds 64K. The minimal
203 sample links and runs, however.
205 Note (3): the wxWindows makefiles assume byte structure alignment. Please
206 make sure that your own project or makefile settings use the
207 same alignment, or you could experience mysterious crashes. To
208 change the alignment, add a suitable option to the $(CFG) target code
209 in src/msw/makefile.b32.
211 Compiling using the IDE files:
213 1. Load src\bc32.ide (or src\bc32d.ide for a debugging version).
214 2. Go to Options|Project... and specify the correct BC++ include and lib path for
216 3. Press F9 to compile the wxWindows library.
217 4. Load samples\bc32.ide.
218 5. Go to Options|Project... and specify the correct BC++ include and lib path for
220 6. Press F9 to compile the samples.
222 Note that to make the png, xpm and zlib libraries (needed for
223 some samples) you need to compile with bc32.ide. bc32d.ide only
224 makes the wxWindows library (lib\wx32d.lib).
226 The debug version of the wxWindows library is about 37 MB, and the
227 release version is around 3 MB.
229 See also the file bc_ide.txt for further instructions and details
230 of how to create your own project files.
232 Borland C++Builder compilation
233 ------------------------------
235 C++Builder compilation is the same as for Borland C++ above.
237 Tested with C++Builder 1.0 and 3.0. Only makefiles are currently
240 Watcom C++ 10.6/11 compilation
241 ---------------------------
243 1. Make sure your WXWIN variable is set, and uses the DOS short
245 2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat' to
246 make the wxWindows core library.
247 3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
248 to make this sample. Repeat for other samples of interest.
250 Note (1): setup.h overrides wxUSE_LIBJPEG and sets it to 0, since
251 imagjpeg.cpp doesn't compile.
252 Note (2): makewat.env uses the odbc32.lib supplied in wxWindows' lib\watcom
253 directory. See the notes in that directory.
255 Metrowerks CodeWarrior compilation
256 ----------------------------------
258 1. Downloaded and unzip wx200cw.zip.
259 2. Load the make_cw.mcp project in wx\src, and compile.
260 3. Load the make_cw.mcp project in wx\samples\minimal, and compile.
261 Further project files for samples will be available in due
264 Note (1): you need CodeWarrior Pro 4 plus the patches to 4.1 from the
267 Note (2): unfortunately these files are not yet up-to-date for the
270 Symantec C++ compilation
271 ------------------------
273 1. Make sure your WXWIN variable is set, and uses the FAT (short
275 2. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
276 3. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
277 make the wxWindows core library.
278 4. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
281 Note: the minimal sample doesn't link properly ('Error: no
283 32-bit compilation only (partially) supported at present, using SC++ 6.1.
284 Some functionality is missing using this compiler (see makefile).
285 Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
286 Step (2). 16-bit compilation is left as an excercise for the user!
288 Salford C++ compilation
289 -----------------------
291 1. Make sure your WXWIN variable is set, and uses the FAT (short
293 2. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
295 3. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
296 make the wxWindows core library.
297 4. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
300 Unfortunately, Salford C++ seems to have problems with its code generation for
301 operations on objects, as seen in wxFrame::OnMenuHighlight
302 (minimal sample) or wxWindow::SetValidator (mdi sample). Also the
303 the debugging version of the library is 90MB, with samples coming in
304 at 40MB :-) However, wxWindows at least makes a good test suite for
305 improving the compiler.
307 Cygwin b19/b20/Mingw32 compilation
308 ----------------------------------
310 wxWindows 2 supports Cygwin (formerly GnuWin32) b19, b20, Mingw32, and Mingw32/EGCS.
312 Thanks are due to Keith Garry Boyce (garp@opustel.com) and Cygnus for making
315 From wxWindows 2.0 beta 9, both Cygwin and Mingw32 (the minimal
316 distribution of Cygwin) can be used with the same makefiles.
318 Here are the steps required:
320 - Retrieve and install the latest beta of Cygwin, or Mingw32, as per the
321 instructions with either of these packages.
323 - If using Mingw32 (including the EGCS variant), you need some
324 extra files to use the wxWindows makefiles. You can find these
325 files in ports/mingw32 on the ftp site or CD-ROM, as extra.zip.
326 These should be extracted to the Mingw32 directory.
327 If you have already have downloaded bison, flex, make, rm, mv
328 from elsewhere, you won't need this.
330 If using Mingw32 2.8.1, see also see mingw32.txt in this directory
331 (docs/msw) about a fix that has to be applied to a Mingw32 header file.
333 If using Mingw32 2.95 with wxWindows 2.1 or above, and wish to use OLE, you
334 should hand-patch in Mingw32-gcc295.patches (located in the top-level of the
335 wxWindows 2 installation).
337 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
338 to set up appropriate variables, if necessary mounting drives.
339 Run it before compiling.
341 - For Cygwin, make sure there's a \tmp directory on your
342 Windows drive or bison will crash.
344 - Edit wx/src/makeg95.env and set the MINGW32 variable at the top of
345 the file to either 1 (you have Mingw32) or 0 (you have Cygwin32).
346 If using MINGW32, also set the MINGW32VERSION variable
349 - Mingw32 may not support winsock.h, so if you have a problem
350 here, comment out socket-related files in src/msw/makefile.g95.
352 - Set your WXWIN variable to where wxWindows is installed.
353 *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
356 - Use the makefile.g95 files for compiling wxWindows and samples,
359 > make -f makefile.g95
360 > cd c:\wx\samples\minimal
361 > make -f makefile.g95
363 Ignore the warning about the default entry point.
365 - Use the 'strip' command to reduce executable size.
367 - With Cygnus Cygwin, you can invoke gdb --nw myfile.exe to
368 debug an executable. If there are memory leaks, they will be
369 flagged when the program quits.
371 - If using GnuWin32 b18, you will need to copy windres.exe
372 from e.g. the Mingw32 distribution, to a directory in your path.
374 All targets have 'clean' targets to allow removal of object files
375 and other intermediate compiler files.
379 - libwx.a is 48 MB or more - but much less if compiled with no
380 debug info (-g0) and level 4 optimization (-O4).
382 - install.exe doesn't have built-in decompression because lzexpand.lib
383 isn't available with Cygwin. However, you can use it with external
384 decompression utilities.
386 - Doesn't compile src/msw/ole files, so no drag and drop.
388 - There's a bug in the Mingw32 headers for some distributions.
390 in include/windows32/defines.h, where it says:
392 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
396 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
402 - The GNU-WIN32 site is at
403 http://www.cygnus.com/gnu-win32/
404 - Mingw32 is available at:
405 ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/mingw32/gcc-2.95/
406 - See also http://web.ukonline.co.uk/julian.smart/wxwin/gnuwin32.htm
408 TWIN32 and gcc on Linux
409 -----------------------
411 The wxWindows 2 for Windows port may be compiled using
412 the TWIN32 emulator package from www.willows.com. However,
413 TWIN32 is by no means finished so this should be taken as
414 something to think about for the future, rather than
415 a tool for writing products with.
417 Use makefile.twn in much the same way as makefile.g95, as
418 described above. Not all sample makefiles are supplied yet.
420 For some reason, I found I had to copy TWIN32's Windows resource
421 compiler (rc) to the current working directory for it to be found.
426 - Debugging: under Windows 95, debugging output isn't output in
427 the same way that it is under NT or Windows 3.1. Set
428 wxUSE_DBWIN32 to 1 if you wish to enable code to output debugging
429 info to an external debug monitor, such as Andrew Tucker's DBWIN32.
430 You can download DBWIN32 from:
432 http://ftp.digital.com/pub/micro/NT/WinSite/programr/dbwin32.zip
434 and it's also on the wxWindows CD-ROM under Packages.
436 - If you are installing wxWindows 2 from CVS, you may find that
437 include/wx/msw/setup.h is missing. This is deliberate, to avoid
438 developers' different setup.h configurations getting confused.
439 Please copy setup0.h to setup.h before compiling.