]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/msw/install.txt
fixed terminology (widget vs. binded window)
[wxWidgets.git] / docs / msw / install.txt
index a8e5447ff59d68480af002de671bc0fda8890795..9c6f8230386a956190682fc5fe5299ad6ba144ba 100644 (file)
@@ -1,4 +1,30 @@
 
+Installing wxWindows 2.1
+------------------------
+
+[Notes from Robert Roebling for snapshot 8]
+
+This is a not-so-well tested snapshot 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.
+
+There have not been major changes in the way to build the library, 
+although the creation of the various makefiles has been automatized. 
+I myself use the GNU MingGW32 compiler from 
+
+  http://www.cygnus.com 
+  
+using the GNU make program from 
+
+  http://agnes.dida.physik.uni-essen.de/~janjaap/mingw32
+  
+and I have not tested any other compiler, but other developers use
+the makefiles for Borland C++, MS-Visual C++ 5.0 and 6.0 and probably
+Metrowerks C++.
+
+Expect problems.
+
 Installing wxWindows 2.0
 ------------------------
 
@@ -26,6 +52,7 @@ wx200pdf.zip            Acrobat PDF documentation
 wx200htm.zip            HTML documentation
 wx200vc.zip             MS VC++ 5.0 project files
 wx200cw.zip             Metrowerks CodeWarrior project files
+wx200bc.zip             BC++ 5 project files
 
 Unarchive the required files plus any optional documentation
 files into a suitable directory such as c:\wx.
@@ -45,7 +72,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
 -----------
@@ -60,31 +88,66 @@ Using project files:
 
 1. Unarchive wx200vc.zip, the VC++ 5 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++ 6 only) and compile in
+   Debug and Release configurations. If you have VC++ 5 or
+   earlier, use makefile.vc, but you may only have one set of object
+   files at a time in use (debug or release).
+4. Open a sample project file, choose a 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. 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).
+3. If you wish to use JPEG in your applications, do the same
+   procedure in src\jpeg but add the 'all' target to the
+   command line.
+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_d.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,6 +161,23 @@ Note (2): libraries and applications generated with makefiles and
 project files are unlikely to be compatible, so use one method or
 the other.
 
+Note (3): VC++ 5's optimization code seems to be broken and can
+cause 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.
+
+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
 --------------------------
 
@@ -117,6 +197,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
@@ -133,6 +215,27 @@ Note: 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.
 
+Compiling using the IDE files:
+
+1. Load src\bc32.ide (or src\bc32d.ide for a debugging version).
+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.
+
+Note that to make the png, xpm and zlib libraries (needed for
+some samples) you need to compile with bc32.ide. bc32d.ide only
+makes the wxWindows library (lib\wx32d.lib).
+
+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
 ------------------------------
 
@@ -144,8 +247,8 @@ supplied.
 Watcom C++ 10.6 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'
@@ -162,9 +265,7 @@ Metrowerks CodeWarrior compilation
 
 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
+You need CodeWarrior Pro 4 plus the patches to 4.1 from the
 Metrowerks Web site.
 
 Symantec C++ compilation
@@ -249,7 +350,8 @@ Here are the steps required:
   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 +360,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,15 +374,29 @@ Here are the steps required:
 All targets have 'clean' targets to allow removal of object files
 and other intermediate compiler files.
 
-Gotchas:
+Notes:
 
 - 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 the Mingw32 headers for some 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).
+
 References:
 
  - The GNU-WIN32 site is at