Merge pull request #589 from marco2357/master

Use MethodResultContext in direct mapping (as done in interface mapping)

CHANGES.md

@@ -34,6 +34,7 @@ Features
 * [#577](https://github.com/java-native-access/jna/pull/577): Apply generic definitions wherever applicable - [@lgoldstein](https://github.com/lgoldstein).
 * [#569](https://github.com/java-native-access/jna/pull/569): Added `com.sun.jna.platform.win32.Winspool.PRINTER_INFO_2` support. Added GetPrinter and ClosePrinter functions in `com.sun.jna.platform.win32.Winspool` - [@IvanRF](https://github.com/IvanRF).
 * [#583](https://github.com/java-native-access/jna/pull/583): Added printer attributes and status - [@IvanRF](https://github.com/IvanRF).
+* [#589](https://github.com/java-native-access/jna/pull/589): Use MethodResultContext in direct mapping (as done in interface mapping) - [@marco2357](https://github.com/marco2357).
 
 Bug Fixes
 ---------

build.xml

@@ -67,12 +67,12 @@
   </condition>
   <property name="jna.version" value="${jna.major}.${jna.minor}.${jna.revision}${version.suffix}"/>
   <!-- jnidispatch library release version -->
-  <property name="jni.major" value="4"/>
+  <property name="jni.major" value="5"/>
   <property name="jni.minor" value="0"/>
   <property name="jni.revision" value="1"/>
   <property name="jni.build" value="0"/> <!--${build.number}-->
   <property name="jni.version" value="${jni.major}.${jni.minor}.${jni.revision}"/>
-  <property name="jni.md5" value="1a6047467b59e8748f975e03016ce3d9"/>
+  <property name="jni.md5" value="4f72f2799dfee6008a386bc40afd7428"/>
   <property name="spec.title" value="Java Native Access (JNA)"/>
   <property name="spec.vendor" value="${vendor}"/>
   <property name="spec.version" value="${jna.major}"/>

native/Makefile

@@ -50,8 +50,8 @@ OS=$(shell uname | sed -e 's/CYGWIN.*/win32/g' \
                         -e 's/AIX.*/aix/g' \
                         -e 's/Linux.*/linux/g')
 
-JNA_JNI_VERSION=4.0.1 # auto-generated by ant
-CHECKSUM=1a6047467b59e8748f975e03016ce3d9 # auto-generated by ant
+JNA_JNI_VERSION=5.0.1 # auto-generated by ant
+CHECKSUM=4f72f2799dfee6008a386bc40afd7428 # auto-generated by ant
 
 JAVA_INCLUDES=-I"$(JAVA_HOME)/include" \
               -I"$(JAVA_HOME)/include/$(OS)"

native/callback.c

@@ -393,7 +393,7 @@ invoke_callback(JNIEnv* env, callback *cb, ffi_cif* cif, void *resp, void **cbar
         case CVT_NATIVE_MAPPED_WSTRING:
 	  // Make sure we have space enough for the new argument
 	  args[i+3] = alloca(sizeof(void *));
-	  *((void **)args[i+3]) = fromNative(env, cb->arg_classes[i], cif->arg_types[i], cbargs[i], JNI_FALSE, cb->encoding);
+	  *((void **)args[i+3]) = fromNativeCallbackParam(env, cb->arg_classes[i], cif->arg_types[i], cbargs[i], JNI_FALSE, cb->encoding);
           break;
         case CVT_POINTER:
           *((void **)args[i+3]) = newJavaPointer(env, *(void **)cbargs[i]);

native/dispatch.c

@@ -183,6 +183,7 @@ static jmethodID MID_DoubleBuffer_arrayOffset;
 
 static jmethodID MID_Pointer_init;
 static jmethodID MID_Native_dispose;
+static jmethodID MID_Native_fromNativeCallbackParam;
 static jmethodID MID_Native_fromNative;
 static jmethodID MID_Native_nativeType;
 static jmethodID MID_Native_toNativeTypeMapped;
@@ -1147,16 +1148,17 @@ static void
 fromNativeTypeMapped(JNIEnv* env, jobject from_native,
                      void* native_return_value,
                      int jtype, size_t size,
-                     jclass java_return_class,
+                     jobject java_method,
                      void* result_storage,
                      const char* encoding) {
   jobject value = new_object(env, (char)jtype, native_return_value, JNI_TRUE, encoding);
   if (!(*env)->ExceptionCheck(env)) {
     jobject obj = (*env)->CallStaticObjectMethod(env, classNative,
                                                  MID_Native_fromNativeTypeMapped,
-                                                 from_native, value, java_return_class);
+                                                 from_native, value, java_method);
     if (!(*env)->ExceptionCheck(env)) {
       // Convert objects into primitive types if the return class demands it
+      jclass java_return_class = (*env)->CallObjectMethod(env, java_method, MID_Method_getReturnType);
       if ((*env)->IsSameObject(env, java_return_class, classPrimitiveBoolean)
           || (*env)->IsSameObject(env, java_return_class, classPrimitiveByte)
           || (*env)->IsSameObject(env, java_return_class, classPrimitiveCharacter)
@@ -1175,17 +1177,29 @@ fromNativeTypeMapped(JNIEnv* env, jobject from_native,
 }
 
 jobject
-fromNative(JNIEnv* env, jclass javaClass, ffi_type* type, void* resp, jboolean promote, const char* encoding) {
+fromNativeCallbackParam(JNIEnv* env, jclass javaClass, ffi_type* type, void* resp, jboolean promote, const char* encoding) {
   int jtype = get_java_type_from_ffi_type(type);
   jobject value = new_object(env, (char)jtype, resp, promote, encoding);
   if (!(*env)->ExceptionCheck(env)) {
     return (*env)->CallStaticObjectMethod(env, classNative,
-                                          MID_Native_fromNative,
+                                          MID_Native_fromNativeCallbackParam,
                                           javaClass, value);
   }
   return NULL;
 }
 
+jobject
+fromNative(JNIEnv* env, jobject javaMethod, ffi_type* type, void* resp, jboolean promote, const char* encoding) {
+  int jtype = get_java_type_from_ffi_type(type);
+  jobject value = new_object(env, (char)jtype, resp, promote, encoding);
+  if (!(*env)->ExceptionCheck(env)) {
+    return (*env)->CallStaticObjectMethod(env, classNative,
+                                          MID_Native_fromNative,
+                                          javaMethod, value);
+  }
+  return NULL;
+}
+
 
 static ffi_type*
 getStructureType(JNIEnv *env, jobject obj) {
@@ -1670,7 +1684,7 @@ typedef struct _method_data {
   ffi_type** closure_arg_types;
   int*    flags;
   int     rflag;
-  jclass  closure_rclass;
+  jobject closure_method;
   jobject* to_native;
   jobject  from_native;
   jboolean throw_last_error;
@@ -1860,15 +1874,15 @@ dispatch_direct(ffi_cif* cif, void* volatile resp, void** argp, void *cdata) {
                    ? 'c' : (data->rflag == CVT_TYPE_MAPPER_WSTRING
                             ? 'w' : get_java_type_from_ffi_type(data->cif.rtype)));
       fromNativeTypeMapped(env, data->from_native, resp, jtype, data->cif.rtype->size,
-                           data->closure_rclass, oldresp, data->encoding);
+                           data->closure_method, oldresp, data->encoding);
     }
     break;
   case CVT_INTEGER_TYPE:
   case CVT_POINTER_TYPE:
   case CVT_NATIVE_MAPPED:
   case CVT_NATIVE_MAPPED_STRING:
   case CVT_NATIVE_MAPPED_WSTRING:
-    *(void **)oldresp = fromNative(env, data->closure_rclass, data->cif.rtype, resp, JNI_TRUE, data->encoding);
+    *(void **)oldresp = fromNative(env, data->closure_method, data->cif.rtype, resp, JNI_TRUE, data->encoding);
     break;
   case CVT_POINTER:
     *(void **)resp = newJavaPointer(env, *(void **)resp);
@@ -1880,13 +1894,22 @@ dispatch_direct(ffi_cif* cif, void* volatile resp, void** argp, void *cdata) {
     *(void **)resp = newJavaWString(env, *(void **)resp);
     break;
   case CVT_STRUCTURE:
-    *(void **)resp = newJavaStructure(env, *(void **)resp, data->closure_rclass);
+    {
+      jclass return_class = (*env)->CallObjectMethod(env, data->closure_method, MID_Method_getReturnType);
+      *(void **)resp = newJavaStructure(env, *(void **)resp, return_class);
+    }
     break;
   case CVT_STRUCTURE_BYVAL:
-    *(void **)oldresp = newJavaStructure(env, resp, data->closure_rclass);
+    {
+      jclass return_class = (*env)->CallObjectMethod(env, data->closure_method, MID_Method_getReturnType);
+      *(void **)oldresp = newJavaStructure(env, resp, return_class);
+    }
     break;
   case CVT_CALLBACK:
-    *(void **)resp = newJavaCallback(env, *(void **)resp, data->closure_rclass);
+    {
+      jclass return_class = (*env)->CallObjectMethod(env, data->closure_method, MID_Method_getReturnType);
+      *(void **)resp = newJavaCallback(env, *(void **)resp, return_class);
+    }
     break;
   default:
     break;
@@ -2749,11 +2772,17 @@ Java_com_sun_jna_Native_initIDs(JNIEnv *env, jclass cls) {
     throwByName(env, EUnsatisfiedLink,
                 "Can't obtain static method dispose from class com.sun.jna.Native");
   }
-  else if (!(MID_Native_fromNative
+  else if (!(MID_Native_fromNativeCallbackParam
              = (*env)->GetStaticMethodID(env, classNative,
                                          "fromNative", "(Ljava/lang/Class;Ljava/lang/Object;)Lcom/sun/jna/NativeMapped;"))) {
     throwByName(env, EUnsatisfiedLink,
-                "Can't obtain static method fromNative from class com.sun.jna.Native");
+                "Can't obtain static method fromNative(Class, Object) from class com.sun.jna.Native");
+  }
+  else if (!(MID_Native_fromNative
+             = (*env)->GetStaticMethodID(env, classNative,
+                                         "fromNative", "(Ljava/lang/reflect/Method;Ljava/lang/Object;)Lcom/sun/jna/NativeMapped;"))) {
+    throwByName(env, EUnsatisfiedLink,
+                "Can't obtain static method fromNative(Method, Object) from class com.sun.jna.Native");
   }
   else if (!(MID_Native_nativeType
              = (*env)->GetStaticMethodID(env, classNative,
@@ -2769,9 +2798,9 @@ Java_com_sun_jna_Native_initIDs(JNIEnv *env, jclass cls) {
   }
   else if (!(MID_Native_fromNativeTypeMapped
              = (*env)->GetStaticMethodID(env, classNative,
-                                         "fromNative", "(Lcom/sun/jna/FromNativeConverter;Ljava/lang/Object;Ljava/lang/Class;)Ljava/lang/Object;"))) {
+                                         "fromNative", "(Lcom/sun/jna/FromNativeConverter;Ljava/lang/Object;Ljava/lang/reflect/Method;)Ljava/lang/Object;"))) {
     throwByName(env, EUnsatisfiedLink,
-                "Can't obtain static method fromNative from class com.sun.jna.Native");
+                "Can't obtain static method fromNative(FromNativeConverter, Object, Method) from class com.sun.jna.Native");
   }
   else if (!LOAD_CREF(env, Structure, "com/sun/jna/Structure")) {
     throwByName(env, EUnsatisfiedLink,
@@ -3250,7 +3279,7 @@ Java_com_sun_jna_Native_unregister(JNIEnv *env, jclass UNUSED(ncls), jclass cls,
       }
     }
     if (md->from_native) (*env)->DeleteWeakGlobalRef(env, md->from_native);
-    if (md->closure_rclass) (*env)->DeleteWeakGlobalRef(env, md->closure_rclass);
+    if (md->closure_method) (*env)->DeleteGlobalRef(env, md->closure_method);
     free(md->arg_types);
     free(md->closure_arg_types);
     free(md->flags);
@@ -3277,7 +3306,7 @@ Java_com_sun_jna_Native_registerMethod(JNIEnv *env, jclass UNUSED(ncls),
                                        jint rconversion,
                                        jlong closure_return_type,
                                        jlong return_type,
-                                       jclass closure_rclass,
+                                       jobject closure_method,
                                        jlong function, jint cc,
                                        jboolean throw_last_error,
                                        jobjectArray to_native,
@@ -3315,7 +3344,7 @@ Java_com_sun_jna_Native_registerMethod(JNIEnv *env, jclass UNUSED(ncls),
   data->closure_arg_types = malloc(sizeof(ffi_type*) * (argc + 2));
   data->closure_arg_types[0] = &ffi_type_pointer;
   data->closure_arg_types[1] = &ffi_type_pointer;
-  data->closure_rclass = NULL;
+  data->closure_method = NULL;
   data->flags = cvts ? malloc(sizeof(jint)*argc) : NULL;
   data->rflag = rconversion;
   data->to_native = NULL;
@@ -3342,7 +3371,7 @@ Java_com_sun_jna_Native_registerMethod(JNIEnv *env, jclass UNUSED(ncls),
   if (closure_types) (*env)->ReleaseLongArrayElements(env, closure_atypes, closure_types, 0);
   if (cvts) (*env)->ReleaseIntArrayElements(env, conversions, cvts, 0);
   data->fptr = L2A(function);
-  data->closure_rclass = (*env)->NewWeakGlobalRef(env, closure_rclass);
+  data->closure_method = (*env)->NewGlobalRef(env, closure_method);
 
   status = ffi_prep_cif(closure_cif, abi, argc+2, closure_rtype, data->closure_arg_types);
   if (ffi_error(env, "Native method mapping", status)) {

native/dispatch.h

@@ -216,7 +216,7 @@ extern void* getPointerTypeAddress(JNIEnv*, jobject);
 extern void writeStructure(JNIEnv*, jobject);
 extern jclass getNativeType(JNIEnv*, jclass);
 extern void toNative(JNIEnv*, jobject, void*, size_t, jboolean, const char*);
-extern jclass fromNative(JNIEnv*, jclass, ffi_type*, void*, jboolean, const char*);
+extern jclass fromNativeCallbackParam(JNIEnv*, jclass, ffi_type*, void*, jboolean, const char*);
 
 typedef struct _AttachOptions {
   int daemon;

src/com/sun/jna/Native.java

@@ -1716,7 +1716,7 @@ public static void register(Class<?> cls, NativeLibrary lib) {
                                             sig, cvt,
                                             closure_atypes, atypes, rcvt,
                                             closure_rtype, rtype,
-                                            rclass,
+                                            method,
                                             f.peer, f.getCallingConvention(),
                                             throwLastError,
                                             toNative, fromNative,
@@ -1769,7 +1769,7 @@ private static native long registerMethod(Class<?> cls,
                                               int rconversion,
                                               long closure_rtype,
                                               long rtype,
-                                              Class<?> rclass,
+                                              Method method,
                                               long fptr,
                                               int callingConvention,
                                               boolean throwLastError,
@@ -1780,11 +1780,15 @@ private static native long registerMethod(Class<?> cls,
 
     // Called from native code
     private static NativeMapped fromNative(Class<?> cls, Object value) {
-        // NOTE: technically should be either CallbackParameterContext or
-        // FunctionResultContext
+        // NOTE: technically should be CallbackParameterContext
         return (NativeMapped)NativeMappedConverter.getInstance(cls).fromNative(value, new FromNativeContext(cls));
     }
     // Called from native code
+    private static NativeMapped fromNative(Method m, Object value) {
+    	Class<?> cls = m.getReturnType();
+        return (NativeMapped)NativeMappedConverter.getInstance(cls).fromNative(value, new MethodResultContext(cls, null, null, m));
+    }
+    // Called from native code
     private static Class<?> nativeType(Class<?> cls) {
         return NativeMappedConverter.getInstance(cls).nativeType();
     }
@@ -1795,9 +1799,8 @@ private static Object toNative(ToNativeConverter cvt, Object o) {
         return cvt.toNative(o, new ToNativeContext());
     }
     // Called from native code
-    private static Object fromNative(FromNativeConverter cvt, Object o, Class<?> cls) {
-        // NOTE: technically should be FunctionResultContext
-        return cvt.fromNative(o, new FromNativeContext(cls));
+    private static Object fromNative(FromNativeConverter cvt, Object o, Method m) {
+        return cvt.fromNative(o, new MethodResultContext(m.getReturnType(), null, null, m));
     }
 
     /** Create a new cif structure. */

src/com/sun/jna/Version.java

@@ -13,5 +13,5 @@
 package com.sun.jna;
 interface Version {
     String VERSION = "4.2.0";
-    String VERSION_NATIVE = "4.0.1";
+    String VERSION_NATIVE = "5.0.1";
 }

test/com/sun/jna/DirectTest.java

@@ -282,5 +282,52 @@ public String getFunctionName(NativeLibrary lib, Method method) {
             fail("Native method was not properly mapped: " + e);
         }
     }
+
+    public static class PointerNativeMapped implements NativeMapped {
+        String nativeMethodName;
+        @Override
+        public PointerNativeMapped fromNative(Object nativeValue, FromNativeContext context) {
+            nativeMethodName = ((MethodResultContext)context).getMethod().getName();
+            return this;
+        }
+        @Override
+        public Object toNative() {
+            return null;
+        }
+        @Override
+        public Class<?> nativeType() {
+            return Pointer.class;
+        }
+    }
+    public static class PointerTypeMapped {
+        String nativeMethodName;
+    }
+    public static class FromNativeTests {
+        static native PointerNativeMapped returnPointerArgument(PointerNativeMapped arg);
+        static native PointerTypeMapped returnPointerArgument(PointerTypeMapped arg);
+    }
+    public void testDirectMappingFromNative() {
+        DefaultTypeMapper mapper = new DefaultTypeMapper();
+        mapper.addTypeConverter(PointerTypeMapped.class, new TypeConverter() {
+            @Override
+            public PointerTypeMapped fromNative(Object nativeValue, FromNativeContext context) {
+                PointerTypeMapped ret = new PointerTypeMapped();
+                ret.nativeMethodName = ((MethodResultContext)context).getMethod().getName();
+                return ret;
+            }
+            @Override
+            public Object toNative(Object value, ToNativeContext context) {
+                return null;
+            }
+            @Override
+            public Class<?> nativeType() {
+                return Pointer.class;
+            }
+        });
+        NativeLibrary lib = NativeLibrary.getInstance("testlib", Collections.singletonMap(Library.OPTION_TYPE_MAPPER, mapper));
+        Native.register(FromNativeTests.class, lib);
+        assertEquals("Failed to access MethodResultContext", "returnPointerArgument", FromNativeTests.returnPointerArgument(new PointerNativeMapped()).nativeMethodName);
+        assertEquals("Failed to access MethodResultContext", "returnPointerArgument", FromNativeTests.returnPointerArgument(new PointerTypeMapped()).nativeMethodName);
+    }
 }