Add length arguments to g_utf8_{strup,strdown,casefold,collate_key}.
[platform/upstream/glib.git] / README.win32
index 38e6c75..480db91 100644 (file)
@@ -2,39 +2,41 @@ General
 =======
 
 For more information about the port or GLib, GTk+ and the GIMP to
-native Windows, and pre-built DLLs, surf to http://www.gimp.org/win32/
-"Native" means that we use the Win32 API only, and no POSIX (Unix)
-emulation layer except that provided by the Microsoft runtime C
-library. Actually, a pthreads emulation library is used.
+native Windows, and pre-built binaries (DLLs), surf to
+http://www.gimp.org/win32/ . "Native" means that we use the Win32 API
+only, and no POSIX (Unix) emulation layer except that provided by the
+Microsoft runtime C library, and a pthreads emulation library.
 
 To build GLib on Win32, you can use either gcc or the Microsoft
 compiler and tools. Both the compiler from MSVC 5.0 and from MSVC 6.0
 have been used successfully.
 
-But note that to just *use* GLib on Windows, there is not need to
-build it, prebuilt DLLs are available from the webiste above.
+But note that to just *use* GLib on Windows, there is no need to build
+it, prebuilt DLLs are available from the webiste above.
 
-With gcc I mean gcc-2.95 or gcc-2.95.2 as distributed by Mumit Khan,
-either as a mingw version (preferred), or running under cygwin. To
-successfully use gcc, follow the instructions below. We want to use
-gcc -mno-cygwin, i.e. produce executables (.exe and .dll files) that
-do *not* require the cygwin runtime library. This is called "mingw".
-also use the -fnative-struct flag, which means that in order to use
-the prebuilt DLLs (especiall of GTK+), you *must* also use that flag.
+With gcc I mean gcc-2.95.2 as distributed by Mumit Khan, either as a
+mingw version (preferred), or running under cygwin. To successfully
+use gcc, follow the instructions below. We want to use gcc
+-mno-cygwin, i.e. produce executables (.exe and .dll files) that do
+*not* require the cygwin runtime library. This is called "mingw".  I
+also use 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 is identical to that used by
 MSVC.)
 
-To test the GLib functions, go to the tests subdirectory and enter
-`nmake -f makefile.msc check` or `make -f makefile.mingw check`.
+If you would want to use the cygwin tools to generate a GLib that
+*does* use the cygwin runtime, the normal Unix configuration method
+should work as if on Unix. Note that successfully producing shared
+libraries (DLLs) most probably requires you to have a very new libtool
+(from March 2001), and to replace the libtool.m4 included in
+acinclude.m4 with the new one, and to replace ltmain.sh.
 
-If you would want to use the cygwin tools to generate executables that
-*do* use the cygwin runtime, the normal Unix configuration method
-should work as if on Unix. But it won't produce DLLs. At least I
-haven't succeeded in that. Also, I have no idea what changes are
-necessary to the code for it to run successfully on cygwin.
-
-With some work, it might be possible to use the ./configure mechanism
-also with a "mingw32" configuration.
+It is also possible to use the ./configure mechanism when building for
+a mingw configuration. You should be running cygwin for the configure
+script to work, obviously. The same libtool issue has to be taken into
+account as when building for Cygwin: You most probably should have a
+libtool from March 2001 or so, and replace libtool.m4 (in
+acinclude.m4) and ltmain.sh.
 
 The following preprocessor macros are used for conditional compilation
 related to Win32:
@@ -44,21 +46,21 @@ related to Win32:
   bundled Microsoft C library (msvcrt.dll) and the pthreads-win32
   library. For instance, pathnames are in the native Windows syntax.
 
-- _WIN32 is defined by the compiler
+- G_WITH_CYGWIN is defined if compiling for the Cygwin
+  environment. Note that G_OS_WIN32 is *not* defined in that case, as
+  Cygwin is supposed to behave like Unix. G_OS_UNIX *is* defined when
+  compiling for Cygwin.
+
+- G_PLATFORM_WIN32 is defined when either G_OS_WIN32 or G_WITH_CYGWIN
+  is defined.
 
-The Win32 port uses the combination with both of those on. As
+The Win32 port of GLib and related software uses only G_OS_WIN32. As
 G_OS_WIN32 is defined in glibconfig.h, it is available to all source
 files that use GLib (or GTk+, which uses GLib).
 
 Additionally, there are the compiler-specific macros:
-- _MSC_VER is defined when using the Microsoft compiler
 - __GNUC__ is defined when using GCC
-
-Some of the usage of these macros used to be a bit mixed up, and had
-to be straightened out when adding the gcc support. In particular, I
-used to check for _MSC_VER in some places where I really wanted to
-check for the Microsoft C library, and those checks has now been
-changed to G_OS_WIN32.
+- _MSC_VER is defined when using the Microsoft compiler
 
 G_OS_WIN32 implies using the Microsoft C runtime MSVCRT.DLL. GLib or
 software using it is not known to work with the older CRTDLL.DLL
@@ -67,10 +69,9 @@ runtime.
 Building software that use GLib or GTk+
 =======================================
 
-Unfortunately, even building software that just *use* 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.
+Even building software that just *use* 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.
 
 Pthreads library
 ================
@@ -105,8 +106,8 @@ line that sets GLIB_VER to the correct version number.
 This is done automatically when an official GLib source distribution
 package is built.
 
-Building with gcc
-=================
+Building GLib with gcc
+======================
 
 I use the latest gcc, gcc-2.95.2. Version 2.95 will most probably also
 work.