SWIG

https://www.swig.org/Doc4.4/SWIGDocumentation.html
Admin
SWIG (Simplified Wrapper and Interface Generator) is a software development tool that connects C/C++...
Tokens:401,931
Snippets:4,825
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Basic Unix Installation

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Standard commands to configure, build, and install SWIG on a Unix-like system. Assumes default installation path.

```bash
$ ./configure
$ make
$ make install

```

--------------------------------

### Install Bison Nuget Package

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Installs the Bison Nuget package to a specified output directory. Version 3.7.4 is used in this example.

```cmd
C:\Tools\nuget install Bison -Version 3.7.4 -OutputDirectory C:\Tools\bison
```

--------------------------------

### Install SWIG

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Install the compiled SWIG executable and associated files to the system.

```bash
make install
```

--------------------------------

### Varargs for Default Arguments Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Shows how varargs can be used to simulate default arguments, using the open() system call as an example.

```c
int open(const char *path, int oflag, ...);
...

/* Examples */
f = open("foo", O_RDONLY);
g = open("bar", O_WRONLY | O_CREAT, 0644);
```

--------------------------------

### Install CMake-win64 Nuget Package

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Installs the CMake-win64 Nuget package to a specified output directory. Version 3.15.5 is used in this example.

```cmd
C:\Tools\nuget install CMake-win64 -Version 3.15.5 -OutputDirectory C:\Tools\CMake
```

--------------------------------

### Python 3 Package Initialization Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Provides a directory structure and file contents for a Python 3 package example illustrating potential import issues from `__init__.py`.

```text
pkg1/__init__.py        # (empty)
pkg1/pkg2/__init__.py   # (imports something from bar.py)
pkg1/pkg2/foo.py
pkg1/pkg2/bar.py        # (imports foo.py)

```

--------------------------------

### Sample Session with Compiled Qt Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This shows the initial output when running the compiled OCaml top-level for the Qt example. It indicates the versions of Objective Caml and Camlp4 being used.

```bash
bash-2.05a$ ./qt_top
        Objective Caml version 3.06

        Camlp4 Parsing version 3.06

```

--------------------------------

### Install PCRE2 Nuget Package

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Installs the PCRE2 Nuget package (x64 build) to a specified output directory. Version 10.39 is used in this example.

```cmd
C:\Tools\nuget install PCRE2 -Version 10.39 -OutputDirectory C:\Tools\pcre2
```

--------------------------------

### Install Node.js using PPA

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Installs Node.js on Ubuntu systems using the provided PPA. Ensure your package list is updated before installation.

```bash
$ sudo add-apt-repository ppa:chris-lea/node.js
$ sudo apt-get update
$ sudo apt-get install nodejs
```

--------------------------------

### Android Build and Install Process

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Compile the Java code using ant, uninstall the old app, and install the new debug build.

```bash
$ ant debug
$ adb uninstall org.swig.classexample
$ adb install bin/SwigClass-debug.apk 

```

--------------------------------

### Install JavascriptCore Development Files

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Command to install the necessary development files for JavascriptCore on Ubuntu.

```bash
$ sudo apt-get install libjavascriptcoregtk-1.0-dev
```

--------------------------------

### Compiling Swig OCaml Qt Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This sequence of commands shows how to compile the Swig-generated OCaml bindings for a C++ Qt example. It involves running Swig, compiling OCaml files, and linking with Qt libraries.

```bash
$ QTPATH=/your/qt/path
$ for file in swig.mli swig.ml swigp4.ml ; do swig -ocaml -co $file ; done
$ ocamlc -c swig.mli ; ocamlc -c swig.ml
$ ocamlc -I `camlp4 -where` -pp "camlp4o pa_extend.cmo q_MLast.cmo" -c swigp4.ml
$ swig -ocaml -c++ -o qt_wrap.c qt.i
$ ocamlc -c -ccopt -xc++ -ccopt -g -g -ccopt -I$QTPATH/include qt_wrap.c
$ ocamlc -c qt.mli
$ ocamlc -c qt.ml
$ ocamlmktop -custom swig.cmo -I `camlp4 -where` \
  camlp4o.cma swigp4.cmo qt_wrap.o qt.cmo -o qt_top -cclib \
  -L$QTPATH/lib -cclib -lqt

```

--------------------------------

### Install Node-API

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Command to install the node-addon-api package globally using npm.

```bash
$ sudo npm install -g node-addon-api
```

--------------------------------

