1 Installing wxWindows 2.5.0
2 --------------------------
4 This is wxWindows 2.5.0 for Microsoft Windows 9x/ME, Windows NT, Windows 2000
5 and Windows XP. This is an unstable development release. Note that unstable in
6 this context doesn't mean that it crashes a lot, just that the library API may
7 change in backwards incompatible way during the 2.5 branch life time.
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
16 http://sourceforge.net/patch/?group_id=9863
18 Please report bugs using the SourceForge bug tracker:
20 http://sourceforge.net/bugs/?group_id=9863
26 A setup program is provided (setup.exe) to automatically copy
27 files to a directory on your hard disk. Do not install into a
28 path that contains spaces. To avoid confusion with other
29 wxWindows installations that might be on your machine, the
30 installation program does not se the WXWIN environment variable;
31 please set this by hand via the System applet if you wish to
34 The setup program contains the following:
36 - All common, generic and MSW-specific wxWindows source;
38 - documentation in Windows Help format;
39 - makefiles for most Windows compilers, plus CodeWarrior,
40 BC++ and VC++ IDE files;
41 - JPEG library source;
42 - TIFF library source;
43 - Object Graphics Library;
45 - Dialog Editor binary.
47 Alternatively, you may unarchive the .zip form by hand:
48 wxMSW-x.y.z.zip where x.y.z is the version number.
50 Unarchive the required files plus any optional documentation
51 files into a suitable directory such as c:\wx.
53 Other add-on packages are available from the wxWindows Web site, such as:
55 - mmedia.zip. Audio, CD, video access for Windows and Linux.
56 - ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
57 - tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
58 the same document source.
61 General installation notes
62 ==========================
64 If installing from the CVS server, copy include/wx/msw/setup0.h to
65 include/wx/msw/setup.h and edit the resulting file to choose
66 the features you would like to compile wxWindows with[out].
72 The following sections explain how to compile wxWindows with each supported
73 compiler. Search for one of Microsoft/Borland/Watcom/Symantec/Metrowerks/
74 Cygwin/Mingw32 to quickly locate the instructions for your compiler.
76 All makefiles and project are located in build\msw directory.
78 Where compiled files are stored
79 -------------------------------
81 After succesful compilation you'll find the libraries in a subdirectory
82 of lib directory named after the compiler, toolkit name and DLL and Unicode
83 settings. A couple of examples:
85 lib\vc_msw VC++ compiled static libraries
86 lib\vc_mswdll VC++ DLLs
87 lib\bcc_mswud Static libraries for Borland C++,
89 lib\wat_mswunivdll Watcom C++ DLLs of wxUniversal port
91 Names of compiled wxWindows libraries follow this scheme: libraries that don't
92 depend on GUI components begin with "wxbase" followed by version number and
93 letters indicating if the library is compiled as Unicode ('u') and/or debug
94 build ('d'). Last component of them name is name of wxWindows component
95 (unless you built the library as single monolithic library; look for
96 "Configuring the build" below). This is a typical set of release ANSI build
97 libraries (release versions on left, debug on right side):
99 wxbase25.lib wxbase25d.lib
100 wxbase25_net.lib wxbase25d_net.lib
101 wxbase25_xml.lib wxbase25d_xml.lib
102 wxmsw25_core.lib wxmsw25d_core.lib
103 wxmsw25_html.lib wxmsw25d_html.lib
104 wxmsw25_adv.lib wxmsw25d_adv.lib
106 These directories also contain wx/setup.h header.
108 Below are compiler specific notes followed by customizing instructions that
109 apply to all compilers (search for "Configuring the build").
112 Microsoft Visual C++ compilation
113 --------------------------------
115 You may wish to visit http://wiki.wxwindows.org/wiki.pl?MSVC for a more
116 informal and more detailed description of the process summarized below.
118 Please note that the VC++ 6.0 project files will work for VC++ .NET also.
120 Also note that you can make the project files work with VC++ 5.0 but you'll
121 need to edit .dsp file by hand before this is possible (change the version in
122 the .dsp file header from 6.0 to 5.0).
124 Using project files (VC++ 6 and later):
126 1. Unarchive wxWindows-x.y.z-vc.zip, the VC++ 6 project
127 makefiles (already included in wxMSW-x.y.z.zip and the setup version).
128 2. Open build\msw\wx.dsw, which has configurations for static
129 compilation or DLL compilation, and each of these available in
130 Unicode/ANSI, Debug/Release and wxUniversal or native variations.
131 Normally you'll use a static linking ANSI configuration.
132 Choose the Win32 Debug or Win32 Release configuration (or any other that
133 suits your needs) and use Batch Build to compile _all_ projects. If you
134 know you won't need some of the libraries (i.e. html part), you don't have
135 to compile it. It will also produce similar variations on jpeg.lib,
136 png.lib, tiff.lib, zlib.lib, and regex.lib.
137 3. Open a sample project file, choose a configuration such as
138 Win32 Debug using Build | Set Active Configuration..., and compile.
139 The project files don't use precompiled headers, to save disk
140 space, but you can switch PCH compiling on for greater speed.
141 NOTE: you may also use samples/samples.dsw to access all
142 sample projects without opening each workspace individually.
143 You can use the Batch Build facility to make several samples
148 1. Change directory to build\msw. Type:
150 'nmake -f makefile.vc'
152 to make the wxWindows core library as release DLL.
153 See "Configuring the build" for instruction how to build debug or static
155 2. Change directory to samples and type 'nmake -f makefile.vc'
156 to make all the samples. You can also make them individually.
160 Use the 'clean' target to clean all objects, libraries and
163 Note (1): if you wish to use templates, please edit
164 include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
165 Without this, the redefinition of 'new' will cause problems in
166 the headers. Alternatively, #undef new before including template headers.
167 You will also need to set wxUSE_IOSTREAMH to 0 if you will be
168 using templates, to avoid the non-template stream files being included
171 Note (2): libraries and applications generated with makefiles and
172 project files are now (hopefully) compatible where static libraries
173 are concerned, but please exercise caution nevertheless and if
174 possible, use one method or the other.
176 Note (3): VC++ 5's optimization code seems to be broken and can
177 cause both compile and run-time problems: this can be seen when
178 deleting an object Dialog Editor, in Release mode with optimizations
179 on. If in doubt, switch off optimisations, although this will result in much
180 larger executables. It seems possible that the library can be created with
181 strong optimization, so long as the application is not strongly
182 optimized. For example, in wxWindows project, set to 'Minimum
183 Size'. In Dialog Editor project, set to 'Customize: Favor Small
184 Code' (and no others). This will then work.
186 Note (4): some crash problems can be due to inconsistent compiler
187 options. If strange/weird/impossible things start to happen please
188 check (dumping IDE project file as makefile and doing text comparison
189 if necessary) that the project settings, especially the list of defined
190 symbols, struct packing, etc. are exactly the same for all items in
191 the project. After this, delete everything (including PCH) and recompile.
193 Note (5): to create your own IDE files, see the technical note on the
194 wxWindows web site or CD-ROM, entitled "Compiling wxWindows
195 applications in the VC++ IDE" (technical note docs/tech/tn0010.htm in the
196 wxWindows distribution). You can also copy .dsp and .dsw
197 files from an existing wxWindows sample and adapt them.
200 Visual C++ 1.5 compilation (16-bit)
201 -----------------------------------
206 Borland C++ 5.0/5.5 compilation
207 -------------------------------
209 Compiling using the makefiles (updated 24 Sept 02):
211 1. Change directory to build\msw. Type 'make -f makefile.bcc' to
212 make the wxWindows core library. Ignore the compiler warnings.
213 This produces a couple of librarie in the lib\bcc_mswdll directory.
215 2. Change directory to a sample or demo such as samples\minimal, and type
216 'make -f makefile.bcc'. This produces a windows exe file - by default
217 in the bcc_mswdll subdirectory.
219 Note (1): the wxWindows makefiles assume dword structure alignment. Please
220 make sure that your own project or makefile settings use the
221 same alignment, or you could experience mysterious crashes. To
222 change the alignment, change CPPFLAGS in build\msw\config.bcc.
224 Note (2): if you get undefined _SQL... symbols at link time,
225 either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
226 directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
227 recompile wxWindows. The same applies if compiling using the IDE.
230 Note (3): If you wish debug messages to be sent to the console in
231 debug mode, edit makefile.bcc and change /aa to /Tpe in link commands.
233 Compiling using the IDE files: [Borland C++ 5.0, not Cbuilder]
235 1. Load src\bc32.ide from the file bc32.zip at
236 http://biolpc22.york.ac.uk/pub/ports/bcc32/wxwin21/ and select Release settings
237 2. Go to Options|Project... and specify the correct BC++ include and lib path for
239 3. Press F9 to compile the wxWindows library.
240 4. Load samples\bc32.ide.
241 5. Go to Options|Project... and specify the correct BC++ include and lib path for
243 6. Press F9 to compile the samples (build each node separately if
244 you prefer, by right clicking and choose Build Node).
245 7. Run each sample: you may need to run from each sample's directory
246 since some (notably the wxHTML samples) look for files
247 relative to the working directory.
249 Note (1): the samples project file contains a selection of
250 samples, and not all samples. The remaining samples can be made
251 with the makefiles. See also the demos hierarchy which doesn't
252 have any BC++ project files yet.
254 Note (2): to make the png, zlib, jpeg and tiff libraries (needed for
255 some samples) you need to compile them with bc32.ide.
257 Note (3): the debug version of the wxWindows library is about 40 MB, and the
258 release version is around 5 MB.
260 See also the file docs/tech/tn0007.txt for further instructions and details
261 of how to create your own project files.
265 In all of your wxWindows applications, your source code should include
266 the following preprocessor directive:
272 (check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for
276 Borland C++Builder IDE compilation
277 ----------------------------------
279 1. Build the wxWindows libraries using the Borland make utility as
280 specified in the section called "Borland C++ 5.0 compilation"
281 above. (C++ Builder includes a stand-alone C++ compiler. For example,
282 C++ Builder 4.0 comes with C++ 5.4.)
284 2. You can use the process_sample_bcb.bat command which is in
285 wxwindows\distrib\msw to generate a .mak or .bpr file for most of the
286 samples [mak for Cbuilder 1-6; v4 and after will convert this to bpr].
287 Execute this in the sampledirectory, passing the name of the cpp files
288 on the command line. For more details, see the instructions in
289 docs/tech/tn0004.htm or http://biolpc22.york.ac.uk/wx/bc/ide.html.
291 Borland 16 Bit compilation for Windows 3.1
292 ------------------------------------------
294 The last version of wxWindows to support 16-bit compilation with Borland was
295 2.2.7 - Please download and read the instructions in that release
297 Watcom C++ 10.6/11 and OpenWatcom compilation
298 ---------------------------------------------
300 1. Change directory to build\msw. Type 'wmake -f makefile.wat' to
301 make the wxWindows core library.
302 2. Change directory to samples\minimal and type 'wmake -f makefile.wat'
303 to make this sample. Repeat for other samples of interest.
306 Note (1): if your installation of Watcom doesn't have odbc32.lib file and
307 you need it (i.e. you have wxUSE_ODBC=1), you can use the file
308 from lib\watcom directory. See the notes in that directory.
310 Note (2): if variant.cpp is compiled with date/time class options, the linker
311 gives up. So the date/time option is switched off for Watcom C++.
312 Also, wxAutomationObject is not compiled with Watcom C++ 10.
314 Note (3): RawBitmaps won't work at present because they use unsupported template
317 Note (4): if Watcom can't read the precompiled header when building a sample,
318 try deleting .pch files in build\msw\wat_* and compiling
322 Metrowerks CodeWarrior compilation
323 ----------------------------------
325 1. CodeWarrior Pro7 project files in XML format are already
326 included in wxMSW-2.5.0.zip and the setup version.
327 2. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if
328 you are working from the CVS version) to make sure the settings reflect
329 what you want. If you aren't sure, leave it alone and go with the
330 default settings. A few notes:
331 - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL
332 - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports
333 will be rather confusing due to interactions with the MSL ANSI
335 3. The project file to build the Win32 wxWindows libraries relies on the
336 Batch File Runner plug-in. This plug-in is not installed as part of
337 a normal CW7 installation. However, you can find this plug-in on the
338 CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the
339 "Batch File Post Linker".
340 4. If you choose not to install the Batch File Runner plug-in, then you
341 need to do the following by hand:
342 (1) Create the directories lib\cw7msw\include\wx and copy the file
343 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
344 working from the CVS version) to lib\cw7msw\include\wx\setup.h
345 (2) Create the directories lib\cw7mswd\include\wx and copy the file
346 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
347 working from the CVS version) to lib\cw7mswd\include\wx\setup.h
348 5. Import src\wxWindowsW7.xml to create the project file wxWindowsW7.mcp.
349 Store this project file in directory src. You may get warnings about
350 not being able to find certain project paths; ignore these warnings, the
351 appropriate paths will be created during the build by the Batch File Runner.
352 6. Choose the wxlib Win32 debug or wxlib Win32 Release target and build. You
353 will get some warnings about hidden virtual functions, illegal conversions
354 from const pointers to pointers, etc., all of which you can safely ignore.
355 ***Note: if you get errors that the compiler can't find "wx/setup.h", just
356 stop the build and build again. These errors occur because sometimes the
357 compiler starts doing its thing before the copying of setup.h has completed.
358 7. The following libraries will be produced depending on chosen
360 - wx_x86.lib ANSI Release (static)
361 - wx_x86_d.lib ANSI Debug (static)
362 8. Sorry, I haven't had time yet to create and test unicode or DLL versions.
363 Volunteers for this are welcome (as neither DLLs nor unicode builds are
364 big priorities for me ;).
365 9. CodeWarrior Pro7 project files (in XML format) are also provided for some
366 of the samples. In particular, there are project files for the minimal,
367 controls, dialogs, dnd, nd docview samples. You can use these project
368 files as templates for the other samples and for your own projects.
369 - For example, to make a project file for the "newgrid" sample,
370 just copy the project file for the "minimal" sample, minimalW7.mcp
371 (made by importing minimalW7.xml into CodeWarrior), into the
372 sample/newgrid directory, calling it newgridW7.mcp. Open
373 newgridW7.mcp and revise the project by deleting the files
374 minimal.rc and minimal.cpp and adding the files griddemo.rc and
375 griddemo.cpp. Build and run....
378 Cygwin/MinGW compilation
379 ------------------------
381 wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
382 releases, and MinGW. Cygwin can be downloaded from:
384 http://sources.redhat.com/cygwin/
388 http://www.mingw.org/
390 Both Cygwin and MinGW can be used with configure (assuming you have MSYS
391 installed in case of MinGW). You will need new enough MinGW version, preferably
392 MinGW 2.0 (ships with gcc3) or at least 1.0 (gcc-2.95.3). GCC versions older
393 than 2.95.3 don't work; you can use wxWindows 2.4 with them.
395 NOTE: some notes specific to old Cygwin (< 1.1.x) are at the end of this
396 section (see OLD VERSIONS)
398 There are two methods of compiling wxWindows, by using the
399 makefiles provided or by using 'configure'.
401 Retrieve and install the latest version of Cygwin, or MinGW, as per
402 the instructions with either of these packages.
404 If using MinGW, you can download the add-on MSYS package to
405 provide Unix-like tools that you'll need to build wxWindows using configure.
407 Using makefiles directly
408 ------------------------
410 NOTE: The makefile are for compilation under Cygwin, MSYS, or
411 command.com/cmd.exe, they won't work in other environments
414 Here are the steps required using the provided makefiles:
416 - If you are using gcc-2.95, edit build\msw\config.gcc and set the GCC_VERSION
419 - Use the makefile.gcc files for compiling wxWindows and samples,
420 e.g. to compile a debugging version of wxWindows:
422 > make -f makefile.gcc BUILD=debug
423 > cd c:\wx\samples\minimal
424 > make -f makefile.gcc BUILD=debug
425 (See below for more options.)
427 Ignore the warning about the default entry point.
429 - Use the 'strip' command to reduce executable/dll size (note that
430 stripping an executable/dll will remove debug information!).
432 All targets have 'clean' targets to allow removal of object files
433 and other intermediate compiler files.
438 Instead of using the makefiles, you can use the configure
439 system to generate appropriate makefiles, as used on Unix
440 and Mac OS X systems.
442 Change directory to the root of the wxWindows distribution,
443 make a build directory, and run configure and make in this directory.
450 ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared
452 make install % This step is optional, see note (8) below.
459 1. See also the Cygwin/MinGW on the web site or CD-ROM for
460 further information about using wxWindows with these compilers.
462 2. libwx.a is 100 MB or more - but much less if compiled with no
463 debug info (-g0) and level 4 optimization (-O4).
465 3. If you get a link error under MinGW 2.95.2 referring to:
467 EnumDAdvise__11IDataObjectPP13IEnumSTATDATA@8
469 then you need to edit the file objidl.h at line 663 and add
470 a missing PURE keyword:
472 STDMETHOD(EnumDAdvise)(THIS_ IEnumSTATDATA**) PURE;
474 4. There's a bug in MinGW headers for some early distributions.
476 in include/windows32/defines.h, where it says:
478 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
482 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
486 5. OpenGL support should work with MinGW as-is. However,
487 if you wish to generate import libraries appropriate either for
488 the MS OpenGL libraries or the SGI OpenGL libraries, go to
489 include/wx/msw/gl and use:
491 dlltool -k -d opengl.def -llibopengl.a
495 dlltool -k -d opengl32.def -llibopengl32.a
497 and similarly for glu[32].def.
499 6. The 'make install' step is optional, and copies files
502 /usr/local/lib - wxmswXYZd.dll.a and wxmswXYZd.dll
503 /usr/local/include/wx - wxWindows header files
504 /usr/local/bin - wx-config
506 You may need to do this if using wx-config with the
509 7. With Cygwin, you can invoke gdb --nw myfile.exe to
510 debug an executable. If there are memory leaks, they will be
511 flagged when the program quits. You can use Cygwin gdb
512 to debug MinGW executables.
517 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
518 to set up appropriate variables, if necessary mounting drives.
519 Run it before compiling.
521 - For Cygwin, make sure there's a \tmp directory on your
522 Windows drive or bison will crash (actually you don't need
523 bison for ordinary wxWindows compilation: a pre-generated .c file is
526 - If using GnuWin32 b18, you will need to copy windres.exe
527 from e.g. the MinGW distribution, to a directory in your path.
530 Symantec & DigitalMars C++ compilation
531 --------------------------------------
532 The DigitalMars compiler is a free succssor to the Symantec compiler
533 and can be downloaded from http://www.digitalmars.com/
535 1. You need to download and unzip in turn (later packages will overwrite
537 Digital Mars C/C++ Compiler Version 8.33
539 beta test C++ Compiler Version 8.34
540 from http://www.digitalmars.com/download/freecompiler.html [02 may 03, CE]
542 2. Change directory to build\msw. Type 'make -f makefile.dm' to
543 make the wxWindows core library.
544 3. Change directory to samples\minimal and type 'make -f makefile.dm'
545 to make this sample. The mdi and image sample also work; others may give
546 linker erros due to missing libraries
548 16-bit compilation is no longer supported.
551 Configuring the build
552 =====================
554 So far the instructions only explained how to build release DLLs of wxWindows
555 and did not cover any configuration. It is possible to change many aspects of
556 the build, including debug/release and ANSI/Unicode settings. All makefiles in
557 build\msw directory use same options (with a few exceptions documented below)
558 and the only difference between them is in object files and library directory
559 names and in make invocation command.
561 Changing the settings
562 ---------------------
564 There are two ways to modify the settings: either by passing the values as
565 arguments when invoking make or by editing build\msw\config.$(compiler) file
566 where $(compiler) is same extension as the makefile you use has (see below).
567 The latter is good for setting options that never change in your development
568 process (e.g. GCC_VERSION or VENDOR). If you want to build several versions of
569 wxWindows and use them side by side, the former method is better. Settings in
570 config.* files are shared by all makefiles (samples, contrib, main library),
571 but if you pass the options as arguments, you must use same arguments you used
572 for the library when building samples or contrib libraries!
574 Examples of invoking make in Unicode debug build (other options described
575 below are set analogically):
578 > nmake -f makefile.vc BUILD=debug UNICODE=1
581 > nmake -f makefile.bcc -DBUILD=debug -DUNICODE=1
582 (Note that you have to use -D to set the variable, unlike in other make
586 > wmake -f makefile.wat BUILD=debug UNICODE=1
588 MinGW using native makefiles:
589 > mingw32-make -f makefile.gcc BUILD=debug UNICODE=1
591 MinGW using configure or Cygwin:
592 > ./configure --enable-debug --enable-unicode
593 (see ./configure --help on details; configure is not covered in this
596 Brief explanation of options and possible values is in every
597 build\msw\config.* file; more detailed description follows.
603 Builds debug version of the library (default is 'release'). This affects
604 name of the library ('d' is appended), __WXDEBUG__ is defined and debug
605 information compiled into object files and the executable.
608 Build static libraries instead of DLLs. By default, DLLs are build
612 To build Unicode versions of the libraries, add UNICODE=1 to make invocation
613 (default is UNICODE=0). If you want to be able to use Unicode version on
614 Windows9x, you will need to set MSLU=1 as well.
616 This option affect name of the library ('u' is appended) and the directory
617 where the library and setup.h are store (ditto).
620 Build wxUniversal instead of native wxMSW (see
621 http://www.wxwindows.org/wxuniv.htm for more information).
627 Starting with version 2.5.0, wxWindows has the ability to be built as
628 several smaller libraries instead of single big one as used to be the case
629 in 2.4 and older versions. This is called "multilib build" and is the
630 default behaviour of makefiles. You can still build single library
631 ("monolithic build") by setting MONOLITHIC variable to 1.
634 Disable building GUI parts of the library, build only wxBase components used
635 by console applications. Note that if you leave USE_GUI=1 then both wxBase
636 and GUI libraries are built. If you are building monolithic library, then
637 you should set wxUSE_GUI to 1 in setup.h.
640 Build wxmsw25_gl.lib library with OpenGL integration class wxGLCanvas.
641 You must also modify your setup.h to #define wxUSE_GLCANVAS 1. Note that
642 OpenGL library is always built as additional library, even in monolithic
646 Build two additional libraries in multilib mode, one with database
647 classes and one with wxGrid database support. You must
648 #define wxUSE_ODBC 1 in setup.h
651 Do not build wxHTML library. If MONOLITHIC=1, then you must also
652 #define wxUSE_HTML 1 in setup.h.
655 Links static version of C and C++ runtime libraries into the executable, so
656 that the program does not depend on DLLs provided with the compiler (e.g.
657 Visual C++'s msvcrt.dll or Borland's cc3250mt.dll).
658 Caution: Do not use static runtime libraries when building DLL (SHARED=1)!
661 Enables MSLU (Microsoft Layer for Unicode). This setting makes sense only if
662 used together with UNICODE=1. If you want to be able to use Unicode version
663 on Windows9x, you will need MSLU (Microsoft Layer for Unicode) runtime DLL
664 and import lib. The former can be downloaded from Microsoft, the latter is
665 part of the latest Platform SDK from Microsoft (see msdn.microsoft.com for
666 details). An alternative implementation of import library can be downloaded
667 from http://libunicows.sourceforge.net - unlike the official one, this one
668 works with other compilers and does not require 300+ MB Platform SDK update.
672 If set to 1, define __WXDEBUG__ symbol, append 'd' to library name and do
673 sanity checks at runtime. If set to 0, don't do it. By default, this is
674 governed by BUILD option (if 'debug', DEBUG_FLAG=1, if 'release' it is 0),
675 but it is sometimes desirable to modify default behaviour and e.g. define
676 __WXDEBUG__ even in release builds.
680 Same as DEBUG_FLAG in behaviour, this option affects whether debugging
681 information is included in the executable or not.
683 VENDOR=<your company name>
684 Set this to a short string identifying your company if you are planning to
685 distribute wxWindows DLLs with your application. Default value is 'custom'.
686 This string is included as part of DLL name. wxWindows DLLs contain compiler
687 name, version information and vendor name in them. For example
688 wxmsw250_core_bcc_custom.dll is one of DLLs build using Borland C++ with
689 default settings. If you set VENDOR=mycorp, the name will change to
690 wxmsw250_core_bcc_mycorp.dll.
692 CFG=<configuration name>
693 Sets configuration name so that you can have multiple wxWindows build with
694 different setup.h settings coexisting in same tree. See "Object and library
695 directories" below for more information.
697 Compiler specific options
698 -------------------------
702 If you are using gcc-2.95 instead of gcc3, you must set GCC_VERSION to
703 2.95. In build\msw\config.gcc, change
712 If set to 1, msvcrtd.dll is used, if to 0, msvcrt.dll is used. By default
713 msvcrtd.dll is used only if the executable contains debug info and
714 msvcrt.dll if it doesn't. It is sometimes desirable to build with debug info
715 and still link against msvcrt.dll (e.g. when you want to ship the app to
716 customers and still have usable .pdb files with debug information) and this
717 setting makes it possible.
719 Fine-tuning the compiler
720 ------------------------
722 All makefiles have variables that you can use to specify additional options
723 passed to the compiler or linker. You won't need this in most cases, but if you
724 do, simply add desired flags to CFLAGS (for C compiler), CXXFLAGS (for C++
725 compiler), CPPFLAGS (for both C and C++ compiler) and LDFLAGS (the linker).
727 Object and library directories
728 ------------------------------
730 All object files produced during library build are stored in a directory under
731 build\msw. It's name is derived from build settings and CFG variable and from
732 compiler name. Examples of directory names:
734 build\msw\bcc_msw SHARED=0
735 build\msw\bcc_mswdll SHARED=1
736 build\msw\bcc_mswunivd SHARED=0, WXUNIV=1, BUILD=debug
737 build\msw\vc_mswunivd ditto, with Visual C++
739 Libraries and DLLs are copied into subdirectory of lib directory with same
740 name as the build\msw subdirectory used for object files:
747 Each lib\ subdirectory has wx subdirectory with setup.h. This file is copied
748 there from include\wx\msw\setup.h (and if it doesn't exist, from
749 include\wx\msw\setup0.h) and this is the copy of setup.h that is used by all
750 samples and should be used by your apps as well. If you are doing changes to
751 setup.h, you should do them in this file, _not_ in include\wx\msw\setup.h.
753 If you set CFG to something, the value is appended to directory names. E.g.
754 for CFG=MyBuild, you'll have object files in
756 build\msw\bcc_mswMyBuild
757 build\msw\bcc_mswdllMyBuild
763 lib\bcc_mswdllMyBuild
766 By now it is clear for CFG is for: builds with different CFG settings don't
767 share any files and they use different setup.h files. This allows you to e.g.
768 have two static debug builds, one with wxUSE_SOCKETS=0 and one with sockets
769 enabled (without CFG, both of them would be put into same directory and there
770 would be conflict between the files).
776 - Debugging: under Windows 95, debugging output isn't output in
777 the same way that it is under NT or Windows 3.1.
778 Please see DebugView (bin/dbgview.exe in the distribution), also
779 available from http://www.sysinternals.com and on the wxWindows CD-ROM
782 - If you are installing wxWindows 2 from CVS, you may find that
783 include/wx/msw/setup.h is missing. This is deliberate, to avoid
784 developers' different setup.h configurations getting confused.
785 Please copy setup0.h to setup.h before compiling. Also, read
786 the BuildCVS.txt for other hints.