X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9c6751aa4693c748f56aebf3de3e3d3d48532471..ea323db37d324661f7140dded22dc69a1f743350:/docs/msw/install.txt diff --git a/docs/msw/install.txt b/docs/msw/install.txt index 2444068794..edca741285 100644 --- a/docs/msw/install.txt +++ b/docs/msw/install.txt @@ -1,11 +1,14 @@ -Installing wxWindows 2.1 ------------------------- +Installing wxWindows 2.3.3 +-------------------------- -This is a beta release of wxWindows 2.1 for Microsoft -Windows 95, 98 and NT. This is not a production release, -although a huge number of bugs found in earlier versions -of wxWindows have been fixed. +This is wxWindows 2.3.3 for Microsoft Windows 9x/ME, Windows NT, +Windows 2000 and Windows XP. This is an unstable development release. + +Please note that the library naming conventions for VC++ +compilation have changed after 2.3.1. This means that +you will need to change your application project files. See the +relevant section below for details. IMPORTANT NOTE: If you experience problems installing, please re-read this instructions and other related files (changes.txt, @@ -34,20 +37,8 @@ program contains the following: - Tex2RTF source; - Dialog Editor binary. -Alternatively, you may unarchive the set of .zip files by hand, -where x is the minor version number and y is the release number: - -wx2_x_y_gen.zip Generic source code and samples (required) -wx2_x_y_msw.zip Windows-specific source code and samples (required) -wx2_x_y_doc.zip Documentation source code (not required) -wx2_x_y_hlp.zip WinHelp documentation -wx2_x_y_pdf.zip Acrobat PDF documentation -wx2_x_y_htm.zip HTML documentation -wx2_x_y_vc.zip MS VC++ 5.0 project files -wx2_x_y_cw.zip Metrowerks CodeWarrior project files -wx2_x_y_bc.zip BC++ 5 project files -jpeg.zip Use this to allow wxImage to read and write JPEG files -tiff.zip Use this to allow wxImage to read and write TIFF files +Alternatively, you may unarchive the .zip form by hand: +wxMSW-x.y.z.zip where x.y.z is the version number. Unarchive the required files plus any optional documentation files into a suitable directory such as c:\wx. @@ -67,8 +58,8 @@ For Cygwin or Mingw32 compilation, make sure WXWIN contains only forward slashes. If installing from the CVS server, copy include/wx/msw/setup0.h to -include/wx/msw/setup.h and edit the resulting file to choose the featrues you -would like to compile wxWindows with[out]. +include/wx/msw/setup.h and edit the resulting file to choose +the features you would like to compile wxWindows with[out]. Compilation ----------- @@ -76,26 +67,35 @@ Compilation The following sections explain how to compile wxWindows with each supported compiler. -Visual C++ 4.0/5.0/6.0 compilation ----------------------------------- +Visual C++ 6.0 compilation +--------------------------- -Using project files (VC++ 5 and 6 only): - -1. Unarchive wx2_x_y_vc.zip, the VC++ 5/6 project makefiles. -2. Open src/wxvc.dsp, set Debug or Release configuration for - the wxvc project, and compile. Alternatively, use Batch Build - to build both Debug and Release configurations. - This will produce lib/wx.lib (release) and lib/wxd.lib (debug), - plus various subordinate libraries. It assumes you have - the TIFF and JPEG source, which is already in the setup - version of the distribution. - The project file src/wxvc_dll.dsp will make a DLL version of wxWindow, - which will go in lib/wxdll.[lib,dll] and lib/wxdlld.[lib,dll]. +Using project files (VC++ 6 only): + +1. Unarchive wxWindows-x.y.z-vc.zip, the VC++ 6 project + makefiles (already included in wxMSW-x.y.z.zip and the setup version). +2. Open src/wxWindows.dsp, which has configurations for static + compilation or DLL compilation, and each of these available in + Unicode/ANSI and Debug/Release variations. Normally you'll use + a static linking ANSI configuration. Choose the Win32 Debug or + Win32 Release configuration for the wxWindows project, and compile. + Alternatively, use Batch Build to build more than one + configuration. + The following libraries will be produced depending on chosen + configuration: + + wxmsw.lib wxmswd.lib ; ANSI Release/Debug + wxmswu.lib wxmswud.lib ; UNICODE Release/Debug + wxmsw23x.lib wxmsw23xd.lib ; ANSI DLL Release/Debug + wxmsw23xu.lib wxmsw23xud.lib ; UNICODE DLL Release/Debug + + It will also produce similar variations on jpeg.lib, png.lib, + tiff.lib, zlib.lib, and regex.lib. 3. Open a sample project file, choose a configuration such as - Debug using Build | Set Active Configuration..., and compile. + Win32 Debug using Build | Set Active Configuration..., and compile. The project files don't use precompiled headers, to save disk space, but you can switch PCH compiling on for greater speed. - NOTE: you may also use samples/SamplesVC.dsw to access all + NOTE: you may also use samples/samples.dsw to access all sample projects without opening each workspace individually. You can use the Batch Build facility to make several samples at a time. @@ -117,8 +117,7 @@ Using makefiles: 'nmake -f makefile.vc cleanall FINAL=1' 'nmake -f makefile.vc FINAL=1' - to make the wxWindows core library without debug information - (wx\lib\wx.lib). + to make the wxWindows core library without debug information. 4. Change directory to wx\samples and type 'nmake -f makefile.vc' to make all the samples. You can also make them individually. @@ -136,6 +135,9 @@ Makefile notes: this manifested in unexpected link errors or warnings. This problem doesn't occur when using project files to build wxWindows. + To build Unicode versions of the libraries, add UNICODE=1 + to the nmake invocation ( default is UNICODE=0 ). + Note that the wxWindows core library allows you to have debug and release libraries available simultaneously, by compiling the objects in different subdirectories, whereas samples must be @@ -146,11 +148,7 @@ To build the DLL version using makefiles: 1. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll pch' to make both a suitable DLL and import library, and to build a suitable precompiled header file for compiling applications. - The resulting libraries are called: - - wx\lib\wx[version].lib(dll) (debug version) - wx\lib\wx[version].lib(dll) (release version, using FINAL=1) - + See the previous section for library names. 2. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1' (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all applications). @@ -178,18 +176,6 @@ optimized. For example, in wxWindows project, set to 'Minimum Size'. In Dialog Editor project, set to 'Customize: Favor Small Code' (and no others). This will then work. -Similarly, in VC++ 4, optimization can cause internal compiler -errors, so edit src\makevc.env and change /O1 to /Od before -trying build a release version of the library. Or, type: - -nmake -f makefile.vc noopt FINAL=1 - -and then resume compilation in the normal way. This will build -troublesome files with no optimization. However, there now seems to be -an internal linker error using VC++ 4, in addition to internal -compiler errors for most of the samples, so this version of the compiler -cannot be recommended! - Note (4): some crash problems can be due to inconsistent compiler options. If strange/weird/impossible things start to happen please check (dumping IDE project file as makefile and doing text comparison @@ -197,19 +183,18 @@ if necessary) that the project settings, especially the list of defined symbols, struct packing, etc. are exactly the same for all items in the project. After this, delete everything (including PCH) and recompile. -Note (5): for some further notes about upgrading your project -files to be compatible with wxWindows 2.1.14, please see -"Highlights of wxWindows 2.1.14" from the Download page of the -web site or CD-ROM. - -Note (6): to create your own IDE files, see the technical note on the +Note (5): to create your own IDE files, see the technical note on the wxWindows web site or CD-ROM, entitled "Compiling wxWindows -applications in the VC++ IDE". You can also copy .dsp and .dsw +applications in the VC++ IDE" (technical note docs/tech/tn0010.htm in the +wxWindows distribution). You can also copy .dsp and .dsw files from an existing wxWindows sample and adapt them. Visual C++ 1.5 compilation (16-bit) ----------------------------------- +NOTE: this has not been tested recently and probably doesn't +work. + 1. Make sure your WXWIN variable is set, and uses the FAT (short name) form. 2. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to @@ -223,13 +208,23 @@ versions of the library and samples. Use the 'clean' target to clean all objects, libraries and executables. -Borland C++ 4.5/5.0 compilation +Borland C++ 4.5/5.0/5.5 compilation ------------------------------- Compiling using the makefiles: -1. Make sure your WXWIN variable is set, and uses the FAT (short - name) form if doing a 16-bit compile. +0. If downloading from CVS, copy include\wx\msw\setup0.h to + include\wx\setup.h. +1. Make sure your WXWIN variable is set [e.g add + set WXWIN=c:\wxwindows + to your autoexec.bat file], and that it uses the FAT (short + name) form with no spaces. + Make sure your BCCDIR variable is set [e.g add + set BCCDIR=c:\progra~1\borland\bcc + to your autoexec.bat file], and that it points to the root directory of + your Borland C++ installation, and it uses the FAT (short + name) form with no spaces. + Reboot if needed for the changes to autoexec.bat to take effect. 2. Change directory to wx\src\msw. Type 'make -f makefile.b32' to make the wxWindows core library. Ignore the warnings about 'XXX' not found in library. @@ -239,6 +234,13 @@ Compiling using the makefiles: 'make -f makefile.b32 clean' 'make -f makefile.b32 FINAL=1' for the library and samples. +5. To make and use wxWindows as a DLL, type + 'make -f makefile.b32 clean' + 'make -f makefile.b32 DLL=1' + and then for each sample, + 'make -f makefile.b32 WXUSINGDLL=1' + Please note that the samples have not been exhaustively tested + with this configuration. Note (1): the wxWindows library and (some) samples compile in 16-bit mode using makefile.bcc, but at present the wxWindows resource system is switched @@ -264,16 +266,13 @@ you will therefore need to set wxUSE_LIBJPEG to 0 in setup.h and remove the jpeg target from src\msw\makefile.b32, and remove jpeg from src\makeprog.b32. -Note (6): If using C++Builder 4 and above (BC++ 5.4 and above), change LINK=tlink32 to -LINK=ilink32 in src\makeb32.env. You may also need to disable -wxUSE_LIBJPEG because there is a conflict in the BC++ headers -(actually this problem seems to have gone away with 5.5 and SP1). +Note (6): [obsolete] Note (7): If you wish debug messages to be sent to the console in debug mode, edit src\makeb32.env and change /aa to /Tpe in LINK_FLAGS. -Compiling using the IDE files: +Compiling using the IDE files: [Borland C++ 5.0, not Cbuilder] 1. Load src\bc32.ide (Release settings) 2. Go to Options|Project... and specify the correct BC++ include and lib path for @@ -293,58 +292,67 @@ samples, and not all samples. The remaining samples can be made with the makefiles. See also the demos hierarchy which doesn't have any BC++ project files yet. -Note (2): to make the png, xpm, zlib, jpeg and tiff libraries (needed for +Note (2): to make the png, zlib, jpeg and tiff libraries (needed for some samples) you need to compile them with bc32.ide. Note (3): the debug version of the wxWindows library is about 40 MB, and the release version is around 5 MB. -See also the file bc_ide.txt for further instructions and details +See also the file docs/tech/tn0007.txt for further instructions and details of how to create your own project files. -Borland C++Builder compilation +** REMEMBER ** + +In all of your wxWindows applications, your source code should include +the following preprocessor directive: + +#ifdef __BORLANDC__ +#pragma hdrstop +#endif + +(check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for +more details) + +Borland C++Builder IDE compilation ------------------------------ -C++Builder compilation is the same as for Borland C++ above. +1. Build the wxWindows libraries using the Borland make utility as + specified in the section called "Borland C++ 4.5/5.0 compilation" + above. (C++ Builder includes a stand-alone C++ compiler. For example, + C++ Builder 4.0 comes with C++ 5.4.) -Tested with C++Builder 1.0 and 3.0. Only makefiles are currently -supplied. +2. You can build samples using the makefiles as per the + instructions for BC++ above, or you can follow the instructions + in docs/tech/tn0004.htm or http://biolpc22.york.ac.uk/wx/bc/ide.html. + You can use the process_sample_bcb.bat command which is in + wxwindows\distrib\msw to generate a .mak or .bpr file for most of the + samples [mak for Cbuilder 1-3; bpr for v4]. Execute this in the sample + directory, passing the name of the cpp files on the command line. Watcom C++ 10.6/11 compilation --------------------------- 1. Make sure your WXWIN variable is set, and uses the DOS short name form. -2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat' to +2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat all' to make the wxWindows core library. -3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat' +3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat all' to make this sample. Repeat for other samples of interest. -Note (1): setup.h overrides wxUSE_LIBJPEG and sets it to 0, since -imagjpeg.cpp doesn't compile. -Note (2): makewat.env uses the odbc32.lib supplied in wxWindows' lib\watcom +Note (1): makewat.env uses the odbc32.lib supplied in wxWindows' lib\watcom directory. See the notes in that directory. -Note (3): if variant.cpp is compiled with date/time class +Note (2): if variant.cpp is compiled with date/time class options, the linker gives up. So the date/time option is switched off for Watcom C++. Also, wxAutomationObject is not compiled with Watcom C++. -Note (4): if Watcom can't read the precompiled header when +Note (3): if Watcom can't read the precompiled header when building a sample, try deleting src\msw\watcom.pch and compiling the sample again. -Note (5): if you get _popen_ and _pclose_ link errors, try -recompiling wxWindows with XPM support disabled in setup.h. -Alternatively, make sure these lines exist at the top of -src\xpm\xpmi.h: - -// Added by JACS for Watcom C++/wxWindows compilation (no popen/pclose functions) -#ifdef __WATCOMC__ -#define NO_ZPIPE -#endif Metrowerks CodeWarrior compilation ---------------------------------- -1. Downloaded and unzip wx2_x_y_cw.zip. +1. Downloaded and unzip wxWindows-x.y.z-cw.zip. 2. Load the make_cw.mcp project in wx\src, and compile. 3. Load the make_cw.mcp project in wx\samples\minimal, and compile. Further project files for samples will be available in due @@ -393,79 +401,78 @@ the debugging version of the library is 90MB, with samples coming in at 40MB :-) However, wxWindows at least makes a good test suite for improving the compiler. -Cygwin b19/b20/Mingw32 compilation +Cygwin/Mingw32 compilation ---------------------------------- -wxWindows 2 supports Cygwin (formerly GnuWin32) b19, b20, Mingw32, -and Mingw32/EGCS. +wxWindows 2 supports Cygwin (formerly GnuWin32) betas and +releases, and Mingw32. -Thanks are due to Keith Garry Boyce (garp@opustel.com) and Cygnus for making -it all possible. +Thanks are due to Keith Garry Boyce (garp@opustel.com), Cygnus +and others for making it all possible. -From wxWindows 2.0 beta 9, both Cygwin and Mingw32 (the minimal -distribution of Cygwin) can be used with the same makefiles. +Both Cygwin and MinGW can be used with the same makefiles. + +NOTE: some notes specific to old Cygwin ( < 1.1.x ) + and MinGW ( < 1.0 ) are at the end of this section + ( see OLD VERSIONS ) Here are the steps required: -- Retrieve and install the latest beta of Cygwin, or Mingw32, as per the +- Retrieve and install the latest version of Cygwin, or Mingw32, as per the instructions with either of these packages. -- If using Mingw32 (including the EGCS variant), you need some - extra files to use the wxWindows makefiles. You can find these - files in ports/mingw32 on the ftp site or CD-ROM, as extra.zip. - These should be extracted to the Mingw32 directory. - If you have already have downloaded bison, flex, make, rm, cp, mv - from elsewhere, you won't need this. - - If using Mingw32 2.8.1, see also see mingw32.txt in this directory - (docs/msw) about a fix that has to be applied to a Mingw32 header file. - - If using Mingw32 2.95 and below with wxWindows 2.1 or above, you - must hand-patch in Mingw32-gcc295.patches (located in the top-level of the - wxWindows 2 installation). Mingw32 2.95.2 and above contain the - fixes already. - -- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat) - to set up appropriate variables, if necessary mounting drives. - Run it before compiling. - -- For Cygwin, make sure there's a \tmp directory on your - Windows drive or bison will crash (actually you don't need this - for ordinary wxWindows compilation: a pre-generated .c file is - supplied). - -- Edit wx/src/makeg95.env and set the MINGW32 variable at the top of - the file to either 1 (you have Mingw32) or 0 (you have Cygwin32). - If using MINGW32, also set the MINGW32VERSION variable - appropriately. +- If using Mingw32, you need some extra files to use the wxWindows + makefiles. You can find these files in ports/mingw32 on the + wxWindows ftp site or CD-ROM, as extra.zip. -- Mingw32 may not support winsock.h, so if you have a problem - here, comment out socket-related files in src/msw/makefile.g95. + ftp://ftp.remstar.com/pub/wxwin/ports/mingw32/extra.zip + + These should be extracted to the Mingw32 directory. If you have + already downloaded rm, cp, mv from elsewhere, you won't need this. - Set your WXWIN variable to where wxWindows is installed. *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not backslashes. - Use the makefile.g95 files for compiling wxWindows and samples, - e.g.: + e.g. to compile a debugging version of wxWindows: > cd c:\wx\src\msw > make -f makefile.g95 > cd c:\wx\samples\minimal > make -f makefile.g95 + to compile with optimizations: + > cd c:\wx\src\msw + > make -f makefile.g95 FINAL=1 + > cd c:\wx\samples\minimal + > make -f makefile.g95 FINAL=1 + + to compile a DLL: + > cd c:\wx\src\msw + > make -f makefile.g95 WXMAKINGDLL=1 + > cd c:\wx\samples\minimal + > make -f makefile.g95 WXUSINGDLL=1 + + to compile the Unicode version: + > cd c:\wx\src\msw + > make -f makefile.g95 UNICODE=1 + > cd c:\wx\samples\minimal + > make -f makefile.g95 UNICODE=1 + + Options can be combined ( e.g.: UNICODE=1 FINAL=1 ) + Ignore the warning about the default entry point. - Use the 'strip' command to reduce executable size. -- With Cygnus Cygwin, you can invoke gdb --nw myfile.exe to +- With Cygwin, you can invoke gdb --nw myfile.exe to debug an executable. If there are memory leaks, they will be - flagged when the program quits. - -- If using GnuWin32 b18, you will need to copy windres.exe - from e.g. the Mingw32 distribution, to a directory in your path. + flagged when the program quits. You can use Cygwin gdb + to debug MinGW executables. All targets have 'clean' targets to allow removal of object files -and other intermediate compiler files. +and other intermediate compiler files and 'cleanall' targets to +allow removal of all object files and library files. Notes: @@ -487,9 +494,9 @@ Notes: (a missing bracket). -4. If there's a problem with the copy command in +4. If there's a problem with the copy or remove commands in src/msw/makefile.g95, you may need to change the COPY and - COPYSEP variables in makeg95.env. + RM variables in makeg95.env. 5. If there's a problem executing the windres program, try commenting out RCPREPROCESSOR in makeg95.env. @@ -507,13 +514,36 @@ Notes: and similarly for glu[32].def. +OLD VERSIONS: + +- If using Mingw32 2.95 and below with wxWindows 2.1 or above, you + must hand-patch with Mingw32-gcc295.patches (located in the + top-level of the wxWindows 2 installation). Mingw32 2.95.2 + and above contain the fixes already. + +- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat) + to set up appropriate variables, if necessary mounting drives. + Run it before compiling. + +- For Cygwin, make sure there's a \tmp directory on your + Windows drive or bison will crash (actually you don't need + bison for ordinary wxWindows compilation: a pre-generated .c file is + supplied). + +- Edit wx/src/makeg95.env and set the MINGW32 variable at the top of + the file to either 1 (you have Mingw32 or Cygwin 1.x releases) or 0 + (if you have Cygwin betas). If using Mingw32, also set the + MINGW32VERSION variable appropriately. + +- If using GnuWin32 b18, you will need to copy windres.exe + from e.g. the Mingw32 distribution, to a directory in your path. + References: - - The GNU-WIN32 site is at - http://www.cygnus.com/gnu-win32/ + - The Cygwin site is at + http://sources.redhat.com/cygwin - Mingw32 is available at: - ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/mingw32/gcc-2.95/ - - See also http://web.ukonline.co.uk/julian.smart/wxwin/gnuwin32.htm + ftp://www.mingw.org TWIN32 and gcc on Linux ----------------------- @@ -542,5 +572,6 @@ General Notes - If you are installing wxWindows 2 from CVS, you may find that include/wx/msw/setup.h is missing. This is deliberate, to avoid developers' different setup.h configurations getting confused. - Please copy setup0.h to setup.h before compiling. + Please copy setup0.h to setup.h before compiling. Also, read + the BuildCVS.txt for other hints.