### SWIG Module Definition with embed.i

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Defines a SWIG module named 'example' and includes the 'embed.i' library for static linking. This setup is for older SWIG versions and may not be supported in the future.

```swig
%module example

%inline %{
extern int fact(int);
extern int mod(int, int);
extern double My_variable;
%}

%include "embed.i"       // Include code for a static version of Python


```

--------------------------------

### Install V8 Development Files

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Command to install the necessary development files for V8 on Ubuntu.

```bash
$ sudo apt-get install libnode-dev
```

--------------------------------

### Install Android Application

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Installs the debug version of the SwigSimple Android application onto a connected device.

```bash
$ adb install bin/SwigSimple-debug.apk 
95 KB/s (4834 bytes in 0.049s)
        pkg: /data/local/tmp/SwigSimple-debug.apk
Success

```

--------------------------------

### Run Javascript Examples with JSC

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Command to run SWIG-generated Javascript examples using JavascriptCore as the engine.

```bash
$ make check-javascript-examples ENGINE=jsc
```

--------------------------------

### Unix Installation with Custom Prefix

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Installs SWIG to a specified directory using the --prefix option with configure. The directory must be an absolute path.

```bash
$ ./configure --prefix=/home/yourname/projects
$ make
$ make install

```

--------------------------------

### Dependency File Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This is an example of a dependency file generated by SWIG, showing the relationship between the wrapper C file and the input interface file.

```makefile
example_wrap.c: \
  example.i

```

--------------------------------

### SWIG Interface File Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This SWIG interface file defines a module named 'example' and declares C functions, a global variable, and constants that SWIG will wrap for scripting languages.

```swig
%module example

%inline %{
extern double sin(double x);
extern int strcmp(const char *, const char *);
extern int Foo;
%}
#define STATUS 50
#define VERSION "1.1"
```

--------------------------------

### Java Usage Example for HireButler and FireButler

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Demonstrates how to use the SWIG-wrapped C functions 'HireButler' and 'FireButler' in Java. This example shows creating a Butler object, hiring it, accessing its properties, and then firing it.

```java
Butler jeeves = new Butler();
example.HireButler(jeeves);
System.out.println("Greeting:     " + jeeves.getGreeting());
System.out.println("Availability: " + jeeves.getHoursAvailable() + " hours per day");
example.FireButler(jeeves);


```

--------------------------------

### Ruby Ownership Example Header

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This C++ header file defines a simple Foo class used in a Ruby ownership example.

```cpp
/* File "RubyOwernshipExample.h" */

class Foo
{
public:
  Foo() {}
  ~Foo() {}
};


```

--------------------------------

### SWIG Configuration Directives Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

An example illustrating SWIG's standard directives defined as macros within the 'swig.swg' configuration file, such as code insertion directives.

```swig
/* Code insertion directives such as %wrapper %{ ... %} */

```

--------------------------------

### Install ccache-swig and create symbolic links

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This snippet shows how to install ccache-swig and create symbolic links to compilers for automatic usage. Ensure you use symbolic links, not hard links, to avoid issues.

```bash
cp ccache-swig /usr/local/bin/
ln -s /usr/local/bin/ccache-swig /usr/local/bin/gcc
ln -s /usr/local/bin/ccache-swig /usr/local/bin/g++
ln -s /usr/local/bin/ccache-swig /usr/local/bin/cc
ln -s /usr/local/bin/ccache-swig /usr/local/bin/swig
```

--------------------------------

### SWIG Asymmetric Type Marshalling Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Demonstrates asymmetric type marshalling in SWIG where input and output types differ, using char* as an example.

```swig
%typemap(imtype, out="global::System.IntPtr") char * "string"
char * function(char *);
```

--------------------------------

### SWIG Interface File Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

An example SWIG interface file demonstrating the declaration of functions that use pointers to basic and derived C types like FILE* and void*.

```swig
%module fileio
FILE *fopen(char *, char *);
int fclose(FILE *);
unsigned fread(void *ptr, unsigned size, unsigned nobj, FILE *);
unsigned fwrite(void *ptr, unsigned size, unsigned nobj, FILE *);
void *malloc(int nbytes);
void free(void *);

```

--------------------------------

### Example Function Call

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Demonstrates calling a built-in SWIG-generated function.

```Python
>>> import example
>>> print(example.fact(4))
24
>>>
```

--------------------------------

### Setuptools Configuration for Build Backend

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This TOML snippet configures the build system to use setuptools as the build backend, specifying a minimum version requirement.

