X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b59da6c285f4ac1a52a879a7fa67b52351f08f34..6ada5c335980d255e2fb315ed86c091010870c5e:/docs/msw/install.txt diff --git a/docs/msw/install.txt b/docs/msw/install.txt index 151ccac7de..46177f5b75 100644 --- a/docs/msw/install.txt +++ b/docs/msw/install.txt @@ -1,21 +1,26 @@ -Installing wxWindows 2.3 ------------------------- +Installing wxWindows 2.3.3 +-------------------------- -This is wxWindows 2.3 for Microsoft Windows 9x/ME, Windows NT, +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 between 2.3.1 and 2.3.2. This means that +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, -readme.txt, notes on the Web site) carefully before mailing -wx-users or the author. Preferably, try to fix the problem first and -then send a patch to the author. Please report bugs using the -bug report form on the wxWindows web site. +readme.txt, FAQ) carefully before mailing wx-users. Preferably, +try to fix the problem first and then upload a patch to +SourceForge: + + http://sourceforge.net/patch/?group_id=9863 + +Please report bugs using the SourceForge bug tracker: + + http://sourceforge.net/bugs/?group_id=9863 Unarchiving ----------- @@ -29,8 +34,8 @@ program contains the following: - All common, generic and MSW-specific wxWindows source; - samples; - documentation in Windows Help format; -- makefiles for most Windows compilers, plus BC++ and - VC++ IDE files; +- makefiles for most Windows compilers, plus CodeWarrior, + BC++ and VC++ IDE files; - JPEG library source; - TIFF library source; - Object Graphics Library; @@ -131,10 +136,22 @@ Makefile notes: You MUST use the 'cleanall' target (with FINAL=1 or FINAL=0) before making a different configuration, because otherwise object files used to build the previous configuration may be - used accidentally for the current configuation. You might see + used accidentally for the current configuration. You might see 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 ). If you want to + be able to use Unicode version on Windows9x, you will need + MSLU (Microsoft Layer for Unicode) runtime DLL and import lib. + The former can be downloaded from Microsoft, the latter is part + of the latest Platform SDK from Microsoft (see msdn.microsoft.com + for details). An alternative implementation of import library can + be downloaded from http://libunicows.sourceforge.net - unlike the + official one, this one works with other compilers and does not + require 300+ MB Platform SDK update. Add MSLU=1 to the nmake + invocation to enable MSLU. + 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 @@ -205,16 +222,19 @@ 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: 0. If downloading from CVS, copy include\wx\msw\setup0.h to include\wx\setup.h. -1. Make sure your WXWIN variable is set, and uses the FAT (short - name) form if doing a 16-bit compile. -2. Change directory to wx\src\msw. Type 'make -f makefile.b32' to +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. + Reboot if needed for the changes to autoexec.bat to take effect. +2. Change directory to src\msw. Type 'make -f makefile.b32' to make the wxWindows core library. Ignore the warnings about 'XXX' not found in library. 3. Change directory to a sample or demo such as samples\minimal, and type @@ -231,40 +251,44 @@ Compiling using the makefiles: 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 +Note (1): In Borland 4.5 and earleir, using bcc.exe you also need to define BCCDIR +in the autoexec.bat file; like this: + set BCCDIR=c:\progra~1\borland\bcc + so that it points to the root directory of + your Borland C++ installation, and it uses the FAT (short + name) form with no spaces. + + +Note (2): the wxWindows library and (some) samples compile in 16-bit mode using makefile.bcc, but at present the wxWindows resource system is switched off in this mode. See issues.txt for details. -Note (2): unfortunately most samples won't link in 16-bit mode, +Note (3): unfortunately most samples won't link in 16-bit mode, because the automatic data segment exceeds 64K. The minimal sample links and runs, however. -Note (3): the wxWindows makefiles assume byte structure alignment. Please +Note (4): the wxWindows makefiles assume byte structure alignment. Please make sure that your own project or makefile settings use the same alignment, or you could experience mysterious crashes. To change the alignment, add a suitable option to the $(CFG) target code in src/msw/makefile.b32. -Note (4): if you get undefined _SQL... symbols at link time, +Note (5): if you get undefined _SQL... symbols at link time, either install odbc32.lib from the BC++ CD-ROM into your BC++ lib directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and recompile wxWindows. The same applies if compiling using the IDE. -Note (5): BC++ 4.5 (not 5.0) trips up over jdmerge.c in the JPEG folder; +Note (6): BC++ 4.5 (not 5.0) trips up over jdmerge.c in the JPEG folder; 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 (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,78 +317,6 @@ release version is around 5 MB. See also the file docs/tech/tn0007.txt for further instructions and details of how to create your own project files. -Borland C++ 5.5 compilation ---------------------------- - -Before compiling wxWindows with Borland C++ 5.5, there are a few -issues concerning the compiler installation: - -1. The compiler must be installed to a path that does not contain - spaces, such as c:\Borland\Bcc55 (in particular, do not install - it below "C:\Program Files"). - -2. Make sure that you downloaded and installed the service pack 1 - for Borland C++ 5.5. This SP1 can be downloaded from: - http://www.borland.com/devsupport/bcppbuilder/patches/#freecompiler55 - - IMPORTANT: - When installing SP1, make sure that you extract (UnZip) the files - to the directory where you installed Borland C++ 5.5 (e.g., - c:\Borland\Bcc55) with the option "use folder names" selected. - This is necessary, to ensure that the files (mostly include files) - are extracted to the right directory. - -3. Create the following two files in the same directory where you - installed Borland C++ 5.5 (e.g., c:\Borland\Bcc55): - - a. bcc32.cfg - text file containing the following two lines: - -I"c:\Borland\Bcc55\include" - -L"c:\Borland\Bcc55\lib" - - b. ilink32.cfg - text file containing the following line: - -L"c:\Borland\Bcc55\lib" - - (replace c:\Borland\Bcc55 with the actual path where you installed - Borland C++ 5.5) - -4. Add the borland BIN directory to your path (e.g., c:\Borland\Bcc55\bin), - and define the environment variable BCCDIR= - (e.g., set BCCDIR=c:\Borland\Bcc55) - -Compiling wxWindows: - -Once the compiler and its service pack are properly installed, you build -wxWindows using the provided makefile.b32 in the src/msw directory: - -a. To build wxWindows in DEBUG mode: - - cd c:\wx2\src\msw - make -f makefile.b32 - - (replace c:\wx2 with the actual path where you installed wxWindows) - -b. To build wxWindows in RELEASE mode: - - cd c:\wx2\src\msw - make -f makefile.b32 FINAL=1 - - (if you had previously built wxWindows, you need to clean all of - the object and intermediate files. Before the above make command, - run: 'make -f makefile.b32 CLEANALL') - -IMPORTANT: -The Service Pack 1 for Borland C++ 5.5 must be installed before wxWindows -is compiled. If you compiled wxWindows before, it is advised that you -re-compile it following the next steps: - - cd c:\wx2\src\msw - make -f makefile.b32 CLEANALL - make -f makefile.b32 (or make -f makefile.b32 FINAL=1) - - (replace c:\wx2 with the actual path where you installed wxWindows) - ** REMEMBER ** In all of your wxWindows applications, your source code should include @@ -377,7 +329,7 @@ the following preprocessor directive: (check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for more details) -Borland C++Builder compilation +Borland C++Builder IDE compilation ------------------------------ 1. Build the wxWindows libraries using the Borland make utility as @@ -388,6 +340,10 @@ Borland C++Builder compilation 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 --------------------------- @@ -412,17 +368,58 @@ compiling the sample again. Metrowerks CodeWarrior compilation ---------------------------------- -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 - course. - -Note (1): you need CodeWarrior Pro 4 plus the patches to 4.1 from the -Metrowerks Web site. +1. CodeWarrior Pro7 project files in XML format are already + included in wxMSW-2.3.3.zip and the setup version. +2. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if + you are working from the CVS version) to make sure the settings reflect + what you want. If you aren't sure, leave it alone and go with the + default settings. A few notes: + - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL + - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports + will be rather confusing due to interactions with the MSL ANSI + and runtime libs. +3. The project file to build the Win32 wxWindows libraries relies on the + Batch File Runner plug-in. This plug-in is not installed as part of + a normal CW7 installation. However, you can find this plug-in on the + CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the + "Batch File Post Linker". +4. If you choose not to install the Batch File Runner plug-in, then you + need to do the following by hand: + (1) Create the directories lib\cw7msw\include\wx and copy the file + include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are + working from the CVS version) to lib\cw7msw\include\wx\setup.h + (2) Create the directories lib\cw7mswd\include\wx and copy the file + include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are + working from the CVS version) to lib\cw7mswd\include\wx\setup.h +5. Import src\wxWindowsW7.xml to create the project file wxWindowsW7.mcp. + Store this project file in directory src. You may get warnings about + not being able to find certain project paths; ignore these warnings, the + appropriate paths will be created during the build by the Batch File Runner. +6. Choose the wxlib Win32 debug or wxlib Win32 Release target and build. You + will get some warnings about hidden virtual functions, illegal conversions + from const pointers to pointers, etc., all of which you can safely ignore. + ***Note: if you get errors that the compiler can't find "wx/setup.h", just + stop the build and build again. These errors occur because sometimes the + compiler starts doing its thing before the copying of setup.h has completed. +7. The following libraries will be produced depending on chosen + target: + - wx_x86.lib ANSI Release (static) + - wx_x86_d.lib ANSI Debug (static) +8. Sorry, I haven't had time yet to create and test unicode or DLL versions. + Volunteers for this are welcome (as neither DLLs nor unicode builds are + big priorities for me ;). +9. CodeWarrior Pro7 project files (in XML format) are also provided for some + of the samples. In particular, there are project files for the minimal, + controls, dialogs, dnd, nd docview samples. You can use these project + files as templates for the other samples and for your own projects. + - For example, to make a project file for the "newgrid" sample, + just copy the project file for the "minimal" sample, minimalW7.mcp + (made by importing minimalW7.xml into CodeWarrior), into the + sample/newgrid directory, calling it newgridW7.mcp. Open + newgridW7.mcp and revise the project by deleting the files + minimal.rc and minimal.cpp and adding the files griddemo.rc and + griddemo.cpp. Build and run.... -Note (2): unfortunately these files are not yet up-to-date for the -current release. Symantec C++ compilation ------------------------ @@ -440,7 +437,7 @@ start address'). 32-bit compilation only (partially) supported at present, using SC++ 6.1. Some functionality is missing using this compiler (see makefile). Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore -Step (2). 16-bit compilation is left as an excercise for the user! +Step (2). 16-bit compilation is left as an exercise for the user! Salford C++ compilation ----------------------- @@ -470,66 +467,98 @@ releases, and Mingw32. Thanks are due to Keith Garry Boyce (garp@opustel.com), Cygnus and others for making it all possible. -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. -Here are the steps required: +NOTE: some notes specific to old Cygwin ( < 1.1.x ) + and MinGW ( < 1.0 ) are at the end of this section + ( see OLD VERSIONS ) -- Retrieve and install the latest beta of Cygwin, or Mingw32, as per the - instructions with either of these packages. -- 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. +There are two methods of compiling wxWindows, by using the +makefiles provided or by using 'configure'. - 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. +Retrieve and install the latest version of Cygwin, or Mingw32, as per the +instructions with either of these packages. - 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. +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. -- 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. + ftp://biolp22.york.ac.uk/pub/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. -- 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). +Using makefiles +=============== -- 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. +Here are the steps required using the provided makefiles: - 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 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. + +Using configure +=============== + +Instead of using the makefiles, you can use the configure +system to generate appropriate makefiles, as used on Unix +and Mac OS X systems. + +Change directory to the root of the wxWindows distribution, +make a build directory, and then run configure and make. + +For example: + + cd $WXWIN + mkdir build-debug + cd build-debug + ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared + make + cd samples/minimal + make + ./minimal.exe + Notes: @@ -571,10 +600,34 @@ 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 Cygwin site is at - http://sourceware.cygnus.com + http://sources.redhat.com/cygwin - Mingw32 is available at: ftp://www.mingw.org