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