Merge pull request #831 from xamarin/add-handle-to-vtable

stephen-hawley · web-flow · commit 5caa5dff8dca · 2024-02-20T09:44:21.000-05:00
Add handle into vtables
diff --git a/SwiftReflector/NewClassCompiler.cs b/SwiftReflector/NewClassCompiler.cs
@@ -2053,11 +2053,22 @@ bool ImplementProtocolDeclarationsVTableAndCSProxy (ModuleInventory modInventory
 					                                                                   virtFunctions, virtFunctions [i], vtableEntryIndex, vtableName, vtable, vtableAssignments, use, swiftLibraryPath);
 				}
 			}
+			AddVTHandleIfNeeded (use, vtable, vtableAssignments, vtableName);
 			ImplementVTableInitializer (proxyClass, picl, usedPinvokeNames, protocolDecl, vtableAssignments, wrapper, vtableType, vtableName, swiftLibraryPath);
 
 			return vtable.Fields.Count > 0;
 		}
 
+		void AddVTHandleIfNeeded (CSUsingPackages use, CSStruct vtable, List<CSLine> vtableAssignments, string vtName)
+		{
+			if (vtable.Fields.Count > 0) {
+				use.AddIfNotPresent (typeof (GCHandle));
+				var gcType = new CSSimpleType (typeof (GCHandle));
+				var decl = new CSFieldDeclaration (gcType, OverrideBuilder.kVtableHandleName, value: null, CSVisibility.Public);
+				vtable.Fields.Insert (0, new CSLine (decl));
+			}
+		}
+
 		void CollectAllProtocolMethods (List<FunctionDeclaration> functions, ProtocolDeclaration decl)
 		{
 			foreach (TypeSpec spec in decl.Inheritance.Where (inh => inh.InheritanceKind == InheritanceKind.Protocol).Select (inh => inh.InheritedTypeSpec)) {
@@ -2114,6 +2125,7 @@ int ImplementVtableMethodsSuperMethodsAndVtable (ModuleInventory modInventory, W
 			if (vtable.Fields.Count > 0) {
 				cl.InnerClasses.Add (vtable);
 			}
+			AddVTHandleIfNeeded (use, vtable, vtableAssignments, vtableName);
 			ImplementVTableInitializer (cl, picl, usedPinvokeNames, classDecl, vtableAssignments, wrapper, vtableType, vtableName, swiftLibraryPath);
 			return virtFuncs.Count;
 		}
diff --git a/SwiftReflector/OverrideBuilder.cs b/SwiftReflector/OverrideBuilder.cs
@@ -14,6 +14,7 @@
 
 namespace SwiftReflector {
 	public class OverrideBuilder {
+		public const string kVtableHandleName = "csVTHandle";
 		TypeMapper typeMapper;
 		string vtableTypeName;
 		string vtableName = null;
@@ -1483,9 +1484,18 @@ SLClass DefineInnerVtableStruct ()
 					}
 				}
 			}
+			if (cl.Fields.Count > 0) {
+				cl.Fields.Insert (0, VtableHandleDeclaration ());
+			}
 			return cl;
 		}
 
