Merge branch 'feature/return_nsstring_opt' into feature/invoke_perf_opt

* feature/return_nsstring_opt:
  fix: debug run scheme
  feat: retType support string
  feat: return string for nsstring by default.

# Conflicts:
#	dart_native/ios/DartNative.framework/DartNative
#	dart_native/lib/src/ios/common/pointer_encoding.dart
#	dart_native/lib/src/ios/runtime/block.dart
#	dart_native/lib/src/ios/runtime/message.dart

Author: yulingtianxia

dart_native/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme

@@ -43,6 +43,7 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      enableASanStackUseAfterReturn = "YES"
       launchStyle = "0"
       useCustomWorkingDirectory = "NO"
       ignoresPersistentStateOnLaunch = "NO"

dart_native/example/lib/ios/runtimestub.dart

@@ -244,9 +244,7 @@ class RuntimeStub extends NSObject {
   }
 
   String fooNSString(String str) {
-    Pointer<Void> result =
-        perform(SEL('fooNSString:'), args: [str], decodeRetVal: false);
-    return NSString.fromPointer(result).raw;
+    return perform(SEL('fooNSString:'), args: [str]);
   }
 
   Future<dynamic> fooNSStringAsync(String str) async {
@@ -257,9 +255,7 @@ class RuntimeStub extends NSObject {
 
   String fooNSMutableString(String str) {
     NSMutableString _str = NSMutableString(str);
-    Pointer<Void> result =
-        perform(SEL('fooNSMutableString:'), args: [_str], decodeRetVal: false);
-    return NSMutableString.fromPointer(result).raw;
+    return perform(SEL('fooNSMutableString:'), args: [_str]);
   }
 
   bool fooWithError(NSObjectRef<NSError> error) {

dart_native/example/lib/ios/unit_test.dart

@@ -148,9 +148,7 @@ testIOS(RuntimeStub stub, DelegateStub delegate) {
   Class('NSThread')
       .performAsync(SEL('currentThread'), onQueue: DispatchQueue.global())
       .then((currentThread) {
-    NSObject description = currentThread.perform(SEL('description'));
-    String threadResult = NSString.fromPointer(description.pointer).raw;
-    print('currentThread: $threadResult');
+    print('currentThread: ${currentThread.description}');
   });
 
   NSNotificationCenter.defaultCenter.addObserver(

dart_native/ios/Classes/DNInvocation.m

@@ -157,7 +157,7 @@ - (void *)_copyPointer:(void **)pointer encode:(const char *)encode key:(NSNumbe
 }
 
 - (void)_retainPointer:(void **)pointer encode:(const char *)encode key:(NSNumber *)key {
-    if (!pointer) {
+    if (!pointer || *encode == 'v') {
         return;
     }
     void *p = *pointer;

dart_native/ios/Classes/DNObjectDealloc.m

@@ -54,19 +54,27 @@ + (void)attachHost:(NSObject *)host
     }
 }
 
+static int64_t fuxk;
+
 - (instancetype)initWithHost:(NSObject *)host
                     dartPort:(Dart_Port)dartPort {
     self = [super init];
     if (self) {
         _host = host;
         _hostAddress = (int64_t)host;
+//        if ([host isKindOfClass:NSClassFromString(@"Fuck")]) {
+//            fuxk = _hostAddress;
+//        }
         _dartPort = dartPort;
         objc_setAssociatedObject(host, _cmd, self, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
     }
     return self;
 }
 
 - (void)dealloc {
+//    if (_hostAddress == fuxk) {
+//        
+//    }
     NotifyDeallocToDart(_hostAddress, _dartPort);
 }
 

dart_native/ios/Classes/native_runtime.h

@@ -42,8 +42,9 @@ native_get_class(const char *className, Class superclass);
 /// @param args arguments passed to method.
 /// @param dartPort port for dart isolate.
 /// @param stringTypeBitmask bitmask for checking if an argument is a string.
+/// @param retType type of return value.
 DN_EXTERN void * _Nullable
-native_instance_invoke(id object, SEL selector, NSMethodSignature *signature, dispatch_queue_t queue, void * _Nonnull * _Nullable args, void (^callback)(void *), Dart_Port dartPort, int64_t stringTypeBitmask);
+native_instance_invoke(id object, SEL selector, NSMethodSignature *signature, dispatch_queue_t queue, void * _Nonnull * _Nullable args, void (^callback)(void *), Dart_Port dartPort, int64_t stringTypeBitmask, const char *_Nonnull *_Nonnull retType);
 
 DN_EXTERN void *
 native_block_create(char *types, void *callback, Dart_Port dartPort);

dart_native/ios/Classes/native_runtime.mm

@@ -125,13 +125,13 @@
                    (stringTypeBitmask >> argsIndex & 0x1) == 1) {
             const unichar *data = ((const unichar **)args)[argsIndex];
             // First four uint16_t is for data length.
-            const NSUInteger dataOffset = 4;
+            const NSUInteger lengthDataSize = 4;
             uint64_t length = data[0];
-            for (int i = 1; i < dataOffset; i++) {
+            for (int i = 1; i < lengthDataSize; i++) {
                 length <<= 16;
                 length |= data[i];
             }
-            NSString *realArg = [NSString stringWithCharacters:data + dataOffset length:length];
+            NSString *realArg = [NSString stringWithCharacters:data + lengthDataSize length:length];
             [stringTypeBucket addObject:realArg];
             free((void *)data); // Malloc data on dart side, need free here.
             [invocation setArgument:&realArg atIndex:i];
@@ -141,8 +141,32 @@
     }
 }
 
+
+/// Return data for NSString: [--dataLength(64bit--)][--dataContent(utf16 without BOM)--]
+/// @param retVal origin return value
+/// @param retType type for return value
+void *_dataForNSStringReturnValue(NSString *retVal, const char **retType) {
+    // first bit is for return value.
+    *retType = native_all_type_encodings()[18];
+    NSUInteger length = 0;
+    const uint16_t *utf16BufferPtr = native_convert_nsstring_to_utf16(retVal, &length);
+    size_t size = sizeof(uint16_t) * length;
+    const size_t lengthDataSize = 4;
+    // free memory on dart side.
+    uint16_t *dataPtr = (uint16_t *)malloc(size + sizeof(uint16_t) * lengthDataSize);
+    memcpy(dataPtr + lengthDataSize, utf16BufferPtr, size);
+    uint16_t lengthData[4] = {
+        static_cast<uint16_t>(length >> 48 & 0xffff),
+        static_cast<uint16_t>(length >> 32 & 0xffff),
+        static_cast<uint16_t>(length >> 16 & 0xffff),
+        static_cast<uint16_t>(length & 0xffff)
+    };
+    memcpy(dataPtr, lengthData, sizeof(uint16_t) * lengthDataSize);
+    return dataPtr;
+}
+
 void *
-native_instance_invoke(id object, SEL selector, NSMethodSignature *signature, dispatch_queue_t queue, void **args, void (^callback)(void *), Dart_Port dartPort, int64_t stringTypeBitmask) {
+native_instance_invoke(id object, SEL selector, NSMethodSignature *signature, dispatch_queue_t queue, void **args, void (^callback)(void *), Dart_Port dartPort, int64_t stringTypeBitmask, const char **retType) {
     if (!object || !selector || !signature) {
         return NULL;
     }
@@ -162,8 +186,16 @@
             } else {
                 [invocation getReturnValue:&result];
                 if (returnType == '@') {
-                    [DNObjectDealloc attachHost:(__bridge id)result
-                                       dartPort:dartPort];
+                    BOOL isNSString = [(__bridge id)result isKindOfClass:NSString.class];
+                    // highest bit is a flag for decode.
+                    BOOL decodeRetVal = (stringTypeBitmask & (1LL << 63)) != 0;
+                    // return value is a NSString and needs decode.
+                    if (isNSString && decodeRetVal) {
+                        result = _dataForNSStringReturnValue((__bridge NSString *)result, retType);
+                    } else {
+                        [DNObjectDealloc attachHost:(__bridge id)result
+                                           dartPort:dartPort];
+                    }
                 }
             }
         }
@@ -201,7 +233,10 @@
 }
 
 void *
-native_block_invoke(void *block, void **args, Dart_Port dartPort, int64_t stringTypeBitmask) {
+native_block_invoke(void *block, void **args, Dart_Port dartPort, int64_t stringTypeBitmask, const char **retType) {
+    if (!block) {
+        return nullptr;
+    }
     const char *typeString = DNBlockTypeEncodeString((__bridge id)block);
     NSMethodSignature *signature = [NSMethodSignature signatureWithObjCTypes:typeString];
     NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:signature];
@@ -216,7 +251,12 @@
             [invocation getReturnValue:result];
         } else {
             [invocation getReturnValue:&result];
-            if (returnType == '@') {
+            BOOL isNSString = [(__bridge id)result isKindOfClass:NSString.class];
+            BOOL decodeRetVal = (stringTypeBitmask & (1LL << 63)) != 0;
+            // return value is a NSString and needs decode.
+            if (isNSString && decodeRetVal) {
+                result = _dataForNSStringReturnValue((__bridge NSString *)result, retType);
+            } else {
                 [DNObjectDealloc attachHost:(__bridge id)result
                                    dartPort:dartPort];
             }
@@ -226,7 +266,7 @@
 }
 
 // Use pointer as key of encoding string cache (on dart side).
-static const char *typeList[18] = {"sint8", "sint16", "sint32", "sint64", "uint8", "uint16", "uint32", "uint64", "float32", "float64", "object", "class", "selector", "block", "char *", "void", "ptr", "bool"};
+static const char *typeList[19] = {"sint8", "sint16", "sint32", "sint64", "uint8", "uint16", "uint32", "uint64", "float32", "float64", "object", "class", "selector", "block", "char *", "void", "ptr", "bool", "string"};
 
 const char **
 native_all_type_encodings() {

dart_native/lib/src/ios/common/callback_register.dart

@@ -62,7 +62,7 @@ _callback(
     if (i + 1 < dartTypes.length) {
       String dartType = dartTypes[i + 1];
       arg = boxingObjCBasicValue(dartType, arg);
-      arg = convertFromPointer(dartType, arg);
+      arg = objcInstanceFromPointer(dartType, arg);
     }
     args.add(arg);
   }

dart_native/lib/src/ios/common/library.dart

@@ -1,7 +1,7 @@
 import 'dart:ffi';
 
 import 'package:dart_native/src/ios/common/callback_manager.dart';
-import 'package:dart_native/src/ios/runtime/nsobject.dart';
+import 'package:dart_native/src/ios/runtime/internal/nsobject_lifecycle.dart';
 
 DynamicLibrary _runtimeLib;
 DynamicLibrary get runtimeLib {
@@ -24,5 +24,4 @@ final initializeApi = runtimeLib.lookupFunction<IntPtr Function(Pointer<Void>),
     int Function(Pointer<Void>)>("InitDartApiDL");
 
 final _dartAPIResult = initializeApi(NativeApi.initializeApiDLData);
-
 final initDartAPISuccess = _dartAPIResult == 0;

dart_native/lib/src/ios/common/pointer_encoding.dart

@@ -30,6 +30,7 @@ extension TypeEncodings on Pointer<Utf8> {
   static final Pointer<Utf8> v = _typeEncodings.elementAt(15).value;
   static final Pointer<Utf8> pointer = _typeEncodings.elementAt(16).value;
   static final Pointer<Utf8> b = _typeEncodings.elementAt(17).value;
+  static final Pointer<Utf8> string = _typeEncodings.elementAt(18).value;
 
   // Return encoding only if type is struct.
   String get encodingForStruct {
@@ -44,6 +45,10 @@ extension TypeEncodings on Pointer<Utf8> {
     return cast<Uint8>().value == 123;
   }
 
+  bool get isString {
+    return this == TypeEncodings.string;
+  }
+
   bool get isNum {
     bool result = this == TypeEncodings.sint8 ||
         this == TypeEncodings.sint16 ||
@@ -321,6 +326,23 @@ String structNameForEncoding(String encoding) {
   return null;
 }
 
+String loadStringFromPointer(Pointer<Void> ptr) {
+  final dataPtr = ptr.cast<Int16>();
+  // get data length
+  const lengthDataSize = 4;
+  final lengthData = dataPtr.asTypedList(lengthDataSize);
+  int length = lengthData[0] << 48 |
+      lengthData[1] << 32 |
+      lengthData[2] << 16 |
+      lengthData[3];
+  // get utf16 data
+  Int16List data = dataPtr.elementAt(lengthDataSize).asTypedList(length);
+  String result = String.fromCharCodes(data);
+  // malloc dataPtr on native side, shoule free the memory.
+  free(dataPtr);
+  return result;
+}
+
 NativeStruct loadStructFromPointer(Pointer<Void> ptr, String encoding) {
   if (encoding == null) {
     return null;