Constants
@@ -66,7 +67,7 @@ To build an Scilab module, run SWIG using the -scilab option.
-This creates a C source file example_wrap.cand a interface file builder.sce. The generated C source file contains the low-level wrappers that need to be compiled and linked with the rest of your C application (in this case, the gcd implementation) to create an extension module. And the builder.sce is used to generate the *.so file.
+This creates a C source file example_wrap.c and a interface file builder.sce. The generated C source file contains the low-level wrappers that need to be compiled and linked with the rest of your C application (in this case, the gcd implementation) to create an extension module. And the builder.sce is used to generate the *.so file.
@@ -89,7 +90,7 @@ $ ./scilab
where builder.sce is the interface file generated by the swig. It looks like the following:
-
+
ilib_name = "examplelib";
files = ["example_wrap.c","example.o"];
libs = [];
@@ -97,16 +98,21 @@ table = ["gcd","_wrap_gcd";"Foo_set","_wrap_Foo_set";"Foo_get","_wrap_Foo_get";]
ilib_build(ilib_name,table,files,libs);
-"ilib_name" is the name of the lib we want to build. "table" contains the name of the C file and its wrapper file. "files" represent the .o file we want to compile, and"libs" is other libs we want to use.
+
ilib_build(lib_name,table,files,libs) is used to create shared libraries and to generate a loader file which can be used to dynamically load the shared library into Scilab with addinter.
+
+- ilib_name: a character string, the generic name of the library without path and extension.
+- files: string matrix giving objects files needed for shared library creation.
+- libs: string matrix giving extra libraries needed for shred library creation.
+- table: two column string matrix giving the table of pairs 'scilab-name', 'interface name'.
+
+
"exec builder.sce" will produce *.so,and a file called "loader.sce" which contains how to load the module. Loading it into Scilab is then a matter of invoking
-
Scilab:1> exec loader.sce
+
Scilab:1> exec loader.sce
36.2.2 Using your module
@@ -119,9 +125,12 @@ Assuming all goes well, you will be able to do this:
Scilab:2>gcd(4,6)
ans = 2
+
Scilab:3>Foo_get
ans = 3
+
Scilab:4>Foo_set(4);
+
Scilab:5>Foo_get
ans = 4
@@ -135,7 +144,7 @@ ans = 4
+
// ------------------------------------------------------
// generated by builder.sce: Please do not edit this file
// ------------------------------------------------------
@@ -153,6 +162,15 @@ clear get_file_path;
// ------------------------------------------------------
addinter (files,spname,fcts) performs incremental linking of a compiled C new Scilab interface routine.
+
+
+- files: a character string or a vector of character string contain object files used to define the new Scilab interface routine (interface code, user routines or libraries, system libraries).
+- spname: a character string. Name of interface routine entry point.
+- fcts: vector of character strings. The name of new Scilab function implemented in the new interface.
+
+
+
After you run the command "exec loader.sce", you could use the module.
@@ -176,16 +194,55 @@ ant=24
27.3.3 Global variables
- To expose variables, SWIG actually generates two functions, to get and set the value. In this case, Foo_set and Foo_set would be generated. SWIG then automatically calls these functions when you get and set the variable-- in the former case creating a local copy in the interpreter of the C variables, and in the latter case copying an interpreter variables onto the C variable.
+ To expose variables, SWIG actually generates two functions, to get and set the value. In this case, Foo_set and Foo_get would be generated. SWIG then automatically calls these functions when you get and set the variable-- in the former case creating a local copy in the interpreter of the C variables, and in the latter case copying an interpreter variables onto the C variable.
scilab:1> exec loader.sce;
-scilab:2> c=Foo
-c = 3
-scilab:3> Foo=4;
+scilab:2> c=Foo_get();
+
+scilab:3> Foo_set(4);
+
scilab:4> c
c = 3
-scilab:5> Foo
+
+scilab:5> Foo_get()
ans = 4
27.3.4 Constants
+
+
+
+ C constants are not really constant in Scilab. They are actually just a copy of the value into the Scilab interpreter. Therefore they can be changed just as any other value. For example given some constants:
+
+
+ %module example
+%constant int ICONST=42;
+#define SCONST "Hello World"
+
+ This is 'effectively' converted into the following code in the wrapper file:
+
+
+ ....
+const int ICONST=42;
+const char * SCONST="Hello World";
+....
+int ICONST_get (char *fname,unsigned long fname_len) {..}
+int SCONST_get (char *fname,unsigned long fname_len) {..}
+.... It is easy to use the C constants as global variables:
+
+
+scilab:1> ICONST
+ant = 42
+
+scilab:2> SCONST
+ant= Hello world
+
+scilab:3> c=SCONST()
+c = Hello World
+