]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/msw/install.txt
patched DoSetClippingRegionAsRegion to update clipping state vars
[wxWidgets.git] / docs / msw / install.txt
index a8e5447ff59d68480af002de671bc0fda8890795..3a5e7d719a505acdcea883cc84eb65f34002837c 100644 (file)
@@ -1,31 +1,54 @@
 
-Installing wxWindows 2.0
+Installing wxWindows 2.1
 ------------------------
 
+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 wxWindows 2.0 have been
+fixed.
+
 IMPORTANT NOTE: If you experience problems installing, please
-re-read this instructions and other related files (todo.txt,
-bugs.txt etc.) carefully before mailing wxwin-users or
+re-read this instructions and other related files (release.txt,
+todo.txt, bugs.txt etc.) carefully before mailing wxwin-users or
 the author. Preferably, try to fix the problem first and
-then send a patch to the author.
+then send a patch to the author. Please report bugs using the
+bug report form on the wxWindows web site.
 
 Unarchiving
 -----------
 
-If there is a setup program, run the setup program that comes with the Windows version.
-Do not install into a path that contains spaces. The installation program should set the
-WXWIN environment variable, which will be activated when your machine is rebooted.
-
-If there is no setup program, it will come as a series of .zip
-files:
-
-wx200gen.zip            Generic source code and samples (required)
-wx200msw.zip            Windows-specific source code and samples (required)
-wx200doc.zip            Documentation source code (not required)
-wx200hlp.zip            WinHelp documentation
-wx200pdf.zip            Acrobat PDF documentation
-wx200htm.zip            HTML documentation
-wx200vc.zip             MS VC++ 5.0 project files
-wx200cw.zip             Metrowerks CodeWarrior project files
+A setup program is provided (setup.exe) to automatically copy files to a
+directory on your hard disk. Do not install into a path that contains spaces.
+The installation program should set the WXWIN environment variable, which
+will be activated when your machine is rebooted. The setup
+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;
+- JPEG library source;
+- Object Graphics Library;
+- wxGLCanvas library;
+- wxTreeLayout library;
+- 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
 
 Unarchive the required files plus any optional documentation
 files into a suitable directory such as c:\wx.
@@ -45,7 +68,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.
+include/wx/msw/setup.h and edit the resulting file to choose the featrues you
+would like to compile wxWindows with[out].
 
 Compilation
 -----------
@@ -58,33 +82,70 @@ Visual C++ 4.0/5.0/6.0 compilation
 
 Using project files:
 
-1. Unarchive wx200vc.zip, the VC++ 5 project makefiles.
+1. Unarchive wx2_x_y_vc.zip, the VC++ 5/6 project makefiles.
 2. Open src/wxvc.dsp, set Debug or Release configuration, and
-   compile. This will produce lib/wxvc.lib or lib/wxvc_debug.lib.
-3. Open a sample project file, choose a configuration, and compile.
+   compile. This will produce src/Debug/wxvc.lib or
+   src/Release/wxvc.lib.  The project file src/wxvc_dll.dsp
+   will make a DLL version of wxWindow, which will go in
+   src/DebugDLL/wxvc.[lib,dll] and src/ReleaseDLL/wxvc.[lib,dll].
+3. If you want to use JPEG in your application (such as the image
+   sample), open src/jpeg/jpeg.dsp (VC++ 5/6 only) and compile in
+   Debug and Release configurations. If you have VC++ 4,
+   use makefile.vc, but you may only have one set of object
+   files at a time in use (debug or release versions).
+4. Open a sample project file, choose a configuration using
+   Build | Set Active Configuration..., and compile.
    The project files don't use precompiled headers, to save
    space, but you can switch PCH compiling on for greater speed.
 
 Using makefiles:
 
 1. Make sure your WXWIN variable is set.
-2. Change directory to wx\src\msw. Type 'nmake -f makefile.vc' to
-   make the wxWindows core library.
-3. Change directory to wx\samples and type 'nmake -f makefile.vc'
+2. If you do NOT have the TIFF or JPEG source code, please remove
+   the tiff and jpeg targets from the 'all' target in
+   src\msw\makefile.vc. Also ensure the settings in
+   include\wx\msw\setup.h specify not to use JPEG or TIFF.
+3. Change directory to wx\src\msw. Type:
+
+  'nmake -f makefile.vc'
+
+   to make the wxWindows core library with debug information
+   (wx\lib\wx_d.lib), or
+
+  'nmake -f makefile.vc FINAL=1'
+
+   to make the wxWindows core library without debug information
+   (wx\lib\wx.lib).
+4. Change directory to wx\samples and type 'nmake -f makefile.vc'
    to make all the samples. You can also make them individually.
 
