README.win32

   1 Tor Lillqvist <tml@iki.fi>
   2 Hans Breuer <hans@breuer.org>
   3
   4 Note that this document is not really maintained in a serious
   5 fashion. Lots of information here might be misleading or outdated. You
   6 have been warned.
   7
   8 The general parts, and the section about gcc and autoconfiscated
   9 build, and about a Visual Studio build are by Tor Lillqvist.
  10
  11 General
  12 =======
  13
  14 For prebuilt binaries (DLLs and EXEs) and developer packages (headers,
  15 import libraries) of GLib, Pango, GTK+ etc for Windows, go to
  16 http://www.gtk.org/download-windows.html . They are for "native"
  17 Windows meaning they use the Win32 API and Microsoft C runtime library
  18 only. No POSIX (Unix) emulation layer like Cygwin in involved.
  19
  20 To build GLib on Win32, you can use either gcc ("mingw") or the
  21 Microsoft compiler and tools. For the latter, MSVC6 and later have
  22 been used successfully. Also the Digital Mars C/C++ compiler has
  23 reportedly been used.
  24
  25 You can also cross-compile GLib for Windows from Linux using the
  26 cross-compiling mingw packages for your distro.
  27
  28 Note that to just *use* GLib on Windows, there is no need to build it
  29 yourself.
  30
  31 On Windows setting up a correct build environment can be quite a task,
  32 especially if you are used to just type "./configure; make" on Linux,
  33 and expect things to work as smoothly on Windows.
  34
  35 The following preprocessor macros are to be used for conditional
  36 compilation related to Win32 in GLib-using code:
  37
  38 - G_OS_WIN32 is defined when compiling for native Win32, without
  39   any POSIX emulation, other than to the extent provided by the
  40   bundled Microsoft C library (msvcr*.dll).
  41
  42 - G_WITH_CYGWIN is defined if compiling for the Cygwin
  43   environment. Note that G_OS_WIN32 is *not* defined in that case, as
  44   Cygwin is supposed to behave like Unix. G_OS_UNIX *is* defined by a GLib
  45   for Cygwin.
  46
  47 - G_PLATFORM_WIN32 is defined when either G_OS_WIN32 or G_WITH_CYGWIN
  48   is defined.
  49
  50 These macros are defined in glibconfig.h, and are thus available in
  51 all source files that include <glib.h>.
  52
  53 Additionally, there are the compiler-specific macros:
  54 - __GNUC__ is defined when using gcc
  55 - _MSC_VER is defined when using the Microsoft compiler
  56 - __DMC__ is defined when using the Digital Mars C/C++ compiler
  57
  58 G_OS_WIN32 implies using the Microsoft C runtime, normally
  59 msvcrt.dll. GLib is not known to work with the older crtdll.dll
  60 runtime, or the static Microsoft C runtime libraries libc.lib and
  61 libcmt.lib. It apparently does work with the debugging version of
  62 msvcrt.dll, msvcrtd.dll. If compiled with Microsoft compilers newer
  63 than MSVC6, it also works with their compiler-specific runtimes, like
  64 msvcr70.dll or msvcr80.dll. Please note that it's non totally clear if
  65 you would be allowed by the license to distrubute a GLib linked to
  66 msvcr70.dll or msvcr80.dll, as those are not part of the operating
  67 system, but of the MSVC product. msvcrt.dll is part of Windows.
  68
  69 For people using Visual Studio 2005 or later:
  70
  71 If you are building GLib-based libraries or applications, or GLib itself
  72 and you see a C4819 error (or warning, before C4819 is treated as an error
  73 in msvc_recommended_pragmas.h), please be advised that this error/warning should
  74 not be disregarded, as this likely means portions of the build is not being
  75 done correctly, as this is an issue of Visual Studio running on CJK (East Asian)
  76 locales.  This is an issue that also affects builds of other projects, such as
  77 QT, Firefox, LibreOffice/OpenOffice, Pango and GTK+, along with many other projects.
  78
  79 To overcome this problem, please set your system's locale setting for non-Unicode to
  80 English (United States), reboot, and restart the build, and the code should build
  81 normally.  See also this GNOME Wiki page [1] that gives a bit further info on this.
  82
  83 Building software that use GLib or GTK+
  84 =======================================
  85
  86 Building software that just *uses* GLib or GTK+ also require to have
  87 the right compiler set up the right way. If you intend to use gcc,
  88 follow the relevant instructions below in that case, too.
  89
  90 Tor uses gcc with the -mms-bitfields flag which means that in order to
  91 use the prebuilt DLLs (especially of GTK+), if you compile your code
  92 with gcc, you *must* also use that flag. This flag means that the
  93 struct layout rules are identical to those used by MSVC. This is
  94 essential if the same DLLs are to be usable both from gcc- and
  95 MSVC-compiled code. Such compatibility is desirable.
  96
  97 When using the prebuilt GLib DLLs that use msvcrt.dll from code that
  98 uses other C runtimes like for example msvcr70.dll, one should note
  99 that one cannot use such GLib API that take or returns file
 100 descriptors. On Windows, a file descriptor (the small integer as
 101 returned by open() and handled by related functions, and included in
 102 the FILE struct) is an index into a table local to the C runtime
 103 DLL. A file descriptor in one C runtime DLL does not have the same
 104 meaning in another C runtime DLL.
 105
 106 Building GLib
 107 =============
 108
 109 Again, first decide whether you really want to do this.
 110
 111 Before building GLib you must also have a GNU gettext-runtime
 112 developer package. Get prebuilt binaries of gettext-runtime from
 113 http://www.gtk.org/download-windows.html .
 114
 115 Autoconfiscated build (with gcc)
 116 ================================
 117
 118 Tor uses gcc 3.4.5 and the rest of the mingw utilities, including MSYS
 119 from www.mingw.org. Somewhat earlier or later versions of gcc
 120 presumably also work fine.
 121
 122 Using Cygwin's gcc with the -mno-cygwin switch is not recommended. In
 123 theory it should work, but Tor hasn't tested that lately. It can
 124 easily lead to confusing situations where one mixes headers for Cygwin
 125 from /usr/include with the headers for native software one really
 126 should use. Ditto for libraries.
 127
 128 If you want to use mingw's gcc, install gcc, win32api, binutils and
 129 MSYS from www.mingw.org.
 130
 131 Tor invokes configure using:
 132
 133 CC='gcc -mtune=pentium3 -mthreads' CPPFLAGS='-I/opt/gnu/include' \
 134         LDFLAGS='-L/opt/gnu/lib -Wl,--enable-auto-image-base' CFLAGS=-O2 \
 135         ./configure --disable-gtk-doc --prefix=$TARGET
 136
 137 The /opt/gnu mentioned contains the header files for GNU and (import)
 138 libraries for GNU libintl. The build scripts used to produce the
 139 prebuilt binaries are included in the "dev" packages.
 140
 141 Please note that the ./configure mechanism should not blindly be used
 142 to build a GLib to be distributed to other developers because it
 143 produces a compiler-dependent glibconfig.h. For instance, the typedef
 144 for gint64 is long long with gcc, but __int64 with MSVC.
 145
 146 Except for this and a few other minor issues, there shouldn't be any
 147 reason to distribute separate GLib headers and DLLs for gcc and MSVC6
 148 users, as the compilers generate code that uses the same C runtime
 149 library.
 150
 151 The DLL generated by either compiler is binary compatible with the
 152 other one. Thus one either has to manually edit glibconfig.h
 153 afterwards, or use the supplied glibconfig.h.win32 which has been
 154 produced by running configure twice, once using gcc and once using
 155 MSVC, and merging the resulting files with diff -D.
 156
 157 For MSVC7 and later (Visual C++ .NET 2003, Visual C++ 2005, Visual C++
 158 2008 etc) it is preferred to use specific builds of GLib DLLs that use
 159 the same C runtime as the code that uses GLib. Such DLLs should be
 160 named differently than the ones that use msvcrt.dll.
 161
 162 For GLib, the DLL that uses msvcrt.dll is called libglib-2.0-0.dll,
 163 and the import libraries libglib-2.0.dll.a and glib-2.0.lib. Note that
 164 the "2.0" is part of the "basename" of the library, it is not
 165 something that libtool has added. The -0 suffix is added by libtool
 166 and is the value of "LT_CURRENT - LT_AGE". The 0 should *not* be
 167 thought to be part of the version number of GLib. The LT_CURRENT -
 168 LT_AGE value will on purpose be kept as zero as long as binary
 169 compatibility is maintained. For the gory details, see configure.ac
 170 and libtool documentation.
 171
 172 Building with Visual Studio
 173 ===========================
 174
 175 A more detailed outline of building GLib with its dependencies can
 176 now be found on the GNOME wiki:
 177
 178 https://wiki.gnome.org/Projects/GTK%2B/Win32/MSVCCompilationOfGTKStack
 179
 180 Please do not build GLib in paths that contain spaces in them, as
 181 this may cause problems during compilation and during usage of the
 182 library.
 183
 184 In an unpacked tarball, you will find in build\win32\vs9 (VS 2008) and
 185 build\win32\vs10 (VS 2010) a solution file that can be used to build
 186 the GLib DLLs and some auxiliary programs under VS 2008 and VS 2010
 187 (Express Edition will suffice with the needed dependencies) respectively.
 188 Read the README.txt file in those folders for more
 189 information. Note that you will need a libintl implementation, zlib, and
 190 libFFI.
 191
 192 If you are building from a GIT checkout, you will first need to use some
 193 Unix-like environment or run win32/setup.py,
 194 which will expand the VS 2008/2010 project files, the DLL resouce files and
 195 other miscellanious files required for the build.  Run win32/setup.py
 196 as follows:
 197
 198 $python win32/setup.py --perl path_to_your_perl.exe
 199
 200 for more usage on this script, run
 201 $python win32/setup.py -h/--help
 202
 203 [1]: https://wiki.gnome.org/Projects/GTK%2B/Win32/MSVCCompilationOfGTKStack under "Preparations"