wxPython/SWIG/README.txt

   1 SWIG 1.3.x Patches
   2 ==================
   3
   4 This directory holds a set of patches for the CVS version of SWIG that
   5 are required if you wish to use SWIG for wxPython development, or for
   6 building your own extension modules that need to interface with
   7 wxPython.  These have been submitted to SWIG's SourceForge patch
   8 tracker, so hopefully they will get incorporated into the main SWIG
   9 source tree soon.
  10
  11 wxPython currently uses the 1.3.27 version of SWIG, which you can get
  12 from https://sourceforge.net/projects/swig/, plus the patch(es) in
  13 this directory.  Download the SWIG sources, apply the patch(es) here
  14 and then build as normal.  I have also have made available a tarball
  15 containing the patched SWIG sources, plus a win32 binary, located
  16 here:
  17
  18         http://starship.python.net/crew/robind/wxPython/tools/
  19
  20 If you want to use the patched version of SWIG and still have the
  21 stock version available for other projects, then you can configure the
  22 patched version to use a different --prefix and then specify that
  23 executable when running setup.py, like this:
  24
  25         python setup.py SWIG=/path/to/my/swig [other params]
  26
  27
  28
  29 ------------------------------------------------------------------------
  30
  31 swig-1.3.27.patch
  32
  33     SWIG changed slightly how the runtime type_info data is structured
  34     in order to optimize load time and runtime access.  wxPython
  35     uncovered a bug in the implementation, so this patch includes the
  36     fix that was checked in to CVS for 1.3.28.
  37
  38     SWIG changed how the import statments are output to the proxy
  39     file, but this also caused the order to change (they all moved to
  40     the very top of the file) so this broke the module docstring, as
  41     well as some behavior that Chandler development is depending upon,
  42     so this patch changes back to how it was done in prior releases.
  43
  44     Bug fix for SWIG's definition of the %makedefault macro.
  45
  46     Add a SWIG_VERSION macro to the wrapper file so C/C++ code can
  47     integrate with different versions of the generated runtime code.
  48
  49
  50
  51 ------------------------------------------------------------------------
  52
  53 swig-1.3.24.patch (now obsolete)
  54
  55     A bug was introduced in SWIG 1.3.23 and remains in 1.3.24 that
  56     causes compilation problems with wxPython (copies are being made
  57     of objects that don't have a copy constructor.)  This patch fixes
  58     the code generator to use a reference to the object instead of
  59     making a copy.
  60
  61     Part of my autodoc patch was disabled becuase a unit-test failed.
  62     It turns out that the failure was due to a name clash in the unit
  63     test itself, so I re-enabled that section of code in this patch.
  64
  65     Don't generate the autodocs string for a class if it has a
  66     docstring attribute.
  67
  68     Some typos fixed, etc.
  69
  70
  71
  72
  73 ------------------------------------------------------------------------
  74 This patch was added to SWIG's CVS on 10/2/2004 and a modified version
  75 of it is in 1.3.23 and 1.3.24.
  76 ------------------------------------------------------------------------
  77
  78
  79 swig.python-2.patch
  80
  81     Adds the following features to the Python Module in SWIG.  See the
  82     updated docs in the patch for more details.
  83
  84             %feature("autodoc")
  85             %feature("docstring")
  86             %feature("pythonprepend")
  87             %feature("pythonappend")
  88
  89             %module(docstring="string")
  90             %module(package="string")
  91
  92     https://sourceforge.net/tracker/index.php?func=detail&aid=1023309&group_id=1645&atid=301645
  93
  94
  95 ------------------------------------------------------------------------
  96 This patch was applied to SWIG's CVS on 07/12/2004 and is in the
  97 1.3.22 relese.
  98 ------------------------------------------------------------------------
  99
 100 swig.xmlout.patch            Fixes a couple problems in the XML output
 101                              of SWIG: an extra "/>" was removed and
 102                              newlines in attribute values were changed
 103                              to the #10; entity reference so they will
 104                              be preserved by parsers.
 105
 106                              Also, added options for dumping or
 107                              writing to a file the XML of the parse
 108                              tree *after* other language modules have
 109                              been run (previously you could only do
 110                              the XML output *instead of* a regular
 111                              language module.)
 112                              See SF Patch #864689
 113
 114
 115
 116 ------------------------------------------------------------------------
 117 These patches have already been checked in to SWIG's CVS and are in
 118 the 1.3.20 release.
 119 ------------------------------------------------------------------------
 120
 121 swig.SplitLines.patch       Adds a new SplitLines function to the DOH
 122                             library.  See SF Patch #829317.
 123                             *Checked in 10/31/2003*
 124
 125 swig.xml.patch              Adds an option that drastically reduces
 126                             the size of the XML output of SWIG, which
 127                             increases the performance of the
 128                             build_renamers script used in the wxPython
 129                             build.  See SF Patch #829319.
 130                             *Checked in 10/31/2003*
 131
 132 swig.python.patch           Lots of changes for SWIG's Python module,
 133                             especially in how the proxy code is
 134                             generated.  See swig.python.patch.txt for
 135                             more details, also SF Patch #829325.
 136                             *Checked in 10/31/2003*
 137
 138 ------------------------------------------------------------------------