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.24 version of SWIG, which you can get
  12 from https://sourceforge.net/projects/swig/, plus the patch(es) in this
  13 directory.  Download the SWIG sources, apply the patch(es) here and
  14 then build as normal.  If you want to use both the patched version of
  15 SWIG and the stock version, then you can configure the patched version
  16 to use a different --prefix and then specify that executable when
  17 running setup.py, like this:
  18
  19         python setup.py SWIG=/path/to/my/swig [other params]
  20
  21
  22 ------------------------------------------------------------------------
  23
  24 swig-1.3.24.patch
  25
  26     A bug was introduced in SWIG 1.3.23 and remains in 1.3.24 that
  27     causes compilation problems with wxPython (copies are being made
  28     of objects that don't have a copy constructor.)  This patch fixes
  29     the code generator to use a reference to the object instead of
  30     making a copy.
  31
  32     Part of my autodoc patch was disabled becuase a unit-test failed.
  33     It turns out that the failure was due to a name clash in the unit
  34     test itself, so I re-enabled that section of code in this patch.
  35
  36     Don't generate the autodocs string for a class if it has a
  37     docstring attribute.
  38
  39     Some typos fixed, etc.
  40
  41
  42
  43
  44 ------------------------------------------------------------------------
  45 This patch was added to SWIG's CVS on 10/2/2004 and a modified version
  46 of it is in 1.3.23 and 1.3.24.
  47 ------------------------------------------------------------------------
  48
  49
  50 swig.python-2.patch
  51
  52     Adds the following features to the Python Module in SWIG.  See the
  53     updated docs in the patch for more details.
  54
  55             %feature("autodoc")
  56             %feature("docstring")
  57             %feature("pythonprepend")
  58             %feature("pythonappend")
  59
  60             %module(docstring="string")
  61             %module(package="string")
  62
  63     https://sourceforge.net/tracker/index.php?func=detail&aid=1023309&group_id=1645&atid=301645
  64
  65
  66 ------------------------------------------------------------------------
  67 This patch was applied to SWIG's CVS on 07/12/2004 and is in the
  68 1.3.22 relese.
  69 ------------------------------------------------------------------------
  70
  71 swig.xmlout.patch            Fixes a couple problems in the XML output
  72                              of SWIG: an extra "/>" was removed and
  73                              newlines in attribute values were changed
  74                              to the #10; entity reference so they will
  75                              be preserved by parsers.
  76
  77                              Also, added options for dumping or
  78                              writing to a file the XML of the parse
  79                              tree *after* other language modules have
  80                              been run (previously you could only do
  81                              the XML output *instead of* a regular
  82                              language module.)
  83                              See SF Patch #864689
  84
  85
  86
  87 ------------------------------------------------------------------------
  88 These patches have already been checked in to SWIG's CVS and are in
  89 the 1.3.20 release.
  90 ------------------------------------------------------------------------
  91
  92 swig.SplitLines.patch       Adds a new SplitLines function to the DOH
  93                             library.  See SF Patch #829317.
  94                             *Checked in 10/31/2003*
  95
  96 swig.xml.patch              Adds an option that drastically reduces
  97                             the size of the XML output of SWIG, which
  98                             increases the performance of the
  99                             build_renamers script used in the wxPython
 100                             build.  See SF Patch #829319.
 101                             *Checked in 10/31/2003*
 102
 103 swig.python.patch           Lots of changes for SWIG's Python module,
 104                             especially in how the proxy code is
 105                             generated.  See swig.python.patch.txt for
 106                             more details, also SF Patch #829325.
 107                             *Checked in 10/31/2003*
 108
 109 ------------------------------------------------------------------------