```toml
[build-system]
requires = ["setuptools>=65.0"]
build-backend = "setuptools.build_meta"

```

--------------------------------

### Configure Help

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Displays available options for the configure script to customize the build process.

```bash
$ ./configure --help.

```

--------------------------------

### Define C++ Class

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Example of a C++ class 'List' with methods for insertion, removal, searching, getting elements, and a public data member 'length'.

```cpp
class List {
public:
  List();
  ~List();
  int  search(char *item);
  void insert(char *item);
  void remove(char *item);
  char *get(int n);
  int  length;
};


```

--------------------------------

### Using $dinput in din Typemaps

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

The $dinput macro is used in 'din' typemaps to specify the expression to be passed to C/C++. This example shows how to get a C++ pointer from a D object.

```d
%typemap(din) SomeClass * "SomeClass.getCPointer($dinput)"

%inline %{
  class SomeClass {};
  void foo(SomeClass *arg);
%}

```

--------------------------------

### Check SWIG Version and Help

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Navigate to the installation directory and run SWIG executables to check their version and display help information.

```bash
cd install2/bin
./swig.exe -version
./swig.exe -help
```

--------------------------------

### Get Base Type

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Returns the base type of a given SWIG type without modifying the original type. For example, for 'p.a(20).int', it returns 'int'.

```c
SwigType *SwigType_base(SwigType *ty);
```

--------------------------------

### Running SWIG Command

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Use the `swig` command with options and a filename to generate wrappers. Full help is available via `swig -help`.

```bash
swig [ options ] filename
```

--------------------------------

### Python Attribute Usage Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Shows how to use the attribute generated by SWIG's %attribute macro in Python, demonstrating setting and getting the attribute's value.

```python
x = A()
x.a = 3        # calls A::set_a(3)
print(x.a)     # calls A::get_a() const
```

--------------------------------

### Typemap and Action Feature Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This example demonstrates a potential interface structure using a typemap for variable arguments and an action feature for custom behavior, aiming to separate wrapper logic from function declarations.

```swig
%typemap(const char *fmt, ...) {
  ...
}
%feature("action") traceprintf {
  ...
}

```

--------------------------------

### Member Data Accessor Functions

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Member data is accessed via generated accessor functions. This example demonstrates the 'get' and 'set' functions for a 'length' member in a 'List' class.

```c
int List_length_get(List *obj) {
  return obj->length;
}
int List_length_set(List *obj, int value) {
  obj->length = value;
  return value;
}

```

--------------------------------

### Basic Qt Application with QPushButton

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This snippet shows how to create a simple Qt application, a button, resize it, and display it. Assumes a working Qt installation.

```ocaml
# open Swig ;;
# open Qt ;;
# let a = new_QApplication '(0, 0) ;;
val a : Qt.c_obj = C_obj <fun>
# let hello = new_QPushButton '("hi", 0) ;;
val hello : Qt.c_obj = C_obj <fun>
# hello -> resize (100, 30) ;;
- : Qt.c_obj = C_void
# hello -> show () ;;
- : Qt.c_obj = C_void
# a -> exec () ;;

```

--------------------------------

### C++ Vector Member Accessor Function

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

An example of a C++ function to get the 'x' member of a Vector structure. This function might not exist directly in the generated wrapper code.

```c++
double Vector_x_get(Vector *v) {
  return v->x;
}
```

--------------------------------

### Java Environment Variables Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Example of setting JAVA_INCLUDE and JAVA_BIN environment variables for Java when using a Conda environment. Ensure these paths point to the correct jni.h and javac.exe locations.

```shell
JAVA_INCLUDE: C:\miniconda3\envs\java\Library\lib\jvm\include
JAVA_BIN: C:\miniconda3\envs\java\Library\lib\jvm\bin
```

--------------------------------

### C++ Vehicle Factory with Multiple Types

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

An example of a C++ factory function that can return different types of Vehicles. This setup is used to demonstrate more flexible downcasting scenarios in Java.

```cpp
class FireEngine : public Vehicle {
public:
  FireEngine() {}
  virtual void start() {
    cout << "FireEngine started" << endl;
  }
  void roll_out_hose() {
    cout << "Hose rolled out" << endl;
  }
  ...
};
Vehicle *vehicle_factory(int vehicle_number) {
  if (vehicle_number == 0)
    return new Ambulance("Very loud");
  else
    return new FireEngine();
}

```

--------------------------------

