Renamed m_blocking to m_non_blocking
[wxWidgets.git] / BuildCVS.txt
1 ------------------------------------------------------------------------
2                 How to build the sources from CVS
3 ------------------------------------------------------------------------
4
5 I) Windows using plain makefiles
6 ----------------------------------------
7
8 a) Using the GNU MinGW32 or GNU CygWin32 compilers
9
10 You'll need the compiler itself which is available from
11
12   http://www.cygwin.com
13
14 When using MingW32 you'll need GNU make which is part of
15 part of the CygWin32 toolchain and is also available as
16 a stand alone port without the infamous Cygwin.dll from
17
18   http://agnes.dida.physik.uni-essen.de/~janjaap/mingw32
19
20 The makefile has small problems with Cygwin´s tools
21 so it is recommended not to use these (but MingGW32
22 and its make.exe).
23
24 -> Set your path so that it includes the directory
25    where your compiler and tools reside
26 -> Assume that you installed the wxWindows sources
27    into c:\wxWin
28 -> Copy c:\wxWin\include\wx\msw\setup0.h 
29    to   c:\wxWin\include\wx\msw\setup.h
30 -> Edit c:\wxWin\include\wx\msw\setup.h so that
31    most features are enabled (i.e. defined to 1) with
32    #define wxUSE_SOCKETS       0
33    #define wxUSE_HTML          1
34    #define wxUSE_THREADS       1
35    #define wxUSE_FS_INET       0
36    #define wxUSE_FS_ZIP        1
37    #define wxUSE_BUSYINFO      1
38    #define wxUSE_DYNLIB_CLASS  1
39    #define wxUSE_ZIPSTREAM     1
40    #define wxUSE_JPEGLIB       1
41    #define wxUSE_PNGLIB        1
42
43    and iostreams ares disabled with
44    #define wxUSE_STD_IOSTREAM   0
45 -> type: cd c:\wxWin\src\msw
46 -> type: make -f makefile.g95
47
48 II) GTK port on Unix using plain makefiles.
49 ------------------------------------------
50
51 Set WXWIN environment variable to the base directory such
52 as ~/wxWindows
53
54 -> type: export WXWIN=~/wxWindows
55 -> edit ~/wxWindows/src/gtk.env as you wish.
56 -> type: cd ~/wxWindows/src/gtk
57 -> type: cp ./setup0.h setup.h
58 -> type: make
59
60
61 III) Windows using configure
62 ----------------------------------------
63
64 Take a look at Unix->Windows cross compiling. With minor
65 modifications, this should work in Windows if you've got the cygnus
66 utilities (bash, GNU make, etc) and either mingw32 or cygwin32 installed. 
67 See http://www.cygnus.com for these programs, or go straight to their
68 ftp server at ftp://sourceware.cygnus.com/pub/cygwin/. 
69
70 Of course, you can also build the library using plain makefiles (see 
71 section I).
72
73 IV) Unix using configure
74 ----------------------------------------
75
76 a) You have all the newest and greatest GNU tools installed on your system 
77 and in the same directory hierachy (e.g. either all tools in /usr or all 
78 in /usr/local), these tools are:
79 - GNU libtool 1.2e (1.3 doesn't work here)
80 - GNU autoconf 2.13 (including autoheader 2.13)
81 - GNU automake 1.4 (including aclocal 1.4)
82 and possibly but not forcibly
83 - GNU make 3.76.1
84 - GNU C++ (EGCS)
85
86 -> Go to the base directory
87 -> type: ./autogen.sh
88
89 b) You don't know what autos are and have no driver's licence anyway:
90
91 -> Go to the testconf directory
92 -> type: ./apply
93
94 a+b) Then proceed in either case with:
95
96 -> Choose a directory name that seems fit for building wxWindows, e.g. mybuild
97 -> Go the base directory
98 -> type: mkdir mybuild
99 -> type: cd mybuild
100 -> type: ../configure --with-gtk   
101 or type: ../configure --with-motif
102 or type: ../configure --with-wine
103 -> type make
104 -> drink lots of coffee and go shopping
105
106
107 V) MacOS
108 ----------------------------------------
109
110 VI) OS/2
111 ----------------------------------------
112
113 VII) Unix->Windows cross-compiling using configure
114 --------------------------------------------------
115
116 First you'll need a cross-compiler; linux glibc binaries of mingw32 and
117 cygwin32 (both based on egcs) can be found at
118 ftp://ftp.objsw.com/pub/crossgcc/linux-x-win32. Otherwise you can 
119 compile one yourself. Check the relevant FAQs.
120
121 [ A Note about cygwin32 and mingw32: the main difference is that cygwin32
122 binaries are always linked against cygwin.dll. This dll encapsulates most
123 standard Unix C extensions, which is very handy if you're porting unix
124 software to windows. However, wxMSW doesn't need this, so mingw32 is
125 preferable if you write portable C(++). ]
126
127 You might want to build both Unix and Windows binaries in the same source
128 tree; to do this make subdirs for each e.g. unix and win32. If you've
129 already build wxWindows in the main dir, do a 'make distclean' there,
130 otherwise configure will get confused. (In any case, read the section 'Unix
131 using configure' and make sure you're able to build a native wxWindows
132 library; cross-compiling errors can be pretty obscure and you'll want to be
133 sure that your configure setup is basically sound.)
134
135 To cross compile the windows library, do
136 -> cd win32
137 Now run configure. There are two ways to do this
138 -> ../configure --host=i586-mingw32 --build=i586-linux --with-mingw \
139    --enable-dnd=no
140 where --build= should read whatever platform you're building on. Configure
141 will notice that build and host platforms differ, and automatically prepend
142 i586-mingw32- to gcc, ar, ld, etc (make sure they're in the PATH!). 
143 The other way to run configure is by specifying the names of the binaries 
144 yourself:
145 -> CC=i586-mingw32-gcc CXX=i586-mingw32-g++ RANLIB=i586-mingw32-ranlib \
146    DLLTOOL=i586-mingw32-dlltool LD=i586-mingw32-ld NM=i586-mingw32-nm \
147    ../configure --host=i586-mingw32 --with-mingw --enable-dnd=no
148
149 (all assuming you're using mingw32)
150 Drag'n'drop is disabled because mingw32 lacks (AFAIK) OLE headers.
151
152 Configure will conclude that shared libraries are out of the question and
153 opt for a static one. I haven't looked into DLL creation yet.
154
155 Type 
156 -> make -C src
157 and wait, wait, wait. Don't leave the room, because the minute you do there
158 will be a compile error :-)
159
160 If this is successful, try building the minimal sample:
161 -> cd samples/minimal
162 -> make
163 -> mv minimal minimal.exe
164
165 and run it with wine, for example
166 -> wine minimal.exe
167
168 If all is well, do an install; from win32
169 -> make install
170
171 Native and cross-compiled installations can co-exist peacefully 
172 (as long as their widget sets differ), except for wx-config. You might 
173 want to rename the cross-compiled one to i586-mingw32-wx-config, or something.
174
175 Cross-compiling TODO:
176 ---------------------
177 - resource compiling must be done manually for now (should/can we link the 
178 default wx resources into libwx_msw.a?) [ No we can't; the linker won't
179 link it in... you have to supply an object file ]
180 - dynamic libraries
181 - static executables are HUGE -- there must be room for improvement.
182