Ensure we pass the correct type of string to EscapeFileNameCharsInURL in wxWebViewArc...

[wxWidgets.git] / docs / tech / tn0016.txt

diff --git a/docs/tech/tn0016.txt b/docs/tech/tn0016.txt
index 48af6442c216cb58c248645b7771858b41759470..abf51765e25ada332bc3550efb3a8012579ac6c2 100644 (file)
--- a/docs/tech/tn0016.txt
+++ b/docs/tech/tn0016.txt
@@ -16,7 +16,7 @@ the bakefile_gen tool. Run it from $(wx)/build/bakefiles directory and it will
 regenerate all outdated makefiles. See $(wx)/build/bakefiles/README for more
 details.
 
 regenerate all outdated makefiles. See $(wx)/build/bakefiles/README for more
 details.
 

-Note that it generates makefiles for samples and contrib libraries, too.
+Note that it generates makefiles for samples, too.

 
 IMPORTANT NOTE: Don't forget to run autoconf in wxWidgets root directory
                 (after running Bakefile) if you changed any conditional
 
 IMPORTANT NOTE: Don't forget to run autoconf in wxWidgets root directory
                 (after running Bakefile) if you changed any conditional


@@ -29,17 +29,17 @@ generate makefiles. For example, you can use this command to generate
 VC++ project files without wxUniversal configurations:
     bakefile -v -fmsvc6prj -o../wxmy.dsw -DRUNTIME_LIBS=dynamic
              -DDEBUG_INFO=default -DDEBUG_FLAG=default
 VC++ project files without wxUniversal configurations:
     bakefile -v -fmsvc6prj -o../wxmy.dsw -DRUNTIME_LIBS=dynamic
              -DDEBUG_INFO=default -DDEBUG_FLAG=default

-             -DOFFICIAL_BUILD=0 -DUSE_HTML=1 -DUSE_OPENGL=1 -DUSE_ODBC=1
+             -DOFFICIAL_BUILD=0 -DUSE_HTML=1 -DUSE_OPENGL=1

              -DMONOLITHIC=0 -DUSE_GUI=1 -DWXUNIV=0 wx.bkl
 Or monolithic instead of multilib (the default):
     bakefile -v -fmsvc6prj -o../wxmono.dsw -DRUNTIME_LIBS=dynamic
              -DDEBUG_INFO=default -DDEBUG_FLAG=default
              -DMONOLITHIC=0 -DUSE_GUI=1 -DWXUNIV=0 wx.bkl
 Or monolithic instead of multilib (the default):
     bakefile -v -fmsvc6prj -o../wxmono.dsw -DRUNTIME_LIBS=dynamic
              -DDEBUG_INFO=default -DDEBUG_FLAG=default

-             -DOFFICIAL_BUILD=0 -DUSE_HTML=1 -DUSE_OPENGL=1 -DUSE_ODBC=1
+             -DOFFICIAL_BUILD=0 -DUSE_HTML=1 -DUSE_OPENGL=1

              -DMONOLITHIC=1 -DUSE_GUI=1 wx.bkl
 Or monolithic wxBase:
     bakefile -v -fmsvc6prj -o../wxBase.dsw -DRUNTIME_LIBS=dynamic
              -DDEBUG_INFO=default -DDEBUG_FLAG=default
              -DMONOLITHIC=1 -DUSE_GUI=1 wx.bkl
 Or monolithic wxBase:
     bakefile -v -fmsvc6prj -o../wxBase.dsw -DRUNTIME_LIBS=dynamic
              -DDEBUG_INFO=default -DDEBUG_FLAG=default

-             -DOFFICIAL_BUILD=0 -DUSE_HTML=0 -DUSE_OPENGL=0 -DUSE_ODBC=0
+             -DOFFICIAL_BUILD=0 -DUSE_HTML=0 -DUSE_OPENGL=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
              -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


@@ -49,18 +49,16 @@ and use bakefile_gen instead of running bakefile directly.
 2. Bakefile files organization
 ------------------------------
 
 2. Bakefile files organization
 ------------------------------
 

-Makefile are generated from .bkl files ("bakefiles") from three places:
+Makefile are generated from .bkl files ("bakefiles") from two places:

   - $(wx)/build/bakefiles directory
   - $(wx)/build/bakefiles directory