### SWIG auto_ptr Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Demonstrates using std::auto_ptr with SWIG by including std_auto_ptr.i and defining a factory function that returns an auto_ptr. This setup allows for natural usage in target languages.

```swig
%include <std_auto_ptr.i>

%auto_ptr(Klass)
%inline %{
#include <memory>
class Klass {
public:
  // Factory function creating objects of this class:
  static std::auto_ptr<Klass> Create(int value) {
    return std::auto_ptr<Klass>(new Klass(value));
  }

  int getValue() const { return m_value; }

private:
  Klass(int value) : m_value(value) {}
  int m_value;
};
%}
```

--------------------------------

### Insert Code into example.php

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This pragma inserts the specified code directly into the example.php file during generation.

```swig
%module example
%pragma(php) code="
include \"include.php\";
"
```

--------------------------------

### Get Type Prefix

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Returns the prefix of a SWIG type, which includes all operators except the base type. The original type is unmodified. For example, for 'p.a(20).int', it returns 'p.a(20).'.

```c
SwigType *SwigType_prefix(SwigType *ty);
```

--------------------------------

### Implicit Director Generation via Inheritance

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Directors can be generated implicitly for derived classes based on the virtual methods of their base classes. In this example, class Bar will get a director class for methods one() and two() from Foo.

```swig
%feature("director") Foo;
class Foo {
public:
  virtual void one();
  virtual void two();
};

class Bar: public Foo {
public:
  virtual void three();
};
```

--------------------------------

### Setuptools Setup for SWIG Extension

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This setup.py script configures setuptools to build a SWIG-generated Python extension module. It specifies the SWIG interface file and the C source file, allowing setuptools to invoke SWIG automatically.

```python
from setuptools import setup, Extension

name = "example"
ext = Extension(f"_{name}", sources=[f"{name}.i", f"{name}.c"])

setup(
    name=name,        
    version="0.1.0",  
    author="SWIG Docs",
    description="Simple SWIG example from docs",
    ext_modules=[ext],
    py_modules=[name],
)
```

--------------------------------

### Example Module-Specific Parse Tree Output

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This output shows the parse tree for the 'example' module at stage 1, filtered with `-debug-quiet`. It includes details like module name, inserted code, and included header information.

```text
debug-module stage 1
+++ module ----------------------------------------
| name         - "example"
|
+++ insert ----------------------------------------
| code         - "\n#include \"example.h\"\n"
|
+++ include ----------------------------------------
| name         - "example.h"

      +++ class ----------------------------------------
      | abstracts    - 0x7f4f15182930
      | allows_typedef - "1"
      | kind         - "class"
      | name         - "Shape"
      | sym:name     - "Shape"

```

--------------------------------

### Tcl Example Usage

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Demonstrates basic interaction with a SWIG-wrapped C library in Tcl, including loading a shared object and calling a function.

```tcl
% load ./example.so
% fact 3
6
% Vector v
% v configure -x 3.4

```

--------------------------------

### C++ class hierarchy for polymorphism example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This C++ code defines a base Vehicle class with a virtual start() method and an Ambulance derived class. It includes a factory function returning a base class pointer to a derived class object.

```cpp
%include "std_string.i"

#include <iostream>
using namespace std;
class Vehicle {
public:
  virtual void start() = 0;
...
};

class Ambulance : public Vehicle {
  string vol;
public:
  Ambulance(string volume) : vol(volume) {}
  virtual void start() {
    cout << "Ambulance started" << endl;
  }
  void sound_siren() {
    cout << vol << " siren sounded!" << endl;
  }
...
};

Vehicle *vehicle_factory() {
  return new Ambulance("Very loud");
}

```

--------------------------------

### Java Usage of Input/Output Parameters

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Demonstrates how to call C functions with input and output parameters from Java using SWIG-generated wrappers.

```java
int result = example.sub(7, 4);
System.out.println("7 - 4 = " + result);
int[] sum = {0};
example.add(3, 4, sum);
System.out.println("3 + 4 = " + sum[0]);
```

--------------------------------

### Java Interface Code Typemap Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This typemap adds code to the body of a Java proxy class when the 'interface' feature is used. It's applied to the proxy class and all derived proxy classes implementing the Java interface. The default typemap includes a declaration for a method to get the interface CPtr.

```swig
%typemap(javainterfacecode,
         declaration="  long $interfacename_GetInterfaceCPtr();\n",
         cptrmethod="$interfacename_GetInterfaceCPtr") CTYPE %{
  public long $interfacename_GetInterfaceCPtr() {
    return $imclassname.$javaclazzname$interfacename_GetInterfaceCPtr(swigCPtr);
  }
%}
```

