]> git.saurik.com Git - wxWidgets.git/blob - docs/msw/install.txt
Changes to allow Cygwin to compile in non-PCH mode
[wxWidgets.git] / docs / msw / install.txt
1
2 Installing wxWindows 2.0
3 ------------------------
4
5 Unarchiving
6 -----------
7
8 If there is a setup program, run the setup program that comes with the Windows version.
9 Do not install into a path that contains spaces. The installation program should set the
10 WXWIN environment variable, which will be activated when your machine is rebooted.
11
12 If there is no setup program, it will come as a series of .zip
13 files:
14
15 wx200gen.zip Generic source code and samples (required)
16 wx200msw.zip Windows-specific source code and samples (required)
17 wx200doc.zip Documentation source code (not required)
18 wx200hlp.zip WinHelp documentation
19 wx200pdf.zip Acrobat PDF documentation
20 wx200htm.zip HTML documentation
21 wx200vc.zip MS VC++ 5.0 project files
22 wx200cw.zip Metrowerks CodeWarrior project files
23
24 Unarchive the required files plus any optional documentation
25 files into a suitable directory such as c:\wx. Alter your
26 WXWIN environment variable to point to this directory.
27
28 Compilation
29 -----------
30
31 At present, wxWindows compiles with VC++ 4.0/5.0/6.0,
32 BC++ 4.5/5.0, Gnu-Win32 b19/b20, and Mingw32. It may compile
33 with 16-bit compilers (BC++ and VC++ 1.5) but this hasn't
34 been tested lately.
35
36 Visual C++ 4.0/5.0/6.0 compilation
37 ----------------------------------
38
39 Using project files:
40
41 1. Unarchive wx200vc.zip, the VC++ 5 project makefiles.
42 2. Open src/wxvc.dsp, set Debug or Release configuration, and
43 compile. This will produce lib/wxvc.lib or lib/wxvc_debug.lib.
44 3. Open a sample project file, choose a configuration, and compile.
45 The project files don't use precompiled headers, to save
46 space, but you can switch PCH compiling on for greater speed.
47
48 Using makefiles:
49
50 1. Make sure your WXWIN variable is set.
51 2. Change directory to wx\src\msw. Type 'nmake -f makefile.nt' to
52 make the wxWindows core library.
53 3. Change directory to wx\samples and type 'nmake -f makefile.nt'
54 to make all the samples. You can also make them individually.
55
56 Note (1): if you wish to use templates, please edit
57 include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
58 Without this, the redefinition of 'new' will cause problems in
59 the headers. Alternatively, #undef new before including template headers.
60
61 Note (2): libraries and applications generated with makefiles and
62 project files are unlikely to be compatible, so use one method or
63 the other.
64
65 Visual C++ 1.5 compilation
66 --------------------------
67
68 1. Make sure your WXWIN variable is set, and uses the FAT (short
69 name) form.
70 2. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to
71 make the wxWindows core library.
72 3. Change directory to a sample, such as wx\samples\minimal, and
73 type 'nmake -f makefile.dos'.
74
75 Borland C++ 4.5/5.0 compilation
76 -------------------------------
77
78 1. Make sure your WXWIN variable is set, and uses the FAT (short
79 name) form if doing a 16-bit compile.
80 2. Change directory to wx\src\msw. Type 'make -f makefile.b32' to
81 make the wxWindows core library. Ignore the warnings about
82 'XXX' not found in library.
83 3. Change directory to a sample such as minimal, and type
84 'make -f makefile.b32'.
85 4. For release versions, recompile wxWindows and samples using
86 'make -f makefile.b32 clean'
87 'make -f makefile.b32 FINAL=1'
88 for the library and samples.
89
90 Note: the wxWindows library and (some) samples compile in 16-bit mode
91 using makefile.bcc, but at present the wxWindows resource system is switched
92 off in this mode. See issues.txt for details.
93
94 Borland C++Builder compilation
95 ------------------------------
96
97 C++Builder compilation is the same as for Borland C++ above.
98
99 Tested with C++Builder 1.0 and 3.0. Only makefiles are currently
100 supplied.
101
102 Watcom C++ 10.6 compilation
103 ---------------------------
104
105 1. Make sure your WXWIN variable is set, and uses the FAT (short
106 name) form.
107 2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat' to
108 make the wxWindows core library.
109 3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
110 to make this sample.
111
112 Metrowerks CodeWarrior compilation
113 ----------------------------------
114
115 1. Downloaded and unzip wx200cw.zip.
116 2. Load the make_cw.mcp project in wx\src, and compile.
117 3. Load the make_cw.mcp project in wx\samples\minimal, and compile.
118 Further project files for samples will be available in due
119 course.
120
121 Symantec C++ compilation
122 ------------------------
123
124 1. Make sure your WXWIN variable is set, and uses the FAT (short
125 name) form.
126 2. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
127 3. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
128 make the wxWindows core library.
129 4. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
130 to make this sample.
131
132 Note: the minimal sample doesn't link properly ('Error: no
133 start address').
134 32-bit compilation only (partially) supported at present, using SC++ 6.1.
135 Some functionality is missing using this compiler (see makefile).
136 Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
137 Step (2). 16-bit compilation is left as an excercise for the user!
138
139 Gnu-Win32 b19/b20/Mingw32 compilation
140 -------------------------------------
141
142 wxWindows 2.0 supports Gnu-Win32/Cygwin b19, b20, Mingw32, and Mingw32/EGCS.
143
144 Thanks are due to Keith Garry Boyce (garp@opustel.com) and Cygnus for making
145 it all possible.
146
147 From wxWindows 2.0 beta 9, both Gnu-Win32 and Mingw32 (the minimal
148 distribution of Gnu-Win32) can be used with the same makefiles.
149
150 Here are the steps required:
151
152 - Retrieve and install the latest beta of Gnu-Win32, or Mingw32, as per the
153 instructions with either of these packages.
154
155 - If using Mingw32 (including the EGCS variant), you need some
156 extra files to use the wxWindows makefiles. You can find these
157 files in ports/mingw32 on the ftp site or CD-ROM, as extra.zip.
158 These should be extracted to the Mingw32 directory.
159 IMPORTANT: also see mingw32.txt in this directory (docs/msw)
160 about a fix that has to be applied to a Mingw32 header file.
161
162 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
163 to set up appropriate variables, if necessary mounting drives.
164 Run it before compiling.
165
166 - For Gnu-Win32, make sure there's a \tmp directory on your
167 Windows drive or bison will crash.
168
169 - Edit wx/src/makeg95.env and search for MINGW32. Take note of
170 the comments for adjusting settings to suit Gnu-Win32 or
171 Mingw32. Basically, this is just a case of adding the __MINGW32__ symbol
172 to OPTIONS for Mingw32, or removing it for Cygnus Gnu-Win32.
173 For Mingw32/EGCS, add both __MINGW32__ and __EGCS__.
174
175 - Mingw32 may not support winsock.h, so comment out
176 socket-related files in src/msw/makefile.g95.
177
178 - Use the makefile.g95 files for compiling wxWindows and samples,
179 e.g.:
180 > cd c:\wx\src\msw
181 > make -f makefile.g95
182 > cd c:\wx\samples\minimal
183 > make -f makefile.g95
184
185 - Use the 'strip' command to reduce executable size.
186
187 - With Cygnus Gnu-Win32, you can invoke gdb --nw myfile.exe to
188 debug an executable. If there are memory leaks, they will be
189 flagged when the program quits.
190
191 - If using GnuWin32 b18, you will need to copy windres.exe
192 from e.g. the Mingw32 distribution, to a directory in your path.
193
194 All targets have 'clean' targets to allow removal of object files
195 and other intermediate compiler files.
196
197 Gotchas:
198
199 - libwx.a is 48 MB or more - but much less if compiled with no
200 debug info (-g0) and level 4 optimization (-O4).
201 - install.exe doesn't have built-in decompression because lzexpand.lib
202 isn't available with Gnu-Win32. However, you can use it with external
203 decompression utilities.
204 - Doesn't compile src/msw/ole files, so no drag and drop.
205
206 References:
207
208 - The GNU-WIN32 site is at
209 http://www.cygnus.com/gnu-win32/
210 - Mingw32 is available at:
211 http://agnes.dida.physik.uni-essen.de/~janjaap/mingw32/index.html
212 - See also http://web.ukonline.co.uk/julian.smart/wxwin/gnuwin32.htm
213
214 Notes
215 -----
216
217 - Debugging: under Windows 95, debugging output isn't output in
218 the same way that it is under NT or Windows 3.1. Set
219 wxUSE_DBWIN32 to 1 if you wish to enable code to output debugging
220 info to an external debug monitor, such as Andrew Tucker's DBWIN32.
221 You can download DBWIN32 from:
222
223 http://ftp.digital.com/pub/micro/NT/WinSite/programr/dbwin32.zip
224
225 and it's also on the wxWindows CD-ROM under Packages.
226