From d16d145787c45954c533c2208b9a0ae721df9002 Mon Sep 17 00:00:00 2001 From: William S Fulton Date: Mon, 11 Feb 2019 19:02:03 +0000 Subject: [PATCH] Documentation section numbering update [skip ci] --- Doc/Manual/Android.html | 16 +-- Doc/Manual/Arguments.html | 22 ++-- Doc/Manual/CCache.html | 36 +++--- Doc/Manual/CPlusPlus14.html | 3 +- Doc/Manual/CPlusPlus17.html | 12 +- Doc/Manual/CSharp.html | 60 +++++----- Doc/Manual/Contents.html | 167 ++++++++++++++------------ Doc/Manual/Contract.html | 10 +- Doc/Manual/Customization.html | 32 ++--- Doc/Manual/D.html | 44 +++---- Doc/Manual/Doxygen.html | 52 ++++---- Doc/Manual/Extending.html | 106 ++++++++-------- Doc/Manual/Go.html | 56 ++++----- Doc/Manual/Guile.html | 44 +++---- Doc/Manual/Java.html | 220 +++++++++++++++++----------------- Doc/Manual/Javascript.html | 44 +++---- Doc/Manual/Library.html | 50 ++++---- Doc/Manual/Lua.html | 88 +++++++------- Doc/Manual/Modules.html | 16 +-- Doc/Manual/Ocaml.html | 66 +++++----- Doc/Manual/Preprocessor.html | 26 ++-- Doc/Manual/Typemaps.html | 132 ++++++++++---------- Doc/Manual/Varargs.html | 20 ++-- Doc/Manual/Warnings.html | 38 +++--- 24 files changed, 688 insertions(+), 672 deletions(-) diff --git a/Doc/Manual/Android.html b/Doc/Manual/Android.html index cc11ec26e..894724188 100644 --- a/Doc/Manual/Android.html +++ b/Doc/Manual/Android.html @@ -6,7 +6,7 @@ -

20 SWIG and Android

+

21 SWIG and Android

-

11.1.3 Output parameters

+

12.1.3 Output parameters

@@ -315,7 +315,7 @@ iresult, dresult = foo(3.5, 2) -

11.1.4 Input/Output parameters

+

12.1.4 Input/Output parameters

@@ -380,7 +380,7 @@ rather than directly overwriting the value of the original input object. SWIG. Backwards compatibility is preserved, but deprecated.

-

11.1.5 Using different names

+

12.1.5 Using different names

@@ -414,7 +414,7 @@ Typemap declarations are lexically scoped so a typemap takes effect from the poi file or a matching %clear declaration.

-

11.2 Applying constraints to input values

+

12.2 Applying constraints to input values

@@ -424,7 +424,7 @@ insure that a value is positive, or that a pointer is non-NULL. This can be accomplished including the constraints.i library file.

-

11.2.1 Simple constraint example

+

12.2.1 Simple constraint example

@@ -450,7 +450,7 @@ the arguments violate the constraint condition, a scripting language exception will be raised. As a result, it is possible to catch bad values, prevent mysterious program crashes and so on.

-

11.2.2 Constraint methods

+

12.2.2 Constraint methods

@@ -466,7 +466,7 @@ NONNULL Non-NULL pointer (pointers only). -

11.2.3 Applying constraints to new datatypes

+

12.2.3 Applying constraints to new datatypes

diff --git a/Doc/Manual/CCache.html b/Doc/Manual/CCache.html index 6923b2e95..3a7db5c7b 100644 --- a/Doc/Manual/CCache.html +++ b/Doc/Manual/CCache.html @@ -7,7 +7,7 @@ -

19 Using SWIG with ccache - ccache-swig(1) manpage

+

20 Using SWIG with ccache - ccache-swig(1) manpage

-

19.14 HISTORY

+

20.14 HISTORY

@@ -423,7 +423,7 @@ I wrote ccache because I wanted to get a bit more speed out of a compiler cache and I wanted to remove some of the limitations of the shell-script version.

-

19.15 DIFFERENCES FROM COMPILERCACHE

+

20.15 DIFFERENCES FROM COMPILERCACHE

