docs/tech/tn0016.txt

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