]> git.saurik.com Git - wxWidgets.git/blame - docs/msw/install.txt
Applied patch [ 608850 ] wxX11 menu accelerators need toupper
[wxWidgets.git] / docs / msw / install.txt
CommitLineData
2bda0e17 1
4e4dc03d
JS
2Installing wxWindows 2.3.3
3--------------------------
0544bc0a 4
4e4dc03d 5This is wxWindows 2.3.3 for Microsoft Windows 9x/ME, Windows NT,
a40a9c81
JS
6Windows 2000 and Windows XP. This is an unstable development release.
7
8Please note that the library naming conventions for VC++
4e4dc03d 9compilation have changed after 2.3.1. This means that
a40a9c81
JS
10you will need to change your application project files. See the
11relevant section below for details.
0544bc0a 12
dbda9e86 13IMPORTANT NOTE: If you experience problems installing, please
9c6751aa 14re-read this instructions and other related files (changes.txt,
7666ad49
JS
15readme.txt, FAQ) carefully before mailing wx-users. Preferably,
16try to fix the problem first and then upload a patch to
17SourceForge:
18
19 http://sourceforge.net/patch/?group_id=9863
20
21Please report bugs using the SourceForge bug tracker:
22
23 http://sourceforge.net/bugs/?group_id=9863
dbda9e86 24
2bda0e17
KB
25Unarchiving
26-----------
27
154f22b3 28A setup program is provided (setup.exe) to automatically copy files to a
01dba85a
JS
29directory on your hard disk. Do not install into a path that contains spaces.
30The installation program should set the WXWIN environment variable, which
31will be activated when your machine is rebooted. The setup
32program contains the following:
33
34- All common, generic and MSW-specific wxWindows source;
35- samples;
36- documentation in Windows Help format;
b9f933ab
JS
37- makefiles for most Windows compilers, plus CodeWarrior,
38 BC++ and VC++ IDE files;
01dba85a 39- JPEG library source;
669f7a11 40- TIFF library source;
01dba85a 41- Object Graphics Library;
01dba85a
JS
42- Tex2RTF source;
43- Dialog Editor binary.
44
f6bcfd97
BP
45Alternatively, you may unarchive the .zip form by hand:
46wxMSW-x.y.z.zip where x.y.z is the version number.
2bda0e17
KB
47
48Unarchive the required files plus any optional documentation
dbda9e86 49files into a suitable directory such as c:\wx.
2bda0e17 50
8870c26e
JS
51Other add-on packages are available from the wxWindows Web site, such as:
52
5d525ad9 53- mmedia.zip. Audio, CD, video access for Windows and Linux.
8870c26e
JS
54- ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
55- tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
56 the same document source.
57
dbda9e86
JS
58General installation notes
59--------------------------
60
61Alter your WXWIN environment variable to point to this directory.
62For Cygwin or Mingw32 compilation, make sure WXWIN contains only
63forward slashes.
64
65If installing from the CVS server, copy include/wx/msw/setup0.h to
a40a9c81
JS
66include/wx/msw/setup.h and edit the resulting file to choose
67the features you would like to compile wxWindows with[out].
dbda9e86 68
2bda0e17
KB
69Compilation
70-----------
71
dbda9e86
JS
72The following sections explain how to compile wxWindows with each supported
73compiler.
2bda0e17 74
a40a9c81
JS
75Visual C++ 6.0 compilation
76---------------------------
2bda0e17 77
a40a9c81 78Using project files (VC++ 6 only):
a367b9b3 79
a40a9c81 801. Unarchive wxWindows-x.y.z-vc.zip, the VC++ 6 project
f6bcfd97 81 makefiles (already included in wxMSW-x.y.z.zip and the setup version).
a40a9c81
JS
822. Open src/wxWindows.dsp, which has configurations for static
83 compilation or DLL compilation, and each of these available in
84 Unicode/ANSI and Debug/Release variations. Normally you'll use
85 a static linking ANSI configuration. Choose the Win32 Debug or
86 Win32 Release configuration for the wxWindows project, and compile.
87 Alternatively, use Batch Build to build more than one
88 configuration.
89 The following libraries will be produced depending on chosen
90 configuration:
91
92 wxmsw.lib wxmswd.lib ; ANSI Release/Debug
93 wxmswu.lib wxmswud.lib ; UNICODE Release/Debug
94 wxmsw23x.lib wxmsw23xd.lib ; ANSI DLL Release/Debug
95 wxmsw23xu.lib wxmsw23xud.lib ; UNICODE DLL Release/Debug
96
97 It will also produce similar variations on jpeg.lib, png.lib,
98 tiff.lib, zlib.lib, and regex.lib.
5fa399c9 993. Open a sample project file, choose a configuration such as
a40a9c81 100 Win32 Debug using Build | Set Active Configuration..., and compile.
5fa399c9 101 The project files don't use precompiled headers, to save disk
16553659 102 space, but you can switch PCH compiling on for greater speed.
a40a9c81 103 NOTE: you may also use samples/samples.dsw to access all
669f7a11
JS
104 sample projects without opening each workspace individually.
105 You can use the Batch Build facility to make several samples
106 at a time.
a367b9b3
JS
107
108Using makefiles:
109
62448488 1101. Make sure your WXWIN variable is set.
d1e418ea
JS
1112. If you do NOT have the TIFF or JPEG source code, please remove
112 the tiff and jpeg targets from the 'all' target in
113 src\msw\makefile.vc. Also ensure the settings in
114 include\wx\msw\setup.h specify not to use JPEG or TIFF.
1153. Change directory to wx\src\msw. Type:
ca5c8b2d
JS
116
117 'nmake -f makefile.vc'
118
119 to make the wxWindows core library with debug information
7fee680b 120 (wx\lib\wxd.lib), then
ca5c8b2d 121
7fee680b 122 'nmake -f makefile.vc cleanall FINAL=1'
ca5c8b2d
JS
123 'nmake -f makefile.vc FINAL=1'
124
a40a9c81 125 to make the wxWindows core library without debug information.
85f3749f 1264. Change directory to wx\samples and type 'nmake -f makefile.vc'
2bda0e17
KB
127 to make all the samples. You can also make them individually.
128
5fa399c9 129Makefile notes:
e2a6f233 130
7fee680b 131 Use the 'cleanall' target to clean all objects, libraries and
ca5c8b2d
JS
132 executables.
133
134 To build the release version using makefiles, add FINAL=1 to your
135 nmake invocation, both when building the library and for samples.
7fee680b
JS
136 You MUST use the 'cleanall' target (with FINAL=1 or FINAL=0)
137 before making a different configuration, because otherwise
138 object files used to build the previous configuration may be
2edb0bde 139 used accidentally for the current configuration. You might see
7fee680b
JS
140 this manifested in unexpected link errors or warnings. This problem
141 doesn't occur when using project files to build wxWindows.
ca5c8b2d 142
4dcd292c 143 To build Unicode versions of the libraries, add UNICODE=1
26a00631
VS
144 to the nmake invocation ( default is UNICODE=0 ). If you want to
145 be able to use Unicode version on Windows9x, you will need
146 MSLU (Microsoft Layer for Unicode) runtime DLL and import lib.
147 The former can be downloaded from Microsoft, the latter is part
148 of the latest Platform SDK from Microsoft (see msdn.microsoft.com
149 for details). An alternative implementation of import library can
150 be downloaded from http://libunicows.sourceforge.net - unlike the
151 official one, this one works with other compilers and does not
152 require 300+ MB Platform SDK update. Add MSLU=1 to the nmake
153 invocation to enable MSLU.
4dcd292c 154
ca5c8b2d
JS
155 Note that the wxWindows core library allows you to have debug
156 and release libraries available simultaneously, by compiling the
157 objects in different subdirectories, whereas samples must be
7fee680b 158 cleaned and re-made to build a different configuration.
e2a6f233
JS
159
160To build the DLL version using makefiles:
161
1621. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll pch'
163 to make both a suitable DLL and import library, and to build a
164 suitable precompiled header file for compiling applications.
a40a9c81 165 See the previous section for library names.
ca5c8b2d
JS
1662. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
167 (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
168 applications).
e2a6f233 169
3f1af920 170Note (1): if you wish to use templates, please edit
025e88c5
JS
171include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
172Without this, the redefinition of 'new' will cause problems in
173the headers. Alternatively, #undef new before including template headers.
dbda9e86
JS
174You will also need to set wxUSE_IOSTREAMH to 0 if you will be
175using templates, to avoid the non-template stream files being included
176within wxWindows.
025e88c5 177
3f1af920 178Note (2): libraries and applications generated with makefiles and
5fa399c9
JS
179project files are now (hopefully) compatible where static libraries
180are concerned, but please exercise caution nevertheless and if
181possible, use one method or the other.
3f1af920 182
750b78ba 183Note (3): VC++ 5's optimization code seems to be broken and can
ad556aa9
JS
184cause both compile and run-time problems: this can be seen when
185deleting an object Dialog Editor, in Release mode with optimizations
186on. If in doubt, switch off optimisations, although this will result in much
750b78ba
JS
187larger executables. It seems possible that the library can be created with
188strong optimization, so long as the application is not strongly
189optimized. For example, in wxWindows project, set to 'Minimum
190Size'. In Dialog Editor project, set to 'Customize: Favor Small
191Code' (and no others). This will then work.
192
ad813b00
JS
193Note (4): some crash problems can be due to inconsistent compiler
194options. If strange/weird/impossible things start to happen please
195check (dumping IDE project file as makefile and doing text comparison
196if necessary) that the project settings, especially the list of defined
197symbols, struct packing, etc. are exactly the same for all items in
198the project. After this, delete everything (including PCH) and recompile.
199
a40a9c81 200Note (5): to create your own IDE files, see the technical note on the
9c6751aa 201wxWindows web site or CD-ROM, entitled "Compiling wxWindows
f6bcfd97
BP
202applications in the VC++ IDE" (technical note docs/tech/tn0010.htm in the
203wxWindows distribution). You can also copy .dsp and .dsw
9c6751aa
JS
204files from an existing wxWindows sample and adapt them.
205
8fb3a512
JS
206Visual C++ 1.5 compilation (16-bit)
207-----------------------------------
2bda0e17 208
a40a9c81
JS
209NOTE: this has not been tested recently and probably doesn't
210work.
211
62448488
JS
2121. Make sure your WXWIN variable is set, and uses the FAT (short
213 name) form.
2142. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to
2bda0e17 215 make the wxWindows core library.
62448488 2163. Change directory to a sample, such as wx\samples\minimal, and
f60d0f94 217 type 'nmake -f makefile.dos'.
2bda0e17 218
e2a6f233
JS
219Add FINAL=1 to your makefile invocation to build the release
220versions of the library and samples.
221
222Use the 'clean' target to clean all objects, libraries and
223executables.
224
9fce8d2e 225Borland C++ 4.5/5.0/5.5 compilation
2bda0e17
KB
226-------------------------------
227
b7b45f6f 228Compiling using the makefiles (updated 24 Seot 02):
ca5c8b2d 229
9fce8d2e
JS
2301. Make sure your WXWIN variable is set [e.g add
231 set WXWIN=c:\wxwindows
232 to your autoexec.bat file], and that it uses the FAT (short
233 name) form with no spaces.
9fce8d2e 234 Reboot if needed for the changes to autoexec.bat to take effect.
19e9b919 2352. Change directory to src\msw. Type 'make -f makefile.b32' to
b7b45f6f
CE
236 make the wxWindows core library. Ignore the compiler warnings.
237 This produces a library in the wxwindows\lib directory called
238 wx32ds.lib
c0bcc480 2393. Change directory to a sample or demo such as samples\minimal, and type
b7b45f6f 240 'make -f makefile.b32'. This produces a windows exe file
4bf78aae
JS
2414. For release versions, recompile wxWindows and samples using
242 'make -f makefile.b32 clean'
243 'make -f makefile.b32 FINAL=1'
b7b45f6f
CE
244 for the library and samples. This produces a library wx32s.lib eliminating
245 all debugging information - if you wish to retain reduced debugging information
246 'make -f makefile.b32 clean'
247 'make -f makefile.b32 FINAL=hybrid'
248
f6bcfd97
BP
2495. To make and use wxWindows as a DLL, type
250 'make -f makefile.b32 clean'
251 'make -f makefile.b32 DLL=1'
b7b45f6f 252 which generates a DLL (wx32d.dll) and import library (wx32d.lib),
f6bcfd97
BP
253 and then for each sample,
254 'make -f makefile.b32 WXUSINGDLL=1'
255 Please note that the samples have not been exhaustively tested
b7b45f6f
CE
256 with this configuration. You may also generate a sepratae library
257 and second DLL using the commands
258 'make -f makefile.b32 clean'
259 'make -f makefile.b32 DLL=1 FINAL=1'
260 which generates a DLL (wx32.dll) and import library (wx32.lib),
261 and then for each sample,
262 'make -f makefile.b32 WXUSINGDLL=1 FINAL=1'
263
2646. To make console mode applications with wxWindows functions go
265 to the src\msw directory
266 'make -f makebase.b32 clean'
267 'make -f makebase.b32'
268 There is a sample\console directory and in this type
269 'make -f makefile.b32 wxUSE_GUI=0'
270
271Note (0): This provides the ability to produce separate wxwindows libraries
272 for different purposes, and only have to rebuild the applications
273
62448488 274
6b6fc9b0
VZ
275Note (1): In Borland 4.5 and earleir, using bcc.exe you also need to define BCCDIR
276in the autoexec.bat file; like this:
277 set BCCDIR=c:\progra~1\borland\bcc
278 so that it points to the root directory of
279 your Borland C++ installation, and it uses the FAT (short
280 name) form with no spaces.
281
282
283Note (2): the wxWindows library and (some) samples compile in 16-bit mode
3b1de9c2
JS
284using makefile.bcc, but at present the wxWindows resource system is switched
285off in this mode. See issues.txt for details.
2bda0e17 286
6b6fc9b0 287Note (3): unfortunately most samples won't link in 16-bit mode,
8fb3a512
JS
288because the automatic data segment exceeds 64K. The minimal
289sample links and runs, however.
290
6b6fc9b0 291Note (4): the wxWindows makefiles assume byte structure alignment. Please
1a7f3062
JS
292make sure that your own project or makefile settings use the
293same alignment, or you could experience mysterious crashes. To
294change the alignment, add a suitable option to the $(CFG) target code
295in src/msw/makefile.b32.
296
6b6fc9b0 297Note (5): if you get undefined _SQL... symbols at link time,
154f22b3
JS
298either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
299directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
300recompile wxWindows. The same applies if compiling using the IDE.
301
6b6fc9b0 302Note (6): BC++ 4.5 (not 5.0) trips up over jdmerge.c in the JPEG folder;
790ad94f 303you will therefore need to set wxUSE_LIBJPEG to 0 in setup.h and remove
b2cf617c
JS
304the jpeg target from src\msw\makefile.b32, and remove jpeg from
305src\makeprog.b32.
790ad94f 306
c3b177ae 307
7fee680b
JS
308Note (7): If you wish debug messages to be sent to the console in
309debug mode, edit src\makeb32.env and change /aa to /Tpe in
310LINK_FLAGS.
311
9fce8d2e 312Compiling using the IDE files: [Borland C++ 5.0, not Cbuilder]
ca5c8b2d 313
01dba85a 3141. Load src\bc32.ide (Release settings)
ca5c8b2d
JS
3152. Go to Options|Project... and specify the correct BC++ include and lib path for
316 your file structure.
3173. Press F9 to compile the wxWindows library.
33b64e6f 3184. Load samples\bc32.ide.
ca5c8b2d
JS
3195. Go to Options|Project... and specify the correct BC++ include and lib path for
320 your file structure.
01dba85a
JS
3216. Press F9 to compile the samples (build each node separately if
322 you prefer, by right clicking and choose Build Node).
3237. Run each sample: you may need to run from each sample's directory
324 since some (notably the wxHTML samples) look for files
325 relative to the working directory.
ca5c8b2d 326
c0bcc480
JS
327Note (1): the samples project file contains a selection of
328samples, and not all samples. The remaining samples can be made
329with the makefiles. See also the demos hierarchy which doesn't
330have any BC++ project files yet.
331
fb1bd1bd 332Note (2): to make the png, zlib, jpeg and tiff libraries (needed for
01dba85a 333some samples) you need to compile them with bc32.ide.
33b64e6f 334
c0bcc480
JS
335Note (3): the debug version of the wxWindows library is about 40 MB, and the
336release version is around 5 MB.
33b64e6f 337
f6bcfd97 338See also the file docs/tech/tn0007.txt for further instructions and details
ca5c8b2d
JS
339of how to create your own project files.
340
f6bcfd97
BP
341** REMEMBER **
342
343In all of your wxWindows applications, your source code should include
344the following preprocessor directive:
345
346#ifdef __BORLANDC__
347#pragma hdrstop
348#endif
349
350(check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for
351more details)
352
9fce8d2e 353Borland C++Builder IDE compilation
4bf78aae
JS
354------------------------------
355
f6bcfd97
BP
3561. Build the wxWindows libraries using the Borland make utility as
357 specified in the section called "Borland C++ 4.5/5.0 compilation"
358 above. (C++ Builder includes a stand-alone C++ compiler. For example,
359 C++ Builder 4.0 comes with C++ 5.4.)
3f1af920 360
f6bcfd97
BP
3612. You can build samples using the makefiles as per the
362 instructions for BC++ above, or you can follow the instructions
363 in docs/tech/tn0004.htm or http://biolpc22.york.ac.uk/wx/bc/ide.html.
9fce8d2e
JS
364 You can use the process_sample_bcb.bat command which is in
365 wxwindows\distrib\msw to generate a .mak or .bpr file for most of the
366 samples [mak for Cbuilder 1-3; bpr for v4]. Execute this in the sample
367 directory, passing the name of the cpp files on the command line.
4bf78aae 368
ace03f87 369Watcom C++ 10.6/11 compilation
7be1f0d9
JS
370---------------------------
371
cba2db0c
JS
3721. Make sure your WXWIN variable is set, and uses the DOS short
373 name form.
3602a62e 3742. Change directory to wx\src\msw. Type 'wmake -f makefile.wat all' to
7be1f0d9 375 make the wxWindows core library.
3602a62e 3763. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat all'
ace03f87
JS
377 to make this sample. Repeat for other samples of interest.
378
f6bcfd97 379Note (1): makewat.env uses the odbc32.lib supplied in wxWindows' lib\watcom
ace03f87 380directory. See the notes in that directory.
f6bcfd97 381Note (2): if variant.cpp is compiled with date/time class
457e6c54
JS
382options, the linker gives up. So the date/time option is switched
383off for Watcom C++. Also, wxAutomationObject is not compiled with
384Watcom C++.
f6bcfd97 385Note (3): if Watcom can't read the precompiled header when
457e6c54
JS
386building a sample, try deleting src\msw\watcom.pch and
387compiling the sample again.
7be1f0d9 388
62448488
JS
389Metrowerks CodeWarrior compilation
390----------------------------------
391
ba14d986 3921. CodeWarrior Pro7 project files in XML format are already
73c3b37b 393 included in wxMSW-2.3.3.zip and the setup version.
ba14d986
VZ
3942. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if
395 you are working from the CVS version) to make sure the settings reflect
396 what you want. If you aren't sure, leave it alone and go with the
397 default settings. A few notes:
398 - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL
399 - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports
400 will be rather confusing due to interactions with the MSL ANSI
401 and runtime libs.
4023. The project file to build the Win32 wxWindows libraries relies on the
403 Batch File Runner plug-in. This plug-in is not installed as part of
404 a normal CW7 installation. However, you can find this plug-in on the
405 CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the
406 "Batch File Post Linker".
4074. If you choose not to install the Batch File Runner plug-in, then you
408 need to do the following by hand:
409 (1) Create the directories lib\cw7msw\include\wx and copy the file
410 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
411 working from the CVS version) to lib\cw7msw\include\wx\setup.h
412 (2) Create the directories lib\cw7mswd\include\wx and copy the file
413 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
414 working from the CVS version) to lib\cw7mswd\include\wx\setup.h
73c3b37b 4155. Import src\wxWindowsW7.xml to create the project file wxWindowsW7.mcp.
ba14d986
VZ
416 Store this project file in directory src. You may get warnings about
417 not being able to find certain project paths; ignore these warnings, the
418 appropriate paths will be created during the build by the Batch File Runner.
4196. Choose the wxlib Win32 debug or wxlib Win32 Release target and build. You
420 will get some warnings about hidden virtual functions, illegal conversions
421 from const pointers to pointers, etc., all of which you can safely ignore.
422 ***Note: if you get errors that the compiler can't find "wx/setup.h", just
423 stop the build and build again. These errors occur because sometimes the
424 compiler starts doing its thing before the copying of setup.h has completed.
4257. The following libraries will be produced depending on chosen
426 target:
427 - wx_x86.lib ANSI Release (static)
428 - wx_x86_d.lib ANSI Debug (static)
4298. Sorry, I haven't had time yet to create and test unicode or DLL versions.
430 Volunteers for this are welcome (as neither DLLs nor unicode builds are
431 big priorities for me ;).
4329. CodeWarrior Pro7 project files (in XML format) are also provided for some
73c3b37b
JS
433 of the samples. In particular, there are project files for the minimal,
434 controls, dialogs, dnd, nd docview samples. You can use these project
435 files as templates for the other samples and for your own projects.
436 - For example, to make a project file for the "newgrid" sample,
437 just copy the project file for the "minimal" sample, minimalW7.mcp
438 (made by importing minimalW7.xml into CodeWarrior), into the
439 sample/newgrid directory, calling it newgridW7.mcp. Open
440 newgridW7.mcp and revise the project by deleting the files
441 minimal.rc and minimal.cpp and adding the files griddemo.rc and
442 griddemo.cpp. Build and run....
62448488 443
74afbadc 444Cygwin/Mingw32 compilation
8870c26e 445----------------------------------
2bda0e17 446
74afbadc 447wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
6500c0b1
JS
448releases, and Mingw32. Cygwin can be downloaded from:
449
450 http://sources.redhat.com/cygwin
2bda0e17 451
6500c0b1
JS
452and Mingw32 from:
453
454 http://www.mingw.org
2bda0e17 455
4dcd292c
MB
456Both Cygwin and MinGW can be used with the same makefiles.
457
458NOTE: some notes specific to old Cygwin ( < 1.1.x )
459 and MinGW ( < 1.0 ) are at the end of this section
460 ( see OLD VERSIONS )
2bda0e17 461
7666ad49
JS
462There are two methods of compiling wxWindows, by using the
463makefiles provided or by using 'configure'.
2bda0e17 464
6500c0b1
JS
465Retrieve and install the latest version of Cygwin, or Mingw32, as per
466the instructions with either of these packages.
467
468If using Mingw32, you can download the add-on MSYS package to
469provide Unix-like tools that you'll need to build wxWindows.
eb165274 470
6500c0b1
JS
471The solution prior to MSYS was to download extra utilities from
472ports/mingw32 on the wxWindows ftp site or CD-ROM:
7666ad49
JS
473
474 ftp://biolp22.york.ac.uk/pub/ports/mingw32/extra.zip
eb165274 475
6500c0b1
JS
476These should be extracted to a directory in your path. If you have
477already downloaded rm, cp, mv from elsewhere, or are using
478MSYS, you won't need all of these files. However if using MSYS
479and configure to build wxWindows, you will need to unzip the
480following files from extra.zip and place them in e.g. an
481extrabin directory which you then add to your path:
7666ad49 482
6500c0b1
JS
483 bison.exe bison.hairy bison.simple flex.exe
484
485You will also need to set these variables:
486
487 set BISON_SIMPLE=c:\apps\mingw2.0.0-3\extrabin\bison.simple
488 set BISON_HAIRY=c:\apps\mingw2.0.0-3\extrabin\bison.hairy
489
490Here we're setting them in DOS before invoking 'sh', but you
491could set them within the shell instead.
492
493The 'configure' method uses flex and bison, whereas the
494direct makefile method uses pregenerated C files.
495
496Using makefiles directly
497========================
7666ad49 498
02fd5400
MB
499NOTE: The makefile are for compilation under Cygwin, MSYS, or
500 command.com/cmd.exe, they won't work in other environments
501 (such as UNIX)
502
7666ad49 503Here are the steps required using the provided makefiles:
8870c26e 504
dbda9e86 505- Set your WXWIN variable to where wxWindows is installed.
25889d3c
JS
506 *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
507 backslashes.
dbda9e86 508
6500c0b1
JS
509- Edit src/makeg95.env and set the MINGW32 variable at the top of
510 the file to either 1 (you have Mingw32) or 0 (if you have
511 Cygwin). If using Mingw32, also set the MINGW32VERSION variable
512 appropriately.
513
2bda0e17 514- Use the makefile.g95 files for compiling wxWindows and samples,
4dcd292c 515 e.g. to compile a debugging version of wxWindows:
2bda0e17 516 > cd c:\wx\src\msw
02fd5400 517 > make -f makefile.g95 clean
2bda0e17
KB
518 > make -f makefile.g95
519 > cd c:\wx\samples\minimal
02fd5400 520 > make -f makefile.g95 cleanall
2bda0e17
KB
521 > make -f makefile.g95
522
4dcd292c
MB
523 to compile with optimizations:
524 > cd c:\wx\src\msw
02fd5400 525 > make -f makefile.g95 clean
4dcd292c
MB
526 > make -f makefile.g95 FINAL=1
527 > cd c:\wx\samples\minimal
02fd5400 528 > make -f makefile.g95 cleanall
4dcd292c
MB
529 > make -f makefile.g95 FINAL=1
530
531 to compile a DLL:
532 > cd c:\wx\src\msw
02fd5400 533 > make -f makefile.g95 clean
4dcd292c
MB
534 > make -f makefile.g95 WXMAKINGDLL=1
535 > cd c:\wx\samples\minimal
02fd5400 536 > make -f makefile.g95 cleanall
4dcd292c
MB
537 > make -f makefile.g95 WXUSINGDLL=1
538
539 to compile the Unicode version:
540 > cd c:\wx\src\msw
02fd5400 541 > make -f makefile.g95 clean
4dcd292c
MB
542 > make -f makefile.g95 UNICODE=1
543 > cd c:\wx\samples\minimal
02fd5400 544 > make -f makefile.g95 cleanall
4dcd292c
MB
545 > make -f makefile.g95 UNICODE=1
546
547 Options can be combined ( e.g.: UNICODE=1 FINAL=1 )
548
cba2db0c
JS
549 Ignore the warning about the default entry point.
550
2bda0e17
KB
551- Use the 'strip' command to reduce executable size.
552
74afbadc 553- With Cygwin, you can invoke gdb --nw myfile.exe to
4fabb575 554 debug an executable. If there are memory leaks, they will be
4dcd292c
MB
555 flagged when the program quits. You can use Cygwin gdb
556 to debug MinGW executables.
2bda0e17
KB
557
558All targets have 'clean' targets to allow removal of object files
4dcd292c
MB
559and other intermediate compiler files and 'cleanall' targets to
560allow removal of all object files and library files.
2bda0e17 561
7666ad49
JS
562Using configure
563===============
564
565Instead of using the makefiles, you can use the configure
566system to generate appropriate makefiles, as used on Unix
567and Mac OS X systems.
568
569Change directory to the root of the wxWindows distribution,
6500c0b1
JS
570make a build directory, run 'sh', and then from this shell
571run configure and make.
7666ad49
JS
572
573For example:
574
575 cd $WXWIN
576 mkdir build-debug
577 cd build-debug
578 ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared
579 make
580 cd samples/minimal
581 make
582 ./minimal.exe
583
7c5dc04f 584Notes:
2bda0e17 585
bf4d9b2b
JS
5861. See also the Cygwin/Mingw32 on the web site or CD-ROM for
587 further information about using wxWindows with these compilers.
7c5dc04f 588
6b978929 5892. libwx.a is 100 MB or more - but much less if compiled with no
bf4d9b2b 590 debug info (-g0) and level 4 optimization (-O4).
7c5dc04f 591
6b978929
JS
5923. If you get a link error under Mingw32 2.95.2 referring to:
593
594 EnumDAdvise__11IDataObjectPP13IEnumSTATDATA@8
595
596 then you need to edit the file objidl.h at line 663 and add
597 a missing PURE keyword:
598
599 STDMETHOD(EnumDAdvise)(THIS_ IEnumSTATDATA**) PURE;
600
6014. There's a bug in Mingw32 headers for some early distributions.
7c5dc04f 602
bf4d9b2b 603 in include/windows32/defines.h, where it says:
7c5dc04f 604
bf4d9b2b 605 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
7c5dc04f 606
bf4d9b2b 607 it should say:
7c5dc04f 608
bf4d9b2b 609 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
7c5dc04f 610
bf4d9b2b 611 (a missing bracket).
7c5dc04f 612
6b978929 6135. If there's a problem with the copy or remove commands in
bf4d9b2b 614 src/msw/makefile.g95, you may need to change the COPY and
f6bcfd97 615 RM variables in makeg95.env.
51babd09 616
6b978929 6176. If there's a problem executing the windres program, try
bf4d9b2b 618 commenting out RCPREPROCESSOR in makeg95.env.
51babd09 619
6b978929 6207. OpenGL support should work with Mingw32 as-is. However,
fac26663
JS
621 if you wish to generate import libraries appropriate either for
622 the MS OpenGL libraries or the SGI OpenGL libraries, go to
623 include/wx/msw/gl and use:
624
625 dlltool -k -d opengl.def -llibopengl.a
626
627 for the SGI DLLs, or
628
629 dlltool -k -d opengl32.def -llibopengl32.a
630
631 and similarly for glu[32].def.
632
4dcd292c
MB
633OLD VERSIONS:
634
635- If using Mingw32 2.95 and below with wxWindows 2.1 or above, you
636 must hand-patch with Mingw32-gcc295.patches (located in the
637 top-level of the wxWindows 2 installation). Mingw32 2.95.2
638 and above contain the fixes already.
639
640- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
641 to set up appropriate variables, if necessary mounting drives.
642 Run it before compiling.
643
644- For Cygwin, make sure there's a \tmp directory on your
645 Windows drive or bison will crash (actually you don't need
646 bison for ordinary wxWindows compilation: a pre-generated .c file is
647 supplied).
648
4dcd292c
MB
649- If using GnuWin32 b18, you will need to copy windres.exe
650 from e.g. the Mingw32 distribution, to a directory in your path.
651
6500c0b1
JS
652Symantec C++ compilation
653------------------------
654
6551. Make sure your WXWIN variable is set, and uses the FAT (short
656 name) form.
6572. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
6583. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
659 make the wxWindows core library.
6604. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
661 to make this sample.
2bda0e17 662
6500c0b1
JS
663Note: the minimal sample doesn't link properly ('Error: no
664start address').
66532-bit compilation only (partially) supported at present, using SC++ 6.1.
666Some functionality is missing using this compiler (see makefile).
667Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
668Step (2). 16-bit compilation is left as an exercise for the user!
669
670Salford C++ compilation
671-----------------------
672
6731. Make sure your WXWIN variable is set, and uses the FAT (short
674 name) form.
6752. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
676 notes.
6773. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
678 make the wxWindows core library.
6794. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
680 to make this sample.
681
682Unfortunately, Salford C++ seems to have problems with its code generation for
683operations on objects, as seen in wxFrame::OnMenuHighlight
684(minimal sample) or wxWindow::SetValidator (mdi sample). Also the
685the debugging version of the library is 90MB, with samples coming in
686at 40MB :-) However, wxWindows at least makes a good test suite for
687improving the compiler.
2bda0e17 688
57c208c5
JS
689TWIN32 and gcc on Linux
690-----------------------
691
692The wxWindows 2 for Windows port may be compiled using
693the TWIN32 emulator package from www.willows.com. However,
694TWIN32 is by no means finished so this should be taken as
695something to think about for the future, rather than
696a tool for writing products with.
697
698Use makefile.twn in much the same way as makefile.g95, as
699described above. Not all sample makefiles are supplied yet.
700
8870c26e
JS
701For some reason, I found I had to copy TWIN32's Windows resource
702compiler (rc) to the current working directory for it to be found.
703
704General Notes
705-------------
a0a302dc
JS
706
707- Debugging: under Windows 95, debugging output isn't output in
9c6751aa
JS
708 the same way that it is under NT or Windows 3.1.
709 Please see DebugView (bin/dbgview.exe in the distribution), also
710 available from http://www.sysinternals.com and on the wxWindows CD-ROM
711 under Packages.
62448488 712
e3065973
JS
713- If you are installing wxWindows 2 from CVS, you may find that
714 include/wx/msw/setup.h is missing. This is deliberate, to avoid
715 developers' different setup.h configurations getting confused.
f6bcfd97
BP
716 Please copy setup0.h to setup.h before compiling. Also, read
717 the BuildCVS.txt for other hints.
bf4d9b2b 718