-  - $(wx)/contrib/build/* directories

   - samples directories
 $(wx)/build/bakefiles contains bakefiles for main library and support files
   - samples directories
 $(wx)/build/bakefiles contains bakefiles for main library and support files

-that simplify writing bakefiles for contrib and samples.
+that simplify writing bakefiles for samples.

 
 Support files are:
   wxwin.py                - helper functions
   common.bkl
   common_samples.bkl
 
 Support files are:
   wxwin.py                - helper functions
   common.bkl
   common_samples.bkl

-  common_contrib.bkl      - shared definitions and templates

   config.bkl              - user-configurable build options
   make_dist.mk            - implementation of "make dist" on Unix
 
   config.bkl              - user-configurable build options
   make_dist.mk            - implementation of "make dist" on Unix
 


@@ -116,30 +114,18 @@ 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.
 
 Make sure to add <wx-lib> statements for all libraries from multilib build
 that are required by the sample.
 

-Run bakefile_gen in $(wx)/build/bakefiles to regenerate the bakefiles.
-
-Finally commit $(wx)/build/bakefiles/Makefile and all the other modified files.
+The Windows resource specification should use the central .rc file:

 
 

+        <win32-res>../sample.rc</win32-res>

 
 

-5. Adding contrib library
--------------------------
-
-Contrib library bakefiles are located in $(wx)/contrib/build/name-of-contrib
-directory, together with generated makefiles. Copy the bakefile from another
-contrib library, change the IDs and files accordingly. Note that there must be
-two targets for contrib wxFoo: foodll and foolib.
+Run bakefile_gen in $(wx)/build/bakefiles to regenerate the bakefiles.

 
 

-foodll definition must contain <wx-lib> statements for all libraries it
-depends on. WXUSINGDLL and WXMAKINGDLL_FOO must be defined and symbols from
-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).
+Finally commit $(wx)/build/bakefiles/make_dist.mk and all the other modified files.

 
 

-Run bakefile_gen in $(wx)/build/bakefiles to regenerate makefiles
-then commit $(wx)/build/bakefiles/Makefile.
+Currently we commit the generated makefiles except .dms, .vcp.

 
 
 
 

-6. Adding new core library
+5. Adding new core library

 --------------------------
 
 When adding new library to the core set of libraries, the files must be
 --------------------------
 
 When adding new library to the core set of libraries, the files must be


@@ -161,7 +147,7 @@ a) Add files to files.bkl:
      Finally, define FOO_SRC and FOO_HDR to contain both
      FOO_PLATFORM_{SRC,HDR} and FOO_{SRC,HDR} (see NET_SRC definition for an
      example).
      Finally, define FOO_SRC and FOO_HDR to contain both
      FOO_PLATFORM_{SRC,HDR} and FOO_{SRC,HDR} (see NET_SRC definition for an
      example).

-   * Add FOO_HDR to ALL_GUI_HEADERS or ALL_BASE_HEADERS. 
+   * Add FOO_HDR to ALL_GUI_HEADERS or ALL_BASE_HEADERS.

    * If wxFoo is wxBase library (doesn't use GUI), add FOO_SRC to
      ALL_BASE_SOURCES.
 
    * If wxFoo is wxBase library (doesn't use GUI), add FOO_SRC to
      ALL_BASE_SOURCES.
 


@@ -174,26 +160,26 @@ 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.
 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 extra libraries needed by wxFoo (if any) 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">
           <if cond="MONOLITHIC=='0'">$(mk.evalExpr(wxwin.mkLibName('foo')))</if>
        </set>
 
    * Add WXLIB_FOO definition to common.bkl (into the "Names of component
      libraries" section). It looks like this:
        <set var="WXLIB_FOO">
           <if cond="MONOLITHIC=='0'">$(mk.evalExpr(wxwin.mkLibName('foo')))</if>
        </set>
 

-c) Add files to monolithic build: it's enough to add FOO_SRC to MONOLIB_GUI_SRC
-   or MONOLIB_SRC, depending on whether wxFoo uses GUI or not.
+c) Modify monolithic.bkl to add files to monolithic build: it's enough to add
+   FOO_SRC to MONOLIB_GUI_SRC or MONOLIB_SRC, depending on whether wxFoo uses
+   GUI or not.

 
 

-d) Add files to multilib build: add foolib and foodll targets. Don't use
-   wxBase targets as the template, use e.g. wxXML or wxHTML. Make sure
-   WXMAKINGDLL_FOO is defined in foodll.
+d) Modify multilib.bkl to add files to multilib build: add foolib and foodll
+   targets. Don't use wxBase targets as the template, use e.g. wxXML or wxHTML.
+   Make sure WXMAKINGDLL_FOO is defined in foodll.

 
 e) Regenerate all makefiles (don't forget to run autoconf)
 
 f) Update configure.in and wx-config.in to contain information about
    the library and needed linker flags:
 
 e) Regenerate all makefiles (don't forget to run autoconf)
 
 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.
+   * Add "foo" to either STD_BASE_LIBS or STD_GUI_LIBS in configure.in.

    * 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).
    * 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).


@@ -212,6 +198,7 @@ g) Update dlimpexp.h to define WXMAKINGDLL_FOO if WXMAKINGDLL is defined (add
             #define WXDLLIMPEXP_NET
             #define WXDLLIMPEXP_DATA_NET(type) type
         #endif
             #define WXDLLIMPEXP_NET
             #define WXDLLIMPEXP_DATA_NET(type) type
         #endif

+   Don't forget to add WXDLLIMPEXP_FWD_FOO definitions too.

    Use WXDLLIMPEXP_FOO when declaring wxFoo classes and functions.
 
 h) Add this code to one of wxFoo's files (the more often used, the better):
    Use WXDLLIMPEXP_FOO when declaring wxFoo classes and functions.
 
 h) Add this code to one of wxFoo's files (the more often used, the better):


@@ -220,8 +207,13 @@ h) Add this code to one of wxFoo's files (the more often used, the better):
       WX_CHECK_BUILD_OPTIONS("wxFoo")
 
 i) Add information about wxFoo to the manual ("Libraries list" section
       WX_CHECK_BUILD_OPTIONS("wxFoo")
 
 i) Add information about wxFoo to the manual ("Libraries list" section

-   in libs.tex).
+   in libs.tex) and update docs/latex/wx/libs.dia (you need Dia for this)
+   to show the dependencies of the new library.

 
 

+j) Also please add 4 #pragma comment(lib, "foo") (for Unicode/ANSI
+   Release/Debug combinations) to the file include/msvc/wx/setup.h and
+   add a check for WXMAKINGDLL_FOO to the test whether we're building a DLL at
+   the end of include/wx/msw/chkconf.h.

 
 === EOF ===
 
 
 === EOF ===