]> git.saurik.com Git - wxWidgets.git/blame - docs/msw/install.txt
More style issues
[wxWidgets.git] / docs / msw / install.txt
CommitLineData
42280e48 1Installing wxWindows 2.5.0
4e4dc03d 2--------------------------
0544bc0a 3
545d1e60
VZ
4This is wxWindows 2.5.0 for Microsoft Windows 9x/ME, Windows NT, Windows 2000
5and Windows XP. This is an unstable development release. Note that unstable in
6this context doesn't mean that it crashes a lot, just that the library API may
7change in backwards incompatible way during the 2.5 branch life time.
a40a9c81 8
0544bc0a 9
dbda9e86 10IMPORTANT NOTE: If you experience problems installing, please
9c6751aa 11re-read this instructions and other related files (changes.txt,
7666ad49
JS
12readme.txt, FAQ) carefully before mailing wx-users. Preferably,
13try to fix the problem first and then upload a patch to
14SourceForge:
15
16 http://sourceforge.net/patch/?group_id=9863
17
18Please report bugs using the SourceForge bug tracker:
19
20 http://sourceforge.net/bugs/?group_id=9863
dbda9e86 21
545d1e60 22
2bda0e17
KB
23Unarchiving
24-----------
25
2b5f62a0
VZ
26A setup program is provided (setup.exe) to automatically copy
27files to a directory on your hard disk. Do not install into a
28path that contains spaces. To avoid confusion with other
29wxWindows installations that might be on your machine, the
30installation program does not se the WXWIN environment variable;
31please set this by hand via the System applet if you wish to
32make it permanent.
33
34The setup program contains the following:
01dba85a
JS
35
36- All common, generic and MSW-specific wxWindows source;
37- samples;
38- documentation in Windows Help format;
b9f933ab
JS
39- makefiles for most Windows compilers, plus CodeWarrior,
40 BC++ and VC++ IDE files;
01dba85a 41- JPEG library source;
669f7a11 42- TIFF library source;
01dba85a 43- Object Graphics Library;
01dba85a
JS
44- Tex2RTF source;
45- Dialog Editor binary.
46
f6bcfd97
BP
47Alternatively, you may unarchive the .zip form by hand:
48wxMSW-x.y.z.zip where x.y.z is the version number.
2bda0e17
KB
49
50Unarchive the required files plus any optional documentation
dbda9e86 51files into a suitable directory such as c:\wx.
2bda0e17 52
8870c26e
JS
53Other add-on packages are available from the wxWindows Web site, such as:
54
5d525ad9 55- mmedia.zip. Audio, CD, video access for Windows and Linux.
8870c26e
JS
56- ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
57- tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
58 the same document source.
59
545d1e60 60
dbda9e86
JS
61General installation notes
62--------------------------
63
2b5f62a0 64Alter your WXWIN environment variable to point to the root directory of the
9a718b86 65wxWindows installation. For Cygwin or MinGW compilation, make sure WXWIN
2b5f62a0 66contains only forward slashes.
dbda9e86
JS
67
68If installing from the CVS server, copy include/wx/msw/setup0.h to
a40a9c81
JS
69include/wx/msw/setup.h and edit the resulting file to choose
70the features you would like to compile wxWindows with[out].
dbda9e86 71
545d1e60 72
2bda0e17 73Compilation
545d1e60 74===========
2bda0e17 75
dbda9e86 76The following sections explain how to compile wxWindows with each supported
545d1e60
VZ
77compiler. Search for one of Microsoft/Borland/Watcom/Symantec/Metrowerks/
78Cygwin/Mingw32 to quickly locate the instructions for your compiler.
79
2bda0e17 80
545d1e60
VZ
81Microsoft Visual C++ compilation
82--------------------------------
2bda0e17 83
38c1f6f7
VZ
84Please note that the VC++ 6.0 project files will work for VC++ .NET also, but
85you must open the .dsp files and not the .dsw files and in this case you will
916095ba 86need to manually build the other .dsp on which wxWindows.dsp depends: jpeg,
38c1f6f7 87png, regex, tiff and zlib.
1257f684 88
916095ba
JS
89Also note that you can make the project files work with VC++ 5.0 but you'll
90need to edit .dsp file by hand before this is possible (change the version in
91the .dsp file header from 6.0 to 5.0).
38c1f6f7
VZ
92
93Using project files (VC++ 6 and later):
a367b9b3 94
a40a9c81 951. Unarchive wxWindows-x.y.z-vc.zip, the VC++ 6 project
f6bcfd97 96 makefiles (already included in wxMSW-x.y.z.zip and the setup version).
38c1f6f7 972. Open src/wxWindows.dsw, which has configurations for static
a40a9c81
JS
98 compilation or DLL compilation, and each of these available in
99 Unicode/ANSI and Debug/Release variations. Normally you'll use
100 a static linking ANSI configuration. Choose the Win32 Debug or
101 Win32 Release configuration for the wxWindows project, and compile.
102 Alternatively, use Batch Build to build more than one
103 configuration.
104 The following libraries will be produced depending on chosen
105 configuration:
106
107 wxmsw.lib wxmswd.lib ; ANSI Release/Debug
108 wxmswu.lib wxmswud.lib ; UNICODE Release/Debug
109 wxmsw23x.lib wxmsw23xd.lib ; ANSI DLL Release/Debug
110 wxmsw23xu.lib wxmsw23xud.lib ; UNICODE DLL Release/Debug
111
112 It will also produce similar variations on jpeg.lib, png.lib,
113 tiff.lib, zlib.lib, and regex.lib.
5fa399c9 1143. Open a sample project file, choose a configuration such as
a40a9c81 115 Win32 Debug using Build | Set Active Configuration..., and compile.
5fa399c9 116 The project files don't use precompiled headers, to save disk
16553659 117 space, but you can switch PCH compiling on for greater speed.
a40a9c81 118 NOTE: you may also use samples/samples.dsw to access all
669f7a11
JS
119 sample projects without opening each workspace individually.
120 You can use the Batch Build facility to make several samples
121 at a time.
a367b9b3
JS
122
123Using makefiles:
124
62448488 1251. Make sure your WXWIN variable is set.
d1e418ea
JS
1262. If you do NOT have the TIFF or JPEG source code, please remove
127 the tiff and jpeg targets from the 'all' target in
128 src\msw\makefile.vc. Also ensure the settings in
129 include\wx\msw\setup.h specify not to use JPEG or TIFF.
1303. Change directory to wx\src\msw. Type:
ca5c8b2d
JS
131
132 'nmake -f makefile.vc'
133
134 to make the wxWindows core library with debug information
7fee680b 135 (wx\lib\wxd.lib), then
ca5c8b2d 136
7fee680b 137 'nmake -f makefile.vc cleanall FINAL=1'
ca5c8b2d
JS
138 'nmake -f makefile.vc FINAL=1'
139
a40a9c81 140 to make the wxWindows core library without debug information.
85f3749f 1414. Change directory to wx\samples and type 'nmake -f makefile.vc'
2bda0e17
KB
142 to make all the samples. You can also make them individually.
143
5fa399c9 144Makefile notes:
e2a6f233 145
7fee680b 146 Use the 'cleanall' target to clean all objects, libraries and
ca5c8b2d
JS
147 executables.
148
149 To build the release version using makefiles, add FINAL=1 to your
150 nmake invocation, both when building the library and for samples.
7fee680b
JS
151 You MUST use the 'cleanall' target (with FINAL=1 or FINAL=0)
152 before making a different configuration, because otherwise
153 object files used to build the previous configuration may be
2edb0bde 154 used accidentally for the current configuration. You might see
7fee680b
JS
155 this manifested in unexpected link errors or warnings. This problem
156 doesn't occur when using project files to build wxWindows.
ca5c8b2d 157
4dcd292c 158 To build Unicode versions of the libraries, add UNICODE=1
9a718b86 159 to the nmake invocation (default is UNICODE=0). If you want to
545d1e60 160 be able to use Unicode version on Windows9x, you will need
26a00631
VS
161 MSLU (Microsoft Layer for Unicode) runtime DLL and import lib.
162 The former can be downloaded from Microsoft, the latter is part
545d1e60 163 of the latest Platform SDK from Microsoft (see msdn.microsoft.com
26a00631
VS
164 for details). An alternative implementation of import library can
165 be downloaded from http://libunicows.sourceforge.net - unlike the
166 official one, this one works with other compilers and does not
167 require 300+ MB Platform SDK update. Add MSLU=1 to the nmake
168 invocation to enable MSLU.
4dcd292c 169
ca5c8b2d
JS
170 Note that the wxWindows core library allows you to have debug
171 and release libraries available simultaneously, by compiling the
172 objects in different subdirectories, whereas samples must be
7fee680b 173 cleaned and re-made to build a different configuration.
e2a6f233
JS
174
175To build the DLL version using makefiles:
176
9a718b86 1771. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll'
e2a6f233
JS
178 to make both a suitable DLL and import library, and to build a
179 suitable precompiled header file for compiling applications.
a40a9c81 180 See the previous section for library names.
ca5c8b2d
JS
1812. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
182 (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
183 applications).
e2a6f233 184
3f1af920 185Note (1): if you wish to use templates, please edit
025e88c5
JS
186include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
187Without this, the redefinition of 'new' will cause problems in
188the headers. Alternatively, #undef new before including template headers.
dbda9e86
JS
189You will also need to set wxUSE_IOSTREAMH to 0 if you will be
190using templates, to avoid the non-template stream files being included
191within wxWindows.
025e88c5 192
3f1af920 193Note (2): libraries and applications generated with makefiles and
5fa399c9
JS
194project files are now (hopefully) compatible where static libraries
195are concerned, but please exercise caution nevertheless and if
196possible, use one method or the other.
3f1af920 197
750b78ba 198Note (3): VC++ 5's optimization code seems to be broken and can
ad556aa9
JS
199cause both compile and run-time problems: this can be seen when
200deleting an object Dialog Editor, in Release mode with optimizations
201on. If in doubt, switch off optimisations, although this will result in much
750b78ba
JS
202larger executables. It seems possible that the library can be created with
203strong optimization, so long as the application is not strongly
204optimized. For example, in wxWindows project, set to 'Minimum
205Size'. In Dialog Editor project, set to 'Customize: Favor Small
206Code' (and no others). This will then work.
207
ad813b00
JS
208Note (4): some crash problems can be due to inconsistent compiler
209options. If strange/weird/impossible things start to happen please
210check (dumping IDE project file as makefile and doing text comparison
211if necessary) that the project settings, especially the list of defined
212symbols, struct packing, etc. are exactly the same for all items in
213the project. After this, delete everything (including PCH) and recompile.
214
a40a9c81 215Note (5): to create your own IDE files, see the technical note on the
9c6751aa 216wxWindows web site or CD-ROM, entitled "Compiling wxWindows
f6bcfd97
BP
217applications in the VC++ IDE" (technical note docs/tech/tn0010.htm in the
218wxWindows distribution). You can also copy .dsp and .dsw
9c6751aa
JS
219files from an existing wxWindows sample and adapt them.
220
545d1e60 221
8fb3a512
JS
222Visual C++ 1.5 compilation (16-bit)
223-----------------------------------
2bda0e17 224
9d1461a4 225No longer supported
a40a9c81 226
e2a6f233 227
9d1461a4 228Borland C++ 5.0/5.5 compilation
2bda0e17
KB
229-------------------------------
230
2b5f62a0 231Compiling using the makefiles (updated 24 Sept 02):
ca5c8b2d 232
9fce8d2e
JS
2331. Make sure your WXWIN variable is set [e.g add
234 set WXWIN=c:\wxwindows
2b5f62a0 235 to your autoexec.bat file], The WXWIN variable should contain neither spaces nor -
545d1e60 236 You may like to use the short form as shown by a dos directory listing ;
42280e48 237 eg instead of c:\wxwindows-2.5.0 use c:\wxwind~1.4
545d1e60 238 Reboot if needed for the changes to autoexec.bat to take effect.
19e9b919 2392. Change directory to src\msw. Type 'make -f makefile.b32' to
b7b45f6f
CE
240 make the wxWindows core library. Ignore the compiler warnings.
241 This produces a library in the wxwindows\lib directory called
242 wx32ds.lib
c0bcc480 2433. Change directory to a sample or demo such as samples\minimal, and type
b7b45f6f 244 'make -f makefile.b32'. This produces a windows exe file
4bf78aae
JS
2454. For release versions, recompile wxWindows and samples using
246 'make -f makefile.b32 clean'
247 'make -f makefile.b32 FINAL=1'
b7b45f6f
CE
248 for the library and samples. This produces a library wx32s.lib eliminating
249 all debugging information - if you wish to retain reduced debugging information
250 'make -f makefile.b32 clean'
251 'make -f makefile.b32 FINAL=hybrid'
252
f6bcfd97
BP
2535. To make and use wxWindows as a DLL, type
254 'make -f makefile.b32 clean'
255 'make -f makefile.b32 DLL=1'
545d1e60 256 which generates a DLL (wx32d.dll) and import library (wx32d.lib),
f6bcfd97
BP
257 and then for each sample,
258 'make -f makefile.b32 WXUSINGDLL=1'
259 Please note that the samples have not been exhaustively tested
b7b45f6f
CE
260 with this configuration. You may also generate a sepratae library
261 and second DLL using the commands
262 'make -f makefile.b32 clean'
263 'make -f makefile.b32 DLL=1 FINAL=1'
545d1e60 264 which generates a DLL (wx32.dll) and import library (wx32.lib),
b7b45f6f
CE
265 and then for each sample,
266 'make -f makefile.b32 WXUSINGDLL=1 FINAL=1'
267
2b5f62a0
VZ
2686. You can use the WXUNIVERSAL widgets instead of the native MSW
269 ones (eg if you want to build an application with the same
270 look and feel on all platforms)
025bbf5b 271 Use the command (in src\msw directory)
2b5f62a0
VZ
272 'make -f makefile.b32 WXUSINGUNIV=1'
273 Then run
274 'make -f makefile.b32 WXUSINGUNIV=1' in the sample directory which you wish
275 to build using the wxUniversal widgets. Use 'SET WXTHEME=GTK' [or WIN32 or METAL]
276 to test the existing themes
277 The makefile is written with the intention that you can build DLLs
278 and do final releases by combinations of commandline parameters.
279 At the time of writing, (Oct 02) not all the wxDialogs are working
280
025bbf5b
CE
2817. To use UNICODE for win2000 and XP systems edit wxWindows\wx\include\msw\setup.h
282 so that wxUSE_UNICODE is 1 instead of the default value of zero
283
2848. To make console mode applications with wxWindows functions go
b7b45f6f
CE
285 to the src\msw directory
286 'make -f makebase.b32 clean'
287 'make -f makebase.b32'
288 There is a sample\console directory and in this type
289 'make -f makefile.b32 wxUSE_GUI=0'
290
291Note (0): This provides the ability to produce separate wxwindows libraries
292 for different purposes, and only have to rebuild the applications
293
9d1461a4 294Note (1): the wxWindows makefiles assume byte structure alignment. Please
1a7f3062
JS
295make sure that your own project or makefile settings use the
296same alignment, or you could experience mysterious crashes. To
297change the alignment, add a suitable option to the $(CFG) target code
298in src/msw/makefile.b32.
299
9d1461a4 300Note (2): if you get undefined _SQL... symbols at link time,
154f22b3
JS
301either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
302directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
303recompile wxWindows. The same applies if compiling using the IDE.
304
790ad94f 305
9d1461a4 306Note (3): If you wish debug messages to be sent to the console in
7fee680b
JS
307debug mode, edit src\makeb32.env and change /aa to /Tpe in
308LINK_FLAGS.
309
9fce8d2e 310Compiling using the IDE files: [Borland C++ 5.0, not Cbuilder]
ca5c8b2d 311
9d1461a4
CE
3121. Load src\bc32.ide from the file bc32.zip at
313 http://biolpc22.york.ac.uk/pub/ports/bcc32/wxwin21/ and select Release settings
ca5c8b2d
JS
3142. Go to Options|Project... and specify the correct BC++ include and lib path for
315 your file structure.
3163. Press F9 to compile the wxWindows library.
33b64e6f 3174. Load samples\bc32.ide.
ca5c8b2d
JS
3185. Go to Options|Project... and specify the correct BC++ include and lib path for
319 your file structure.
01dba85a
JS
3206. Press F9 to compile the samples (build each node separately if
321 you prefer, by right clicking and choose Build Node).
3227. Run each sample: you may need to run from each sample's directory
323 since some (notably the wxHTML samples) look for files
324 relative to the working directory.
ca5c8b2d 325
c0bcc480
JS
326Note (1): the samples project file contains a selection of
327samples, and not all samples. The remaining samples can be made
328with the makefiles. See also the demos hierarchy which doesn't
329have any BC++ project files yet.
330
fb1bd1bd 331Note (2): to make the png, zlib, jpeg and tiff libraries (needed for
01dba85a 332some samples) you need to compile them with bc32.ide.
33b64e6f 333
c0bcc480
JS
334Note (3): the debug version of the wxWindows library is about 40 MB, and the
335release version is around 5 MB.
33b64e6f 336
f6bcfd97 337See also the file docs/tech/tn0007.txt for further instructions and details
ca5c8b2d
JS
338of how to create your own project files.
339
f6bcfd97
BP
340** REMEMBER **
341
545d1e60 342In all of your wxWindows applications, your source code should include
f6bcfd97
BP
343the following preprocessor directive:
344
345#ifdef __BORLANDC__
346#pragma hdrstop
347#endif
348
545d1e60
VZ
349(check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for
350more details)
351
f6bcfd97 352
9fce8d2e 353Borland C++Builder IDE compilation
545d1e60 354----------------------------------
4bf78aae 355
f6bcfd97 3561. Build the wxWindows libraries using the Borland make utility as
9d1461a4 357 specified in the section called "Borland C++ 5.0 compilation"
f6bcfd97
BP
358 above. (C++ Builder includes a stand-alone C++ compiler. For example,
359 C++ Builder 4.0 comes with C++ 5.4.)
3f1af920 360
9d1461a4 3612. You can use the process_sample_bcb.bat command which is in
9fce8d2e 362 wxwindows\distrib\msw to generate a .mak or .bpr file for most of the
025bbf5b
CE
363 samples [mak for Cbuilder 1-6; v4 and after will convert this to bpr].
364 Execute this in the sampledirectory, passing the name of the cpp files
365 on the command line. For more details, see the instructions in
366 docs/tech/tn0004.htm or http://biolpc22.york.ac.uk/wx/bc/ide.html.
9d1461a4
CE
367
368Borland 16 Bit compilation for Windows 3.1
369------------------------------------------
4bf78aae 370
9d1461a4
CE
371The last version of wxWindows to support 16-bit compilation with Borland was
3722.2.7 - Please download and read the instructions in that release
545d1e60
VZ
373
374Watcom C++ 10.6/11 and OpenWatcom compilation
375---------------------------------------------
7be1f0d9 376
cba2db0c
JS
3771. Make sure your WXWIN variable is set, and uses the DOS short
378 name form.
545d1e60 3792. Change directory to wx\src\msw. Type 'wmake -f makefile.wat' to
7be1f0d9 380 make the wxWindows core library.
545d1e60 3813. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
ace03f87
JS
382 to make this sample. Repeat for other samples of interest.
383
545d1e60
VZ
384
385There are several makefile variables which may be modified:
386
387- FINAL may be set to 1 (e.g. 'wmake -f makefile.wat FINAL=1') to build
388 the release version of the library, i.e. without debug info and with
389 optimizations enabled
390
391- WATCOM_SUFFIX is appended to the names of all libraries produced by the
392 makefile -- this allows to use several compilers in the same wxWindows
393 source tree. If you only use Watcom compiler, set WATCOM_SUFFIX to nothing.
394
395- OUTPUTDIR may be set to the name of the directory where you want all the
396 object files to be generated (the library files are always created in
dc7219d2
CE
397 %WXWIN\lib). Compilation will fail if you set it to an empty string
398 to create them in the same directory as the source. If you change OUTPUTDIR,
399 make sure that it does not have a trailing backslash!
400
401- In the samples, you may use EXEDIR=adir to build the samples in adir. Setting
402 EXEDIR=. will build in the current directory,
545d1e60
VZ
403
404
405Note (1): if your installation of Watcom doesn't have odbc32.lib file and
406 you need it (i.e. you have wxUSE_ODBC=1), you can use the file
407 from lib\watcom directory. See the notes in that directory.
408
409Note (2): if variant.cpp is compiled with date/time class options, the linker
410 gives up. So the date/time option is switched off for Watcom C++.
411 Also, wxAutomationObject is not compiled with Watcom C++ 10.
412
025bbf5b
CE
413Note (3): RawBitmaps won't work at present because they use unsupported template
414 classes
415
416Note (4): if Watcom can't read the precompiled header when building a sample,
545d1e60
VZ
417 try deleting src\msw\watcom.pch and compiling the sample again.
418
7be1f0d9 419
62448488
JS
420Metrowerks CodeWarrior compilation
421----------------------------------
422
545d1e60 4231. CodeWarrior Pro7 project files in XML format are already
42280e48 424 included in wxMSW-2.5.0.zip and the setup version.
545d1e60
VZ
4252. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if
426 you are working from the CVS version) to make sure the settings reflect
427 what you want. If you aren't sure, leave it alone and go with the
ba14d986
VZ
428 default settings. A few notes:
429 - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL
545d1e60 430 - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports
ba14d986
VZ
431 will be rather confusing due to interactions with the MSL ANSI
432 and runtime libs.
545d1e60
VZ
4333. The project file to build the Win32 wxWindows libraries relies on the
434 Batch File Runner plug-in. This plug-in is not installed as part of
435 a normal CW7 installation. However, you can find this plug-in on the
436 CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the
437 "Batch File Post Linker".
4384. If you choose not to install the Batch File Runner plug-in, then you
ba14d986 439 need to do the following by hand:
545d1e60
VZ
440 (1) Create the directories lib\cw7msw\include\wx and copy the file
441 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
ba14d986 442 working from the CVS version) to lib\cw7msw\include\wx\setup.h
545d1e60
VZ
443 (2) Create the directories lib\cw7mswd\include\wx and copy the file
444 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
ba14d986 445 working from the CVS version) to lib\cw7mswd\include\wx\setup.h
73c3b37b 4465. Import src\wxWindowsW7.xml to create the project file wxWindowsW7.mcp.
545d1e60
VZ
447 Store this project file in directory src. You may get warnings about
448 not being able to find certain project paths; ignore these warnings, the
ba14d986 449 appropriate paths will be created during the build by the Batch File Runner.
545d1e60
VZ
4506. Choose the wxlib Win32 debug or wxlib Win32 Release target and build. You
451 will get some warnings about hidden virtual functions, illegal conversions
ba14d986 452 from const pointers to pointers, etc., all of which you can safely ignore.
545d1e60
VZ
453 ***Note: if you get errors that the compiler can't find "wx/setup.h", just
454 stop the build and build again. These errors occur because sometimes the
ba14d986
VZ
455 compiler starts doing its thing before the copying of setup.h has completed.
4567. The following libraries will be produced depending on chosen
457 target:
458 - wx_x86.lib ANSI Release (static)
459 - wx_x86_d.lib ANSI Debug (static)
4608. Sorry, I haven't had time yet to create and test unicode or DLL versions.
545d1e60 461 Volunteers for this are welcome (as neither DLLs nor unicode builds are
ba14d986 462 big priorities for me ;).
545d1e60
VZ
4639. CodeWarrior Pro7 project files (in XML format) are also provided for some
464 of the samples. In particular, there are project files for the minimal,
465 controls, dialogs, dnd, nd docview samples. You can use these project
466 files as templates for the other samples and for your own projects.
467 - For example, to make a project file for the "newgrid" sample,
468 just copy the project file for the "minimal" sample, minimalW7.mcp
469 (made by importing minimalW7.xml into CodeWarrior), into the
470 sample/newgrid directory, calling it newgridW7.mcp. Open
471 newgridW7.mcp and revise the project by deleting the files
472 minimal.rc and minimal.cpp and adding the files griddemo.rc and
73c3b37b 473 griddemo.cpp. Build and run....
62448488 474
545d1e60 475
9a718b86 476Cygwin/MinGW compilation
545d1e60 477------------------------
2bda0e17 478
74afbadc 479wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
9a718b86 480releases, and MinGW. Cygwin can be downloaded from:
6500c0b1 481
9a718b86 482 http://sources.redhat.com/cygwin/
2bda0e17 483
9a718b86 484and MinGW from:
6500c0b1 485
9a718b86 486 http://www.mingw.org/
2bda0e17 487
9a718b86 488Both Cygwin and MinGW can be used with the same makefiles, and both can be
545d1e60
VZ
489used with configure. However the (strongly) preferred way to build wxWindows
490is using configure with Cygwin and using the makefiles with MinGW as these
491configurations are test much more often than the remaining two and so are much
492more likely to work out of the box.
493
4dcd292c 494
9a718b86
MB
495NOTE: some notes specific to old Cygwin (< 1.1.x)
496 and MinGW (< 1.0) are at the end of this section
497 (see OLD VERSIONS)
2bda0e17 498
7666ad49
JS
499There are two methods of compiling wxWindows, by using the
500makefiles provided or by using 'configure'.
2bda0e17 501
9a718b86 502Retrieve and install the latest version of Cygwin, or MinGW, as per
6500c0b1
JS
503the instructions with either of these packages.
504
9a718b86 505If using MinGW, you can download the add-on MSYS package to
6500c0b1 506provide Unix-like tools that you'll need to build wxWindows.
9a718b86 507If you do not want to use MSYS, then you need to download extra utilities from
6500c0b1 508ports/mingw32 on the wxWindows ftp site or CD-ROM:
7666ad49 509
2b5f62a0 510 ftp://biolpc22.york.ac.uk/pub/ports/mingw32/extra.zip
545d1e60
VZ
511
512These should be extracted to a directory in your path. If you have
6500c0b1
JS
513already downloaded rm, cp, mv from elsewhere, or are using
514MSYS, you won't need all of these files. However if using MSYS
515and configure to build wxWindows, you will need to unzip the
516following files from extra.zip and place them in e.g. an
517extrabin directory which you then add to your path:
7666ad49 518
6500c0b1
JS
519 bison.exe bison.hairy bison.simple flex.exe
520
521You will also need to set these variables:
522
523 set BISON_SIMPLE=c:\apps\mingw2.0.0-3\extrabin\bison.simple
524 set BISON_HAIRY=c:\apps\mingw2.0.0-3\extrabin\bison.hairy
525
526Here we're setting them in DOS before invoking 'sh', but you
527could set them within the shell instead.
528
529The 'configure' method uses flex and bison, whereas the
530direct makefile method uses pregenerated C files.
531
532Using makefiles directly
533========================
7666ad49 534
02fd5400
MB
535NOTE: The makefile are for compilation under Cygwin, MSYS, or
536 command.com/cmd.exe, they won't work in other environments
537 (such as UNIX)
538
7666ad49 539Here are the steps required using the provided makefiles:
8870c26e 540
dbda9e86 541- Set your WXWIN variable to where wxWindows is installed.
9a718b86 542 *** IMPORTANT: For Cygwin/MinGW, use forward slashes in the path, not
25889d3c 543 backslashes.
dbda9e86 544
6500c0b1 545- Edit src/makeg95.env and set the MINGW32 variable at the top of
9a718b86
MB
546 the file to either 1 (you have MinGW) or 0 (if you have
547 Cygwin); also set the MINGW32VERSION variable appropriately for your
548 GCC version.
6500c0b1 549
2bda0e17 550- Use the makefile.g95 files for compiling wxWindows and samples,
4dcd292c 551 e.g. to compile a debugging version of wxWindows:
2bda0e17 552 > cd c:\wx\src\msw
02fd5400 553 > make -f makefile.g95 clean
2bda0e17
KB
554 > make -f makefile.g95
555 > cd c:\wx\samples\minimal
02fd5400 556 > make -f makefile.g95 cleanall
2bda0e17
KB
557 > make -f makefile.g95
558
4dcd292c
MB
559 to compile with optimizations:
560 > cd c:\wx\src\msw
02fd5400 561 > make -f makefile.g95 clean
4dcd292c
MB
562 > make -f makefile.g95 FINAL=1
563 > cd c:\wx\samples\minimal
02fd5400 564 > make -f makefile.g95 cleanall
4dcd292c
MB
565 > make -f makefile.g95 FINAL=1
566
567 to compile a DLL:
568 > cd c:\wx\src\msw
02fd5400 569 > make -f makefile.g95 clean
4dcd292c
MB
570 > make -f makefile.g95 WXMAKINGDLL=1
571 > cd c:\wx\samples\minimal
02fd5400 572 > make -f makefile.g95 cleanall
4dcd292c
MB
573 > make -f makefile.g95 WXUSINGDLL=1
574
575 to compile the Unicode version:
576 > cd c:\wx\src\msw
02fd5400 577 > make -f makefile.g95 clean
4dcd292c
MB
578 > make -f makefile.g95 UNICODE=1
579 > cd c:\wx\samples\minimal
02fd5400 580 > make -f makefile.g95 cleanall
4dcd292c
MB
581 > make -f makefile.g95 UNICODE=1
582
9a718b86 583 Options can be combined (e.g.: UNICODE=1 FINAL=1)
4dcd292c 584
cba2db0c
JS
585 Ignore the warning about the default entry point.
586
9a718b86
MB
587- Use the 'strip' command to reduce executable/dll size (note that
588 stripping an executable/dll will remove debug information!).
2bda0e17 589
74afbadc 590- With Cygwin, you can invoke gdb --nw myfile.exe to
4fabb575 591 debug an executable. If there are memory leaks, they will be
4dcd292c
MB
592 flagged when the program quits. You can use Cygwin gdb
593 to debug MinGW executables.
2bda0e17
KB
594
595All targets have 'clean' targets to allow removal of object files
4dcd292c
MB
596and other intermediate compiler files and 'cleanall' targets to
597allow removal of all object files and library files.
2bda0e17 598
7666ad49
JS
599Using configure
600===============
601
602Instead of using the makefiles, you can use the configure
603system to generate appropriate makefiles, as used on Unix
604and Mac OS X systems.
605
606Change directory to the root of the wxWindows distribution,
9a718b86 607make a build directory, and run configure and make in this directory.
7666ad49
JS
608
609For example:
610
611 cd $WXWIN
612 mkdir build-debug
613 cd build-debug
614 ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared
615 make
c5f53eb8 616 make install % This step is optional, see note (8) below.
7666ad49
JS
617 cd samples/minimal
618 make
619 ./minimal.exe
620
7c5dc04f 621Notes:
2bda0e17 622
9a718b86 6231. See also the Cygwin/MinGW on the web site or CD-ROM for
bf4d9b2b 624 further information about using wxWindows with these compilers.
7c5dc04f 625
6b978929 6262. libwx.a is 100 MB or more - but much less if compiled with no
bf4d9b2b 627 debug info (-g0) and level 4 optimization (-O4).
7c5dc04f 628
9a718b86 6293. If you get a link error under MinGW 2.95.2 referring to:
6b978929
JS
630
631 EnumDAdvise__11IDataObjectPP13IEnumSTATDATA@8
632
633 then you need to edit the file objidl.h at line 663 and add
634 a missing PURE keyword:
635
636 STDMETHOD(EnumDAdvise)(THIS_ IEnumSTATDATA**) PURE;
637
9a718b86 6384. There's a bug in MinGW headers for some early distributions.
7c5dc04f 639
bf4d9b2b 640 in include/windows32/defines.h, where it says:
7c5dc04f 641
bf4d9b2b 642 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
7c5dc04f 643
bf4d9b2b 644 it should say:
7c5dc04f 645
bf4d9b2b 646 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
7c5dc04f 647
bf4d9b2b 648 (a missing bracket).
7c5dc04f 649
6b978929 6505. If there's a problem with the copy or remove commands in
bf4d9b2b 651 src/msw/makefile.g95, you may need to change the COPY and
f6bcfd97 652 RM variables in makeg95.env.
51babd09 653
6b978929 6546. If there's a problem executing the windres program, try
bf4d9b2b 655 commenting out RCPREPROCESSOR in makeg95.env.
51babd09 656
9a718b86 6577. OpenGL support should work with MinGW as-is. However,
fac26663
JS
658 if you wish to generate import libraries appropriate either for
659 the MS OpenGL libraries or the SGI OpenGL libraries, go to
660 include/wx/msw/gl and use:
661
662 dlltool -k -d opengl.def -llibopengl.a
663
664 for the SGI DLLs, or
665
666 dlltool -k -d opengl32.def -llibopengl32.a
667
668 and similarly for glu[32].def.
669
c5f53eb8
JS
6708. The 'make install' step is optional, and copies files
671 as follows:
672
673 /usr/local/lib - wxmswXYZd.dll.a and wxmswXYZd.dll
674 /usr/local/include/wx - wxWindows header files
675 /usr/local/bin - wx-config
676
677 You may need to do this if using wx-config with the
678 default root path.
679
4dcd292c
MB
680OLD VERSIONS:
681
9a718b86 682- If using MinGW 2.95 and below with wxWindows 2.1 or above, you
4dcd292c 683 must hand-patch with Mingw32-gcc295.patches (located in the
9a718b86 684 top-level of the wxWindows 2 installation). MinGW 2.95.2
4dcd292c
MB
685 and above contain the fixes already.
686
687- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
688 to set up appropriate variables, if necessary mounting drives.
689 Run it before compiling.
690
691- For Cygwin, make sure there's a \tmp directory on your
692 Windows drive or bison will crash (actually you don't need
693 bison for ordinary wxWindows compilation: a pre-generated .c file is
694 supplied).
695
4dcd292c 696- If using GnuWin32 b18, you will need to copy windres.exe
9a718b86 697 from e.g. the MinGW distribution, to a directory in your path.
4dcd292c 698
545d1e60 699
ce8897bb 700Symantec & DigitalMars C++ compilation
6500c0b1 701------------------------
ce8897bb
CE
702The DigitalMars compiler is a free succssor to the Symantec compiler
703and can be downloaded from http://www.digitalmars.com/
025bbf5b
CE
704
7051. You need to download and unzip in turn (later packages will oevrwrite older files)
706 Digital Mars C/C++ Compiler Version 8.33
707 Basic utilities
708 beta test C++ Compiler Version 8.34
709 from http://www.digitalmars.com/download/freecompiler.html [02 may 03, CE]
710
7112. Make sure your WXWIN variable is set, and uses the FAT (short
6500c0b1 712 name) form.
025bbf5b 713
6500c0b1
JS
7143. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
715 make the wxWindows core library.
7164. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
025bbf5b
CE
717 to make this sample. The mdi and image sample also work; others may give
718 linker erros due to missing libraries
2bda0e17 719
ce8897bb 72016-bit compilation is no longer supported.
6500c0b1 721
545d1e60 722
6500c0b1
JS
723Salford C++ compilation
724-----------------------
725
7261. Make sure your WXWIN variable is set, and uses the FAT (short
727 name) form.
7282. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
729 notes.
7303. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
731 make the wxWindows core library.
7324. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
733 to make this sample.
734
735Unfortunately, Salford C++ seems to have problems with its code generation for
736operations on objects, as seen in wxFrame::OnMenuHighlight
737(minimal sample) or wxWindow::SetValidator (mdi sample). Also the
738the debugging version of the library is 90MB, with samples coming in
739at 40MB :-) However, wxWindows at least makes a good test suite for
740improving the compiler.
2bda0e17 741
545d1e60 742
57c208c5
JS
743TWIN32 and gcc on Linux
744-----------------------
745
746The wxWindows 2 for Windows port may be compiled using
747the TWIN32 emulator package from www.willows.com. However,
748TWIN32 is by no means finished so this should be taken as
749something to think about for the future, rather than
750a tool for writing products with.
751
752Use makefile.twn in much the same way as makefile.g95, as
753described above. Not all sample makefiles are supplied yet.
754
8870c26e
JS
755For some reason, I found I had to copy TWIN32's Windows resource
756compiler (rc) to the current working directory for it to be found.
757
545d1e60 758
8870c26e
JS
759General Notes
760-------------
a0a302dc
JS
761
762- Debugging: under Windows 95, debugging output isn't output in
9c6751aa
JS
763 the same way that it is under NT or Windows 3.1.
764 Please see DebugView (bin/dbgview.exe in the distribution), also
765 available from http://www.sysinternals.com and on the wxWindows CD-ROM
766 under Packages.
62448488 767
e3065973
JS
768- If you are installing wxWindows 2 from CVS, you may find that
769 include/wx/msw/setup.h is missing. This is deliberate, to avoid
770 developers' different setup.h configurations getting confused.
f6bcfd97
BP
771 Please copy setup0.h to setup.h before compiling. Also, read
772 the BuildCVS.txt for other hints.
bf4d9b2b 773