SWIG is a software development tool that connects programs written in C and C++ with a variety of high-level programming languages. http://www.swig.org
Find a file
William S Fulton 98237e2b81 Merge branch 'javascript'
* javascript: (342 commits)
  Revert "Remove unnecessary Javascript installs on Travis"
  Remove unnecessary Javascript installs on Travis
  Javascript cosmetic changes
  Javascript: ensure banner appears before %begin code
  Enable Javascript in director_nspace_director_name_collision.i.
  Make javascript 'nspace' conform to corresponding lua example.
  Added some documentation on using 'node-webkit'.
  Enable javascript examples 'exception', 'namespace'.
  Fix bug and regression in javascript namespace generator.
  Prettify generated output in JS emitters.
  Fix node-gyp configuration for example 'exception'.
  Fix regression of 226da4.
  Print error when specified multiple js engines.
  Removed obsolete 'node.i'.
  Added a comment about V8_VERSION macro.
  Restore missing copyright info in javascript branch
  beautify javascript.cxx
  Javascript variable naming convention corrections
  Javascript test-suite - warning suppression not needed
  Javascript example Makefiles more consistent with other languages
  Cosmetic code changes in javascript.cxx
  Fix regression in Javascript generator for enums.
  Fix configuration for Javascript/node ctests.
  SKIP_JAVASCRIPT only when there is none of v8/node/jsc.
  Fix generator for Javascript enums.
  Turn on Swig_cparse_cplusplusout for Javascript/v8.
  Fix configuration for ctest with Javascript/v8.
  Add cast to test 'string_simple' to avoid C++ compiler error.
  Add 'fix' for Javascript/v8 to test 'enum_forward'.
  Only disable javascript tests if node-gyp is missing when testing node
  Revert "Javascript node test-suite makefile fixes for parallel make"
  Suppress keyword warning in test-suite
  Restore and fix infinity testcase for Javascript
  Simple C string test
  Javascript node test-suite makefile fixes for parallel make
  Restore missing make code in javascript branch
  Javascript test-suite makefile update
  ADD RUNPIPE and RUNTOOL to Javascript examples
  Remove unnecessary blank lines from Javascript examples
  Detect node-gyp at configure time and show version in javascript_version target
  Fix typo in Javascript exception
  Revert css style changes in javascript branch
  Add missing license info
  Javascript html documentation tidy up
  Improve missing JS engine error message
  a few Javascript clarifications in configure.ac
  Makefile and autoconf file tidy up for Javascript
  Tidy up Example makefile for Javascript
  Alphabetical order for Javascript in -help output
  Remove junk files
  Travis file code consistency
  Turn on Travis testing on javascript branch
  Add javascript to Sections.html
  Optimized travis before_install for Javascript.
  Document Javascript related preprocessor macros.
  Updated Javascript documentation.
  Insert a workaround for c_delete and c_delete_function for v8.
  Update Javascript.html.
  Remove inadvertently added xcode file.
  Remove gdb pretty printing.
  Remove cmake relict.
  Remove pandoc toolchain.
  Remove Javascript documentation source file.
  Revert "Development version for travis configuration."
  Fix travis configuration.
  Fix regression in custom v8 interpreter.
  Development version for travis configuration.
  Generalized smoke test configuration.
  Add 'version' target for javascript.
  Merged branch 'devel' from https://github.com/oliver----/swig-v8 (squashed commit):
  Add check to skip javascript test-suite if default interpreter is not installed.
  Activate travis matrix for different Javascript interpreters.
  Beautified Javascript module.
  Fix regressions.
  Removed obsolete paragraph from Javascript documentation.
  Fix pandoc filter.
  Minor tweaks in Javascript documentation.
  Adding a chapter about Javascript tests and examples.
  Minor change in Javascript configuration.
  Fix issues that were observed with newer JavascriptCore.
  Add missing copy ctor for Javascript Code Template class.
  Removed CMake.
  Fix regression in Javascript configuration.
  Fix regressions in configuration of some Javascript examples.
  More gitignores filtering Javascript related files.
  Fix custom javascript interpreter configuration for OSX.
  Make examples work with node.js and the custom interpreter.
  Introduced an extra Makefile for the custom javascript interpreter.
  Fix travis configuration.
  Added a comment.
  Fix regressions in Javascript example configuration.
  Fix issue with strange constants under OSX.
  Some fixes in example section of Javascript documentation.
  Add note about '-node' command line flag for Node.js code generation.
  Added examples to Javascript module documentation.
  Simplification in common javascript example Makefile.
  Add an extra argument for enabling nodejs support.
  Add more notes about how to install node.
  Better error message when no Javascript emitter is specified.
  Deactivated broken JS examples.
  Refactored configuration for javascript examples.
  Beginning to document v8 integration.
  Documented extending Node.js and Webkit's Javascript engine.
  Pandoc filter detects shell blocks when not explicitely given.
  Conitnued documenting the Javascript module.
  Not a real change.
  Add a pandoc filter to create compatible html.
  Add Javascript to chapters.
  More Javascript module documentation.
  Next iteration on creating a documentation for the Javascript module.
  Next iteration on creating a documentation for the Javascript module.
  Travis configuration for Javascript branch.
  Javascript examples.
  Javascript documentation.
  CMake configuration.
  Fix regression.
  Fix test configuration.
  Trying to install former working version of nodejs.
  Fix test configuration for nodejs.
  Add stub std_deque.i files.
  Add non pretty printing function to Templates.
  Fix bug with typedefd function pointers.
  Add some test runners.
  Fix emitter for member pointer constants.
  Fix %nspace support and activated relevant tests.
  Disable warnings for some v8 test-cases.
  Fix regression.
  Bugfix in argument marshalling.
  Disable testcase 'typemap_variables' for v8.
  Bugfix for Javascript generator.
  Replace $symname in generated function wrappers.
  Add missing macros.
  Let v8 generated code include stdlib.h
  Add cdata.i typemaps.
  Rearrange generation of init block to have custom init code within the initializer body.
  Make JSC inheritance definition more robust.
  Removed dead code.
  Bugfix for JSC %typemap(out) std::string&.
  Fix typemap declarations for (unsigned) long long.
  Add support for IN/OUTPUT typemaps.
  removed Clear before Dispose from newer v8 code, consider the following code: template <class T> void Persistent<T>::Dispose() {   if (this->IsEmpty()) return; //Clear will trigger this   V8::DisposeGlobal(reinterpret_cast<internal::Object**>(this->val_));   ... }
  fixed newer v8 compilation
  Add stub 'typemaps.i' files.
  Bugfix Javascript generator: valid name for dispatcher functions.
  Fix Javascript generator for smartpointeraccessed variables.
  Bugfix for Javascript generator: avoid duplicate action code generation.
  Bugfix in Javascript generator: detect member setter/getters correctly.
  Fix configuration for nodejs based tests.
  Some fixes and cleanup in Javascript generator.
  Fix settings for building nodejs tests.
  Add support for PackedData to Javascript generator.
  Added two more Javascript tests.
  Some fixes for the Javascript generator.
  Redefined set of Javascript smoke tests.
  Clean up in `javascripttypemaps.swg`.
  Fix v8 generator to use a non clashing name for built-in 'equals' method.
  Fix Javascript generator to use %renamed variable names.
  Activate Javascript test-cases `rename_simple` and `rename_scope`.
  Activate Javascript testcases `rename1-4`.
  Add `infinity` test-case to list of smoke tests.
  Added unit test using C99 INFINITY. This test actually tests a float conversion bug where converting to float imposed overflow checking which should not be there and causes this program to error out. This was seen originally in Javascript, but it turns out Python has the same bug. Lua does not have this bug. Other generators have not been tested.
  Bug-fix for static variables as proposed by Kota Iguchi.
  Let Travis test all three targets.
  Allow to run the test suite with our list of smoke tests.
  Javascript V8 test-cases always create cpp wrappers.
  Test-suite Makefile now supports testing for all three Javascript variants.
  Rewritten Javascript autoconfiguration.
  Renamed object provided to JS initializers.
  Refactored custom javascript engines to support primitive 'require' statements.
  fixed deprecation warnings for v8-3.21
  moved common swig v8 definitions in javascriptruntime.swg, fixed obsoleted api calls
  Added missing template configuration files for nodejs based tests.
  Put the SWIG_V8_VERSION macro into "runtime" block.
  Use a diffent name for the V8_VERSION provided via command line.
  fixed return values and added missing newer v8 dtor wrapper.
  Allow exceptions in generated example/test node extensions.
  Fix cleanup configuration for javascript test-suite.
  Relax type check in SWIG_AsVal_int.
  Fixing travis configuration.
  Remove javascript autoconf detection (Temporarily).
  Fix in travis config.
  Not a real change.
  Slight modification to travis config.
  Add a travis configuration (experimental).
  Make javascript test-suite work with nodejs.
  Replace old style v8 version switches.
  Fix error in SWIG_V8_GetInstancePtr.
  Add "equals" to compare between pointers Add "getCPtr" to retrieve pointer value
  Typemap for natural support for arrays
  Added the finalize callback (JSObjectFinalizeCallback)
  Fix regression.
  Convert javascript examples to nodejs.
  Ignore javascript Example build files.
  First example that addresses node.js as primary execution environment.
  Better v8 version handling.
  Add a dedicated mode for creating node modules.
  Starting from scratch with Examples configuration.
  ported to newer, more efficient v8 api
  Patch to support argout typemap for your swig-v8 branch.
  Since this code uses assert, #include <assert.h> is needed.
  ...
2014-05-01 20:08:20 +01:00
CCache Remove mkstemp replacement for ccache-swig on Cygwin 2013-09-14 15:51:50 -07:00
debian Remove cvsignore files: this is stored on svn:igonre property now 2006-12-03 08:28:42 +00:00
Doc Merge branch 'master' into javascript 2014-05-01 19:01:20 +01:00
Examples Merge branch 'master' into javascript 2014-05-01 19:01:20 +01:00
Lib Merge branch 'master' into javascript 2014-05-01 19:01:20 +01:00
Source Javascript cosmetic changes 2014-05-01 19:41:17 +01:00
Tools Makefile and autoconf file tidy up for Javascript 2014-04-16 07:38:52 +01:00
vms file changed 2002-12-11 22:43:46 +00:00
Win The great merge 2002-11-30 22:01:28 +00:00
.gitattributes Add .gitattributes file 2013-05-12 19:14:59 +01:00
.gitignore Merge branch 'master' into javascript 2014-05-01 19:01:20 +01:00
.travis.yml Revert "Remove unnecessary Javascript installs on Travis" 2014-05-01 20:05:16 +01:00
ANNOUNCE Bump version to 3.0.1 2014-03-17 06:54:00 +00:00
autogen.sh update some comments 2008-11-07 21:25:31 +00:00
CHANGES Fix typos 2014-04-29 11:31:29 +12:00
CHANGES.current [PHP] The generated __isset() method now returns true for read-only properties. 2014-05-01 14:37:58 +12:00
configure.ac Merge branch 'master' into javascript 2014-05-01 19:01:20 +01:00
COPYRIGHT Restore missing copyright info in javascript branch 2014-04-25 07:57:32 +01:00
INSTALL The great merge 2002-11-30 22:01:28 +00:00
LICENSE SWIG license change - Licenses put in place and bump version to 2.0.0 - Source moves to GPLv3. The Examples and Lib move to a very permissive license, removing the BSD license restrictions as agreed by committers since it was inadvertently introduced. 2010-02-27 23:04:21 +00:00
LICENSE-GPL SWIG license change - Licenses put in place and bump version to 2.0.0 - Source moves to GPLv3. The Examples and Lib move to a very permissive license, removing the BSD license restrictions as agreed by committers since it was inadvertently introduced. 2010-02-27 23:04:21 +00:00
LICENSE-UNIVERSITIES Fix grammatical error introduced by previous fix. 2010-06-21 03:37:08 +00:00
Makefile.in Merge branch 'master' into tmp 2014-03-05 01:09:26 +01:00
preinst-swig.in Quote $builddir and @srcdir@ to protect from the shell. 2008-05-10 10:30:31 +00:00
README Bump version to 3.0.1 2014-03-17 06:54:00 +00:00
RELEASENOTES Add release note summary 2014-03-16 21:11:03 +00:00
swig.spec.in Replace references to Subversion with Git 2013-01-12 01:24:22 +00:00
TODO PHP directors now done. WAD has been removed. 2011-06-03 13:49:18 +00:00

SWIG (Simplified Wrapper and Interface Generator)

Version: 3.0.1 (in progress)

Tagline: SWIG is a compiler that integrates C and C++ with languages
         including Perl, Python, Tcl, Ruby, PHP, Java, C#, D, Go, Lua,
         Octave, R, Scheme (Guile, MzScheme/Racket, CHICKEN), Ocaml,
         Modula-3, Common Lisp (CLISP, Allegro CL, CFFI, UFFI) and Pike.
         SWIG can also export its parse tree into Lisp s-expressions and
         XML.

SWIG reads annotated C/C++ header files and creates wrapper code (glue
code) in order to make the corresponding C/C++ libraries available to
the listed languages, or to extend C/C++ programs with a scripting
language.

Up-to-date SWIG related information can be found at

        http://www.swig.org

A SWIG FAQ and other hints can be found on the SWIG Wiki:

        http://www.dabeaz.com/cgi-bin/wiki.pl

License
=======
Please see the LICENSE file for details of the SWIG license. For
further insight into the license including the license of SWIG's
output code, please visit

        http://www.swig.org/legal.html

Release Notes
=============
Please see the CHANGES.current file for a detailed list of bug fixes and
new features for the current release. The CHANGES file contains bug fixes
and new features for older versions. A summary of changes in each release
can be found in the RELEASENOTES file.

Documentation
=============
The Doc/Manual directory contains the most recent set of updated
documentation for this release. The documentation is available in
three different formats, each of which contains identical content.
These format are, pdf (Doc/Manual/SWIGDocumentation.pdf), single
page html (Doc/Manual/SWIGDocumentation.html) or multiple page html
(other files in Doc/Manual). Please select your chosen format and
copy/install to wherever takes your fancy.

There is some technical developer documentation available in the
Doc/Devel subdirectory.  This is not necessarily up-to-date, but it
has some information on SWIG internals.

Documentation is also online at http://www.swig.org/doc.html.

Backwards Compatibility
=======================
The developers strive their best to preserve backwards compatibility
between releases, but this is not always possible as the overriding
aim is to provide the best wrapping experience. Where backwards
compatibility is known to be broken, it is clearly marked as an
incompatibility in the CHANGES and CHANGES.current files.

See the documentation for details of the SWIG_VERSION preprocessor
symbol if you have backward compatibility issues and need to use more
than one version of SWIG.

Installation
============
Please read the Doc/Manual/Preface.html#Preface_installation for
full installation instructions for Windows, Unix and Mac OS X.
The INSTALL file has generic build and installation instructions for
Unix users.

Testing
=======
The typical 'make -k check' can be performed on Unix operating systems.
Please read Doc/Manual/Preface.html#Preface_testing for details.

Examples
========
The Examples directory contains a variety of examples of using SWIG
and it has some browsable documentation.  Simply point your browser to
the file "Example/index.html".

The Examples directory also includes Visual C++ project 6 (.dsp) files for
building some of the examples on Windows. Later versions of Visual Studio
will convert these old style project files into a current solution file.

Known Issues
============
There are minor known bugs, details of which are in the bug tracker, see
http://www.swig.org/bugs.html.

Troubleshooting
===============
In order to operate correctly, SWIG relies upon a set of library
files.  If after building SWIG, you get error messages like this,

    $ swig foo.i
    :1. Unable to find 'swig.swg'
    :3. Unable to find 'tcl8.swg'

it means that SWIG has either been incorrectly configured or
installed.  To fix this:

    1.  Make sure you remembered to do a 'make install' and that
        the installation actually worked.  Make sure you have
        write permission on the install directory.

    2.  If that doesn't work, type 'swig -swiglib' to find out
        where SWIG thinks its library is located.

    3.  If the location is not where you expect, perhaps
        you supplied a bad option to configure.  Use
        ./configure --prefix=pathname to set the SWIG install
        location.   Also, make sure you don't include a shell
        escape character such as ~ when you specify the path.

    4.  The SWIG library can be changed by setting the SWIG_LIB
        environment variable.  However, you really shouldn't
        have to do this.

If you are having other troubles, you might look at the SWIG Wiki at
http://www.dabeaz.com/cgi-bin/wiki.pl.

Participate!
============
Please report any errors and submit patches (if possible)!  We only
have access to a limited variety of hardware (Linux, Solaris, OS-X,
and Windows). All contributions help.

If you would like to join the SWIG development team or contribute a
language module to the distribution, please contact the swig-devel
mailing list, details at http://www.swig.org/mail.html.


 -- The SWIG Maintainers