BuildSVN.txt

   1 ------------------------------------------------------------------------
   2                 How to build the sources from SVN
   3 ------------------------------------------------------------------------
   4
   5 Please use the install.txt files in docs/gtk, docs/msw, docs/motif, docs/mac
   6 etc. alongside these instructions.
   7
   8 I) Windows using plain makefiles
   9 ----------------------------------------
  10
  11 a) If using Microsoft Visual C++ 5.0 or 6.0
  12
  13 Ensure that the command-line compiler and tools (including
  14 nmake) are installed and ready to run.  Depending on your
  15 installation there may be a batch file (commonly named VCVARS32.BAT)
  16 that needs to be run to set correct environment variables and PATH entries.
  17
  18 Continue with item c) below.
  19
  20
  21 b) If using the MinGW or Cygwin compilers
  22
  23 You can get MinGW from  http://www.mingw.org/
  24
  25 Cygwin is available at  http://www.cygwin.com/
  26
  27 If you are using Cygwin or MinGW together with the MSYS environment, you
  28 can build the library using configure (see "Unix ports" and
  29 "Windows using configure" below). You can also
  30 build wxWidgets without configure using native makefile, but only with
  31 MinGW. Using Cygwin together with Windows makefile is no longer supported.
  32
  33 If building with MinGW without configure:
  34
  35 -> Set your path so that it includes the directory
  36    where your compiler and tools reside
  37
  38 -> Make sure you have GNU Make installed. It must be Windows native version.
  39    Download it from http://www.mingw.org, the executable will be called
  40    mingw32-make.exe.
  41
  42 -> Modern version of MinGW is required; preferably MinGW 2.0 (with gcc3),
  43    but MinGW with gcc-2.95.3 will suffice. If you are using 2.95, you will
  44    have to change variable GCC_VERSION in config.gcc (see msw/install.txt
  45    for details).
  46
  47 If using configure, Unix instructions apply.
  48
  49
  50 c) Build instructions
  51
  52 Assuming that you installed the wxWidgets sources into c:\wxWidgets:
  53
  54 -> Copy c:\wxWidgets\include\wx\msw\setup0.h
  55    to   c:\wxWidgets\include\wx\msw\setup.h
  56 -> Edit c:\wxWidgets\include\wx\msw\setup.h to choose
  57    the features you would like to compile wxWidgets with[out].
  58
  59    and std iostreams are disabled with
  60    #define wxUSE_STD_IOSTREAM   0
  61
  62 -> type: cd c:\wxWidgets\build\msw
  63 -> type: make -f makefile.gcc  (if using GNU tools)
  64 or type: nmake -f makefile.vc   (if using MS VC++)
  65 etc.
  66
  67    See also docs/msw/install.txt for additional compilation options.
  68
  69 d) Borland (including free command line tools)
  70    Download tools from http://www.borland.com/downloads/
  71
  72    See docs/msw/install.txt for details; in brief:
  73
  74 -> type cd c:\wxWidgets\build\msw
  75 -> type make -f makefile.bcc
  76
  77 You can customize many things in the build process, detailed description is
  78 in docs/msw/install.txt.
  79
  80
  81 II) Unix ports
  82 --------------
  83
  84 Building wxGTK or wxMotif completely without configure
  85 won't ever work, but there is now a new makefile system
  86 that works without libtool and automake, using only
  87 configure to create what is needed.
  88
  89 In order to create configure, you need to have the
  90 GNU autoconf package (version > 2.54) installed
  91 on your system and type run "autoconf" in the base
  92 directory (or run the autogen.sh script in the same
  93 directory, which just calls autoconf). Note that you usually don't
  94 need to do this because configure is included in SVN.
  95
  96 Set WXWIN environment variable to the base directory such
  97 as ~/wxWidgets (this is actually not really needed).
  98
  99 -> type: export WXWIN=~/wxWidgets
 100 -> type: md mybuild
 101 -> type: cd mybuild
 102 -> type: ../configure --with-motif
 103 or type: ../configure --with-gtk
 104 -> type: make
 105 -> type: su <type root password>
 106 -> type: make install
 107 -> type: ldconfig
 108 -> type: exit
 109
 110 Call configure with --disable-shared to create a static
 111 library. Calling "make uninstall" will remove the installed
 112 library and "make dist" will create a distribution (not
 113 yet complete).
 114
 115 III) Windows using configure
 116 ----------------------------------------
 117
 118 wxWidgets can be built on Windows using MSYS (see
 119 http://www.mingw.org/), which is a POSIX build environment
 120 for Windows. With MSYS you can just ./configure && make (see also VII,
 121 Unix->Windows cross-compiling using configure).
 122
 123 Of course, you can also build the library using plain makefiles (see
 124 section I).
 125
 126 IV) Classic MacOS using CodeWarrior (eg MacOS 8.x/9.x)
 127 ----------------------------------------
 128
 129 Refer to the readme.txt and install.txt files in docs/mac to build
 130 wxWidgets under Classic Mac OS using CodeWarrior.
 131
 132 If you are checking out the SVN sources using svn under Mac OS X and
 133 compiling under Classic Mac OS:
 134
 135 - make sure that all text files have a Mac OS type of 'TEXT' otherwise
 136   CodeWarrior may ignore them. Checking out the SVN sources using svn
 137   under Mac OS X creates untyped files which can lead to compilation
 138   errors under CodeWarrior which are hard to track down.
 139
 140 - convert the xml files to CodeWarrior binary projects using the supplied
 141   AppleScript in docs/mac (M5xml2mcp.applescript for CodeWarrior 5.3)
 142
 143 V) MacOS X using configure and the Developer Tools
 144 ----------------------------------------
 145
 146 You need to have the Developer Tools installed. If this is not the case,
 147 you will need to register at the Apple Developer web site (this is a free
 148 registration) in order to download the Developer Tools installer.
 149
 150 In order to create configure, you need to have the
 151 GNU autoconf package (version >= 2.54) installed
 152 on your system and type run "autoconf" in the base
 153 directory (or run the autogen.sh script in the same
 154 directory, which just calls autoconf).
 155
 156 -> type: mkdir macbuild
 157 -> type: cd macbuild
 158 -> type: ../configure --with-mac
 159 or type: ../configure
 160 -> type: make
 161
 162 VI) OS/2
 163 ----------------------------------------
 164 No notes.
 165
 166 VII) Unix->Windows cross-compiling using configure
 167 --------------------------------------------------
 168
 169 First you'll need a cross-compiler; linux glibc binaries of MinGW and
 170 Cygwin (both based on egcs) can be found at
 171 ftp://ftp.objsw.com/pub/crossgcc/linux-x-win32. Alternative binaries,
 172 based on the latest MinGW release can be found at
 173 http://members.telering.at/jessich/mingw/mingwcross/mingw_cross.html
 174 Otherwise you can compile one yourself.
 175
 176 [ A Note about Cygwin and MinGW: the main difference is that Cygwin
 177 binaries are always linked against cygwin.dll. This dll encapsulates most
 178 standard Unix C extensions, which is very handy if you're porting unix
 179 software to windows. However, wxMSW doesn't need this, so MinGW is
 180 preferable if you write portable C(++). ]
 181
 182 You might want to build both Unix and Windows binaries in the same source
 183 tree; to do this make subdirs for each e.g. unix and win32. If you've
 184 already build wxWidgets in the main dir, do a 'make distclean' there,
 185 otherwise configure will get confused. (In any case, read the section 'Unix
 186 using configure' and make sure you're able to build a native wxWidgets
 187 library; cross-compiling errors can be pretty obscure and you'll want to be
 188 sure that your configure setup is basically sound.)
 189
 190 To cross compile the windows library, do
 191 -> cd win32
 192 (or whatever you called it)
 193 Now run configure. There are two ways to do this
 194 -> ../configure --host=i586-mingw32 --build=i586-linux --with-mingw
 195 where --build= should read whatever platform you're building on. Configure
 196 will notice that build and host platforms differ, and automatically prepend
 197 i586-mingw32- to gcc, ar, ld, etc (make sure they're in the PATH!).
 198 The other way to run configure is by specifying the names of the binaries
 199 yourself:
 200 -> CC=i586-mingw32-gcc CXX=i586-mingw32-g++ RANLIB=i586-mingw32-ranlib \
 201    DLLTOOL=i586-mingw32-dlltool LD=i586-mingw32-ld NM=i586-mingw32-nm \
 202    ../configure --host=i586-mingw32 --with-mingw
 203
 204 (all assuming you're using MinGW)
 205 By default this will compile a DLL, if you want a static library,
 206 specify --disable-shared.
 207
 208 Type
 209 -> make
 210 and wait, wait, wait. Don't leave the room, because the minute you do there
 211 will be a compile error :-)
 212
 213 NB: if you are using a very old compiler you risk to get quite a few warnings
 214     about "ANSI C++ forbids implicit conversion from 'void *'" in all places
 215     where va_arg macro is used. This is due to a bug in (some versions of)
 216     MinGW headers which may be corrected by upgrading your compier,
 217     otherwise you might edit the file
 218
 219     ${install_prefix}/lib/gcc-lib/i586-mingw32/egcs-2.91.57/include/stdarg.h
 220
 221     (instead of egcs-2.91.57 you may have something different), searching for
 222     the lines
 223
 224 /* Define __gnuc_va_list.  */
 225
 226 #ifndef __GNUC_VA_LIST
 227 #define __GNUC_VA_LIST
 228 #if defined(__svr4__) || defined(_AIX) || defined(_M_UNIX) || defined(__NetBSD__)
 229 typedef char *__gnuc_va_list;
 230 #else
 231 typedef void *__gnuc_va_list;
 232 #endif
 233 #endif
 234
 235     and adding "|| defined(_WIN32)" to the list of platforms on which
 236     __gnuc_va_list is char *.
 237
 238 If this is successful, you end up with a wx23_2.dll/libwx23_2.a in win32/lib
 239 (or just libwx_msw.a if you opted for a static build).
 240 Now try building the minimal sample:
 241
 242 -> cd samples/minimal
 243 -> make
 244
 245 and run it with wine, for example (or copy to a Windows box)
 246 -> wine minimal.exe
 247
 248 If all is well, do an install; from win32
 249 -> make install
 250
 251 Native and cross-compiled installations can co-exist peacefully
 252 (as long as their widget sets differ), except for wx-config. You might
 253 want to rename the cross-compiled one to i586-mingw32-wx-config, or something.
 254
 255 Cross-compiling TODO:
 256 ---------------------
 257 - resource compiling must be done manually for now (should/can we link the
 258 default wx resources into libwx_msw.a?) [ No we can't; the linker won't
 259 link it in... you have to supply an object file ]
 260 - static executables are HUGE -- there must be room for improvement.
 261