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.29 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://wxpython.wxcommunity.com/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.29.patch
  32
  33     SWIG changed how the import statements are output to the proxy
  34     file, but this also caused the order to change (they all moved to
  35     the very top of the file) so this broke the module docstring, as
  36     well as some behavior that Chandler development is depending upon,
  37     so this patch changes back to how it was done in prior releases.
  38
  39     Changed the exception message used for TypeErrors to make a little
  40     more sense.
  41
  42     Added support for dropping the leading wx from wxNames using
  43     %rename("%(wxpy)s") "";
  44
  45     Don't set a module attribute for the *_swigregister functions,
  46     just call the one in the extension module directly.
  47
  48     Fixes to allow compiling with Python 2.5 headers.
  49
  50
  51 ------------------------------------------------------------------------
  52
  53 swig-1.3.27.patch
  54
  55     SWIG changed slightly how the runtime type_info data is structured
  56     in order to optimize load time and runtime access.  wxPython
  57     uncovered a bug in the implementation, so this patch includes the
  58     fix that was checked in to CVS for 1.3.28.
  59
  60     SWIG changed how the import statements are output to the proxy
  61     file, but this also caused the order to change (they all moved to
  62     the very top of the file) so this broke the module docstring, as
  63     well as some behavior that Chandler development is depending upon,
  64     so this patch changes back to how it was done in prior releases.
  65
  66     Bug fix for SWIG's definition of the %makedefault macro.
  67
  68     Fixes to allow compiling with Python 2.5 headers.
  69
  70
  71 ------------------------------------------------------------------------
  72
  73 swig-1.3.24.patch (now obsolete)
  74
  75     A bug was introduced in SWIG 1.3.23 and remains in 1.3.24 that
  76     causes compilation problems with wxPython (copies are being made
  77     of objects that don't have a copy constructor.)  This patch fixes
  78     the code generator to use a reference to the object instead of
  79     making a copy.
  80
  81     Part of my autodoc patch was disabled because a unit-test failed.
  82     It turns out that the failure was due to a name clash in the unit
  83     test itself, so I re-enabled that section of code in this patch.
  84
  85     Don't generate the autodocs string for a class if it has a
  86     docstring attribute.
  87
  88     Some typos fixed, etc.
  89
  90
  91
  92
  93 ------------------------------------------------------------------------
  94 This patch was added to SWIG's CVS on 10/2/2004 and a modified version
  95 of it is in 1.3.23 and 1.3.24.
  96 ------------------------------------------------------------------------
  97
  98
  99 swig.python-2.patch
 100
 101     Adds the following features to the Python Module in SWIG.  See the
 102     updated docs in the patch for more details.
 103
 104             %feature("autodoc")
 105             %feature("docstring")
 106             %feature("pythonprepend")
 107             %feature("pythonappend")
 108
 109             %module(docstring="string")
 110             %module(package="string")
 111
 112     https://sourceforge.net/tracker/index.php?func=detail&aid=1023309&group_id=1645&atid=301645
 113
 114
 115 ------------------------------------------------------------------------
 116 This patch was applied to SWIG's CVS on 07/12/2004 and is in the
 117 1.3.22 release.
 118 ------------------------------------------------------------------------
 119
 120 swig.xmlout.patch            Fixes a couple problems in the XML output
 121                              of SWIG: an extra "/>" was removed and
 122                              newlines in attribute values were changed
 123                              to the #10; entity reference so they will
 124                              be preserved by parsers.
 125
 126                              Also, added options for dumping or
 127                              writing to a file the XML of the parse
 128                              tree *after* other language modules have
 129                              been run (previously you could only do
 130                              the XML output *instead of* a regular
 131                              language module.)
 132                              See SF Patch #864689
 133
 134
 135
 136 ------------------------------------------------------------------------
 137 These patches have already been checked in to SWIG's CVS and are in
 138 the 1.3.20 release.
 139 ------------------------------------------------------------------------
 140
 141 swig.SplitLines.patch       Adds a new SplitLines function to the DOH
 142                             library.  See SF Patch #829317.
 143                             *Checked in 10/31/2003*
 144
 145 swig.xml.patch              Adds an option that drastically reduces
 146                             the size of the XML output of SWIG, which
 147                             increases the performance of the
 148                             build_renamers script used in the wxPython
 149                             build.  See SF Patch #829319.
 150                             *Checked in 10/31/2003*
 151
 152 swig.python.patch           Lots of changes for SWIG's Python module,
 153                             especially in how the proxy code is
 154                             generated.  See swig.python.patch.txt for
 155                             more details, also SF Patch #829325.
 156                             *Checked in 10/31/2003*
 157
 158 ------------------------------------------------------------------------