+		SLLine VtableHandleDeclaration ()
+		{
+			var fieldLine = SLDeclaration.VarLine (kVtableHandleName, new SLOptionalType (SLSimpleType.OpaquePointer), SLConstant.Nil, Visibility.Public);
+			return fieldLine;
+		}
+
 		SLLine ToFieldDeclaration (FunctionDeclaration func, int index, List<string> fieldIdentifiers)
 		{
 			// this defines the type and member of a vtable entry

Original file line number	Diff line number	Diff line change
`@@ -2053,11 +2053,22 @@ bool ImplementProtocolDeclarationsVTableAndCSProxy (ModuleInventory modInventory`
`2053`	`2053`	`virtFunctions, virtFunctions [i], vtableEntryIndex, vtableName, vtable, vtableAssignments, use, swiftLibraryPath);`
`2054`	`2054`	`}`
`2055`	`2055`	`}`
	`2056`	`+ AddVTHandleIfNeeded (use, vtable, vtableAssignments, vtableName);`
`2056`	`2057`	`ImplementVTableInitializer (proxyClass, picl, usedPinvokeNames, protocolDecl, vtableAssignments, wrapper, vtableType, vtableName, swiftLibraryPath);`
`2057`	`2058`
`2058`	`2059`	`return vtable.Fields.Count > 0;`
`2059`	`2060`	`}`
`2060`	`2061`
	`2062`	`+ void AddVTHandleIfNeeded (CSUsingPackages use, CSStruct vtable, List<CSLine> vtableAssignments, string vtName)`
	`2063`	`+ {`
	`2064`	`+ if (vtable.Fields.Count > 0) {`
	`2065`	`+ use.AddIfNotPresent (typeof (GCHandle));`
	`2066`	`+ var gcType = new CSSimpleType (typeof (GCHandle));`
	`2067`	`+ var decl = new CSFieldDeclaration (gcType, OverrideBuilder.kVtableHandleName, value: null, CSVisibility.Public);`
	`2068`	`+ vtable.Fields.Insert (0, new CSLine (decl));`
	`2069`	`+ }`
	`2070`	`+ }`
	`2071`	`+`
`2061`	`2072`	`void CollectAllProtocolMethods (List<FunctionDeclaration> functions, ProtocolDeclaration decl)`
`2062`	`2073`	`{`
`2063`	`2074`	`foreach (TypeSpec spec in decl.Inheritance.Where (inh => inh.InheritanceKind == InheritanceKind.Protocol).Select (inh => inh.InheritedTypeSpec)) {`
`@@ -2114,6 +2125,7 @@ int ImplementVtableMethodsSuperMethodsAndVtable (ModuleInventory modInventory, W`
`2114`	`2125`	`if (vtable.Fields.Count > 0) {`
`2115`	`2126`	`cl.InnerClasses.Add (vtable);`
`2116`	`2127`	`}`
	`2128`	`+ AddVTHandleIfNeeded (use, vtable, vtableAssignments, vtableName);`
`2117`	`2129`	`ImplementVTableInitializer (cl, picl, usedPinvokeNames, classDecl, vtableAssignments, wrapper, vtableType, vtableName, swiftLibraryPath);`
`2118`	`2130`	`return virtFuncs.Count;`
`2119`	`2131`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`
`15`	`15`	`namespace SwiftReflector {`
`16`	`16`	`public class OverrideBuilder {`
	`17`	`+ public const string kVtableHandleName = "csVTHandle";`
`17`	`18`	`TypeMapper typeMapper;`
`18`	`19`	`string vtableTypeName;`
`19`	`20`	`string vtableName = null;`
`@@ -1483,9 +1484,18 @@ SLClass DefineInnerVtableStruct ()`
`1483`	`1484`	`}`
`1484`	`1485`	`}`
`1485`	`1486`	`}`
	`1487`	`+ if (cl.Fields.Count > 0) {`
	`1488`	`+ cl.Fields.Insert (0, VtableHandleDeclaration ());`
	`1489`	`+ }`
`1486`	`1490`	`return cl;`
`1487`	`1491`	`}`
`1488`	`1492`
	`1493`	`+ SLLine VtableHandleDeclaration ()`
	`1494`	`+ {`
	`1495`	`+ var fieldLine = SLDeclaration.VarLine (kVtableHandleName, new SLOptionalType (SLSimpleType.OpaquePointer), SLConstant.Nil, Visibility.Public);`
	`1496`	`+ return fieldLine;`
	`1497`	`+ }`
	`1498`	`+`
`1489`	`1499`	`SLLine ToFieldDeclaration (FunctionDeclaration func, int index, List<string> fieldIdentifiers)`
`1490`	`1500`	`{`
`1491`	`1501`	`// this defines the type and member of a vtable entry`