The Java directors feature requires the %typemap(inv), the %typemap(directorin), the %typemap(javadirectorin) and the %typemap(javadirectorout) type maps in
order to work properly.
- The %typemap(inv) type map is used for converting arguments
+ The %typemap(directorin) type map is used for converting arguments
in the C++ director class to the appropriate JNI type before the upcall
to Java. This typemap also specifies the JNI field descriptor for the
type. For example, integers are converted as follows:
-
%typemap(inv,parse="I") int "$input = (jint) $1;"+
%typemap(directorin,parse="I") int "$input = (jint) $1;"
$input is the SWIG name of the JNI temporary variable passed to
Java in the upcall. The parse="I" will put an I
into the JNI field descriptor that identifies the Java method that will be
@@ -4183,7 +4183,7 @@ order to work properly.
A typemap for C character strings is:
-
%typemap(inv,parse="Ljava/lang/String;") char * +%typemap(directorin,parse="Ljava/lang/String;") char * %{ $input = jenv->NewStringUTF($1); %}diff --git a/SWIG/Doc/Manual/Ocaml.html b/SWIG/Doc/Manual/Ocaml.html index 4fe761024..b879599a0 100644 --- a/SWIG/Doc/Manual/Ocaml.html +++ b/SWIG/Doc/Manual/Ocaml.html @@ -43,10 +43,10 @@
-Special typemaps exist for use with directors, the inv, outv, argoutv +Special typemaps exist for use with directors, the directorin, directorout, directorargout are used in place of in, out, argout typemaps, except that their direction is reversed. They provide for you to provide argout values, as 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.
--The inv typemap is used when you will receive arguments from a call +The directorin typemap is used when you will receive arguments from a call made by C++ code to you, therefore, values will be translated from C++ to ocaml. You must provide some valid C_obj value. This is the value your ocaml -code receives when you are called. In general, a simple inv typemap +code receives when you are called. In general, a simple directorin typemap can use the same body as a simple out typemap.
--The outv typemap is used when you will send an argument from your -code back to the C++ caller. That is; outv specifies a function return +The directorout typemap is used when you will send an argument from your +code back to the C++ caller. That is; directorout specifies a function return conversion. You can usually use the same body as an in typemap for the same type, except when there are special requirements for object ownership, etc.
-C++ allows function arguments which are by pointer (*) and by reference (&) to receive a value from the called function, as well as sending one there. -Sometimes, this is the main purpose of the argument given. argoutv +Sometimes, this is the main purpose of the argument given. directorargout typemaps allow your caml code to emulate this by specifying additional return values to be put into the output parameters. The SWIG ocaml module is a bit loose in order to make code eaiser to write. In this case, your return to the caller must be a list containing the normal function return first, followed by any argout values in order. These argout values will be taken from the -list and assigned to the values to be returned to C++ through argoutv typemaps. +list and assigned to the values to be returned to C++ through directorargout typemaps. 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.
@@ -895,4 +895,4 @@ Catching exceptions is now supported using SWIG's %exception feature. A simple but not too useful example is provided by the throw_exception testcase in Examples/test-suite. You can provide your own exceptions, too.