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

SWIG 1.3 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 20-Feb-2004 version of SWIG.  You can get
that version from their CVS using these commands::


    cvs -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/swig login
    <press ENTER for empty password>

    cvs -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/swig \
	checkout -D 20-FEB-2004 SWIG


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


swig.python-docstring.patch  Adds "autodoc" and "docstring" features.
			     See SF Patch #883402

			     Also changes the "addtofunc" feature to
			     "pythonappend" and also adds a
			     "pythonprepend" feature that prepends
			     pythoncode to the begining of a
			     SWIG-generated proxy function or method.

			     Add support for two new options to the
			     %module directive.  The first allows you
			     to specify a docstring for the proxy
			     module, you use it like this::

			       %module(docstring="blah") modulename

			     And then when generating the
			     modulename.py file SWIG will make a
			     docstring using the value given.  

			     The second %module option allows you to
			     specify the name of the package that the
			     module will live in.  This is useful when
			     the .i file is %imported by other .i
			     files.  If they are to live in separate
			     packages then the importer can't do local
			     imports of the importee.  If both modules
			     have the same package name then nothing
			     is generated differently than the current
			     SWIG functionality.  If they are
			     different then the package name of the
			     importee is prepended to the import
			     statement and the base class declarations
			     in the importer.  For example::

			       %module(pacakge="wx") _core

			     Multiple %module options can be specfied,
			     separated by commmas.


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
d14a1e28 RD	1	SWIG 1.3 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
f96a7475 RD	11	wxPython currently uses the 20-Feb-2004 version of SWIG. You can get
	12	that version from their CVS using these commands::
	13
	14
	15	cvs -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/swig login
	16	<press ENTER for empty password>
	17
	18	cvs -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/swig \
	19	checkout -D 20-FEB-2004 SWIG
	20
d14a1e28 RD	21
	22	------------------------------------------------------------------------
	23
d14a1e28	24
6a30d63a	25	swig.python-docstring.patch Adds "autodoc" and "docstring" features.
0cb6df6e RD	26	See SF Patch #883402
0cb6df6e RD	27
6c7eee75 RD	28	Also changes the "addtofunc" feature to
	29	"pythonappend" and also adds a
	30	"pythonprepend" feature that prepends
	31	pythoncode to the begining of a
	32	SWIG-generated proxy function or method.
d14a1e28	33
42637d60 RD	34	Add support for two new options to the
	35	%module directive. The first allows you
	36	to specify a docstring for the proxy
	37	module, you use it like this::
	38
	39	%module(docstring="blah") modulename
	40
	41	And then when generating the
	42	modulename.py file SWIG will make a
	43	docstring using the value given.
	44
	45	The second %module option allows you to
	46	specify the name of the package that the
	47	module will live in. This is useful when
	48	the .i file is %imported by other .i
	49	files. If they are to live in separate
	50	packages then the importer can't do local
	51	imports of the importee. If both modules
	52	have the same package name then nothing
	53	is generated differently than the current
	54	SWIG functionality. If they are
	55	different then the package name of the
	56	importee is prepended to the import
	57	statement and the base class declarations
	58	in the importer. For example::
	59
	60	%module(pacakge="wx") _core
	61
	62	Multiple %module options can be specfied,
	63	separated by commmas.
	64
	65
1e9b37a2 RD	66	swig.xmlout.patch Fixes a couple problems in the XML output
	67	of SWIG: an extra "/>" was removed and
	68	newlines in attribute values were changed
	69	to the #10; entity reference so they will
	70	be preserved by parsers.
	71
	72	Also, added options for dumping or
	73	writing to a file the XML of the parse
	74	tree after other language modules have
	75	been run (previously you could only do
	76	the XML output instead of a regular
	77	language module.)
1202c414	78	See SF Patch #864689
d14a1e28 RD	79
d14a1e28 RD	80
0cb6df6e	81
d14a1e28	82	------------------------------------------------------------------------
700c96d4 RD	83	These patches have already been checked in to SWIG's CVS and are in
700c96d4 RD	84	the 1.3.20 release.
d14a1e28 RD	85	------------------------------------------------------------------------
	86
	87	swig.SplitLines.patch Adds a new SplitLines function to the DOH
	88	library. See SF Patch #829317.
	89	Checked in 10/31/2003
	90
	91	swig.xml.patch Adds an option that drastically reduces
	92	the size of the XML output of SWIG, which
	93	increases the performance of the
	94	build_renamers script used in the wxPython
	95	build. See SF Patch #829319.
	96	Checked in 10/31/2003
	97
	98	swig.python.patch Lots of changes for SWIG's Python module,
	99	especially in how the proxy code is
	100	generated. See swig.python.patch.txt for
	101	more details, also SF Patch #829325.
	102	Checked in 10/31/2003
	103
	104	------------------------------------------------------------------------