--------------------------------

### Include File in example.php

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

The %pragma(php) include directive is a shortcut to add include statements to the example.php file.

```swig
%module example
%pragma(php) include="include.php"
```

--------------------------------

### Importing and Using a SWIG Module in Python

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Demonstrates how to import a SWIG-generated module named 'example' in Python and call a function 'fact' from it. This assumes the module was successfully compiled and linked.

```python
$ python
>>> import example
>>> example.fact(4)
24
>>>

```

--------------------------------

### FileA.i: Basic Fragment Inclusion

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

A simple example file demonstrating the use of %fragment for code inclusion, which is then included by another file.

```swig
// FileA.i\n%{ \n  #include <stdio.h>\n%}\n%fragment("<limits.h>");
```

--------------------------------

### Dynamic Link and Call SWIG_init in Guile

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This example demonstrates how to dynamically link a shared library containing SWIG bindings and then call the SWIG_init function to make those bindings available in the Guile environment.

```scheme
(define-module (my module))
(define my-so (dynamic-link "./libexample.so"))
(dynamic-call "SWIG_init" my-so) ; make SWIG bindings
;; Scheme definitions can go here


```

--------------------------------

### Example C Function Signature

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This is an example of a C function signature that will be wrapped by SWIG.

```c
void func(unsigned short a, char *b, const long &c, unsigned long long d);

```

--------------------------------

### Set Up Android Development Environment

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Configure the PATH environment variable to include Android SDK and NDK tools. Create a directory for Android projects.

```bash
$ export PATH=$HOME/android/android-sdk-linux_x86/tools:$HOME/android/android-sdk-linux_x86/platform-tools:$HOME/android/android-ndk-r6b:$PATH
$ mkdir AndroidApps 
$ cd AndroidApps
```

--------------------------------

### Manual Compilation of SWIG Extension Module (Linux)

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Demonstrates the manual steps to compile a SWIG extension module without setuptools. This involves running SWIG, compiling C files, and linking them into a shared library.

```bash
swig -python example.i
gcc -O2 -fPIC -c example.c
gcc -O2 -fPIC -c example_wrap.c -I/usr/local/include/python3.10
gcc -shared example.o example_wrap.o -o _example.so
```

--------------------------------

### Create and Build a Simple Android Project

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Generate a new Android project named 'SwigSimple' in the './simple' directory using a specified target ID. Then, build the project in debug mode.

```bash
$ android create project --target 1 --name SwigSimple --path ./simple --activity SwigSimple --package org.swig.simple
$ cd simple
$ ant debug
```

--------------------------------

### Example C Header File

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

A simple C header file containing function declarations.

```c
/* File : header.h */

#include <stdio.h>
#include <math.h>

extern int foo(double);
extern double bar(int, int);
extern void dump(FILE *f);

```

--------------------------------

### Example Module Usage

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Demonstrates basic interaction with a SWIG-wrapped Lua module, including calling functions and accessing/modifying global variables.

```lua
$ ./my_lua
> print(example.gcd(4, 6))
2
> print(example.Foo)
3
> example.Foo=4
> print(example.Foo)
4
>

```

--------------------------------

### Install CMake-win64 Nuget Package (PowerShell)

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Equivalent PowerShell command to install the CMake-win64 Nuget package.

```powershell
& "C:\Tools\nuget" install CMake-win64 -Version 3.15.5 -OutputDirectory C:\Tools\CMake
```

--------------------------------

### SWIG Builder Mode Command Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Illustrates the command to build a SWIG module using the 'builder' mode, including specifying source files, compiler flags, and linker flags for external libraries.

```bash
$ swig -scilab -builder -buildercflags -I/opt/foo/include -builderldflags "-L/opt/foo/lib -lfoo" -buildersources baa1.cxx, baa2.cxx example.i

```

--------------------------------

### UnsatisfiedLinkError Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

An example of an UnsatisfiedLinkError that may occur when the Java Virtual Machine cannot find the native library.

```bash
$ java runme
Exception in thread "main" java.lang.UnsatisfiedLinkError: no example in java.library.path
        at java.lang.ClassLoader.loadLibrary(ClassLoader.java:1312)
        at java.lang.Runtime.loadLibrary0(Runtime.java:749)
        at java.lang.System.loadLibrary(System.java:820)
        at runme.<clinit>(runme.java:5)

```

--------------------------------

