2 Installing wxWindows 2.1
3 ------------------------
5 [Notes from Robert Roebling for snapshot 8]
7 This is a not-so-well tested snapshot release of wxWindows 2.1 for
8 Microsoft Windows 95, 98 and NT. This is not a production release,
9 although a huge number of bugs found in wxWindows 2.0 have been
12 There have not been major changes in the way to build the library,
13 although the creation of the various makefiles has been automatized.
14 I myself use the GNU MingGW32 compiler from
18 using the GNU make program from
20 http://agnes.dida.physik.uni-essen.de/~janjaap/mingw32
22 and I have not tested any other compiler, but other developers use
23 the makefiles for Borland C++, MS-Visual C++ 5.0 and 6.0 and probably
28 Installing wxWindows 2.0
29 ------------------------
31 IMPORTANT NOTE: If you experience problems installing, please
32 re-read this instructions and other related files (todo.txt,
33 bugs.txt etc.) carefully before mailing wxwin-users or
34 the author. Preferably, try to fix the problem first and
35 then send a patch to the author.
40 If there is a setup program, run the setup program that comes with the Windows version.
41 Do not install into a path that contains spaces. The installation program should set the
42 WXWIN environment variable, which will be activated when your machine is rebooted.
44 If there is no setup program, it will come as a series of .zip
47 wx200gen.zip Generic source code and samples (required)
48 wx200msw.zip Windows-specific source code and samples (required)
49 wx200doc.zip Documentation source code (not required)
50 wx200hlp.zip WinHelp documentation
51 wx200pdf.zip Acrobat PDF documentation
52 wx200htm.zip HTML documentation
53 wx200vc.zip MS VC++ 5.0 project files
54 wx200cw.zip Metrowerks CodeWarrior project files
55 wx200bc.zip BC++ 5 project files
57 Unarchive the required files plus any optional documentation
58 files into a suitable directory such as c:\wx.
60 Other add-on packages are available from the wxWindows Web site, such as:
62 - glcanvas.zip. Use OpenGL in a wxWindows window.
63 - ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
64 - tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
65 the same document source.
67 General installation notes
68 --------------------------
70 Alter your WXWIN environment variable to point to this directory.
71 For Cygwin or Mingw32 compilation, make sure WXWIN contains only
74 If installing from the CVS server, copy include/wx/msw/setup0.h to
75 include/wx/msw/setup.h and edit the resulting file to choose the featrues you
76 would like to compile wxWindows with[out].
81 The following sections explain how to compile wxWindows with each supported
84 Visual C++ 4.0/5.0/6.0 compilation
85 ----------------------------------
89 1. Unarchive wx200vc.zip, the VC++ 5 project makefiles.
90 2. Open src/wxvc.dsp, set Debug or Release configuration, and
91 compile. This will produce src/Debug/wxvc.lib or
92 src/Release/wxvc.lib. The project file src/wxvc_dll.dsp
93 will make a DLL version of wxWindow, which will go in
94 src/DebugDLL/wxvc.[lib,dll] and src/ReleaseDLL/wxvc.[lib,dll].
95 3. If you want to use JPEG in your application (such as the image
96 sample), open src/jpeg/jpeg.dsp (VC++ 6 only) and compile in
97 Debug and Release configurations. If you have VC++ 5 or
98 earlier, use makefile.vc, but you may only have one set of object
99 files at a time in use (debug or release).
100 4. Open a sample project file, choose a configuration, and compile.
101 The project files don't use precompiled headers, to save
102 space, but you can switch PCH compiling on for greater speed.
106 1. Make sure your WXWIN variable is set.
107 2. Change directory to wx\src\msw. Type:
109 'nmake -f makefile.vc'
111 to make the wxWindows core library with debug information
112 (wx\lib\wx_d.lib), or
114 'nmake -f makefile.vc FINAL=1'
116 to make the wxWindows core library without debug information
118 3. If you wish to use JPEG in your applications, do the same
119 procedure in src\jpeg but add the 'all' target to the
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 'clean' 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.
132 Note that the wxWindows core library allows you to have debug
133 and release libraries available simultaneously, by compiling the
134 objects in different subdirectories, whereas samples must be
135 cleaned and re-made to build a different configuration. This
136 may be changed in later versions of wxWindows.
138 To build the DLL version using makefiles:
140 1. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll pch'
141 to make both a suitable DLL and import library, and to build a
142 suitable precompiled header file for compiling applications.
143 The resulting libraries are called:
145 wx\lib\wx200_d.lib(dll) (debug version)
146 wx\lib\wx200.lib(dll) (release version, using FINAL=1)
148 2. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
149 (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
152 Note (1): if you wish to use templates, please edit
153 include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
154 Without this, the redefinition of 'new' will cause problems in
155 the headers. Alternatively, #undef new before including template headers.
156 You will also need to set wxUSE_IOSTREAMH to 0 if you will be
157 using templates, to avoid the non-template stream files being included
160 Note (2): libraries and applications generated with makefiles and
161 project files are unlikely to be compatible, so use one method or
164 Note (3): VC++ 5's optimization code seems to be broken and can
165 cause problems: this can be seen when deleting an object Dialog
166 Editor, in Release mode with optimizations on. If in doubt,
167 switch off optimisations, although this will result in much
168 larger executables. It seems possible that the library can be created with
169 strong optimization, so long as the application is not strongly
170 optimized. For example, in wxWindows project, set to 'Minimum
171 Size'. In Dialog Editor project, set to 'Customize: Favor Small
172 Code' (and no others). This will then work.
174 Note (4): some crash problems can be due to inconsistent compiler
175 options. If strange/weird/impossible things start to happen please
176 check (dumping IDE project file as makefile and doing text comparison
177 if necessary) that the project settings, especially the list of defined
178 symbols, struct packing, etc. are exactly the same for all items in
179 the project. After this, delete everything (including PCH) and recompile.
181 Visual C++ 1.5 compilation
182 --------------------------
184 1. Make sure your WXWIN variable is set, and uses the FAT (short
186 2. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to
187 make the wxWindows core library.
188 3. Change directory to a sample, such as wx\samples\minimal, and
189 type 'nmake -f makefile.dos'.
191 Add FINAL=1 to your makefile invocation to build the release
192 versions of the library and samples.
194 Use the 'clean' target to clean all objects, libraries and
197 Borland C++ 4.5/5.0 compilation
198 -------------------------------
200 Compiling using the makefiles:
202 1. Make sure your WXWIN variable is set, and uses the FAT (short
203 name) form if doing a 16-bit compile.
204 2. Change directory to wx\src\msw. Type 'make -f makefile.b32' to
205 make the wxWindows core library. Ignore the warnings about
206 'XXX' not found in library.
207 3. Change directory to a sample such as minimal, and type
208 'make -f makefile.b32'.
209 4. For release versions, recompile wxWindows and samples using
210 'make -f makefile.b32 clean'
211 'make -f makefile.b32 FINAL=1'
212 for the library and samples.
214 Note (1): the wxWindows library and (some) samples compile in 16-bit mode
215 using makefile.bcc, but at present the wxWindows resource system is switched
216 off in this mode. See issues.txt for details.
218 Note (2): the wxWindows makefiles assume byte structure alignment. Please
219 make sure that your own project or makefile settings use the
220 same alignment, or you could experience mysterious crashes. To
221 change the alignment, add a suitable option to the $(CFG) target code
222 in src/msw/makefile.b32.
224 Compiling using the IDE files:
226 1. Load src\bc32.ide (or src\bc32d.ide for a debugging version).
227 2. Go to Options|Project... and specify the correct BC++ include and lib path for
229 3. Press F9 to compile the wxWindows library.
230 4. Load samples\bc32.ide.
231 5. Go to Options|Project... and specify the correct BC++ include and lib path for
233 6. Press F9 to compile the samples.
235 Note that to make the png, xpm and zlib libraries (needed for
236 some samples) you need to compile with bc32.ide. bc32d.ide only
237 makes the wxWindows library (lib\wx32d.lib).
239 The debug version of the wxWindows library is about 37 MB, and the
240 release version is around 3 MB.
242 See also the file bc_ide.txt for further instructions and details
243 of how to create your own project files.
245 Borland C++Builder compilation
246 ------------------------------
248 C++Builder compilation is the same as for Borland C++ above.
250 Tested with C++Builder 1.0 and 3.0. Only makefiles are currently
253 Watcom C++ 10.6/11 compilation
254 ---------------------------
256 1. Make sure your WXWIN variable is set, and uses the DOS short
258 2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat' to
259 make the wxWindows core library.
260 3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
261 to make this sample. Repeat for other samples of interest.
263 Note (1): setup.h overrides wxUSE_LIBJPEG and sets it to 0, since
264 imagjpeg.cpp doesn't compile.
265 Note (2): makewat.env uses the odbc32.lib supplied in wxWindows' lib\watcom
266 directory. See the notes in that directory.
268 Metrowerks CodeWarrior compilation
269 ----------------------------------
271 1. Downloaded and unzip wx200cw.zip.
272 2. Load the make_cw.mcp project in wx\src, and compile.
273 3. Load the make_cw.mcp project in wx\samples\minimal, and compile.
274 Further project files for samples will be available in due
279 You need CodeWarrior Pro 4 plus the patches to 4.1 from the
282 Symantec C++ compilation
283 ------------------------
285 1. Make sure your WXWIN variable is set, and uses the FAT (short
287 2. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
288 3. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
289 make the wxWindows core library.
290 4. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
293 Note: the minimal sample doesn't link properly ('Error: no
295 32-bit compilation only (partially) supported at present, using SC++ 6.1.
296 Some functionality is missing using this compiler (see makefile).
297 Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
298 Step (2). 16-bit compilation is left as an excercise for the user!
300 Salford C++ compilation
301 -----------------------
303 1. Make sure your WXWIN variable is set, and uses the FAT (short
305 2. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
307 3. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
308 make the wxWindows core library.
309 4. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
312 Unfortunately, Salford C++ seems to have problems with its code generation for
313 operations on objects, as seen in wxFrame::OnMenuHighlight
314 (minimal sample) or wxWindow::SetValidator (mdi sample). Also the
315 the debugging version of the library is 90MB, with samples coming in
316 at 40MB :-) However, wxWindows at least makes a good test suite for
317 improving the compiler.
319 Cygwin b19/b20/Mingw32 compilation
320 ----------------------------------
322 wxWindows 2 supports Cygwin (formerly GnuWin32) b19, b20, Mingw32, and Mingw32/EGCS.
324 Thanks are due to Keith Garry Boyce (garp@opustel.com) and Cygnus for making
327 From wxWindows 2.0 beta 9, both Cygwin and Mingw32 (the minimal
328 distribution of Cygwin) can be used with the same makefiles.
330 Here are the steps required:
332 - Retrieve and install the latest beta of Cygwin, or Mingw32, as per the
333 instructions with either of these packages.
335 - If using Mingw32 (including the EGCS variant), you need some
336 extra files to use the wxWindows makefiles. You can find these
337 files in ports/mingw32 on the ftp site or CD-ROM, as extra.zip.
338 These should be extracted to the Mingw32 directory.
339 If you have already have downloaded bison, flex, make, rm, mv
340 from elsewhere, you won't need this.
342 If using Mingw32 2.8.1, see also see mingw32.txt in this directory
343 (docs/msw) about a fix that has to be applied to a Mingw32 header file.
345 If using Mingw32 2.95 with wxWindows 2.1 or above, and wish to use OLE, you
346 should hand-patch in Mingw32-gcc295.patches (located in the top-level of the
347 wxWindows 2 installation).
349 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
350 to set up appropriate variables, if necessary mounting drives.
351 Run it before compiling.
353 - For Cygwin, make sure there's a \tmp directory on your
354 Windows drive or bison will crash.
356 - Edit wx/src/makeg95.env and set the MINGW32 variable at the top of
357 the file to either 1 (you have Mingw32) or 0 (you have Cygwin32).
358 If using MINGW32, also set the MINGW32VERSION variable
361 - Mingw32 may not support winsock.h, so if you have a problem
362 here, comment out socket-related files in src/msw/makefile.g95.
364 - Set your WXWIN variable to where wxWindows is installed.
365 *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
368 - Use the makefile.g95 files for compiling wxWindows and samples,
371 > make -f makefile.g95
372 > cd c:\wx\samples\minimal
373 > make -f makefile.g95
375 Ignore the warning about the default entry point.
377 - Use the 'strip' command to reduce executable size.
379 - With Cygnus Cygwin, you can invoke gdb --nw myfile.exe to
380 debug an executable. If there are memory leaks, they will be
381 flagged when the program quits.
383 - If using GnuWin32 b18, you will need to copy windres.exe
384 from e.g. the Mingw32 distribution, to a directory in your path.
386 All targets have 'clean' targets to allow removal of object files
387 and other intermediate compiler files.
391 - libwx.a is 48 MB or more - but much less if compiled with no
392 debug info (-g0) and level 4 optimization (-O4).
394 - install.exe doesn't have built-in decompression because lzexpand.lib
395 isn't available with Cygwin. However, you can use it with external
396 decompression utilities.
398 - Doesn't compile src/msw/ole files, so no drag and drop.
400 - There's a bug in the Mingw32 headers for some distributions.
402 in include/windows32/defines.h, where it says:
404 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
408 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
414 - The GNU-WIN32 site is at
415 http://www.cygnus.com/gnu-win32/
416 - Mingw32 is available at:
417 ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/mingw32/gcc-2.95/
418 - See also http://web.ukonline.co.uk/julian.smart/wxwin/gnuwin32.htm
420 TWIN32 and gcc on Linux
421 -----------------------
423 The wxWindows 2 for Windows port may be compiled using
424 the TWIN32 emulator package from www.willows.com. However,
425 TWIN32 is by no means finished so this should be taken as
426 something to think about for the future, rather than
427 a tool for writing products with.
429 Use makefile.twn in much the same way as makefile.g95, as
430 described above. Not all sample makefiles are supplied yet.
432 For some reason, I found I had to copy TWIN32's Windows resource
433 compiler (rc) to the current working directory for it to be found.
438 - Debugging: under Windows 95, debugging output isn't output in
439 the same way that it is under NT or Windows 3.1. Set
440 wxUSE_DBWIN32 to 1 if you wish to enable code to output debugging
441 info to an external debug monitor, such as Andrew Tucker's DBWIN32.
442 You can download DBWIN32 from:
444 http://ftp.digital.com/pub/micro/NT/WinSite/programr/dbwin32.zip
446 and it's also on the wxWindows CD-ROM under Packages.
448 - If you are installing wxWindows 2 from CVS, you may find that
449 include/wx/msw/setup.h is missing. This is deliberate, to avoid
450 developers' different setup.h configurations getting confused.
451 Please copy setup0.h to setup.h before compiling.