fix: Register Swift classes with both native names

The Objective-C runtime doesn't behave consistently with Swift class
names. Sometimes the mangled name can only be used, other times
the demangled one. To avoid hardcoding any logic which may get
easily broken in the future, we are adding both names in the global
tables and are using the mangled name in signatures.

Observation which lead to this change:

* `objc_getClass(const char *)` - accepts both mangled and demangled
names of Swift classes which are not nested in another class. Nested
classes however can be discovered only by their mangled name.

* `class_getName` - returns the demangled name for Swift classes
which aren't nested, and the mangled one for nested.

* On Mac Catalyst `class_getName` returns  the mangled names
no matter whether the class is nested or not.

* Update the `metadata-generator` submodule
* Add an optional demangled name for every metadata entity
* Add a test case with a nested Swift-like class

Author: mbektchiev

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/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");
+    });
 });