### SWIG Builder Script Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Shows a snippet of the 'builder.sce' script generated by SWIG in builder mode. It defines the library name, source files, and tables for building the module using ilib_build.

```scilab
ilib_name = "examplelib";
files = ["example_wrap.c"];
libs = [];
table = ["fact", "_wrap_fact";"Foo_set", "_wrap_Foo_set";"Foo_get", "_wrap_Foo_get";];
ilib_build(ilib_name, table, files, libs);

```

--------------------------------

### Constexpr Destructor Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Provides an example of a constexpr destructor in C++20, which SWIG parses and handles like other constructors.

```cpp
class DtorA {
public:
  constexpr ~DtorA() {}
};
```

--------------------------------

### Compilation and Linking Commands for Static Linking

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Example commands for compiling C/C++ code, SWIG-generated wrappers, and linking them with a Lua interpreter. Adjust include and library paths as necessary for your system.

```bash
$ swig -lua example.i -o example_wrap.c
$ gcc -I/usr/include/lua -c min.c -o min.o
$ gcc -I/usr/include/lua -c example_wrap.c -o example_wrap.o
$ 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

```

--------------------------------

### R Method Definition Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Provides an example of an R method definition function, illustrating how accessors and variables are handled.

```R
Method Definition:

function (x, name) 
{
    accessorFuns = list(Axles = Vehicle_Axles, Available = Vehicle_Available_get)
    vaccessors = c("Available")
    idx = pmatch(name, names(accessorFuns))
    if (is.na(idx)) 
        return(callNextMethod(x, name))
    f = accessorFuns[[idx]]
    if (is.na(match(name, vaccessors)))
        function(...) {
            f(x, ...)
        }
    else f(x)
}

Signatures:
        x           
target  "_p_Vehicle"
defined "_p_Vehicle"
```

--------------------------------

### SWIG Typemap for Output Parameters

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Demonstrates how to use %apply to map C output parameters to Perl variables. This example shows how to handle integer pointers for rows and columns.

```swig
%module example
%include "typemaps.i"
%apply int *OUTPUT { int *rows, int *columns };
...
void get_dimensions(Matrix *m, int *rows, *columns);

```

--------------------------------

### Generated D Proxy Code for $dinput Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This shows the resulting D proxy code generated by SWIG when using the $dinput typemap example.

```d
void foo(SomeClass arg) {
  example_im.foo(SomeClass.getCPointer(arg));
}

```

--------------------------------

### Ambiguous Overloading Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

An example of C++ overloading that SWIG cannot fully support due to ambiguity between 'int' and 'long' types.

```cpp
void foo(int x);
void foo(long x);
```

--------------------------------

### SWIG Warning Messages Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Example of warning messages generated during SWIG compilation, indicating potential issues with input files.

```text
example.i:16: Warning 501: Overloaded declaration ignored.  bar(double)
example.i:15: Warning 501: Previous declaration is bar(int)
```

--------------------------------

### Build SWIG Extension In-Place with Setuptools

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Command to build the SWIG extension module in the current directory using setuptools. This allows for immediate testing without installing the package.

```bash
python setup.py build_ext --inplace
```

--------------------------------

### Complete FooBarGo Class Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

The complete and annotated `FooBarGo` class implementation, demonstrating Go subclassing of C++ with SWIG, including interfaces, embedding, and memory management.

```Go
// FooBarGo is a superset of FooBarAbstract and hence FooBarGo can be used as a
// drop in replacement for FooBarAbstract but the reverse causes a compile time
// error.
type FooBarGo interface {
  FooBarAbstract
  deleteFooBarAbstract()
  IsFooBarGo()
}

// Via embedding fooBarGo "inherits" all methods of FooBarAbstract.
type fooBarGo struct {
  FooBarAbstract
}

func (fbgs *fooBarGo) deleteFooBarAbstract() {
  DeleteDirectorFooBarAbstract(fbgs.FooBarAbstract)
}

// The IsFooBarGo method ensures that FooBarGo is a superset of FooBarAbstract.
// This is also how the class hierarchy gets represented by the SWIG generated
// wrapper code.  For an instance FooBarCpp has the IsFooBarAbstract and
// IsFooBarCpp methods.
func (fbgs *fooBarGo) IsFooBarGo() {}

// Go type that defines the DirectorInterface. It contains the Foo and Bar
// methods that overwrite the respective virtual C++ methods on FooBarAbstract.
type overwrittenMethodsOnFooBarAbstract struct {
  // Backlink to FooBarAbstract so that the rest of the class can be used by
  // the overridden methods.
  fb FooBarAbstract

```

