test wxString's char<->wchar_t ctors

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

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