[wxWidgets.git] / wxPython / SWIG / README.txt

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
building your own extension modules that need to interface with
wxPython.  These have been submitted to SWIG's SourceForge patch
tracker, so hopefully they will get incorporated into the main SWIG
source tree soon.

wxPython currently uses the 1.3.29 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.  I have also have made available a tarball
containing the patched SWIG sources, plus a win32 binary, located
here:

	http://wxpython.wxcommunity.com/tools/

If you want to use the patched version of SWIG and still have the
stock version available for other projects, 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-1.3.29.patch

    SWIG changed how the import statements are output to the proxy
    file, but this also caused the order to change (they all moved to
    the very top of the file) so this broke the module docstring, as
    well as some behavior that Chandler development is depending upon,
    so this patch changes back to how it was done in prior releases.

    Changed the exception message used for TypeErrors to make a little
    more sense.

    Added support for dropping the leading wx from wxNames using
    %rename("%(wxpy)s") ""; 

    Don't set a module attribute for the *_swigregister functions,
    just call the one in the extension module directly.

    Fixes to allow compiling with Python 2.5 headers.


------------------------------------------------------------------------

swig-1.3.27.patch

    SWIG changed slightly how the runtime type_info data is structured
    in order to optimize load time and runtime access.  wxPython
    uncovered a bug in the implementation, so this patch includes the
    fix that was checked in to CVS for 1.3.28.

    SWIG changed how the import statements are output to the proxy
    file, but this also caused the order to change (they all moved to
    the very top of the file) so this broke the module docstring, as
    well as some behavior that Chandler development is depending upon,
    so this patch changes back to how it was done in prior releases.

    Bug fix for SWIG's definition of the %makedefault macro.

    Fixes to allow compiling with Python 2.5 headers.
    

------------------------------------------------------------------------

swig-1.3.24.patch (now obsolete)

    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 because 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 release.
------------------------------------------------------------------------

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 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.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*

------------------------------------------------------------------------
Commit	Line	Data
3c1705d9 RD	1	SWIG 1.3.x Patches
3c1705d9 RD	2	==================
d14a1e28 RD	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
0ae3258d	11	wxPython currently uses the 1.3.29 version of SWIG, which you can get
9269629e RD	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
53133108	18	http://wxpython.wxcommunity.com/tools/
9269629e RD	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:
f96a7475	24
3c1705d9	25	python setup.py SWIG=/path/to/my/swig [other params]
f96a7475	26
d14a1e28	27
9269629e	28
0ae3258d RD	29	------------------------------------------------------------------------
	30
	31	swig-1.3.29.patch
	32
daf22b89	33	SWIG changed how the import statements are output to the proxy
0ae3258d RD	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
d9f09ac4 RD	42	Added support for dropping the leading wx from wxNames using
d9f09ac4 RD	43	%rename("%(wxpy)s") "";
0ae3258d	44
1767b394 RD	45	Don't set a module attribute for the *_swigregister functions,
1767b394 RD	46	just call the one in the extension module directly.
0ae3258d	47
ae200bfc RD	48	Fixes to allow compiling with Python 2.5 headers.
	49
	50
2f810297 RD	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
daf22b89	60	SWIG changed how the import statements are output to the proxy
2f810297 RD	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
ae200bfc	68	Fixes to allow compiling with Python 2.5 headers.
9037d43c	69
2f810297	70
d14a1e28 RD	71	------------------------------------------------------------------------
d14a1e28 RD	72
9269629e	73	swig-1.3.24.patch (now obsolete)
3c1705d9 RD	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
daf22b89	81	Part of my autodoc patch was disabled because a unit-test failed.
782ece57 RD	82	It turns out that the failure was due to a name clash in the unit
782ece57 RD	83	test itself, so I re-enabled that section of code in this patch.
3c1705d9 RD	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
d14a1e28	98
414863fd	99	swig.python-2.patch
d14a1e28	100
414863fd RD	101	Adds the following features to the Python Module in SWIG. See the
414863fd RD	102	updated docs in the patch for more details.
42637d60	103
414863fd RD	104	%feature("autodoc")
	105	%feature("docstring")
	106	%feature("pythonprepend")
	107	%feature("pythonappend")
42637d60	108
414863fd RD	109	%module(docstring="string")
414863fd RD	110	%module(package="string")
42637d60	111
414863fd	112	https://sourceforge.net/tracker/index.php?func=detail&aid=1023309&group_id=1645&atid=301645
42637d60	113
42637d60	114
414863fd RD	115	------------------------------------------------------------------------
414863fd RD	116	This patch was applied to SWIG's CVS on 07/12/2004 and is in the
daf22b89	117	1.3.22 release.
414863fd	118	------------------------------------------------------------------------
42637d60	119
414863fd RD	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.
1e9b37a2	125
414863fd RD	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
d14a1e28 RD	133
d14a1e28 RD	134
0cb6df6e	135
d14a1e28	136	------------------------------------------------------------------------
700c96d4 RD	137	These patches have already been checked in to SWIG's CVS and are in
700c96d4 RD	138	the 1.3.20 release.
d14a1e28 RD	139	------------------------------------------------------------------------
d14a1e28 RD	140
414863fd RD	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
d14a1e28 RD	157
d14a1e28 RD	158	------------------------------------------------------------------------