1SWIG (Simplified Wrapper and Interface Generator)
3Version: 3.0.8 (in progress)
5Tagline: SWIG is a compiler that integrates C and C++ with languages
6 including Perl, Python, Tcl, Ruby, PHP, Java, C#, D, Go, Lua,
7 Octave, R, Scheme (Guile, MzScheme/Racket, CHICKEN), Scilab,
8 Ocaml, Modula-3, Common Lisp (CLISP, Allegro CL, CFFI, UFFI)
9 and Pike. SWIG can also export its parse tree into XML and
10 Lisp s-expressions.
12SWIG reads annotated C/C++ header files and creates wrapper code (glue
13code) in order to make the corresponding C/C++ libraries available to
14the listed languages, or to extend C/C++ programs with a scripting
17Up-to-date SWIG related information can be found at
21A SWIG FAQ and other hints can be found on the SWIG Wiki:
27Please see the LICENSE file for details of the SWIG license. For
28further insight into the license including the license of SWIG's
29output code, please visit
35Please see the CHANGES.current file for a detailed list of bug fixes and
36new features for the current release. The CHANGES file contains bug fixes
37and new features for older versions. A summary of changes in each release
38can be found in the RELEASENOTES file.
42The Doc/Manual directory contains the most recent set of updated
43documentation for this release. The documentation is available in
44three different formats, each of which contains identical content.
45These format are, pdf (Doc/Manual/SWIGDocumentation.pdf), single
46page html (Doc/Manual/SWIGDocumentation.html) or multiple page html
47(other files in Doc/Manual). Please select your chosen format and
48copy/install to wherever takes your fancy.
50There is some technical developer documentation available in the
51Doc/Devel subdirectory. This is not necessarily up-to-date, but it
52has some information on SWIG internals.
54Documentation is also online at http://www.swig.org/doc.html.
58The developers strive their best to preserve backwards compatibility
59between releases, but this is not always possible as the overriding
60aim is to provide the best wrapping experience. Where backwards
61compatibility is known to be broken, it is clearly marked as an
62incompatibility in the CHANGES and CHANGES.current files.
64See the documentation for details of the SWIG_VERSION preprocessor
65symbol if you have backward compatibility issues and need to use more
66than one version of SWIG.
70Please read the Doc/Manual/Preface.html#Preface_installation for
71full installation instructions for Windows, Unix and Mac OS X.
72The INSTALL file has generic build and installation instructions for
77The typical 'make -k check' can be performed on Unix operating systems.
78Please read Doc/Manual/Preface.html#Preface_testing for details.
82The Examples directory contains a variety of examples of using SWIG
83and it has some browsable documentation. Simply point your browser to
84the file "Example/index.html".
86The Examples directory also includes Visual C++ project 6 (.dsp) files for
87building some of the examples on Windows. Later versions of Visual Studio
88will convert these old style project files into a current solution file.
92There are minor known bugs, details of which are in the bug tracker, see
97In order to operate correctly, SWIG relies upon a set of library
98files. If after building SWIG, you get error messages like this,
100 $ swig foo.i
101 :1. Unable to find 'swig.swg'
102 :3. Unable to find 'tcl8.swg'
104it means that SWIG has either been incorrectly configured or
105installed. To fix this:
107 1. Make sure you remembered to do a 'make install' and that
108 the installation actually worked. Make sure you have
109 write permission on the install directory.
111 2. If that doesn't work, type 'swig -swiglib' to find out
112 where SWIG thinks its library is located.
114 3. If the location is not where you expect, perhaps
115 you supplied a bad option to configure. Use
116 ./configure --prefix=pathname to set the SWIG install
117 location. Also, make sure you don't include a shell
118 escape character such as ~ when you specify the path.
120 4. The SWIG library can be changed by setting the SWIG_LIB
121 environment variable. However, you really shouldn't
122 have to do this.
124If you are having other troubles, you might look at the SWIG Wiki at
129Please report any errors and submit patches (if possible)! We only
130have access to a limited variety of hardware (Linux, Solaris, OS-X,
131and Windows). All contributions help.
133If you would like to join the SWIG development team or contribute a
134language module to the distribution, please contact the swig-devel
135mailing list, details at http://www.swig.org/mail.html.
138 -- The SWIG Maintainers