README.win32

   1 Tor Lillqvist <tml@iki.fi>\r
   2 Hans Breuer <hans@breuer.org>\r
   3 \r
   4 Note that this document is not really maintained in a serious\r
   5 fashion. Lots of information here might be misleading or outdated. You\r
   6 have been warned.\r
   7 \r
   8 The general parts, and the section about gcc and autoconfiscated\r
   9 build, and about a Visual Studio build are by Tor Lillqvist. The\r
  10 sections about MSVC build with NMAKE is by Hans Breuer. \r
  11 \r
  12 General\r
  13 =======\r
  14 \r
  15 For prebuilt binaries (DLLs and EXEs) and developer packages (headers,\r
  16 import libraries) of GLib, Pango, GTK+ etc for Windows, go to\r
  17 http://www.gtk.org/download-windows.html . They are for "native"\r
  18 Windows meaning they use the Win32 API and Microsoft C runtime library\r
  19 only. No POSIX (Unix) emulation layer like Cygwin in involved.\r
  20 \r
  21 To build GLib on Win32, you can use either gcc ("mingw") or the\r
  22 Microsoft compiler and tools. For the latter, MSVC6 and later have\r
  23 been used successfully. Also the Digital Mars C/C++ compiler has\r
  24 reportedly been used.\r
  25 \r
  26 You can also cross-compile GLib for Windows from Linux using the\r
  27 cross-compiling mingw packages for your distro.\r
  28 \r
  29 Note that to just *use* GLib on Windows, there is no need to build it\r
  30 yourself.\r
  31 \r
  32 On Windows setting up a correct build environment can be quite a task,\r
  33 especially if you are used to just type "./configure; make" on Linux,\r
  34 and expect things to work as smoothly on Windows.\r
  35 \r
  36 The following preprocessor macros are to be used for conditional\r
  37 compilation related to Win32 in GLib-using code:\r
  38 \r
  39 - G_OS_WIN32 is defined when compiling for native Win32, without\r
  40   any POSIX emulation, other than to the extent provided by the\r
  41   bundled Microsoft C library (msvcr*.dll).\r
  42 \r
  43 - G_WITH_CYGWIN is defined if compiling for the Cygwin\r
  44   environment. Note that G_OS_WIN32 is *not* defined in that case, as\r
  45   Cygwin is supposed to behave like Unix. G_OS_UNIX *is* defined by a GLib\r
  46   for Cygwin.\r
  47 \r
  48 - G_PLATFORM_WIN32 is defined when either G_OS_WIN32 or G_WITH_CYGWIN\r
  49   is defined.\r
  50 \r
  51 These macros are defined in glibconfig.h, and are thus available in\r
  52 all source files that include <glib.h>.\r
  53 \r
  54 Additionally, there are the compiler-specific macros:\r
  55 - __GNUC__ is defined when using gcc\r
  56 - _MSC_VER is defined when using the Microsoft compiler\r
  57 - __DMC__ is defined when using the Digital Mars C/C++ compiler\r
  58 \r
  59 G_OS_WIN32 implies using the Microsoft C runtime, normally\r
  60 msvcrt.dll. GLib is not known to work with the older crtdll.dll\r
  61 runtime, or the static Microsoft C runtime libraries libc.lib and\r
  62 libcmt.lib. It apparently does work with the debugging version of\r
  63 msvcrt.dll, msvcrtd.dll. If compiled with Microsoft compilers newer\r
  64 than MSVC6, it also works with their compiler-specific runtimes, like\r
  65 msvcr70.dll or msvcr80.dll. Please note that it's non totally clear if\r
  66 you would be allowed by the license to distrubute a GLib linked to\r
  67 msvcr70.dll or msvcr80.dll, as those are not part of the operating\r
  68 system, but of the MSVC product. msvcrt.dll is part of Windows.\r
  69 \r
  70 For people using Visual Studio 2005 or later:\r
  71 \r
  72 If you are building GLib-based libraries or applications, or GLib itself\r
  73 and you see a C4819 error (or warning, before C4819 is treated as an error\r
  74 in msvc_recommended_pragmas.h), please be advised that this error/warning should\r
  75 not be disregarded, as this likely means portions of the build is not being\r
  76 done correctly, as this is an issue of Visual Studio running on CJK (East Asian)\r
  77 locales.  This is an issue that also affects builds of other projects, such as\r
  78 QT, Firefox, LibreOffice/OpenOffice, Pango and GTK+, along with many other projects.\r
  79 \r
  80 To overcome this problem, please set your system's locale setting for non-Unicode to\r
  81 English (United States), reboot, and restart the build, and the code should build\r
  82 normally.  See also this GNOME Wiki page [1] that gives a bit further info on this.\r
  83 \r
  84 Building software that use GLib or GTK+\r
  85 =======================================\r
  86 \r
  87 Building software that just *uses* GLib or GTK+ also require to have\r
  88 the right compiler set up the right way. If you intend to use gcc,\r
  89 follow the relevant instructions below in that case, too.\r
  90 \r
  91 Tor uses gcc with the -mms-bitfields flag which means that in order to\r
  92 use the prebuilt DLLs (especially of GTK+), if you compile your code\r
  93 with gcc, you *must* also use that flag. This flag means that the\r
  94 struct layout rules are identical to those used by MSVC. This is\r
  95 essential if the same DLLs are to be usable both from gcc- and\r
  96 MSVC-compiled code. Such compatibility is desirable.\r
  97 \r
  98 When using the prebuilt GLib DLLs that use msvcrt.dll from code that\r
  99 uses other C runtimes like for example msvcr70.dll, one should note\r
 100 that one cannot use such GLib API that take or returns file\r
 101 descriptors. On Windows, a file descriptor (the small integer as\r
 102 returned by open() and handled by related functions, and included in\r
 103 the FILE struct) is an index into a table local to the C runtime\r
 104 DLL. A file descriptor in one C runtime DLL does not have the same\r
 105 meaning in another C runtime DLL.\r
 106 \r
 107 Building GLib\r
 108 =============\r
 109 \r
 110 Again, first decide whether you really want to do this.\r
 111 \r
 112 Before building GLib you must also have a GNU gettext-runtime\r
 113 developer package. Get prebuilt binaries of gettext-runtime from\r
 114 http://www.gtk.org/download-windows.html .\r
 115 \r
 116 Autoconfiscated build (with gcc)\r
 117 ================================\r
 118 \r
 119 Tor uses gcc 3.4.5 and the rest of the mingw utilities, including MSYS\r
 120 from www.mingw.org. Somewhat earlier or later versions of gcc\r
 121 presumably also work fine.\r
 122 \r
 123 Using Cygwin's gcc with the -mno-cygwin switch is not recommended. In\r
 124 theory it should work, but Tor hasn't tested that lately. It can\r
 125 easily lead to confusing situations where one mixes headers for Cygwin\r
 126 from /usr/include with the headers for native software one really\r
 127 should use. Ditto for libraries.\r
 128 \r
 129 If you want to use mingw's gcc, install gcc, win32api, binutils and\r
 130 MSYS from www.mingw.org.\r
 131 \r
 132 Tor invokes configure using:\r
 133 \r
 134 CC='gcc -mtune=pentium3 -mthreads' CPPFLAGS='-I/opt/gnu/include' \\r
 135         LDFLAGS='-L/opt/gnu/lib -Wl,--enable-auto-image-base' CFLAGS=-O2 \\r
 136         ./configure --disable-gtk-doc --prefix=$TARGET\r
 137 \r
 138 The /opt/gnu mentioned contains the header files for GNU and (import)\r
 139 libraries for GNU libintl. The build scripts used to produce the\r
 140 prebuilt binaries are included in the "dev" packages.\r
 141 \r
 142 Please note that the ./configure mechanism should not blindly be used\r
 143 to build a GLib to be distributed to other developers because it\r
 144 produces a compiler-dependent glibconfig.h. For instance, the typedef\r
 145 for gint64 is long long with gcc, but __int64 with MSVC.\r
 146 \r
 147 Except for this and a few other minor issues, there shouldn't be any\r
 148 reason to distribute separate GLib headers and DLLs for gcc and MSVC6\r
 149 users, as the compilers generate code that uses the same C runtime\r
 150 library.\r
 151 \r
 152 The DLL generated by either compiler is binary compatible with the\r
 153 other one. Thus one either has to manually edit glibconfig.h\r
 154 afterwards, or use the supplied glibconfig.h.win32 which has been\r
 155 produced by running configure twice, once using gcc and once using\r
 156 MSVC, and merging the resulting files with diff -D.\r
 157 \r
 158 For MSVC7 and later (Visual C++ .NET 2003, Visual C++ 2005, Visual C++\r
 159 2008 etc) it is preferred to use specific builds of GLib DLLs that use\r
 160 the same C runtime as the code that uses GLib. Such DLLs should be\r
 161 named differently than the ones that use msvcrt.dll.\r
 162 \r
 163 For GLib, the DLL that uses msvcrt.dll is called libglib-2.0-0.dll,\r
 164 and the import libraries libglib-2.0.dll.a and glib-2.0.lib. Note that\r
 165 the "2.0" is part of the "basename" of the library, it is not\r
 166 something that libtool has added. The -0 suffix is added by libtool\r
 167 and is the value of "LT_CURRENT - LT_AGE". The 0 should *not* be\r
 168 thought to be part of the version number of GLib. The LT_CURRENT -\r
 169 LT_AGE value will on purpose be kept as zero as long as binary\r
 170 compatibility is maintained. For the gory details, see configure.ac\r
 171 and libtool documentation.\r
 172 \r
 173 Building with Visual Studio\r
 174 ===========================\r
 175 \r
 176 A more detailed outline of building GLib with its dependencies can\r
 177 now be found on the GNOME wiki:\r
 178 \r
 179 https://wiki.gnome.org/Projects/GTK%2B/Win32/MSVCCompilationOfGTKStack\r
 180 \r
 181 Please do not build GLib in paths that contain spaces in them, as\r
 182 this may cause problems during compilation and during usage of the\r
 183 library.\r
 184 \r
 185 In an unpacked tarball, you will find in build\win32\vs9 (VS 2008) and\r
 186 build\win32\vs10 (VS 2010) a solution file that can be used to build\r
 187 the GLib DLLs and some auxiliary programs under VS 2008 and VS 2010\r
 188 (Express Edition will suffice with the needed dependencies) respectively.\r
 189 Read the README.txt file in those folders for more\r
 190 information. Note that you will need a libintl implementation, zlib, and \r
 191 libFFI.\r
 192 \r
 193 If you are building from a GIT checkout, you will first need to use some\r
 194 Unix-like environment or run build/win32/setup.py, \r
 195 which will expand the VS 2008/2010 project files, the DLL resouce files and\r
 196 other miscellanious files required for the build.  Run build/win32/setup.py\r
 197 as follows:\r
 198 \r
 199 $python build/win32/setup.py --perl path_to_your_perl.exe\r
 200 \r
 201 for more usage on this script, run\r
 202 $python build/win32/setup.py -h/--help\r
 203 \r
 204 Building with MSVC and NMAKE\r
 205 ============================\r
 206 \r
 207 If you are building from a GIT snapshot, you will not have all\r
 208 makefile.msc files. You should copy the corresponding makefile.msc.in\r
 209 file to that name, and replace any @...@ strings with the correct\r
 210 value (or use the python script de-in.py from http://hans.breuer.org/gtk/de-in.py).\r
 211 \r
 212 This is done automatically when an official GLib source distribution\r
 213 package is built, so if you get GLib from a source distribution\r
 214 package, there should be makefile.msc files ready to use (possibly after some\r
 215 editing).\r
 216 \r
 217 The hand-written makefile.msc files, and the stuff in the "build"\r
 218 subdirectory, produce DLLs and import libraries that match what the\r
 219 so-called autoconfiscated build produces.\r
 220 \r
 221 All the MSVC makefiles are for the command line build with nmake.  If\r
 222 you want to use the VC-UI you can simply create wrapper .dsp makefiles\r
 223 (read the VC docs how to do so).\r
 224 \r
 225 Some modules may require Perl to auto-generate files. The goal (at\r
 226 least Hans's) is to not require any more tools. Of course you need\r
 227 the Microsoft Platform SDK in a recent enough - but not too recent - version.\r
 228 The last PSDK for Visual Studio 6 is:\r
 229   http://www.microsoft.com/msdownload/platformsdk/sdkupdate/psdk-full.htm\r
 230 At least install the Core SDK, maybe also the "Tablet PC SDK".\r
 231 \r
 232 \r
 233 Build with:\r
 234 \r
 235 nmake -f makefile.msc\r
 236   or\r
 237 nmake -f makefile.msc DEBUG=1\r
 238 \r
 239 [\r
 240  The former will create 'release' versions of the DLLs. If you\r
 241  plan to distribute you DLLs please use this command. The latter \r
 242  will create DLLs with debug information _and_ link them with\r
 243  msvcrtd.dll instead of msvcrt.dll. \r
 244  Beware: There are known problems with mixing DLLs in one \r
 245  application, which are build against different runtimes. \r
 246  Especially the index-to-file mapping used by 'unix-style' file\r
 247  operation - _open() _pipe() etc. - breaks sometimes in strange \r
 248  ways (for example the Gimp plug-in communication).\r
 249 ]\r
 250 \r
 251 Required libraries (not build from svn)\r
 252 ------------------\r
 253   libintl (gnu-intl),\r
 254 \r
 255 are available pre-built from the website mentioned above.\r
 256 \r
 257 Versioning\r
 258 ----------\r
 259 Instead of the Unix and auto* way of tracking versions and resolving\r
 260 dependencies (configure; make; make install) involving autoconf,\r
 261 automake, libtool and friends the MSVC build uses a different\r
 262 approach.\r
 263 \r
 264 The core of it's versioning is the file build/win32/module.defs.\r
 265 It contains entries of the form MODULE_VER, e.g.:\r
 266 \r
 267         GLIB_VER = 2.0\r
 268         LIBICONV_VER = 1.3\r
 269 \r
 270 and the placement of these modules defined as MODULE, e.g.:\r
 271 \r
 272         GLIB = $(TOP)/glib\r
 273         LIBICONV = $(TOP)/libiconv-$(LIBICONV_VER)\r
 274 \r
 275 whereas TOP is defined as the relative path from the respective\r
 276 module directory to your top build directory. Every makefile.msc\r
 277 needs to define TOP before including the common make file part\r
 278 make.msc, which than includes module.defs, like:\r
 279 \r
 280 TOP = ../..\r
 281 !INCLUDE $(TOP)/glib/build/win32/make.msc\r
 282 \r
 283 (Taken from gtk+/gdk/makefile.msc)\r
 284 \r
 285 With this provision it is possible to create almost placement\r
 286 independent makefiles without requiring to 'install' the libraries and\r
 287 headers into a common place (as it is done on Unix, and as Tor does\r
 288 when producing his zipfiles with prebuilt GLib, GTK+ etc).\r
 289 \r
 290 Special Files\r
 291 -------------\r
 292         config.h.win32.in : @XXX_MAJOR_VERSION@ needs to be replaced by\r
 293 the current version/build number. The resulting file is to be saved\r
 294 as 'config.h.win32'. This should be automatically done if a package\r
 295 gets build on the Unix platform.\r
 296 \r
 297         makefile.msc.in : @XXX_MAJOR_VERSION@ to be replaced. Save as\r
 298 makefile.msc.\r
 299 \r
 300         <module>.def : every function which should be used from the outside of\r
 301 a dll needs to be marked for 'export'. It is common that one needs to change \r
 302 these files after some api changes occured. If there are variables to be\r
 303 exported another mechanism is needed, like :\r
 304 \r
 305         #ifdef G_OS_WIN32\r
 306         #  ifdef GDK_COMPILATION\r
 307         #    define GDKVAR __declspec(dllexport)\r
 308         #  else\r
 309         #    define GDKVAR extern __declspec(dllimport)\r
 310         #  endif\r
 311         #else\r
 312         #  define GDKVAR extern\r
 313         #endif\r
 314 \r
 315 \r
 316 \r
 317 Directory Structure\r
 318 -------------------\r
 319 all modules should be build in a common directory tree otherwise you \r
 320 need to adapt the file 'module.defs'. They are listed here in increasing\r
 321 dependencies order.\r
 322 \r
 323 <common rootdir without spaces>\r
 324   |\r
 325   +- glib\r
 326   |   |\r
 327   |   +- build          : [this module lives in the SVN root dir]\r
 328   |   |   +- win32\r
 329   |   |       .\module.defs : defines (relative) locations of the headers\r
 330   |   |                       and libs and version numbers to be include \r
 331   |   |                       in dll names\r
 332   |   |       .\make.msc    : include by almost every 'makefile.msc'\r
 333   |   |\r
 334   |   | .\README.WIN32  : more information how to build\r
 335   |   | .\glibconfig.h.win32.in : similar to config.h.win32.in\r
 336   |   | .\makefile.msc  : master makefile, sub dir makefiles should work \r
 337   |   |\r
 338   |   +- glib\r
 339   |   +- gmodule\r
 340   |   +- gthread        : does _not_ depend on pthread anymore\r
 341   |   +- gobject\r
 342   |\r
 343   +- pango\r
 344   |   +- pango          : 'native' build does not require extra libs and\r
 345   |   |                 includes the minimal required text renderer\r
 346   |   |                 (there is also a currently slightly broken FreeType2 \r
 347   |   |                 based implementation for win32)\r
 348   |   +- modules (not yet build)\r
 349   |\r
 350   +- atk\r
 351   |   +- atk\r
 352   |       .\makefile.msc : build here\r
 353   |\r
 354   +- gtk+\r
 355   |   | .\config.h.win32 : for all the below\r
 356   |   |\r
 357   |   +- gdk-pixbuf\r
 358   |   |   .\gdk_pixbuf.rc.in : version resource for the DLLs. Needs\r
 359   |   |                 to be converted (filled with version info)\r
 360   |   |                 as described above.\r
 361   |   |\r
 362   |   +- gdk\r
 363   |   |   | .\makefile.msc : some auto-generation is needed to build in the\r
 364   |   |   |             in the subdirectory \r
 365   |   |   +- win32\r
 366   |   |\r
 367   |   +- gtk\r
 368 \r
 369   |\r
 370   +- gimp\r
 371   |   .\makefile.msc    : master makefile to build The Gimp. The makefiles\r
 372   |                     from the sub dirs should work stand alone, but than\r
 373   |                     the user needs to know the build order\r
 374 \r
 375   |\r
 376   +- dia                : additionally depends on libart_lgpl (in SVN)\r
 377       |                 and libxml2 ( see http://www.xmlsoft.org/ )\r
 378       +- lib\r
 379       +- app\r
 380       +- objects\r
 381       +- plug-ins\r
 382           +- python\r
 383 \r
 384 [1]: https://wiki.gnome.org/Projects/GTK%2B/Win32/MSVCCompilationOfGTKStack under "Preparations"\r