Merge pull request #1253 from NativeScript/bektchiev/fix-md-for-nested-swift-classes

fix: Register Swift classes with both native names

Author: mbektchiev

src/NativeScript/JSErrors.h

@@ -16,6 +16,8 @@
 
 #define NS_EXCEPTION_SCOPE_ZERO_RECURSION_KEY @"__nsExceptionScopeZeroRecursion"
 
+#define NS_THROW(msg) @throw [NSException exceptionWithName:NSGenericException reason:msg userInfo:nil];
+
 #define NS_TRY @try
 
 #define NS_CATCH_THROW_TO_JS(execState)                                                                  \

src/NativeScript/Metadata/Metadata.h

@@ -63,6 +63,7 @@ inline UInt8 getMinorVersion(UInt8 encodedVersion) {
 
 // Bit indices in flags section
 enum MetaFlags {
+    HasDemangledName = 8,
     HasName = 7,
     // IsIosAppExtensionAvailable = 6, the flag exists in metadata generator but we never use it in the runtime
     FunctionReturnsUnmanaged = 3,
@@ -319,7 +320,7 @@ struct GlobalTable {
         return buckets.sizeInBytes();
     }
 
-    static const char* getName(const Meta& meta);
+    static bool compareName(const Meta& meta, const char* identifierString, size_t length);
 };
 
 struct ModuleTable {
@@ -546,22 +547,28 @@ struct LibraryMeta {
     }
 };
 
-struct JsNameAndName {
-    String jsName;
-    String name;
+enum NameIndex {
+    JsName,
+    Name,
+    DemangledName,
+    NameIndexCount,
+};
+
+struct JsNameAndNativeNames {
+    String strings[NameIndexCount];
 };
 
 union MetaNames {
     String name;
-    PtrTo<JsNameAndName> names;
+    PtrTo<JsNameAndNativeNames> names;
 };
 
 struct Meta {
 
 private:
     MetaNames _names;
     PtrTo<ModuleMeta> _topLevelModule;
-    UInt8 _flags;
+    UInt16 _flags;
     UInt8 _introduced;
 
 public:
@@ -577,16 +584,24 @@ struct Meta {
         return this->flag(MetaFlags::HasName);
     }
 
+    bool hasDemangledName() const {
+        return this->flag(MetaFlags::HasDemangledName);
+    }
+
     bool flag(int index) const {
         return (this->_flags & (1 << index)) > 0;
     }
 
     const char* jsName() const {
-        return (this->hasName()) ? this->_names.names->jsName.valuePtr() : this->_names.name.valuePtr();
+        return this->getNameByIndex(JsName);
     }
 
     const char* name() const {
-        return (this->hasName()) ? this->_names.names->name.valuePtr() : this->_names.name.valuePtr();
+        return this->getNameByIndex(Name);
+    }
+
+    const char* demangledName() const {
+        return this->getNameByIndex(DemangledName);
     }
 
     /**
@@ -605,6 +620,24 @@ struct Meta {
     * > have been introduced in this or prior version;
     */
     bool isAvailable() const;
+
+private:
+    const char* getNameByIndex(enum NameIndex index) const {
+        int i = index;
+        if (!this->hasName() && !this->hasDemangledName()) {
+            return this->_names.name.valuePtr();
+        }
+
+        if (!this->hasDemangledName() && i >= DemangledName) {
+            i--;
+        }
+
+        if (!this->hasName() && i >= Name) {
+            i--;
+        }
+
+        return this->_names.names.value().strings[i].valuePtr();
+    }
 };
 
 struct RecordMeta : Meta {

src/NativeScript/Metadata/MetadataInlines.h

@@ -101,17 +101,21 @@ const Meta* GlobalTable<TYPE>::findMeta(const char* identifierString, size_t len
     const ArrayOfPtrTo<Meta>& bucketContent = buckets[bucketIndex].value();
     for (ArrayOfPtrTo<Meta>::iterator it = bucketContent.begin(); it != bucketContent.end(); it++) {
         const Meta* meta = (*it).valuePtr();
-        const char* name = getName(*meta);
-        if (compareIdentifiers(name, identifierString, length) == 0) {
+        if (this->compareName(*meta, identifierString, length)) {
             return onlyIfAvailable ? (meta->isAvailable() ? meta : nullptr) : meta;
         }
     }
     return nullptr;
 }
 
-template <GlobalTableType TYPE>
-inline const char* GlobalTable<TYPE>::getName(const Meta& meta) {
-    return TYPE == GlobalTableType::ByJsName ? meta.jsName() : meta.name();
+template <>
+inline bool GlobalTable<ByJsName>::compareName(const Meta& meta, const char* identifierString, size_t length) {
+    return compareIdentifiers(meta.jsName(), identifierString, length) == 0;
+}
+
+template <>
+inline bool GlobalTable<ByNativeName>::compareName(const Meta& meta, const char* identifierString, size_t length) {
+    return compareIdentifiers(meta.name(), identifierString, length) == 0 || (meta.hasDemangledName() && compareIdentifiers(meta.demangledName(), identifierString, length) == 0);
 }
 
 // GlobalTable::iterator

src/NativeScript/TypeFactory.mm

@@ -101,7 +101,8 @@
 
     const StructMeta* structInfo = static_cast<const StructMeta*>(MetaFile::instance()->globalTableJs()->findMeta(structName.impl()));
     if (!structInfo) {
-        @throw [NSException exceptionWithName:NSGenericException reason:[NSString stringWithFormat:@"Struct \"%s\" is missing from metadata. It may have been blacklisted.", structName.utf8().data()] userInfo:nil];
+        NSString* errorMsg = [NSString stringWithFormat:@"Struct \"%s\" is missing from metadata. It may have been blacklisted.", structName.utf8().data()];
+        NS_THROW(errorMsg);
     }
 
     ffi_type* ffiType = new ffi_type({ .size = 0,
@@ -277,7 +278,7 @@
 
     if (!klass || !metadata) {
         if (strcmp(metadata->name(), "NSObject") == 0) {
-            @throw [NSException exceptionWithName:NSGenericException reason:@"fatal error: NativeScript cannot create constructor for NSObject." userInfo:nil];
+            NS_THROW(@"fatal error: NativeScript cannot create constructor for NSObject.");
         }
 #ifdef DEBUG
         NSLog(@"** Can not create constructor for \"%s\". Casting it to \"NSObject\". **", metadata->name());
@@ -478,9 +479,8 @@
         if (Class klass = objc_getClass(declarationName.utf8().data())) {
             result = globalObject->constructorFor(klass, additionalProtocols);
         } else {
-            auto scope = DECLARE_THROW_SCOPE(execState->vm());
-            WTF::String message = makeString("Class \"", declarationName, "\" referenced by type encoding not found at runtime.");
-            throwException(execState, scope, JSC::createError(execState, message, defaultSourceAppender));
+            auto errorMsg = [NSString stringWithFormat:@"Class \"%s\" referenced by type encoding not found at runtime.", declarationName.utf8().data()];
+            NS_THROW(errorMsg);
         }
 
         break;

src/metadata-generator

@@ -13,8 +13,14 @@ __attribute__((objc_runtime_name("_TtC17NativeScriptTests12TNSSwiftLike")))
 
 @end
 
+__attribute__((objc_runtime_name("_TtCC17NativeScriptTests12TNSSwiftLike5Inner")))
+@interface TNSSwiftLikeInner : NSObject
+
+@end
+
 @interface TNSSwiftLikeFactory : NSObject
 + (TNSSwiftLike*)create;
++ (TNSSwiftLikeInner*)createInner;
 @end
 
 NS_ASSUME_NONNULL_END

tests/TestFixtures/Interfaces/TNSSwiftLike.h

@@ -11,8 +11,16 @@ @implementation TNSSwiftLike
 
 @end
 
+@implementation TNSSwiftLikeInner
+
+@end
+
 @implementation TNSSwiftLikeFactory
 + (TNSSwiftLike*)create {
     return [TNSSwiftLike new];
 }
+
++ (TNSSwiftLikeInner*)createInner {
+    return [TNSSwiftLikeInner new];
+}
 @end

tests/TestFixtures/Interfaces/TNSSwiftLike.m

@@ -12,4 +12,11 @@ describe("Metadata", function () {
         expect(swiftLikeObj.constructor.name).toBe("NativeScriptTests.TNSSwiftLike");
         expect(NSString.stringWithUTF8String(class_getName(swiftLikeObj.constructor)).toString()).toBe("NativeScriptTests.TNSSwiftLike");
     });
+    
+    it("Objects from nested Swift classes should be marshalled correctly", function () {
+        const swiftLikeInnerObj = TNSSwiftLikeFactory.createInner();
+        expect(swiftLikeInnerObj.constructor).toBe(global.TNSSwiftLikeInner);
+        expect(swiftLikeInnerObj.constructor.name).toBe("_TtCC17NativeScriptTests12TNSSwiftLike5Inner");
+        expect(NSString.stringWithUTF8String(class_getName(swiftLikeInnerObj.constructor)).toString(), "_TtCC17NativeScriptTests12TNSSwiftLike5Inner");
+    });
 });