BuildSVN.txt

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