-To build the release version using makefiles, add FINAL=1 to your
-nmake invocation, both when building the library and for samples.
+Notes:
 
-Use the 'clean' target to clean all objects, libraries and
-executables.
+  Use the 'clean' target to clean all objects, libraries and
+  executables.
+
+  To build the release version using makefiles, add FINAL=1 to your
+  nmake invocation, both when building the library and for samples.
+
+  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
+  cleaned and re-made to build a different configuration. This
+  may be changed in later versions of wxWindows.
 
 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.
-2. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'.
+   The resulting libraries are called:
+
+      wx\lib\wx200.lib(dll) (debug version)
+      wx\lib\wx200.lib(dll)   (release version, using FINAL=1)
+
+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).
 
 Note (1): if you wish to use templates, please edit
 include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
@@ -98,8 +159,29 @@ Note (2): libraries and applications generated with makefiles and
 project files are unlikely to be compatible, so use one method or
 the other.
 
-Visual C++ 1.5 compilation
---------------------------
+Note (3): VC++ 5's optimization code seems to be broken and can
+cause both compile and run-time problems: this can be seen when
+deleting an object Dialog Editor, in Release mode with optimizations
+on. If in doubt, switch off optimisations, although this will result in much
+larger executables. It seems possible that the library can be created with
+strong optimization, so long as the application is not strongly
+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.
+
+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
+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.
+
+Visual C++ 1.5 compilation (16-bit)
+-----------------------------------
 
 1. Make sure your WXWIN variable is set, and uses the FAT (short
    name) form.
@@ -117,6 +199,8 @@ executables.
 Borland C++ 4.5/5.0 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.
 2. Change directory to wx\src\msw. Type 'make -f makefile.b32' to
@@ -129,10 +213,49 @@ Borland C++ 4.5/5.0 compilation
    'make -f makefile.b32 FINAL=1'
    for the library and samples.
 
-Note: the wxWindows library and (some) samples compile in 16-bit mode
+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
 off in this mode. See issues.txt for details.
 
+Note (2): 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
+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,
+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.
+
+Compiling using the IDE files:
+
+1. Load src\bc32.ide (Release settings)
+2. Go to Options|Project... and specify the correct BC++ include and lib path for
+   your file structure.
+3. Press F9 to compile the wxWindows library.
+4. Load samples\bc32.ide.
+5. Go to Options|Project... and specify the correct BC++ include and lib path for
+   your file structure.
+6. Press F9 to compile the samples (build each node separately if
+   you prefer, by right clicking and choose Build Node).
+7. Run each sample: you may need to run from each sample's directory
+   since some (notably the wxHTML samples) look for files
+   relative to the working directory.
+
+Note that to make the png, xpm, zlib and jpeg libraries (needed for
+some samples) you need to compile them with bc32.ide.
+
+The debug version of the wxWindows library is about 37 MB, and the
+release version is around 3 MB.
+
+See also the file bc_ide.txt for further instructions and details
+of how to create your own project files.
+
 Borland C++Builder compilation
 ------------------------------
 
@@ -141,32 +264,39 @@ C++Builder compilation is the same as for Borland C++ above.
 Tested with C++Builder 1.0 and 3.0. Only makefiles are currently
 supplied.
 
-Watcom C++ 10.6 compilation
+Watcom C++ 10.6/11 compilation
 ---------------------------
 
-1. Make sure your WXWIN variable is set, and uses the FAT (short
-   name) form.
+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
    make the wxWindows core library.
 3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
-   to make this sample.
+   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
+directory. See the notes in that directory.
+Note (3): makefile compilation seems broken (28/12/99) with a
+GPF in the linker. Too many object files? Could try switching
+some options off in setup.h.
 
 Metrowerks CodeWarrior compilation
 ----------------------------------
 
-1. Downloaded and unzip wx200cw.zip.
+1. Downloaded and unzip wx2_x_y_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.
 
