]>
Commit | Line | Data |
---|---|---|
8c9f8f91 | 1 | Installing wxWidgets 2.5.5 |
4e4dc03d | 2 | -------------------------- |
0544bc0a | 3 | |
8c9f8f91 | 4 | This is wxWidgets 2.5.5 for Microsoft Windows 9x/ME, Windows NT, Windows 2000 |
545d1e60 VZ |
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 | |
3d82ef9b | 7 | change in backwards incompatible way during the 2.5 branch lifetime. |
0544bc0a | 8 | |
dbda9e86 | 9 | IMPORTANT NOTE: If you experience problems installing, please |
9c6751aa | 10 | re-read this instructions and other related files (changes.txt, |
7666ad49 JS |
11 | readme.txt, FAQ) carefully before mailing wx-users. Preferably, |
12 | try to fix the problem first and then upload a patch to | |
13 | SourceForge: | |
14 | ||
15 | http://sourceforge.net/patch/?group_id=9863 | |
16 | ||
17 | Please report bugs using the SourceForge bug tracker: | |
18 | ||
19 | http://sourceforge.net/bugs/?group_id=9863 | |
dbda9e86 | 20 | |
2bda0e17 | 21 | Unarchiving |
03265572 | 22 | =========== |
2bda0e17 | 23 | |
2b5f62a0 VZ |
24 | A setup program is provided (setup.exe) to automatically copy |
25 | files to a directory on your hard disk. Do not install into a | |
3d82ef9b | 26 | path that contains spaces. |
2b5f62a0 VZ |
27 | |
28 | The setup program contains the following: | |
01dba85a | 29 | |
fc2171bd | 30 | - All common, generic and MSW-specific wxWidgets source; |
3d82ef9b JS |
31 | - samples and demos; |
32 | - documentation in MS HTML Help format; | |
b9f933ab JS |
33 | - makefiles for most Windows compilers, plus CodeWarrior, |
34 | BC++ and VC++ IDE files; | |
01dba85a | 35 | - JPEG library source; |
669f7a11 | 36 | - TIFF library source; |
3d82ef9b | 37 | - Object Graphics Library, Tex2RTF, wxSTC, etc. |
01dba85a | 38 | |
f6bcfd97 BP |
39 | Alternatively, you may unarchive the .zip form by hand: |
40 | wxMSW-x.y.z.zip where x.y.z is the version number. | |
2bda0e17 KB |
41 | |
42 | Unarchive the required files plus any optional documentation | |
dbda9e86 | 43 | files into a suitable directory such as c:\wx. |
2bda0e17 | 44 | |
dbda9e86 | 45 | General installation notes |
03265572 | 46 | ========================== |
dbda9e86 | 47 | |
dbda9e86 | 48 | If installing from the CVS server, copy include/wx/msw/setup0.h to |
a40a9c81 | 49 | include/wx/msw/setup.h and edit the resulting file to choose |
fc2171bd | 50 | the features you would like to compile wxWidgets with[out]. |
dbda9e86 | 51 | |
2bda0e17 | 52 | Compilation |
545d1e60 | 53 | =========== |
2bda0e17 | 54 | |
fc2171bd | 55 | The following sections explain how to compile wxWidgets with each supported |
545d1e60 VZ |
56 | compiler. Search for one of Microsoft/Borland/Watcom/Symantec/Metrowerks/ |
57 | Cygwin/Mingw32 to quickly locate the instructions for your compiler. | |
58 | ||
fd9f42b6 VS |
59 | All makefiles and project are located in build\msw directory. |
60 | ||
61 | Where compiled files are stored | |
62 | ------------------------------- | |
63 | ||
3980000c | 64 | After successful compilation you'll find the libraries in a subdirectory |
0a7cad3a | 65 | of lib directory named after the compiler and DLL/static settings. |
6acf2ef6 | 66 | A couple of examples: |
fd9f42b6 | 67 | |
6acf2ef6 VS |
68 | lib\vc_lib VC++ compiled static libraries |
69 | lib\vc_dll VC++ DLLs | |
70 | lib\bcc_lib Static libraries for Borland C++ | |
71 | lib\wat_dll Watcom C++ DLLs | |
fd9f42b6 | 72 | |
fc2171bd | 73 | Names of compiled wxWidgets libraries follow this scheme: libraries that don't |
fd9f42b6 VS |
74 | depend on GUI components begin with "wxbase" followed by version number and |
75 | letters indicating if the library is compiled as Unicode ('u') and/or debug | |
fc2171bd | 76 | build ('d'). Last component of them name is name of wxWidgets component |
fd9f42b6 VS |
77 | (unless you built the library as single monolithic library; look for |
78 | "Configuring the build" below). This is a typical set of release ANSI build | |
79 | libraries (release versions on left, debug on right side): | |
80 | ||
81 | wxbase25.lib wxbase25d.lib | |
82 | wxbase25_net.lib wxbase25d_net.lib | |
83 | wxbase25_xml.lib wxbase25d_xml.lib | |
84 | wxmsw25_core.lib wxmsw25d_core.lib | |
85 | wxmsw25_html.lib wxmsw25d_html.lib | |
86 | wxmsw25_adv.lib wxmsw25d_adv.lib | |
87 | ||
6acf2ef6 VS |
88 | Their Unicode debug counterparts in wxUniversal build would be |
89 | ||
90 | wxbase25ud.lib | |
91 | wxbase25ud_net.lib | |
92 | wxbase25ud_xml.lib (notice these libs are same for wxUniv and wxMSW) | |
93 | wxmswuniv25ud_core.lib | |
94 | wxmswuniv25ud_html.lib | |
95 | wxmswuniv25ud_adv.lib | |
96 | ||
97 | These directories also contain subdirectory with wx/setup.h header. This | |
98 | subdirectory is named after port, Unicode, wxUniv and debug settings and | |
99 | you must add it to include paths when compiling your application. Some | |
100 | examples: | |
101 | ||
102 | lib\vc_lib\msw\wx\setup.h VC++ static, wxMSW | |
103 | lib\vc_lib\mswud\wx\setup.h VC++ static, wxMSW, Unicode, debug | |
104 | lib\vc_lib\mswunivd\wx\setup.h VC++ static, wxUniversal, debug | |
fd9f42b6 VS |
105 | |
106 | Below are compiler specific notes followed by customizing instructions that | |
107 | apply to all compilers (search for "Configuring the build"). | |
108 | ||
545d1e60 VZ |
109 | Microsoft Visual C++ compilation |
110 | -------------------------------- | |
2bda0e17 | 111 | |
90985bde VZ |
112 | You may wish to visit http://wiki.wxwindows.org/wiki.pl?MSVC for a more |
113 | informal and more detailed description of the process summarized below. | |
114 | ||
b2575739 | 115 | Please note that the VC++ 6.0 project files will work for VC++ .NET also. |
1257f684 | 116 | |
916095ba JS |
117 | Also note that you can make the project files work with VC++ 5.0 but you'll |
118 | need to edit .dsp file by hand before this is possible (change the version in | |
119 | the .dsp file header from 6.0 to 5.0). | |
38c1f6f7 VZ |
120 | |
121 | Using project files (VC++ 6 and later): | |
a367b9b3 | 122 | |
fc2171bd | 123 | 1. Unarchive wxWidgets-x.y.z-vc.zip, the VC++ 6 project |
f6bcfd97 | 124 | makefiles (already included in wxMSW-x.y.z.zip and the setup version). |
fd9f42b6 | 125 | 2. Open build\msw\wx.dsw, which has configurations for static |
a40a9c81 | 126 | compilation or DLL compilation, and each of these available in |
fd9f42b6 VS |
127 | Unicode/ANSI, Debug/Release and wxUniversal or native variations. |
128 | Normally you'll use a static linking ANSI configuration. | |
efefa4f8 VS |
129 | Choose the Win32 Debug or Win32 Release configuration (or any other that |
130 | suits your needs) and use Batch Build to compile _all_ projects. If you | |
21de777f | 131 | know you won't need some of the libraries (i.e. html part), you don't have |
efefa4f8 | 132 | to compile it. It will also produce similar variations on jpeg.lib, |
fd9f42b6 | 133 | png.lib, tiff.lib, zlib.lib, and regex.lib. |
f2e61abe VS |
134 | If you want to build DLLs, you have to either build them one by one in |
135 | proper order (jpeg, png, tiff, zlib, regex, expat, base, core, the rest | |
136 | in any order) or to use wx_dll.dsw workspace which has correct dependencies. | |
5fa399c9 | 137 | 3. Open a sample project file, choose a configuration such as |
a40a9c81 | 138 | Win32 Debug using Build | Set Active Configuration..., and compile. |
5fa399c9 | 139 | The project files don't use precompiled headers, to save disk |
16553659 | 140 | space, but you can switch PCH compiling on for greater speed. |
a40a9c81 | 141 | NOTE: you may also use samples/samples.dsw to access all |
669f7a11 JS |
142 | sample projects without opening each workspace individually. |
143 | You can use the Batch Build facility to make several samples | |
144 | at a time. | |
a367b9b3 JS |
145 | |
146 | Using makefiles: | |
147 | ||
03265572 | 148 | 1. Change directory to build\msw. Type: |
ca5c8b2d JS |
149 | |
150 | 'nmake -f makefile.vc' | |
151 | ||
fc2171bd | 152 | to make the wxWidgets core library as release DLL. |
fd9f42b6 VS |
153 | See "Configuring the build" for instruction how to build debug or static |
154 | libraries. | |
3d82ef9b | 155 | |
03265572 | 156 | 2. Change directory to samples and type 'nmake -f makefile.vc' |
2bda0e17 KB |
157 | to make all the samples. You can also make them individually. |
158 | ||
5fa399c9 | 159 | Makefile notes: |
e2a6f233 | 160 | |
fd9f42b6 | 161 | Use the 'clean' target to clean all objects, libraries and |
ca5c8b2d JS |
162 | executables. |
163 | ||
3f1af920 | 164 | Note (1): if you wish to use templates, please edit |
025e88c5 JS |
165 | include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0. |
166 | Without this, the redefinition of 'new' will cause problems in | |
167 | the headers. Alternatively, #undef new before including template headers. | |
dbda9e86 JS |
168 | You will also need to set wxUSE_IOSTREAMH to 0 if you will be |
169 | using templates, to avoid the non-template stream files being included | |
fc2171bd | 170 | within wxWidgets. |
025e88c5 | 171 | |
3f1af920 | 172 | Note (2): libraries and applications generated with makefiles and |
5fa399c9 JS |
173 | project files are now (hopefully) compatible where static libraries |
174 | are concerned, but please exercise caution nevertheless and if | |
175 | possible, use one method or the other. | |
3f1af920 | 176 | |
3d82ef9b | 177 | Note (3): some crash problems can be due to inconsistent compiler |
ad813b00 JS |
178 | options. If strange/weird/impossible things start to happen please |
179 | check (dumping IDE project file as makefile and doing text comparison | |
180 | if necessary) that the project settings, especially the list of defined | |
181 | symbols, struct packing, etc. are exactly the same for all items in | |
182 | the project. After this, delete everything (including PCH) and recompile. | |
183 | ||
3d82ef9b | 184 | Note (4): to create your own IDE files, copy .dsp and .dsw |
fc2171bd | 185 | files from an existing wxWidgets sample and adapt them, or |
3d82ef9b | 186 | visit http://wiki.wxwindows.org/wiki.pl?MSVC. |
e2a6f233 | 187 | |
9d1461a4 | 188 | Borland C++ 5.0/5.5 compilation |
2bda0e17 KB |
189 | ------------------------------- |
190 | ||
2b5f62a0 | 191 | Compiling using the makefiles (updated 24 Sept 02): |
ca5c8b2d | 192 | |
fd9f42b6 | 193 | 1. Change directory to build\msw. Type 'make -f makefile.bcc' to |
fc2171bd | 194 | make the wxWidgets core library. Ignore the compiler warnings. |
6bddef36 | 195 | This produces a couple of libraries in the lib\bcc_lib directory. |
fd9f42b6 VS |
196 | |
197 | 2. Change directory to a sample or demo such as samples\minimal, and type | |
198 | 'make -f makefile.bcc'. This produces a windows exe file - by default | |
6bddef36 | 199 | in the bcc_mswd subdirectory. |
fd9f42b6 | 200 | |
fc2171bd | 201 | Note (1): the wxWidgets makefiles assume dword structure alignment. Please |
1a7f3062 JS |
202 | make sure that your own project or makefile settings use the |
203 | same alignment, or you could experience mysterious crashes. To | |
fd9f42b6 | 204 | change the alignment, change CPPFLAGS in build\msw\config.bcc. |
1a7f3062 | 205 | |
9d1461a4 | 206 | Note (2): if you get undefined _SQL... symbols at link time, |
154f22b3 JS |
207 | either install odbc32.lib from the BC++ CD-ROM into your BC++ lib |
208 | directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and | |
fc2171bd | 209 | recompile wxWidgets. The same applies if compiling using the IDE. |
154f22b3 | 210 | |
9d1461a4 | 211 | Note (3): If you wish debug messages to be sent to the console in |
fd9f42b6 | 212 | debug mode, edit makefile.bcc and change /aa to /Tpe in link commands. |
7fee680b | 213 | |
7945bfb4 CE |
214 | Compiling using the IDE files for Borland C++ 5.0: not supported - please |
215 | use version 2.4.1 (using the make utility in commandline mode works fine_ | |
ca5c8b2d | 216 | |
7945bfb4 CE |
217 | Compiling using CBuilder (v1-v6): not supported - please |
218 | use version 2.4.1 (using the make utility in commandline mode works fine_ | |
ca5c8b2d | 219 | |
f6bcfd97 BP |
220 | ** REMEMBER ** |
221 | ||
fc2171bd | 222 | In all of your wxWidgets applications, your source code should include |
f6bcfd97 BP |
223 | the following preprocessor directive: |
224 | ||
225 | #ifdef __BORLANDC__ | |
226 | #pragma hdrstop | |
227 | #endif | |
228 | ||
545d1e60 VZ |
229 | (check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for |
230 | more details) | |
231 | ||
9d1461a4 CE |
232 | Borland 16 Bit compilation for Windows 3.1 |
233 | ------------------------------------------ | |
4bf78aae | 234 | |
fc2171bd | 235 | The last version of wxWidgets to support 16-bit compilation with Borland was |
9d1461a4 | 236 | 2.2.7 - Please download and read the instructions in that release |
545d1e60 VZ |
237 | |
238 | Watcom C++ 10.6/11 and OpenWatcom compilation | |
239 | --------------------------------------------- | |
7be1f0d9 | 240 | |
fd9f42b6 | 241 | 1. Change directory to build\msw. Type 'wmake -f makefile.wat' to |
fc2171bd | 242 | make the wxWidgets core library. |
3d82ef9b | 243 | |
e8400940 | 244 | 2. Change directory to samples\minimal and type 'wmake -f makefile.wat' |
ace03f87 JS |
245 | to make this sample. Repeat for other samples of interest. |
246 | ||
545d1e60 VZ |
247 | Note (1): if your installation of Watcom doesn't have odbc32.lib file and |
248 | you need it (i.e. you have wxUSE_ODBC=1), you can use the file | |
249 | from lib\watcom directory. See the notes in that directory. | |
250 | ||
251 | Note (2): if variant.cpp is compiled with date/time class options, the linker | |
252 | gives up. So the date/time option is switched off for Watcom C++. | |
253 | Also, wxAutomationObject is not compiled with Watcom C++ 10. | |
254 | ||
025bbf5b CE |
255 | Note (3): RawBitmaps won't work at present because they use unsupported template |
256 | classes | |
257 | ||
258 | Note (4): if Watcom can't read the precompiled header when building a sample, | |
fd9f42b6 VS |
259 | try deleting .pch files in build\msw\wat_* and compiling |
260 | the sample again. | |
545d1e60 | 261 | |
62448488 JS |
262 | Metrowerks CodeWarrior compilation |
263 | ---------------------------------- | |
264 | ||
545d1e60 | 265 | 1. CodeWarrior Pro7 project files in XML format are already |
8c9f8f91 | 266 | included in wxMSW-2.5.5.zip and the setup version. |
3d82ef9b | 267 | |
545d1e60 VZ |
268 | 2. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if |
269 | you are working from the CVS version) to make sure the settings reflect | |
270 | what you want. If you aren't sure, leave it alone and go with the | |
ba14d986 VZ |
271 | default settings. A few notes: |
272 | - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL | |
545d1e60 | 273 | - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports |
ba14d986 VZ |
274 | will be rather confusing due to interactions with the MSL ANSI |
275 | and runtime libs. | |
3d82ef9b | 276 | |
fc2171bd | 277 | 3. The project file to build the Win32 wxWidgets libraries relies on the |
545d1e60 VZ |
278 | Batch File Runner plug-in. This plug-in is not installed as part of |
279 | a normal CW7 installation. However, you can find this plug-in on the | |
280 | CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the | |
281 | "Batch File Post Linker". | |
3d82ef9b | 282 | |
545d1e60 | 283 | 4. If you choose not to install the Batch File Runner plug-in, then you |
ba14d986 | 284 | need to do the following by hand: |
545d1e60 VZ |
285 | (1) Create the directories lib\cw7msw\include\wx and copy the file |
286 | include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are | |
ba14d986 | 287 | working from the CVS version) to lib\cw7msw\include\wx\setup.h |
545d1e60 VZ |
288 | (2) Create the directories lib\cw7mswd\include\wx and copy the file |
289 | include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are | |
ba14d986 | 290 | working from the CVS version) to lib\cw7mswd\include\wx\setup.h |
3d82ef9b | 291 | |
fc2171bd | 292 | 5. Import src\wxWidgetsW7.xml to create the project file wxWidgetsW7.mcp. |
545d1e60 VZ |
293 | Store this project file in directory src. You may get warnings about |
294 | not being able to find certain project paths; ignore these warnings, the | |
ba14d986 | 295 | appropriate paths will be created during the build by the Batch File Runner. |
3d82ef9b | 296 | |
545d1e60 VZ |
297 | 6. Choose the wxlib Win32 debug or wxlib Win32 Release target and build. You |
298 | will get some warnings about hidden virtual functions, illegal conversions | |
ba14d986 | 299 | from const pointers to pointers, etc., all of which you can safely ignore. |
545d1e60 VZ |
300 | ***Note: if you get errors that the compiler can't find "wx/setup.h", just |
301 | stop the build and build again. These errors occur because sometimes the | |
ba14d986 | 302 | compiler starts doing its thing before the copying of setup.h has completed. |
3d82ef9b | 303 | |
ba14d986 VZ |
304 | 7. The following libraries will be produced depending on chosen |
305 | target: | |
306 | - wx_x86.lib ANSI Release (static) | |
307 | - wx_x86_d.lib ANSI Debug (static) | |
3d82ef9b | 308 | |
ba14d986 | 309 | 8. Sorry, I haven't had time yet to create and test unicode or DLL versions. |
545d1e60 | 310 | Volunteers for this are welcome (as neither DLLs nor unicode builds are |
ba14d986 | 311 | big priorities for me ;). |
3d82ef9b | 312 | |
545d1e60 VZ |
313 | 9. CodeWarrior Pro7 project files (in XML format) are also provided for some |
314 | of the samples. In particular, there are project files for the minimal, | |
315 | controls, dialogs, dnd, nd docview samples. You can use these project | |
316 | files as templates for the other samples and for your own projects. | |
3d82ef9b | 317 | - For example, to make a project file for the "grid" sample, |
545d1e60 VZ |
318 | just copy the project file for the "minimal" sample, minimalW7.mcp |
319 | (made by importing minimalW7.xml into CodeWarrior), into the | |
3d82ef9b | 320 | sample/grid directory, calling it gridW7.mcp. Open |
545d1e60 VZ |
321 | newgridW7.mcp and revise the project by deleting the files |
322 | minimal.rc and minimal.cpp and adding the files griddemo.rc and | |
377c68c5 CE |
323 | griddemo.cpp. Build and run.... |
324 | ||
545d1e60 | 325 | |
9a718b86 | 326 | Cygwin/MinGW compilation |
545d1e60 | 327 | ------------------------ |
2bda0e17 | 328 | |
7acf6a92 | 329 | wxWidgets supports Cygwin (formerly GnuWin32) betas and |
9a718b86 | 330 | releases, and MinGW. Cygwin can be downloaded from: |
6500c0b1 | 331 | |
9a718b86 | 332 | http://sources.redhat.com/cygwin/ |
2bda0e17 | 333 | |
9a718b86 | 334 | and MinGW from: |
6500c0b1 | 335 | |
9a718b86 | 336 | http://www.mingw.org/ |
2bda0e17 | 337 | |
fd9f42b6 VS |
338 | Both Cygwin and MinGW can be used with configure (assuming you have MSYS |
339 | installed in case of MinGW). You will need new enough MinGW version, preferably | |
340 | MinGW 2.0 (ships with gcc3) or at least 1.0 (gcc-2.95.3). GCC versions older | |
fc2171bd | 341 | than 2.95.3 don't work; you can use wxWidgets 2.4 with them. |
7acf6a92 JS |
342 | If using Cygwin, you must pass --disable-sockets to configure due to a header |
343 | conflict in Cygwin. | |
545d1e60 | 344 | |
fd9f42b6 VS |
345 | NOTE: some notes specific to old Cygwin (< 1.1.x) are at the end of this |
346 | section (see OLD VERSIONS) | |
2bda0e17 | 347 | |
fc2171bd | 348 | There are two methods of compiling wxWidgets, by using the |
7666ad49 | 349 | makefiles provided or by using 'configure'. |
2bda0e17 | 350 | |
9a718b86 | 351 | Retrieve and install the latest version of Cygwin, or MinGW, as per |
6500c0b1 JS |
352 | the instructions with either of these packages. |
353 | ||
9a718b86 | 354 | If using MinGW, you can download the add-on MSYS package to |
fc2171bd | 355 | provide Unix-like tools that you'll need to build wxWidgets using configure. |
6500c0b1 JS |
356 | |
357 | Using makefiles directly | |
fd9f42b6 | 358 | ------------------------ |
7666ad49 | 359 | |
d01bf7ae VS |
360 | NOTE: The makefile.gcc makefiles are for compilation under MinGW using |
361 | native make and Windows command interpreter (command.com/cmd.exe), they | |
362 | won't work in other environments (such as UNIX or Unix-like, e.g. MSYS; | |
363 | you have to use configure instead) | |
02fd5400 | 364 | |
7666ad49 | 365 | Here are the steps required using the provided makefiles: |
8870c26e | 366 | |
fd9f42b6 VS |
367 | - If you are using gcc-2.95, edit build\msw\config.gcc and set the GCC_VERSION |
368 | variable to "2.95". | |
6500c0b1 | 369 | |
bea8e651 MB |
370 | - If you are compiling with GCC 3.x using makefiles and with wxUSE_STL == 1 |
371 | you need to manually add -DNO_GCC_PRAGMA to CXXFLAGS in config.gcc. | |
372 | ||
fc2171bd JS |
373 | - Use the makefile.gcc files for compiling wxWidgets and samples, |
374 | e.g. to compile a debugging version of wxWidgets: | |
fd9f42b6 VS |
375 | > cd c:\wx\build\msw |
376 | > make -f makefile.gcc BUILD=debug | |
4dcd292c | 377 | > cd c:\wx\samples\minimal |
fd9f42b6 VS |
378 | > make -f makefile.gcc BUILD=debug |
379 | (See below for more options.) | |
4dcd292c | 380 | |
cba2db0c JS |
381 | Ignore the warning about the default entry point. |
382 | ||
9a718b86 MB |
383 | - Use the 'strip' command to reduce executable/dll size (note that |
384 | stripping an executable/dll will remove debug information!). | |
2bda0e17 | 385 | |
2bda0e17 | 386 | All targets have 'clean' targets to allow removal of object files |
fd9f42b6 | 387 | and other intermediate compiler files. |
2bda0e17 | 388 | |
7666ad49 | 389 | Using configure |
03265572 | 390 | --------------- |
7666ad49 JS |
391 | |
392 | Instead of using the makefiles, you can use the configure | |
393 | system to generate appropriate makefiles, as used on Unix | |
394 | and Mac OS X systems. | |
395 | ||
fc2171bd | 396 | Change directory to the root of the wxWidgets distribution, |
9a718b86 | 397 | make a build directory, and run configure and make in this directory. |
7666ad49 JS |
398 | |
399 | For example: | |
400 | ||
401 | cd $WXWIN | |
402 | mkdir build-debug | |
403 | cd build-debug | |
404 | ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared | |
405 | make | |
c5f53eb8 | 406 | make install % This step is optional, see note (8) below. |
7666ad49 JS |
407 | cd samples/minimal |
408 | make | |
409 | ./minimal.exe | |
410 | ||
7c5dc04f | 411 | Notes: |
2bda0e17 | 412 | |
9a718b86 | 413 | 1. See also the Cygwin/MinGW on the web site or CD-ROM for |
fc2171bd | 414 | further information about using wxWidgets with these compilers. |
7c5dc04f | 415 | |
6b978929 | 416 | 2. libwx.a is 100 MB or more - but much less if compiled with no |
bf4d9b2b | 417 | debug info (-g0) and level 4 optimization (-O4). |
7c5dc04f | 418 | |
9a718b86 | 419 | 3. If you get a link error under MinGW 2.95.2 referring to: |
6b978929 JS |
420 | |
421 | EnumDAdvise__11IDataObjectPP13IEnumSTATDATA@8 | |
422 | ||
423 | then you need to edit the file objidl.h at line 663 and add | |
424 | a missing PURE keyword: | |
425 | ||
426 | STDMETHOD(EnumDAdvise)(THIS_ IEnumSTATDATA**) PURE; | |
427 | ||
9a718b86 | 428 | 4. There's a bug in MinGW headers for some early distributions. |
7c5dc04f | 429 | |
bf4d9b2b | 430 | in include/windows32/defines.h, where it says: |
7c5dc04f | 431 | |
bf4d9b2b | 432 | #define LPSTR_TEXTCALLBACKA (LPSTR)-1L) |
7c5dc04f | 433 | |
bf4d9b2b | 434 | it should say: |
7c5dc04f | 435 | |
bf4d9b2b | 436 | #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L) |
7c5dc04f | 437 | |
bf4d9b2b | 438 | (a missing bracket). |
7c5dc04f | 439 | |
fd9f42b6 | 440 | 5. OpenGL support should work with MinGW as-is. However, |
fac26663 JS |
441 | if you wish to generate import libraries appropriate either for |
442 | the MS OpenGL libraries or the SGI OpenGL libraries, go to | |
443 | include/wx/msw/gl and use: | |
444 | ||
445 | dlltool -k -d opengl.def -llibopengl.a | |
446 | ||
447 | for the SGI DLLs, or | |
448 | ||
449 | dlltool -k -d opengl32.def -llibopengl32.a | |
450 | ||
451 | and similarly for glu[32].def. | |
452 | ||
fd9f42b6 | 453 | 6. The 'make install' step is optional, and copies files |
c5f53eb8 JS |
454 | as follows: |
455 | ||
456 | /usr/local/lib - wxmswXYZd.dll.a and wxmswXYZd.dll | |
fc2171bd | 457 | /usr/local/include/wx - wxWidgets header files |
c5f53eb8 JS |
458 | /usr/local/bin - wx-config |
459 | ||
460 | You may need to do this if using wx-config with the | |
461 | default root path. | |
462 | ||
fd9f42b6 VS |
463 | 7. With Cygwin, you can invoke gdb --nw myfile.exe to |
464 | debug an executable. If there are memory leaks, they will be | |
465 | flagged when the program quits. You can use Cygwin gdb | |
466 | to debug MinGW executables. | |
4dcd292c | 467 | |
fd9f42b6 | 468 | OLD VERSIONS: |
4dcd292c MB |
469 | |
470 | - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat) | |
471 | to set up appropriate variables, if necessary mounting drives. | |
472 | Run it before compiling. | |
473 | ||
474 | - For Cygwin, make sure there's a \tmp directory on your | |
475 | Windows drive or bison will crash (actually you don't need | |
fc2171bd | 476 | bison for ordinary wxWidgets compilation: a pre-generated .c file is |
4dcd292c MB |
477 | supplied). |
478 | ||
4dcd292c | 479 | - If using GnuWin32 b18, you will need to copy windres.exe |
9a718b86 | 480 | from e.g. the MinGW distribution, to a directory in your path. |
4dcd292c | 481 | |
df945db9 | 482 | |
ce8897bb | 483 | Symantec & DigitalMars C++ compilation |
03265572 | 484 | -------------------------------------- |
ce8897bb CE |
485 | The DigitalMars compiler is a free succssor to the Symantec compiler |
486 | and can be downloaded from http://www.digitalmars.com/ | |
025bbf5b | 487 | |
fd9f42b6 VS |
488 | 1. You need to download and unzip in turn (later packages will overwrite |
489 | older files) | |
9c266fa0 | 490 | Digital Mars C/C++ Compiler Version 8.40 or later |
1a81e3db | 491 | Basic utilities |
df945db9 | 492 | from http://www.digitalmars.com/download/freecompiler.html |
025bbf5b | 493 | |
df945db9 | 494 | 2. Change directory to build\msw and type 'make -f makefile.dmc' to |
fc2171bd | 495 | make the wxWidgets core library. |
df945db9 VZ |
496 | |
497 | 3. Change directory to samples\minimal and type 'make -f makefile.dmc' | |
1a81e3db | 498 | to make this sample. Most of the other samples also work. |
377c68c5 | 499 | |
2bda0e17 | 500 | |
df945db9 VZ |
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 | ||
ce8897bb | 509 | 16-bit compilation is no longer supported. |
6500c0b1 | 510 | |
fd9f42b6 VS |
511 | Configuring the build |
512 | ===================== | |
57c208c5 | 513 | |
fc2171bd | 514 | So far the instructions only explained how to build release DLLs of wxWidgets |
03265572 VS |
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. | |
57c208c5 | 520 | |
03265572 VS |
521 | Changing the settings |
522 | --------------------- | |
57c208c5 | 523 | |
03265572 VS |
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 | |
fc2171bd | 529 | wxWidgets and use them side by side, the former method is better. Settings in |
03265572 VS |
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! | |
8870c26e | 533 | |
03265572 VS |
534 | Examples of invoking make in Unicode debug build (other options described |
535 | below are set analogically): | |
545d1e60 | 536 | |
03265572 VS |
537 | Visual C++: |
538 | > nmake -f makefile.vc BUILD=debug UNICODE=1 | |
539 | ||
540 | Borland C++: | |
19fea858 | 541 | > make -f makefile.bcc -DBUILD=debug -DUNICODE=1 |
03265572 VS |
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 | |
8870c26e | 560 | ------------- |
a0a302dc | 561 | |
458d26a0 WS |
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). | |
03265572 VS |
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 | |
fc2171bd | 582 | http://www.wxwidgets.org/wxuniv.htm for more information). |
03265572 VS |
583 | |
584 | Advanced options | |
585 | ---------------- | |
586 | ||
587 | MONOLITHIC=1 | |
fc2171bd | 588 | Starting with version 2.5.1, wxWidgets has the ability to be built as |
03265572 VS |
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 | ||
9a8f0513 VS |
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 | ||
03265572 VS |
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 | |
fc2171bd JS |
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 | |
03265572 VS |
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> | |
fc2171bd | 658 | Sets configuration name so that you can have multiple wxWidgets builds with |
03265572 VS |
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 | ||
6acf2ef6 VS |
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: | |
03265572 VS |
707 | |
708 | lib\bcc_msw | |
6acf2ef6 VS |
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. | |
03265572 VS |
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 | ||
6acf2ef6 VS |
732 | lib\bcc_libMyBuild |
733 | lib\bcc_dllMyBuild | |
03265572 VS |
734 | etc. |
735 | ||
fd04b3cb | 736 | By now it is clear what CFG is for: builds with different CFG settings don't |
03265572 VS |
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 | |
fd04b3cb | 740 | would be conflicts between the files). |
03265572 | 741 | |
03265572 VS |
742 | General Notes |
743 | ============= | |
744 | ||
a0a302dc | 745 | - Debugging: under Windows 95, debugging output isn't output in |
9c6751aa | 746 | the same way that it is under NT or Windows 3.1. |
3d82ef9b JS |
747 | Please see DebugView available from http://www.sysinternals.com. |
748 |