docs/tech/tn0016.txt

   1          How to add new files and libraries to wxWindows build system
   2          ============================================================
   3
   4
   5 1. Regenerating makefiles
   6 -------------------------
   7
   8 wxWindows now uses Bakefile (http://bakefile.sourceforge.net) to generate
   9 native makefiles. You must have bakefile installed if you want to regenerate
  10 the makefiles. Bakefile currently runs on Unix and Windows systems. You will
  11 need Python >= 2.2 installed on Unix and either use Bakefile installer or have
  12 Python on Windows.
  13
  14 Once you have installed Bakefile, you can easily regenerate the makefiles using
  15 the makefile in $(wx)/build/bakefiles directory. The makefile uses Unix make
  16 syntax and works on Unix or using either Borland Make or GNU Make (including
  17 native Win32 port called mingw32-make from http://www.mingw.org) on Windows.
  18 It is possible that other Windows make utilities work as well, but it wasn't
  19 tested. "make clean" only works on Unix or Cygwin or MSYS emulation layer on
  20 Windows.
  21
  22 You can use following commands when generating the makefiles (must be run from
  23 $(wx)/build/bakefiles directory):
  24
  25 make <filename>           generates one makefile (e.g. "make ../makefile.gcc")
  26 make all                  regenerates all makefiles that are out of date
  27 make library              only makefiles for the main library
  28 make <compiler>           only makefiles for given compiler; possible values
  29                           are "borland", "watcom", "mingw", "autoconf", "msvc"
  30                           and "mvsc6prj" (Visual C++ project files)
  31 make clean                deletes all generated files (Unix shell only)
  32
  33 Note that it generates makefiles for samples and contrib libraries, too.
  34
  35 IMPORTANT NOTE: Don't forget to run autoconf in wxWindows root directory if
  36                 you changed any conditional variable or target condition
  37                 in .bkl files! You will know that this happened if
  38                 $(wx)/autoconf_inc.m4 content changed.
  39
  40 You can use Bakefile to generate makefiles or projects customized to your
  41 needs, too. See Makefile for details on bakefile commands used to generate
  42 makefiles. For example, you can use this command to generate VC++ project
  43 files without wxUniversal configurations:
  44     bakefile -v -fmsvc6prj -o../wxmy.dsw -DRUNTIME_LIBS=dynamic
  45              -DOFFICIAL_BUILD=0 -DUSE_HTML=1 -DUSE_OPENGL=1
  46              -DMONOLITHIC=0 -DUSE_GUI=1 -DWXUNIV=0 wx.bkl
  47 Or monolithic instead of multilib (the default):
  48     bakefile -v -fmsvc6prj -o../wxmono.dsw -DRUNTIME_LIBS=dynamic
  49              -DOFFICIAL_BUILD=0 -DUSE_HTML=1 -DUSE_OPENGL=1
  50              -DMONOLITHIC=1 -DUSE_GUI=1 wx.bkl
  51 Or monolithic wxBase:
  52     bakefile -v -fmsvc6prj -o../wxBase.dsw -DRUNTIME_LIBS=dynamic
  53              -DOFFICIAL_BUILD=0 -DUSE_HTML=0 -DUSE_OPENGL=0
  54              -DMONOLITHIC=1 -DUSE_GUI=0 wx.bkl
  55
  56
  57 2. Bakefile files organization
  58 ------------------------------
  59
  60 Makefile are generated from .bkl files ("bakefiles") from three places:
  61   - $(wx)/build/bakefiles directory
  62   - $(wx)/contrib/build/* directories
  63   - samples directories
  64 $(wx)/build/bakefiles contains bakefiles for main library and support files
  65 that simplify writing bakefiles for contrib and samples.
  66
  67 Support files are:
  68   wxwin.py                - helper functions
  69   common.bkl
  70   common_samples.bkl
  71   common_contrib.bkl      - shared definitions and templates
  72   config.bkl              - user-configurable build options
  73
  74 Files used to build the library are:
  75   wx.bkl                  - main file
  76   files.bkl               - lists of source files
  77   monolithic.bkl          - targets for wxWin built as single big library
  78   multilib.bkl            - targets for multilib build
  79   opengl.bkl              - GL library with wxGLCanvas (this one is not
  80                             included in monolithic library for historical
  81                             reasons, so "monolithic" really means "two libs")
  82   {expat,jpeg,png,tiff,
  83    regex,zlib,odbc}.bkl   - 3rd party libraries makefiles
  84
  85
  86 3. Adding files to existing library
  87 -----------------------------------
  88
  89 All files used by main libraries are listed in files.bkl. The file is
  90 organized into variables for toolkits, platforms and libraries. The variables
  91 come in pairs: there's always FOO_SRC for source files and FOO_HDR for header
  92 files. Platform or toolkit specific files are grouped together in variable
  93 with platform or tookit name in them, e.g. BASE_WIN32_SRC, BASE_UNIX_SRC,
  94 GTK_SRC, MOTIF_SRC.
  95
  96 Note: A side effect of this toolkit-centric organization is that one file may
  97       be present several times in files.bkl in different contenxt.
  98
  99 When you are adding a file, you must put it into appropriate variable. This is
 100 easy if you are adding the file to library that is always built from same
 101 sources on all platforms (e.g. wxXml or wxXML) -- simply add the file to e.g.
 102 HTML_SRC or HTML_HDR.
 103
 104 If the file is used only on one platform and is part of wxBase, add it to
 105 BASE_{platform}_SRC/HDR. If it is used on all platforms, add it to BASE_CMN.
 106 If it is built on more than one platform but not on all of them, add the file
 107 to *all platforms that use it*!
 108
 109 If a file is not wxBase file, but GUI file, then the variables are named after
 110 toolkits/ports, not platforms. Same rules as for wxBase files apply
 111 (substitute "platform" with "toolkit"). Make sure you correctly choose between
 112 {port}_LOWLEVEL_SRC and {port}_SRC -- the former is for files used by
 113 wxUniversal, e.g. GDI classes. Files shared by all X Window System ports
 114 should be put into XWIN_LOWLEVEL_SRC.
 115
 116
 117 4. Adding sample
 118 ----------------
 119
 120 Copy the bakefile from another sample, change the ID and files accordingly.
 121 If the sample uses some data files, make sure to have <wx-data> node
 122 in the sample's bakefile (see e.g. samples/image/image.bkl for an example).
 123 Make sure to add <wx-lib> statements for all libraries from multilib build
 124 that are required by the sample.
 125
 126 Run Python script regenMakefile.py in $(wx)/build/bakefiles to update Makefile
 127 and commit $(wx)/build/bakefiles/Makefile.
 128
 129
 130 5. Adding contrib library
 131 -------------------------
 132
 133 Contrib library bakefiles are located in $(wx)/contrib/build/name-of-contrib
 134 directory, together with generated makefiles. Copy the bakefile from another
 135 contrib library, change the IDs and files accordingly. Note that there must be
 136 two targets for contrib wxFoo: foodll and foolib.
 137
 138 foodll definition must contain <wx-lib> statements for all libraries it
 139 depends on. WXUSINGDLL and WXMAKINGDLL_FOO must be defined and symbols from
 140 the library should use WXDLLIMPEXP_FOO defined in wxFoo's headers analogically
 141 to WXDLLIMPEXP_{BASE,CORE,HTML,...} in the main library (see 5g below for
 142 additional details).
 143
 144 Run Python script regenMakefile.py in $(wx)/build/bakefiles to update Makefile
 145 and commit $(wx)/build/bakefiles/Makefile.
 146
 147
 148 6. Adding new core library
 149 --------------------------
 150
 151 When adding new library to the core set of libraries, the files must be
 152 added to both a newly added library in multilib build and into the single
 153 library built in monolithic mode. We will assume that the new library is
 154 called wxFoo.
 155
 156 a) Add files to files.bkl:
 157    * If wxFoo builds from same files on all platforms (e.g. wxNet),
 158      add FOO_SRC and FOO_HDR variables with lists of sources and headers.
 159    * If wxFoo have no files in common (e.g. wxGL), add FOO_SRC and FOO_HDR
 160      with toolkit or platform conditions. Have a look at OPENGL_SRC for an
 161      example.
 162    * Otherwise add FOO_CMN_SRC and FOO_CMN_HDR for common files and
 163      FOO_{platform}_{SRC,HDR} or FOO_{toolkit}_{SRC,HDR} as appropriate. Add
 164      FOO_PLATFORM_{SRC,HDR} into "Define sources for specific libraries"
 165      section that is conditionally set to one of FOO_xxx_{SRC,HDR} based on
 166      target platform/toolkit (see NET_PLATFORM_SRC definition for an example).
 167      Finally, define FOO_SRC and FOO_HDR to contain both
 168      FOO_PLATFORM_{SRC,HDR} and FOO_{SRC,HDR} (see NET_SRC definition for an
 169      example).
 170    * Add FOO_HDR to ALL_HEADERS
 171
 172    (You can apply different approaches to HDR and SRC variables, if e.g.
 173    headers are all common but sources are not.)
 174
 175    Note that the conditions can only test for equality, due to limitations of
 176    native make tools.
 177
 178 b) Modify bakefile system in build/bakefiles/ to recognize wxFoo:
 179    * Add 'foo'to MAIN_LIBS and LIBS_NOGUI or LIBS_GUI (depending on whether
 180      the library depends on wxCore or not) to wxwin.py file.
 181    * Add WXLIB_FOO definition to common.bkl (into the "Names of component
 182      libraries" section). It looks like this:
 183        <set var="WXLIB_FOO">
 184           <if cond="MONOLITHIC=='0'">$(mk.evalExpr(wxwin.mkLibName('foo')))</if>
 185        </set>
 186
 187 c) Add files to monolithic build: it's enough to add FOO_SRC to MONOLIB_GUI_SRC
 188    or MONOLIB_SRC, depending on whether wxFoo uses GUI or not.
 189
 190 d) Add files to multilib build: add foolib and foodll targets. Don't use
 191    wxBase targets as the template, use e.g. wxXML or wxHTML. Make sure
 192    WXMAKINGDLL_FOO is defined in foodll.
 193
 194 e) Regenerate all makefiles (don't forget to run autoconf)
 195
 196 f) Update wx-config.in to contain information about the library and needed
 197    linker flags:
 198    * Add "foo" to either CORE_BASE_LIBS or CORE_GUI_LIBS so that wxFoo is
 199      not treated as contrib library in monolithic build.
 200    * If wxFoo links against additional libraries, add neccessary linker
 201      flags and libraries to ldflags_foo and ldlibs_foo variables (both are
 202      optional).
 203
 204 g) Update defs.h to define WXMAKINGDLL_FOO if WXMAKINGDLL is defined (add
 205    #define WXMAKINGDLL_FOO inside first "#ifdef WXMAKINGDLL" block in defs.h)
 206    and to define WXDLLIMPEXP_FOO and WXDLLIMPEXP_DATA_FOO. You can copy
 207    e.g. WXDLLIMPEXP_NET definition, it is something like this:
 208         #ifdef WXMAKINGDLL_NET
 209             #define WXDLLIMPEXP_NET WXEXPORT
 210             #define WXDLLIMPEXP_DATA_NET(type) WXEXPORT type
 211         #elif defined(WXUSINGDLL)
 212             #define WXDLLIMPEXP_NET WXIMPORT
 213             #define WXDLLIMPEXP_DATA_NET(type) WXIMPORT type
 214         #else // not making nor using DLL
 215             #define WXDLLIMPEXP_NET
 216             #define WXDLLIMPEXP_DATA_NET(type) type
 217         #endif
 218    Use WXDLLIMPEXP_FOO when declaring wxFoo classes and functions.
 219
 220 i) Add information about wxFoo to the manual
 221    FIXME - where exactly
 222
 223
 224 === EOF ===
 225
 226 Version: $Id$