]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/SWIG/README.txt
added a test to check how exception handling works with Win32 SEH; corrected copyright
[wxWidgets.git] / wxPython / SWIG / README.txt
index 1022a8994f59510fce66a7be49681bb0bd62be1a..ade6b98f8b8224412713a977df2c8780594948d2 100644 (file)
@@ -1,5 +1,5 @@
-SWIG 1.3 Patches
-================
+SWIG 1.3.x Patches
+==================
 
 This directory holds a set of patches for the CVS version of SWIG that
 are required if you wish to use SWIG for wxPython development, or for
 
 This directory holds a set of patches for the CVS version of SWIG that
 are required if you wish to use SWIG for wxPython development, or for
@@ -8,40 +8,102 @@ wxPython.  These have been submitted to SWIG's SourceForge patch
 tracker, so hopefully they will get incorporated into the main SWIG
 source tree soon.
 
 tracker, so hopefully they will get incorporated into the main SWIG
 source tree soon.
 
+wxPython currently uses the 1.3.24 version of SWIG, which you can get
+from https://sourceforge.net/projects/swig/, plus the patch(es) in this
+directory.  Download the SWIG sources, apply the patch(es) here and
+then build as normal.  If you want to use both the patched version of
+SWIG and the stock version, then you can configure the patched version
+to use a different --prefix and then specify that executable when
+running setup.py, like this:
+
+       python setup.py SWIG=/path/to/my/swig [other params]
+
 
 ------------------------------------------------------------------------
 
 
 ------------------------------------------------------------------------
 
-swig.python-2.patch        Adds the ability to turn off the automatic
-                           generation of __repr__ methods on a class
-                           by class basis.  Used in wxPython for
-                           classes that have a __repr__ added in
-                           %pythoncode directives.  See SF Patch
-                           #835471.
+swig-1.3.24.patch
+
+    A bug was introduced in SWIG 1.3.23 and remains in 1.3.24 that
+    causes compilation problems with wxPython (copies are being made
+    of objects that don't have a copy constructor.)  This patch fixes
+    the code generator to use a reference to the object instead of
+    making a copy.
+
+    Part of my autodoc patch was disabled becuase a unit-test failed.
+    It turns out that the failure was due to a name clash in the unit
+    test itself, so I re-enabled that section of code in this patch.
+
+    Don't generate the autodocs string for a class if it has a
+    docstring attribute.
+
+    Some typos fixed, etc.
 
 
 
 
 
 
 
 
+------------------------------------------------------------------------
+This patch was added to SWIG's CVS on 10/2/2004 and a modified version
+of it is in 1.3.23 and 1.3.24.
+------------------------------------------------------------------------
+
+
+swig.python-2.patch  
+
+    Adds the following features to the Python Module in SWIG.  See the
+    updated docs in the patch for more details.
+
+            %feature("autodoc")
+            %feature("docstring")
+            %feature("pythonprepend")
+            %feature("pythonappend")
+
+            %module(docstring="string")
+            %module(package="string")
+
+    https://sourceforge.net/tracker/index.php?func=detail&aid=1023309&group_id=1645&atid=301645
+
+
+------------------------------------------------------------------------
+This patch was applied to SWIG's CVS on 07/12/2004 and is in the
+1.3.22 relese.
+------------------------------------------------------------------------
+
+swig.xmlout.patch            Fixes a couple problems in the XML output
+                             of SWIG: an extra "/>" was removed and
+                             newlines in attribute values were changed
+                             to the #10; entity reference so they will
+                             be preserved by parsers.
+
+                             Also, added options for dumping or
+                             writing to a file the XML of the parse
+                             tree *after* other language modules have
+                             been run (previously you could only do
+                             the XML output *instead of* a regular
+                             language module.)
+                             See SF Patch #864689
+
 
 
 ------------------------------------------------------------------------
 
 
 ------------------------------------------------------------------------
-These patches have already been checked in to SWIG's CVS
+These patches have already been checked in to SWIG's CVS and are in
+the 1.3.20 release.
 ------------------------------------------------------------------------
 
 ------------------------------------------------------------------------
 
-swig.SplitLines.patch      Adds a new SplitLines function to the DOH
-                           library.  See SF Patch #829317.
-                           *Checked in 10/31/2003*
+swig.SplitLines.patch       Adds a new SplitLines function to the DOH
+                            library.  See SF Patch #829317.
+                            *Checked in 10/31/2003*
 
 
-swig.xml.patch             Adds an option that drastically reduces
-                           the size of the XML output of SWIG, which
-                           increases the performance of the
-                           build_renamers script used in the wxPython
-                           build.  See SF Patch #829319.
-                           *Checked in 10/31/2003*
+swig.xml.patch              Adds an option that drastically reduces
+                            the size of the XML output of SWIG, which
+                            increases the performance of the
+                            build_renamers script used in the wxPython
+                            build.  See SF Patch #829319.
+                            *Checked in 10/31/2003*
 
 
-swig.python.patch          Lots of changes for SWIG's Python module,
-                           especially in how the proxy code is
-                           generated.  See swig.python.patch.txt for
-                           more details, also SF Patch #829325.
-                           *Checked in 10/31/2003*
+swig.python.patch           Lots of changes for SWIG's Python module,
+                            especially in how the proxy code is
+                            generated.  See swig.python.patch.txt for
+                            more details, also SF Patch #829325.
+                            *Checked in 10/31/2003*
 
 ------------------------------------------------------------------------
 
 ------------------------------------------------------------------------