swig/Lib/java/enumtypesafe.swg
William S Fulton 990156dff1 Enum typemaps taken out of java.swg
New typemap files for the different C/C++ to Java enum wrapping approaches.


git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk/SWIG@5921 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2004-05-24 20:09:17 +00:00

68 lines
2.6 KiB
Text

/* -----------------------------------------------------------------------------
* Include this file in order for C/C++ enums to be wrapped by the so called
* typesafe enum pattern. Each enum has an equivalent Java class named after the
* enum and each enum item is a static instance of this class.
* ----------------------------------------------------------------------------- */
%typemap(jni) enum SWIGTYPE "jint"
%typemap(jtype) enum SWIGTYPE "int"
%typemap(jstype) enum SWIGTYPE "$javaclassname"
%typemap(in) enum SWIGTYPE %{ $1 = ($1_ltype)$input; %}
%typemap(out) enum SWIGTYPE %{ $result = (jint)$1; %}
%typemap(directorin, descriptor="I") enum SWIGTYPE "$input = (jint) $1;"
%typemap(javadirectorin) enum SWIGTYPE "$jniinput"
%typemap(javadirectorout) enum SWIGTYPE "$javacall"
%typecheck(SWIG_TYPECHECK_INT32) enum SWIGTYPE ""
%typemap(javain) enum SWIGTYPE "$javainput.swigValue()"
%typemap(javaout) enum SWIGTYPE {
return $javaclassname.swigToEnum($jnicall);
}
%typemap(throws) enum SWIGTYPE {
SWIG_JavaThrowException(jenv, SWIG_JavaRuntimeException, "C++ $1_type exception thrown");
}
// '$static' will be replaced with either 'static' or nothing depending on whether the enum is an inner Java class or not
%typemap(javaclassmodifiers) enum SWIGTYPE "public $static class"
/*
* The swigToEnum method is used to find the Java enum from a C++ enum integer value. The default one here takes
* advantage of the fact that most enums do not have initial values specified, so the lookup is fast. If initial
* values are specified then a lengthy linear search through all possible enums might occur. Specific typemaps could be
* written to possibly optimise this lookup by taking advantage of characteristics peculiar to the targeted enum.
* The special variable, $enumvalues, is replaced with a comma separated list of all the enum values.
*/
%typemap(javagetcptr) enum SWIGTYPE %{
public final int swigValue() {
return swigValue;
}
public static $javaclassname swigToEnum(int swigValue) {
if (swigValue < swigValues.length && swigValues[swigValue].swigValue == swigValue)
return swigValues[swigValue];
for (int i = 0; i<swigValues.length; i++)
if (swigValues[i].swigValue == swigValue)
return swigValues[i];
throw new IllegalArgumentException("No enum " + $javaclassname.class + " with value " + swigValue);
}
private $javaclassname() {
this.swigValue = next++;
}
private $javaclassname(int swigValue) {
this.swigValue = swigValue;
next = swigValue+1;
}
private static $javaclassname[] swigValues = { $enumvalues };
private static int next = 0;
private final int swigValue;
%}
%javaenum(typesafe);