@@ -91,7 +91,7 @@ Also, this chapter is not meant to be a hand-holding tutorial. As a starting po you should probably look at one of SWIG's existing modules.
-@@ -121,7 +121,7 @@ obvious, but almost all SWIG directives as well as the low-level generation of wrapper code are driven by C++ datatypes.
-@@ -158,7 +158,7 @@ role in making the system work. For example, both typemaps and declaration anno based on pattern matching and interact heavily with the underlying type system.
-@@ -203,7 +203,7 @@ latter stage of compilation. The next few sections briefly describe some of these stages.
-@@ -284,7 +284,7 @@ been expanded as well as everything else that goes into the low-level construction of the wrapper code.
-@@ -385,7 +385,7 @@ returning a foo and taking types a and b as arguments).
-@@ -640,7 +640,7 @@ $ swig -c++ -python -debug-module 4 example.i
@@ -659,7 +659,7 @@ that matches the name of the target language. For example, python:foo perl:foo.
-@@ -750,7 +750,7 @@ example.i:5. Previous declaration is foo_i(int )
@@ -806,7 +806,7 @@ For example, the exception code above is simply stored without any modifications.
-@@ -928,7 +928,7 @@ public : The role of these functions is described shortly.
-@@ -941,7 +941,7 @@ internal data structures, it may be useful to keep XML in the back of your mind as a model.
-@@ -987,7 +987,7 @@ typedef Hash Typetab; -
@@ -1128,7 +1128,7 @@ Returns the number of replacements made (if any). -
@@ -1205,7 +1205,7 @@ Returns the list of hash table keys. -
@@ -1294,7 +1294,7 @@ If t is not a standard object, it is assumed to be a char * and is used to create a String object. -
@@ -1782,7 +1782,7 @@ the attribute is optional. Swig_restore() must always be called after function. -
@@ -1791,7 +1791,7 @@ pointers, references, and pointers to members. A detailed discussion of type theory is impossible here. However, let's cover the highlights.
-@@ -1892,7 +1892,7 @@ make the final type, the two parts are just joined together using string concatenation.
-@@ -2061,7 +2061,7 @@ Returns the prefix of a type. For example, if ty is ty is unmodified. -
@@ -2148,7 +2148,7 @@ Checks if ty is a varargs type. Checks if ty is a templatized type. -
@@ -2250,7 +2250,7 @@ Fully reduces ty according to typedef rules. Resulting datatype will consist only of primitive typenames. -
@@ -2287,7 +2287,7 @@ Literal y; // type = 'Literal', ltype='p.char' -
@@ -2349,7 +2349,7 @@ SWIG, but is most commonly associated with type-descriptor objects that appear in wrappers (e.g., SWIGTYPE_p_double). -
@@ -2448,7 +2448,7 @@ included. Used to emit prototypes. Returns the number of required (non-optional) arguments in p. -
@@ -2463,7 +2463,7 @@ describes the creation of a minimal Python module. You should be able to extra this to other languages.
-@@ -2473,7 +2473,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.
-@@ -2581,7 +2581,7 @@ that activates your module. For example, swig -python foo.i. The messages from your new module should appear.
-@@ -2640,7 +2640,7 @@ to mark the option as valid. If you forget to do this, SWIG will terminate wit unrecognized command line option error.
-@@ -2689,7 +2689,7 @@ an implementation file python.cxx and a configuration file python.swg.
-@@ -2747,7 +2747,7 @@ int Python::top(Node *n) { -
@@ -3202,7 +3202,7 @@ Discuss the kinds of functions typically needed for SWIG runtime support (e.g. the SWIG files that implement those functions.
-@@ -3221,7 +3221,7 @@ The following are the minimum that are usually supported: Please copy these and modify for any new language.
-@@ -3250,7 +3250,7 @@ during this process, see the section on .
-@@ -3309,7 +3309,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.
-@@ -3495,7 +3495,7 @@ The syntax for setting environment variables varies from one shell to the next, make ret_by_value.ctest SWIG_FEATURES="-debug-tmsearch" -
@@ -3527,7 +3527,7 @@ Some topics that you'll want to be sure to address include: if available. -
@@ -3584,7 +3584,7 @@ should be added should there be an area not already covered by the existing tests.
-@@ -3608,7 +3608,7 @@ The generated C/C++ code should also follow this style as close as possible. How should be avoided as unlike the SWIG developers, users will never have consistent tab settings.
-@@ -3635,7 +3635,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.
-@@ -4043,7 +4043,7 @@ extern "X" { ... } declaration. -
diff --git a/Doc/Manual/Go.html b/Doc/Manual/Go.html index 5e99a5156..d5275efea 100644 --- a/Doc/Manual/Go.html +++ b/Doc/Manual/Go.html @@ -5,7 +5,7 @@
-@@ -65,7 +65,7 @@ checking and runtime library are not used with Go. This should be borne in mind when reading the rest of the SWIG documentation.
-@@ -74,7 +74,7 @@ default SWIG will generate code for the gc compilers. To generate code for gccgo, you should also use the -gccgo option.
-@@ -118,7 +118,7 @@ swig -go -help -
When generating Go code, SWIG will generate the following @@ -163,7 +163,7 @@ A typical command sequence would look like this: % 6l main.6
@@ -173,7 +173,7 @@ modifications have to occur. This section briefly covers the essential aspects of this wrapping.
-@@ -183,7 +183,7 @@ directive. You may override this by using SWIG's -package command line option.
-@@ -215,7 +215,7 @@ followed by that name, and the destructor will be named Delete followed by that name.
-@@ -223,7 +223,7 @@ C/C++ constants created via #define or the %constant directive become Go constants, declared with a const declaration. -
@@ -233,7 +233,7 @@ usual). The values of the enumeration will become variables in Go; code should avoid modifying those variables.
-@@ -280,7 +280,7 @@ to reinterpret_cast. This should only be used for very special cases, such as where C++ would use a dynamic_cast.
-@@ -292,7 +292,7 @@ Doing the reverse will require an explicit type assertion, which will be checked dynamically.
-@@ -300,7 +300,7 @@ In order to use C++ templates in Go, you must tell SWIG to create wrappers for a particular template instantation. To do this, use the %template directive. -
@@ -343,7 +343,7 @@ method defined in Go. The Go code may of course call other methods on itself, and those methods may be defined either in Go or in C++.
-diff --git a/Doc/Manual/Guile.html b/Doc/Manual/Guile.html index 75c3d3473..da0b11dd8 100644 --- a/Doc/Manual/Guile.html +++ b/Doc/Manual/Guile.html @@ -8,7 +8,7 @@
-This section details guile-specific support in SWIG. -
@@ -55,7 +55,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". -
The guile module can currently export wrapper files that use the guile GH interface or the @@ -103,7 +103,7 @@ for the specific API. Currently only the guile language module has created a ma but there is no reason other languages (like mzscheme or chicken) couldn't also use this. If that happens, there is A LOT less code duplication in the standard typemaps.
-@@ -111,7 +111,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. -
@@ -206,7 +206,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.
-
Passive linkage is just like simple linkage, but it generates an @@ -216,7 +216,7 @@ package name (see below).
You should use passive linkage rather than simple linkage when you are using multiple modules. -
SWIG can also generate wrapper code that does all the Guile module @@ -257,7 +257,7 @@ Newer Guile versions have a shorthand procedure for this:
Guile used to support an autoloading facility for object-code @@ -283,7 +283,7 @@ option, SWIG generates an exported module initialization function with an appropriate name. -
@@ -308,7 +308,7 @@ my/lib/libfoo.so.X.Y.Z and friends. This scheme is still very experimental; the (hobbit4d link) conventions are not well understood.
-
@@ -320,7 +320,7 @@ complained so far.
%rename to specify the Guile name of the wrapped
functions and variables (see CHANGES).
-
@@ -412,7 +412,7 @@ constant will appear as a scheme variable. See Features and the %feature directive for info on how to apply the %feature.
-
@@ -433,7 +433,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.
-
@@ -462,7 +462,7 @@ that created them, so the first module we check will most likely be correct. Once we have a swig_type_info structure, we loop through the linked list of casts, using pointer comparisons.
-The SCM interface (using the "-scm" argument to swig) uses swigrun.swg. @@ -477,7 +477,7 @@ in the smob tag. If a generated GOOPS module has been loaded, smobs will be wra GOOPS class.
-Garbage collection is a feature of the new SCM interface, and it is automatically included @@ -491,7 +491,7 @@ is exactly like described in 21.7 Exception Handling +
@@ -517,7 +517,7 @@ mapping: The default when not specified here is to use "swig-error". See Lib/exception.i for details. -
If invoked with the command-line option For global variables, SWIG creates a single wrapper procedure
@@ -581,7 +581,7 @@ struct members, the procedures SWIG can also generate classes and generic functions for use with
@@ -730,7 +730,7 @@ Notice that <Foo> is used before it is defined. The fix is to just put th
As you can see in the example above, there are potential naming conflicts. The default exported
@@ -767,7 +767,7 @@ guile-modules. For example, 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 d32a7fb9a..a27d9adbb 100644
--- a/Doc/Manual/Java.html
+++ b/Doc/Manual/Java.html
@@ -5,7 +5,7 @@
@@ -189,7 +189,7 @@ Various customisation tips and techniques using SWIG directives are covered.
The latter sections cover the advanced techniques of using typemaps for complete control of the wrapping process.
@@ -205,7 +205,7 @@ Run make -k check from the SWIG root directory after installing SWIG on
The Java module requires your system to support shared libraries and dynamic loading.
This is the commonly used method to load JNI code so your system will more than likely support this.
@@ -264,7 +264,7 @@ The following sections have further practical examples and details on how you mi
compiling and using the generated files.
@@ -301,7 +301,7 @@ swig -java -help
Their use will become clearer by the time you have finished reading this section on SWIG and Java.
@@ -316,7 +316,7 @@ They are usually in directories like this:
The exact location may vary on your machine, but the above locations are typical.
@@ -352,7 +352,7 @@ The name of the shared library output file is important.
If the name of your SWIG module is "example", the name of the corresponding shared library file should be "libexample.so" (or equivalent depending on your machine, see Dynamic linking problems for more information).
The name of the module is specified using the %module directive or -module command line option.
@@ -387,7 +387,7 @@ $
If it doesn't work have a look at the following section which discusses problems loading the shared library.
@@ -474,7 +474,7 @@ The following section also contains some C++ specific linking problems and solut
@@ -527,7 +527,7 @@ Finally make sure the version of JDK header files matches the version of Java th
@@ -536,7 +536,7 @@ You will want to produce a DLL that can be loaded by the Java Virtual Machine.
This section covers the process of using SWIG with Microsoft Visual C++ 6 although the procedure may be similar with other compilers.
In order for everything to work, you will need to have a JDK installed on your machine in order to read the JNI header files.
@@ -575,7 +575,7 @@ To run the native code in the DLL (example.dll), make sure that it is in your pa
If the library fails to load have a look at Dynamic linking problems.
@@ -634,7 +634,7 @@ Of course you may want to make changes for it to work for C++ by adding in the -
@@ -644,7 +644,7 @@ variables are wrapped with JavaBean type getters and setters and so forth.
This section briefly covers the essential aspects of this wrapping.
@@ -680,7 +680,7 @@ swig -java -package com.bloggs.swig -outdir com/bloggs/swig example.i
SWIG won't create the directory, so make sure it exists beforehand.
@@ -714,7 +714,7 @@ System.out.println(example.fact(4));
@@ -801,7 +801,7 @@ extern char *path; // Read-only (due to %immutable)
-
@@ -941,7 +941,7 @@ Or if you decide this practice isn't so bad and your own class implements ex
@@ -955,7 +955,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.
@@ -1018,7 +1018,7 @@ As in the case of constants, you can access them through either the module class
@@ -1112,7 +1112,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.
@@ -1165,7 +1165,7 @@ The additional support methods need not be generated if none of the enum items h
Simpler Java enums for enums without initializers section.
@@ -1213,7 +1213,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.
@@ -1232,7 +1232,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.
@@ -1320,7 +1320,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.
@@ -1488,7 +1488,7 @@ x.setA(3); // Modify x.a - this is the same as b.f.a
-
@@ -1551,7 +1551,7 @@ int bar = Spam.getBar();
-
@@ -1612,7 +1612,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.
@@ -1667,7 +1667,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).
@@ -1691,7 +1691,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.
@@ -1806,7 +1806,7 @@ void spam(unsigned short); // Ignored
-
@@ -1849,7 +1849,7 @@ Further details on default arguments and how to restore this approach are given
@@ -1927,7 +1927,7 @@ with -package - Java does not support types declared in a named package accessin
-
@@ -1976,7 +1976,7 @@ Obviously, there is more to template wrapping than shown in this example.
More details can be found in the SWIG and C++ chapter.
@@ -2060,7 +2060,7 @@ Foo f = p.__deref__(); // Returns underlying Foo *
-
@@ -2075,7 +2075,7 @@ Finally enum classes are covered.
First, the crucial intermediary JNI class is considered.
@@ -2195,7 +2195,7 @@ If name is the same as modulename then the module class name g
from modulename to modulenameModule.
@@ -2274,7 +2274,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.
@@ -2305,7 +2305,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.
@@ -2356,7 +2356,7 @@ See The intermediary JNI class pragmas secti
@@ -2432,7 +2432,7 @@ int y = f.spam(5, new Foo());
-
@@ -2594,7 +2594,7 @@ and
@@ -2710,7 +2710,7 @@ However, true cross language polymorphism can be achieved using the 22.4.3.3 Proxy classes and garbage collection
+
@@ -2793,7 +2793,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.
@@ -2915,7 +2915,7 @@ For example:
Compatibility note: The generation of this additional parameter did not occur in versions prior to SWIG-1.3.30.
@@ -3003,7 +3003,7 @@ for (int i=0; i<100000; i++) {
-
@@ -3090,7 +3090,7 @@ public static void spam(SWIGTYPE_p_int x, SWIGTYPE_p_int y, int z) { ... }
-
@@ -3099,7 +3099,7 @@ The Enumerations section discussed these but om
The following sub-sections detail the various types of enum classes that can be generated.
@@ -3183,7 +3183,7 @@ The swigValue method is used for marshalling in the other direction.
The toString method is overridden so that the enum name is available.
@@ -3261,7 +3261,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.
@@ -3292,7 +3292,7 @@ public final class Beverage {
-
@@ -3314,7 +3314,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.
@@ -3385,7 +3385,7 @@ public:
-
@@ -3412,7 +3412,7 @@ If the correct implementation is in Java, the Java API is used to call the metho
@@ -3430,7 +3430,7 @@ This situation can be optimized by selectively enabling director methods (using
@@ -3495,7 +3495,7 @@ DirectorDerived::upcall_method() invoked.
-
@@ -3515,7 +3515,7 @@ Macros can be defined on the commandline when compiling your C++ code, or altern
-
@@ -3611,7 +3611,7 @@ class MyProtectedBase extends ProtectedBase
-
@@ -3623,7 +3623,7 @@ be awkward. This section describes some common SWIG features that are used
to improve the interface to existing C/C++ code.
@@ -3689,7 +3689,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.
@@ -3752,7 +3752,7 @@ Vector(2,3,4)
in any way---the extensions only show up in the Java interface.
@@ -3911,7 +3911,7 @@ to raise exceptions. See the SWIG Library ch
The typemap example Handling C++ exception specifications as Java exceptions provides further exception handling capabilities.
@@ -3937,7 +3937,7 @@ protected static void protect_me() {
-
@@ -3947,7 +3947,7 @@ strings and arrays. This chapter discusses the common techniques for
solving these problems.
@@ -4121,7 +4121,7 @@ void foo(Bar *OUTPUT);
will not have the intended effect since typemaps.i does not define an OUTPUT rule for Bar.
@@ -4187,7 +4187,7 @@ System.out.println("3 + 4 = " + result);
See the SWIG Library chapter for further details.
@@ -4254,7 +4254,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.
@@ -4399,7 +4399,7 @@ well suited for applications in which you need to create buffers,
package binary data, etc.
@@ -4516,7 +4516,7 @@ model and use these functions in place of malloc and free in your own
code.
@@ -4537,7 +4537,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.
-
@@ -4689,7 +4689,7 @@ However, the mappings allow the full range of values for each C type from Java.
@@ -4704,7 +4704,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.
@@ -4717,7 +4717,7 @@ Unfortunately it won't of course hold true for JNI code.
@@ -4840,7 +4840,7 @@ int c = example.count('e',"Hello World");
-
@@ -5100,7 +5100,7 @@ These are listed below:
-
@@ -5146,7 +5146,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.
@@ -5297,7 +5297,7 @@ This special variable expands to the intermediary class name. Usually this is th
unless the jniclassname attribute is specified in the %module directive.
@@ -5334,7 +5334,7 @@ If you do not intend your code to be targeting both C and C++ then your typemaps
@@ -5540,7 +5540,7 @@ For the typemap to be used in all type wrapper classes, all the different types
Again this is the same that is in "java.swg", barring the method modifier for getCPtr.
@@ -5765,7 +5765,7 @@ The basic strategy here is to provide a default package typemap for the majority
-
@@ -5775,7 +5775,7 @@ the SWIG library.
@@ -5854,7 +5854,7 @@ This would be done by using the original versions of these typemaps in "enums.sw
@@ -5979,7 +5979,7 @@ We could alternatively have used %rename to rename what() into
@@ -6134,7 +6134,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.
@@ -6278,7 +6278,7 @@ Lastly the "jni", "jtype" and "jstype" typemaps are also required to specify
what Java types to use.
@@ -6360,7 +6360,7 @@ example.foo(new String[]{"red", "green", "blue", "white"});
-
@@ -6478,7 +6478,7 @@ $ java runme
1 12.0 340.0
-
@@ -6684,7 +6684,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.
@@ -6728,7 +6728,7 @@ System.out.println("foo1? " + foo1.equals(foo2));
-
@@ -6787,7 +6787,7 @@ This example contains some useful functionality which you may want in your code.
@@ -6967,7 +6967,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.
@@ -7090,7 +7090,7 @@ public class Bike {
Note the addReference call.
@@ -7206,7 +7206,7 @@ The 'javacode' typemap simply adds in the specified code into the Java proxy cla
-
@@ -7383,7 +7383,7 @@ A few things to note:
-
@@ -7564,10 +7564,10 @@ public abstract class UserVisibleFoo extends Foo {
@@ -7623,7 +7623,7 @@ public class Barmy {
-
@@ -7684,7 +7684,7 @@ All destructors have to be called manually for example the delete_Foo(foo)
-
@@ -7734,7 +7734,7 @@ This directive is only really useful if you want to mix your own hand crafted JN
@@ -7755,7 +7755,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.
@@ -7777,7 +7777,7 @@ The -verbose:jni and -verbose:gc are also useful options for monitoring code beh
diff --git a/Doc/Manual/Lisp.html b/Doc/Manual/Lisp.html
index b9b5b6c1e..92af4e6c9 100644
--- a/Doc/Manual/Lisp.html
+++ b/Doc/Manual/Lisp.html
@@ -6,7 +6,7 @@
@@ -50,7 +50,7 @@
here
@@ -77,7 +77,7 @@ swig -cffi -module module-name file-name
files and the various things which you can do with them.
@@ -118,7 +118,7 @@ swig -cffi -help
- This feature to SWIG (for CFFI) is very new and still far from
@@ -568,7 +568,7 @@ If you have any questions, suggestions, patches, etc., related to CFFI
module feel free to contact us on the SWIG mailing list, and
also please add a "[CFFI]" tag in the subject line.
-
@@ -608,7 +608,7 @@ Note that the block %{ ... %} is effectively a shortcut for
@@ -638,7 +638,7 @@ swig -clisp -module module-name file-name
interface file for the CLISP module. The CLISP module tries to
produce code which is both human readable and easily modifyable.
@@ -671,7 +671,7 @@ and global variables will be created otherwise only definitions for
@@ -795,7 +795,7 @@ struct bar {
-
Lua is an extension programming language designed to support general procedural programming with data description facilities. It also offers good support for object-oriented programming, functional programming, and data-driven programming. Lua is intended to be used as a powerful, light-weight configuration language for any program that needs one. Lua is implemented as a library, written in clean C (that is, in the common subset of ANSI C and C++). Its also a really tiny language, less than 6000 lines of code, which compiles to <100 kilobytes of binary code. It can be found at http://www.lua.org
The current SWIG implementation is designed to work with Lua 5.0.x and Lua 5.1.x. It should work with later versions of Lua, but certainly not with Lua 4.0 due to substantial API changes. ((Currently SWIG generated code has only been tested on Windows with MingW, though given the nature of Lua, is should not have problems on other OS's)). 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).
@@ -105,7 +105,7 @@ This creates a C/C++ source file example_wrap.c or example_wrap.cxx
The name of the wrapper file is derived from the name of the input file. For example, if the input file is example.i, the name of the wrapper file is example_wrap.c. To change this, you can use the -o option. The wrappered module will export one function "int luaopen_example(lua_State* L)" which must be called to register the module with the Lua interpreter. The name "luaopen_example" depends upon the name of the module.
@@ -152,7 +152,7 @@ $ gcc -c example.c -o example.o
$ gcc -I/usr/include/lua -L/usr/lib/lua min.o example_wrap.o example.o -o my_lua
@@ -220,7 +220,7 @@ Is quite obvious (Go back and consult the Lua documents on how to enable loadlib
-
@@ -238,19 +238,19 @@ $ ./my_lua
>
-
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.
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.
@@ -288,7 +288,7 @@ It is also possible to rename the module with an assignment.
24
-
@@ -362,7 +362,7 @@ nil
3.142
-
@@ -385,7 +385,7 @@ example.SUNDAY=0
Constants are not guaranteed to remain constant in Lua. The name of the constant could be accidentally reassigned to refer to some other object. Unfortunately, there is no easy way for SWIG to generate code that prevents this. You will just have to be careful.
@@ -423,7 +423,7 @@ Lua enforces the integrity of its userdata, so it is virtually impossible to cor
nil
-
@@ -509,7 +509,7 @@ Because the pointer points inside the structure, you can modify the contents and
> x.a = 3 -- Modifies the same structure
-
@@ -570,7 +570,7 @@ It is not (currently) possible to access static members of an instance:
-- does NOT work
-
@@ -595,7 +595,7 @@ then the function spam() accepts a Foo pointer or a pointer to any clas
It is safe to use multiple inheritance with SWIG.
@@ -626,7 +626,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.
@@ -712,7 +712,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.
@@ -824,7 +824,7 @@ It is also possible to overload the operator[], but currently this cann
};
-
@@ -879,7 +879,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).
@@ -914,7 +914,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.
@@ -966,7 +966,7 @@ If you ever need to access the underlying pointer returned by operator->(
> f = p:__deref__() -- Returns underlying Foo *
-
@@ -1110,12 +1110,12 @@ add exception specification to functions or globally (respectively).
This section explains what typemaps are and the usage of them. The default wrappering 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 wrappering. This section will be explaining how to use typemaps to best effect 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: 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. 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). Arrays present a challenge for SWIG, because like pointers SWIG does not know whether these are input or output values, nor
@@ -1260,7 +1260,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. 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: 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. Before proceeding, you should read the previous section on using typemaps, as well as read the ready written 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 a idea to base your worn on). 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. 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.
@@ -1374,7 +1374,7 @@ This section covers adding of some small extra bits to your module to add the la
-
@@ -1393,7 +1393,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 wrappering for this function, beyond adding it into the function table. How you write your code is entirely up to you.
@@ -1431,7 +1431,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.
@@ -1442,7 +1442,7 @@ See Examples/lua/arrays for an example of this code.
@@ -1502,7 +1502,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)'.
@@ -1582,7 +1582,7 @@ Note: Both the opaque structures (like the FILE*) and normal wrappered classes/s
Note: Operator overloads are basically done in the same way, by adding functions such as '__add' & '__call' to the classes 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.
diff --git a/Doc/Manual/Modula3.html b/Doc/Manual/Modula3.html
index 71611e3c5..1fd82b459 100644
--- a/Doc/Manual/Modula3.html
+++ b/Doc/Manual/Modula3.html
@@ -5,7 +5,7 @@
@@ -84,7 +84,7 @@ FFTW
-
@@ -131,10 +131,10 @@ functions), but it doesn't allow you to easily integrate a Module-3 module into
a C/C++ project.
@@ -283,7 +283,7 @@ and the principal type must be renamed (%typemap).
@@ -384,10 +384,10 @@ There is no C++ library I wrote a SWIG interface for,
so I'm not sure if this is possible or sensible, yet.
@@ -401,7 +401,7 @@ For testing examples I use Critical Mass cm3.
@@ -478,10 +478,10 @@ Instead generate templates for some basic typemaps.
-
@@ -697,7 +697,7 @@ consist of the following parts:
-
@@ -749,7 +749,7 @@ that I'd like to automate.
@@ -762,7 +762,7 @@ is not really useful, yet.
@@ -797,7 +797,7 @@ IMPORT M3toC;
@@ -821,7 +821,7 @@ you should declare
%typemap("m3wrapinconv:throws") blah * %{OSError.E%}.
@@ -868,10 +868,10 @@ where almost everything is generated by a typemap:
-
This section contains information on SWIG's support of MzScheme.
-
diff --git a/Doc/Manual/Ocaml.html b/Doc/Manual/Ocaml.html
index 6cbfa5510..1a7c4c97c 100644
--- a/Doc/Manual/Ocaml.html
+++ b/Doc/Manual/Ocaml.html
@@ -6,7 +6,7 @@
@@ -99,7 +99,7 @@ file Examples/Makefile illustrate how to compile and link SWIG modules that
will be loaded dynamically. This has only been tested on Linux so far.
@@ -122,7 +122,7 @@ you will compile the file example_wrap.c with ocamlc or
the resulting .ml and .mli files as well, and do the final link with -custom
(not needed for native link).
@@ -158,7 +158,7 @@ the user more freedom with respect to custom typing.
@@ -234,7 +234,7 @@ let b = C_string (getenv "PATH")
-
@@ -248,7 +248,7 @@ When linking any ocaml bytecode with your module, use the -custom
option is not needed when you build native code.
@@ -259,7 +259,7 @@ liberal with pointer types may not compile under the C++ compiler.
Most code meant to be compiled as C++ will not have problems.
@@ -360,7 +360,7 @@ is that you must append them to the return list with swig_result = caml_list_a
signature for a function that uses value in this way.
@@ -394,7 +394,7 @@ it describes the output SWIG will generate for class definitions.
-
@@ -457,7 +457,7 @@ val x : Enum_test.c_obj = C_enum `a
@@ -470,10 +470,10 @@ functions imported from different modules. You must convert values to master
values using the swig_val function before sharing them with another module.
@@ -494,7 +494,7 @@ arrays of simple types with known bounds in your code, but this only works
for arrays whose bounds are completely specified.
@@ -507,7 +507,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.
@@ -521,7 +521,7 @@ Consider writing an object when the ending condition of your array is complex,
such as using a required sentinel, etc.
@@ -572,7 +572,7 @@ void printfloats( float *tab, int len );
-
@@ -615,7 +615,7 @@ the underlying pointer, so using create_[x]_from_ptr alters the
returned value for the same object.
@@ -695,7 +695,7 @@ baz
#
-
@@ -725,7 +725,7 @@ public:
};
-
@@ -800,7 +800,7 @@ class foo {
};
@@ -828,7 +828,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.
@@ -928,7 +928,7 @@ object from causing a core dump, as long as the object is destroyed
properly.
@@ -939,7 +939,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.
@@ -950,7 +950,7 @@ code receives when you are called. In general, a simple directorin typ
can use the same body as a simple out typemap.
@@ -961,7 +961,7 @@ for the same type, except when there are special requirements for object
ownership, etc.
@@ -978,7 +978,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.
diff --git a/Doc/Manual/Octave.html b/Doc/Manual/Octave.html
index be512f0ce..2ceb75ff9 100644
--- a/Doc/Manual/Octave.html
+++ b/Doc/Manual/Octave.html
@@ -8,7 +8,7 @@
The SWIG implemention was first based on Octave 2.9.12, so this is the minimum version required. Testing has only been done on Linux.
@@ -97,7 +97,7 @@ This creates a C++ source file example_wrap.cxx. A C++ file is generate
The swig command line has a number of options you can use, like to redirect it's output. Use swig --help to learn about these.
@@ -124,7 +124,7 @@ $ mkoctfile example_wrap.cxx example.c
@@ -142,10 +142,10 @@ octave:4> example.cvar.Foo=4;
octave:5> example.cvar.Foo
ans = 4
@@ -187,7 +187,7 @@ One can also rename it by simple assignment, e.g.,
octave:1> some_vars = cvar;
-
@@ -204,7 +204,7 @@ int fact(int n);
@@ -257,7 +257,7 @@ octave:2> example.PI=3.142;
octave:3> example.PI
ans = 3.1420
-
@@ -279,7 +279,7 @@ example.SCONST="Hello World"
example.SUNDAY=0
....
-
@@ -326,7 +326,7 @@ octave:2> f=example.fopen("not there","r");
error: value on right hand side of assignment is undefined
error: evaluating assignment expression near line 2, column 2
-
@@ -461,7 +461,7 @@ ans = 1
Depending on the ownership setting of a swig_ref, it may call C++ destructors when its reference count goes to zero. See the section on memory management below for details.
@@ -470,7 +470,7 @@ This information contains the full class hierarchy. When an indexing operation (
the tree is walked to find a match in the current class as well as any of its bases. The lookup is then cached in the swig_ref.
@@ -480,7 +480,7 @@ The dispatch function selects which overload to call (if any) based on the passe
typecheck typemaps are used to analyze each argument, as well as assign precedence. See the chapter on typemaps for details.
@@ -580,7 +580,7 @@ On the C++ side, the default mappings are as follows:
%rename(__brace) *::operator[];
-
@@ -610,7 +610,7 @@ octave:3> printf("%s\n",a);
octave:4> a.__str()
4
-
@@ -687,14 +687,14 @@ ans =
-
C++ smart pointers are fully supported as in other modules.
@@ -774,14 +774,14 @@ c-side routine called
octave-side routine called
-
The use of threads in wrapped Director code is not supported; i.e., an Octave-side implementation of a C++ class must be called from the Octave interpreter's thread. Anything fancier (apartment/queue model, whatever) is left to the user. Without anything fancier, this amounts to the limitation that Octave must drive the module... like, for example, an optimization package that calls Octave to evaluate an objective function.
@@ -815,14 +815,14 @@ The %newobject directive may be used to control this behavior for pointers retur
In the case where one wishes for the C++ side to own an object that was created in Octave (especially a Director object), one can use the __disown() method to invert this logic. Then letting the Octave reference count go to zero will not destroy the object, but destroying the object will invalidate the Octave-side object if it still exists (and call destructors of other C++ bases in the case of multiple inheritance/subclass()'ing).
Various STL library files are provided for wrapping STL containers.
diff --git a/Doc/Manual/Perl5.html b/Doc/Manual/Perl5.html
index 0c2733c0e..5aae51888 100644
--- a/Doc/Manual/Perl5.html
+++ b/Doc/Manual/Perl5.html
@@ -6,7 +6,7 @@
@@ -108,7 +108,7 @@ described. Advanced customization features, typemaps, and other
options are found near the end of the chapter.
@@ -133,7 +133,7 @@ To build the module, you will need to compile the file
example_wrap.c and link it with the rest of your program.
@@ -165,7 +165,7 @@ loaded, an easy way to find out is to run Perl itself.
@@ -198,7 +198,7 @@ the target should be named `example.so',
`example.sl', or the appropriate dynamic module name on your system.
@@ -232,7 +232,7 @@ the preferred approach to compilation. More information about MakeMaker can be
found in "Programming Perl, 2nd ed." by Larry Wall, Tom Christiansen,
and Randal Schwartz.
@@ -301,7 +301,7 @@ added to it. Depending on your machine, you may need to link with
additional libraries such as -lsocket, -lnsl, -ldl, etc.
@@ -456,7 +456,7 @@ system configuration (this requires root access and you will need to
read the man pages).
@@ -599,7 +599,7 @@ have to find the macro that conflicts and add an #undef into the .i file. Pleas
any conflicting macros you find to swig-user mailing list.
@@ -626,7 +626,7 @@ also introduce problems on platforms that support more than one
linking standard (e.g., -o32 and -n32 on Irix).
@@ -637,7 +637,7 @@ section assumes you are using SWIG with Microsoft Visual C++
although the procedure may be similar with other compilers.
@@ -700,7 +700,7 @@ print "$a\n";
-
@@ -708,7 +708,7 @@ SWIG is known to work with Cygwin and may work with other compilers on Windows.
For general hints and suggestions refer to the Windows chapter.
@@ -718,7 +718,7 @@ can be used to control your application. However, it is also used to
construct more user-friendly proxy classes as described in the next section.
@@ -741,7 +741,7 @@ use example;
$a = &example::fact(2);
-
@@ -811,7 +811,7 @@ extern char *path; // Declared later in the input
-
@@ -851,7 +851,7 @@ print example::FOO,"\n";
-
@@ -960,7 +960,7 @@ as XS and xsubpp. Given the advancement of the SWIG typesystem and the
SWIG and XS, this is no longer supported.
@@ -1094,7 +1094,7 @@ void Bar_f_set(Bar *b, Foo *val) {
-
@@ -1159,7 +1159,7 @@ provides direct access to C++ objects. A higher level interface using Perl prox
can be built using these low-level accessors. This is described shortly.
@@ -1195,7 +1195,7 @@ If necessary, the type-checker also adjusts the value of the pointer (as is nece
multiple inheritance is used).
@@ -1239,7 +1239,7 @@ example::Spam_foo_d($s,3.14);
Please refer to the "SWIG Basics" chapter for more information.
@@ -1266,7 +1266,7 @@ The following C++ operators are currently supported by the Perl module:
@@ -1361,7 +1361,7 @@ print Foo::fact(4),"\n"; # Call a function in package FooBar
-->
-
@@ -1580,7 +1580,7 @@ print "$c\n";
Note: The REFERENCE feature is only currently supported for numeric types (integers and floating point).
@@ -1745,7 +1745,7 @@ This is still supported, but it is deprecated. The newer %exception di
functionality, but it has additional capabilities that make it more powerful.
@@ -1762,7 +1762,7 @@ Typemaps are only used if you want to change some aspect of the primitive
C-Perl interface.
@@ -1866,7 +1866,7 @@ example::count("e","Hello World");
-
@@ -1971,7 +1971,7 @@ Return of C++ member data (all languages).
Check value of input parameter.
-
@@ -2042,7 +2042,7 @@ properly assigned.
The Perl name of the wrapper function being created.
-
@@ -2111,7 +2111,7 @@ int sv_isa(SV *, char *0;
-
@@ -2120,7 +2120,7 @@ might look at the files "perl5.swg" and "typemaps.i" in
the SWIG library.
@@ -2212,7 +2212,7 @@ print @$b,"\n"; # Print it out
-
@@ -2241,7 +2241,7 @@ can be done using the EXTEND() macro as in :
}
-
@@ -2295,7 +2295,7 @@ print "multout(7,13) = @r\n";
($x,$y) = multout(7,13);
-
@@ -2358,7 +2358,7 @@ the "in" typemap in the previous section would be used to convert an
to copy the converted array into a C data structure.
@@ -2423,7 +2423,7 @@ print "$c\n";
-
@@ -2502,7 +2502,7 @@ For example:
-
@@ -2518,7 +2518,7 @@ to the underlying code. This section describes the implementation
details of the proxy interface.
@@ -2540,7 +2540,7 @@ SWIG creates a collection of high-level Perl wrappers. In your scripts, you wil
high level wrappers. The wrappers, in turn, interact with the low-level procedural module.
@@ -2666,7 +2666,7 @@ $v->DESTROY();
-
@@ -2753,7 +2753,7 @@ counting, garbage collection, or advanced features one might find in
sophisticated languages.
@@ -2806,7 +2806,7 @@ $p->{f}->{x} = 0.0;
%${$p->{v}} = ( x=>0, y=>0, z=>0);
-
@@ -2840,7 +2840,7 @@ This function replaces the original function, but operates in an
identical manner.
@@ -2916,7 +2916,7 @@ particular, inheritance of data members is extremely tricky (and I'm
not even sure if it really works).
@@ -2944,7 +2944,7 @@ public:
};
-
diff --git a/Doc/Manual/Php.html b/Doc/Manual/Php.html
index c9ee74f38..797cb058e 100644
--- a/Doc/Manual/Php.html
+++ b/Doc/Manual/Php.html
@@ -7,7 +7,7 @@
@@ -122,7 +122,7 @@ and it doesn't play nicely with package system. We don't recommend
this approach, or provide explicit support for it.
@@ -137,7 +137,7 @@ least work for Linux though):
gcc -shared example_wrap.o -o example.so
@@ -168,7 +168,7 @@ attempts to do the dl() call for you:
include("example.php");
-
@@ -178,7 +178,7 @@ possible for names of symbols in one extension module to clash with
other symbols unless care is taken to %rename them.
@@ -303,7 +303,7 @@ both point to the same value, without the case test taking place. (
Apologies, this paragraph needs rewriting to make some sense. )
@@ -352,7 +352,7 @@ undefined.
At this time SWIG does not support custom accessor methods.
@@ -405,7 +405,7 @@ print $s; # The value of $s was not changed.
-->
-
@@ -461,7 +461,7 @@ taking the integer argument.
@@ -593,7 +593,7 @@ PHP in a number of ways: by using unset on an existing
variable, or assigning NULL to a variable.
@@ -652,7 +652,7 @@ Would be used in the following way from PHP5:
Member variables and methods are accessed using the -> operator.
@@ -678,7 +678,7 @@ Complex_im_set($obj,$d);
Complex_im_get($obj);
-
@@ -719,7 +719,7 @@ the programmer can either reassign the variable or call
unset($v)
@@ -762,7 +762,7 @@ Ko::threats(10);
echo "There has now been " . Ko::threats() . " threats\n";
-
@@ -784,7 +784,7 @@ Ko::threats();
-
@@ -872,7 +872,7 @@ The %rinit and %rshutdown statements are very similar but inse
into the request init (PHP_RINIT_FUNCTION) and request shutdown (PHP_RSHUTDOWN_FUNCTION) code respectively.
@@ -907,7 +907,7 @@ wrapper functions takes care of all the cross-language method routing
transparently.
@@ -999,7 +999,7 @@ class MyFoo extends Foo {
-
@@ -1135,7 +1135,7 @@ In this example, we are assuming that FooContainer will take care of
deleting all the Foo pointers it contains at some point.
@@ -1194,7 +1194,7 @@ Swig::DirectorMethodException is thrown, PHP will register the exception
as soon as the C wrapper function returns.
@@ -1227,7 +1227,7 @@ optimized by selectively enabling director methods (using the %feature
directive) for only those methods that are likely to be extended in PHP.
@@ -1241,7 +1241,7 @@ need to be supported.
Director typemaps for STL classes are mostly in place, and hence you
diff --git a/Doc/Manual/Pike.html b/Doc/Manual/Pike.html
index 8f9e43735..8bd6b410f 100644
--- a/Doc/Manual/Pike.html
+++ b/Doc/Manual/Pike.html
@@ -6,7 +6,7 @@
@@ -94,7 +94,7 @@ can use the -o option:
@@ -114,7 +114,7 @@ You're looking for files with the names global.h, program.h
and so on.
@@ -129,10 +129,10 @@ Pike v7.4 release 10 running Hilfe v3.5 (Incremental Pike Frontend)
(1) Result: 24
@@ -143,7 +143,7 @@ concerned), SWIG's %module directive doesn't really have any
significance.
@@ -168,7 +168,7 @@ exactly as you'd expect it to:
(1) Result: 24
-
@@ -197,7 +197,7 @@ will result in two functions, Foo_get() and Foo_set():
(3) Result: 3.141590
-
@@ -205,7 +205,7 @@ Enumerated types in C/C++ declarations are wrapped as Pike constants,
not as Pike enums.
@@ -213,7 +213,7 @@ Constructors are wrapped as create() methods, and destructors are
wrapped as destroy() methods, for Pike classes.
diff --git a/Doc/Manual/Python.html b/Doc/Manual/Python.html
index 084ad3eab..cacb9a368 100644
--- a/Doc/Manual/Python.html
+++ b/Doc/Manual/Python.html
@@ -6,7 +6,7 @@
@@ -155,10 +155,10 @@ described followed by a discussion of low-level implementation
details.
@@ -256,7 +256,7 @@ The following sections have further practical examples and details on
how you might go about compiling and using the generated files.
@@ -348,7 +348,7 @@ This same approach works on all platforms if the appropriate compiler is install
can even build extensions to the standard Windows Python using MingGW)
@@ -396,7 +396,7 @@ module actually consists of two files; socket.py and
@@ -475,7 +475,7 @@ If using static linking, you might want to rely on a different approach
(perhaps using distutils).
@@ -632,7 +632,7 @@ system configuration (this requires root access and you will need to
read the man pages).
@@ -724,7 +724,7 @@ erratic program behavior. If working with lots of software components, you
might want to investigate using a more formal standard such as COM.
@@ -761,7 +761,7 @@ and -m64 allow you to choose the desired binary format for your python
extension.
@@ -870,7 +870,7 @@ SWIG Wiki.
@@ -879,7 +879,7 @@ to your C/C++ code. Functions are wrapped as functions, classes are wrapped as
This section briefly covers the essential aspects of this wrapping.
@@ -892,7 +892,7 @@ module name, make sure you don't use the same name as a built-in
Python command or standard module name.
@@ -916,7 +916,7 @@ like you think it does:
>>>
@@ -1054,7 +1054,7 @@ that starts with a leading underscore. SWIG does not create cvar
if there are no global variables in a module.
@@ -1094,7 +1094,7 @@ other object. Unfortunately, there is no easy way for SWIG to
generate code that prevents this. You will just have to be careful.
@@ -1235,7 +1235,7 @@ C-style cast may return a bogus result whereas as the C++-style cast will return
None if the conversion can't be performed.
@@ -1424,7 +1424,7 @@ everything works just like you would expect. For example:
-
@@ -1513,7 +1513,7 @@ they are accessed through cvar like this:
-
@@ -1568,7 +1568,7 @@ then the function spam() accepts Foo * or a pointer to any cla
It is safe to use multiple inheritance with SWIG.
@@ -1629,7 +1629,7 @@ treated as a returning value, and it will follow the same
allocation/deallocation process.
@@ -1752,7 +1752,7 @@ first declaration takes precedence.
Please refer to the "SWIG and C++" chapter for more information about overloading.
@@ -1841,7 +1841,7 @@ Also, be aware that certain operators don't map cleanly to Python. For instance
overloaded assignment operators don't map to Python semantics and will be ignored.
@@ -1908,7 +1908,7 @@ utilizes thousands of small deeply nested namespaces each with
identical symbol names, well, then you get what you deserve.
@@ -1962,7 +1962,7 @@ Some more complicated
examples will appear later.
@@ -2047,7 +2047,7 @@ simply use the __deref__() method. For example:
-
@@ -2190,7 +2190,7 @@ python releases the proxy instance.
@@ -2203,7 +2203,7 @@ of low-level details were omitted. This section provides a brief overview
of how the proxy classes work.
@@ -2292,7 +2292,7 @@ you can attach new Python methods to the class and you can even inherit from it
by Python built-in types until Python 2.2).
@@ -2484,7 +2484,7 @@ It is also possible to deal with situations like this using
typemaps--an advanced topic discussed later.
@@ -2521,7 +2521,7 @@ class itself. In Python-2.1 and earlier, they have to be accessed as a global
function or through an instance (see the earlier section).
@@ -2555,7 +2555,7 @@ proxy classes, director classes, and C wrapper functions takes care of
all the cross-language method routing transparently.
@@ -2648,7 +2648,7 @@ class MyFoo(mymodule.Foo):
-
@@ -2797,7 +2797,7 @@ deleting all the Foo pointers it contains at some point. Note that no hard
references to the Foo objects remain in Python.
@@ -2856,7 +2856,7 @@ Swig::DirectorMethodException is thrown, Python will register the
exception as soon as the C wrapper function returns.
@@ -2890,7 +2890,7 @@ directive) for only those methods that are likely to be extended in
Python.
@@ -2904,7 +2904,7 @@ need to be supported.
@@ -2951,7 +2951,7 @@ methods that return const references.
@@ -2964,7 +2964,7 @@ This section describes some common SWIG features that are used to
improve your the interface to an extension module.
@@ -3045,7 +3045,7 @@ hard to implement. It is possible to clean this up using Python code, typemaps,
customization features as covered in later sections.
@@ -3194,7 +3194,7 @@ public:
-
@@ -3283,7 +3283,7 @@ Vector(12,14,16)
in any way---the extensions only show up in the Python interface.
@@ -3409,7 +3409,7 @@ The language-independent exception.i library file can also be used
to raise exceptions. See the SWIG Library chapter.
@@ -3419,7 +3419,7 @@ strings, binary data, and arrays. This chapter discusses the common techniques
solving these problems.
@@ -3632,7 +3632,7 @@ void foo(Bar *OUTPUT);
may not have the intended effect since typemaps.i does not define an OUTPUT rule for Bar.
@@ -3701,7 +3701,7 @@ If you replace %pointer_functions() by %pointer_class(type,name)SWIG Library chapter for further details.
@@ -3763,7 +3763,7 @@ well suited for applications in which you need to create buffers,
package binary data, etc.
@@ -3832,7 +3832,7 @@ If you need to return binary data, you might use the
also be used to extra binary data from arbitrary pointers.
@@ -3849,7 +3849,7 @@ Typemaps are only used if you want to change some aspect of the primitive
C-Python interface or if you want to elevate your guru status.
@@ -3965,7 +3965,7 @@ parameter is omitted):
-
@@ -4006,7 +4006,7 @@ a look at the SWIG library version 1.3.20 or so.
@@ -4077,7 +4077,7 @@ properly assigned.
The Python name of the wrapper function being created.
-
@@ -4205,7 +4205,7 @@ write me
-
@@ -4214,7 +4214,7 @@ might look at the files "python.swg" and "typemaps.i" in
the SWIG library.
@@ -4294,7 +4294,7 @@ memory allocation is used to allocate memory for the array, the
the C function.
@@ -4373,7 +4373,7 @@ to supply the argument count. This is automatically set by the typemap code. F
-
@@ -4462,7 +4462,7 @@ function can now be used as follows:
>>>
-
@@ -4511,7 +4511,7 @@ array, such an approach would not be recommended for huge arrays, but
for small structures, this approach works fine.
@@ -4600,7 +4600,7 @@ static int convert_darray(PyObject *input, double *ptr, int size) {
-
@@ -4697,7 +4697,7 @@ class object (if applicable).
-
@@ -4725,7 +4725,7 @@ of your users much simpler.
@@ -4759,7 +4759,7 @@ layout of controls on a panel, etc. to be loaded from an XML file."
-
@@ -4786,7 +4786,7 @@ names, default values if any, and return type if any. There are also
three options for autodoc controlled by the value given to the
feature, described below.
-
@@ -4815,7 +4815,7 @@ def function_name(*args, **kwargs):
-
@@ -4840,7 +4840,7 @@ def function_name(*args, **kwargs):
-
@@ -4859,7 +4859,7 @@ void GetPosition(int* OUTPUT, int* OUTPUT);
-
@@ -4891,7 +4891,7 @@ with more than one line.
-
@@ -4918,7 +4918,7 @@ and also in base class declarations, etc. if the package name is
different than its own.
@@ -4945,7 +4945,7 @@ The following are Python 3.0 new features that are currently supported by
SWIG.
@@ -4977,7 +4977,7 @@ all overloaded functions share the same function in SWIG generated proxy class.
For detailed usage of function annotation, see PEP 3107.
@@ -5129,7 +5129,7 @@ modify the buffer.
-
diff --git a/Doc/Manual/R.html b/Doc/Manual/R.html
index 679718400..e8cee6448 100644
--- a/Doc/Manual/R.html
+++ b/Doc/Manual/R.html
@@ -6,7 +6,7 @@
@@ -45,7 +45,7 @@ Currently the following features are not implemented or broken:
@@ -119,7 +119,7 @@ Without it, inheritance of wrapped objects may fail.
These two files can be loaded in any order
@@ -146,7 +146,7 @@ wrapping over the underlying functions and rely on the R type system
to provide R syntax.
@@ -155,7 +155,7 @@ and [ are overloaded to allow for R syntax (one based indices and
slices)
@@ -167,7 +167,7 @@ keep track of the pointer object which removes the necessity for a lot
of the proxy class baggage you see in other languages.
diff --git a/Doc/Manual/Ruby.html b/Doc/Manual/Ruby.html
index a08f497d5..f21e353ce 100644
--- a/Doc/Manual/Ruby.html
+++ b/Doc/Manual/Ruby.html
@@ -7,7 +7,7 @@
SWIG 1.3 is known to work with Ruby versions 1.6 and later.
@@ -171,7 +171,7 @@ of Ruby. To build a Ruby module, run SWIG using the -ruby
@@ -225,7 +225,7 @@ to compile this file and link it with the rest of your program. In order to compile the wrapper code, the compiler needs the ruby.h
@@ -274,7 +274,7 @@ installed, you can run Ruby to find out. For example: Ruby extension modules are typically compiled into shared
@@ -428,7 +428,7 @@ manual pages for your compiler and linker to determine the correct set
of options. You might also check the SWIG Wiki
for additional information. Ruby module names must be capitalized,
@@ -488,7 +488,7 @@ begins with: An alternative approach to dynamic linking is to rebuild the
@@ -509,7 +509,7 @@ finally rebuilding Ruby. On most machines, C++ extension modules should be linked
@@ -561,7 +561,7 @@ extension, e.g. Building a SWIG extension to Ruby under Windows 95/NT is
@@ -600,7 +600,7 @@ files. If you are developing your application within Microsoft
@@ -742,7 +742,7 @@ directory, then run the Ruby script from the DOS/Command prompt: This section describes the basics of how SWIG maps C or C++
@@ -752,7 +752,7 @@ declarations in your SWIG interface files to Ruby constructs. The SWIG %module directive specifies
@@ -921,7 +921,7 @@ Ruby's built-in names. Global functions are wrapped as Ruby module methods. For
@@ -984,7 +984,7 @@ module that can be used like so: C/C++ global variables are wrapped as a pair of singleton
@@ -1084,7 +1084,7 @@ effect until it is explicitly disabled using %mutable.
- C/C++ constants are wrapped as module constants initialized
@@ -1128,7 +1128,7 @@ constant values, e.g. "Opaque" pointers to arbitrary C/C++ types (i.e. types that
@@ -1180,7 +1180,7 @@ the Ruby nil object. C/C++ structs are wrapped as Ruby classes, with accessor
@@ -1355,7 +1355,7 @@ pointers. For example, Like structs, C++ classes are wrapped by creating a new Ruby
@@ -1441,7 +1441,7 @@ class.
- The SWIG type-checker is fully aware of C++ inheritance.
@@ -1672,7 +1672,7 @@ Typing"). C++ overloaded functions, methods, and constructors are
@@ -1872,7 +1872,7 @@ and C++" chapter for more information about overloading. For the most part, overloaded operators are handled
@@ -1953,7 +1953,7 @@ on operator overloading. SWIG is aware of C++ namespaces, but namespace names do not
@@ -2029,7 +2029,7 @@ identical symbol names, well, then you get what you deserve. C++ templates don't present a huge problem for SWIG. However,
@@ -2073,7 +2073,7 @@ directive. For example: On a related note, the standard SWIG library contains a
@@ -2326,7 +2326,7 @@ chapter. Some containers in the STL allow you to modify their default
@@ -2526,7 +2526,7 @@ b The STL is well known for the use of iterators. There
@@ -2737,7 +2737,7 @@ i In certain C++ programs, it is common to use classes that
@@ -2862,7 +2862,7 @@ method. For example: SWIG's Ruby module supports cross-language polymorphism
@@ -2875,7 +2875,7 @@ using this feature with Ruby. Whenever a C++ director class routes one of its virtual
@@ -2913,7 +2913,7 @@ caught here and a C++ exception is raised in its place. Ruby has several common naming conventions. Constants are
@@ -3009,7 +3009,7 @@ planned to become the default option in future releases. It's a fairly common practice in the Ruby built-ins and
@@ -3101,7 +3101,7 @@ Features") for more details). Ruby methods that return a boolean value and end in a
@@ -3190,7 +3190,7 @@ Features") for more details). Ruby methods that modify an object in-place and end in an
@@ -3254,7 +3254,7 @@ Features") for more details). Often times a C++ library will expose properties through
@@ -3324,7 +3324,7 @@ methods to be exposed in Ruby as value and value=.
- A common problem in some C programs is handling parameters
@@ -3575,10 +3575,10 @@ of %apply The SWIG %exception directive can be
@@ -3673,7 +3673,7 @@ Features for more examples. One of the highlights of Ruby and most of its standard library
@@ -3854,7 +3854,7 @@ RUBY_YIELD_SELF ); For more information on typemaps, see Typemaps. There are three ways to raise exceptions from C++ code to
@@ -4615,7 +4615,7 @@ the built-in Ruby exception types. Starting with SWIG 1.3.28, the Ruby module supports the %exceptionclass
@@ -4673,7 +4673,7 @@ providing for a more natural integration between C++ code and Ruby code. This section describes how you can modify SWIG's default
@@ -4696,7 +4696,7 @@ of the primitive C-Ruby interface. A typemap is nothing more than a code generation rule that is
@@ -4958,7 +4958,7 @@ to be used as follows (notice how the length parameter is omitted): Once defined, a typemap remains in effect for all of the
@@ -5006,7 +5006,7 @@ where the class itself is defined. For example: A typemap is copied by using assignment. For example: A typemap can be deleted by simply defining no code. For
@@ -5160,7 +5160,7 @@ typemaps immediately after the clear operation. Typemap declarations can be declared in the global scope,
@@ -5244,7 +5244,7 @@ string
- The following list details all of the typemap methods that
@@ -5254,7 +5254,7 @@ can be used by the Ruby module: Converts Ruby objects to input
@@ -5497,7 +5497,7 @@ arguments to be specified. For example: The "typecheck" typemap is used to support overloaded
@@ -5538,7 +5538,7 @@ on "Typemaps and Overloading." Converts return value of a C function
@@ -5770,7 +5770,7 @@ version of the C datatype matched by the typemap.
- The "arginit" typemap is used to set the initial value of a
@@ -5795,7 +5795,7 @@ applications. For example: The "default" typemap is used to turn an argument into a
@@ -5837,7 +5837,7 @@ default argument wrapping. The "check" typemap is used to supply value checking code
@@ -5861,7 +5861,7 @@ arguments have been converted. For example: The "argout" typemap is used to return values from arguments.
@@ -6019,7 +6019,7 @@ some function like SWIG_Ruby_AppendOutput. The "freearg" typemap is used to cleanup argument data. It is
@@ -6055,7 +6055,7 @@ abort prematurely. The "newfree" typemap is used in conjunction with the %newobject
@@ -6086,7 +6086,7 @@ ownership and %newobject for further details. The "memberin" typemap is used to copy data from an
@@ -6119,7 +6119,7 @@ other objects. The "varin" typemap is used to convert objects in the target
@@ -6130,7 +6130,7 @@ This is implementation specific. The "varout" typemap is used to convert a C/C++ object to an
@@ -6141,7 +6141,7 @@ This is implementation specific. The "throws" typemap is only used when SWIG parses a C++
@@ -6200,7 +6200,7 @@ handling with %exception section. Converts C++ objects in director
@@ -6454,7 +6454,7 @@ referring to the class itself.
- Converts Ruby objects in director
@@ -6714,7 +6714,7 @@ exception. Output argument processing in director
@@ -6954,7 +6954,7 @@ referring to the instance of the class itself
- Cleanup of function return values
@@ -6964,7 +6964,7 @@ referring to the instance of the class itself
- Setting of C global variables
@@ -6974,7 +6974,7 @@ referring to the instance of the class itself
-
@@ -7084,7 +7084,7 @@ being created. When you write a typemap, you usually have to work directly
@@ -7108,7 +7108,7 @@ across multiple languages. Here, while the Ruby versions return the value directly, the SWIG
@@ -7253,7 +7253,7 @@ Ruby_Format_TypeError( "$1_name", "$1_type","$symname", $argnum, $input
- RSTRING_LEN(str) void rb_raise(VALUE exception, const char *fmt,
@@ -7483,7 +7483,7 @@ arguments are interpreted as with printf(). void rb_iter_break() This section includes a few examples of typemaps. For more
@@ -7596,7 +7596,7 @@ directory. A common problem in many C programs is the processing of
@@ -7651,7 +7651,7 @@ after the execution of the C function. Ruby's solution to the "keyword arguments" capability of some
@@ -7930,7 +7930,7 @@ directory of the SWIG distribution. Occasionally, it might be necessary to convert pointer values
@@ -8029,7 +8029,7 @@ For example: VALUE Data_Wrap_Struct(VALUE class, void
@@ -8080,7 +8080,7 @@ and assigns that pointer to ptr. Another use for macros and type maps is to create a Ruby array
@@ -8189,7 +8189,7 @@ the C++ Standard Template Library.
@@ -8250,7 +8250,7 @@ generate ri documentation from a c wrap file, you could do:
@@ -8301,7 +8301,7 @@ macro. For example:
- Since SWIG does know everything about the function it wraps,
@@ -8330,7 +8330,7 @@ feature, described below.
-
@@ -8378,7 +8378,7 @@ Then Ruby code like this will be generated:
-
@@ -8410,7 +8410,7 @@ this:
-
@@ -8426,7 +8426,7 @@ this:
-
@@ -8454,7 +8454,7 @@ this:
-
@@ -8482,7 +8482,7 @@ generated string. For example:
-
@@ -8497,10 +8497,10 @@ docstring and they are output together. SWIG allows operator overloading with, by using the %extend
@@ -9517,7 +9517,7 @@ parses the expression a != b as !(a == b).
- The chapter on Working
@@ -9698,7 +9698,7 @@ initialized: The Ruby language doesn't support multiple inheritance, but
@@ -9796,7 +9796,7 @@ Features") for more details). One of the most common issues in generating SWIG bindings for
@@ -9843,7 +9843,7 @@ understanding of how the underlying library manages memory. Ruby uses a mark and sweep garbage collector. When the garbage
@@ -9891,7 +9891,7 @@ this memory. As described above, memory management depends on clearly
@@ -10149,7 +10149,7 @@ public:
- The remaining parts of this section will use the class library
@@ -10400,7 +10400,7 @@ methods. With a bit more testing, we see that our class library still
@@ -10518,7 +10518,7 @@ test suite. By default, SWIG creates a "free" function that is called when
@@ -10768,7 +10768,7 @@ been freed, and thus raises a runtime exception. As has been said, the Ruby GC runs and marks objects before
diff --git a/Doc/Manual/Tcl.html b/Doc/Manual/Tcl.html
index 7a4a85de9..c677f6eed 100644
--- a/Doc/Manual/Tcl.html
+++ b/Doc/Manual/Tcl.html
@@ -6,7 +6,7 @@
@@ -109,7 +109,7 @@ build a Tcl extension module. To finish building the module, you
need to compile this file and link it with the rest of your program.
@@ -127,7 +127,7 @@ this is the case, you should probably make a symbolic link so that tcl.h
-
@@ -162,7 +162,7 @@ The name of the module is specified using the %module directive or the
-module command line option.
@@ -228,7 +228,7 @@ minimal in most situations (and quite frankly not worth the extra
hassle in the opinion of this author).
@@ -356,7 +356,7 @@ to the default system configuration (this requires root access and you will need
the man pages).
@@ -439,7 +439,7 @@ erratic program behavior. If working with lots of software components, you
might want to investigate using a more formal standard such as COM.
@@ -466,7 +466,7 @@ also introduce problems on platforms that support more than one
linking standard (e.g., -o32 and -n32 on Irix).
@@ -485,7 +485,7 @@ option will append the prefix to the name when creating a command and
call it "Foo_bar".
@@ -507,7 +507,7 @@ When the -namespace option is used, objects in the module
are always accessed with the namespace name such as Foo::bar.
@@ -518,7 +518,7 @@ covers the process of using SWIG with Microsoft Visual C++.
although the procedure may be similar with other compilers.
@@ -576,7 +576,7 @@ MSDOS > tclsh80
%
@@ -639,7 +639,7 @@ to get you started. With a little practice, you'll be making lots of
Tcl extensions.
@@ -650,7 +650,7 @@ classes. This section briefly covers the essential aspects of this
wrapping.
@@ -684,7 +684,7 @@ To fix this, supply an extra argument to load like this:
-
@@ -709,7 +709,7 @@ like you think it does:
%
-
@@ -789,7 +789,7 @@ extern char *path; // Read-only (due to %immutable)
-
@@ -873,7 +873,7 @@ When an identifier name is given, it is used to perform an implicit hash-table l
conversion. This allows the global statement to be omitted.
@@ -969,7 +969,7 @@ C-style cast may return a bogus result whereas as the C++-style cast will return
None if the conversion can't be performed.
@@ -1251,7 +1251,7 @@ Note: Tcl only destroys the underlying object if it has ownership. See the
memory management section that appears shortly.
@@ -1318,7 +1318,7 @@ In Tcl, the static member is accessed as follows:
-
@@ -1367,7 +1367,7 @@ For instance:
It is safe to use multiple inheritance with SWIG.
@@ -1421,7 +1421,7 @@ to hold the result and a pointer is returned (Tcl will release this memory
when the return value is garbage collected).
@@ -1544,7 +1544,7 @@ first declaration takes precedence.
Please refer to the "SWIG and C++" chapter for more information about overloading.
@@ -1646,7 +1646,7 @@ There are ways to make this operator appear as part of the class using the %
Keep reading.
@@ -1710,7 +1710,7 @@ utilizes thousands of small deeply nested namespaces each with
identical symbol names, well, then you get what you deserve.
@@ -1762,7 +1762,7 @@ More details can be found in the SWIG and C++
-
@@ -1846,7 +1846,7 @@ simply use the __deref__() method. For example:
-
@@ -1859,7 +1859,7 @@ of low-level details were omitted. This section provides a brief overview
of how the proxy classes work.
@@ -1924,7 +1924,7 @@ function. This allows objects to be encapsulated objects that look a lot like
as shown in the last section.
@@ -2112,7 +2112,7 @@ typemaps--an advanced topic discussed later.
@@ -2300,7 +2300,7 @@ set c [lindex $dim 1]
-
@@ -2434,7 +2434,7 @@ Since SWIG's exception handling is user-definable, you are not limited to C++ ex
See the chapter on "Customization Features" for more examples.
@@ -2451,7 +2451,7 @@ Typemaps are only used if you want to change some aspect of the primitive
C-Tcl interface.
@@ -2568,7 +2568,7 @@ parameter is omitted):
-
@@ -2706,7 +2706,7 @@ Initialize an argument to a value before any conversions occur.
Examples of these methods will appear shortly.
@@ -2777,7 +2777,7 @@ properly assigned.
The Tcl name of the wrapper function being created.
-
@@ -2839,7 +2839,7 @@ argv[2] = Larry
3
-
@@ -2881,7 +2881,7 @@ result, a Tcl function using these typemaps will work like this :
%
-
@@ -2958,7 +2958,7 @@ int Tcl_IsShared(Tcl_Obj *obj);
-
@@ -3042,7 +3042,7 @@ work)
-
@@ -3118,7 +3118,7 @@ For example:
-
@@ -3190,7 +3190,7 @@ As a final note, most SWIG examples do not yet use the
to use the load command instead.
@@ -3289,7 +3289,7 @@ danger of blowing something up (although it is easily accomplished
with an out of bounds array access).
@@ -3410,7 +3410,7 @@ short, but clever Tcl script can be combined with SWIG to do many
interesting things.
-procdoc
@@ -553,7 +553,7 @@ like this:
typemap argument doc. See Lib/guile/typemaps.i for
details.
-21.9 Procedures with setters
+22.9 Procedures with setters
(struct-member-get
pointer) and (struct-member-set pointer
value) are not generated.
-21.10 GOOPS Proxy Classes
+22.10 GOOPS Proxy Classes
%import "foo.h" before the %inline block.
21.10.1 Naming Issues
+22.10.1 Naming Issues
21.10.2 Linking
+22.10.2 Linking
22 SWIG and Java
+23 SWIG and Java
@@ -154,7 +154,7 @@ It covers most SWIG features, but certain low-level details are covered in less
-
22.1 Overview
+23.1 Overview
22.2 Preliminaries
+23.2 Preliminaries
22.2.1 Running SWIG
+23.2.1 Running SWIG
22.2.2 Additional Commandline Options
+23.2.2 Additional Commandline Options
22.2.3 Getting the right header files
+23.2.3 Getting the right header files
22.2.4 Compiling a dynamic module
+23.2.4 Compiling a dynamic module
22.2.5 Using your module
+23.2.5 Using your module
22.2.6 Dynamic linking problems
+23.2.6 Dynamic linking problems
22.2.7 Compilation problems and compiling with C++
+23.2.7 Compilation problems and compiling with C++
22.2.8 Building on Windows
+23.2.8 Building on Windows
22.2.8.1 Running SWIG from Visual Studio
+23.2.8.1 Running SWIG from Visual Studio
22.2.8.2 Using NMAKE
+23.2.8.2 Using NMAKE
22.3 A tour of basic C/C++ wrapping
+23.3 A tour of basic C/C++ wrapping
22.3.1 Modules, packages and generated Java classes
+23.3.1 Modules, packages and generated Java classes
22.3.2 Functions
+23.3.2 Functions
22.3.3 Global variables
+23.3.3 Global variables
22.3.4 Constants
+23.3.4 Constants
22.3.5 Enumerations
+23.3.5 Enumerations
22.3.5.1 Anonymous enums
+23.3.5.1 Anonymous enums
22.3.5.2 Typesafe enums
+23.3.5.2 Typesafe enums
22.3.5.3 Proper Java enums
+23.3.5.3 Proper Java enums
22.3.5.4 Type unsafe enums
+23.3.5.4 Type unsafe enums
22.3.5.5 Simple enums
+23.3.5.5 Simple enums
22.3.6 Pointers
+23.3.6 Pointers
22.3.7 Structures
+23.3.7 Structures
22.3.8 C++ classes
+23.3.8 C++ classes
22.3.9 C++ inheritance
+23.3.9 C++ inheritance
22.3.10 Pointers, references, arrays and pass by value
+23.3.10 Pointers, references, arrays and pass by value
22.3.10.1 Null pointers
+23.3.10.1 Null pointers
22.3.11 C++ overloaded functions
+23.3.11 C++ overloaded functions
22.3.12 C++ default arguments
+23.3.12 C++ default arguments
22.3.13 C++ namespaces
+23.3.13 C++ namespaces
22.3.14 C++ templates
+23.3.14 C++ templates
22.3.15 C++ Smart Pointers
+23.3.15 C++ Smart Pointers
22.4 Further details on the generated Java classes
+23.4 Further details on the generated Java classes
22.4.1 The intermediary JNI class
+23.4.1 The intermediary JNI class
22.4.1.1 The intermediary JNI class pragmas
+23.4.1.1 The intermediary JNI class pragmas
22.4.2 The Java module class
+23.4.2 The Java module class
22.4.2.1 The Java module class pragmas
+23.4.2.1 The Java module class pragmas
22.4.3 Java proxy classes
+23.4.3 Java proxy classes
22.4.3.1 Memory management
+23.4.3.1 Memory management
22.4.3.2 Inheritance
+23.4.3.2 Inheritance
23.4.3.3 Proxy classes and garbage collection
22.4.3.4 The premature garbage collection prevention parameter for proxy class marshalling
+23.4.3.4 The premature garbage collection prevention parameter for proxy class marshalling
22.4.3.5 Single threaded applications and thread safety
+23.4.3.5 Single threaded applications and thread safety
22.4.4 Type wrapper classes
+23.4.4 Type wrapper classes
22.4.5 Enum classes
+23.4.5 Enum classes
22.4.5.1 Typesafe enum classes
+23.4.5.1 Typesafe enum classes
22.4.5.2 Proper Java enum classes
+23.4.5.2 Proper Java enum classes
22.4.5.3 Type unsafe enum classes
+23.4.5.3 Type unsafe enum classes
22.5 Cross language polymorphism using directors
+23.5 Cross language polymorphism using directors
22.5.1 Enabling directors
+23.5.1 Enabling directors
22.5.2 Director classes
+23.5.2 Director classes
22.5.3 Overhead and code bloat
+23.5.3 Overhead and code bloat
22.5.4 Simple directors example
+23.5.4 Simple directors example
22.5.5 Director threading issues
+23.5.5 Director threading issues
22.6 Accessing protected members
+23.6 Accessing protected members
22.7 Common customization features
+23.7 Common customization features
22.7.1 C/C++ helper functions
+23.7.1 C/C++ helper functions
22.7.2 Class extension with %extend
+23.7.2 Class extension with %extend
22.7.3 Exception handling with %exception and %javaexception
+23.7.3 Exception handling with %exception and %javaexception
22.7.4 Method access with %javamethodmodifiers
+23.7.4 Method access with %javamethodmodifiers
22.8 Tips and techniques
+23.8 Tips and techniques
22.8.1 Input and output parameters using primitive pointers and references
+23.8.1 Input and output parameters using primitive pointers and references
22.8.2 Simple pointers
+23.8.2 Simple pointers
22.8.3 Wrapping C arrays with Java arrays
+23.8.3 Wrapping C arrays with Java arrays
22.8.4 Unbounded C Arrays
+23.8.4 Unbounded C Arrays
22.8.5 Overriding new and delete to allocate from Java heap
+23.8.5 Overriding new and delete to allocate from Java heap
22.9 Java typemaps
+23.9 Java typemaps
22.9.1 Default primitive type mappings
+23.9.1 Default primitive type mappings
22.9.2 Default typemaps for non-primitive types
+23.9.2 Default typemaps for non-primitive types
22.9.3 Sixty four bit JVMs
+23.9.3 Sixty four bit JVMs
22.9.4 What is a typemap?
+23.9.4 What is a typemap?
22.9.5 Typemaps for mapping C/C++ types to Java types
+23.9.5 Typemaps for mapping C/C++ types to Java types
22.9.6 Java typemap attributes
+23.9.6 Java typemap attributes
22.9.7 Java special variables
+23.9.7 Java special variables
22.9.8 Typemaps for both C and C++ compilation
+23.9.8 Typemaps for both C and C++ compilation
22.9.9 Java code typemaps
+23.9.9 Java code typemaps
22.9.10 Director specific typemaps
+23.9.10 Director specific typemaps
22.10 Typemap Examples
+23.10 Typemap Examples
22.10.1 Simpler Java enums for enums without initializers
+23.10.1 Simpler Java enums for enums without initializers
22.10.2 Handling C++ exception specifications as Java exceptions
+23.10.2 Handling C++ exception specifications as Java exceptions
22.10.3 NaN Exception - exception handling for a particular type
+23.10.3 NaN Exception - exception handling for a particular type
22.10.4 Converting Java String arrays to char **
+23.10.4 Converting Java String arrays to char **
22.10.5 Expanding a Java object to multiple arguments
+23.10.5 Expanding a Java object to multiple arguments
22.10.6 Using typemaps to return arguments
+23.10.6 Using typemaps to return arguments
22.10.7 Adding Java downcasts to polymorphic return types
+23.10.7 Adding Java downcasts to polymorphic return types
22.10.8 Adding an equals method to the Java classes
+23.10.8 Adding an equals method to the Java classes
22.10.9 Void pointers and a common Java base class
+23.10.9 Void pointers and a common Java base class
22.10.10 Struct pointer to pointer
+23.10.10 Struct pointer to pointer
22.10.11 Memory management when returning references to member variables
+23.10.11 Memory management when returning references to member variables
22.10.12 Memory management for objects passed to the C++ layer
+23.10.12 Memory management for objects passed to the C++ layer
22.10.13 Date marshalling using the javain typemap and associated attributes
+23.10.13 Date marshalling using the javain typemap and associated attributes
22.11 Living with Java Directors
+23.11 Living with Java Directors
22.12 Odds and ends
+23.12 Odds and ends
-22.12.1 JavaDoc comments
+23.12.1 JavaDoc comments
22.12.2 Functional interface without proxy classes
+23.12.2 Functional interface without proxy classes
22.12.3 Using your own JNI functions
+23.12.3 Using your own JNI functions
22.12.4 Performance concerns and hints
+23.12.4 Performance concerns and hints
22.12.5 Debugging
+23.12.5 Debugging
22.13 Examples
+23.13 Examples
23 SWIG and Common Lisp
+24 SWIG and Common Lisp
@@ -41,7 +41,7 @@
Lisp, Common Foreign Function Interface(CFFI), CLisp and UFFI
foreign function interfaces.
-
23.1 Allegro Common Lisp
+24.1 Allegro Common Lisp
23.2 Common Foreign Function Interface(CFFI)
+24.2 Common Foreign Function Interface(CFFI)
23.2.1 Additional Commandline Options
+24.2.1 Additional Commandline Options
23.2.2 Generating CFFI bindings
+24.2.2 Generating CFFI bindings
As we mentioned earlier the ideal way to use SWIG is to use interface
@@ -392,7 +392,7 @@ The feature intern_function ensures that all C names are
23.2.3 Generating CFFI bindings for C++ code
+24.2.3 Generating CFFI bindings for C++ code
23.2.4 Inserting user code into generated files
+24.2.4 Inserting user code into generated files
23.3 CLISP
+24.3 CLISP
23.3.1 Additional Commandline Options
+24.3.1 Additional Commandline Options
-23.3.2 Details on CLISP bindings
+24.3.2 Details on CLISP bindings
23.4 UFFI
+24.4 UFFI
diff --git a/Doc/Manual/Lua.html b/Doc/Manual/Lua.html
index c07fe66c8..04f96f2f3 100644
--- a/Doc/Manual/Lua.html
+++ b/Doc/Manual/Lua.html
@@ -6,7 +6,7 @@
-24 SWIG and Lua
+25 SWIG and Lua
@@ -67,13 +67,13 @@
24.1 Preliminaries
+25.1 Preliminaries
24.2 Running SWIG
+25.2 Running SWIG
24.2.1 Compiling and Linking and Interpreter
+25.2.1 Compiling and Linking and Interpreter
24.2.2 Compiling a dynamic module
+25.2.2 Compiling a dynamic module
24.2.3 Using your module
+25.2.3 Using your module
24.3 A tour of basic C/C++ wrapping
+25.3 A tour of basic C/C++ wrapping
24.3.1 Modules
+25.3.1 Modules
24.3.2 Functions
+25.3.2 Functions
24.3.3 Global variables
+25.3.3 Global variables
24.3.4 Constants and enums
+25.3.4 Constants and enums
24.3.5 Pointers
+25.3.5 Pointers
24.3.6 Structures
+25.3.6 Structures
24.3.7 C++ classes
+25.3.7 C++ classes
24.3.8 C++ inheritance
+25.3.8 C++ inheritance
24.3.9 Pointers, references, values, and arrays
+25.3.9 Pointers, references, values, and arrays
24.3.10 C++ overloaded functions
+25.3.10 C++ overloaded functions
24.3.11 C++ operators
+25.3.11 C++ operators
24.3.12 Class extension with %extend
+25.3.12 Class extension with %extend
24.3.13 C++ templates
+25.3.13 C++ templates
24.3.14 C++ Smart Pointers
+25.3.14 C++ Smart Pointers
24.3.15 C++ Exceptions
+25.3.15 C++ Exceptions
24.4 Typemaps
+25.4 Typemaps
24.4.1 What is a typemap?
+25.4.1 What is a typemap?
24.4.2 Using typemaps
+25.4.2 Using typemaps
24.4.3 Typemaps and arrays
+25.4.3 Typemaps and arrays
24.4.4 Typemaps and pointer-pointer functions
+25.4.4 Typemaps and pointer-pointer functions
24.5 Writing typemaps
+25.5 Writing typemaps
24.5.1 Typemaps you can write
+25.5.1 Typemaps you can write
24.5.2 SWIG's Lua-C API
+25.5.2 SWIG's Lua-C API
24.6 Customization of your Bindings
+25.6 Customization of your Bindings
24.6.1 Writing your own custom wrappers
+25.6.1 Writing your own custom wrappers
24.6.2 Adding additional Lua code
+25.6.2 Adding additional Lua code
24.7 Details on the Lua binding
+25.7 Details on the Lua binding
24.7.1 Binding global data into the module.
+25.7.1 Binding global data into the module.
24.7.2 Userdata and Metatables
+25.7.2 Userdata and Metatables
24.7.3 Memory management
+25.7.3 Memory management
25 SWIG and Modula-3
+26 SWIG and Modula-3
@@ -54,7 +54,7 @@ especially
typemaps.
-
25.1 Overview
+26.1 Overview
25.1.1 Motivation
+26.1.1 Motivation
25.2 Conception
+26.2 Conception
-25.2.1 Interfaces to C libraries
+26.2.1 Interfaces to C libraries
25.2.2 Interfaces to C++ libraries
+26.2.2 Interfaces to C++ libraries
25.3 Preliminaries
+26.3 Preliminaries
-25.3.1 Compilers
+26.3.1 Compilers
25.3.2 Additional Commandline Options
+26.3.2 Additional Commandline Options
25.4 Modula-3 typemaps
+26.4 Modula-3 typemaps
-25.4.1 Inputs and outputs
+26.4.1 Inputs and outputs
25.4.2 Subranges, Enumerations, Sets
+26.4.2 Subranges, Enumerations, Sets
25.4.3 Objects
+26.4.3 Objects
25.4.4 Imports
+26.4.4 Imports
25.4.5 Exceptions
+26.4.5 Exceptions
25.4.6 Example
+26.4.6 Example
25.5 More hints to the generator
+26.5 More hints to the generator
-25.5.1 Features
+26.5.1 Features
@@ -908,7 +908,7 @@ where almost everything is generated by a typemap:
-25.5.2 Pragmas
+26.5.2 Pragmas
@@ -931,7 +931,7 @@ where almost everything is generated by a typemap:
-25.6 Remarks
+26.6 Remarks
diff --git a/Doc/Manual/Mzscheme.html b/Doc/Manual/Mzscheme.html
index 4351e34a7..257e58b95 100644
--- a/Doc/Manual/Mzscheme.html
+++ b/Doc/Manual/Mzscheme.html
@@ -8,7 +8,7 @@
-
26 SWIG and MzScheme
+27 SWIG and MzScheme
@@ -22,7 +22,7 @@
26.1 Creating native MzScheme structures
+27.1 Creating native MzScheme structures
27 SWIG and Ocaml
+28 SWIG and Ocaml
@@ -80,7 +80,7 @@ If you're not familiar with the Objective Caml language, you can visit
The Ocaml Website.
-
27.1 Preliminaries
+28.1 Preliminaries
27.1.1 Running SWIG
+28.1.1 Running SWIG
27.1.2 Compiling the code
+28.1.2 Compiling the code
27.1.3 The camlp4 module
+28.1.3 The camlp4 module
27.1.4 Using your module
+28.1.4 Using your module
27.1.5 Compilation problems and compiling with C++
+28.1.5 Compilation problems and compiling with C++
27.2 The low-level Ocaml/C interface
+28.2 The low-level Ocaml/C interface
27.2.1 The generated module
+28.2.1 The generated module
27.2.2 Enums
+28.2.2 Enums
27.2.2.1 Enum typing in Ocaml
+28.2.2.1 Enum typing in Ocaml
27.2.3 Arrays
+28.2.3 Arrays
-27.2.3.1 Simple types of bounded arrays
+28.2.3.1 Simple types of bounded arrays
27.2.3.2 Complex and unbounded arrays
+28.2.3.2 Complex and unbounded arrays
27.2.3.3 Using an object
+28.2.3.3 Using an object
27.2.3.4 Example typemap for a function taking float * and int
+28.2.3.4 Example typemap for a function taking float * and int
27.2.4 C++ Classes
+28.2.4 C++ Classes
27.2.4.1 STL vector and string Example
+28.2.4.1 STL vector and string Example
27.2.4.2 C++ Class Example
+28.2.4.2 C++ Class Example
27.2.4.3 Compiling the example
+28.2.4.3 Compiling the example
@@ -743,7 +743,7 @@ bash-2.05a$ ocamlmktop -custom swig.cmo -I `camlp4 -where` \
-L$QTPATH/lib -cclib -lqt
27.2.4.4 Sample Session
+28.2.4.4 Sample Session
@@ -770,10 +770,10 @@ Assuming you have a working installation of QT, you will see a window
containing the string "hi" in a button.
-
27.2.5 Director Classes
+28.2.5 Director Classes
-27.2.5.1 Director Introduction
+28.2.5.1 Director Introduction
27.2.5.2 Overriding Methods in Ocaml
+28.2.5.2 Overriding Methods in Ocaml
27.2.5.3 Director Usage Example
+28.2.5.3 Director Usage Example
@@ -887,7 +887,7 @@ in a more effortless style in ocaml, while leaving the "engine" part of the
program in C++.
-
27.2.5.4 Creating director objects
+28.2.5.4 Creating director objects
27.2.5.5 Typemaps for directors, directorin, directorout, directorargout
+28.2.5.5 Typemaps for directors, directorin, directorout, directorargout
27.2.5.6 directorin typemap
+28.2.5.6 directorin typemap
27.2.5.7 directorout typemap
+28.2.5.7 directorout typemap
27.2.5.8 directorargout typemap
+28.2.5.8 directorargout typemap
27.2.6 Exceptions
+28.2.6 Exceptions
28 SWIG and Octave
+29 SWIG and Octave
@@ -54,14 +54,14 @@ More information can be found at www.octave.org<
Also, there are a dozen or so examples in the Examples/octave directory, and hundreds in the test suite (Examples/test-suite and Examples/test-suite/octave).
-
28.1 Preliminaries
+29.1 Preliminaries
28.2 Running SWIG
+29.2 Running SWIG
28.2.1 Compiling a dynamic module
+29.2.1 Compiling a dynamic module
octave:1> example
28.2.2 Using your module
+29.2.2 Using your module
28.3 A tour of basic C/C++ wrapping
+29.3 A tour of basic C/C++ wrapping
-28.3.1 Modules
+29.3.1 Modules
28.3.2 Functions
+29.3.2 Functions
octave:1> example.fact(4)
24
28.3.3 Global variables
+29.3.3 Global variables
28.3.4 Constants and enums
+29.3.4 Constants and enums
28.3.5 Pointers
+29.3.5 Pointers
28.3.6 Structures and C++ classes
+29.3.6 Structures and C++ classes
28.3.7 C++ inheritance
+29.3.7 C++ inheritance
28.3.8 C++ overloaded functions
+29.3.8 C++ overloaded functions
28.3.9 C++ operators
+29.3.9 C++ operators
28.3.10 Class extension with %extend
+29.3.10 Class extension with %extend
28.3.11 C++ templates
+29.3.11 C++ templates
28.3.12 C++ Smart Pointers
+29.3.12 C++ Smart Pointers
28.3.13 Directors (calling Octave from C++ code)
+29.3.13 Directors (calling Octave from C++ code)
28.3.14 Threads
+29.3.14 Threads
28.3.15 Memory management
+29.3.15 Memory management
28.3.16 STL support
+29.3.16 STL support
28.3.17 Matrix typemaps
+29.3.17 Matrix typemaps
29 SWIG and Perl5
+30 SWIG and Perl5
@@ -87,7 +87,7 @@ later. Earlier versions are problematic and SWIG generated extensions
may not compile or run correctly.
-
29.1 Overview
+30.1 Overview
29.2 Preliminaries
+30.2 Preliminaries
29.2.1 Getting the right header files
+30.2.1 Getting the right header files
29.2.2 Compiling a dynamic module
+30.2.2 Compiling a dynamic module
29.2.3 Building a dynamic module with MakeMaker
+30.2.3 Building a dynamic module with MakeMaker
29.2.4 Building a static version of Perl
+30.2.4 Building a static version of Perl
29.2.5 Using the module
+30.2.5 Using the module
29.2.6 Compilation problems and compiling with C++
+30.2.6 Compilation problems and compiling with C++
29.2.7 Compiling for 64-bit platforms
+30.2.7 Compiling for 64-bit platforms
29.3 Building Perl Extensions under Windows
+30.3 Building Perl Extensions under Windows
29.3.1 Running SWIG from Developer Studio
+30.3.1 Running SWIG from Developer Studio
29.3.2 Using other compilers
+30.3.2 Using other compilers
29.4 The low-level interface
+30.4 The low-level interface
29.4.1 Functions
+30.4.1 Functions
29.4.2 Global variables
+30.4.2 Global variables
29.4.3 Constants
+30.4.3 Constants
29.4.4 Pointers
+30.4.4 Pointers
29.4.5 Structures
+30.4.5 Structures
29.4.6 C++ classes
+30.4.6 C++ classes
29.4.7 C++ classes and type-checking
+30.4.7 C++ classes and type-checking
29.4.8 C++ overloaded functions
+30.4.8 C++ overloaded functions
29.4.9 Operators
+30.4.9 Operators
29.4.10 Modules and packages
+30.4.10 Modules and packages
29.5 Input and output parameters
+30.5 Input and output parameters
29.6 Exception handling
+30.6 Exception handling
29.7 Remapping datatypes with typemaps
+30.7 Remapping datatypes with typemaps
29.7.1 A simple typemap example
+30.7.1 A simple typemap example
29.7.2 Perl5 typemaps
+30.7.2 Perl5 typemaps
29.7.3 Typemap variables
+30.7.3 Typemap variables
29.7.4 Useful functions
+30.7.4 Useful functions
29.8 Typemap Examples
+30.8 Typemap Examples
29.8.1 Converting a Perl5 array to a char **
+30.8.1 Converting a Perl5 array to a char **
29.8.2 Return values
+30.8.2 Return values
29.8.3 Returning values from arguments
+30.8.3 Returning values from arguments
29.8.4 Accessing array structure members
+30.8.4 Accessing array structure members
29.8.5 Turning Perl references into C pointers
+30.8.5 Turning Perl references into C pointers
29.8.6 Pointer handling
+30.8.6 Pointer handling
29.9 Proxy classes
+30.9 Proxy classes
29.9.1 Preliminaries
+30.9.1 Preliminaries
29.9.2 Structure and class wrappers
+30.9.2 Structure and class wrappers
29.9.3 Object Ownership
+30.9.3 Object Ownership
29.9.4 Nested Objects
+30.9.4 Nested Objects
29.9.5 Proxy Functions
+30.9.5 Proxy Functions
29.9.6 Inheritance
+30.9.6 Inheritance
29.9.7 Modifying the proxy methods
+30.9.7 Modifying the proxy methods
29.10 Adding additional Perl code
+30.10 Adding additional Perl code
30 SWIG and PHP
+31 SWIG and PHP
@@ -75,7 +75,7 @@ your extension into php directly, you will need the complete PHP source tree
available.
-
30.1 Generating PHP Extensions
+31.1 Generating PHP Extensions
30.1.1 Building a loadable extension
+31.1.1 Building a loadable extension
30.1.2 Using PHP Extensions
+31.1.2 Using PHP Extensions
30.2 Basic PHP interface
+31.2 Basic PHP interface
30.2.1 Constants
+31.2.1 Constants
30.2.2 Global Variables
+31.2.2 Global Variables
30.2.3 Functions
+31.2.3 Functions
30.2.4 Overloading
+31.2.4 Overloading
30.2.5 Pointers and References
+31.2.5 Pointers and References
30.2.6 Structures and C++ classes
+31.2.6 Structures and C++ classes
30.2.6.1 Using -noproxy
+31.2.6.1 Using -noproxy
30.2.6.2 Constructors and Destructors
+31.2.6.2 Constructors and Destructors
30.2.6.3 Static Member Variables
+31.2.6.3 Static Member Variables
30.2.6.4 Static Member Functions
+31.2.6.4 Static Member Functions
30.2.7 PHP Pragmas, Startup and Shutdown code
+31.2.7 PHP Pragmas, Startup and Shutdown code
30.3 Cross language polymorphism
+31.3 Cross language polymorphism
30.3.1 Enabling directors
+31.3.1 Enabling directors
30.3.2 Director classes
+31.3.2 Director classes
@@ -1079,7 +1079,7 @@ so there is no need for the extra overhead involved with routing the
calls through PHP.
-30.3.3 Ownership and object destruction
+31.3.3 Ownership and object destruction
30.3.4 Exception unrolling
+31.3.4 Exception unrolling
30.3.5 Overhead and code bloat
+31.3.5 Overhead and code bloat
30.3.6 Typemaps
+31.3.6 Typemaps
30.3.7 Miscellaneous
+31.3.7 Miscellaneous
31 SWIG and Pike
+32 SWIG and Pike
@@ -46,10 +46,10 @@ least, make sure you read the "SWIG Basics"
chapter.
-31.1 Preliminaries
+32.1 Preliminaries
-31.1.1 Running SWIG
+32.1.1 Running SWIG
$ swig -pike -o pseudonym.c example.i
31.1.2 Getting the right header files
+32.1.2 Getting the right header files
31.1.3 Using your module
+32.1.3 Using your module
31.2 Basic C/C++ Mapping
+32.2 Basic C/C++ Mapping
-31.2.1 Modules
+32.2.1 Modules
31.2.2 Functions
+32.2.2 Functions
31.2.3 Global variables
+32.2.3 Global variables
31.2.4 Constants and enumerated types
+32.2.4 Constants and enumerated types
31.2.5 Constructors and Destructors
+32.2.5 Constructors and Destructors
31.2.6 Static Members
+32.2.6 Static Members
32 SWIG and Python
+33 SWIG and Python
@@ -128,7 +128,7 @@ very least, make sure you read the "SWIG
Basics" chapter.
-
32.1 Overview
+33.1 Overview
32.2 Preliminaries
+33.2 Preliminaries
-32.2.1 Running SWIG
+33.2.1 Running SWIG
32.2.2 Using distutils
+33.2.2 Using distutils
32.2.3 Hand compiling a dynamic module
+33.2.3 Hand compiling a dynamic module
32.2.4 Static linking
+33.2.4 Static linking
32.2.5 Using your module
+33.2.5 Using your module
32.2.6 Compilation of C++ extensions
+33.2.6 Compilation of C++ extensions
32.2.7 Compiling for 64-bit platforms
+33.2.7 Compiling for 64-bit platforms
32.2.8 Building Python Extensions under Windows
+33.2.8 Building Python Extensions under Windows
32.3 A tour of basic C/C++ wrapping
+33.3 A tour of basic C/C++ wrapping
32.3.1 Modules
+33.3.1 Modules
32.3.2 Functions
+33.3.2 Functions
32.3.3 Global variables
+33.3.3 Global variables
32.3.4 Constants and enums
+33.3.4 Constants and enums
32.3.5 Pointers
+33.3.5 Pointers
32.3.6 Structures
+33.3.6 Structures
32.3.7 C++ classes
+33.3.7 C++ classes
32.3.8 C++ inheritance
+33.3.8 C++ inheritance
32.3.9 Pointers, references, values, and arrays
+33.3.9 Pointers, references, values, and arrays
32.3.10 C++ overloaded functions
+33.3.10 C++ overloaded functions
32.3.11 C++ operators
+33.3.11 C++ operators
32.3.12 C++ namespaces
+33.3.12 C++ namespaces
32.3.13 C++ templates
+33.3.13 C++ templates
32.3.14 C++ Smart Pointers
+33.3.14 C++ Smart Pointers
32.3.15 C++ Reference Counted Objects (ref/unref)
+33.3.15 C++ Reference Counted Objects (ref/unref)
32.4 Further details on the Python class interface
+33.4 Further details on the Python class interface
32.4.1 Proxy classes
+33.4.1 Proxy classes
32.4.2 Memory management
+33.4.2 Memory management
32.4.3 Python 2.2 and classic classes
+33.4.3 Python 2.2 and classic classes
32.5 Cross language polymorphism
+33.5 Cross language polymorphism
32.5.1 Enabling directors
+33.5.1 Enabling directors
32.5.2 Director classes
+33.5.2 Director classes
@@ -2730,7 +2730,7 @@ so there is no need for the extra overhead involved with routing the
calls through Python.
-32.5.3 Ownership and object destruction
+33.5.3 Ownership and object destruction
32.5.4 Exception unrolling
+33.5.4 Exception unrolling
32.5.5 Overhead and code bloat
+33.5.5 Overhead and code bloat
32.5.6 Typemaps
+33.5.6 Typemaps
32.5.7 Miscellaneous
+33.5.7 Miscellaneous
32.6 Common customization features
+33.6 Common customization features
32.6.1 C/C++ helper functions
+33.6.1 C/C++ helper functions
32.6.2 Adding additional Python code
+33.6.2 Adding additional Python code
32.6.3 Class extension with %extend
+33.6.3 Class extension with %extend
32.6.4 Exception handling with %exception
+33.6.4 Exception handling with %exception
32.7 Tips and techniques
+33.7 Tips and techniques
32.7.1 Input and output parameters
+33.7.1 Input and output parameters
32.7.2 Simple pointers
+33.7.2 Simple pointers
32.7.3 Unbounded C Arrays
+33.7.3 Unbounded C Arrays
32.7.4 String handling
+33.7.4 String handling
32.8 Typemaps
+33.8 Typemaps
32.8.1 What is a typemap?
+33.8.1 What is a typemap?
32.8.2 Python typemaps
+33.8.2 Python typemaps
32.8.3 Typemap variables
+33.8.3 Typemap variables
32.8.4 Useful Python Functions
+33.8.4 Useful Python Functions
32.9 Typemap Examples
+33.9 Typemap Examples
32.9.1 Converting Python list to a char **
+33.9.1 Converting Python list to a char **
32.9.2 Expanding a Python object into multiple arguments
+33.9.2 Expanding a Python object into multiple arguments
32.9.3 Using typemaps to return arguments
+33.9.3 Using typemaps to return arguments
32.9.4 Mapping Python tuples into small arrays
+33.9.4 Mapping Python tuples into small arrays
32.9.5 Mapping sequences to C arrays
+33.9.5 Mapping sequences to C arrays
32.9.6 Pointer handling
+33.9.6 Pointer handling
32.10 Docstring Features
+33.10 Docstring Features
32.10.1 Module docstring
+33.10.1 Module docstring
32.10.2 %feature("autodoc")
+33.10.2 %feature("autodoc")
32.10.2.1 %feature("autodoc", "0")
+33.10.2.1 %feature("autodoc", "0")
32.10.2.2 %feature("autodoc", "1")
+33.10.2.2 %feature("autodoc", "1")
32.10.2.3 %feature("autodoc", "docstring")
+33.10.2.3 %feature("autodoc", "docstring")
32.10.3 %feature("docstring")
+33.10.3 %feature("docstring")
32.11 Python Packages
+33.11 Python Packages
32.12 Python 3 Support
+33.12 Python 3 Support
32.12.1 Function annotation
+33.12.1 Function annotation
32.12.2 Buffer interface
+33.12.2 Buffer interface
32.12.3 Abstract base classes
+33.12.3 Abstract base classes
33 SWIG and R
+34 SWIG and R
@@ -33,7 +33,7 @@ compile and run an R interface to QuantLib running on Mandriva Linux
with gcc. The R bindings also work on Microsoft Windows using Visual C++.
-
-33.1 Bugs
+34.1 Bugs
33.2 Using R and SWIG
+34.2 Using R and SWIG
33.3 Precompiling large R files
+34.3 Precompiling large R files
In cases where the R file is large, one make save a lot of loading
@@ -137,7 +137,7 @@ will save a large amount of loading time.
-33.4 General policy
+34.4 General policy
33.5 Language conventions
+34.5 Language conventions
33.6 C++ classes
+34.6 C++ classes
33.7 Enumerations
+34.7 Enumerations
34 SWIG and Ruby
+35 SWIG and Ruby
@@ -148,7 +148,7 @@
-
34.1 Preliminaries
+35.1 Preliminaries
34.1.1 Running SWIG
+35.1.1 Running SWIG
34.1.2 Getting the right header files
+35.1.2 Getting the right header files
34.1.3 Compiling a dynamic module
+35.1.3 Compiling a dynamic module
34.1.4 Using your module
+35.1.4 Using your module
34.1.5 Static linking
+35.1.5 Static linking
34.1.6 Compilation of C++ extensions
+35.1.6 Compilation of C++ extensions
34.2 Building Ruby Extensions under Windows 95/NT
+35.2 Building Ruby Extensions under Windows 95/NT
34.2.1 Running SWIG from Developer Studio
+35.2.1 Running SWIG from Developer Studio
34.3 The Ruby-to-C/C++ Mapping
+35.3 The Ruby-to-C/C++ Mapping
34.3.1 Modules
+35.3.1 Modules
34.3.2 Functions
+35.3.2 Functions
34.3.3 Variable Linking
+35.3.3 Variable Linking
34.3.4 Constants
+35.3.4 Constants
34.3.5 Pointers
+35.3.5 Pointers
34.3.6 Structures
+35.3.6 Structures
34.3.7 C++ classes
+35.3.7 C++ classes
34.3.8 C++ Inheritance
+35.3.8 C++ Inheritance
34.3.9 C++ Overloaded Functions
+35.3.9 C++ Overloaded Functions
34.3.10 C++ Operators
+35.3.10 C++ Operators
34.3.11 C++ namespaces
+35.3.11 C++ namespaces
34.3.12 C++ templates
+35.3.12 C++ templates
34.3.13 C++ Standard Template Library (STL)
+35.3.13 C++ Standard Template Library (STL)
34.3.14 C++ STL Functors
+35.3.14 C++ STL Functors
-34.3.15 C++ STL Iterators
+35.3.15 C++ STL Iterators
-34.3.16 C++ Smart Pointers
+35.3.16 C++ Smart Pointers
34.3.17 Cross-Language Polymorphism
+35.3.17 Cross-Language Polymorphism
34.3.17.1 Exception Unrolling
+35.3.17.1 Exception Unrolling
34.4 Naming
+35.4 Naming
34.4.1 Defining Aliases
+35.4.1 Defining Aliases
34.4.2 Predicate Methods
+35.4.2 Predicate Methods
34.4.3 Bang Methods
+35.4.3 Bang Methods
34.4.4 Getters and Setters
+35.4.4 Getters and Setters
34.5 Input and output parameters
+35.5 Input and output parameters
34.6 Exception handling
+35.6 Exception handling
-34.6.1 Using the %exception directive
+35.6.1 Using the %exception directive
34.6.2 Handling Ruby Blocks
+35.6.2 Handling Ruby Blocks
34.6.3 Raising exceptions
+35.6.3 Raising exceptions
34.6.4 Exception classes
+35.6.4 Exception classes
34.7 Typemaps
+35.7 Typemaps
34.7.1 What is a typemap?
+35.7.1 What is a typemap?
34.7.2 Typemap scope
+35.7.2 Typemap scope
34.7.3 Copying a typemap
+35.7.3 Copying a typemap
34.7.4 Deleting a typemap
+35.7.4 Deleting a typemap
34.7.5 Placement of typemaps
+35.7.5 Placement of typemaps
34.7.6 Ruby typemaps
+35.7.6 Ruby typemaps
34.7.6.1 "in" typemap
+35.7.6.1 "in" typemap
34.7.6.2 "typecheck" typemap
+35.7.6.2 "typecheck" typemap
34.7.6.3 "out" typemap
+35.7.6.3 "out" typemap
34.7.6.4 "arginit" typemap
+35.7.6.4 "arginit" typemap
34.7.6.5 "default" typemap
+35.7.6.5 "default" typemap
34.7.6.6 "check" typemap
+35.7.6.6 "check" typemap
34.7.6.7 "argout" typemap
+35.7.6.7 "argout" typemap
34.7.6.8 "freearg" typemap
+35.7.6.8 "freearg" typemap
34.7.6.9 "newfree" typemap
+35.7.6.9 "newfree" typemap
34.7.6.10 "memberin" typemap
+35.7.6.10 "memberin" typemap
34.7.6.11 "varin" typemap
+35.7.6.11 "varin" typemap
34.7.6.12 "varout" typemap
+35.7.6.12 "varout" typemap
34.7.6.13 "throws" typemap
+35.7.6.13 "throws" typemap
34.7.6.14 directorin typemap
+35.7.6.14 directorin typemap
34.7.6.15 directorout typemap
+35.7.6.15 directorout typemap
-34.7.6.16 directorargout typemap
+35.7.6.16 directorargout typemap
34.7.6.17 ret typemap
+35.7.6.17 ret typemap
34.7.6.18 globalin typemap
+35.7.6.18 globalin typemap
34.7.7 Typemap variables
+35.7.7 Typemap variables
34.7.8 Useful Functions
+35.7.8 Useful Functions
34.7.8.1 C Datatypes to Ruby Objects
+35.7.8.1 C Datatypes to Ruby Objects
34.7.8.2 Ruby Objects to C Datatypes
+35.7.8.2 Ruby Objects to C Datatypes
34.7.8.3 Macros for VALUE
+35.7.8.3 Macros for VALUE
34.7.8.4 Exceptions
+35.7.8.4 Exceptions
34.7.8.5 Iterators
+35.7.8.5 Iterators
34.7.9 Typemap Examples
+35.7.9 Typemap Examples
34.7.10 Converting a Ruby array to a char **
+35.7.10 Converting a Ruby array to a char **
34.7.11 Collecting arguments in a hash
+35.7.11 Collecting arguments in a hash
34.7.12 Pointer handling
+35.7.12 Pointer handling
34.7.12.1 Ruby Datatype Wrapping
+35.7.12.1 Ruby Datatype Wrapping
34.7.13 Example: STL Vector to Ruby Array
+35.7.13 Example: STL Vector to Ruby Array
-34.8 Docstring Features
+35.8 Docstring Features
34.8.1 Module docstring
+35.8.1 Module docstring
34.8.2 %feature("autodoc")
+35.8.2 %feature("autodoc")
34.8.2.1 %feature("autodoc", "0")
+35.8.2.1 %feature("autodoc", "0")
34.8.2.2 %feature("autodoc", "1")
+35.8.2.2 %feature("autodoc", "1")
34.8.2.3 %feature("autodoc", "2")
+35.8.2.3 %feature("autodoc", "2")
34.8.2.4 %feature("autodoc", "3")
+35.8.2.4 %feature("autodoc", "3")
34.8.2.5 %feature("autodoc", "docstring")
+35.8.2.5 %feature("autodoc", "docstring")
34.8.3 %feature("docstring")
+35.8.3 %feature("docstring")
34.9 Advanced Topics
+35.9 Advanced Topics
-34.9.1 Operator overloading
+35.9.1 Operator overloading
34.9.2 Creating Multi-Module Packages
+35.9.2 Creating Multi-Module Packages
34.9.3 Specifying Mixin Modules
+35.9.3 Specifying Mixin Modules
34.10 Memory Management
+35.10 Memory Management
34.10.1 Mark and Sweep Garbage Collector
+35.10.1 Mark and Sweep Garbage Collector
34.10.2 Object Ownership
+35.10.2 Object Ownership
34.10.3 Object Tracking
+35.10.3 Object Tracking
34.10.4 Mark Functions
+35.10.4 Mark Functions
34.10.5 Free Functions
+35.10.5 Free Functions
34.10.6 Embedded Ruby and the C++ Stack
+35.10.6 Embedded Ruby and the C++ Stack
35 SWIG and Tcl
+36 SWIG and Tcl
@@ -83,7 +83,7 @@ Tcl 8.0 or a later release. Earlier releases of SWIG supported Tcl 7.x, but
this is no longer supported.
-
35.1 Preliminaries
+36.1 Preliminaries
35.1.1 Getting the right header files
+36.1.1 Getting the right header files
35.1.2 Compiling a dynamic module
+36.1.2 Compiling a dynamic module
35.1.3 Static linking
+36.1.3 Static linking
35.1.4 Using your module
+36.1.4 Using your module
35.1.5 Compilation of C++ extensions
+36.1.5 Compilation of C++ extensions
35.1.6 Compiling for 64-bit platforms
+36.1.6 Compiling for 64-bit platforms
35.1.7 Setting a package prefix
+36.1.7 Setting a package prefix
35.1.8 Using namespaces
+36.1.8 Using namespaces
35.2 Building Tcl/Tk Extensions under Windows 95/NT
+36.2 Building Tcl/Tk Extensions under Windows 95/NT
35.2.1 Running SWIG from Developer Studio
+36.2.1 Running SWIG from Developer Studio
35.2.2 Using NMAKE
+36.2.2 Using NMAKE
35.3 A tour of basic C/C++ wrapping
+36.3 A tour of basic C/C++ wrapping
35.3.1 Modules
+36.3.1 Modules
35.3.2 Functions
+36.3.2 Functions
35.3.3 Global variables
+36.3.3 Global variables
35.3.4 Constants and enums
+36.3.4 Constants and enums
35.3.5 Pointers
+36.3.5 Pointers
35.3.6 Structures
+36.3.6 Structures
35.3.7 C++ classes
+36.3.7 C++ classes
35.3.8 C++ inheritance
+36.3.8 C++ inheritance
35.3.9 Pointers, references, values, and arrays
+36.3.9 Pointers, references, values, and arrays
35.3.10 C++ overloaded functions
+36.3.10 C++ overloaded functions
35.3.11 C++ operators
+36.3.11 C++ operators
35.3.12 C++ namespaces
+36.3.12 C++ namespaces
35.3.13 C++ templates
+36.3.13 C++ templates
35.3.14 C++ Smart Pointers
+36.3.14 C++ Smart Pointers
35.4 Further details on the Tcl class interface
+36.4 Further details on the Tcl class interface
35.4.1 Proxy classes
+36.4.1 Proxy classes
35.4.2 Memory management
+36.4.2 Memory management
35.5 Input and output parameters
+36.5 Input and output parameters
35.6 Exception handling
+36.6 Exception handling
35.7 Typemaps
+36.7 Typemaps
35.7.1 What is a typemap?
+36.7.1 What is a typemap?
35.7.2 Tcl typemaps
+36.7.2 Tcl typemaps
35.7.3 Typemap variables
+36.7.3 Typemap variables
35.7.4 Converting a Tcl list to a char **
+36.7.4 Converting a Tcl list to a char **
35.7.5 Returning values in arguments
+36.7.5 Returning values in arguments
35.7.6 Useful functions
+36.7.6 Useful functions
35.7.7 Standard typemaps
+36.7.7 Standard typemaps
35.7.8 Pointer handling
+36.7.8 Pointer handling
35.8 Turning a SWIG module into a Tcl Package.
+36.8 Turning a SWIG module into a Tcl Package.
35.9 Building new kinds of Tcl interfaces (in Tcl)
+36.9 Building new kinds of Tcl interfaces (in Tcl)
35.9.1 Proxy classes
+36.9.1 Proxy classes
35.10 Tcl/Tk Stubs
+36.10 Tcl/Tk Stubs