It happens especially when wrapping structs/classes, for which the wrapping functions name are composed of the struct/class name and field names. In that case, the SWIG rename instruction, to choose a different wrapping name, can be useful. +
It happens especially when wrapping structs/classes, for which the wrapping functions name are composed of the struct/class name and field names. +In that case, the SWIG rename instruction, to choose a different wrapping name, can be useful.
-%module example
-int fact(int n);
+%module example
+
+%inline %{
+int fact(int n) {
+ if (n > 1)
+ return n * fact(n - 1);
+ else
+ return 1;
+}
+%}
@@ -343,6 +352,105 @@ ans = +
+In this example, the function parameter is of simple type, and transmitted by value. +So this function is wrapped without any other work than declaring it. +
+ ++Argument values are converted automatically between C and Scilab through type mappings which are described here. +There are several available type mappings for simple and complex types. +
+ ++When a parameter is not transmitted by value, is a pointer (or a reference), SWIG does not know if it is an input, output (or both) parameter. +The argument type can be specified with the INPUT, OUTPUT, INOUT keywords defined in the library typemaps.i +
+ ++Let's see it on two simple functions: +
+ +
+%module example
+
+%include typemaps.i
+
+extern void sub(int *INPUT, int *INPUT, int *OUTPUT);
+extern void inc(int *INOUT, int *INPUT);
+
+%{
+void sub(int *x, int *y, int *result) {
+ *result = *x - *y;
+}
+void inc(int *x, int *delta) {
+ *x = *x + *delta;
+}
+%}
++Note: in fact, it is not necessary to include the library typemaps.i, this one is included by default. +
+ ++In Scilab, parameters are passed by value. The output (and inout) parameters are returned as result of the functions: +
+ ++-->sub(5, 3) + ans = + + 2. + +-->inc(4, 3) + ans = + + 7. +
+Scilab supports multiple values to be returned from a function. +A C function can have several output parameters, they are all returned as results of the wrapped function. +If the function itself returns also a result, it is returned in first in the result of the function. +
+ ++This example shows this for a function returning 2 values and a result: +
+ +
+%module example
+
+int divide(int n, int d, int *OUTPUT, int *OUTPUT);
+
+%{
+int divide(int n, int d, int q*, int *r) {
+ if (d != 0) {
+ *q = n / d;
+ *r = n % d;
+ return 1;
+ }
+ else return 0;
+}
+%}
++
+-->[ret, q, r] = divide(20, 6) + r = + + 2. + q = + + 3. + ret = + + 1. +
Given a wrapping of some of the C file functions:
++Given a wrapping of some of the C file functions: +
%module example