-NOTES:
-
-(a) Unfortunately CodeWarrior support is broken in this
-release. Stefan Csomor (csomor@advancedconcepts.ch) will rectify this shortly.
-(b) You need CodeWarrior Pro 4 plus the patches to 4.1 from the
+Note (1): you need CodeWarrior Pro 4 plus the patches to 4.1 from the
 Metrowerks Web site.
 
+Note (2): unfortunately these files are not yet up-to-date for the
+current release.
+
 Symantec C++ compilation
 ------------------------
 
@@ -207,7 +337,7 @@ improving the compiler.
 Cygwin b19/b20/Mingw32 compilation
 ----------------------------------
 
-wxWindows 2.0 supports Cygwin (formerly GnuWin32) b19, b20, Mingw32, and Mingw32/EGCS.
+wxWindows 2 supports Cygwin (formerly GnuWin32) b19, b20, Mingw32, and Mingw32/EGCS.
 
 Thanks are due to Keith Garry Boyce (garp@opustel.com) and Cygnus for making
 it all possible.
@@ -227,8 +357,12 @@ Here are the steps required:
   If you have already have downloaded bison, flex, make, rm, mv
   from elsewhere, you won't need this.
 
-  IMPORTANT: 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.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 with wxWindows 2.1 or above, and wish to use OLE, you
+  should hand-patch in Mingw32-gcc295.patches (located in the top-level of the
+  wxWindows 2 installation).
 
 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
   to set up appropriate variables, if necessary mounting drives.
@@ -237,19 +371,17 @@ Here are the steps required:
 - For Cygwin, make sure there's a \tmp directory on your
   Windows drive or bison will crash.
 
-- Edit wx/src/makeg95.env and search for MINGW32. Take note of
-  the comments for adjusting settings to suit Cygwin or
-  Mingw32. Basically, this is just a case of adding the __MINGW32__ symbol
-  to OPTIONS for Mingw32, or removing it for Cygnus Cygwin.
-  For Mingw32/EGCS, add both __MINGW32__ and __EGCS__.
-  You may need to remove -loldnames from WINLIBS for Mingw32, or add it for
-  Cygwin.
+- 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.
 
-- Mingw32 may not support winsock.h, so comment out
-  socket-related files in src/msw/makefile.g95.
+- Mingw32 may not support winsock.h, so if you have a problem
+  here, comment out socket-related files in src/msw/makefile.g95.
 
 - Set your WXWIN variable to where wxWindows is installed.
-  For Cygwin/Mingw32, use forward slashes in the path, not backslashes.
+  *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
+  backslashes.
 
 - Use the makefile.g95 files for compiling wxWindows and samples,
   e.g.:
@@ -258,6 +390,8 @@ Here are the steps required:
   > cd c:\wx\samples\minimal
   > make -f makefile.g95
 
+  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
@@ -270,21 +404,47 @@ Here are the steps required:
 All targets have 'clean' targets to allow removal of object files
 and other intermediate compiler files.
 
-Gotchas:
+Notes:
+
+- See also the Cygwin/Mingw32 on the web site or CD-ROM for
+  further information about using wxWindows with these compilers.
 
 - libwx.a is 48 MB or more - but much less if compiled with no
   debug info (-g0) and level 4 optimization (-O4).
+
 - install.exe doesn't have built-in decompression because lzexpand.lib
   isn't available with Cygwin. However, you can use it with external
   decompression utilities.
-- Doesn't compile src/msw/ole files, so no drag and drop.
+
+- There's a bug in Mingw32 headers for some early distributions.
+
+  in include/windows32/defines.h, where it says:
+
+  #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
+
+  it should say:
+
+  #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
+
+  (a missing bracket).
+
+- If there's a problem with the copy command in
+  src/msw/makefile.g95, you may need to change the relevant
+  section to the following:
+
+  COPY = command /c copy
+  $(COMMDIR)/y_tab.c:     $(COMMDIR)/dosyacc.c
+      $(COPY) ..\\common\\dosyacc.c ..\\common\\y_tab.c
+
+  $(COMMDIR)/lex_yy.c:    $(COMMDIR)/doslex.c
+      $(COPY) ..\\common\\doslex.c ..\\common\\lex_yy.c
 
 References:
 
  - The GNU-WIN32 site is at
      http://www.cygnus.com/gnu-win32/
  - Mingw32 is available at:
-     http://agnes.dida.physik.uni-essen.de/~janjaap/mingw32/index.html
+     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
 
 TWIN32 and gcc on Linux