--------------------------------

### Android Build and Install Commands

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Commands to compile Java code, uninstall the previous app version, and install the new Android application.

```bash
$ ant debug
$ adb uninstall org.swig.simple
$ adb install bin/SwigSimple-debug.apk 

```

--------------------------------

### SWIG Module Initialization Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Demonstrates the basic initialization function for a SWIG-wrapped module in Scilab. This function must be called before using the wrapped library.

```scilab
--> example_Init();

```

--------------------------------

### Python Package Structure Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Illustrates a basic Python package structure with an __init__.py file and two submodules, foo.py and bar.py.

```python
# pkg1/pkg2/__init__.py
from .bar import Bar
```

```python
# pkg1/pkg2/foo.py
class Foo: pass
```

```python
# pkg1/pkg2/bar.py
import pkg1.pkg2.foo
class Bar(pkg1.pkg2.foo.Foo): pass
```

--------------------------------

### TCL Environment Variables Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Example of setting TCL_INCLUDE and TCL_LIB environment variables for TCL when using ActiveTcl. These paths are required for linking.

```shell
TCL_INCLUDE: C:\ActiveTcl\include
TCL_LIB: C:\ActiveTcl\lib\tcl86t.lib
```

--------------------------------

### Editable Install with Pip

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Installs the package in editable mode using pip, which also builds the SWIG extension module. This is useful for development workflows.

```bash
pip install -e .
```

--------------------------------

### Install node-gyp build tool

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Installs the node-gyp build tool globally using npm. This tool is essential for compiling Node.js native modules.

```bash
$ sudo npm install -g node-gyp
```

--------------------------------

### Script Code Demonstrating Resource Management

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Example script code showing object creation, assignment, reference storage, and deletion, highlighting potential resource management challenges.

```python
f = Foo()               # Creates a new Foo
s = Spam()              # Creates a new Spam
s.value = f             # Stores a reference to f inside s
g = s.value             # Returns stored reference
g = 4                   # Reassign g to some other value
del f                   # Destroy f 

```

--------------------------------

### Install MSYS2 Packages for SWIG Build

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Install essential packages required for building SWIG on an MSYS2 environment. These include development tools and libraries.

```bash
pacman -S git autoconf automake bison gcc make pcre2-devel
```

--------------------------------

### Typemap Matching Examples

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Illustrates how SWIG applies basic matching rules, including exact matches, type-only matches, and matches after stripping qualifiers. It shows the order in which typemaps are searched for a given function signature.

```swig
%typemap(in) int *x {
  ... typemap 1
}

%typemap(in) int * {
  ... typemap 2
}

%typemap(in) const int *z {
  ... typemap 3
}

%typemap(in) int [4] {
  ... typemap 4
}

%typemap(in) int [ANY] {
  ... typemap 5
}

void A(int *x);        // int *x rule       (typemap 1)
void B(int *y);        // int * rule        (typemap 2)
void C(const int *x);  // int *x rule       (typemap 1)
void D(const int *z);  // const int *z rule (typemap 3)
void E(int x[4]);      // int [4] rule      (typemap 4)
void F(int x[1000]);   // int [ANY] rule    (typemap 5)

```

--------------------------------

### Python Package and Module Hierarchy Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Illustrates a typical Python source tree structure and the resulting package and module hierarchy.

```text
mod1.py
pkg1/__init__.py
pkg1/mod2.py
pkg1/pkg2/__init__.py
pkg1/pkg2/mod3.py

```

```text
pkg1            # package
pkg1.pkg2       # package
mod1            # module
pkg1.mod2       # module
pkg1.pkg2.mod3  # module

```

--------------------------------

### SWIG Python Typemap 'in' Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

An example of a SWIG 'in' typemap for Python, showing the code used for converting pointers and handling errors.

```swig
%typemap(in, noblock=1) SWIGTYPE [] (void *argp = 0, int res = 0) {
  res = SWIG_ConvertPtr($input, &argp, $descriptor, $disown |  0 );
  if (!SWIG_IsOK(res)) {
    SWIG_exception_fail(SWIG_ArgError(res), "in method '" "$symname""', argument "
                       "$argnum"" of type '" "$type""'");
  }
  $1 = ($ltype)(argp);
}
```

--------------------------------

### Basic Ruby Example with SWIG Typemaps

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Demonstrates passing simple integer values to C functions using SWIG's INPUT and OUTPUT typemaps in Ruby.

