Add MSVC-specific text by Hans Breuer.

2002-03-17  Tor Lillqvist  <tml@iki.fi>

	* README.win32: Add MSVC-specific text by Hans Breuer.

1 files changed, 170 insertions, 9 deletions

diff --git a/README.win32 b/README.win32
index b3c3ad069..ba6312b1d 100644
--- a/README.win32
+++ b/README.win32
@@ -1,3 +1,9 @@
+Tor Lillqvist <tml@iki.fi>
+Hans Breuer <hans@breuer.org>
+
+The general parts, and the stuff about gcc and autoconfiscated build
+are by Tor Lillqvist. The stuff about MSVC build is by Hans Breuer.
+
 General
 =======
 
@@ -53,7 +59,7 @@ Even building software that just *uses* GLib or GTK+ also require to
 have the right compiler set up the right way, so if you intend to use
 gcc, follow the relevant instructions below in that case, too.
 
-I use gcc with the -fnative-struct flag, which means that in order to
+Tor uses gcc with the -fnative-struct flag, which means that in order to
 use the prebuilt DLLs (especially of GTK+), you *must* also use that
 flag. (This flag means that the struct layout rules are identical to
 those used by MSVC. This is essential if the same DLLs are to be
@@ -93,7 +99,7 @@ to use (after some editing).
 Building GLib with gcc
 ======================
 
-I use gcc-2.95.3. Version 2.95.2 will most probably also work.
+Tor uses gcc-2.95.3. Version 2.95.2 will most probably also work.
 
 You can either use gcc running on Cygwin, or the "pure" mingw
 gcc. Using the latter might work better, or at least did at some
@@ -119,7 +125,7 @@ mechanism when building with gcc. You should be running Cygwin, or
 maybe cross-compiling from real Unix, for the configure script to
 work, obviously. (It might also be possible to use "MSYS", but I
 haven't checked.) You most probably should have very new auto* and
-libtool. Personally, I invoke configure using:
+libtool. Tor invokes configure using:
 
 CC='gcc -mpentium -fnative-struct'
   CPPFLAGS='-I/src/libiconv-1.7/include -I/target/include'
@@ -146,7 +152,7 @@ twice, once using gcc and once using MSVC, and merging the resulting
 files with diff -D.
 
 There might be other hickups when using auto* and configure to build
-with gcc. Lately I have used auto*/configure/libtool exclusively when
+with gcc. Lately Tor has used auto*/configure/libtool exclusively when
 building GLib, GTK+, GIMP etc on Win32, and it seems to work well
 (with some patches applied to the current CVS libtool...).
 
@@ -163,7 +169,7 @@ configure.in and libtool documentation.
 
 If you want to run the Cygwin-hosted gcc, and still want to produce
 code that does not use Cygwin, but the msvcrt runtime, in theory it
-should work to use the -no-cygwin flag, but I haven't tested that
+should work to use the -no-cygwin flag, but Tor hasn't tested that
 lately.
 
 If you would want to use the Cygwin tools to generate a GLib that
@@ -171,12 +177,167 @@ If you would want to use the Cygwin tools to generate a GLib that
 should work as if on Unix. Note that successfully producing shared
 libraries (DLLs) for Cygwin most probably requires you to have a very
 new libtool. (And a new libtool probably requires rather new autoconf
-and automake.) I haven't personally tested this in a while.
+and automake.) Tor hasn't tested this in a while.
 
 Building with MSVC
 ==================
 
-If using the Microsoft toolchain, build with `nmake -f
-makefile.msc`.
+All the MSVC makefiles are for the command line build with nmake.
+If you want to use the VC-UI you can simply create wrapper .dsp
+makefiles (read the VC docs how to do so).
+
+Some modules may require Perl to auto-generate files. The goal (at
+least Hans's) is to not require any more tools.
+
+Build with:
+
+nmake -f makefile.msc
+  or
+nmake -f makefile.msc DEBUG=1
+
+[
+ The former will create 'release' versions of the DLLs. If you
+ plan to distribute you DLLs please use this command. The latter 
+ will create DLLs with debug information _and_ link them with
+ msvcrtd.dll instead of msvcrt.dll. 
+ Beware: There are known problems with mixing DLLs in one 
+ application, which are build against different runtimes. 
+ Especially the index-to-file mapping used by 'unix-style' file
+ operation - _open() _pipe() etc. - breaks sometimes in strange 
+ ways (for example the Gimp plug-in communication).
+]
+
+Required libraries (not build from cvs)
+==================
+  libintl (gnu-intl), libiconv
+  libtiff, libpng, zlib, libjpeg
+
+are available pre-built from the website mentioned above.
+
+Versioning
+==========
+Instead of the Unix and auto* way of tracking versions and resolving
+dependencies (configure; make; make install) involving autoconf,
+automake, libtool and friends the MSVC build uses a different
+approach.
+
+The core of it's versioning is the file build/win32/module.defs.
+It contains entries of the form MODULE_VER, e.g.:
+
+	GLIB_VER = 2.0
+	LIBICONV_VER = 1.3
+
+and the placement of these modules defined as MODULE, e.g.:
+
+	GLIB = $(TOP)/glib
+	LIBICONV = $(TOP)/libiconv-$(LIBICONV_VER)
+
+whereas TOP is defined as the relative path from the respective
+module directory to your top build directory. Every makefile.msc
+needs to define TOP before including the common make file part
+make.msc, which than includes module.defs, like:
+
+TOP = ../..
+!INCLUDE $(TOP)/glib/build/win32/make.msc
+
+(Taken from gtk+/gdk/makefile.msc)
+
+With this provision it is possible to create almost placement
+independent makefiles without requiring to 'install' the libraries and
+headers into a common place (as it is done on Unix, and as Tor does
+when producing his zipfiles with prebuilt GLib, GTK+ etc).
+
+Special Files
+=============
+	config.h.win32.in : @XXX_MAJOR_VERSION@ needs to be replaced by
+the current version/build number. The resulting file is to be saved
+as 'config.h.win32'. This should be automatically done if a package
+gets build on the Unix platform.
+
+	makefile.msc.in : @XXX_MAJOR_VERSION@ to be replaced. Save as
+makefile.msc.
+
+	<module>.def : every function which should be used from the outside of
+a dll needs to be marked for 'export'. It is common that one needs to change 
+these files after some api changes occured. If there are variables to be
+exported another mechanism is needed, like :
+
+	#ifdef G_OS_WIN32
+	#  ifdef GDK_COMPILATION
+	#    define GDKVAR __declspec(dllexport)
+	#  else
+	#    define GDKVAR extern __declspec(dllimport)
+	#  endif
+	#else
+	#  define GDKVAR extern
+	#endif
+
+
+
+Directory Structure
+===================
+all modules should be build in a common directory tree otherwise you 
+need to adapt the file 'module.defs'. They are listed here in increasing
+dependencies order.
+
+<common rootdir without spaces>
+  |
+  +- glib
+  |   |
+  |   +- build          : [this module lives in the cvs root dir]
+  |   |   +- win32
+  |   |       .\module.defs : defines (relative) locations of the headers
+  |   |                       and libs and version numbers to be include 
+  |   |                       in dll names
+  |   |       .\make.msc    : include by almost every 'makefile.msc'
+  |   |
+  |   | .\README.WIN32  : more information how to build
+  |   | .\glibconfig.h.win32.in : similar to config.h.win32.in
+  |   | .\makefile.msc  : master makefile, sub dir makefiles should work 
+  |   |
+  |   +- glib
+  |   +- gmodule
+  |   +- gthread        : does _not_ depend on pthread anymore
+  |   +- gobject
+  |
+  +- pango
+  |   +- pango          : 'native' build does not require extra libs and
+  |   |                 includes the minimal required text renderer
+  |   |                 (there is also a currently slightly broken FreeType2 
+  |   |                 based implementation for win32)
+  |   +- modules (not yet build)
+  |
+  +- atk
+  |   +- atk
+  |       .\makefile.msc : build here
+  |
+  +- gtk+
+  |   | .\config.h.win32 : for all the below
+  |   |
+  |   +- gdk-pixbuf
+  |   |   .\gdk_pixbuf.rc.in : version resource for the DLLs. Needs
+  |   |                 to be converted (filled with version info)
+  |   |                 as described above.
+  |   |
+  |   +- gdk
+  |   |   | .\makefile.msc : some auto-generation is needed to build in the
+  |   |   |             in the subdirectory 
+  |   |   +- win32
+  |   |
+  |   +- gtk
+
+  |
+  +- gimp
+  |   .\makefile.msc    : master makefile to build The Gimp. The makefiles
+  |                     from the sub dirs should work stand alone, but than
+  |                     the user needs to know the build order
+
+  |
+  +- dia                : additionally depends on libart_lgpl (in cvs)
+      |                 and libxml2 ( see http://www.xmlsoft.org/ )
+      +- lib
+      +- app
+      +- objects
+      +- plug-ins
+          +- python
 
---Tor Lillqvist <tml@iki.fi>