]>
Commit | Line | Data |
---|---|---|
1 | Installing wxWidgets 2.6.0 | |
2 | ----------------------------------------------------------- | |
3 | ||
4 | This is wxWidgets 2.6.0 for Microsoft Windows 9x/ME, Windows NT, | |
5 | Windows 2000, Windows XP and Windows CE. | |
6 | ||
7 | These installation notes can be found in docs/msw/install.txt | |
8 | in your wxWidgets distribution. | |
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 | Unarchiving | |
23 | ============================================================ | |
24 | ||
25 | A setup program is provided (setup.exe) to automatically copy | |
26 | files to a directory on your hard disk. Do not install into a | |
27 | path that contains spaces. | |
28 | ||
29 | The setup program contains the following: | |
30 | ||
31 | - All common, generic and MSW-specific wxWidgets source; | |
32 | - samples and demos; | |
33 | - documentation in MS HTML Help format; | |
34 | - makefiles for most Windows compilers, plus CodeWarrior, | |
35 | BC++ and VC++ IDE files; | |
36 | - JPEG library source; | |
37 | - TIFF library source; | |
38 | - Object Graphics Library, Tex2RTF, wxSTC, etc. | |
39 | ||
40 | Alternatively, you may unarchive the .zip form by hand: | |
41 | wxMSW-x.y.z.zip where x.y.z is the version number. | |
42 | ||
43 | Unarchive the required files plus any optional documentation | |
44 | files into a suitable directory such as c:\wx. | |
45 | ||
46 | General installation notes | |
47 | ========================== | |
48 | ||
49 | If installing from the CVS server, copy include/wx/msw/setup0.h to | |
50 | include/wx/msw/setup.h and edit the resulting file to choose | |
51 | the features you would like to compile wxWidgets with[out]. | |
52 | ||
53 | Compilation | |
54 | =========== | |
55 | ||
56 | The following sections explain how to compile wxWidgets with each supported | |
57 | compiler. Search for one of Microsoft/Borland/Watcom/Symantec/Metrowerks/ | |
58 | Cygwin/Mingw32 to quickly locate the instructions for your compiler. | |
59 | ||
60 | All makefiles and project are located in build\msw directory. | |
61 | ||
62 | Where compiled files are stored | |
63 | ------------------------------- | |
64 | ||
65 | After successful compilation you'll find the libraries in a subdirectory | |
66 | of lib directory named after the compiler and DLL/static settings. | |
67 | A couple of examples: | |
68 | ||
69 | lib\vc_lib VC++ compiled static libraries | |
70 | lib\vc_dll VC++ DLLs | |
71 | lib\bcc_lib Static libraries for Borland C++ | |
72 | lib\wat_dll Watcom C++ DLLs | |
73 | ||
74 | Names of compiled wxWidgets libraries follow this scheme: libraries that don't | |
75 | depend on GUI components begin with "wxbase" followed by version number and | |
76 | letters indicating if the library is compiled as Unicode ('u') and/or debug | |
77 | build ('d'). Last component of them name is name of wxWidgets component | |
78 | (unless you built the library as single monolithic library; look for | |
79 | "Configuring the build" below). This is a typical set of release ANSI build | |
80 | libraries (release versions on left, debug on right side): | |
81 | ||
82 | wxbase25.lib wxbase25d.lib | |
83 | wxbase25_net.lib wxbase25d_net.lib | |
84 | wxbase25_xml.lib wxbase25d_xml.lib | |
85 | wxmsw25_core.lib wxmsw25d_core.lib | |
86 | wxmsw25_html.lib wxmsw25d_html.lib | |
87 | wxmsw25_adv.lib wxmsw25d_adv.lib | |
88 | ||
89 | Their Unicode debug counterparts in wxUniversal build would be | |
90 | ||
91 | wxbase25ud.lib | |
92 | wxbase25ud_net.lib | |
93 | wxbase25ud_xml.lib (notice these libs are same for wxUniv and wxMSW) | |
94 | wxmswuniv25ud_core.lib | |
95 | wxmswuniv25ud_html.lib | |
96 | wxmswuniv25ud_adv.lib | |
97 | ||
98 | These directories also contain subdirectory with wx/setup.h header. This | |
99 | subdirectory is named after port, Unicode, wxUniv and debug settings and | |
100 | you must add it to include paths when compiling your application. Some | |
101 | examples: | |
102 | ||
103 | lib\vc_lib\msw\wx\setup.h VC++ static, wxMSW | |
104 | lib\vc_lib\mswud\wx\setup.h VC++ static, wxMSW, Unicode, debug | |
105 | lib\vc_lib\mswunivd\wx\setup.h VC++ static, wxUniversal, debug | |
106 | ||
107 | Below are compiler specific notes followed by customizing instructions that | |
108 | apply to all compilers (search for "Configuring the build"). | |
109 | ||
110 | Microsoft Visual C++ compilation | |
111 | ---------------------------------------------------------------- | |
112 | ||
113 | You may wish to visit http://wiki.wxwindows.org/wiki.pl?MSVC for a more | |
114 | informal and more detailed description of the process summarized below. | |
115 | ||
116 | Please note that the VC++ 6.0 project files will work for VC++ .NET also. | |
117 | ||
118 | Also note that you can make the project files work with VC++ 5.0 but you'll | |
119 | need to edit .dsp file by hand before this is possible (change the version in | |
120 | the .dsp file header from 6.0 to 5.0). | |
121 | ||
122 | Using project files (VC++ 6 and later): | |
123 | ||
124 | 1. Unarchive wxWidgets-x.y.z-vc.zip, the VC++ 6 project | |
125 | makefiles (already included in wxMSW-x.y.z.zip and the setup version). | |
126 | 2. Open build\msw\wx.dsw, which has configurations for static | |
127 | compilation or DLL compilation, and each of these available in | |
128 | Unicode/ANSI, Debug/Release and wxUniversal or native variations. | |
129 | Normally you'll use a static linking ANSI configuration. | |
130 | Choose the Win32 Debug or Win32 Release configuration (or any other that | |
131 | suits your needs) and use Batch Build to compile _all_ projects. If you | |
132 | know you won't need some of the libraries (i.e. html part), you don't have | |
133 | to compile it. It will also produce similar variations on jpeg.lib, | |
134 | png.lib, tiff.lib, zlib.lib, and regex.lib. | |
135 | If you want to build DLLs, you have to either build them one by one in | |
136 | proper order (jpeg, png, tiff, zlib, regex, expat, base, core, the rest | |
137 | in any order) or to use wx_dll.dsw workspace which has correct dependencies. | |
138 | 3. Open a sample project file, choose a configuration such as | |
139 | Win32 Debug using Build | Set Active Configuration..., and compile. | |
140 | The project files don't use precompiled headers, to save disk | |
141 | space, but you can switch PCH compiling on for greater speed. | |
142 | NOTE: you may also use samples/samples.dsw to access all | |
143 | sample projects without opening each workspace individually. | |
144 | You can use the Batch Build facility to make several samples | |
145 | at a time. | |
146 | ||
147 | Using makefiles: | |
148 | ||
149 | 1. Change directory to build\msw. Type: | |
150 | ||
151 | 'nmake -f makefile.vc' | |
152 | ||
153 | to make the wxWidgets core library as release DLL. | |
154 | See "Configuring the build" for instruction how to build debug or static | |
155 | libraries. | |
156 | ||
157 | 2. Change directory to samples and type 'nmake -f makefile.vc' | |
158 | to make all the samples. You can also make them individually. | |
159 | ||
160 | Makefile notes: | |
161 | ||
162 | Use the 'clean' target to clean all objects, libraries and | |
163 | executables. | |
164 | ||
165 | Note (1): if you wish to use templates, please edit | |
166 | include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0. | |
167 | Without this, the redefinition of 'new' will cause problems in | |
168 | the headers. Alternatively, #undef new before including template headers. | |
169 | You will also need to set wxUSE_IOSTREAMH to 0 if you will be | |
170 | using templates, to avoid the non-template stream files being included | |
171 | within wxWidgets. | |
172 | ||
173 | Note (2): libraries and applications generated with makefiles and | |
174 | project files are now (hopefully) compatible where static libraries | |
175 | are concerned, but please exercise caution nevertheless and if | |
176 | possible, use one method or the other. | |
177 | ||
178 | Note (3): some crash problems can be due to inconsistent compiler | |
179 | options. If strange/weird/impossible things start to happen please | |
180 | check (dumping IDE project file as makefile and doing text comparison | |
181 | if necessary) that the project settings, especially the list of defined | |
182 | symbols, struct packing, etc. are exactly the same for all items in | |
183 | the project. After this, delete everything (including PCH) and recompile. | |
184 | ||
185 | Note (4): to create your own IDE files, copy .dsp and .dsw | |
186 | files from an existing wxWidgets sample and adapt them, or | |
187 | visit http://wiki.wxwindows.org/wiki.pl?MSVC. | |
188 | ||
189 | Borland C++ 5.0/5.5 compilation | |
190 | ---------------------------------------------------------------- | |
191 | ||
192 | Compiling using the makefiles (updated 24 Sept 02): | |
193 | ||
194 | 1. Change directory to build\msw. Type 'make -f makefile.bcc' to | |
195 | make the wxWidgets core library. Ignore the compiler warnings. | |
196 | This produces a couple of libraries in the lib\bcc_lib directory. | |
197 | ||
198 | 2. Change directory to a sample or demo such as samples\minimal, and type | |
199 | 'make -f makefile.bcc'. This produces a windows exe file - by default | |
200 | in the bcc_mswd subdirectory. | |
201 | ||
202 | Note (1): the wxWidgets makefiles assume dword structure alignment. Please | |
203 | make sure that your own project or makefile settings use the | |
204 | same alignment, or you could experience mysterious crashes. To | |
205 | change the alignment, change CPPFLAGS in build\msw\config.bcc. | |
206 | ||
207 | Note (2): if you get undefined _SQL... symbols at link time, | |
208 | either install odbc32.lib from the BC++ CD-ROM into your BC++ lib | |
209 | directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and | |
210 | recompile wxWidgets. The same applies if compiling using the IDE. | |
211 | ||
212 | Note (3): If you wish debug messages to be sent to the console in | |
213 | debug mode, edit makefile.bcc and change /aa to /Tpe in link commands. | |
214 | ||
215 | Compiling using the IDE files for Borland C++ 5.0: not supported - please | |
216 | use version 2.4.1 (using the make utility in commandline mode works fine_ | |
217 | ||
218 | Compiling using CBuilder (v1-v6): not supported - please | |
219 | use version 2.4.1 (using the make utility in commandline mode works fine_ | |
220 | ||
221 | ** REMEMBER ** | |
222 | ||
223 | In all of your wxWidgets applications, your source code should include | |
224 | the following preprocessor directive: | |
225 | ||
226 | #ifdef __BORLANDC__ | |
227 | #pragma hdrstop | |
228 | #endif | |
229 | ||
230 | (check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for | |
231 | more details) | |
232 | ||
233 | Borland 16 Bit compilation for Windows 3.1 | |
234 | ---------------------------------------------------------------- | |
235 | ||
236 | The last version of wxWidgets to support 16-bit compilation with Borland was | |
237 | 2.2.7 - Please download and read the instructions in that release | |
238 | ||
239 | Watcom C++ 10.6/11 and OpenWatcom compilation | |
240 | ---------------------------------------------------------------- | |
241 | ||
242 | 1. Change directory to build\msw. Type 'wmake -f makefile.wat' to | |
243 | make the wxWidgets core library. | |
244 | ||
245 | 2. Change directory to samples\minimal and type 'wmake -f makefile.wat' | |
246 | to make this sample. Repeat for other samples of interest. | |
247 | ||
248 | Note (1): if your installation of Watcom doesn't have odbc32.lib file and | |
249 | you need it (i.e. you have wxUSE_ODBC=1), you can use the file | |
250 | from lib\watcom directory. See the notes in that directory. | |
251 | ||
252 | Note (2): if variant.cpp is compiled with date/time class options, the linker | |
253 | gives up. So the date/time option is switched off for Watcom C++. | |
254 | Also, wxAutomationObject is not compiled with Watcom C++ 10. | |
255 | ||
256 | Note (3): RawBitmaps won't work at present because they use unsupported template | |
257 | classes | |
258 | ||
259 | Note (4): if Watcom can't read the precompiled header when building a sample, | |
260 | try deleting .pch files in build\msw\wat_* and compiling | |
261 | the sample again. | |
262 | ||
263 | Metrowerks CodeWarrior compilation | |
264 | ---------------------------------------------------------------- | |
265 | ||
266 | 1. CodeWarrior Pro 7 project files in XML format are already | |
267 | included in wxMSW-2.6.0.zip and the setup version. | |
268 | ||
269 | 2. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if | |
270 | you are working from the CVS version) to make sure the settings reflect | |
271 | what you want. If you aren't sure, leave it alone and go with the | |
272 | default settings. A few notes: | |
273 | - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL | |
274 | - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports | |
275 | will be rather confusing due to interactions with the MSL ANSI | |
276 | and runtime libs. | |
277 | ||
278 | 3. The project file to build the Win32 wxWidgets libraries relies on the | |
279 | Batch File Runner plug-in. This plug-in is not installed as part of | |
280 | a normal CW7 installation. However, you can find this plug-in on the | |
281 | CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the | |
282 | "Batch File Post Linker". | |
283 | ||
284 | 4. If you choose not to install the Batch File Runner plug-in, then you | |
285 | need to do the following by hand: | |
286 | (1) Create the directories lib\cw7msw\include\wx and copy the file | |
287 | include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are | |
288 | working from the CVS version) to lib\cw7msw\include\wx\setup.h | |
289 | (2) Create the directories lib\cw7mswd\include\wx and copy the file | |
290 | include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are | |
291 | working from the CVS version) to lib\cw7mswd\include\wx\setup.h | |
292 | ||
293 | 5. Import src\wxWidgetsW7.xml to create the project file wxWidgetsW7.mcp. | |
294 | Store this project file in directory src. You may get warnings about | |
295 | not being able to find certain project paths; ignore these warnings, the | |
296 | appropriate paths will be created during the build by the Batch File Runner. | |
297 | ||
298 | 6. Choose the wxlib Win32 debug or wxlib Win32 Release target and build. You | |
299 | will get some warnings about hidden virtual functions, illegal conversions | |
300 | from const pointers to pointers, etc., all of which you can safely ignore. | |
301 | ***Note: if you get errors that the compiler can't find "wx/setup.h", just | |
302 | stop the build and build again. These errors occur because sometimes the | |
303 | compiler starts doing its thing before the copying of setup.h has completed. | |
304 | ||
305 | 7. The following libraries will be produced depending on chosen | |
306 | target: | |
307 | - wx_x86.lib ANSI Release (static) | |
308 | - wx_x86_d.lib ANSI Debug (static) | |
309 | ||
310 | 8. Sorry, I haven't had time yet to create and test unicode or DLL versions. | |
311 | Volunteers for this are welcome (as neither DLLs nor unicode builds are | |
312 | big priorities for me ;). | |
313 | ||
314 | 9. CodeWarrior Pro7 project files (in XML format) are also provided for some | |
315 | of the samples. In particular, there are project files for the minimal, | |
316 | controls, dialogs, dnd, nd docview samples. You can use these project | |
317 | files as templates for the other samples and for your own projects. | |
318 | - For example, to make a project file for the "grid" sample, | |
319 | just copy the project file for the "minimal" sample, minimalW7.mcp | |
320 | (made by importing minimalW7.xml into CodeWarrior), into the | |
321 | sample/grid directory, calling it gridW7.mcp. Open | |
322 | newgridW7.mcp and revise the project by deleting the files | |
323 | minimal.rc and minimal.cpp and adding the files griddemo.rc and | |
324 | griddemo.cpp. Build and run.... | |
325 | ||
326 | ||
327 | Cygwin/MinGW compilation | |
328 | ---------------------------------------------------------------- | |
329 | ||
330 | wxWidgets supports Cygwin (formerly GnuWin32) betas and | |
331 | releases, and MinGW. Cygwin can be downloaded from: | |
332 | ||
333 | http://sources.redhat.com/cygwin/ | |
334 | ||
335 | and MinGW from: | |
336 | ||
337 | http://www.mingw.org/ | |
338 | ||
339 | Both Cygwin and MinGW can be used with configure (assuming you have MSYS | |
340 | installed in case of MinGW). You will need new enough MinGW version, preferably | |
341 | MinGW 2.0 (ships with gcc3) or at least 1.0 (gcc-2.95.3). GCC versions older | |
342 | than 2.95.3 don't work; you can use wxWidgets 2.4 with them. | |
343 | ||
344 | NOTE: some notes specific to old Cygwin (< 1.1.x) are at the end of this | |
345 | section (see OLD VERSIONS) | |
346 | ||
347 | There are two methods of compiling wxWidgets, by using the | |
348 | makefiles provided or by using 'configure'. | |
349 | ||
350 | Retrieve and install the latest version of Cygwin, or MinGW, as per | |
351 | the instructions with either of these packages. | |
352 | ||
353 | If using MinGW, you can download the add-on MSYS package to | |
354 | provide Unix-like tools that you'll need to build wxWidgets using configure. | |
355 | ||
356 | Using makefiles directly | |
357 | ---------------------------------------------------------------- | |
358 | ||
359 | NOTE: The makefile.gcc makefiles are for compilation under MinGW using | |
360 | native make and Windows command interpreter (command.com/cmd.exe), they | |
361 | won't work in other environments (such as UNIX or Unix-like, e.g. MSYS; | |
362 | you have to use configure instead) | |
363 | ||
364 | Here are the steps required using the provided makefiles: | |
365 | ||
366 | - If you are using gcc-2.95, edit build\msw\config.gcc and set the GCC_VERSION | |
367 | variable to "2.95". | |
368 | ||
369 | - If you are compiling with GCC 3.x using makefiles and with wxUSE_STL == 1 | |
370 | you need to manually add -DNO_GCC_PRAGMA to CXXFLAGS in config.gcc. | |
371 | ||
372 | - Use the makefile.gcc files for compiling wxWidgets and samples, | |
373 | e.g. to compile a debugging version of wxWidgets: | |
374 | > cd c:\wx\build\msw | |
375 | > make -f makefile.gcc BUILD=debug | |
376 | > cd c:\wx\samples\minimal | |
377 | > make -f makefile.gcc BUILD=debug | |
378 | (See below for more options.) | |
379 | ||
380 | Ignore the warning about the default entry point. | |
381 | ||
382 | - Use the 'strip' command to reduce executable/dll size (note that | |
383 | stripping an executable/dll will remove debug information!). | |
384 | ||
385 | All targets have 'clean' targets to allow removal of object files | |
386 | and other intermediate compiler files. | |
387 | ||
388 | Using configure | |
389 | ---------------------------------------------------------------- | |
390 | ||
391 | Instead of using the makefiles, you can use the configure | |
392 | system to generate appropriate makefiles, as used on Unix | |
393 | and Mac OS X systems. | |
394 | ||
395 | Change directory to the root of the wxWidgets distribution, | |
396 | make a build directory, and run configure and make in this directory. | |
397 | ||
398 | For example: | |
399 | ||
400 | cd $WXWIN | |
401 | mkdir build-debug | |
402 | cd build-debug | |
403 | ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared | |
404 | make | |
405 | make install % This step is optional, see note (8) below. | |
406 | cd samples/minimal | |
407 | make | |
408 | ./minimal.exe | |
409 | ||
410 | Notes: | |
411 | ||
412 | 1. See also the Cygwin/MinGW on the web site or CD-ROM for | |
413 | further information about using wxWidgets with these compilers. | |
414 | ||
415 | 2. libwx.a is 100 MB or more - but much less if compiled with no | |
416 | debug info (-g0) and level 4 optimization (-O4). | |
417 | ||
418 | 3. If you get a link error under MinGW 2.95.2 referring to: | |
419 | ||
420 | EnumDAdvise__11IDataObjectPP13IEnumSTATDATA@8 | |
421 | ||
422 | then you need to edit the file objidl.h at line 663 and add | |
423 | a missing PURE keyword: | |
424 | ||
425 | STDMETHOD(EnumDAdvise)(THIS_ IEnumSTATDATA**) PURE; | |
426 | ||
427 | 4. There's a bug in MinGW headers for some early distributions. | |
428 | ||
429 | in include/windows32/defines.h, where it says: | |
430 | ||
431 | #define LPSTR_TEXTCALLBACKA (LPSTR)-1L) | |
432 | ||
433 | it should say: | |
434 | ||
435 | #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L) | |
436 | ||
437 | (a missing bracket). | |
438 | ||
439 | 5. OpenGL support should work with MinGW as-is. However, | |
440 | if you wish to generate import libraries appropriate either for | |
441 | the MS OpenGL libraries or the SGI OpenGL libraries, go to | |
442 | include/wx/msw/gl and use: | |
443 | ||
444 | dlltool -k -d opengl.def -llibopengl.a | |
445 | ||
446 | for the SGI DLLs, or | |
447 | ||
448 | dlltool -k -d opengl32.def -llibopengl32.a | |
449 | ||
450 | and similarly for glu[32].def. | |
451 | ||
452 | 6. The 'make install' step is optional, and copies files | |
453 | as follows: | |
454 | ||
455 | /usr/local/lib - wxmswXYZd.dll.a and wxmswXYZd.dll | |
456 | /usr/local/include/wx - wxWidgets header files | |
457 | /usr/local/bin - wx-config | |
458 | ||
459 | You may need to do this if using wx-config with the | |
460 | default root path. | |
461 | ||
462 | 7. With Cygwin, you can invoke gdb --nw myfile.exe to | |
463 | debug an executable. If there are memory leaks, they will be | |
464 | flagged when the program quits. You can use Cygwin gdb | |
465 | to debug MinGW executables. | |
466 | ||
467 | OLD VERSIONS: | |
468 | ||
469 | - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat) | |
470 | to set up appropriate variables, if necessary mounting drives. | |
471 | Run it before compiling. | |
472 | ||
473 | - For Cygwin, make sure there's a \tmp directory on your | |
474 | Windows drive or bison will crash (actually you don't need | |
475 | bison for ordinary wxWidgets compilation: a pre-generated .c file is | |
476 | supplied). | |
477 | ||
478 | - If using GnuWin32 b18, you will need to copy windres.exe | |
479 | from e.g. the MinGW distribution, to a directory in your path. | |
480 | ||
481 | ||
482 | Symantec & DigitalMars C++ compilation | |
483 | ---------------------------------------------------------------- | |
484 | ||
485 | The DigitalMars compiler is a free succssor to the Symantec compiler | |
486 | and can be downloaded from http://www.digitalmars.com/ | |
487 | ||
488 | 1. You need to download and unzip in turn (later packages will overwrite | |
489 | older files) | |
490 | Digital Mars C/C++ Compiler Version 8.40 or later | |
491 | Basic utilities | |
492 | from http://www.digitalmars.com/download/freecompiler.html | |
493 | ||
494 | 2. Change directory to build\msw and type 'make -f makefile.dmc' to | |
495 | make the wxWidgets core library. | |
496 | ||
497 | 3. Change directory to samples\minimal and type 'make -f makefile.dmc' | |
498 | to make this sample. Most of the other samples also work. | |
499 | ||
500 | ||
501 | Note that if you don't have the files makefile.dmc you may create them yourself | |
502 | using bakefile tool according to the instructions in build\bakefiles\README: | |
503 | ||
504 | cd build\bakefiles | |
505 | bakefile_gen -f dmars -b wx.bkl | |
506 | bakefile_gen -f dmars -b ../../samples/minimal/minimal.bkl | |
507 | ||
508 | ||
509 | 16-bit compilation is no longer supported. | |
510 | ||
511 | Configuring the build | |
512 | ================================================================ | |
513 | ||
514 | So far the instructions only explained how to build release DLLs of wxWidgets | |
515 | and did not cover any configuration. It is possible to change many aspects of | |
516 | the build, including debug/release and ANSI/Unicode settings. All makefiles in | |
517 | build\msw directory use same options (with a few exceptions documented below) | |
518 | and the only difference between them is in object files and library directory | |
519 | names and in make invocation command. | |
520 | ||
521 | Changing the settings | |
522 | ---------------------------------------------------------------- | |
523 | ||
524 | There are two ways to modify the settings: either by passing the values as | |
525 | arguments when invoking make or by editing build\msw\config.$(compiler) file | |
526 | where $(compiler) is same extension as the makefile you use has (see below). | |
527 | The latter is good for setting options that never change in your development | |
528 | process (e.g. GCC_VERSION or VENDOR). If you want to build several versions of | |
529 | wxWidgets and use them side by side, the former method is better. Settings in | |
530 | config.* files are shared by all makefiles (samples, contrib, main library), | |
531 | but if you pass the options as arguments, you must use same arguments you used | |
532 | for the library when building samples or contrib libraries! | |
533 | ||
534 | Examples of invoking make in Unicode debug build (other options described | |
535 | below are set analogically): | |
536 | ||
537 | Visual C++: | |
538 | > nmake -f makefile.vc BUILD=debug UNICODE=1 | |
539 | ||
540 | Borland C++: | |
541 | > make -f makefile.bcc -DBUILD=debug -DUNICODE=1 | |
542 | (Note that you have to use -D to set the variable, unlike in other make | |
543 | tools!) | |
544 | ||
545 | Watcom C/C++: | |
546 | > wmake -f makefile.wat BUILD=debug UNICODE=1 | |
547 | ||
548 | MinGW using native makefiles: | |
549 | > mingw32-make -f makefile.gcc BUILD=debug UNICODE=1 | |
550 | ||
551 | MinGW using configure or Cygwin: | |
552 | > ./configure --enable-debug --enable-unicode | |
553 | (see ./configure --help on details; configure is not covered in this | |
554 | section) | |
555 | ||
556 | Brief explanation of options and possible values is in every | |
557 | build\msw\config.* file; more detailed description follows. | |
558 | ||
559 | Basic options | |
560 | ---------------------------------------------------------------- | |
561 | ||
562 | BUILD=release | |
563 | Builds release version of the library. It differs from default 'debug' | |
564 | in lack of appended 'd' in name of library, does not define __WXDEBUG__ | |
565 | and not include debug information compiled into object files and the | |
566 | executable. | |
567 | ||
568 | SHARED=1 | |
569 | Build shared libraries (DLLs). By default, DLLs are not built | |
570 | (SHARED=0). | |
571 | ||
572 | UNICODE=1 | |
573 | To build Unicode versions of the libraries, add UNICODE=1 to make invocation | |
574 | (default is UNICODE=0). If you want to be able to use Unicode version on | |
575 | Windows9x, you will need to set MSLU=1 as well. | |
576 | ||
577 | This option affect name of the library ('u' is appended) and the directory | |
578 | where the library and setup.h are store (ditto). | |
579 | ||
580 | WXUNIV=1 | |
581 | Build wxUniversal instead of native wxMSW (see | |
582 | http://www.wxwidgets.org/wxuniv.htm for more information). | |
583 | ||
584 | Advanced options | |
585 | ---------------------------------------------------------------- | |
586 | ||
587 | MONOLITHIC=1 | |
588 | Starting with version 2.5.1, wxWidgets has the ability to be built as | |
589 | several smaller libraries instead of single big one as used to be the case | |
590 | in 2.4 and older versions. This is called "multilib build" and is the | |
591 | default behaviour of makefiles. You can still build single library | |
592 | ("monolithic build") by setting MONOLITHIC variable to 1. | |
593 | ||
594 | USE_GUI=0 | |
595 | Disable building GUI parts of the library, build only wxBase components used | |
596 | by console applications. Note that if you leave USE_GUI=1 then both wxBase | |
597 | and GUI libraries are built. If you are building monolithic library, then | |
598 | you should set wxUSE_GUI to 1 in setup.h. | |
599 | ||
600 | USE_OPENGL=1 | |
601 | Build wxmsw25_gl.lib library with OpenGL integration class wxGLCanvas. | |
602 | You must also modify your setup.h to #define wxUSE_GLCANVAS 1. Note that | |
603 | OpenGL library is always built as additional library, even in monolithic | |
604 | build! | |
605 | ||
606 | USE_ODBC=1 | |
607 | Build two additional libraries in multilib mode, one with database | |
608 | classes and one with wxGrid database support. You must | |
609 | #define wxUSE_ODBC 1 in setup.h | |
610 | ||
611 | USE_HTML=0 | |
612 | Do not build wxHTML library. If MONOLITHIC=1, then you must also | |
613 | #define wxUSE_HTML 1 in setup.h. | |
614 | ||
615 | USE_XRC=0 | |
616 | Do not build XRC resources library. If MONOLITHIC=1, then you must also | |
617 | #define wxUSE_HTML 1 in setup.h. | |
618 | ||
619 | RUNTIME_LIBS=static | |
620 | Links static version of C and C++ runtime libraries into the executable, so | |
621 | that the program does not depend on DLLs provided with the compiler (e.g. | |
622 | Visual C++'s msvcrt.dll or Borland's cc3250mt.dll). | |
623 | Caution: Do not use static runtime libraries when building DLL (SHARED=1)! | |
624 | ||
625 | MSLU=1 | |
626 | Enables MSLU (Microsoft Layer for Unicode). This setting makes sense only if | |
627 | used together with UNICODE=1. If you want to be able to use Unicode version | |
628 | on Windows9x, you will need MSLU (Microsoft Layer for Unicode) runtime DLL | |
629 | and import lib. The former can be downloaded from Microsoft, the latter is | |
630 | part of the latest Platform SDK from Microsoft (see msdn.microsoft.com for | |
631 | details). An alternative implementation of import library can be downloaded | |
632 | from http://libunicows.sourceforge.net - unlike the official one, this one | |
633 | works with other compilers and does not require 300+ MB Platform SDK update. | |
634 | ||
635 | DEBUG_FLAG=0 | |
636 | DEBUG_FLAG=1 | |
637 | If set to 1, define __WXDEBUG__ symbol, append 'd' to library name and do | |
638 | sanity checks at runtime. If set to 0, don't do it. By default, this is | |
639 | governed by BUILD option (if 'debug', DEBUG_FLAG=1, if 'release' it is 0), | |
640 | but it is sometimes desirable to modify default behaviour and e.g. define | |
641 | __WXDEBUG__ even in release builds. | |
642 | ||
643 | DEBUG_INFO=0 | |
644 | DEBUG_INFO=1 | |
645 | Same as DEBUG_FLAG in behaviour, this option affects whether debugging | |
646 | information is included in the executable or not. | |
647 | ||
648 | VENDOR=<your company name> | |
649 | Set this to a short string identifying your company if you are planning to | |
650 | distribute wxWidgets DLLs with your application. Default value is 'custom'. | |
651 | This string is included as part of DLL name. wxWidgets DLLs contain compiler | |
652 | name, version information and vendor name in them. For example | |
653 | wxmsw250_core_bcc_custom.dll is one of DLLs build using Borland C++ with | |
654 | default settings. If you set VENDOR=mycorp, the name will change to | |
655 | wxmsw250_core_bcc_mycorp.dll. | |
656 | ||
657 | CFG=<configuration name> | |
658 | Sets configuration name so that you can have multiple wxWidgets builds with | |
659 | different setup.h settings coexisting in same tree. See "Object and library | |
660 | directories" below for more information. | |
661 | ||
662 | Compiler specific options | |
663 | ---------------------------------------------------------------- | |
664 | ||
665 | * MinGW | |
666 | ||
667 | If you are using gcc-2.95 instead of gcc3, you must set GCC_VERSION to | |
668 | 2.95. In build\msw\config.gcc, change | |
669 | > GCC_VERSION = 3 | |
670 | to | |
671 | > GCC_VERSION = 2.95 | |
672 | ||
673 | * Visual C++ | |
674 | ||
675 | DEBUG_RUNTIME_LIBS=0 | |
676 | DEBUG_RUNTIME_LIBS=1 | |
677 | If set to 1, msvcrtd.dll is used, if to 0, msvcrt.dll is used. By default | |
678 | msvcrtd.dll is used only if the executable contains debug info and | |
679 | msvcrt.dll if it doesn't. It is sometimes desirable to build with debug info | |
680 | and still link against msvcrt.dll (e.g. when you want to ship the app to | |
681 | customers and still have usable .pdb files with debug information) and this | |
682 | setting makes it possible. | |
683 | ||
684 | Fine-tuning the compiler | |
685 | ---------------------------------------------------------------- | |
686 | ||
687 | All makefiles have variables that you can use to specify additional options | |
688 | passed to the compiler or linker. You won't need this in most cases, but if you | |
689 | do, simply add desired flags to CFLAGS (for C compiler), CXXFLAGS (for C++ | |
690 | compiler), CPPFLAGS (for both C and C++ compiler) and LDFLAGS (the linker). | |
691 | ||
692 | Object and library directories | |
693 | ---------------------------------------------------------------- | |
694 | ||
695 | All object files produced during library build are stored in a directory under | |
696 | build\msw. It's name is derived from build settings and CFG variable and from | |
697 | compiler name. Examples of directory names: | |
698 | ||
699 | build\msw\bcc_msw SHARED=0 | |
700 | build\msw\bcc_mswdll SHARED=1 | |
701 | build\msw\bcc_mswunivd SHARED=0, WXUNIV=1, BUILD=debug | |
702 | build\msw\vc_mswunivd ditto, with Visual C++ | |
703 | ||
704 | Libraries and DLLs are copied into subdirectory of lib directory with | |
705 | name derived from compiler and static/DLL setting and setup.h into directory | |
706 | with name that contains other settings: | |
707 | ||
708 | lib\bcc_msw | |
709 | lib\bcc_lib\msw\wx\setup.h | |
710 | lib\bcc_dll | |
711 | lib\bcc_dll\msw\wx\setup.h | |
712 | lib\bcc_lib | |
713 | lib\bcc_lib\mswunivd\wx\setup.h | |
714 | lib\vc_lib | |
715 | lib\vc_lib\mswunivd\wx\setup.h | |
716 | ||
717 | Each lib\ subdirectory has wx subdirectory with setup.h as seen above. | |
718 | This file is copied there from include\wx\msw\setup.h (and if it doesn't exist, | |
719 | from include\wx\msw\setup0.h) and this is the copy of setup.h that is used by | |
720 | all samples and should be used by your apps as well. If you are doing changes | |
721 | to setup.h, you should do them in this file, _not_ in include\wx\msw\setup.h. | |
722 | ||
723 | If you set CFG to something, the value is appended to directory names. E.g. | |
724 | for CFG=MyBuild, you'll have object files in | |
725 | ||
726 | build\msw\bcc_mswMyBuild | |
727 | build\msw\bcc_mswdllMyBuild | |
728 | etc. | |
729 | ||
730 | and libraries in | |
731 | ||
732 | lib\bcc_libMyBuild | |
733 | lib\bcc_dllMyBuild | |
734 | etc. | |
735 | ||
736 | By now it is clear what CFG is for: builds with different CFG settings don't | |
737 | share any files and they use different setup.h files. This allows you to e.g. | |
738 | have two static debug builds, one with wxUSE_SOCKETS=0 and one with sockets | |
739 | enabled (without CFG, both of them would be put into same directory and there | |
740 | would be conflicts between the files). | |
741 | ||
742 | General Notes | |
743 | ================================================================= | |
744 | ||
745 | - Debugging: under Windows 95, debugging output isn't output in | |
746 | the same way that it is under NT or Windows 3.1. | |
747 | Please see DebugView available from http://www.sysinternals.com. | |
748 |