```c
void add(int, int, int *OUTPUT);
int sub(int *INPUT, int *INPUT);
```

```ruby
a = Example.add(3, 4)
puts a
7
b = Example.sub(7, 4)
puts b
3
```

--------------------------------

### Python Environment Variables Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Example of setting PYTHON_INCLUDE and PYTHON_LIB environment variables for Python when using a Conda environment. These paths are necessary for linking.

```shell
PYTHON_INCLUDE: C:\miniconda3\envs\python\include
PYTHON_LIB: C:\miniconda3\envs\python\libs\python313.lib
```

--------------------------------

### C++ Template Partial Specialization Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Provides an example of C++ class template partial specialization, analogous to SWIG's default typemap matching.

```c++
template <typename T> struct X             { void a(); };
template <typename T> struct X< T const& > { void b(); };

X< int & >            x1;  x1.a();

X< int *const& >      x2;  x2.b();
X< int const*const& > x3;  x3.b();
X< int const& >       x4;  x4.b();
```

--------------------------------

### C Function Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

An example of a standard C function that calculates the factorial of a number. This function serves as the base for demonstrating how to make it accessible from scripting languages.

```c
int fact(int n) {
  if (n <= 1)
    return 1;
  else
    return n*fact(n-1);
}

```

--------------------------------

### Compiling and Linking with SWIG

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Example of using SWIG with the -c++ option and subsequent compilation and linking steps for creating a shared library.

```bash
$ swig -c++ -tcl example.i
$ c++ -fPIC -c example_wrap.cxx 
$ c++ example_wrap.o $(OBJS) -o example.so

```

--------------------------------

### C++ Class Method Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Example of a C++ class with a method that returns a pointer. SWIG's default behavior might lead to ownership issues if not managed.

```cpp
class Foo {
public:
  ...
  Foo *spam();
  ...
};

```

--------------------------------

### FileB.i: Including FileA.i

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

This file demonstrates how including FileA.i results in the code from FileA.i (including the fragment) being generated in the wrappers.

```swig
// FileB.i\n%include "FileA.i"
```

--------------------------------

### Python 3 Constructor Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Demonstrates an alternative construction method for Python 3, utilizing super().__init__.

```python
super().__init__(foo) # Alternative construction for Python3
```

--------------------------------

### Custom Java Body Typemap Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

An example of a custom 'javabody' typemap that modifies access modifiers for the swigCPtr and swigCMemOwn fields, and the constructor and getCPtr methods to be protected.

```swig
%typemap(javabody) SWIGTYPE %{
  private transient long swigCPtr;
  protected transient boolean swigCMemOwn;

  protected $javaclassname(long cPtr, boolean cMemoryOwn) {
    swigCMemOwn = cMemoryOwn;
    swigCPtr = cPtr;
  }

  protected static long getCPtr($javaclassname obj) {
    return (obj == null) ? 0 : obj.swigCPtr;
  }
%}
```

--------------------------------

### C Global Variable Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

A simple C global variable declaration. This serves as an example for demonstrating how such variables can be linked and accessed from scripting languages like Perl.

```c
double Foo = 3.5;

```

--------------------------------

### Run SWIG Test Suite

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Execute the SWIG test suite on Unix-like systems to verify the build. This can be run before or after installation and requires at least one target language to be installed.

```bash
    $ make -k check

```

--------------------------------

### Python Example: Initializing Container with std::vector

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Illustrates how to call a SWIG-wrapped constructor that takes a `std::vector` from Python, demonstrating the usage of the alternative constructor added via `%extend`.

```python
>>> c = Container( [1, 2, 3, 4] )

```

--------------------------------

### Java Proxy Class Usage Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Example demonstrating how to instantiate and use a generated Java proxy class. It shows creating an object, setting a member, and calling a method.

```java
Foo f = new Foo();
f.setX(3);
int y = f.spam(5, new Foo());
```

--------------------------------

### Load and Use Shared Library in Scripting Language

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Demonstrates how to load a shared library and call a function from it within a scripting environment.

```swig
% load ./example.so
% fact 4
24
%
```

--------------------------------

### SWIG Template Instantiation Example

Source: https://www.swig.org/Doc4.4/SWIGDocumentation.html

Demonstrates basic SWIG template instantiation for a List class, showing a valid and an illegal instantiation.

```swig
%template(intList) List<int>; // ok
%template(intList) ListOfInt; // illegal - Syntax error
```
Tokens:
Raw