diff options
Diffstat (limited to 'Doc/Manual')
| -rw-r--r-- | Doc/Manual/Extending.html | 10 | ||||
| -rw-r--r-- | Doc/Manual/Go.html | 6 | ||||
| -rw-r--r-- | Doc/Manual/Javascript.html | 808 | ||||
| -rw-r--r-- | Doc/Manual/Lua.html | 28 | ||||
| -rw-r--r-- | Doc/Manual/Preprocessor.html | 3 | ||||
| -rw-r--r-- | Doc/Manual/Ruby.html | 2 | ||||
| -rw-r--r-- | Doc/Manual/Sections.html | 1 | ||||
| -rw-r--r-- | Doc/Manual/chapters | 1 |
8 files changed, 845 insertions, 14 deletions
diff --git a/Doc/Manual/Extending.html b/Doc/Manual/Extending.html index 5cd89a280..5c209bbb5 100644 --- a/Doc/Manual/Extending.html +++ b/Doc/Manual/Extending.html @@ -1500,12 +1500,11 @@ Create a File object wrapper around an existing <tt>FILE *</tt> object. </div> <p> -<b><tt>int Close(String_or_FILE *f)</tt></b> +There's no explicit function to close a file, just call <tt>Delete(f)</tt> - +this decreases the reference count, and the file will be closed when the +reference count reaches zero. </p> -<div class="indent"> -<p>Closes a file. Has no effect on strings.</p> - <p> The use of the above I/O functions and strings play a critical role in SWIG. It is common to see small code fragments of code generated using code like this: @@ -1529,8 +1528,6 @@ Printf(f, "%s\n", s); Similarly, the preprocessor and parser all operate on string-files. </p> -</div> - <H2><a name="Extending_nn21"></a>39.6 Navigating and manipulating parse trees</H2> @@ -2832,7 +2829,6 @@ int Python::top(Node *n) { Delete(f_header); Delete(f_wrappers); Delete(f_init); - Close(f_begin); Delete(f_begin); return SWIG_OK; diff --git a/Doc/Manual/Go.html b/Doc/Manual/Go.html index f970b02e8..93b87a4a4 100644 --- a/Doc/Manual/Go.html +++ b/Doc/Manual/Go.html @@ -94,9 +94,9 @@ swig -go -help </tr> <tr> -<td>-intgo-type-size %lt;s%gt;</td> +<td>-intgosize <s></td> <td>Set the size for the Go type <tt>int</tt>. This controls the size - that the C/C++ code expects to see. The %lt;s%gt; argument should + that the C/C++ code expects to see. The <s> argument should be 32 or 64. This option is currently required during the transition from Go 1.0 to Go 1.1, as the size of <tt>int</tt> on 64-bit x86 systems changes between those releases (from 32 bits to @@ -125,7 +125,7 @@ swig -go -help </tr> <tr> -<td>-soname %lt;name%gt;</td> +<td>-soname <name></td> <td>Set the runtime name of the shared library that the dynamic linker should include at runtime. The default is the package name with ".so" appended. This is only used when generating code for diff --git a/Doc/Manual/Javascript.html b/Doc/Manual/Javascript.html new file mode 100644 index 000000000..e589d9d09 --- /dev/null +++ b/Doc/Manual/Javascript.html @@ -0,0 +1,808 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + <link rel="stylesheet" type="text/css" href="./style.css"> + <title></title> +</head> +<body> + +<H1>SWIG and Javascript</H1> +<p>This chapter describes SWIG's support of Javascript. It does not cover SWIG basics, but only information that is specific to this module.</p> + +<H2>Overview</H2> +<p>Javascript is a prototype-based scripting language that is dynamic, weakly typed and has first-class functions. Its arguably the most popular language for web development. +Javascript has gone beyond being a browser-based scripting language and with <a href="http://nodejs.org">node.js</a>, it is also used as a backend development language.</p> +<p>Native Javascript extensions can be used for applications that embed a web-browser view or that embed a Javascript engine (such as <em>node.js</em>). Extending a general purpose web-browser is not possible as this would be a severe security issue.</p> +<p>SWIG Javascript currently supports <strong>JavascriptCore</strong>, the Javascript engine used by <code>Safari/Webkit</code>, and <strong>v8</strong>, which is used by <code>Chromium</code> and <code>node.js</code>.</p> +<p><a href="http://www.webkit.org/">WebKit</a> is a modern browser implementation available as open-source which can be embedded into an application. +With <a href="https://github.com/rogerwang/node-webkit">node-webkit</a> there is a platform which uses Google's <code>Chromium</code> as Web-Browser widget and <code>node.js</code> for javascript extensions. +</p> + +<H2>Preliminaries</H2> + +<H3>Running SWIG</H3> + +<p>Suppose that you defined a SWIG module such as the following:</p> +<div class="code"> +<pre> +%module example +%{ +#include "example.h" +%} +int gcd(int x, int y); +extern double Foo;</pre> +</div> +<p>To build a Javascript module, run SWIG using the <code>-javascript</code> option and a desired target engine <code>-jsc</code>, <code>-v8</code>, or <code>-node</code>. The generator for <code>node</code> is essentially delegating to the <code>v8</code> generator and adds some necessary preprocessor definitions.</p> +<div class="shell"> +<pre> +$ swig -javascript -jsc example.i</pre> +</div> +<p>If building a C++ extension, add the -c++ option:</p> +<div class="shell"> +<pre> +$ swig -c++ -javascript -jsc example.i</pre> +</div> +<p>This creates a C/C++ source file <code>example_wrap.c</code> or <code>example_wrap.cxx</code>. The generated C source file contains the low-level wrappers that need to be compiled and linked with the rest of your C/C++ application to create an extension module.</p> +<p>The name of the wrapper file is derived from the name of the input file. For example, if the input file is <code>example.i</code>, the name of the wrapper file is <code>example_wrap.c</code>. To change this, you can use the -o option. The wrapped module will export one function which must be called to register the module with the Javascript interpreter. For example, if your module is named <code>example</code> the corresponding initializer for JavascriptCore would be</p> +<div class="code"> +<pre> +bool example_initialize(JSGlobalContextRef context, JSObjectRef *exports)</pre> +</div> +<p>and for v8:</p> +<div class="code"> +<pre> +void example_initialize(v8::Handle<v8::Object> exports)</pre> +</div> +<p> +<p><b>Note</b>: be aware that <code>v8</code> has a C++ API, and thus, the generated modules must be compiled as C++.</p> +</p> + +<H3>Running Tests and Examples</H3> +<p>The configuration for tests and examples currently supports Linux and Mac only and not MinGW (Windows) yet.</p> +<p>The default interpreter is <code>node.js</code> as it is available on all platforms and convenient to use.</p> +<p>Running the examples with JavascriptCore requires <code>libjavascriptcoregtk-1.0</code> to be installed, e.g., under Ubuntu with</p> +<div class="shell"> +<pre> +$ sudo apt-get install libjavascriptcoregtk-1.0-dev</pre> +</div> +<p>Running with <code>V8</code> requires <code>libv8</code>:</p> +<div class="shell"> +<pre> +$ sudo apt-get install libv8-dev</pre> +</div> +<p>Examples can be run using</p> +<div class="shell"> +<pre> +$ make check-javascript-examples ENGINE=jsc</pre> +</div> +<p><code>ENGINE</code> can be <code>node</code>, <code>jsc</code>, or <code>v8</code>.</p> +<p>The test-suite can be run using</p> +<div class="shell"> +<pre> +$ make check-javascript-test-suite ENGINE=jsc</pre> +</div> +<p>Tests should run without any problems, i.e., have been tried out, on the following platforms/interpreters:</p> +<div class="code"> +<pre> +- Ubuntu Precise 12.04 64bit + - JavascriptCore (Webkit 1.8.3) + - Node.js (0.10.26) + - v8 (3.7.12) +- Ubuntu Saucy 13.10 64bit + - JavascriptCore (Webkit 1.10.2) + - Node.js + - v8 (3.14.5) +- Mac OSX Mountain Lion 10.8 + - JavascriptCore (built-in) + - Node.js +- Windows 7 64bit (VS 2010) + - Node.js</pre> +</div> +<p> + +<H3>Future work</H3> +<p>The Javascript module is not yet as mature as other modules and some things are still missing. As it makes use of SWIG's Unified Typemap Library (UTL), many typemaps are inherited. We could work on that if requested:</p> +<ul> +<li><p>More typemaps: compared to other modules there are only a few typemaps implemented. For instance a lot of the <code>std_*.i</code> typemaps are missing, such as <code>std_iostream</code>, for instance.</p></li> +<li><p>Director support: this would allow to extend a C++ abstract base class in Javascript. A pragmatic intermediate step for the most important usecase would be to support Javascript callbacks as arguments.</p></li> +</ul> + +<H2>Integration</H2> +<p>This chapter gives a short introduction how to use a native Javascript extension: as a <code>node.js</code> module, and as an extension for an embedded Webkit.</p> + +<H3>Creating <code>node.js</code> Extensions</H3> +<p>To install <code>node.js</code> you can download an installer from their <a href="https://launchpad.net/~chris-lea/+archive/node.js">web-site</a> for OSX and Windows. For Linux you can either build the source yourself and run <code>sudo checkinstall</code> or keep to the (probably stone-age) packaged version. For Ubuntu there is a <a href="https://launchpad.net/~chris-lea/+archive/node.js/">PPA</a> available.</p> +<div class="shell"> +<pre> +$ sudo add-apt-repository ppa:chris-lea/node.js +$ sudo apt-get update +$ sudo apt-get install nodejs</pre> +</div> +<p>As <code>v8</code> is written in C++ and comes as a C++ library it is crucial to compile your module using the same compiler flags as used for building v8. To make things easier, <code>node.js</code> provides a build tool called <code>node-gyp</code>.</p> +<p>You have to install it using <code>npm</code>:</p> +<div class="shell"> +<pre> +$ sudo npm install -g node-gyp</pre> +</div> +<p><code>node-gyp</code> expects a configuration file named <code>binding.gyp</code> which is basically in JSON format and conforms to the same format that is used with Google's build-tool <code>gyp</code>.</p> +<p><code>binding.gyp</code>:</p> +<div class="code"> +<pre> +{ + "targets": [ + { + "target_name": "example", + "sources": [ "example.cxx", "example_wrap.cxx" ] + } + ] +}</pre> +</div> +<p>First create the wrapper using SWIG:</p> +<div class="shell"> +<pre> +$ swig -javascript -node -c++ example.cxx</pre> +</div> +<p>Then run <code>node-gyp</code></p> +<div class="shell"> +<pre> +$ node-gyp</pre> +</div> +<p>This will create a <code>build</code> folder containing the native module. To use the extension you need to 'require' it in your Javascript source file:</p> +<div class="code"> +<pre> +require("./build/Release/example")</pre> +</div> +<p>A more detailed explanation is given in the <a href="#Javascript_examples">Examples</a> section.</p> + +<H4>Troubleshooting</H4> +<ul> +<li><em>'module' object has no attribute 'script_main'</em></li> +</ul> +<p>This error happens when <code>gyp</code> is installed as a distribution package. It seems to be outdated. Removing it resolves the problem.</p> +<div class="shell"> +<pre> +$ sudo apt-get remove gyp</pre> +</div> + +<H3>Embedded Webkit</H3> +<p>Webkit is pre-installed on OSX and available as a library for GTK.</p> + +<H4>OSX</H4> +<p>There is general information about programming with WebKit on <a href="https://developer.apple.com/library/mac/documentation/cocoa/conceptual/DisplayWebContent/DisplayWebContent.html">Apple Developer Documentation</a>. Details about <code>Cocoa</code> programming are not covered here.</p> +<p>An integration of a native extension 'example' would look like this:</p> +<div class="code"> +<pre> +#import "appDelegate.h" + +extern bool example_initialize(JSGlobalContextRef context); + + +@implementation ExampleAppDelegate + +@synthesize webView; + + +- (void)applicationDidFinishLaunching:(NSNotification *)aNotification { + + // Start a webview with the bundled index.html file + NSString *path = [[NSBundle mainBundle] bundlePath]; + NSString *url = [NSString stringWithFormat: @"file://%@/Contents/Assets/index.html", path]; + + WebFrame *webframe = [webView mainFrame]; + JSGlobalContextRef context = [webframe globalContext]; + + example_initialize(context); + + [ [webView mainFrame] loadRequest: + [NSURLRequest requestWithURL: [NSURL URLWithString:url] ] + ]; +} + +@end</pre> +</div> + +<H4>GTK</H4> +<p>There is general information about programming GTK at <a href="https://developer.gnome.org/gtk2/">GTK documentation</a> and in the <a href="https://developer.gnome.org/gtk-tutorial">GTK tutorial</a>, and for Webkit there is a <a href="http://webkitgtk.org/reference/webkitgtk/stable/index.html">Webkit GTK+ API Reference</a>.</p> +<p>An integration of a native extension 'example' would look like this:</p> +<div class="code"> +<pre> +#include <gtk/gtk.h> +#include <webkit/webkit.h> + +extern bool example_initialize(JSGlobalContextRef context); + +int main(int argc, char* argv[]) +{ + // Initialize GTK+ + gtk_init(&argc, &argv); + + ... + + // Create a browser instance + WebKitWebView *webView = WEBKIT_WEB_VIEW(webkit_web_view_new()); + WebFrame *webframe = webkit_web_view_get_main_frame(webView); + JSGlobalContextRef context = webkit_web_frame_get_global_context(webFrame); + example_initialize(context); + + ... + + // Load a web page into the browser instance + webkit_web_view_load_uri(webView, "http://www.webkitgtk.org/"); + + ... + + // Run the main GTK+ event loop + gtk_main(); + + return 0; +}</pre> +</div> + +<H3>Creating Applications with <code>node-webkit</code></H3> +<p> +<p>To get started with <code>node-webkit</code> there is a very informative set of <a href="https://github.com/rogerwang/node-webkit/wiki">wiki pages</a>.</p> +<p>Similar to <code>node.js</code>, <code>node-webkit</code> is started from command line within a <code>node.js</code> project directory. +Native extensions are created in the very same way as for <code>node.js</code>, except that a customized <code>gyp</code> derivate has to be used: <a href="https://github.com/rogerwang/nw-gyp">nw-gyp</a>. +</p> + +<p> +A simple example would have the following structure: +</p> + +<div class="code"> +<pre> +- package.json +- app.html +- app.js +- node_modules + / example + ... (as known from node.js) +</pre> +</div> + +<p> +The configuration file essentially conforms to <code>node.js</code> syntax. +It has some extras to configure <code>node-webkit</code>. See the <a href="">Manifest</a> specification for more details. +</p> + +<p> + <code>package.json</code>: +</p> +<div class="code"> +<pre> +{ + "name": "example" + "main": "app.html" + "window": { + "show": true, + "width": 800, + "height": 600 + } +}</pre> +</div> + +<p> +The <code>'main'</code> property of <code>package.json</code> specifies a web-page to be rendered in +the main window.</p> + +<p> + <code>app.html</code>: +</p> + +<div class="code"> +<pre> +<html> + <head> + <script src="app.js"></script> + </head> + <body> + <div> + The greatest common divisor of + <span id="x"></span> and + <span id="y"></span> is + <span id="z"></span>. + </div> + </body> +</html></pre> +</div> + +<p> +As known from <code>node.js</code> one can use <code>require</code> to load javascript modules. +Additionally, <code>node-webkit</code> provides an API that allows to manipulate the window's menu, +open new windows, and many more things. +</p> + +<p> + <code>app.js</code>: +</p> + +<div class="code"> +<pre>window.onload = function() { + var example = require("example"); + var x = 18; + var y = 24; + var z = example.gcd(x,y); + document.querySelector('#x').innerHTML = x; + document.querySelector('#y').innerHTML = y; + document.querySelector('#z').innerHTML = z; +};</pre> +</div> + +<H2><a name="Javascript_examples">Examples</H2> +<p>Some basic examples are shown here in more detail.</p> + +<H3>Simple</H3> +<p>The common example <code>simple</code> looks like this:</p> +<div class="code"> +<pre> +/* File : example.i */ +%module example + +%inline %{ +extern int gcd(int x, int y); +extern double Foo; +%}</pre> +</div> +<p>To make this available as a node extension a <code>binding.gyp</code> has to be created:</p> +<div class="code"> +<pre> +{ + "targets": [ + { + "target_name": "example", + "sources": [ "example.cxx", "example_wrap.cxx" ] + } + ] +}</pre> +</div> +<p>Then <code>node-gyp</code> is used to build the extension:</p> +<div class="shell"> +<pre> +$ node-gyp configure build</pre> +</div> +<p>From a 'nodejs` application the extension would be used like this:</p> +<div class="code"> +<pre> +// import the extension via require +var example = require("./build/Release/example"); + +// calling the global method +var x = 42; +var y = 105; +var g = example.gcd(x,y); + +// Accessing the globak variable +var f = example.Foo; +example.Foo = 3.1415926;</pre> +</div> +<p>First the module <code>example</code> is loaded from the previously built extension. Global methods and variables are available in the scope of the module.</p> +<p> +<p><b>Note</b>: ECMAScript 5, the currently implemented Javascript standard, does not have modules. <code>node.js</code> and other implementations provide this mechanism defined by the <a href="http://wiki.commonjs.org/wiki/CommonJS">CommonJS</a> group. For browsers this is provided by <a href="http://browserify.org">Browserify</a>, for instance.</p> +</p> + +<H3>Class</H3> +<p>The common example <code>class</code> defines three classes, <code>Shape</code>, <code>Circle</code>, and <code>Square</code>:</p> +<div class="code"> +<pre> +class Shape { +public: + Shape() { + nshapes++; + } + virtual ~Shape() { + nshapes--; + }; + double x, y; + void move(double dx, double dy); + virtual double area(void) = 0; + virtual double perimeter(void) = 0; + static int nshapes; +}; + +class Circle : public Shape { +private: + double radius; +public: + Circle(double r) : radius(r) { }; + virtual double area(void); + virtual double perimeter(void); +}; + +class Square : public Shape { +private: + double width; +public: + Square(double w) : width(w) { }; + virtual double area(void); + virtual double perimeter(void); +};</pre> +</div> +<p><code>Circle</code> and <code>Square</code> inherit from <code>Shape</code>. <code>Shape</code> has a static variable <code>nshapes</code>, a function <code>move</code> that can't be overridden (non-virtual), and two abstract functions <code>area</code> and <code>perimeter</code> (pure virtual) that must be overridden by the sub-classes.</p> +<p>A <code>nodejs</code> extension is built the same way as for the <code>simple</code> example.</p> +<p>In Javascript it can be used as follows:</p> +<div class="code"> +<pre> +var example = require("./build/Release/example"); + +// local aliases for convenience +var Shape = example.Shape; +var Circle = example.Circle; +var Square = example.Square; + +// creating new instances using the 'new' operator +var c = new Circle(10); +var s = new Square(10); + +// accessing a static member +Shape.nshapes; + +// accessing member variables +c.x = 20; +c.y = 30; +s.x = -10; +s.y = 5; + +// calling some methods +c.area(); +c.perimeter(); +s.area(); +s.perimeter(); + +// instantiation of Shape is not permitted +new Shape();</pre> +</div> +<p>Running these commands in an interactive node shell results in the following output:</p> +<div class="shell"> +<pre> +$ node -i +> var example = require("./build/Release/example"); +undefined +> var Shape = example.Shape; +undefined +> var Circle = example.Circle; +undefined +> var Square = example.Square; +undefined +> var c = new Circle(10); +undefined +> var s = new Square(10); +undefined +> Shape.nshapes; +2 +> c.x = 20; +20 +> c.y = 30; +30 +> s.x = -10; +-10 +> s.y = 5; +5 +> c.area(); +314.1592653589793 +> c.perimeter(); +62.83185307179586 +> s.area(); +100 +> s.perimeter(); +40 +> c.move(40, 40) +undefined +> c.x +60 +> c.y +70 +> new Shape() +Error: Class Shape can not be instantiated +at repl:1:2 +at REPLServer.self.eval (repl.js:110:21) +at Interface.<anonymous> (repl.js:239:12) +at Interface.EventEmitter.emit (events.js:95:17) +at Interface._onLine (readline.js:202:10) +at Interface._line (readline.js:531:8) +at Interface._ttyWrite (readline.js:760:14) +at ReadStream.onkeypress (readline.js:99:10) +at ReadStream.EventEmitter.emit (events.js:98:17) +at emitKey (readline.js:1095:12)</pre> +</div> +<p> +<p><b>Note</b>: In ECMAScript 5 there is no concept for classes. Instead each function can be used as a constructor function which is executed by the 'new' operator. Furthermore, during construction the key property <code>prototype</code> of the constructor function is used to attach a prototype instance to the created object. A prototype is essentially an object itself that is the first-class delegate of a class used whenever the access to a property of an object fails. The very same prototype instance is shared among all instances of one type. Prototypal inheritance is explained in more detail on in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Inheritance_and_the_prototype_chain">Inheritance and the prototype chain</a>, for instance.</p> +</p> + +<H2>Implementation</H2> +<p>The Javascript Module implementation has taken a very different approach compared to other language modules in order to support different Javascript interpreters.</p> + +<H3>Source Code</H3> +<p>The Javascript module is implemented in <code>Source/Modules/javascript.cxx</code>. It dispatches the code generation to a <code>JSEmitter</code> instance, <code>V8Emitter</code> or <code>JSCEmitter</code>. Additionally there are some helpers: <code>Template</code>, for templated code generation, and <code>JSEmitterState</code>, which is used to manage state information during AST traversal. This rough map shall make it easier to find a way through this huge source file:</p> +<div class="code"> +<pre> +// module wide defines + +#define NAME "name" +... + +// ############################### +// # Helper class declarations + +class JSEmitterState { ... }; + +class Template { ... }; + +// ############################### +// # JSEmitter declaration + +class JSEmitter { ... }; + +// Emitter factory declarations + +JSEmitter *swig_javascript_create_JSCEmitter(); +JSEmitter *swig_javascript_create_V8Emitter(); + +// ############################### +// # Javascript module + +// Javascript module declaration + +class JAVASCRIPT:public Language { ... }; + +// Javascript module implementation + +int JAVASCRIPT::functionWrapper(Node *n) { ... } +... + +// Module factory implementation + +static Language *new_swig_javascript() { ... } + +extern "C" Language *swig_javascript(void) { ... } + +// ############################### +// # JSEmitter base implementation + +JSEmitter::JSEmitter() { ... } + +Template JSEmitter::getTemplate(const String *name) { ... } +... + +// ############################### +// # JSCEmitter + +// JSCEmitter declaration + +class JSCEmitter: public JSEmitter { ... }; + +// JSCEmitter implementation + +JSCEmitter::JSCEmitter() { ... } + +void JSCEmitter::marshalInputArgs(Node *n, ParmList *parms, Wrapper *wrapper, MarshallingMode mode, bool is_member, bool is_static) { ... } +... + +// JSCEmitter factory + +JSEmitter *swig_javascript_create_JSCEmitter() { ... } + + +// ############################### +// # V8Emitter + +// V8Emitter declaration + +class V8Emitter: public JSEmitter { ... }; + +// V8Emitter implementation + +V8Emitter::V8Emitter() { ... } + +int V8Emitter::initialize(Node *n) { ... } + +// V8Emitter factory + +JSEmitter *swig_javascript_create_V8Emitter() { ... } + + +// ############################### +// # Helper implementation (JSEmitterState, Template) + +JSEmitterState::JSEmitterState() { ... } +... + +Template::Template(const String *code_) { ... } +...</pre> +</div> + +<H3>Code Templates</H3> +<p>All generated code is created on the basis of code templates. The templates for <em>JavascriptCore</em> can be found in <code>Lib/javascript/jsc/javascriptcode.swg</code>, for <em>v8</em> in <code>Lib/javascript/v8/javascriptcode.swg</code>.</p> +<p>To track the originating code template for generated code you can run</p> +<div class="shell"> +<pre> +$ swig -javascript -jsc -debug-codetemplates</pre> +</div> +<p>which wraps generated code with a descriptive comment</p> +<div class="code"> +<pre> +/* begin fragment("template_name") */ + +...generated code ... + +/* end fragment("template_name") */</pre> +</div> +<p>The Template class is used like this:</p> +<div class="code"> +<pre> +Template t_register = getTemplate("jsv8_register_static_variable"); +t_register.replace("$jsparent", state.clazz(NAME_MANGLED)) + .replace("$jsname", state.variable(NAME)) + .replace("$jsgetter", state.variable(GETTER)) + .replace("$jssetter", state.variable(SETTER)) + .trim(). + print(f_init_static_wrappers);</pre> +</div> +<p>A code template is registered with the <em>JSEmitter</em> via <code>fragment(name, "template")</code>, e.g.,</p> +<div class="code"> +<pre> +%fragment ("jsc_variable_declaration", "templates") +%{ + {"$jsname", $jsgetter, $jssetter, kJSPropertyAttributeNone}, +%}</pre> +</div> +<p><code>Template</code> creates a copy of that string and <code>Template::replace</code> uses Swig's <code>Replaceall</code> to replace variables in the template. <code>Template::trim</code> can be used to eliminate leading and trailing whitespaces. <code>Template::print</code> is used to write the final template string to a Swig <code>DOH</code> (based on <code>Printv</code>). All methods allow chaining.</p> + +<H3>Emitter</H3> +<p>The Javascript module delegates code generation to a <code>JSEmitter</code> instance. The following extract shows the essential interface:</p> +<div class="code"> +<pre> +class JSEmitter { + ... + + /** + * Opens output files and temporary output DOHs. + */ + virtual int initialize(Node *n); + + /** + * Writes all collected code into the output file(s). + */ + virtual int dump(Node *n) = 0; + + /** + * Cleans up all open output DOHs. + */ + virtual int close() = 0; + + ... + + /** + * Invoked at the beginning of the classHandler. + */ + virtual int enterClass(Node *); + + /** + * Invoked at the end of the classHandler. + */ + virtual int exitClass(Node *) { + return SWIG_OK; + }; + + /** + * Invoked at the beginning of the variableHandler. + */ + virtual int enterVariable(Node *); + + /** + * Invoked at the end of the variableHandler. + */ + virtual int exitVariable(Node *) { + return SWIG_OK; + }; + + /** + * Invoked at the beginning of the functionHandler. + */ + virtual int enterFunction(Node *); + + /** + * Invoked at the end of the functionHandler. + */ + virtual int exitFunction(Node *) { + return SWIG_OK; + }; + + /** + * Invoked by functionWrapper callback after call to Language::functionWrapper. + */ + virtual int emitWrapperFunction(Node *n); + + /** + * Invoked from constantWrapper after call to Language::constantWrapper. + **/ + virtual int emitConstant(Node *n); + + /** + * Registers a given code snippet for a given key name. + * + * This method is called by the fragmentDirective handler + * of the JAVASCRIPT language module. + **/ + int registerTemplate(const String *name, const String *code); + + /** + * Retrieve the code template registered for a given name. + */ + Template getTemplate(const String *name); + + State &getState(); + + ... + +}</pre> +</div> +<p>The module calls <code>initialize</code>, <code>dump</code>, and <code>close</code> from within the <code>top</code> method:</p> +<div class="code"> +<pre> +int JAVASCRIPT::top(Node *n) { + emitter->initialize(n); + + Language::top(n); + + emitter->dump(n); + emitter->close(); + + return SWIG_OK; +}</pre> +</div> +<p>The methods <code>enterClass</code> and <code>exitClass</code> are called from within the <code>classHandler</code> method:</p> +<div class="code"> +<pre> +int JAVASCRIPT::classHandler(Node *n) { + + emitter->enterClass(n); + Language::classHandler(n); + emitter->exitClass(n); + + return SWIG_OK; +}</pre> +</div> +<p>In <code>enterClass</code> the emitter stores state information that is necessary when processing class members. In <code>exitClass</code> the wrapper code for the whole class is generated.</p> + +<H3>Emitter states</H3> +<p>For storing information during the AST traversal the emitter provides a <code>JSEmitterState</code> with different slots to store data representing the scopes global, class, function, and variable.</p> +<div class="code"> +<pre> +class JSEmitterState { + +public: + + JSEmitterState(); + + ~JSEmitterState(); + + DOH *global(); + + DOH *global(const char* key, DOH *initial = 0); + + DOH *clazz(bool reset = false); + + DOH *clazz(const char* key, DOH *initial = 0); + + DOH *function(bool reset = false); + + DOH *function(const char* key, DOH *initial = 0); + + DOH *variable(bool reset = false); + + DOH *variable(const char* key, DOH *initial = 0); + + static int IsSet(DOH *val); + + ... +};</pre> +</div> +<p>When entering a scope, such as in <code>enterClass</code>, the corresponding state is reset and new data is stored:</p> +<div class="code"> +<pre> +state.clazz(RESET); +state.clazz(NAME, Getattr(n, "sym:name"));</pre> +</div> +<p>State information can be retrieved using <code>state.clazz(NAME)</code> or with <code>Getattr</code> on <code>state.clazz()</code> which actually returns a <code>Hash</code> instance.</p> +</body> +</html> diff --git a/Doc/Manual/Lua.html b/Doc/Manual/Lua.html index e6cf11b9f..c67e08834 100644 --- a/Doc/Manual/Lua.html +++ b/Doc/Manual/Lua.html @@ -990,7 +990,7 @@ The current list of operators which can be overloaded (and the alternative funct <li><tt>__sub__</tt> operator- <li><tt>__mul__</tt> operator * <li><tt>__div__</tt> operator/ -<li><tt>__neg__</tt> unary minus +<li><tt>__unm__</tt> unary minus <li><tt>__call__</tt> operator<tt>()</tt> (often used in functor classes) <li><tt>__pow__</tt> the exponential fn (no C++ equivalent, Lua uses <tt>^</tt>) <li><tt>__concat__</tt> the concatenation operator (SWIG maps C++'s <tt>~</tt> to Lua's <tt>..</tt>) @@ -1037,7 +1037,29 @@ It is also possible to overload the operator<tt>[]</tt>, but currently this cann void __setitem__(int i,double d); // i is the index, d is the data }; </pre></div> - +<p> +C++ operators are mapped to Lua predefined metafunctions. Class inherits from its bases the following list of metafunctions ( thus inheriting the folloging +operators and pseudo-operators):</p> +<ul> +<li><tt>__add__</tt> +<li><tt>__sub__</tt> +<li><tt>__mul__</tt> +<li><tt>__div__</tt> +<li><tt>__unm__</tt> +<li><tt>__mod__</tt> +<li><tt>__call__</tt> +<li><tt>__pow__</tt> +<li><tt>__concat__</tt> +<li><tt>__eq__</tt> +<li><tt>__lt__</tt> +<li><tt>__le__</tt> +<li><tt>__len__</tt> +<li><tt>__getitem__</tt> +<li><tt>__setitem__</tt> +<li><tt>__tostring</tt> used internally by Lua for tostring() function. __str__ is mapped to this function +</ul> +<p>No other lua metafunction is inherited. For example, __gc is not inherited and must be redefined in every class. <tt>__tostring</tt> is subject to a special handling. If absent in class and in class bases, a default one will be provided by SWIG</p> +</p> <H3><a name="Lua_nn19"></a>27.3.12 Class extension with %extend</H3> @@ -1073,7 +1095,7 @@ Now we extend it with some new code return tmp; } bool operator==(const Complex& c) - { return ($self->re()==c.re() && $self->im()==c.im();} + { return ($self->re()==c.re() && $self->im()==c.im());} }; </pre></div> <p> diff --git a/Doc/Manual/Preprocessor.html b/Doc/Manual/Preprocessor.html index d5c41dde7..745570ca4 100644 --- a/Doc/Manual/Preprocessor.html +++ b/Doc/Manual/Preprocessor.html @@ -115,6 +115,9 @@ SWIGCLISP Defined when using CLISP SWIGCSHARP Defined when using C# SWIGGUILE Defined when using Guile SWIGJAVA Defined when using Java +SWIGJAVASCRIPT Defined when using Javascript +SWIG_JAVASCRIPT_JSC Defined when using Javascript for JavascriptCore +SWIG_JAVASCRIPT_V8 Defined when using Javascript for v8 or node.js SWIGLUA Defined when using Lua SWIGMODULA3 Defined when using Modula-3 SWIGMZSCHEME Defined when using Mzscheme diff --git a/Doc/Manual/Ruby.html b/Doc/Manual/Ruby.html index 3fc45834d..9719239a9 100644 --- a/Doc/Manual/Ruby.html +++ b/Doc/Manual/Ruby.html @@ -4690,7 +4690,7 @@ public: C++ constructor, thus creating a new <tt>foo</tt> object. By default, SWIG will assign the new Ruby object a "free" function. When the Ruby object is garbage collected, the "free" function will be -called. It in turn will call <tt>Foo's</tt> destructor.</p> +called. It in turn will call <tt>Foo</tt>'s destructor.</p> <p>Next, consider this code: </p> diff --git a/Doc/Manual/Sections.html b/Doc/Manual/Sections.html index 877ca2fae..99d1dfe0d 100644 --- a/Doc/Manual/Sections.html +++ b/Doc/Manual/Sections.html @@ -42,6 +42,7 @@ Last update : SWIG-3.0.1 (in progress) <li><a href="Go.html#Go">Go support</a></li> <li><a href="Guile.html#Guile">Guile support</a></li> <li><a href="Java.html#Java">Java support</a></li> +<li><a href="Javascript.html#Java">Javascript support</a></li> <li><a href="Lisp.html#Lisp">Common Lisp support</a></li> <li><a href="Lua.html#Lua">Lua support</a></li> <li><a href="Modula3.html#Modula3">Modula3 support</a></li> diff --git a/Doc/Manual/chapters b/Doc/Manual/chapters index 45d35e793..c5f655254 100644 --- a/Doc/Manual/chapters +++ b/Doc/Manual/chapters @@ -23,6 +23,7 @@ D.html Go.html Guile.html Java.html +Javascript.html Lisp.html Lua.html Modula3.html |