]> git.saurik.com Git - wxWidgets.git/blob - docs/msw/install.txt
6feb6de6072631857be7f52f693c136390c1d7f5
[wxWidgets.git] / docs / msw / install.txt
1
2 Installing wxWindows 2.1
3 ------------------------
4
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
8 fixed.
9
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.
15
16 Unarchiving
17 -----------
18
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.
22
23 If there is no setup program, it will come as a series of .zip
24 files:
25
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
35
36 Unarchive the required files plus any optional documentation
37 files into a suitable directory such as c:\wx.
38
39 Other add-on packages are available from the wxWindows Web site, such as:
40
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.
45
46 General installation notes
47 --------------------------
48
49 Alter your WXWIN environment variable to point to this directory.
50 For Cygwin or Mingw32 compilation, make sure WXWIN contains only
51 forward slashes.
52
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].
56
57 Compilation
58 -----------
59
60 The following sections explain how to compile wxWindows with each supported
61 compiler.
62
63 Visual C++ 4.0/5.0/6.0 compilation
64 ----------------------------------
65
66 Using project files:
67
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.
82
83 Using makefiles:
84
85 1. Make sure your WXWIN variable is set.
86 2. Change directory to wx\src\msw. Type:
87
88 'nmake -f makefile.vc'
89
90 to make the wxWindows core library with debug information
91 (wx\lib\wx_d.lib), or
92
93 'nmake -f makefile.vc FINAL=1'
94
95 to make the wxWindows core library without debug information
96 (wx\lib\wx.lib).
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
99 command line.
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.
102
103 Notes:
104
105 Use the 'clean' target to clean all objects, libraries and
106 executables.
107
108 To build the release version using makefiles, add FINAL=1 to your
109 nmake invocation, both when building the library and for samples.
110
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.
116
117 To build the DLL version using makefiles:
118
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:
123
124 wx\lib\wx200_d.lib(dll) (debug version)
125 wx\lib\wx200.lib(dll) (release version, using FINAL=1)
126
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
129 applications).
130
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
137 within wxWindows.
138
139 Note (2): libraries and applications generated with makefiles and
140 project files are unlikely to be compatible, so use one method or
141 the other.
142
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.
152 Note also that a bug in the compiler, even without optimization,
153 causes dobjcmn.cpp to produce an internal error, so setup.h
154 switches off drag and drop for VC++ 5.
155
156 Similarly, in VC++ 4, optimization can cause internal compiler
157 errors, so edit src\makevc.env and change /O1 to /Od before
158 trying build a release version of the library.
159
160 Note (4): some crash problems can be due to inconsistent compiler
161 options. If strange/weird/impossible things start to happen please
162 check (dumping IDE project file as makefile and doing text comparison
163 if necessary) that the project settings, especially the list of defined
164 symbols, struct packing, etc. are exactly the same for all items in
165 the project. After this, delete everything (including PCH) and recompile.
166
167 Visual C++ 1.5 compilation (16-bit)
168 -----------------------------------
169
170 1. Make sure your WXWIN variable is set, and uses the FAT (short
171 name) form.
172 2. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to
173 make the wxWindows core library.
174 3. Change directory to a sample, such as wx\samples\minimal, and
175 type 'nmake -f makefile.dos'.
176
177 Add FINAL=1 to your makefile invocation to build the release
178 versions of the library and samples.
179
180 Use the 'clean' target to clean all objects, libraries and
181 executables.
182
183 Borland C++ 4.5/5.0 compilation
184 -------------------------------
185
186 Compiling using the makefiles:
187
188 1. Make sure your WXWIN variable is set, and uses the FAT (short
189 name) form if doing a 16-bit compile.
190 2. Change directory to wx\src\msw. Type 'make -f makefile.b32' to
191 make the wxWindows core library. Ignore the warnings about
192 'XXX' not found in library.
193 3. Change directory to a sample such as minimal, and type
194 'make -f makefile.b32'.
195 4. For release versions, recompile wxWindows and samples using
196 'make -f makefile.b32 clean'
197 'make -f makefile.b32 FINAL=1'
198 for the library and samples.
199
200 Note (1): the wxWindows library and (some) samples compile in 16-bit mode
201 using makefile.bcc, but at present the wxWindows resource system is switched
202 off in this mode. See issues.txt for details.
203
204 Note (2): unfortunately most samples won't link in 16-bit mode,
205 because the automatic data segment exceeds 64K. The minimal
206 sample links and runs, however.
207
208 Note (3): the wxWindows makefiles assume byte structure alignment. Please
209 make sure that your own project or makefile settings use the
210 same alignment, or you could experience mysterious crashes. To
211 change the alignment, add a suitable option to the $(CFG) target code
212 in src/msw/makefile.b32.
213
214 Compiling using the IDE files:
215
216 1. Load src\bc32.ide (or src\bc32d.ide for a debugging version).
217 2. Go to Options|Project... and specify the correct BC++ include and lib path for
218 your file structure.
219 3. Press F9 to compile the wxWindows library.
220 4. Load samples\bc32.ide.
221 5. Go to Options|Project... and specify the correct BC++ include and lib path for
222 your file structure.
223 6. Press F9 to compile the samples.
224
225 Note that to make the png, xpm and zlib libraries (needed for
226 some samples) you need to compile with bc32.ide. bc32d.ide only
227 makes the wxWindows library (lib\wx32d.lib).
228
229 The debug version of the wxWindows library is about 37 MB, and the
230 release version is around 3 MB.
231
232 See also the file bc_ide.txt for further instructions and details
233 of how to create your own project files.
234
235 Borland C++Builder compilation
236 ------------------------------
237
238 C++Builder compilation is the same as for Borland C++ above.
239
240 Tested with C++Builder 1.0 and 3.0. Only makefiles are currently
241 supplied.
242
243 Watcom C++ 10.6/11 compilation
244 ---------------------------
245
246 1. Make sure your WXWIN variable is set, and uses the DOS short
247 name form.
248 2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat' to
249 make the wxWindows core library.
250 3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
251 to make this sample. Repeat for other samples of interest.
252
253 Note (1): setup.h overrides wxUSE_LIBJPEG and sets it to 0, since
254 imagjpeg.cpp doesn't compile.
255 Note (2): makewat.env uses the odbc32.lib supplied in wxWindows' lib\watcom
256 directory. See the notes in that directory.
257
258 Metrowerks CodeWarrior compilation
259 ----------------------------------
260
261 1. Downloaded and unzip wx200cw.zip.
262 2. Load the make_cw.mcp project in wx\src, and compile.
263 3. Load the make_cw.mcp project in wx\samples\minimal, and compile.
264 Further project files for samples will be available in due
265 course.
266
267 Note (1): you need CodeWarrior Pro 4 plus the patches to 4.1 from the
268 Metrowerks Web site.
269
270 Note (2): unfortunately these files are not yet up-to-date for the
271 current release.
272
273 Symantec C++ compilation
274 ------------------------
275
276 1. Make sure your WXWIN variable is set, and uses the FAT (short
277 name) form.
278 2. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
279 3. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
280 make the wxWindows core library.
281 4. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
282 to make this sample.
283
284 Note: the minimal sample doesn't link properly ('Error: no
285 start address').
286 32-bit compilation only (partially) supported at present, using SC++ 6.1.
287 Some functionality is missing using this compiler (see makefile).
288 Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
289 Step (2). 16-bit compilation is left as an excercise for the user!
290
291 Salford C++ compilation
292 -----------------------
293
294 1. Make sure your WXWIN variable is set, and uses the FAT (short
295 name) form.
296 2. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
297 notes.
298 3. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
299 make the wxWindows core library.
300 4. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
301 to make this sample.
302
303 Unfortunately, Salford C++ seems to have problems with its code generation for
304 operations on objects, as seen in wxFrame::OnMenuHighlight
305 (minimal sample) or wxWindow::SetValidator (mdi sample). Also the
306 the debugging version of the library is 90MB, with samples coming in
307 at 40MB :-) However, wxWindows at least makes a good test suite for
308 improving the compiler.
309
310 Cygwin b19/b20/Mingw32 compilation
311 ----------------------------------
312
313 wxWindows 2 supports Cygwin (formerly GnuWin32) b19, b20, Mingw32, and Mingw32/EGCS.
314
315 Thanks are due to Keith Garry Boyce (garp@opustel.com) and Cygnus for making
316 it all possible.
317
318 From wxWindows 2.0 beta 9, both Cygwin and Mingw32 (the minimal
319 distribution of Cygwin) can be used with the same makefiles.
320
321 Here are the steps required:
322
323 - Retrieve and install the latest beta of Cygwin, or Mingw32, as per the
324 instructions with either of these packages.
325
326 - If using Mingw32 (including the EGCS variant), you need some
327 extra files to use the wxWindows makefiles. You can find these
328 files in ports/mingw32 on the ftp site or CD-ROM, as extra.zip.
329 These should be extracted to the Mingw32 directory.
330 If you have already have downloaded bison, flex, make, rm, mv
331 from elsewhere, you won't need this.
332
333 If using Mingw32 2.8.1, see also see mingw32.txt in this directory
334 (docs/msw) about a fix that has to be applied to a Mingw32 header file.
335
336 If using Mingw32 2.95 with wxWindows 2.1 or above, and wish to use OLE, you
337 should hand-patch in Mingw32-gcc295.patches (located in the top-level of the
338 wxWindows 2 installation).
339
340 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
341 to set up appropriate variables, if necessary mounting drives.
342 Run it before compiling.
343
344 - For Cygwin, make sure there's a \tmp directory on your
345 Windows drive or bison will crash.
346
347 - Edit wx/src/makeg95.env and set the MINGW32 variable at the top of
348 the file to either 1 (you have Mingw32) or 0 (you have Cygwin32).
349 If using MINGW32, also set the MINGW32VERSION variable
350 appropriately.
351
352 - Mingw32 may not support winsock.h, so if you have a problem
353 here, comment out socket-related files in src/msw/makefile.g95.
354
355 - Set your WXWIN variable to where wxWindows is installed.
356 *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
357 backslashes.
358
359 - Use the makefile.g95 files for compiling wxWindows and samples,
360 e.g.:
361 > cd c:\wx\src\msw
362 > make -f makefile.g95
363 > cd c:\wx\samples\minimal
364 > make -f makefile.g95
365
366 Ignore the warning about the default entry point.
367
368 - Use the 'strip' command to reduce executable size.
369
370 - With Cygnus Cygwin, you can invoke gdb --nw myfile.exe to
371 debug an executable. If there are memory leaks, they will be
372 flagged when the program quits.
373
374 - If using GnuWin32 b18, you will need to copy windres.exe
375 from e.g. the Mingw32 distribution, to a directory in your path.
376
377 All targets have 'clean' targets to allow removal of object files
378 and other intermediate compiler files.
379
380 Notes:
381
382 - libwx.a is 48 MB or more - but much less if compiled with no
383 debug info (-g0) and level 4 optimization (-O4).
384
385 - install.exe doesn't have built-in decompression because lzexpand.lib
386 isn't available with Cygwin. However, you can use it with external
387 decompression utilities.
388
389 - Doesn't compile src/msw/ole files, so no drag and drop.
390
391 - There's a bug in the Mingw32 headers for some distributions.
392
393 in include/windows32/defines.h, where it says:
394
395 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
396
397 it should say:
398
399 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
400
401 (a missing bracket).
402
403 - If there's a problem with the copy command in
404 src/msw/makefile.g95, you may need to change the relevant
405 section to the following:
406
407 COPY = command /c copy
408 $(COMMDIR)/y_tab.c: $(COMMDIR)/dosyacc.c
409 $(COPY) ..\\common\\dosyacc.c ..\\common\\y_tab.c
410
411 $(COMMDIR)/lex_yy.c: $(COMMDIR)/doslex.c
412 $(COPY) ..\\common\\doslex.c ..\\common\\lex_yy.c
413
414 References:
415
416 - The GNU-WIN32 site is at
417 http://www.cygnus.com/gnu-win32/
418 - Mingw32 is available at:
419 ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/mingw32/gcc-2.95/
420 - See also http://web.ukonline.co.uk/julian.smart/wxwin/gnuwin32.htm
421
422 TWIN32 and gcc on Linux
423 -----------------------
424
425 The wxWindows 2 for Windows port may be compiled using
426 the TWIN32 emulator package from www.willows.com. However,
427 TWIN32 is by no means finished so this should be taken as
428 something to think about for the future, rather than
429 a tool for writing products with.
430
431 Use makefile.twn in much the same way as makefile.g95, as
432 described above. Not all sample makefiles are supplied yet.
433
434 For some reason, I found I had to copy TWIN32's Windows resource
435 compiler (rc) to the current working directory for it to be found.
436
437 General Notes
438 -------------
439
440 - Debugging: under Windows 95, debugging output isn't output in
441 the same way that it is under NT or Windows 3.1. Set
442 wxUSE_DBWIN32 to 1 if you wish to enable code to output debugging
443 info to an external debug monitor, such as Andrew Tucker's DBWIN32.
444 You can download DBWIN32 from:
445
446 http://ftp.digital.com/pub/micro/NT/WinSite/programr/dbwin32.zip
447
448 and it's also on the wxWindows CD-ROM under Packages.
449
450 - If you are installing wxWindows 2 from CVS, you may find that
451 include/wx/msw/setup.h is missing. This is deliberate, to avoid
452 developers' different setup.h configurations getting confused.
453 Please copy setup0.h to setup.h before compiling.