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