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