]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/tech/tn0016.txt
added GetSelection for wxMSW.
[wxWidgets.git] / docs / tech / tn0016.txt
index 012c63bf24bb14baf2a54f52b4bbb8bbd850e1bf..88fbebcf5921de5c9a110a7e299bb6c621359df5 100644 (file)
@@ -1,11 +1,11 @@
-         How to add new files and libraries to wxWindows build system
+         How to add new files and libraries to wxWidgets build system
          ============================================================
 
 
 1. Regenerating makefiles
 -------------------------
 
-wxWindows now uses Bakefile (http://bakefile.sourceforge.net) to generate
+wxWidgets now uses Bakefile (http://bakefile.sourceforge.net) to generate
 native makefiles. You must have bakefile installed if you want to regenerate
 the makefiles. Bakefile currently runs on Unix and Windows systems. You will
 need Python >= 2.2 installed on Unix and either use Bakefile installer or have
@@ -18,10 +18,10 @@ details.
 
 Note that it generates makefiles for samples and contrib libraries, too.
 
-IMPORTANT NOTE: Don't forget to run autoconf in wxWindows root directory if
-                you changed any conditional variable or target condition
-                in .bkl files! You will know that this happened if
-                $(wx)/autoconf_inc.m4 content changed.
+IMPORTANT NOTE: Don't forget to run autoconf in wxWidgets root directory
+                (after running Bakefile) if you changed any conditional
+                variable or target condition in .bkl files! You will know that
+                this happened if $(wx)/autoconf_inc.m4 content changed.
 
 You can use Bakefile to generate makefiles or projects customized to your
 needs, too. See Bakefiles.bkgen for details on bakefile commands used to
@@ -41,6 +41,9 @@ Or monolithic wxBase:
              -DDEBUG_INFO=default -DDEBUG_FLAG=default
              -DOFFICIAL_BUILD=0 -DUSE_HTML=0 -DUSE_OPENGL=0 -DUSE_ODBC=0
              -DMONOLITHIC=1 -DUSE_GUI=0 wx.bkl
+It is, however, recommended to modify Bakefiles.bkgen (or
+Bakefiles.local.bkgen) by means of <add-flags> and <del-flags> directives
+and use bakefile_gen instead of running bakefile directly.
 
 
 2. Bakefile files organization
@@ -80,11 +83,11 @@ All files used by main libraries are listed in files.bkl. The file is
 organized into variables for toolkits, platforms and libraries. The variables
 come in pairs: there's always FOO_SRC for source files and FOO_HDR for header
 files. Platform or toolkit specific files are grouped together in variable
-with platform or tookit name in them, e.g. BASE_WIN32_SRC, BASE_UNIX_SRC,
+with platform or toolkit name in them, e.g. BASE_WIN32_SRC, BASE_UNIX_SRC,
 GTK_SRC, MOTIF_SRC.
 
 Note: A side effect of this toolkit-centric organization is that one file may
-      be present several times in files.bkl in different contenxt.
+      be present several times in files.bkl in different contexts.
 
 When you are adding a file, you must put it into appropriate variable. This is
 easy if you are adding the file to library that is always built from same
@@ -113,8 +116,7 @@ in the sample's bakefile (see e.g. samples/image/image.bkl for an example).
 Make sure to add <wx-lib> statements for all libraries from multilib build
 that are required by the sample.
 
-Run Python script regenMakefile.py in $(wx)/build/bakefiles to update Makefile
-then run "make" in $(wx)/build/bakefiles directories.
+Run bakefile_gen in $(wx)/build/bakefiles to regenerate the bakefiles.
 
 Finally commit $(wx)/build/bakefiles/Makefile and all the other modified files.
 
@@ -133,8 +135,8 @@ the library should use WXDLLIMPEXP_FOO defined in wxFoo's headers analogically
 to WXDLLIMPEXP_{BASE,CORE,HTML,...} in the main library (see 5g below for
 additional details).
 
-Run Python script regenMakefile.py in $(wx)/build/bakefiles to update Makefile
-and commit $(wx)/build/bakefiles/Makefile.
+Run bakefile_gen in $(wx)/build/bakefiles to regenerate makefiles
+then commit $(wx)/build/bakefiles/Makefile.
 
 
 6. Adding new core library
@@ -172,7 +174,7 @@ a) Add files to files.bkl:
 b) Modify bakefile system in build/bakefiles/ to recognize wxFoo:
    * Add 'foo' to MAIN_LIBS and LIBS_NOGUI or LIBS_GUI (depending on whether
      the library depends on wxCore or not) to wxwin.py file.
-   * Add the library to DEPS_TABLE in wxwin.py
+   * Add the library to EXTRALIBS in wxwin.py
    * Add WXLIB_FOO definition to common.bkl (into the "Names of component
      libraries" section). It looks like this:
        <set var="WXLIB_FOO">
@@ -192,14 +194,14 @@ f) Update configure.in and wx-config.in to contain information about
    the library and needed linker flags:
    * Add "foo" to either CORE_BASE_LIBS or CORE_GUI_LIBS in configure.in so
      that wxFoo is not treated as contrib library in monolithic build.
-   * If wxFoo links against additional libraries, add neccessary linker
+   * If wxFoo links against additional libraries, add necessary linker
      flags and libraries to ldflags_foo and ldlibs_foo variables in
      wx-config.in (both are optional).
 
-g) Update defs.h to define WXMAKINGDLL_FOO if WXMAKINGDLL is defined (add
-   #define WXMAKINGDLL_FOO inside first "#ifdef WXMAKINGDLL" block in defs.h)
-   and to define WXDLLIMPEXP_FOO and WXDLLIMPEXP_DATA_FOO. You can copy
-   e.g. WXDLLIMPEXP_NET definition, it is something like this:
+g) Update dlimpexp.h to define WXMAKINGDLL_FOO if WXMAKINGDLL is defined (add
+   #define WXMAKINGDLL_FOO inside first "#ifdef WXMAKINGDLL" block in
+   dlimpexp.h) and to define WXDLLIMPEXP_FOO and WXDLLIMPEXP_DATA_FOO. You
+   can copy e.g. WXDLLIMPEXP_NET definition, it is something like this:
         #ifdef WXMAKINGDLL_NET
             #define WXDLLIMPEXP_NET WXEXPORT
             #define WXDLLIMPEXP_DATA_NET(type) WXEXPORT type