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