@@ -441,7 +441,7 @@ are:

  • ccache avoids a double call to cpp on a cache miss

    -

    19.16 CREDITS

    +

    20.16 CREDITS

    @@ -453,7 +453,7 @@ Thanks to the following people for their contributions to ccache

  • Paul Russell for many suggestions and the debian packaging

    -

    19.17 AUTHOR

    +

    20.17 AUTHOR

    diff --git a/Doc/Manual/CPlusPlus14.html b/Doc/Manual/CPlusPlus14.html index 32798f302..b162c7818 100644 --- a/Doc/Manual/CPlusPlus14.html +++ b/Doc/Manual/CPlusPlus14.html @@ -14,6 +14,7 @@

  • Introduction
  • Core language changes
  • Standard library changes @@ -38,7 +39,7 @@ C++14 support.

    8.2 Core language changes

    -

    Binary integer literals

    +

    8.2.1 Binary integer literals

    diff --git a/Doc/Manual/CPlusPlus17.html b/Doc/Manual/CPlusPlus17.html index ea42bd6a2..ae3ca5c77 100644 --- a/Doc/Manual/CPlusPlus17.html +++ b/Doc/Manual/CPlusPlus17.html @@ -7,7 +7,7 @@ -

    8 SWIG and C++17

    +

    9 SWIG and C++17

    -

    8.2.2 UTF-8 character literals

    +

    9.2.2 UTF-8 character literals

    @@ -87,7 +87,7 @@ char a = u8'a';

    • -

    8.3 Standard library changes

    +

    9.3 Standard library changes

    diff --git a/Doc/Manual/CSharp.html b/Doc/Manual/CSharp.html index 7a1326b54..a4e0be799 100644 --- a/Doc/Manual/CSharp.html +++ b/Doc/Manual/CSharp.html @@ -6,7 +6,7 @@ -

    21 SWIG and C#

    +

    22 SWIG and C#

    -

    21.4 C# Arrays

    +

    22.4 C# Arrays

    @@ -586,7 +586,7 @@ with one of the following three approaches; namely the SWIG C arrays library, P/ pinned arrays.

    -

    21.4.1 The SWIG C arrays library

    +

    22.4.1 The SWIG C arrays library

    @@ -623,7 +623,7 @@ example.print_array(c.cast()); // Pass to C -

    21.4.2 Managed arrays using P/Invoke default array marshalling

    +

    22.4.2 Managed arrays using P/Invoke default array marshalling

    @@ -750,7 +750,7 @@ and intermediary class method -

    21.4.3 Managed arrays using pinning

    +

    22.4.3 Managed arrays using pinning

    @@ -845,7 +845,7 @@ public static extern void myArrayCopy(global::System.IntPtr jarg1, global::Syste -

    21.5 C# Exceptions

    +

    22.5 C# Exceptions

    @@ -942,7 +942,7 @@ set so should only be used when a C# exception is not created.

    -

    21.5.1 C# exception example using "check" typemap

    +

    22.5.1 C# exception example using "check" typemap

    @@ -1124,7 +1124,7 @@ method and C# code does not handle pending exceptions via the canthrow attribute Actually it will issue this warning for any function beginning with SWIG_CSharpSetPendingException.

    -

    21.5.2 C# exception example using %exception

    +

    22.5.2 C# exception example using %exception

    @@ -1189,7 +1189,7 @@ The managed code generated does check for the pending exception as mentioned ear -

    21.5.3 C# exception example using exception specifications

    +

    22.5.3 C# exception example using exception specifications

    @@ -1245,7 +1245,7 @@ SWIGEXPORT void SWIGSTDCALL CSharp_evensonly(int jarg1) { Multiple catch handlers are generated should there be more than one exception specifications declared.

    -

    21.5.4 Custom C# ApplicationException example

    +

    22.5.4 Custom C# ApplicationException example

    @@ -1379,7 +1379,7 @@ try { -

    21.6 C# Directors

    +

    22.6 C# Directors

    @@ -1392,7 +1392,7 @@ The following sections provide information on the C# director implementation and However, the Java directors section should also be read in order to gain more insight into directors.

    -

    21.6.1 Directors example

    +

    22.6.1 Directors example

    @@ -1513,7 +1513,7 @@ CSharpDerived - UIntMethod(123) -

    21.6.2 Directors implementation

    +

    22.6.2 Directors implementation

    @@ -1721,7 +1721,7 @@ before SWIG parses the Base class will change all the delegates to internal< -

    21.6.3 Director caveats

    +

    22.6.3 Director caveats

    @@ -1769,7 +1769,7 @@ However, a call from C# to CSharpDefaults.DefaultMethod() will of cours should pass the call on to CSharpDefaults.DefaultMethod(int)using the C++ default value, as shown above.

    -

    21.7 Multiple modules

    +

    22.7 Multiple modules

    @@ -1804,7 +1804,7 @@ the [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrows if you don't want users to easily stumble upon these so called 'internal workings' of the wrappers.

    -

    21.8 C# Typemap examples

    +

    22.8 C# Typemap examples

    This section includes a few examples of typemaps. For more examples, you @@ -1812,7 +1812,7 @@ might look at the files "csharp.swg" and "typemaps.i" in the SWIG library. -

    21.8.1 Memory management when returning references to member variables

    +

    22.8.1 Memory management when returning references to member variables

    @@ -1936,7 +1936,7 @@ public class Bike : global::System.IDisposable { Note the addReference call.

    -

    21.8.2 Memory management for objects passed to the C++ layer

    +

    22.8.2 Memory management for objects passed to the C++ layer

    @@ -2068,7 +2068,7 @@ as mentioned earlier, setElement is actually: -

    21.8.3 Date marshalling using the csin typemap and associated attributes

    +

    22.8.3 Date marshalling using the csin typemap and associated attributes

    @@ -2354,7 +2354,7 @@ public class example { -

    21.8.4 A date example demonstrating marshalling of C# properties

    +

    22.8.4 A date example demonstrating marshalling of C# properties

    @@ -2454,7 +2454,7 @@ Some points to note:

  • The 'csin' typemap has 'pre', 'post' and 'cshin' attributes, and these are all ignored in the property set. The code in these attributes must instead be replicated within the 'csvarin' typemap. The line creating the temp$csinput variable is such an example; it is identical to what is in the 'pre' attribute. -

    21.8.5 Date example demonstrating the 'pre' and 'post' typemap attributes for directors

    +

    22.8.5 Date example demonstrating the 'pre' and 'post' typemap attributes for directors

    @@ -2516,7 +2516,7 @@ Pay special attention to the memory management issues, using these attributes.

    -

    21.8.6 Turning proxy classes into partial classes

    +

    22.8.6 Turning proxy classes into partial classes

    @@ -2616,7 +2616,7 @@ demonstrating that the class contains methods calling both unmanaged code - The following example is an alternative approach to adding managed code to the generated proxy class.

    -

    21.8.7 Turning proxy classes into sealed classes

    +

    22.8.7 Turning proxy classes into sealed classes

    @@ -2706,7 +2706,7 @@ Either suppress the warning or modify the generated code by copying and tweaking 'csbody' typemap code in csharp.swg by modifying swigCMemOwn to not be protected.

    -

    21.8.8 Extending proxy classes with additional C# code

    +

    22.8.8 Extending proxy classes with additional C# code

    @@ -2745,7 +2745,7 @@ public class ExtendMe : global::System.IDisposable { -

    21.8.9 Underlying type for enums

    +

    22.8.9 Underlying type for enums

    diff --git a/Doc/Manual/Contents.html b/Doc/Manual/Contents.html index 5218cc0d9..fbfc7d751 100644 --- a/Doc/Manual/Contents.html +++ b/Doc/Manual/Contents.html @@ -340,7 +340,22 @@ -

    8 SWIG and C++17

    +

    8 SWIG and C++14

    + + +
    + +
    + + +

    9 SWIG and C++17

    @@ -356,7 +371,7 @@
    -

    9 Preprocessing

    +

    10 Preprocessing

    @@ -379,7 +394,7 @@
    -

    10 SWIG library

    +

    11 SWIG library

    @@ -422,7 +437,7 @@
    -

    11 Argument Handling

    +

    12 Argument Handling

    @@ -445,7 +460,7 @@
    -

    12 Typemaps

    +

    13 Typemaps

    @@ -539,7 +554,7 @@
    -

    13 Customization Features

    +

    14 Customization Features

    @@ -567,7 +582,7 @@
    -

    14 Contracts

    +

    15 Contracts

    @@ -580,7 +595,7 @@
    -

    15 Variable Length Arguments

    +

    16 Variable Length Arguments

    @@ -598,7 +613,7 @@
    -

    16 SWIG and Doxygen Translation

    +

    17 SWIG and Doxygen Translation

    @@ -642,7 +657,7 @@
    -

    17 Warning Messages

    +

    18 Warning Messages

    @@ -671,7 +686,7 @@
    -

    18 Working with Modules

    +

    19 Working with Modules

    @@ -687,7 +702,7 @@
    -

    19 Using SWIG with ccache - ccache-swig(1) manpage

    +

    20 Using SWIG with ccache - ccache-swig(1) manpage

    @@ -713,7 +728,7 @@
    -

    20 SWIG and Android

    +

    21 SWIG and Android

    @@ -731,7 +746,7 @@
    -

    21 SWIG and C#

    +

    22 SWIG and C#

    @@ -779,7 +794,7 @@
    -

    22 SWIG and D

    +

    23 SWIG and D

    @@ -813,7 +828,7 @@
    -

    23 SWIG and Go

    +

    24 SWIG and Go

    @@ -857,7 +872,7 @@
    -

    24 SWIG and Guile

    +

    25 SWIG and Guile

    @@ -893,7 +908,7 @@
    -

    25 SWIG and Java

    +

    26 SWIG and Java

    @@ -1047,7 +1062,7 @@
    -

    26 SWIG and Javascript

    +

    27 SWIG and Javascript

    @@ -1089,7 +1104,7 @@
    -

    27 SWIG and Lua

    +

    28 SWIG and Lua

    @@ -1157,61 +1172,6 @@
    -

    28 SWIG and Ocaml

    - - -
    - -
    - -

    29 SWIG and Octave

    @@ -1812,7 +1772,62 @@ -

    38 Extending SWIG to support new languages

    +

    38 SWIG and OCaml

    + + +
    + +
    + + +

    39 Extending SWIG to support new languages

    diff --git a/Doc/Manual/Contract.html b/Doc/Manual/Contract.html index 2394db25e..93fb8c003 100644 --- a/Doc/Manual/Contract.html +++ b/Doc/Manual/Contract.html @@ -7,7 +7,7 @@ -

    14 Contracts

    +

    15 Contracts

      @@ -39,7 +39,7 @@ When one of the rules is violated by a script, a runtime exception is generated rather than having the program continue to execute.

      -

      14.1 The %contract directive

      +

      15.1 The %contract directive

      @@ -95,7 +95,7 @@ RuntimeError: Contract violation: require: (arg1>=0)

    -

    14.2 %contract and classes

    +

    15.2 %contract and classes

    @@ -174,7 +174,7 @@ specified for the derived class all must hold. In the above example, this means that both the arguments to Spam::bar must be positive.

    -

    14.3 Constant aggregation and %aggregate_check

    +

    15.3 Constant aggregation and %aggregate_check

    @@ -263,7 +263,7 @@ Regrettably, there is no automatic way to perform similar checks with enums valu release.

    -

    14.4 Notes

    +

    15.4 Notes

    diff --git a/Doc/Manual/Customization.html b/Doc/Manual/Customization.html index 27a291d0c..328bc2391 100644 --- a/Doc/Manual/Customization.html +++ b/Doc/Manual/Customization.html @@ -7,7 +7,7 @@ -

    13 Customization Features

    +

    14 Customization Features

    -

    13.1.4 Exception handlers for variables

    +

    14.1.4 Exception handlers for variables

    @@ -305,7 +305,7 @@ The %allowexception feature works like any other feature and so can be

    -

    13.1.5 Defining different exception handlers

    +

    14.1.5 Defining different exception handlers

    @@ -442,7 +442,7 @@ declarations. However, it never really worked that well and the new %exception directive is much better.

    -

    13.1.6 Special variables for %exception

    +

    14.1.6 Special variables for %exception

    @@ -545,7 +545,7 @@ Below shows the expansions for the 1st of the overloaded something wrap -

    13.1.7 Using The SWIG exception library

    +

    14.1.7 Using The SWIG exception library

    @@ -600,7 +600,7 @@ SWIG_NullReferenceError The SWIG_exception() function can also be used in typemaps.

    -

    13.2 Object ownership and %newobject

    +

    14.2 Object ownership and %newobject

    @@ -757,7 +757,7 @@ char *strdup(const char *s); The results might not be what you expect.

    -

    13.3 Features and the %feature directive

    +

    14.3 Features and the %feature directive

    @@ -839,7 +839,7 @@ The following are all equivalent: The syntax in the first variation will generate the { } delimiters used whereas the other variations will not.

    -

    13.3.1 Feature attributes

    +

    14.3.1 Feature attributes

    @@ -880,7 +880,7 @@ In the following example, MyExceptionClass is the name of the Java clas Further details can be obtained from the Java exception handling section.

    -

    13.3.2 Feature flags

    +

    14.3.2 Feature flags

    @@ -978,7 +978,7 @@ in the swig.swg Library file. The following shows the alternative synta The concept of clearing features is discussed next.

    -

    13.3.3 Clearing features

    +

    14.3.3 Clearing features

    @@ -1071,7 +1071,7 @@ The three macros below show this for the "except" feature: -

    13.3.4 Features and default arguments

    +

    14.3.4 Features and default arguments

    @@ -1146,7 +1146,7 @@ specifying or not specifying default arguments in a feature is not applicable as in SWIG-1.3.23 when the approach to wrapping methods with default arguments was changed.

    -

    13.3.5 Feature example

    +

    14.3.5 Feature example

    diff --git a/Doc/Manual/D.html b/Doc/Manual/D.html index 1a317a005..a252650ff 100644 --- a/Doc/Manual/D.html +++ b/Doc/Manual/D.html @@ -6,7 +6,7 @@ -

    22 SWIG and D

    +

    23 SWIG and D

      @@ -41,7 +41,7 @@ -

      22.1 Introduction

      +

      23.1 Introduction

      From the D Programming Language web site: D is a systems programming language. Its focus is on combining the power and high performance of C and C++ with the programmer productivity of modern languages like Ruby and Python. [...] The D language is statically typed and compiles directly to machine code. As such, it is not very surprising that D is able to directly interface with C libraries. Why would a SWIG module for D be needed then in the first place?

      @@ -53,7 +53,7 @@

      To help addressing these issues, the SWIG C# module has been forked to support D. Is has evolved quite a lot since then, but there are still many similarities, so if you do not find what you are looking for on this page, it might be worth having a look at the chapter on C# (and also on Java, since the C# module was in turn forked from it).

      -

      22.2 Command line invocation

      +

      23.2 Command line invocation

      To activate the D module, pass the -d option to SWIG at the command line. The same standard command line switches as with any other language module are available, plus the following D specific ones:

      @@ -83,10 +83,10 @@ -

      22.3 Typemaps

      +

      23.3 Typemaps

      -

      22.3.1 C# <-> D name comparison

      +

      23.3.1 C# <-> D name comparison

      If you already know the SWIG C# module, you might find the following name comparison table useful:

      @@ -112,7 +112,7 @@
    -

    22.3.2 ctype, imtype, dtype

    +

    23.3.2 ctype, imtype, dtype

    Mapping of types between the C/C++ library, the C/C++ library wrapper exposing the C functions, the D wrapper module importing these functions and the D proxy code.

    @@ -120,7 +120,7 @@

    The ctype typemap is used to determine the types to use in the C wrapper functions. The types from the imtype typemap are used in the extern(C) declarations of these functions in the intermediary D module. The dtype typemap contains the D types used in the D proxy module/class.

    -

    22.3.3 in, out, directorin, directorout

    +

    23.3.3 in, out, directorin, directorout

    Used for converting between the types for C/C++ and D when generating the code for the wrapper functions (on the C++ side).

    @@ -130,7 +130,7 @@

    The directorin typemap is used to convert parameters to the type used in the D director callback function, its return value is processed by directorout (see below).

    -

    22.3.4 din, dout, ddirectorin, ddirectorout

    +

    23.3.4 din, dout, ddirectorin, ddirectorout

    Typemaps for code generation in D proxy and type wrapper classes.

    @@ -157,13 +157,13 @@ dtype DClass.method(dtype a) -

    22.3.5 typecheck typemaps

    +

    23.3.5 typecheck typemaps

    Because, unlike many scripting languages supported by SWIG, D does not need any dynamic dispatch helper to access an overloaded function, the purpose of these is merely to issue a warning for overloaded C++ functions that cannot be overloaded in D (as more than one C++ type maps to a single D type).

    -

    22.3.6 Code injection typemaps

    +

    23.3.6 Code injection typemaps

    These typemaps are used for generating the skeleton of proxy classes for C++ types.

    @@ -178,7 +178,7 @@ Code can also be injected into the D proxy class using %proxycode.

    -

    22.3.7 Special variable macros

    +

    23.3.7 Special variable macros

    The standard SWIG special variables are available for use within typemaps as described in the Typemaps documentation, for example $1, $input, $result etc.

    @@ -299,7 +299,7 @@ $importtype(AnotherInterface) -

    22.4 D and %feature

    +

    23.4 D and %feature

    The D module defines a number of directives which modify the SWIG features set globally or for a specific declaration:

    @@ -329,7 +329,7 @@ struct A { -

    22.5 Pragmas

    +

    23.5 Pragmas

    There are a few SWIG pragmas specific to the D module, which you can use to influence the D code SWIG generates:

    @@ -368,7 +368,7 @@ struct A { -

    22.6 D Exceptions

    +

    23.6 D Exceptions

    Out of the box, C++ exceptions are fundamentally incompatible to their equivalent in the D world and cannot simply be propagated to a calling D method. There is, however, an easy way to solve this problem: Just catch the exception in the C/C++ wrapper layer, pass the contents to D, and make the wrapper code rethrow the exception in the D world.

    @@ -378,7 +378,7 @@ struct A {

    As this feature is implemented in exactly the same way it is for C#, please see the C# documentation for a more detailed explanation.

    -

    22.7 D Directors

    +

    23.7 D Directors

    When the directors feature is activated, SWIG generates extra code on both the C++ and the D side to enable cross-language polymorphism. Essentially, this means that if you subclass a proxy class in D, C++ code can access any overridden virtual methods just as if you created a derived class in C++.

    @@ -387,16 +387,16 @@ struct A {

    -

    22.8 Other features

    +

    23.8 Other features

    -

    22.8.1 Extended namespace support (nspace)

    +

    23.8.1 Extended namespace support (nspace)

    By default, SWIG flattens all C++ namespaces into a single target language namespace, but as for Java and C#, the nspace feature is supported for D. If it is active, C++ namespaces are mapped to D packages/modules. Note, however, that like for the other languages, free variables and functions are not supported yet; currently, they are all allows written to the main proxy D module.

    -

    22.8.2 Native pointer support

    +

    23.8.2 Native pointer support

    Contrary to many of the scripting languages supported by SWIG, D fully supports C-style pointers. The D module thus includes a custom mechanism to wrap C pointers directly as D pointers where applicable, that is, if the type that is pointed to is represented the same in C and D (on the bit-level), dubbed a primitive type below.

    @@ -408,7 +408,7 @@ struct A {

    To determine if a type should be considered primitive, the cprimitive attribute on its dtype attribute is used. For example, the dtype typemap for float has cprimitive="1", so the code from the nativepointer attribute is taken into account e.g. for float ** or the function pointer float (*)(float *).

    -

    22.8.3 Operator overloading

    +

    23.8.3 Operator overloading

    The D module comes with basic operator overloading support for both D1 and D2. There are, however, a few limitations arising from conceptual differences between C++ and D:

    @@ -420,7 +420,7 @@ struct A {

    There are also some cases where the operators can be translated to D, but the differences in the implementation details are big enough that a rather involved scheme would be required for automatic wrapping them, which has not been implemented yet. This affects, for example, the array subscript operator, [], in combination with assignments - while operator [] in C++ simply returns a reference which is then written to, D resorts to a separate opIndexAssign method -, or implicit casting (which was introduced in D2 via alias this). Despite the lack of automatic support, manually handling these cases should be perfectly possible.

    -

    22.8.4 Running the test-suite

    +

    23.8.4 Running the test-suite

    As with any other language, the SWIG test-suite can be built for D using the *-d-test-suite targets of the top-level Makefile. By default, D1 is targeted, to build it with D2, use the optional D_VERSION variable, e.g. make check-d-test-suite D_VERSION=2.

    @@ -428,14 +428,14 @@ struct A {

    Note: If you want to use GDC on Linux or another platform which requires you to link libdl for dynamically loading the shared library, you might have to add -ldl manually to the d_compile target in Examples/Makefile, because GDC does not currently honor the pragma(lib, ...) statement.

    -

    22.9 D Typemap examples

    +

    23.9 D Typemap examples

    There are no D-specific typemap examples yet. However, with the above name comparison table, you should be able to get an idea what can be done by looking at the corresponding C# section.

    -

    22.10 Work in progress and planned features

    +

    23.10 Work in progress and planned features

    There are a couple of features which are not implemented yet, but would be very useful and might be added in the near future:

    diff --git a/Doc/Manual/Doxygen.html b/Doc/Manual/Doxygen.html index 1e9bbb977..b14b05ba3 100644 --- a/Doc/Manual/Doxygen.html +++ b/Doc/Manual/Doxygen.html @@ -5,7 +5,7 @@ -

    16 SWIG and Doxygen Translation

    +

    17 SWIG and Doxygen Translation

    -

    16.2.2.4 doxygen:nolinktranslate

    +

    17.2.2.4 doxygen:nolinktranslate

    @@ -425,7 +425,7 @@ This is only applicable to Java at the moment.

    -

    16.2.2.5 doxygen:nostripparams

    +

    17.2.2.5 doxygen:nostripparams

    @@ -435,14 +435,14 @@ This is only applicable to Java at the moment.

    -

    16.2.3 Additional command line options

    +

    17.2.3 Additional command line options

    ALSO TO BE ADDED (Javadoc auto brief?)

    -

    16.3 Doxygen to Javadoc

    +

    17.3 Doxygen to Javadoc

    @@ -451,7 +451,7 @@ automatically placed in the correct locations in the resulting module and proxy files.

    -

    16.3.1 Basic example

    +

    17.3.1 Basic example

    @@ -558,7 +558,7 @@ Javadoc translator features summary directives):

    -

    16.3.2 Javadoc tags

    +

    17.3.2 Javadoc tags

    @@ -812,7 +812,7 @@ Here is the list of all Doxygen tags and the description of how they are transla -

    16.3.3 Unsupported tags

    +

    17.3.3 Unsupported tags

    @@ -1048,14 +1048,14 @@ comment, the whole comment block is ignored: -

    16.3.4 Further details

    +

    17.3.4 Further details

    TO BE ADDED.

    -

    16.4 Doxygen to Pydoc

    +

    17.4 Doxygen to Pydoc

    @@ -1066,7 +1066,7 @@ Doxygen or Javadoc, so most of Doxygen commands are translated by merely copying the appropriate command text.

    -

    16.4.1 Basic example

    +

    17.4.1 Basic example

    @@ -1229,7 +1229,7 @@ docs), you may want to use some tool like doxypy to do the work.

    -

    16.4.2 Pydoc translator

    +

    17.4.2 Pydoc translator

    @@ -1443,7 +1443,7 @@ Here is the list of all Doxygen tags and the description of how they are transla -

    16.4.3 Unsupported tags

    +

    17.4.3 Unsupported tags

    @@ -1627,21 +1627,21 @@ Here is the list of these tags: -

    16.4.4 Further details

    +

    17.4.4 Further details

    TO BE ADDED.

    -

    16.5 Developer information

    +

    17.5 Developer information

    This section contains information for developers enhancing the Doxygen translator.

    -

    16.5.1 Doxygen translator design

    +

    17.5.1 Doxygen translator design

    @@ -1667,7 +1667,7 @@ class for translation into the target documentation language. For example, JavaDocConverter is the Javadoc module class.

    -

    16.5.2 Debugging the Doxygen parser and translator

    +

    17.5.2 Debugging the Doxygen parser and translator

    @@ -1680,7 +1680,7 @@ detailed debug information printing. -debug-doxygen-translator - Display Doxygen translator module debugging information -

    16.5.3 Tests

    +

    17.5.3 Tests

    @@ -1732,7 +1732,7 @@ Runtime tests in Python are just plain string comparisons of the __doc__ properties.

    -

    16.6 Extending to other languages

    +

    17.6 Extending to other languages

    diff --git a/Doc/Manual/Extending.html b/Doc/Manual/Extending.html index 1d9fc83ac..1deb1cb12 100644 --- a/Doc/Manual/Extending.html +++ b/Doc/Manual/Extending.html @@ -7,7 +7,7 @@ -

    38 Extending SWIG to support new languages

    +

    39 Extending SWIG to support new languages

    -

    38.4.4 Attribute namespaces

    +

    39.4.4 Attribute namespaces

    @@ -665,7 +665,7 @@ that matches the name of the target language. For example, python:foo perl:foo.

    -

    38.4.5 Symbol Tables

    +

    39.4.5 Symbol Tables

    @@ -756,7 +756,7 @@ example.i:5. Previous declaration is foo_i(int ) -

    38.4.6 The %feature directive

    +

    39.4.6 The %feature directive

    @@ -812,7 +812,7 @@ For example, the exception code above is simply stored without any modifications.

    -

    38.4.7 Code Generation

    +

    39.4.7 Code Generation

    @@ -934,7 +934,7 @@ public : The role of these functions is described shortly.

    -

    38.4.8 SWIG and XML

    +

    39.4.8 SWIG and XML

    @@ -947,7 +947,7 @@ internal data structures, it may be useful to keep XML in the back of your mind as a model.

    -

    38.5 Primitive Data Structures

    +

    39.5 Primitive Data Structures

    @@ -993,7 +993,7 @@ typedef Hash Typetab; -

    38.5.1 Strings

    +

    39.5.1 Strings

    @@ -1134,7 +1134,7 @@ Returns the number of replacements made (if any). -

    38.5.2 Hashes

    +

    39.5.2 Hashes

    @@ -1211,7 +1211,7 @@ Returns the list of hash table keys. -

    38.5.3 Lists

    +

    39.5.3 Lists

    @@ -1300,7 +1300,7 @@ If t is not a standard object, it is assumed to be a char * and is used to create a String object. -

    38.5.4 Common operations

    +

    39.5.4 Common operations

    The following operations are applicable to all datatypes. @@ -1355,7 +1355,7 @@ objects and report errors. Gets the line number associated with x. -

    38.5.5 Iterating over Lists and Hashes

    +

    39.5.5 Iterating over Lists and Hashes

    To iterate over the elements of a list or a hash table, the following functions are used: @@ -1400,7 +1400,7 @@ for (j = First(j); j.item; j= Next(j)) { -

    38.5.6 I/O

    +

    39.5.6 I/O

    Special I/O functions are used for all internal I/O. These operations @@ -1534,7 +1534,7 @@ Printf(f, "%s\n", s); Similarly, the preprocessor and parser all operate on string-files.

    -

    38.6 Navigating and manipulating parse trees

    +

    39.6 Navigating and manipulating parse trees

    Parse trees are built as collections of hash tables. Each node is a hash table in which @@ -1668,7 +1668,7 @@ Deletes a node from the parse tree. Deletion reconnects siblings and properly u the parent so that sibling nodes are unaffected. -

    38.7 Working with attributes

    +

    39.7 Working with attributes

    @@ -1785,7 +1785,7 @@ the attribute is optional. Swig_restore() must always be called after function. -

    38.8 Type system

    +

    39.8 Type system

    @@ -1794,7 +1794,7 @@ pointers, references, and pointers to members. A detailed discussion of type theory is impossible here. However, let's cover the highlights.

    -

    38.8.1 String encoding of types

    +

    39.8.1 String encoding of types

    @@ -1895,7 +1895,7 @@ make the final type, the two parts are just joined together using string concatenation.

    -

    38.8.2 Type construction

    +

    39.8.2 Type construction

    @@ -2064,7 +2064,7 @@ Returns the prefix of a type. For example, if ty is ty is unmodified. -

    38.8.3 Type tests

    +

    39.8.3 Type tests

    @@ -2151,7 +2151,7 @@ Checks if ty is a varargs type. Checks if ty is a templatized type. -

    38.8.4 Typedef and inheritance

    +

    39.8.4 Typedef and inheritance

    @@ -2253,7 +2253,7 @@ Fully reduces ty according to typedef rules. Resulting datatype will consist only of primitive typenames. -

    38.8.5 Lvalues

    +

    39.8.5 Lvalues

    @@ -2290,7 +2290,7 @@ Literal y; // type = 'Literal', ltype='p.char' -

    38.8.6 Output functions

    +

    39.8.6 Output functions

    @@ -2352,7 +2352,7 @@ SWIG, but is most commonly associated with type-descriptor objects that appear in wrappers (e.g., SWIGTYPE_p_double). -

    38.9 Parameters

    +

    39.9 Parameters

    @@ -2451,7 +2451,7 @@ included. Used to emit prototypes. Returns the number of required (non-optional) arguments in p. -

    38.10 Writing a Language Module

    +

    39.10 Writing a Language Module

    @@ -2466,7 +2466,7 @@ describes the creation of a minimal Python module. You should be able to extra this to other languages.

    -

    38.10.1 Execution model

    +

    39.10.1 Execution model

    @@ -2476,7 +2476,7 @@ the parsing of command line options, all aspects of code generation are controll different methods of the Language that must be defined by your module.

    -

    38.10.2 Starting out

    +

    39.10.2 Starting out

    @@ -2584,7 +2584,7 @@ that activates your module. For example, swig -python foo.i. The messages from your new module should appear.

    -

    38.10.3 Command line options

    +

    39.10.3 Command line options

    @@ -2643,7 +2643,7 @@ to mark the option as valid. If you forget to do this, SWIG will terminate wit unrecognized command line option error.

    -

    38.10.4 Configuration and preprocessing

    +

    39.10.4 Configuration and preprocessing

    @@ -2692,7 +2692,7 @@ an implementation file python.cxx and a configuration file python.swg.

    -

    38.10.5 Entry point to code generation

    +

    39.10.5 Entry point to code generation

    @@ -2750,7 +2750,7 @@ int Python::top(Node *n) { -

    38.10.6 Module I/O and wrapper skeleton

    +

    39.10.6 Module I/O and wrapper skeleton

    @@ -2898,7 +2898,7 @@ functionWrapper : void Shape_y_set(Shape *self, double y) -

    38.10.7 Low-level code generators

    +

    39.10.7 Low-level code generators

    @@ -3052,7 +3052,7 @@ but without the typemaps, there is still work to do.

    -

    38.10.8 Configuration files

    +

    39.10.8 Configuration files

    @@ -3196,7 +3196,7 @@ politely displays the ignoring language message. -

    38.10.9 Runtime support

    +

    39.10.9 Runtime support

    @@ -3205,7 +3205,7 @@ Discuss the kinds of functions typically needed for SWIG runtime support (e.g. the SWIG files that implement those functions.

    -

    38.10.10 Standard library files

    +

    39.10.10 Standard library files

    @@ -3224,7 +3224,7 @@ The following are the minimum that are usually supported: Please copy these and modify for any new language.

    -

    38.10.11 User examples

    +

    39.10.11 User examples

    @@ -3253,7 +3253,7 @@ during this process, see the section on .

    -

    38.10.12 Test driven development and the test-suite

    +

    39.10.12 Test driven development and the test-suite

    @@ -3312,7 +3312,7 @@ It is therefore essential that the runtime tests are written in a manner that di but error/exception out with an error message on stderr on failure.

    -

    38.10.12.1 Running the test-suite

    +

    39.10.12.1 Running the test-suite

    @@ -3504,7 +3504,7 @@ It can be run in the same way as the other language test-suites, replacing [lang The test cases used and the way it works is described in Examples/test-suite/errors/Makefile.in.

    -

    38.10.13 Documentation

    +

    39.10.13 Documentation

    @@ -3536,7 +3536,7 @@ Some topics that you'll want to be sure to address include: if available. -

    38.10.14 Coding style guidelines

    +

    39.10.14 Coding style guidelines

    @@ -3561,7 +3561,7 @@ should be avoided as unlike the SWIG developers, users will never have consisten

    -

    38.10.15 Target language status

    +

    39.10.15 Target language status

    @@ -3570,7 +3570,7 @@ the Target language in This section provides more details on how this status is given.

    -

    38.10.15.1 Supported status

    +

    39.10.15.1 Supported status

    @@ -3617,7 +3617,7 @@ A target language is given the 'Supported' status when

    • -

    38.10.15.2 Experimental status

    +

    39.10.15.2 Experimental status

    @@ -3682,7 +3682,7 @@ Some minimum requirements and notes about languages with the 'Experimental' stat -

    38.10.16 Prerequisites for adding a new language module to the SWIG distribution

    +

    39.10.16 Prerequisites for adding a new language module to the SWIG distribution

    @@ -3746,7 +3746,7 @@ the existing tests.

    -

    38.11 Debugging Options

    +

    39.11 Debugging Options

    @@ -3773,7 +3773,7 @@ There are various command line options which can aid debugging a SWIG interface The complete list of command line options for SWIG are available by running swig -help.

    -

    38.12 Guide to parse tree nodes

    +

    39.12 Guide to parse tree nodes

    @@ -4181,7 +4181,7 @@ extern "X" { ... } declaration. -

    38.13 Further Development Information

    +

    39.13 Further Development Information

    diff --git a/Doc/Manual/Go.html b/Doc/Manual/Go.html index 8523f74aa..4a60e45e0 100644 --- a/Doc/Manual/Go.html +++ b/Doc/Manual/Go.html @@ -6,7 +6,7 @@ -

    23 SWIG and Go

    +

    24 SWIG and Go

    -

    23.3.1 Go-specific Commandline Options

    +

    24.3.1 Go-specific Commandline Options

    @@ -264,7 +264,7 @@ swig -go -help -

    23.3.2 Generated Wrapper Files

    +

    24.3.2 Generated Wrapper Files

    There are two different approaches to generating wrapper files, @@ -308,7 +308,7 @@ combined with the compiled MODULE.go using go tool pack. -

    23.4 A tour of basic C/C++ wrapping

    +

    24.4 A tour of basic C/C++ wrapping

    @@ -318,7 +318,7 @@ modifications have to occur. This section briefly covers the essential aspects of this wrapping.

    -

    23.4.1 Go Package Name

    +

    24.4.1 Go Package Name

    @@ -328,7 +328,7 @@ directive. You may override this by using SWIG's -package command line option.

    -

    23.4.2 Go Names

    +

    24.4.2 Go Names

    @@ -360,7 +360,7 @@ followed by that name, and the destructor will be named Delete followed by that name.

    -

    23.4.3 Go Constants

    +

    24.4.3 Go Constants

    @@ -368,7 +368,7 @@ C/C++ constants created via #define or the %constant directive become Go constants, declared with a const declaration. -

    23.4.4 Go Enumerations

    +

    24.4.4 Go Enumerations

    @@ -378,7 +378,7 @@ usual). The values of the enumeration will become variables in Go; code should avoid modifying those variables.

    -

    23.4.5 Go Classes

    +

    24.4.5 Go Classes

    @@ -456,7 +456,7 @@ returns a go interface. If the returned pointer can be null, you can check for this by calling the Swigcptr() method.

    -

    23.4.5.1 Go Class Memory Management

    +

    24.4.5.1 Go Class Memory Management

    @@ -578,7 +578,7 @@ func (o *GoClassName) Close() { -

    23.4.5.2 Go Class Inheritance

    +

    24.4.5.2 Go Class Inheritance

    @@ -590,7 +590,7 @@ Doing the reverse will require an explicit type assertion, which will be checked dynamically.

    -

    23.4.6 Go Templates

    +

    24.4.6 Go Templates

    @@ -599,7 +599,7 @@ wrappers for a particular template instantation. To do this, use the %template directive. -

    23.4.7 Go Director Classes

    +

    24.4.7 Go Director Classes

    @@ -617,7 +617,7 @@ completely to avoid common pitfalls with directors in Go.

    -

    23.4.7.1 Example C++ code

    +

    24.4.7.1 Example C++ code

    @@ -689,7 +689,7 @@ be found in the end of the guide.

    -

    23.4.7.2 Enable director feature

    +

    24.4.7.2 Enable director feature

    @@ -724,7 +724,7 @@ documentation on directors.

    -

    23.4.7.3 Constructor and destructor

    +

    24.4.7.3 Constructor and destructor

    @@ -777,7 +777,7 @@ embedding.

    -

    23.4.7.4 Override virtual methods

    +

    24.4.7.4 Override virtual methods

    @@ -843,7 +843,7 @@ the Go methods.

    -

    23.4.7.5 Call base methods

    +

    24.4.7.5 Call base methods

    @@ -880,7 +880,7 @@ be found in the end of the guide.

    -

    23.4.7.6 Subclass via embedding

    +

    24.4.7.6 Subclass via embedding

    @@ -948,7 +948,7 @@ class.

    -

    23.4.7.7 Memory management with runtime.SetFinalizer

    +

    24.4.7.7 Memory management with runtime.SetFinalizer

    @@ -1013,7 +1013,7 @@ before using runtime.SetFinalizer to know all of its gotchas.

    -

    23.4.7.8 Complete FooBarGo example class

    +

    24.4.7.8 Complete FooBarGo example class

    @@ -1142,7 +1142,7 @@ SWIG/Examples/go/director/.

    -

    23.4.8 Default Go primitive type mappings

    +

    24.4.8 Default Go primitive type mappings

    @@ -1249,7 +1249,7 @@ that typemap, or add new values, to control how C/C++ types are mapped into Go types.

    -

    23.4.9 Output arguments

    +

    24.4.9 Output arguments

    Because of limitations in the way output arguments are processed in swig, @@ -1302,7 +1302,7 @@ void f(char *output); -

    23.4.10 Adding additional go code

    +

    24.4.10 Adding additional go code

    Often the APIs generated by swig are not very natural in go, especially if @@ -1397,7 +1397,7 @@ func bar() { -

    23.4.11 Go typemaps

    +

    24.4.11 Go typemaps

    diff --git a/Doc/Manual/Guile.html b/Doc/Manual/Guile.html index 6acdd2dc3..31d822599 100644 --- a/Doc/Manual/Guile.html +++ b/Doc/Manual/Guile.html @@ -8,7 +8,7 @@ -

    24 SWIG and Guile

    +

    25 SWIG and Guile

      @@ -48,7 +48,7 @@

      This section details guile-specific support in SWIG. -

      24.1 Supported Guile Versions

      +

      25.1 Supported Guile Versions

      @@ -62,7 +62,7 @@ improved performance. This is currently not tested with swig so your mileage may vary. To be safe set environment variable GUILE_AUTO_COMPILE to 0 when using swig generated guile code. -

      24.2 Meaning of "Module"

      +

      25.2 Meaning of "Module"

      @@ -70,7 +70,7 @@ There are three different concepts of "module" involved, defined separately for SWIG, Guile, and Libtool. To avoid horrible confusion, we explicitly prefix the context, e.g., "guile-module". -

      24.3 Old GH Guile API

      +

      25.3 Old GH Guile API

      Guile 1.8 and older could be interfaced using two different api's, the SCM @@ -81,7 +81,7 @@ or the GH API. The GH interface to guile is deprecated. Read more about why in version of SWIG that can still generate guile GH wrapper code is 2.0.9. Please use that version if you really need the GH wrapper code. -

      24.4 Linkage

      +

      25.4 Linkage

      @@ -89,7 +89,7 @@ Guile support is complicated by a lack of user community cohesiveness, which manifests in multiple shared-library usage conventions. A set of policies implementing a usage convention is called a linkage. -

      24.4.1 Simple Linkage

      +

      25.4.1 Simple Linkage

      @@ -194,7 +194,7 @@ placed between the define-module form and the SWIG_init via a preprocessor define to avoid symbol clashes. For this case, however, passive linkage is available. -

      24.4.2 Passive Linkage

      +

      25.4.2 Passive Linkage

      Passive linkage is just like simple linkage, but it generates an @@ -204,7 +204,7 @@ package name (see below).

      You should use passive linkage rather than simple linkage when you are using multiple modules. -

      24.4.3 Native Guile Module Linkage

      +

      25.4.3 Native Guile Module Linkage

      SWIG can also generate wrapper code that does all the Guile module @@ -245,7 +245,7 @@ Newer Guile versions have a shorthand procedure for this:

    -

    24.4.4 Old Auto-Loading Guile Module Linkage

    +

    25.4.4 Old Auto-Loading Guile Module Linkage

    Guile used to support an autoloading facility for object-code @@ -271,7 +271,7 @@ option, SWIG generates an exported module initialization function with an appropriate name. -

    24.4.5 Hobbit4D Linkage

    +

    25.4.5 Hobbit4D Linkage

    @@ -296,7 +296,7 @@ my/lib/libfoo.so.X.Y.Z and friends. This scheme is still very experimental; the (hobbit4d link) conventions are not well understood.

    -

    24.5 Underscore Folding

    +

    25.5 Underscore Folding

    @@ -308,7 +308,7 @@ complained so far. %rename to specify the Guile name of the wrapped functions and variables (see CHANGES). -

    24.6 Typemaps

    +

    25.6 Typemaps

    @@ -400,7 +400,7 @@ constant will appear as a scheme variable. See Features and the %feature directive for info on how to apply the %feature.

    -

    24.7 Representation of pointers as smobs

    +

    25.7 Representation of pointers as smobs

    @@ -421,7 +421,7 @@ representing the expected pointer type. See also If the Scheme object passed was not a SWIG smob representing a compatible pointer, a wrong-type-arg exception is raised. -

    24.7.1 Smobs

    +

    25.7.1 Smobs

    @@ -440,7 +440,7 @@ structure describing this type. If a generated GOOPS module has been loaded, sm the corresponding GOOPS class.

    -

    24.7.2 Garbage Collection

    +

    25.7.2 Garbage Collection

    Garbage collection is a feature of Guile since version 1.6. As SWIG now requires Guile > 1.8, @@ -454,14 +454,14 @@ is exactly like described in 24.8 Native Guile pointers +

    25.8 Native Guile pointers

    In addition to SWIG smob pointers, Guile's native pointer type are accepted as arguments to wrapped SWIG functions. This can be useful for passing pointers to bytevector data to wrapped functions.

    -

    24.9 Exception Handling

    +

    25.9 Exception Handling

    @@ -487,7 +487,7 @@ mapping: The default when not specified here is to use "swig-error". See Lib/exception.i for details. -

    24.10 Procedure documentation

    +

    25.10 Procedure documentation

    If invoked with the command-line option -procdoc @@ -522,7 +522,7 @@ like this: typemap argument doc. See Lib/guile/typemaps.i for details. -

    24.11 Procedures with setters

    +

    25.11 Procedures with setters

    For global variables, SWIG creates a single wrapper procedure @@ -550,7 +550,7 @@ struct members, the procedures (struct-member-get pointer) and (struct-member-set pointer value) are not generated. -

    24.12 GOOPS Proxy Classes

    +

    25.12 GOOPS Proxy Classes

    SWIG can also generate classes and generic functions for use with @@ -696,7 +696,7 @@ Notice that <Foo> is used before it is defined. The fix is to just put th %import "foo.h" before the %inline block.

    -

    24.12.1 Naming Issues

    +

    25.12.1 Naming Issues

    As you can see in the example above, there are potential naming conflicts. The default exported @@ -733,7 +733,7 @@ guile-modules. For example,

    (use-modules ((Test) #:renamer (symbol-prefix-proc 'goops:))) -

    24.12.2 Linking

    +

    25.12.2 Linking

    The guile-modules generated above all need to be linked together. GOOPS support requires diff --git a/Doc/Manual/Java.html b/Doc/Manual/Java.html index 77a81995e..4c7b6d058 100644 --- a/Doc/Manual/Java.html +++ b/Doc/Manual/Java.html @@ -6,7 +6,7 @@ -

    25 SWIG and Java

    +

    26 SWIG and Java

    -

    25.3.3 Global variables

    +

    26.3.3 Global variables

    @@ -816,7 +816,7 @@ extern char *path; // Read-only (due to %immutable) -

    25.3.4 Constants

    +

    26.3.4 Constants

    @@ -956,7 +956,7 @@ Or if you decide this practice isn't so bad and your own class implements ex

    -

    25.3.5 Enumerations

    +

    26.3.5 Enumerations

    @@ -970,7 +970,7 @@ The final two approaches use simple integers for each enum item. Before looking at the various approaches for wrapping named C/C++ enums, anonymous enums are considered.

    -

    25.3.5.1 Anonymous enums

    +

    26.3.5.1 Anonymous enums

    @@ -1033,7 +1033,7 @@ As in the case of constants, you can access them through either the module class

    -

    25.3.5.2 Typesafe enums

    +

    26.3.5.2 Typesafe enums

    @@ -1127,7 +1127,7 @@ When upgrading to JDK 1.5 or later, proper Java enums could be used instead, wit The following section details proper Java enum generation.

    -

    25.3.5.3 Proper Java enums

    +

    26.3.5.3 Proper Java enums

    @@ -1180,7 +1180,7 @@ The additional support methods need not be generated if none of the enum items h Simpler Java enums for enums without initializers section.

    -

    25.3.5.4 Type unsafe enums

    +

    26.3.5.4 Type unsafe enums

    @@ -1228,7 +1228,7 @@ Note that unlike typesafe enums, this approach requires users to mostly use diff Thus the upgrade path to proper enums provided in JDK 1.5 is more painful.

    -

    25.3.5.5 Simple enums

    +

    26.3.5.5 Simple enums

    @@ -1247,7 +1247,7 @@ SWIG-1.3.21 and earlier versions wrapped all enums using this approach. The type unsafe approach is preferable to this one and this simple approach is only included for backwards compatibility with these earlier versions of SWIG.

    -

    25.3.6 Pointers

    +

    26.3.6 Pointers

    @@ -1335,7 +1335,7 @@ C-style cast may return a bogus result whereas as the C++-style cast will return a NULL pointer if the conversion can't be performed.

    -

    25.3.7 Structures

    +

    26.3.7 Structures

    @@ -1503,7 +1503,7 @@ x.setA(3); // Modify x.a - this is the same as b.f.a -

    25.3.8 C++ classes

    +

    26.3.8 C++ classes

    @@ -1566,7 +1566,7 @@ int bar = Spam.getBar(); -

    25.3.9 C++ inheritance

    +

    26.3.9 C++ inheritance

    @@ -1627,7 +1627,7 @@ Note that Java does not support multiple inheritance so any multiple inheritance A warning is given when multiple inheritance is detected and only the first base class is used.

    -

    25.3.10 Pointers, references, arrays and pass by value

    +

    26.3.10 Pointers, references, arrays and pass by value

    @@ -1682,7 +1682,7 @@ to hold the result and a pointer is returned (Java will release this memory when the returned object's finalizer is run by the garbage collector).

    -

    25.3.10.1 Null pointers

    +

    26.3.10.1 Null pointers

    @@ -1706,7 +1706,7 @@ For spam1 and spam4 above the Java null gets translat The converse also occurs, that is, NULL pointers are translated into null Java objects when returned from a C/C++ function.

    -

    25.3.11 C++ overloaded functions

    +

    26.3.11 C++ overloaded functions

    @@ -1821,7 +1821,7 @@ void spam(unsigned short); // Ignored -

    25.3.12 C++ default arguments

    +

    26.3.12 C++ default arguments

    @@ -1864,7 +1864,7 @@ Further details on default arguments and how to restore this approach are given

    -

    25.3.13 C++ namespaces

    +

    26.3.13 C++ namespaces

    @@ -1954,7 +1954,7 @@ If the resulting use of the nspace feature and hence packages results in a proxy you will need to open up the visibility for the pointer constructor and getCPtr method from the default 'protected' to 'public' with the SWIG_JAVABODY_PROXY macro. See Java code typemaps.

    -

    25.3.14 C++ templates

    +

    26.3.14 C++ templates

    @@ -2003,10 +2003,10 @@ Obviously, there is more to template wrapping than shown in this example. More details can be found in the SWIG and C++ chapter.

    -

    25.3.15 C++ Smart Pointers

    +

    26.3.15 C++ Smart Pointers

    -

    25.3.15.1 The shared_ptr Smart Pointer

    +

    26.3.15.1 The shared_ptr Smart Pointer

    @@ -2017,7 +2017,7 @@ in the shared_ptr smart pointer -

    25.3.15.2 Generic Smart Pointers

    +

    26.3.15.2 Generic Smart Pointers

    @@ -2101,7 +2101,7 @@ Foo f = p.__deref__(); // Returns underlying Foo * -

    25.4 Further details on the generated Java classes

    +

    26.4 Further details on the generated Java classes

    @@ -2116,7 +2116,7 @@ Finally enum classes are covered. First, the crucial intermediary JNI class is considered.

    -

    25.4.1 The intermediary JNI class

    +

    26.4.1 The intermediary JNI class

    @@ -2236,7 +2236,7 @@ If name is the same as modulename then the module class name g from modulename to modulenameModule.

    -

    25.4.1.1 The intermediary JNI class pragmas

    +

    26.4.1.1 The intermediary JNI class pragmas

    @@ -2318,7 +2318,7 @@ For example, let's change the intermediary JNI class access to just the default All the methods in the intermediary JNI class will then not be callable outside of the package as the method modifiers have been changed from public access to default access. This is useful if you want to prevent users calling these low level functions.

    -

    25.4.2 The Java module class

    +

    26.4.2 The Java module class

    @@ -2349,7 +2349,7 @@ example.egg(new Foo()); The primary reason for having the module class wrapping the calls in the intermediary JNI class is to implement static type checking. In this case only a Foo can be passed to the egg function, whereas any long can be passed to the egg function in the intermediary JNI class.

    -

    25.4.2.1 The Java module class pragmas

    +

    26.4.2.1 The Java module class pragmas

    @@ -2400,7 +2400,7 @@ See The intermediary JNI class pragmas secti

    -

    25.4.3 Java proxy classes

    +

    26.4.3 Java proxy classes

    @@ -2476,7 +2476,7 @@ int y = f.spam(5, new Foo()); -

    25.4.3.1 Memory management

    +

    26.4.3.1 Memory management

    @@ -2638,7 +2638,7 @@ and

    -

    25.4.3.2 Inheritance

    +

    26.4.3.2 Inheritance

    @@ -2754,7 +2754,7 @@ However, true cross language polymorphism can be achieved using the 25.4.3.3 Proxy classes and garbage collection +

    26.4.3.3 Proxy classes and garbage collection

    @@ -2837,7 +2837,7 @@ The section on Java typemaps details how to specify See the How to Handle Java Finalization's Memory-Retention Issues article for alternative approaches to managing memory by avoiding finalizers altogether.

    -

    25.4.3.4 The premature garbage collection prevention parameter for proxy class marshalling

    +

    26.4.3.4 The premature garbage collection prevention parameter for proxy class marshalling

    @@ -2959,7 +2959,7 @@ For example: Compatibility note: The generation of this additional parameter did not occur in versions prior to SWIG-1.3.30.

    -

    25.4.3.5 Single threaded applications and thread safety

    +

    26.4.3.5 Single threaded applications and thread safety

    @@ -3047,7 +3047,7 @@ for (int i=0; i<100000; i++) { -

    25.4.4 Type wrapper classes

    +

    26.4.4 Type wrapper classes

    @@ -3134,7 +3134,7 @@ public static void spam(SWIGTYPE_p_int x, SWIGTYPE_p_int y, int z) { ... } -

    25.4.5 Enum classes

    +

    26.4.5 Enum classes

    @@ -3143,7 +3143,7 @@ The Enumerations section discussed these but om The following sub-sections detail the various types of enum classes that can be generated.

    -

    25.4.5.1 Typesafe enum classes

    +

    26.4.5.1 Typesafe enum classes

    @@ -3227,7 +3227,7 @@ The swigValue method is used for marshalling in the other direction. The toString method is overridden so that the enum name is available.

    -

    25.4.5.2 Proper Java enum classes

    +

    26.4.5.2 Proper Java enum classes

    @@ -3305,7 +3305,7 @@ These needn't be generated if the enum being wrapped does not have any initializ Simpler Java enums for enums without initializers section describes how typemaps can be used to achieve this.

    -

    25.4.5.3 Type unsafe enum classes

    +

    26.4.5.3 Type unsafe enum classes

    @@ -3336,7 +3336,7 @@ public final class Beverage { -

    25.4.6 Interfaces

    +

    26.4.6 Interfaces

    @@ -3581,7 +3581,7 @@ typemap which is only used when a class is marked with the interface fe See Java code typemaps for details.

    -

    25.5 Cross language polymorphism using directors

    +

    26.5 Cross language polymorphism using directors

    @@ -3603,7 +3603,7 @@ The upshot is that C++ classes can be extended in Java and from C++ these extens Neither C++ code nor Java code needs to know where a particular method is implemented: the combination of proxy classes, director classes, and C wrapper functions transparently takes care of all the cross-language method routing.

    -

    25.5.1 Enabling directors

    +

    26.5.1 Enabling directors

    @@ -3671,7 +3671,7 @@ public: -

    25.5.2 Director classes

    +

    26.5.2 Director classes

    @@ -3698,7 +3698,7 @@ If the correct implementation is in Java, the Java API is used to call the metho

    -

    25.5.3 Overhead and code bloat

    +

    26.5.3 Overhead and code bloat

    @@ -3716,7 +3716,7 @@ This situation can be optimized by selectively enabling director methods (using

    -

    25.5.4 Simple directors example

    +

    26.5.4 Simple directors example

    @@ -3779,7 +3779,7 @@ DirectorDerived.upcall_method() invoked. -

    25.5.5 Director threading issues

    +

    26.5.5 Director threading issues

    @@ -3799,7 +3799,7 @@ Macros can be defined on the commandline when compiling your C++ code, or altern -

    25.5.6 Director performance tuning

    +

    26.5.6 Director performance tuning

    @@ -3820,7 +3820,7 @@ However, if all director methods are expected to usually be overridden by Java s The disadvantage is that invocation of director methods from C++ when Java doesn't actually override the method will require an additional call up into Java and back to C++. As such, this option is only useful when overrides are extremely common and instantiation is frequent enough that its performance is critical.

    -

    25.5.7 Java exceptions from directors

    +

    26.5.7 Java exceptions from directors

    @@ -3896,7 +3896,7 @@ Exception in thread "main" java.lang.RuntimeException: There was a problem! More on the Swig::DirectorException class can be found in the next section which details how to customize the handling of director exceptions.

    -

    25.5.7.1 Customizing director exceptions

    +

    26.5.7.1 Customizing director exceptions

    @@ -4454,7 +4454,7 @@ Exception in thread "main" java.lang.IndexOutOfBoundsException: Index is negativ -

    25.6 Accessing protected members

    +

    26.6 Accessing protected members

    @@ -4550,7 +4550,7 @@ class MyProtectedBase extends ProtectedBase -

    25.7 Common customization features

    +

    26.7 Common customization features

    @@ -4562,7 +4562,7 @@ be awkward. This section describes some common SWIG features that are used to improve the interface to existing C/C++ code.

    -

    25.7.1 C/C++ helper functions

    +

    26.7.1 C/C++ helper functions

    @@ -4628,7 +4628,7 @@ hard to implement. It is possible to improve on this using Java code, typemaps, customization features as covered in later sections, but sometimes helper functions are a quick and easy solution to difficult cases.

    -

    25.7.2 Class extension with %extend

    +

    26.7.2 Class extension with %extend

    @@ -4691,7 +4691,7 @@ Vector(2, 3, 4) in any way---the extensions only show up in the Java interface.

    -

    25.7.3 Class extension with %proxycode

    +

    26.7.3 Class extension with %proxycode

    @@ -4828,7 +4828,7 @@ public class ValueUnsignedInt { -

    25.7.4 Exception handling with %exception and %javaexception

    +

    26.7.4 Exception handling with %exception and %javaexception

    @@ -4987,7 +4987,7 @@ to raise exceptions. See the SWIG Library ch The typemap example Handling C++ exception specifications as Java exceptions provides further exception handling capabilities.

    -

    25.7.5 Method access with %javamethodmodifiers

    +

    26.7.5 Method access with %javamethodmodifiers

    @@ -5013,7 +5013,7 @@ protected static void protect_me() { -

    25.8 Tips and techniques

    +

    26.8 Tips and techniques

    @@ -5023,7 +5023,7 @@ strings and arrays. This chapter discusses the common techniques for solving these problems.

    -

    25.8.1 Input and output parameters using primitive pointers and references

    +

    26.8.1 Input and output parameters using primitive pointers and references

    @@ -5197,7 +5197,7 @@ void foo(Bar *OUTPUT); will not have the intended effect since typemaps.i does not define an OUTPUT rule for Bar.

    -

    25.8.2 Simple pointers

    +

    26.8.2 Simple pointers

    @@ -5263,7 +5263,7 @@ System.out.println("3 + 4 = " + result); See the SWIG Library chapter for further details.

    -

    25.8.3 Wrapping C arrays with Java arrays

    +

    26.8.3 Wrapping C arrays with Java arrays

    @@ -5330,7 +5330,7 @@ Please be aware that the typemaps in this library are not efficient as all the e There is an alternative approach using the SWIG array library and this is covered in the next section.

    -

    25.8.4 Unbounded C Arrays

    +

    26.8.4 Unbounded C Arrays

    @@ -5475,7 +5475,7 @@ well suited for applications in which you need to create buffers, package binary data, etc.

    -

    25.8.5 Binary data vs Strings

    +

    26.8.5 Binary data vs Strings

    @@ -5519,7 +5519,7 @@ len: 5 data: 68 69 0 6a 6b -

    25.8.6 Overriding new and delete to allocate from Java heap

    +

    26.8.6 Overriding new and delete to allocate from Java heap

    @@ -5636,7 +5636,7 @@ model and use these functions in place of malloc and free in your own code.

    -

    25.9 Java typemaps

    +

    26.9 Java typemaps

    @@ -5657,7 +5657,7 @@ Before proceeding, it should be stressed that typemaps are not a required part of using SWIG---the default wrapping behavior is enough in most cases. Typemaps are only used if you want to change some aspect of the generated code. -

    25.9.1 Default primitive type mappings

    +

    26.9.1 Default primitive type mappings

    @@ -5809,7 +5809,7 @@ However, the mappings allow the full range of values for each C type from Java.

    -

    25.9.2 Default typemaps for non-primitive types

    +

    26.9.2 Default typemaps for non-primitive types

    @@ -5824,7 +5824,7 @@ So in summary, the C/C++ pointer to non-primitive types is cast into the 64 bit The Java type is either the proxy class or type wrapper class.

    -

    25.9.3 Sixty four bit JVMs

    +

    26.9.3 Sixty four bit JVMs

    @@ -5837,7 +5837,7 @@ Unfortunately it won't of course hold true for JNI code.

    -

    25.9.4 What is a typemap?

    +

    26.9.4 What is a typemap?

    @@ -5960,7 +5960,7 @@ int c = example.count('e', "Hello World"); -

    25.9.5 Typemaps for mapping C/C++ types to Java types

    +

    26.9.5 Typemaps for mapping C/C++ types to Java types

    @@ -6240,7 +6240,7 @@ These are listed below: -

    25.9.6 Java typemap attributes

    +

    26.9.6 Java typemap attributes

    @@ -6286,7 +6286,7 @@ The "javain" typemap has the optional 'pre', 'post' and 'pgcppname' attributes. Note that when the 'pre' or 'post' attributes are specified and the associated type is used in a constructor, a constructor helper function is generated. This is necessary as the Java proxy constructor wrapper makes a call to a support constructor using a this call. In Java the this call must be the first statement in the constructor body. The constructor body thus calls the helper function and the helper function instead makes the JNI call, ensuring the 'pre' code is called before the JNI call is made. There is a Date marshalling example showing 'pre', 'post' and 'pgcppname' attributes in action.

    -

    25.9.7 Java special variables

    +

    26.9.7 Java special variables

    @@ -6468,7 +6468,7 @@ in that it is not fully qualified with the package name when using the nspace feature.

    -

    25.9.8 Typemaps for both C and C++ compilation

    +

    26.9.8 Typemaps for both C and C++ compilation

    @@ -6505,7 +6505,7 @@ If you do not intend your code to be targeting both C and C++ then your typemaps

    -

    25.9.9 Java code typemaps

    +

    26.9.9 Java code typemaps

    @@ -6801,7 +6801,7 @@ to make the method and constructor public: -

    25.9.10 Director specific typemaps

    +

    26.9.10 Director specific typemaps

    @@ -7078,7 +7078,7 @@ The basic strategy here is to provide a default package typemap for the majority -

    25.10 Typemap Examples

    +

    26.10 Typemap Examples

    @@ -7088,7 +7088,7 @@ the SWIG library.

    -

    25.10.1 Simpler Java enums for enums without initializers

    +

    26.10.1 Simpler Java enums for enums without initializers

    @@ -7167,7 +7167,7 @@ This would be done by using the original versions of these typemaps in "enums.sw

    -

    25.10.2 Handling C++ exception specifications as Java exceptions

    +

    26.10.2 Handling C++ exception specifications as Java exceptions

    @@ -7292,7 +7292,7 @@ We could alternatively have used %rename to rename what() into

    -

    25.10.3 NaN Exception - exception handling for a particular type

    +

    26.10.3 NaN Exception - exception handling for a particular type

    @@ -7447,7 +7447,7 @@ If we were a martyr to the JNI cause, we could replace the succinct code within If we had, we would have put it in the "in" typemap which, like all JNI and Java typemaps, also supports the 'throws' attribute.

    -

    25.10.4 Converting Java String arrays to char **

    +

    26.10.4 Converting Java String arrays to char **

    @@ -7591,7 +7591,7 @@ Lastly the "jni", "jtype" and "jstype" typemaps are also required to specify what Java types to use.

    -

    25.10.5 Expanding a Java object to multiple arguments

    +

    26.10.5 Expanding a Java object to multiple arguments

    @@ -7673,7 +7673,7 @@ example.foo(new String[]{"red", "green", "blue", "white"}); -

    25.10.6 Using typemaps to return arguments

    +

    26.10.6 Using typemaps to return arguments

    @@ -7791,7 +7791,7 @@ $ java runme 1 12.0 340.0 -

    25.10.7 Adding Java downcasts to polymorphic return types

    +

    26.10.7 Adding Java downcasts to polymorphic return types

    @@ -7997,7 +7997,7 @@ SWIG usually generates code which constructs the proxy classes using Java code a Note that the JNI code above uses a number of string lookups to call a constructor, whereas this would not occur using byte compiled Java code.

    -

    25.10.8 Adding an equals method to the Java classes

    +

    26.10.8 Adding an equals method to the Java classes

    @@ -8041,7 +8041,7 @@ System.out.println("foo1? " + foo1.equals(foo2)); -

    25.10.9 Void pointers and a common Java base class

    +

    26.10.9 Void pointers and a common Java base class

    @@ -8100,7 +8100,7 @@ This example contains some useful functionality which you may want in your code.

  • It also has a function which effectively implements a cast from the type of the proxy/type wrapper class to a void pointer. This is necessary for passing a proxy class or a type wrapper class to a function that takes a void pointer. -

    25.10.10 Struct pointer to pointer

    +

    26.10.10 Struct pointer to pointer

    @@ -8280,7 +8280,7 @@ The C functional interface has been completely morphed into an object-oriented i the Butler class would behave much like any pure Java class and feel more natural to Java users.

    -

    25.10.11 Memory management when returning references to member variables

    +

    26.10.11 Memory management when returning references to member variables

    @@ -8403,7 +8403,7 @@ public class Bike { Note the addReference call.

    -

    25.10.12 Memory management for objects passed to the C++ layer

    +

    26.10.12 Memory management for objects passed to the C++ layer

    @@ -8531,7 +8531,7 @@ as mentioned earlier, setElement is actually: -

    25.10.13 Date marshalling using the javain typemap and associated attributes

    +

    26.10.13 Date marshalling using the javain typemap and associated attributes

    @@ -8708,7 +8708,7 @@ A few things to note: -

    25.11 Living with Java Directors

    +

    26.11 Living with Java Directors

    @@ -8887,10 +8887,10 @@ public abstract class UserVisibleFoo extends Foo {

    • -

    25.12 Odds and ends

    +

    26.12 Odds and ends

    -

    25.12.1 JavaDoc comments

    +

    26.12.1 JavaDoc comments

    @@ -8946,7 +8946,7 @@ public class Barmy { -

    25.12.2 Functional interface without proxy classes

    +

    26.12.2 Functional interface without proxy classes

    @@ -9007,7 +9007,7 @@ All destructors have to be called manually for example the delete_Foo(foo) -

    25.12.3 Using your own JNI functions

    +

    26.12.3 Using your own JNI functions

    @@ -9057,7 +9057,7 @@ This directive is only really useful if you want to mix your own hand crafted JN

    -

    25.12.4 Performance concerns and hints

    +

    26.12.4 Performance concerns and hints

    @@ -9078,7 +9078,7 @@ However, you will have to be careful about memory management and make sure that This method normally calls the C++ destructor or free() for C code.

    -

    25.12.5 Debugging

    +

    26.12.5 Debugging

    @@ -9100,7 +9100,7 @@ The -verbose:jni and -verbose:gc are also useful options for monitoring code beh

    -

    25.13 Java Examples

    +

    26.13 Java Examples

    diff --git a/Doc/Manual/Javascript.html b/Doc/Manual/Javascript.html index 8de528511..c328bbb6b 100644 --- a/Doc/Manual/Javascript.html +++ b/Doc/Manual/Javascript.html @@ -7,7 +7,7 @@ -

    26 SWIG and Javascript

    +

    27 SWIG and Javascript

      @@ -52,7 +52,7 @@

      This chapter describes SWIG's support of Javascript. It does not cover SWIG basics, but only information that is specific to this module.

      -

      26.1 Overview

      +

      27.1 Overview

      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. @@ -63,10 +63,10 @@ Javascript has gone beyond being a browser-based scripting language and with node-webkit there is a platform which uses Google's Chromium as Web-Browser widget and node.js for javascript extensions.

      -

      26.2 Preliminaries

      +

      27.2 Preliminaries

      -

      26.2.1 Running SWIG

      +

      27.2.1 Running SWIG

      Suppose that you defined a SWIG module such as the following:

      @@ -121,7 +121,7 @@ void example_initialize(v8::Handle<v8::Object> exports) Note: be aware that v8 has a C++ API, and thus, the generated modules must be compiled as C++.

      -

      26.2.2 Running Tests and Examples

      +

      27.2.2 Running Tests and Examples

      The configuration for tests and examples currently supports Linux and Mac only and not MinGW (Windows) yet.

      @@ -153,7 +153,7 @@ $ make check-javascript-test-suite ENGINE=jsc $ make check-javascript-examples V8_VERSION=0x032530 ENGINE=v8
    -

    26.2.3 Known Issues

    +

    27.2.3 Known Issues

    At the moment, the Javascript generators pass all tests syntactically, i.e., the generated source code compiles. However, there are still remaining runtime issues.

    @@ -170,12 +170,12 @@ $ make check-javascript-examples V8_VERSION=0x032530 ENGINE=v8

    The primary development environment has been Linux (Ubuntu 12.04). Windows and Mac OS X have been tested sporadically. Therefore, the generators might have more issues on those platforms. Please report back any problem you observe to help us improving this module quickly.

    -

    26.3 Integration

    +

    27.3 Integration

    This chapter gives a short introduction how to use a native Javascript extension: as a node.js module, and as an extension for an embedded Webkit.

    -

    26.3.1 Creating node.js Extensions

    +

    27.3.1 Creating node.js Extensions

    To install node.js you can download an installer from their web-site for Mac OS X and Windows. For Linux you can either build the source yourself and run sudo checkinstall or keep to the (probably stone-age) packaged version. For Ubuntu there is a PPA available.

    @@ -221,7 +221,7 @@ require("./build/Release/example")

    A more detailed explanation is given in the Examples section.

    -

    26.3.1.1 Troubleshooting

    +

    27.3.1.1 Troubleshooting

      @@ -233,12 +233,12 @@ require("./build/Release/example") $ sudo apt-get remove gyp -

      26.3.2 Embedded Webkit

      +

      27.3.2 Embedded Webkit

      Webkit is pre-installed on Mac OS X and available as a library for GTK.

      -

      26.3.2.1 Mac OS X

      +

      27.3.2.1 Mac OS X

      There is general information about programming with WebKit on Apple Developer Documentation. Details about Cocoa programming are not covered here.

      @@ -286,7 +286,7 @@ extern bool example_initialize(JSGlobalContextRef context, JSObjectRef* exports) @end -

      26.3.2.2 GTK

      +

      27.3.2.2 GTK

      There is general information about programming GTK at GTK documentation and in the GTK tutorial, and for Webkit there is a Webkit GTK+ API Reference.

      @@ -331,7 +331,7 @@ int main(int argc, char* argv[]) } -

      26.3.3 Creating Applications with node-webkit

      +

      27.3.3 Creating Applications with node-webkit

      To get started with node-webkit there is a very informative set of wiki pages.

      @@ -422,12 +422,12 @@ open new windows, and many more things. }; -

      26.4 Examples

      +

      27.4 Examples

      Some basic examples are shown here in more detail.

      -

      26.4.1 Simple

      +

      27.4.1 Simple

      The common example simple looks like this:

      @@ -477,7 +477,7 @@ example.Foo = 3.1415926;

      Note: ECMAScript 5, the currently implemented Javascript standard, does not have modules. node.js and other implementations provide this mechanism defined by the CommonJS group. For browsers this is provided by Browserify, for instance.

      -

      26.4.2 Class

      +

      27.4.2 Class

      The common example class defines three classes, Shape, Circle, and Square:

      @@ -607,12 +607,12 @@ at emitKey (readline.js:1095:12) Note: 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 prototype 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 Inheritance and the prototype chain, for instance.

      -

      26.5 Implementation

      +

      27.5 Implementation

      The Javascript Module implementation has taken a very different approach compared to other language modules in order to support different Javascript interpreters.

      -

      26.5.1 Source Code

      +

      27.5.1 Source Code

      The Javascript module is implemented in Source/Modules/javascript.cxx. It dispatches the code generation to a JSEmitter instance, V8Emitter or JSCEmitter. Additionally there are some helpers: Template, for templated code generation, and JSEmitterState, 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:

      @@ -713,7 +713,7 @@ Template::Template(const String *code_) { ... } ... -

      26.5.2 Code Templates

      +

      27.5.2 Code Templates

      All generated code is created on the basis of code templates. The templates for JavascriptCore can be found in Lib/javascript/jsc/javascriptcode.swg, for v8 in Lib/javascript/v8/javascriptcode.swg.

      @@ -752,7 +752,7 @@ t_register.replace("$jsparent", state.clazz(NAME_MANGLED))

      Template creates a copy of that string and Template::replace uses Swig's Replaceall to replace variables in the template. Template::trim can be used to eliminate leading and trailing whitespaces. Template::print is used to write the final template string to a Swig DOH (based on Printv). All methods allow chaining.

      -

      26.5.3 Emitter

      +

      27.5.3 Emitter

      The Javascript module delegates code generation to a JSEmitter instance. The following extract shows the essential interface:

      @@ -871,7 +871,7 @@ int JAVASCRIPT::classHandler(Node *n) {

      In enterClass the emitter stores state information that is necessary when processing class members. In exitClass the wrapper code for the whole class is generated.

      -

      26.5.4 Emitter states

      +

      27.5.4 Emitter states

      For storing information during the AST traversal the emitter provides a JSEmitterState with different slots to store data representing the scopes global, class, function, and variable.

      @@ -915,7 +915,7 @@ state.clazz(NAME, Getattr(n, "sym:name"));

      State information can be retrieved using state.clazz(NAME) or with Getattr on state.clazz() which actually returns a Hash instance.

      -

      26.5.5 Handling Exceptions in JavascriptCore

      +

      27.5.5 Handling Exceptions in JavascriptCore

      Applications with an embedded JavascriptCore should be able to present detailed exception messages that occur in the Javascript engine. Below is an example derived from code provided by Brian Barnes on how these exception details can be extracted.

      diff --git a/Doc/Manual/Library.html b/Doc/Manual/Library.html index c2c02fc7d..4ef6aeb83 100644 --- a/Doc/Manual/Library.html +++ b/Doc/Manual/Library.html @@ -7,7 +7,7 @@ -

      10 SWIG library

      +

      11 SWIG library

      -

      10.2.4 cdata.i

      +

      11.2.4 cdata.i

      @@ -769,7 +769,7 @@ char *cdata_name(type* ptr, int nitems) Clearly they are unsafe.

      -

      10.3 C string handling

      +

      11.3 C string handling

      @@ -789,7 +789,7 @@ morality. The modules in this section provide basic functionality for manipulating raw C strings.

      -

      10.3.1 Default string handling

      +

      11.3.1 Default string handling

      @@ -830,7 +830,7 @@ interpreter and lead to a crash). Furthermore, the default behavior does not work well with binary data. Instead, strings are assumed to be NULL-terminated.

      -

      10.3.2 Passing binary data

      +

      11.3.2 Passing binary data

      @@ -872,7 +872,7 @@ In the wrapper function, the passed string will be expanded to a pointer and len The (char *STRING, int LENGTH) multi-argument typemap is also available in addition to (char *STRING, size_t LENGTH).

      -

      10.3.3 Using %newobject to release memory

      +

      11.3.3 Using %newobject to release memory

      @@ -913,7 +913,7 @@ however, you may need to provide your own "newfree" typemap for other types. See Object ownership and %newobject for more details.

      -

      10.3.4 cstring.i

      +

      11.3.4 cstring.i

      @@ -1373,7 +1373,7 @@ structure or class instead.

    -

    10.4 STL/C++ library

    +

    11.4 STL/C++ library

    @@ -1420,7 +1420,7 @@ Please look for the library files in the appropriate language library directory.

    -

    10.4.1 std::string

    +

    11.4.1 std::string

    @@ -1504,7 +1504,7 @@ void foo(string s, const String &t); // std_string typemaps still applie -

    10.4.2 std::vector

    +

    11.4.2 std::vector

    @@ -1683,7 +1683,7 @@ if you want to make their head explode. details and the public API exposed to the interpreter vary.

    -

    10.4.3 STL exceptions

    +

    11.4.3 STL exceptions

    @@ -1733,10 +1733,10 @@ The %exception directive can be used by placing the following code befo Any thrown STL exceptions will then be gracefully handled instead of causing a crash.

    -

    10.4.4 shared_ptr smart pointer

    +

    11.4.4 shared_ptr smart pointer

    -

    10.4.4.1 shared_ptr basics

    +

    11.4.4.1 shared_ptr basics

    @@ -1832,7 +1832,7 @@ System.out.println(val1 + " " + val2); -

    10.4.4.2 shared_ptr and inheritance

    +

    11.4.4.2 shared_ptr and inheritance

    @@ -1923,7 +1923,7 @@ Adding the missing %shared_ptr macros will fix this: -

    10.4.4.3 shared_ptr and method overloading

    +

    11.4.4.3 shared_ptr and method overloading

    @@ -1945,7 +1945,7 @@ SWIG will choose to wrap just the first method by default. For the interested reader, SWIG detects that they are equivalent types via the typecheck typemaps in the shared_ptr library.

    -

    10.4.4.4 shared_ptr and templates

    +

    11.4.4.4 shared_ptr and templates

    @@ -1987,7 +1987,7 @@ The SWIG code below shows the required ordering: -

    10.4.4.5 shared_ptr and directors

    +

    11.4.4.5 shared_ptr and directors

    @@ -1995,7 +1995,7 @@ The languages that support shared_ptr also have support for using shared_ptr wit

    -

    10.4.5 auto_ptr smart pointer

    +

    11.4.5 auto_ptr smart pointer

    @@ -2044,10 +2044,10 @@ int value = k.getValue(); -

    10.5 Utility Libraries

    +

    11.5 Utility Libraries

    -

    10.5.1 exception.i

    +

    11.5.1 exception.i

    diff --git a/Doc/Manual/Lua.html b/Doc/Manual/Lua.html index 90bcc5a00..0fa1ecb13 100644 --- a/Doc/Manual/Lua.html +++ b/Doc/Manual/Lua.html @@ -7,7 +7,7 @@ -

    27 SWIG and Lua

    +

    28 SWIG and Lua

      @@ -83,14 +83,14 @@ Lua is an extension programming language designed to support general procedural eLua stands for Embedded Lua (can be thought of as a flavor of Lua) and offers the full implementation of the Lua programming language to the embedded world, extending it with specific features for efficient and portable software embedded development. eLua runs on smaller devices like microcontrollers and provides the full features of the regular Lua desktop version. More information on eLua can be found here: http://www.eluaproject.net

      -

      27.1 Preliminaries

      +

      28.1 Preliminaries

      The current SWIG implementation is designed to work with Lua 5.0.x, 5.1.x and 5.2.x. It should work with later versions of Lua, but certainly not with Lua 4.0 due to substantial API changes. It is possible to either static link or dynamic link a Lua module into the interpreter (normally Lua static links its libraries, as dynamic linking is not available on all platforms). SWIG also has support for eLua starting from eLua 0.8. Due to substantial changes between SWIG 2.x and SWIG 3.0 and unavailability of testing platform, eLua status was downgraded to 'experimental'.

      -

      27.2 Running SWIG

      +

      28.2 Running SWIG

      @@ -138,7 +138,7 @@ $ swig -lua -eluac example.i The -elua option puts all the C function wrappers and variable get/set wrappers in rotables. It also generates a metatable which will control the access to these variables from eLua. It also offers a significant amount of module size compression. On the other hand, the -eluac option puts all the wrappers in a single rotable. With this option, no matter how huge the module, it will consume no additional microcontroller SRAM (crass compression). There is a catch though: Metatables are not generated with -eluac. To access any value from eLua, one must directly call the wrapper function associated with that value.

      -

      27.2.1 Additional command line options

      +

      28.2.1 Additional command line options

      @@ -179,7 +179,7 @@ swig -lua -help -

      27.2.2 Compiling and Linking and Interpreter

      +

      28.2.2 Compiling and Linking and Interpreter

      @@ -250,7 +250,7 @@ LUALIB_API int ( luaopen_mod )(lua_State *L ); More information on building and configuring eLua can be found here: http://www.eluaproject.net/doc/v0.8/en_building.html

      -

      27.2.3 Compiling a dynamic module

      +

      28.2.3 Compiling a dynamic module

      @@ -318,7 +318,7 @@ Is quite obvious (Go back and consult the Lua documents on how to enable loadlib -

      27.2.4 Using your module

      +

      28.2.4 Using your module

      @@ -336,19 +336,19 @@ $ ./my_lua >

    -

    27.3 A tour of basic C/C++ wrapping

    +

    28.3 A tour of basic C/C++ wrapping

    By default, SWIG tries to build a very natural Lua interface to your C/C++ code. This section briefly covers the essential aspects of this wrapping.

    -

    27.3.1 Modules

    +

    28.3.1 Modules

    The SWIG module directive specifies the name of the Lua module. If you specify `module example', then everything is wrapped into a Lua table 'example' containing all the functions and variables. When choosing a module name, make sure you don't use the same name as a built-in Lua command or standard module name.

    -

    27.3.2 Functions

    +

    28.3.2 Functions

    @@ -389,7 +389,7 @@ It is also possible to rename the module with an assignment. 24 -

    27.3.3 Global variables

    +

    28.3.3 Global variables

    @@ -477,7 +477,7 @@ If you have used the -eluac option for your eLua module, you will have In general, functions of the form "variable_get()" and "variable_set()" are automatically generated by SWIG for use with -eluac.

    -

    27.3.4 Constants and enums

    +

    28.3.4 Constants and enums

    @@ -512,7 +512,7 @@ If you're using eLua and have used -elua or -eluac to generate Hello World -

    27.3.4.1 Constants/enums and classes/structures

    +

    28.3.4.1 Constants/enums and classes/structures

    @@ -568,7 +568,7 @@ If the -no-old-metatable-bindings option is used, then these old-style It is worth mentioning, that example.Test.TEST1 and example.Test_TEST1 are different entities and changing one does not change the other. Given the fact that these are constantes and they are not supposed to be changed, it is up to you to avoid such issues.

    -

    27.3.5 Pointers

    +

    28.3.5 Pointers

    @@ -606,7 +606,7 @@ Lua enforces the integrity of its userdata, so it is virtually impossible to cor nil -

    27.3.6 Structures

    +

    28.3.6 Structures

    @@ -710,7 +710,7 @@ For eLua with the -eluac option, structure manipulation has to be perfo In general, functions of the form "new_struct()", "struct_member_get()", "struct_member_set()" and "free_struct()" are automatically generated by SWIG for each structure defined in C. (Please note: This doesn't apply for modules generated with the -elua option)

    -

    27.3.7 C++ classes

    +

    28.3.7 C++ classes

    @@ -785,7 +785,7 @@ Both style names are generated by default now. However, if the -no-old-metatable-bindings option is used, then the backward compatible names are not generated in addition to ordinary ones.

    -

    27.3.8 C++ inheritance

    +

    28.3.8 C++ inheritance

    @@ -810,7 +810,7 @@ then the function spam() accepts a Foo pointer or a pointer to any clas

    It is safe to use multiple inheritance with SWIG.

    -

    27.3.9 Pointers, references, values, and arrays

    +

    28.3.9 Pointers, references, values, and arrays

    @@ -841,7 +841,7 @@ Foo spam7();

    then all three functions will return a pointer to some Foo object. Since the third function (spam7) returns a value, newly allocated memory is used to hold the result and a pointer is returned (Lua will release this memory when the return value is garbage collected). The other two are pointers which are assumed to be managed by the C code and so will not be garbage collected.

    -

    27.3.10 C++ overloaded functions

    +

    28.3.10 C++ overloaded functions

    @@ -927,7 +927,7 @@ Please refer to the "SWIG and C++" chapter for more information about overloadin

    Dealing with the Lua coercion mechanism, the priority is roughly (integers, floats, strings, userdata). But it is better to rename the functions rather than rely upon the ordering.

    -

    27.3.11 C++ operators

    +

    28.3.11 C++ operators

    @@ -1059,7 +1059,7 @@ operators and pseudo-operators):

    No other lua metafunction is inherited. For example, __gc is not inherited and must be redefined in every class. __tostring is subject to a special handling. If absent in class and in class bases, a default one will be provided by SWIG.

    -

    27.3.12 Class extension with %extend

    +

    28.3.12 Class extension with %extend

    @@ -1116,7 +1116,7 @@ true Extend works with both C and C++ code, on classes and structs. It does not modify the underlying object in any way---the extensions only show up in the Lua interface. The only item to take note of is the code has to use the '$self' instead of 'this', and that you cannot access protected/private members of the code (as you are not officially part of the class).

    -

    27.3.13 Using %newobject to release memory

    +

    28.3.13 Using %newobject to release memory

    If you have a function that allocates memory like this,

    @@ -1140,7 +1140,7 @@ char *foo();

    This will release the allocated memory.

    -

    27.3.14 C++ templates

    +

    28.3.14 C++ templates

    @@ -1175,7 +1175,7 @@ In Lua:

    Obviously, there is more to template wrapping than shown in this example. More details can be found in the SWIG and C++ chapter. Some more complicated examples will appear later.

    -

    27.3.15 C++ Smart Pointers

    +

    28.3.15 C++ Smart Pointers

    @@ -1227,7 +1227,7 @@ If you ever need to access the underlying pointer returned by operator->( > f = p:__deref__() -- Returns underlying Foo * -

    27.3.16 C++ Exceptions

    +

    28.3.16 C++ Exceptions

    @@ -1370,7 +1370,7 @@ and the "Exception handling add exception specification to functions or globally (respectively).

    -

    27.3.17 Namespaces

    +

    28.3.17 Namespaces

    @@ -1421,7 +1421,7 @@ Now, from Lua usage is as follows: 19 > -

    27.3.17.1 Compatibility Note

    +

    28.3.17.1 Compatibility Note

    @@ -1437,7 +1437,7 @@ If SWIG is running in a backwards compatible way, i.e. without the -no-old-m -

    27.3.17.2 Names

    +

    28.3.17.2 Names

    If SWIG is launched without -no-old-metatable-bindings option, then it enters backward-compatible mode. While in this mode, it tries @@ -1481,7 +1481,7 @@ surrounding scope without any prefixing. Pretending that Test2 is a struct, not > -

    27.3.17.3 Inheritance

    +

    28.3.17.3 Inheritance

    The internal organization of inheritance has changed. @@ -1522,12 +1522,12 @@ function > -

    27.4 Typemaps

    +

    28.4 Typemaps

    This section explains what typemaps are and how to use them. The default wrapping behaviour of SWIG is enough in most cases. However sometimes SWIG may need a little additional assistance to know which typemap to apply to provide the best wrapping. This section will be explaining how to use typemaps to best effect

    -

    27.4.1 What is a typemap?

    +

    28.4.1 What is a typemap?

    A typemap is nothing more than a code generation rule that is attached to a specific C datatype. For example, to convert integers from Lua to C, you might define a typemap like this:

    @@ -1555,7 +1555,7 @@ Received an integer : 6 720 -

    27.4.2 Using typemaps

    +

    28.4.2 Using typemaps

    There are many ready written typemaps built into SWIG for all common types (int, float, short, long, char*, enum and more), which SWIG uses automatically, with no effort required on your part.

    @@ -1608,7 +1608,7 @@ void swap(int *sx, int *sy);

    Note: C++ references must be handled exactly the same way. However SWIG will automatically wrap a const int& as an input parameter (since that it obviously input).

    -

    27.4.3 Typemaps and arrays

    +

    28.4.3 Typemaps and arrays

    Arrays present a challenge for SWIG, because like pointers SWIG does not know whether these are input or output values, nor @@ -1672,7 +1672,7 @@ and Lua tables to be 1..N, (the indexing follows the norm for the language). In

    Note: SWIG also can support arrays of pointers in a similar manner.

    -

    27.4.4 Typemaps and pointer-pointer functions

    +

    28.4.4 Typemaps and pointer-pointer functions

    Several C++ libraries use a pointer-pointer functions to create its objects. These functions require a pointer to a pointer which is then filled with the pointer to the new object. Microsoft's COM and DirectX as well as many other libraries have this kind of function. An example is given below:

    @@ -1706,7 +1706,7 @@ int Create_Math(iMath** pptr); // its creator (assume it mallocs) ptr=nil -- the iMath* will be GC'ed as normal -

    27.5 Writing typemaps

    +

    28.5 Writing typemaps

    This section describes how you can modify SWIG's default wrapping behavior for various C/C++ datatypes using the %typemap directive. This is an advanced topic that assumes familiarity with the Lua C API as well as the material in the "Typemaps" chapter.

    @@ -1715,7 +1715,7 @@ ptr=nil -- the iMath* will be GC'ed as normal

    Before proceeding, you should read the previous section on using typemaps, and look at the existing typemaps found in luatypemaps.swg and typemaps.i. These are both well documented and fairly easy to read. You should not attempt to write your own typemaps until you have read and can understand both of these files (they may well also give you an idea to base your work on).

    -

    27.5.1 Typemaps you can write

    +

    28.5.1 Typemaps you can write

    There are many different types of typemap that can be written, the full list can be found in the "Typemaps" chapter. However the following are the most commonly used ones.

    @@ -1728,7 +1728,7 @@ ptr=nil -- the iMath* will be GC'ed as normal (the syntax for the typecheck is different from the typemap, see typemaps for details). -

    27.5.2 SWIG's Lua-C API

    +

    28.5.2 SWIG's Lua-C API

    This section explains the SWIG specific Lua-C API. It does not cover the main Lua-C api, as this is well documented and not worth covering.

    @@ -1777,7 +1777,7 @@ This macro, when called within the context of a SWIG wrapped function, will disp
    Similar to SWIG_fail_arg, except that it will display the swig_type_info information instead.
    -

    27.6 Customization of your Bindings

    +

    28.6 Customization of your Bindings

    @@ -1786,7 +1786,7 @@ This section covers adding of some small extra bits to your module to add the la -

    27.6.1 Writing your own custom wrappers

    +

    28.6.1 Writing your own custom wrappers

    @@ -1805,7 +1805,7 @@ int native_function(lua_State*L) // my native code The %native directive in the above example, tells SWIG that there is a function int native_function(lua_State*L); which is to be added into the module under the name 'my_func'. SWIG will not add any wrapper for this function, beyond adding it into the function table. How you write your code is entirely up to you.

    -

    27.6.2 Adding additional Lua code

    +

    28.6.2 Adding additional Lua code

    @@ -1843,7 +1843,7 @@ Good uses for this feature is adding of new code, or writing helper functions to See Examples/lua/arrays for an example of this code.

    -

    27.7 Details on the Lua binding

    +

    28.7 Details on the Lua binding

    @@ -1854,7 +1854,7 @@ See Examples/lua/arrays for an example of this code.

    -

    27.7.1 Binding global data into the module.

    +

    28.7.1 Binding global data into the module.

    @@ -1914,7 +1914,7 @@ end

    That way when you call 'a=example.Foo', the interpreter looks at the table 'example' sees that there is no field 'Foo' and calls __index. This will in turn check in '.get' table and find the existence of 'Foo' and then return the value of the C function call 'Foo_get()'. Similarly for the code 'example.Foo=10', the interpreter will check the table, then call the __newindex which will then check the '.set' table and call the C function 'Foo_set(10)'.

    -

    27.7.2 Userdata and Metatables

    +

    28.7.2 Userdata and Metatables

    @@ -1994,7 +1994,7 @@ Note: Both the opaque structures (like the FILE*) and normal wrapped classes/str

    Note: Operator overloads are basically done in the same way, by adding functions such as '__add' & '__call' to the class' metatable. The current implementation is a bit rough as it will add any member function beginning with '__' into the metatable too, assuming its an operator overload.

    -

    27.7.3 Memory management

    +

    28.7.3 Memory management

    diff --git a/Doc/Manual/Modules.html b/Doc/Manual/Modules.html index 19b69e5f4..7efd74e2b 100644 --- a/Doc/Manual/Modules.html +++ b/Doc/Manual/Modules.html @@ -7,7 +7,7 @@ -

    18 Working with Modules

    +

    19 Working with Modules

    -

    28.2.2.1 Enum typing in Ocaml

    +

    38.2.2.1 Enum typing in Ocaml

    @@ -477,10 +477,10 @@ functions imported from different modules. You must convert values to master values using the swig_val function before sharing them with another module.

    -

    28.2.3 Arrays

    +

    38.2.3 Arrays

    -

    28.2.3.1 Simple types of bounded arrays

    +

    38.2.3.1 Simple types of bounded arrays

    @@ -501,7 +501,7 @@ arrays of simple types with known bounds in your code, but this only works for arrays whose bounds are completely specified.

    -

    28.2.3.2 Complex and unbounded arrays

    +

    38.2.3.2 Complex and unbounded arrays

    @@ -514,7 +514,7 @@ SWIG can't predict which of these methods will be used in the array, so you have to specify it for yourself in the form of a typemap.

    -

    28.2.3.3 Using an object

    +

    38.2.3.3 Using an object

    @@ -528,7 +528,7 @@ Consider writing an object when the ending condition of your array is complex, such as using a required sentinel, etc.

    -

    28.2.3.4 Example typemap for a function taking float * and int

    +

    38.2.3.4 Example typemap for a function taking float * and int

    @@ -579,7 +579,7 @@ void printfloats( float *tab, int len ); -

    28.2.4 C++ Classes

    +

    38.2.4 C++ Classes

    @@ -622,7 +622,7 @@ the underlying pointer, so using create_[x]_from_ptr alters the returned value for the same object.

    -

    28.2.4.1 STL vector and string Example

    +

    38.2.4.1 STL vector and string Example

    @@ -702,7 +702,7 @@ baz # -

    28.2.4.2 C++ Class Example

    +

    38.2.4.2 C++ Class Example

    @@ -732,7 +732,7 @@ public: }; -

    28.2.4.3 Compiling the example

    +

    38.2.4.3 Compiling the example

    @@ -750,7 +750,7 @@ bash-2.05a$ ocamlmktop -custom swig.cmo -I `camlp4 -where` \
   -L$QTPATH/lib -cclib -lqt
    -

    28.2.4.4 Sample Session

    +

    38.2.4.4 Sample Session

    @@ -777,10 +777,10 @@ Assuming you have a working installation of QT, you will see a window
 containing the string "hi" in a button.
 
    
 
-
    28.2.5 Director Classes
    
+
    38.2.5 Director Classes
    
 
 
-
    28.2.5.1 Director Introduction
    
+
    38.2.5.1 Director Introduction
    
 
 
 
    
@@ -807,7 +807,7 @@ class foo {
 };
    -

    28.2.5.2 Overriding Methods in Ocaml

    +

    38.2.5.2 Overriding Methods in Ocaml

    @@ -835,7 +835,7 @@ In this example, I'll examine the objective caml code involved in providing an overloaded class. This example is contained in Examples/ocaml/shapes.

    -

    28.2.5.3 Director Usage Example

    +

    38.2.5.3 Director Usage Example

    @@ -896,7 +896,7 @@ in a more effortless style in ocaml, while leaving the "engine" part of the program in C++.

    -

    28.2.5.4 Creating director objects

    +

    38.2.5.4 Creating director objects

    @@ -937,7 +937,7 @@ object from causing a core dump, as long as the object is destroyed properly.

    -

    28.2.5.5 Typemaps for directors, directorin, directorout, directorargout

    +

    38.2.5.5 Typemaps for directors, directorin, directorout, directorargout

    @@ -948,7 +948,7 @@ well as a function return value in the same way you provide function arguments, and to receive arguments the same way you normally receive function returns.

    -

    28.2.5.6 typemap

    +

    38.2.5.6 typemap

    @@ -959,7 +959,7 @@ code receives when you are called. In general, a simple directorin typ can use the same body as a simple out typemap.

    -

    28.2.5.7 directorout typemap

    +

    38.2.5.7 directorout typemap

    @@ -970,7 +970,7 @@ for the same type, except when there are special requirements for object ownership, etc.

    -

    28.2.5.8 directorargout typemap

    +

    38.2.5.8 directorargout typemap

    @@ -987,7 +987,7 @@ In the event that you don't specify all of the necessary values, integral values will read zero, and struct or object returns have undefined results.

    -

    28.2.6 Exceptions

    +

    38.2.6 Exceptions

    @@ -996,7 +996,7 @@ but not too useful example is provided by the throw_exception testcase in Examples/test-suite. You can provide your own exceptions, too.

    -

    28.3 Documentation Features

    +

    38.3 Documentation Features

    @@ -1005,7 +1005,7 @@ comments (colloquially referred to as "docstrings") that can be read by OCamldoc.

    -

    28.3.1 Module docstring

    +

    38.3.1 Module docstring

    diff --git a/Doc/Manual/Preprocessor.html b/Doc/Manual/Preprocessor.html index 10efe0c15..1bf59e238 100644 --- a/Doc/Manual/Preprocessor.html +++ b/Doc/Manual/Preprocessor.html @@ -7,7 +7,7 @@ -

    9 Preprocessing

    +

    10 Preprocessing

      @@ -38,7 +38,7 @@ However, a number of modifications and enhancements have been made. This chapter describes some of these modifications.

      -

      9.1 File inclusion

      +

      10.1 File inclusion

      @@ -64,7 +64,7 @@ By default, the #include is ignored unless you run SWIG with the is that you often don't want SWIG to try and wrap everything included in standard header system headers and auxiliary files. -

      9.2 File imports

      +

      10.2 File imports

      @@ -93,7 +93,7 @@ The -importall directive tells SWIG to follow all #include sta as imports. This might be useful if you want to extract type definitions from system header files without generating any wrappers. -

      9.3 Conditional Compilation

      +

      10.3 Conditional Compilation

      @@ -151,7 +151,7 @@ SWIG (except for the symbol `SWIG' which is only defined within the SWIG compiler).

      -

      9.4 Macro Expansion

      +

      10.4 Macro Expansion

      @@ -206,7 +206,7 @@ like #x. This is a non-standard SWIG extension.

    -

    9.5 SWIG Macros

    +

    10.5 SWIG Macros

    @@ -252,7 +252,7 @@ many of SWIG's advanced features and libraries are built using this mechanism (s support).

    -

    9.6 C99 and GNU Extensions

    +

    10.6 C99 and GNU Extensions

    @@ -308,14 +308,14 @@ interface building. However, they are used internally to implement a number of SWIG directives and are provided to make SWIG more compatible with C99 code.

    -

    9.7 Preprocessing and delimiters

    +

    10.7 Preprocessing and delimiters

    The preprocessor handles { }, " " and %{ %} delimiters differently.

    -

    9.7.1 Preprocessing and %{ ... %} & " ... " delimiters

    +

    10.7.1 Preprocessing and %{ ... %} & " ... " delimiters

    @@ -340,7 +340,7 @@ the contents of the %{ ... %} block are copied without modification to the output (including all preprocessor directives).

    -

    9.7.2 Preprocessing and { ... } delimiters

    +

    10.7.2 Preprocessing and { ... } delimiters

    @@ -382,7 +382,7 @@ to actually go into the wrapper file, prefix the preprocessor directives with % and leave the preprocessor directive in the code.

    -

    9.8 Preprocessor and Typemaps

    +

    10.8 Preprocessor and Typemaps

    @@ -453,7 +453,7 @@ would generate

    -

    9.9 Viewing preprocessor output

    +

    10.9 Viewing preprocessor output

    @@ -463,7 +463,7 @@ Instead the results after the preprocessor has run are displayed. This might be useful as an aid to debugging and viewing the results of macro expansions.

    -

    9.10 The #error and #warning directives

    +

    10.10 The #error and #warning directives

    diff --git a/Doc/Manual/Typemaps.html b/Doc/Manual/Typemaps.html index 1639423af..d34bb2801 100644 --- a/Doc/Manual/Typemaps.html +++ b/Doc/Manual/Typemaps.html @@ -7,7 +7,7 @@ -

    12 Typemaps

    +

    13 Typemaps

    -

    12.1.7 Similarities to Aspect Oriented Programming

    +

    13.1.7 Similarities to Aspect Oriented Programming

    @@ -686,7 +686,7 @@ SWIG can also be viewed as has having a second set of aspects based around %exception are also cross-cutting concerns as they encapsulate code that can be used to add logging or exception handling to any function.

    -

    12.1.8 The rest of this chapter

    +

    13.1.8 The rest of this chapter

    @@ -706,14 +706,14 @@ of "The C Programming Language" by Kernighan and Ritchie or "The C++ Programming Language" by Stroustrup before going any further.

    -

    12.2 Typemap specifications

    +

    13.2 Typemap specifications

    This section describes the behavior of the %typemap directive itself.

    -

    12.2.1 Defining a typemap

    +

    13.2.1 Defining a typemap

    @@ -826,7 +826,7 @@ Admittedly, it's not the most readable syntax at first glance. However, the pur individual pieces will become clear.

    -

    12.2.2 Typemap scope

    +

    13.2.2 Typemap scope

    @@ -876,7 +876,7 @@ class Foo { -

    12.2.3 Copying a typemap

    +

    13.2.3 Copying a typemap

    @@ -934,7 +934,7 @@ The patterns for %apply follow the same rules as for %typemap. -

    12.2.4 Deleting a typemap

    +

    13.2.4 Deleting a typemap

    @@ -968,7 +968,7 @@ For example: after the clear operation.

    -

    12.2.5 Placement of typemaps

    +

    13.2.5 Placement of typemaps

    @@ -1048,7 +1048,7 @@ It should be noted that for scoping to work, SWIG has to know that stringclass string.

    -

    12.3 Pattern matching rules

    +

    13.3 Pattern matching rules

    @@ -1056,7 +1056,7 @@ The section describes the pattern matching rules by which C/C++ datatypes are as The matching rules can be observed in practice by using the debugging options also described.

    -

    12.3.1 Basic matching rules

    +

    13.3.1 Basic matching rules

    @@ -1155,7 +1155,7 @@ void F(int x[1000]); // int [ANY] rule (typemap 5) stripped all qualifiers in one step.

    -

    12.3.2 Typedef reductions matching

    +

    13.3.2 Typedef reductions matching

    @@ -1330,7 +1330,7 @@ void go(Struct aStruct); -

    12.3.3 Default typemap matching rules

    +

    13.3.3 Default typemap matching rules

    @@ -1468,7 +1468,7 @@ Finally the best way to view the typemap matching rules in action is via the -

    12.3.4 Multi-arguments typemaps

    +

    13.3.4 Multi-arguments typemaps

    @@ -1498,7 +1498,7 @@ but all subsequent arguments must match exactly.

    -

    12.3.5 Matching rules compared to C++ templates

    +

    13.3.5 Matching rules compared to C++ templates

    @@ -1657,7 +1657,7 @@ are similar to those for specialized template handling.

    -

    12.3.6 Debugging typemap pattern matching

    +

    13.3.6 Debugging typemap pattern matching

    @@ -1870,7 +1870,7 @@ Also the types may be displayed slightly differently - char const * and -

    12.4 Code generation rules

    +

    13.4 Code generation rules

    @@ -1878,7 +1878,7 @@ This section describes rules by which typemap code is inserted into the generated wrapper code.

    -

    12.4.1 Scope

    +

    13.4.1 Scope

    @@ -1956,7 +1956,7 @@ a block scope when it is emitted. This sometimes results in a less complicated Note that only the third of the three typemaps have the typemap code passed through the SWIG preprocessor.

    -

    12.4.2 Declaring new local variables

    +

    13.4.2 Declaring new local variables

    @@ -2123,7 +2123,7 @@ each type must have its own local variable declaration. -

    12.4.3 Special variables

    +

    13.4.3 Special variables

    @@ -2375,7 +2375,7 @@ Another approach, which only works for arrays is to use the $1_basetype -

    12.4.4 Special variable macros

    +

    13.4.4 Special variable macros

    @@ -2387,7 +2387,7 @@ it is done during the SWIG parsing/compilation stages. The following special variable macros are available across all language modules.

    -

    12.4.4.1 $descriptor(type)

    +

    13.4.4.1 $descriptor(type)

    @@ -2398,7 +2398,7 @@ For example, $descriptor(std::vector<int> *) will expand into Run-time type checker usage section.

    -

    12.4.4.2 $typemap(method, typepattern)

    +

    13.4.4.2 $typemap(method, typepattern)

    @@ -2456,7 +2456,7 @@ The result is the following expansion -

    12.4.5 Special variables and typemap attributes

    +

    13.4.5 Special variables and typemap attributes

    @@ -2483,7 +2483,7 @@ is equivalent to the following as $*1_ltype expands to unsigned int -

    12.4.6 Special variables combined with special variable macros

    +

    13.4.6 Special variables combined with special variable macros

    @@ -2525,7 +2525,7 @@ which then expands to: -

    12.5 Common typemap methods

    +

    13.5 Common typemap methods

    @@ -2533,7 +2533,7 @@ The family of typemaps recognized by a language module may vary. However, the following typemap methods are nearly universal:

    -

    12.5.1 "in" typemap

    +

    13.5.1 "in" typemap

    @@ -2593,7 +2593,7 @@ Usually numinputs is not specified, whereupon the default value is 1, t is the same as the old "ignore" typemap.

    -

    12.5.2 "typecheck" typemap

    +

    13.5.2 "typecheck" typemap

    @@ -2620,7 +2620,7 @@ If you define new "in" typemaps and your program uses overloaded method "typecheck" typemaps. More details about this follow in the Typemaps and overloading section.

    -

    12.5.3 "out" typemap

    +

    13.5.3 "out" typemap

    @@ -2651,7 +2651,7 @@ $symname - Name of function/method being wrapped The "out" typemap supports an optional attribute flag called "optimal". This is for code optimisation and is detailed in the Optimal code generation when returning by value section.

    -

    12.5.4 "arginit" typemap

    +

    13.5.4 "arginit" typemap

    @@ -2670,7 +2670,7 @@ For example: -

    12.5.5 "default" typemap

    +

    13.5.5 "default" typemap

    @@ -2703,7 +2703,7 @@ See the Default/optional arguments sec for further information on default argument wrapping.

    -

    12.5.6 "check" typemap

    +

    13.5.6 "check" typemap

    @@ -2722,7 +2722,7 @@ converted. For example: -

    12.5.7 "argout" typemap

    +

    13.5.7 "argout" typemap

    @@ -2768,7 +2768,7 @@ return values are often appended to return value of the function. See the typemaps.i library file for examples.

    -

    12.5.8 "freearg" typemap

    +

    13.5.8 "freearg" typemap

    @@ -2801,7 +2801,7 @@ be used in other typemaps whenever a wrapper function needs to abort prematurely.

    -

    12.5.9 "newfree" typemap

    +

    13.5.9 "newfree" typemap

    @@ -2830,7 +2830,7 @@ string *foo(); See Object ownership and %newobject for further details.

    -

    12.5.10 "ret" typemap

    +

    13.5.10 "ret" typemap

    @@ -2869,7 +2869,7 @@ This approach is an alternative to using the "newfree" typemap and %newobjec is no need to list all the functions that require the memory cleanup, it is purely done on types.

    -

    12.5.11 "memberin" typemap

    +

    13.5.11 "memberin" typemap

    @@ -2891,7 +2891,7 @@ It is rarely necessary to write "memberin" typemaps---SWIG already provides a default implementation for arrays, strings, and other objects.

    -

    12.5.12 "varin" typemap

    +

    13.5.12 "varin" typemap

    @@ -2899,7 +2899,7 @@ The "varin" typemap is used to convert objects in the target language to C for t purposes of assigning to a C/C++ global variable. This is implementation specific.

    -

    12.5.13 "varout" typemap

    +

    13.5.13 "varout" typemap

    @@ -2907,7 +2907,7 @@ The "varout" typemap is used to convert a C/C++ object to an object in the targe language when reading a C/C++ global variable. This is implementation specific.

    -

    12.5.14 "throws" typemap

    +

    13.5.14 "throws" typemap

    @@ -2957,7 +2957,7 @@ Note that if your methods do not have an exception specification but they do thr Please also see the Exception handling with %exception section for another way to handle exceptions.

    -

    12.6 Some typemap examples

    +

    13.6 Some typemap examples

    @@ -2965,7 +2965,7 @@ This section contains a few examples. Consult language module documentation for more examples.

    -

    12.6.1 Typemaps for arrays

    +

    13.6.1 Typemaps for arrays

    @@ -3224,7 +3224,7 @@ Now, you will find that member access is quite nice: useless and has since been eliminated. To return structure members, simply use the "out" typemap.

    -

    12.6.2 Implementing constraints with typemaps

    +

    13.6.2 Implementing constraints with typemaps

    @@ -3272,7 +3272,7 @@ a NULL pointer. As a result, SWIG can often prevent a potential segmentation faults or other run-time problems by raising an exception rather than blindly passing values to the underlying C/C++ program.

    -

    12.7 Typemaps for multiple target languages

    +

    13.7 Typemaps for multiple target languages

    @@ -3302,7 +3302,7 @@ The example above also shows a common approach of issuing a warning for an as ye %typemap(ruby, in) int "$1 = NUM2INT($input);".

    -

    12.8 Optimal code generation when returning by value

    +

    13.8 Optimal code generation when returning by value

    @@ -3491,7 +3491,7 @@ example.i:7: Warning 475: optimal attribute usage in the out typemap. However, it doesn't always get it right, for example when $1 is within some commented out code.

    -

    12.9 Multi-argument typemaps

    +

    13.9 Multi-argument typemaps

    @@ -3768,7 +3768,7 @@ with non-consecutive C/C++ arguments; a workaround such as a helper function re- the arguments to make them consecutive will need to be written.

    -

    12.10 Typemap warnings

    +

    13.10 Typemap warnings

    @@ -3777,7 +3777,7 @@ See the information in the issuing warnings

    -

    12.11 Typemap fragments

    +

    13.11 Typemap fragments

    @@ -4113,7 +4113,7 @@ fragment usage unless a desire to really get to grips with some powerful but tricky macro and fragment usage that is used in parts of the SWIG typemap library.

    -

    12.11.1 Fragment type specialization

    +

    13.11.1 Fragment type specialization

    @@ -4146,7 +4146,7 @@ struct A { -

    12.11.2 Fragments and automatic typemap specialization

    +

    13.11.2 Fragments and automatic typemap specialization

    @@ -4192,7 +4192,7 @@ The interested (or very brave) reader can take a look at the fragments.swg file

    -

    12.12 The run-time type checker

    +

    13.12 The run-time type checker

    @@ -4218,7 +4218,7 @@ language modules.

  • Modules can be unloaded from the type system.
    • -

    12.12.1 Implementation

    +

    13.12.1 Implementation

    @@ -4412,7 +4412,7 @@ structures rather than creating new ones. These swig_module_info structures are chained together in a circularly linked list.

    -

    12.12.2 Usage

    +

    13.12.2 Usage

    This section covers how to use these functions from typemaps. To learn how to @@ -4508,7 +4508,7 @@ probably just look at the output of SWIG to get a better sense for how types are managed.

    -

    12.13 Typemaps and overloading

    +

    13.13 Typemaps and overloading

    @@ -4815,7 +4815,7 @@ Subsequent "in" typemaps would then perform more extensive type-checking. -

    12.13.1 SWIG_TYPECHECK_POINTER precedence level and the typecheck typemap

    +

    13.13.1 SWIG_TYPECHECK_POINTER precedence level and the typecheck typemap

    @@ -4917,7 +4917,7 @@ Otherwise both can be wrapped by removing the overloading name ambiguity by rena The 'equivalent' attribute is used in the implementation for the shared_ptr smart pointer library.

    -

    12.14 More about %apply and %clear

    +

    13.14 More about %apply and %clear

    @@ -5022,7 +5022,7 @@ will delete the typemaps for all the typemap methods; namely "in", "check" and " -

    12.15 Passing data between typemaps

    +

    13.15 Passing data between typemaps

    @@ -5059,7 +5059,7 @@ sure that the typemaps sharing information have exactly the same types and names

    -

    12.16 C++ "this" pointer

    +

    13.16 C++ "this" pointer

    @@ -5119,7 +5119,7 @@ will also match the typemap. One work around is to create an interface file tha the method, but gives the argument a name other than self.

    -

    12.17 Where to go for more information?

    +

    13.17 Where to go for more information?

    diff --git a/Doc/Manual/Varargs.html b/Doc/Manual/Varargs.html index c6f0e8c63..9f20469d2 100644 --- a/Doc/Manual/Varargs.html +++ b/Doc/Manual/Varargs.html @@ -7,7 +7,7 @@ -

    15 Variable Length Arguments

    +

    16 Variable Length Arguments

      @@ -43,7 +43,7 @@ added in SWIG-1.3.12. Most other wrapper generation tools have wisely chosen to avoid this issue.

      -

      15.1 Introduction

      +

      16.1 Introduction

      @@ -140,7 +140,7 @@ List make_list(const char *s, ...) {

    -

    15.2 The Problem

    +

    16.2 The Problem

    @@ -233,7 +233,7 @@ can also support real varargs wrapping (with stack-frame manipulation) if you are willing to get hands dirty. Keep reading.

    -

    15.3 Default varargs support

    +

    16.3 Default varargs support

    @@ -302,7 +302,7 @@ Read on for further solutions.

    -

    15.4 Argument replacement using %varargs

    +

    16.4 Argument replacement using %varargs

    @@ -413,7 +413,7 @@ mixed argument types such as printf(). Providing general purpose wrappers to such functions presents special problems (covered shortly).

    -

    15.5 Varargs and typemaps

    +

    16.5 Varargs and typemaps

    @@ -593,7 +593,7 @@ really want to elevate your guru status and increase your job security, continue to the next section.

    -

    15.6 Varargs wrapping with libffi

    +

    16.6 Varargs wrapping with libffi

    @@ -845,7 +845,7 @@ provide an argument number for the first extra argument. This can be used to in values. Please consult the chapter on each language module for more details.

    -

    15.7 Wrapping of va_list

    +

    16.7 Wrapping of va_list

    @@ -899,7 +899,7 @@ int my_vprintf(const char *fmt, ...) { -

    15.8 C++ Issues

    +

    16.8 C++ Issues

    @@ -968,7 +968,7 @@ design or to provide an alternative interface using a helper function than it is fully general wrapper to a varargs C++ member function.

    -

    15.9 Discussion

    +

    16.9 Discussion

    diff --git a/Doc/Manual/Warnings.html b/Doc/Manual/Warnings.html index 968bdbac8..bff20801e 100644 --- a/Doc/Manual/Warnings.html +++ b/Doc/Manual/Warnings.html @@ -7,7 +7,7 @@ -

    17 Warning Messages

    +

    18 Warning Messages

    -

    17.5 Symbolic symbols

    +

    18.5 Symbolic symbols

    @@ -311,7 +311,7 @@ or -

    17.6 Commentary

    +

    18.6 Commentary

    @@ -328,7 +328,7 @@ no obvious recovery. There is no mechanism for suppressing error messages.

    -

    17.7 Warnings as errors

    +

    18.7 Warnings as errors

    @@ -337,7 +337,7 @@ option. This will cause SWIG to exit with a non successful exit code if a warning is encountered.

    -

    17.8 Message output format

    +

    18.8 Message output format

    @@ -356,10 +356,10 @@ $ swig -python -Fmicrosoft example.i example.i(4) : Syntax error in input(1). -

    17.9 Warning number reference

    +

    18.9 Warning number reference

    -

    17.9.1 Deprecated features (100-199)

    +

    18.9.1 Deprecated features (100-199)

      @@ -387,7 +387,7 @@ example.i(4) : Syntax error in input(1).
    • 126. The 'nestedworkaround' feature is deprecated.
    -

    17.9.2 Preprocessor (200-299)

    +

    18.9.2 Preprocessor (200-299)

      @@ -399,7 +399,7 @@ example.i(4) : Syntax error in input(1).
    • 206. Unexpected tokens after #directive directive.
    -

    17.9.3 C/C++ Parser (300-399)

    +

    18.9.3 C/C++ Parser (300-399)

      @@ -476,7 +476,7 @@ example.i(4) : Syntax error in input(1).
    • 395. operator delete[] ignored.
    -

    17.9.4 Types and typemaps (400-499)

    +

    18.9.4 Types and typemaps (400-499)