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