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